add commands to navigate through edits (microsoft#230791)

Author: jrieken

src/vs/workbench/contrib/chat/browser/chat.contribution.ts

@@ -73,6 +73,8 @@ import { EditorContributionInstantiation, registerEditorContribution } from '../
 import { ChatEditorController } from './chatEditorController.js';
 import { LanguageModelToolsService } from './languageModelToolsService.js';
 import { ChatEditorSaving } from './chatEditorSaving.js';
+import { registerChatEditorActions } from './chatEditorActions.js';
+
 
 // Register configuration
 const configurationRegistry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration);
@@ -298,6 +300,7 @@ registerMoveActions();
 registerNewChatActions();
 registerChatContextActions();
 registerChatDeveloperActions();
+registerChatEditorActions();
 
 registerEditorFeature(ChatPasteProvidersFeature);
 registerEditorContribution(ChatEditorController.ID, ChatEditorController, EditorContributionInstantiation.Eventually);

src/vs/workbench/contrib/chat/browser/chatEditorActions.ts

@@ -0,0 +1,68 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { isCodeEditor } from '../../../../editor/browser/editorBrowser.js';
+import { localize2 } from '../../../../nls.js';
+import { ServicesAccessor } from '../../../../editor/browser/editorExtensions.js';
+import { Codicon } from '../../../../base/common/codicons.js';
+import { Action2, MenuId, registerAction2 } from '../../../../platform/actions/common/actions.js';
+import { KeybindingWeight } from '../../../../platform/keybinding/common/keybindingsRegistry.js';
+import { KeyCode, KeyMod } from '../../../../base/common/keyCodes.js';
+import { CHAT_CATEGORY } from './actions/chatActions.js';
+import { ChatEditorController, ctxHasEditorModification } from './chatEditorController.js';
+import { ContextKeyExpr } from '../../../../platform/contextkey/common/contextkey.js';
+import { EditorContextKeys } from '../../../../editor/common/editorContextKeys.js';
+import { IEditorService } from '../../../services/editor/common/editorService.js';
+
+abstract class NavigateAction extends Action2 {
+
+	constructor(readonly next: boolean) {
+		super({
+			id: next
+				? 'chat.action.navigateNext'
+				: 'chat.action.navigatePrevious',
+			title: next
+				? localize2('next', 'Go to Next Chat Edit')
+				: localize2('prev', 'Go to Previous Chat Edit'),
+			category: CHAT_CATEGORY,
+			icon: next ? Codicon.arrowDown : Codicon.arrowUp,
+			keybinding: {
+				primary: next
+					? KeyMod.Alt | KeyCode.F5
+					: KeyMod.Alt | KeyMod.Shift | KeyCode.F5,
+				weight: KeybindingWeight.EditorContrib,
+				when: ContextKeyExpr.and(ctxHasEditorModification, EditorContextKeys.focus),
+			},
+			f1: true,
+			menu: {
+				id: MenuId.EditorTitle,
+				group: 'navigation',
+				order: next ? -100 : -101,
+				when: ctxHasEditorModification
+			}
+		});
+	}
+
+	override run(accessor: ServicesAccessor) {
+
+		const editor = accessor.get(IEditorService).activeTextEditorControl;
+
+		if (!isCodeEditor(editor)) {
+			return;
+		}
+
+		if (this.next) {
+			ChatEditorController.get(editor)?.revealNext();
+		} else {
+			ChatEditorController.get(editor)?.revealPrevious();
+		}
+	}
+
+}
+
+
+export function registerChatEditorActions() {
+	registerAction2(class extends NavigateAction { constructor() { super(true); } });
+	registerAction2(class extends NavigateAction { constructor() { super(false); } });
+}

src/vs/workbench/contrib/chat/browser/chatEditorController.ts

@@ -3,35 +3,56 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { binarySearch, coalesceInPlace } from '../../../../base/common/arrays.js';
 import { Disposable, DisposableStore, toDisposable } from '../../../../base/common/lifecycle.js';
 import { Constants } from '../../../../base/common/uint.js';
 import { ICodeEditor, IViewZone } from '../../../../editor/browser/editorBrowser.js';
 import { LineSource, renderLines, RenderOptions } from '../../../../editor/browser/widget/diffEditor/components/diffEditorViewZones/renderLines.js';
 import { diffAddDecoration, diffDeleteDecoration, diffWholeLineAddDecoration } from '../../../../editor/browser/widget/diffEditor/registrations.contribution.js';
 import { EditorOption } from '../../../../editor/common/config/editorOptions.js';
+import { Range } from '../../../../editor/common/core/range.js';
 import { IDocumentDiff } from '../../../../editor/common/diff/documentDiffProvider.js';
