Fixes #44424: Add proposed API - TextEditor.visibleRanges

src/vs/workbench/api/node/extHost.api.impl.ts

@@ -334,6 +334,9 @@ export function createApiFactory(
 			onDidChangeTextEditorOptions(listener: (e: vscode.TextEditorOptionsChangeEvent) => any, thisArgs?: any, disposables?: extHostTypes.Disposable[]) {
 				return extHostEditors.onDidChangeTextEditorOptions(listener, thisArgs, disposables);
 			},
+			onDidChangeTextEditorVisibleRanges: proposedApiFunction(extension, (listener: (e: vscode.TextEditorVisibleRangesChangeEvent) => any, thisArgs?: any, disposables?: extHostTypes.Disposable[]) => {
+				return extHostEditors.onDidChangeTextEditorVisibleRanges(listener, thisArgs, disposables);
+			}),
 			onDidChangeTextEditorViewColumn(listener, thisArg?, disposables?) {
 				return extHostEditors.onDidChangeTextEditorViewColumn(listener, thisArg, disposables);
 			},

src/vs/workbench/api/node/extHost.protocol.ts

@@ -508,6 +508,7 @@ export interface ITextEditorAddData {
 	documentUri: UriComponents;
 	options: IResolvedTextEditorConfiguration;
 	selections: ISelection[];
+	visibleRanges: IRange[];
 	editorPosition: EditorPosition;
 }
 export interface ITextEditorPositionData {
@@ -516,6 +517,7 @@ export interface ITextEditorPositionData {
 export interface IEditorPropertiesChangeData {
 	options: IResolvedTextEditorConfiguration | null;
 	selections: ISelectionChangeEvent | null;
+	visibleRanges: IRange[] | null;
 }
 export interface ISelectionChangeEvent {
 	selections: Selection[];

src/vs/workbench/api/node/extHostDocumentsAndEditors.ts

@@ -115,6 +115,7 @@ export class ExtHostDocumentsAndEditors implements ExtHostDocumentsAndEditorsSha
 					documentData,
 					data.selections.map(typeConverters.toSelection),
 					data.options,
+					data.visibleRanges.map(typeConverters.toRange),
 					typeConverters.toViewColumn(data.editorPosition)
 				);
 				this._editors.set(data.id, editor);

src/vs/workbench/api/node/extHostTextEditor.ts

@@ -321,17 +321,23 @@ export class ExtHostTextEditor implements vscode.TextEditor {
 
 	private _selections: Selection[];
 	private _options: ExtHostTextEditorOptions;
+	private _visibleRanges: Range[];
 	private _viewColumn: vscode.ViewColumn;
 	private _disposed: boolean = false;
 
 	get id(): string { return this._id; }
 
-	constructor(proxy: MainThreadTextEditorsShape, id: string, document: ExtHostDocumentData, selections: Selection[], options: IResolvedTextEditorConfiguration, viewColumn: vscode.ViewColumn) {
+	constructor(
+		proxy: MainThreadTextEditorsShape, id: string, document: ExtHostDocumentData,
+		selections: Selection[], options: IResolvedTextEditorConfiguration,
+		visibleRanges: Range[], viewColumn: vscode.ViewColumn
+	) {
 		this._proxy = proxy;
 		this._id = id;
 		this._documentData = document;
 		this._selections = selections;
 		this._options = new ExtHostTextEditorOptions(this._proxy, this._id, options);
+		this._visibleRanges = visibleRanges;
 		this._viewColumn = viewColumn;
 	}
 
@@ -375,6 +381,21 @@ export class ExtHostTextEditor implements vscode.TextEditor {
 		this._options._accept(options);
 	}
 
+	// ---- visible ranges
+
+	get visibleRanges(): Range[] {
+		return this._visibleRanges;
+	}
+
+	set visibleRanges(value: Range[]) {
+		throw readonly('visibleRanges');
+	}
+
+	_acceptVisibleRanges(value: Range[]): void {
+		ok(!this._disposed);
+		this._visibleRanges = value;
+	}
+
 	// ---- view column
 
 	get viewColumn(): vscode.ViewColumn {

src/vs/workbench/api/node/extHostTextEditors.ts

@@ -19,12 +19,14 @@ export class ExtHostEditors implements ExtHostEditorsShape {
 
 	private readonly _onDidChangeTextEditorSelection = new Emitter<vscode.TextEditorSelectionChangeEvent>();
 	private readonly _onDidChangeTextEditorOptions = new Emitter<vscode.TextEditorOptionsChangeEvent>();
+	private readonly _onDidChangeTextEditorVisibleRanges = new Emitter<vscode.TextEditorVisibleRangesChangeEvent>();
 	private readonly _onDidChangeTextEditorViewColumn = new Emitter<vscode.TextEditorViewColumnChangeEvent>();
 	private readonly _onDidChangeActiveTextEditor = new Emitter<vscode.TextEditor | undefined>();
 	private readonly _onDidChangeVisibleTextEditors = new Emitter<vscode.TextEditor[]>();
 
 	readonly onDidChangeTextEditorSelection: Event<vscode.TextEditorSelectionChangeEvent> = this._onDidChangeTextEditorSelection.event;
 	readonly onDidChangeTextEditorOptions: Event<vscode.TextEditorOptionsChangeEvent> = this._onDidChangeTextEditorOptions.event;
+	readonly onDidChangeTextEditorVisibleRanges: Event<vscode.TextEditorVisibleRangesChangeEvent> = this._onDidChangeTextEditorVisibleRanges.event;
 	readonly onDidChangeTextEditorViewColumn: Event<vscode.TextEditorViewColumnChangeEvent> = this._onDidChangeTextEditorViewColumn.event;
 	readonly onDidChangeActiveTextEditor: Event<vscode.TextEditor | undefined> = this._onDidChangeActiveTextEditor.event;
 	readonly onDidChangeVisibleTextEditors: Event<vscode.TextEditor[]> = this._onDidChangeVisibleTextEditors.event;
@@ -124,6 +126,10 @@ export class ExtHostEditors implements ExtHostEditorsShape {
 			const selections = data.selections.selections.map(TypeConverters.toSelection);
 			textEditor._acceptSelections(selections);
 		}
+		if (data.visibleRanges) {
+			const visibleRanges = data.visibleRanges.map(TypeConverters.toRange);
+			textEditor._acceptVisibleRanges(visibleRanges);
+		}
 
 		// (2) fire change events
 		if (data.options) {
@@ -141,6 +147,13 @@ export class ExtHostEditors implements ExtHostEditorsShape {
 				kind
 			});
 		}
+		if (data.visibleRanges) {
+			const visibleRanges = data.visibleRanges.map(TypeConverters.toRange);
+			this._onDidChangeTextEditorVisibleRanges.fire({
+				textEditor,
+				visibleRanges
+			});
+		}
 	}
 
 	$acceptEditorPositionData(data: ITextEditorPositionData): void {