Merge commit 'be3e8236086165e5e45a5a10783823874b3f3ebd' as 'lib/vscode'

lib/vscode/src/vs/editor/contrib/quickAccess/gotoLineQuickAccess.ts

@@ -0,0 +1,169 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { localize } from 'vs/nls';
+import { IQuickPick, IQuickPickItem } from 'vs/platform/quickinput/common/quickInput';
+import { CancellationToken } from 'vs/base/common/cancellation';
+import { DisposableStore, IDisposable, Disposable, toDisposable } from 'vs/base/common/lifecycle';
+import { IEditor, ScrollType } from 'vs/editor/common/editorCommon';
+import { IRange } from 'vs/editor/common/core/range';
+import { AbstractEditorNavigationQuickAccessProvider } from 'vs/editor/contrib/quickAccess/editorNavigationQuickAccess';
+import { IPosition } from 'vs/editor/common/core/position';
+import { getCodeEditor } from 'vs/editor/browser/editorBrowser';
+import { EditorOption, RenderLineNumbersType } from 'vs/editor/common/config/editorOptions';
+
+interface IGotoLineQuickPickItem extends IQuickPickItem, Partial<IPosition> { }
+
+export abstract class AbstractGotoLineQuickAccessProvider extends AbstractEditorNavigationQuickAccessProvider {
+
+	static PREFIX = ':';
+
+	constructor() {
+		super({ canAcceptInBackground: true });
+	}
+
+	protected provideWithoutTextEditor(picker: IQuickPick<IGotoLineQuickPickItem>): IDisposable {
+		const label = localize('cannotRunGotoLine', "Open a text editor first to go to a line.");
+
+		picker.items = [{ label }];
+		picker.ariaLabel = label;
+
+		return Disposable.None;
+	}
+
+	protected provideWithTextEditor(editor: IEditor, picker: IQuickPick<IGotoLineQuickPickItem>, token: CancellationToken): IDisposable {
+		const disposables = new DisposableStore();
+
+		// Goto line once picked
+		disposables.add(picker.onDidAccept(event => {
+			const [item] = picker.selectedItems;
+			if (item) {
+				if (!this.isValidLineNumber(editor, item.lineNumber)) {
+					return;
+				}
+
+				this.gotoLocation(editor, { range: this.toRange(item.lineNumber, item.column), keyMods: picker.keyMods, preserveFocus: event.inBackground });
+
+				if (!event.inBackground) {
+					picker.hide();
+				}
+			}
+		}));
+
+		// React to picker changes
+		const updatePickerAndEditor = () => {
+			const position = this.parsePosition(editor, picker.value.trim().substr(AbstractGotoLineQuickAccessProvider.PREFIX.length));
+			const label = this.getPickLabel(editor, position.lineNumber, position.column);
+
+			// Picker
+			picker.items = [{
+				lineNumber: position.lineNumber,
+				column: position.column,
+				label
+			}];
+
+			// ARIA Label
+			picker.ariaLabel = label;
+
+			// Clear decorations for invalid range
+			if (!this.isValidLineNumber(editor, position.lineNumber)) {
+				this.clearDecorations(editor);
+				return;
+			}
+
+			// Reveal
+			const range = this.toRange(position.lineNumber, position.column);
+			editor.revealRangeInCenter(range, ScrollType.Smooth);
+
+			// Decorate
+			this.addDecorations(editor, range);
+		};
+		updatePickerAndEditor();
+		disposables.add(picker.onDidChangeValue(() => updatePickerAndEditor()));
+
+		// Adjust line number visibility as needed
+		const codeEditor = getCodeEditor(editor);
+		if (codeEditor) {
+			const options = codeEditor.getOptions();
+			const lineNumbers = options.get(EditorOption.lineNumbers);
+			if (lineNumbers.renderType === RenderLineNumbersType.Relative) {
+				codeEditor.updateOptions({ lineNumbers: 'on' });
+
+				disposables.add(toDisposable(() => codeEditor.updateOptions({ lineNumbers: 'relative' })));
+			}
+		}
+
+		return disposables;
+	}
+
+	private toRange(lineNumber = 1, column = 1): IRange {
+		return {
+			startLineNumber: lineNumber,
+			startColumn: column,
+			endLineNumber: lineNumber,
+			endColumn: column
+		};
+	}
+
+	private parsePosition(editor: IEditor, value: string): IPosition {
+
+		// Support line-col formats of `line,col`, `line:col`, `line#col`
+		const numbers = value.split(/,|:|#/).map(part => parseInt(part, 10)).filter(part => !isNaN(part));
+		const endLine = this.lineCount(editor) + 1;
+
+		return {
+			lineNumber: numbers[0] > 0 ? numbers[0] : endLine + numbers[0],
+			column: numbers[1]
+		};
+	}
+
+	private getPickLabel(editor: IEditor, lineNumber: number, column: number | undefined): string {
+
+		// Location valid: indicate this as picker label
+		if (this.isValidLineNumber(editor, lineNumber)) {
+			if (this.isValidColumn(editor, lineNumber, column)) {
+				return localize('gotoLineColumnLabel', "Go to line {0} and column {1}.", lineNumber, column);
+			}
+
+			return localize('gotoLineLabel', "Go to line {0}.", lineNumber);
+		}
+
+		// Location invalid: show generic label
+		const position = editor.getPosition() || { lineNumber: 1, column: 1 };
+		const lineCount = this.lineCount(editor);
+		if (lineCount > 1) {
+			return localize('gotoLineLabelEmptyWithLimit', "Current Line: {0}, Character: {1}. Type a line number between 1 and {2} to navigate to.", position.lineNumber, position.column, lineCount);
+		}
+
+		return localize('gotoLineLabelEmpty', "Current Line: {0}, Character: {1}. Type a line number to navigate to.", position.lineNumber, position.column);
+	}
+
+	private isValidLineNumber(editor: IEditor, lineNumber: number | undefined): boolean {
+		if (!lineNumber || typeof lineNumber !== 'number') {
+			return false;
+		}
+
+		return lineNumber > 0 && lineNumber <= this.lineCount(editor);
+	}
+
+	private isValidColumn(editor: IEditor, lineNumber: number, column: number | undefined): boolean {
+		if (!column || typeof column !== 'number') {
+			return false;
+		}
+
+		const model = this.getModel(editor);
+		if (!model) {
+			return false;
+		}
+
+		const positionCandidate = { lineNumber, column };
+
+		return model.validatePosition(positionCandidate).equals(positionCandidate);
+	}
+
+	private lineCount(editor: IEditor): number {
+		return this.getModel(editor)?.getLineCount() ?? 0;
+	}
+}