-import { IEditorContribution } from '../../../../editor/common/editorCommon.js';
+import { IEditorContribution, ScrollType } from '../../../../editor/common/editorCommon.js';
 import { IModelDeltaDecoration, ITextModel } from '../../../../editor/common/model.js';
 import { IEditorWorkerService } from '../../../../editor/common/services/editorWorker.js';
 import { InlineDecoration, InlineDecorationType } from '../../../../editor/common/viewModel.js';
 import { IChatEditingService, IChatEditingSession, IModifiedFileEntry, WorkingSetEntryState } from '../common/chatEditingService.js';
+import { localize } from '../../../../nls.js';
+import { IContextKey, IContextKeyService, RawContextKey } from '../../../../platform/contextkey/common/contextkey.js';
+
+export const ctxHasEditorModification = new RawContextKey<boolean>('chat.hasEditorModifications', undefined, localize('chat.hasEditorModifications', "The current editor contains chat modifications"));
 
 export class ChatEditorController extends Disposable implements IEditorContribution {
 
 	public static readonly ID = 'editor.contrib.chatEditorController';
+
 	private readonly _sessionStore = this._register(new DisposableStore());
 	private readonly _decorations = this._editor.createDecorationsCollection();
 	private _viewZones: string[] = [];
+	private readonly _ctxHasEditorModification: IContextKey<boolean>;
+
+	static get(editor: ICodeEditor): ChatEditorController | null {
+		const controller = editor.getContribution<ChatEditorController>(ChatEditorController.ID);
+		return controller;
+	}
 
 	constructor(
 		private readonly _editor: ICodeEditor,
 		@IChatEditingService private readonly _chatEditingService: IChatEditingService,
-		@IEditorWorkerService private readonly _editorWorkerService: IEditorWorkerService
+		@IEditorWorkerService private readonly _editorWorkerService: IEditorWorkerService,
+		@IContextKeyService contextKeyService: IContextKeyService,
 	) {
 		super();
 		this._register(this._editor.onDidChangeModel(() => this._update()));
 		this._register(this._chatEditingService.onDidChangeEditingSession(() => this._updateSessionDecorations()));
 		this._register(toDisposable(() => this._clearRendering()));
+
+		this._ctxHasEditorModification = ctxHasEditorModification.bindTo(contextKeyService);
+	}
+
+	override dispose(): void {
+		this._clearRendering();
+		super.dispose();
 	}
 
 	private _update(): void {
@@ -88,6 +109,7 @@ export class ChatEditorController extends Disposable implements IEditorContribut
 				return;
 			}
 
+			this._ctxHasEditorModification.set(true);
 			this._updateWithDiff(model, entry, diff);
 		});
 	}
@@ -107,6 +129,7 @@ export class ChatEditorController extends Disposable implements IEditorContribut
 		});
 		this._viewZones = [];
 		this._decorations.clear();
+		this._ctxHasEditorModification.reset();
 	}
 
 	private _updateWithDiff(model: ITextModel, entry: IModifiedFileEntry, diff: IDocumentDiff | null): void {
@@ -166,4 +189,62 @@ export class ChatEditorController extends Disposable implements IEditorContribut
 			this._decorations.set(modifiedDecorations);
 		});
 	}
+
+	revealNext() {
+		this._reveal(true);
+	}
+
+	revealPrevious() {
+		this._reveal(false);
+	}
+
+	private _reveal(next: boolean) {
+		const position = this._editor.getPosition();
+		if (!position) {
+			return;
+		}
+
+		const decorations: (Range | undefined)[] = this._decorations
+			.getRanges()
+			.sort((a, b) => Range.compareRangesUsingStarts(a, b));
+
+		// TODO@jrieken this is slow and should be done smarter, e.g being able to read
+		// only whole range decorations because the goal is to go from change to change, skipping
+		// over word level changes
+		for (let i = 0; i < decorations.length; i++) {
+			const decoration = decorations[i];
+			for (let j = 0; j < decorations.length; j++) {
+				if (i !== j && decoration && decorations[j]?.containsRange(decoration)) {
+					decorations[i] = undefined;
+					break;
+				}
+			}
+		}
+
+		coalesceInPlace(decorations);
+
+		if (decorations.length === 0) {
+			return;
+		}
+
+		let idx = binarySearch(decorations, Range.fromPositions(position), Range.compareRangesUsingStarts);
+		if (idx < 0) {
+			idx = ~idx;
+		}
+
+		let target: number;
+		if (decorations[idx]?.containsPosition(position)) {
+			target = idx + (next ? 1 : -1);
+		} else {
+			target = next ? idx : idx - 1;
+		}
+
+		target = (target + decorations.length) % decorations.length;
+
+
+		const targetPosition = decorations[target].getStartPosition();
+		this._editor.setPosition(targetPosition);
+		this._editor.revealPosition(targetPosition, ScrollType.Smooth);
+		this._editor.focus();
+	}
 }