Deprecate editor.deltaDecorations (microsoft#153529)

alexdima · web-flow · commit ff744e89a63d · 2022-06-29T09:14:56.000+02:00
* Fixes microsoft#148423: Deprecate `editor.deltaDecorations` * Fix compilation
diff --git a/src/vs/editor/browser/editorBrowser.ts b/src/vs/editor/browser/editorBrowser.ts
@@ -852,7 +852,7 @@ export interface ICodeEditor extends editorCommon.IEditor {
 
 	/**
 	 * All decorations added through this call will get the ownerId of this editor.
-	 * @see {@link ITextModel.deltaDecorations}
+	 * @deprecated
 	 */
 	deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
 
diff --git a/src/vs/editor/browser/widget/codeEditorWidget.ts b/src/vs/editor/browser/widget/codeEditorWidget.ts
@@ -267,7 +267,7 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 
 	private _bannerDomNode: HTMLElement | null = null;
 
-	private _dropIntoEditorDecorationIds: string[] = [];
+	private _dropIntoEditorDecorations: EditorDecorationsCollection = this.createDecorationsCollection();
 
 	constructor(
 		domElement: HTMLElement,
@@ -1286,6 +1286,9 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 		return this._modelData.model.getDecorationsInRange(range, this._id, filterValidationDecorations(this._configuration.options));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[] {
 		if (!this._modelData) {
 			return [];
@@ -1844,12 +1847,12 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 			options: CodeEditorWidget.dropIntoEditorDecorationOptions
 		}];
 
-		this._dropIntoEditorDecorationIds = this.deltaDecorations(this._dropIntoEditorDecorationIds, newDecorations);
+		this._dropIntoEditorDecorations.set(newDecorations);
 		this.revealPosition(position, editorCommon.ScrollType.Immediate);
 	}
 
 	private removeDropIndicator(): void {
-		this._dropIntoEditorDecorationIds = this.deltaDecorations(this._dropIntoEditorDecorationIds, []);
+		this._dropIntoEditorDecorations.clear();
 	}
 }
 
diff --git a/src/vs/editor/browser/widget/diffEditorWidget.ts b/src/vs/editor/browser/widget/diffEditorWidget.ts
@@ -115,7 +115,9 @@ class VisualEditorState {
 		this._zonesMap = {};
 
 		// (2) Model decorations
-		this._decorations = editor.deltaDecorations(this._decorations, []);
+		editor.changeDecorations((changeAccessor) => {
+			this._decorations = changeAccessor.deltaDecorations(this._decorations, []);
+		});
 	}
 
 	public apply(editor: CodeEditorWidget, overviewRuler: editorBrowser.IOverviewRuler | null, newDecorations: IEditorDiffDecorationsWithZones, restoreScrollState: boolean): void {
@@ -153,7 +155,9 @@ class VisualEditorState {
 		scrollState?.restore(editor);
 
 		// decorations
-		this._decorations = editor.deltaDecorations(this._decorations, newDecorations.decorations);
+		editor.changeDecorations((changeAccessor) => {
+			this._decorations = changeAccessor.deltaDecorations(this._decorations, newDecorations.decorations);
+		});
 
 		// overview ruler
 		overviewRuler?.setZones(newDecorations.overviewZones);
diff --git a/src/vs/editor/contrib/colorPicker/browser/colorDetector.ts b/src/vs/editor/contrib/colorPicker/browser/colorDetector.ts
@@ -172,10 +172,12 @@ export class ColorDetector extends Disposable implements IEditorContribution {
 			options: ModelDecorationOptions.EMPTY
 		}));
 
-		this._decorationsIds = this._editor.deltaDecorations(this._decorationsIds, decorations);
+		this._editor.changeDecorations((changeAccessor) => {
+			this._decorationsIds = changeAccessor.deltaDecorations(this._decorationsIds, decorations);
 
-		this._colorDatas = new Map<string, IColorData>();
-		this._decorationsIds.forEach((id, i) => this._colorDatas.set(id, colorDatas[i]));
+			this._colorDatas = new Map<string, IColorData>();
+			this._decorationsIds.forEach((id, i) => this._colorDatas.set(id, colorDatas[i]));
+		});
 	}
 
 	private _colorDecorationClassRefs = this._register(new DisposableStore());
@@ -219,7 +221,8 @@ export class ColorDetector extends Disposable implements IEditorContribution {
 	}
 
 	private removeAllDecorations(): void {
-		this._decorationsIds = this._editor.deltaDecorations(this._decorationsIds, []);
+		this._editor.removeDecorations(this._decorationsIds);
+		this._decorationsIds = [];
 		this._colorDecoratorIds.clear();
 		this._colorDecorationClassRefs.clear();
 	}
diff --git a/src/vs/editor/contrib/find/browser/findDecorations.ts b/src/vs/editor/contrib/find/browser/findDecorations.ts
@@ -33,7 +33,7 @@ export class FindDecorations implements IDisposable {
 	}
 
 	public dispose(): void {
-		this._editor.deltaDecorations(this._allDecorations(), []);
+		this._editor.removeDecorations(this._allDecorations());
 
 		this._decorations = [];
 		this._overviewRulerApproximateDecorations = [];
diff --git a/src/vs/editor/contrib/folding/browser/foldingDecorations.ts b/src/vs/editor/contrib/folding/browser/foldingDecorations.ts
@@ -5,7 +5,7 @@
 
 import { Codicon } from 'vs/base/common/codicons';
 import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
-import { IModelDecorationsChangeAccessor, IModelDeltaDecoration, TrackedRangeStickiness } from 'vs/editor/common/model';
+import { IModelDecorationsChangeAccessor, TrackedRangeStickiness } from 'vs/editor/common/model';
 import { ModelDecorationOptions } from 'vs/editor/common/model/textModel';
 import { IDecorationProvider } from 'vs/editor/contrib/folding/browser/foldingModel';
 import { localize } from 'vs/nls';
@@ -72,11 +72,11 @@ export class FoldingDecorationProvider implements IDecorationProvider {
 		}
 	}
 
-	deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[] {
-		return this.editor.deltaDecorations(oldDecorations, newDecorations);
-	}
-
 	changeDecorations<T>(callback: (changeAccessor: IModelDecorationsChangeAccessor) => T): T {
 		return this.editor.changeDecorations(callback);
 	}
+
+	removeDecorations(decorationIds: string[]): void {
+		this.editor.removeDecorations(decorationIds);
+	}
 }
diff --git a/src/vs/editor/contrib/folding/browser/foldingModel.ts b/src/vs/editor/contrib/folding/browser/foldingModel.ts
@@ -9,8 +9,8 @@ import { FoldingRegion, FoldingRegions, ILineRange } from './foldingRanges';
 
 export interface IDecorationProvider {
 	getDecorationOption(isCollapsed: boolean, isHidden: boolean): IModelDecorationOptions;
-	deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
 	changeDecorations<T>(callback: (changeAccessor: IModelDecorationsChangeAccessor) => T): T | null;
+	removeDecorations(decorationIds: string[]): void;
 }
 
 export interface FoldingModelChangeEvent {
@@ -162,7 +162,9 @@ export class FoldingModel {
 			k++;
 		}
 
-		this._editorDecorationIds = this._decorationProvider.deltaDecorations(this._editorDecorationIds, newEditorDecorations);
+		this._decorationProvider.changeDecorations((changeAccessor) => {
+			this._editorDecorationIds = changeAccessor.deltaDecorations(this._editorDecorationIds, newEditorDecorations);
+		});
 		this._regions = newRegions;
 		this._isInitialized = true;
 		this._updateEventEmitter.fire({ model: this });
@@ -207,7 +209,7 @@ export class FoldingModel {
 	}
 
 	public dispose() {
-		this._decorationProvider.deltaDecorations(this._editorDecorationIds, []);
+		this._decorationProvider.removeDecorations(this._editorDecorationIds);
 	}
 
 	getAllRegionsAtLine(lineNumber: number, filter?: (r: FoldingRegion, level: number) => boolean): FoldingRegion[] {
diff --git a/src/vs/editor/contrib/folding/test/browser/foldingModel.test.ts b/src/vs/editor/contrib/folding/test/browser/foldingModel.test.ts
@@ -7,7 +7,7 @@ import { escapeRegExpCharacters } from 'vs/base/common/strings';
 import { EditOperation } from 'vs/editor/common/core/editOperation';
 import { Position } from 'vs/editor/common/core/position';
 import { Range } from 'vs/editor/common/core/range';
-import { IModelDecorationsChangeAccessor, IModelDeltaDecoration, ITextModel, TrackedRangeStickiness } from 'vs/editor/common/model';
+import { IModelDecorationsChangeAccessor, ITextModel, TrackedRangeStickiness } from 'vs/editor/common/model';
 import { ModelDecorationOptions } from 'vs/editor/common/model/textModel';
 import { FoldingModel, getNextFoldLine, getParentFoldLine, getPreviousFoldLine, setCollapseStateAtLevel, setCollapseStateForMatchingLines, setCollapseStateForRest, setCollapseStateLevelsDown, setCollapseStateLevelsUp, setCollapseStateUp } from 'vs/editor/contrib/folding/browser/foldingModel';
 import { FoldingRegion } from 'vs/editor/contrib/folding/browser/foldingRanges';
@@ -59,14 +59,16 @@ export class TestDecorationProvider {
 		return TestDecorationProvider.expandedDecoration;
 	}
 
-	deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[] {
-		return this.model.deltaDecorations(oldDecorations, newDecorations);
-	}
-
 	changeDecorations<T>(callback: (changeAccessor: IModelDecorationsChangeAccessor) => T): (T | null) {
 		return this.model.changeDecorations(callback);
 	}
 
+	removeDecorations(decorationIds: string[]): void {
+		this.model.changeDecorations((changeAccessor) => {
+			changeAccessor.deltaDecorations(decorationIds, []);
+		});
+	}
+
 	getDecorations(): ExpectedDecoration[] {
 		const decorations = this.model.getAllDecorations();
 		const res: ExpectedDecoration[] = [];
diff --git a/src/vs/editor/contrib/inlayHints/browser/inlayHintsController.ts b/src/vs/editor/contrib/inlayHints/browser/inlayHintsController.ts
@@ -597,7 +597,7 @@ export class InlayHintsController implements IEditorContribution {
 	}
 
 	private _removeAllDecorations(): void {
-		this._editor.deltaDecorations(Array.from(this._decorationsMetadata.keys()), []);
+		this._editor.removeDecorations(Array.from(this._decorationsMetadata.keys()));
 		for (const obj of this._decorationsMetadata.values()) {
 			obj.classNameRef.dispose();
 		}
diff --git a/src/vs/editor/contrib/inlineCompletions/browser/inlineCompletionsModel.ts b/src/vs/editor/contrib/inlineCompletions/browser/inlineCompletionsModel.ts
@@ -577,18 +577,21 @@ export class SynchronizedInlineCompletionsCache extends Disposable {
 	) {
 		super();
 
-		const decorationIds = editor.deltaDecorations(
-			[],
-			completionsSource.items.map(i => ({
-				range: i.range,
-				options: {
-					description: 'inline-completion-tracking-range'
-				},
-			}))
-		);
+		const decorationIds = editor.changeDecorations((changeAccessor) => {
+			return changeAccessor.deltaDecorations(
+				[],
+				completionsSource.items.map(i => ({
+					range: i.range,
+					options: {
+						description: 'inline-completion-tracking-range'
+					},
+				}))
+			);
+		});
+
 		this._register(toDisposable(() => {
 			this.isDisposing = true;
-			editor.deltaDecorations(decorationIds, []);
+			editor.removeDecorations(decorationIds);
 		}));
 
 		this.completions = completionsSource.items.map((c, idx) => new CachedInlineCompletion(c, decorationIds[idx]));
diff --git a/src/vs/editor/contrib/links/browser/links.ts b/src/vs/editor/contrib/links/browser/links.ts
@@ -163,14 +163,16 @@ export class LinkDetector extends Disposable implements IEditorContribution {
 			}
 		}
 
-		const decorations = this.editor.deltaDecorations(oldDecorations, newDecorations);
+		this.editor.changeDecorations((changeAccessor) => {
+			const decorations = changeAccessor.deltaDecorations(oldDecorations, newDecorations);
 
-		this.currentOccurrences = {};
-		this.activeLinkDecorationId = null;
-		for (let i = 0, len = decorations.length; i < len; i++) {
-			const occurence = new LinkOccurrence(links[i], decorations[i]);
-			this.currentOccurrences[occurence.decorationId] = occurence;
-		}
+			this.currentOccurrences = {};
+			this.activeLinkDecorationId = null;
+			for (let i = 0, len = decorations.length; i < len; i++) {
+				const occurence = new LinkOccurrence(links[i], decorations[i]);
+				this.currentOccurrences[occurence.decorationId] = occurence;
+			}
+		});
 	}
 
 	private _onEditorMouseMove(mouseEvent: ClickLinkMouseEvent, withKey: ClickLinkKeyboardEvent | null): void {
diff --git a/src/vs/editor/contrib/snippet/browser/snippetSession.ts b/src/vs/editor/contrib/snippet/browser/snippetSession.ts
@@ -55,7 +55,7 @@ export class OneSnippet {
 
 	dispose(): void {
 		if (this._placeholderDecorations) {
-			this._editor.deltaDecorations([...this._placeholderDecorations.values()], []);
+			this._editor.removeDecorations([...this._placeholderDecorations.values()]);
 		}
 		this._placeholderGroups.length = 0;
 	}
diff --git a/src/vs/editor/test/browser/controller/cursor.test.ts b/src/vs/editor/test/browser/controller/cursor.test.ts
@@ -502,18 +502,20 @@ suite('Editor Controller - Cursor', () => {
 		);
 
 		withTestCodeEditor(model, { wrappingIndent: 'indent', wordWrap: 'wordWrapColumn', wordWrapColumn: 20 }, (editor, viewModel) => {
-			editor.deltaDecorations([], [
-				{
-					range: new Range(1, 22, 1, 22),
-					options: {
-						showIfCollapsed: true,
-						description: 'test',
-						after: {
-							content: 'some very very very very very very very very long text',
+			editor.changeDecorations((changeAccessor) => {
+				changeAccessor.deltaDecorations([], [
+					{
+						range: new Range(1, 22, 1, 22),
+						options: {
+							showIfCollapsed: true,
+							description: 'test',
+							after: {
+								content: 'some very very very very very very very very long text',
+							}
 						}
 					}
-				}
-			]);
+				]);
+			});
 			viewModel.setSelections('test', [new Selection(1, 1, 1, 1)]);
 
 			const cursorPositions: any[] = [];
diff --git a/src/vs/editor/test/browser/widget/codeEditorWidget.test.ts b/src/vs/editor/test/browser/widget/codeEditorWidget.test.ts
@@ -192,7 +192,9 @@ suite('CodeEditorWidget', () => {
 			const calls: string[] = [];
 			disposables.add(editor.onDidChangeModelContent((e) => {
 				calls.push(`listener1 - contentchange(${e.changes.reduce<any[]>((aggr, c) => [...aggr, c.text, c.rangeOffset, c.rangeLength], []).join(', ')})`);
-				editor.deltaDecorations([], [{ range: new Range(1, 1, 1, 1), options: { description: 'test' } }]);
+				editor.changeDecorations((changeAccessor) => {
+					changeAccessor.deltaDecorations([], [{ range: new Range(1, 1, 1, 1), options: { description: 'test' } }]);
+				});
 			}));
 			disposables.add(editor.onDidChangeCursorSelection((e) => {
 				calls.push(`listener1 - cursorchange(${e.selection.positionLineNumber}, ${e.selection.positionColumn})`);
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -5313,7 +5313,7 @@ declare namespace monaco.editor {
 		getDecorationsInRange(range: Range): IModelDecoration[] | null;
 		/**
 		 * All decorations added through this call will get the ownerId of this editor.
-		 * @see {@link ITextModel.deltaDecorations}
+		 * @deprecated
 		 */
 		deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
 		/**
diff --git a/src/vs/workbench/contrib/comments/browser/commentThreadRangeDecorator.ts b/src/vs/workbench/contrib/comments/browser/commentThreadRangeDecorator.ts
@@ -84,8 +84,10 @@ export class CommentThreadRangeDecorator extends Disposable {
 				}
 			}
 		}
-		this.activeDecorationIds = this.editor.deltaDecorations(this.activeDecorationIds, newDecoration);
-		newDecoration.forEach((decoration, index) => decoration.id = this.decorationIds[index]);
+		this.editor.changeDecorations((changeAccessor) => {
+			this.activeDecorationIds = changeAccessor.deltaDecorations(this.activeDecorationIds, newDecoration);
+			newDecoration.forEach((decoration, index) => decoration.id = this.decorationIds[index]);
+		});
 	}
 
 	public update(editor: ICodeEditor, commentInfos: ICommentInfo[]) {
@@ -122,8 +124,10 @@ export class CommentThreadRangeDecorator extends Disposable {
 			});
 		}
 
-		this.decorationIds = editor.deltaDecorations(this.decorationIds, commentThreadRangeDecorations);
-		commentThreadRangeDecorations.forEach((decoration, index) => decoration.id = this.decorationIds[index]);
+		editor.changeDecorations((changeAccessor) => {
+			this.decorationIds = changeAccessor.deltaDecorations(this.decorationIds, commentThreadRangeDecorations);
+			commentThreadRangeDecorations.forEach((decoration, index) => decoration.id = this.decorationIds[index]);
+		});
 	}
 
 	override dispose() {
diff --git a/src/vs/workbench/contrib/debug/browser/breakpointEditorContribution.ts b/src/vs/workbench/contrib/debug/browser/breakpointEditorContribution.ts

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ export class FindDecorations implements IDisposable {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public dispose(): void {`
`36`		`- this._editor.deltaDecorations(this._allDecorations(), []);`
	`36`	`+ this._editor.removeDecorations(this._allDecorations());`
`37`	`37`
`38`	`38`	`this._decorations = [];`
`39`	`39`	`this._overviewRulerApproximateDecorations = [];`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`import { Codicon } from 'vs/base/common/codicons';`
`7`	`7`	`import { ICodeEditor } from 'vs/editor/browser/editorBrowser';`
`8`		`-import { IModelDecorationsChangeAccessor, IModelDeltaDecoration, TrackedRangeStickiness } from 'vs/editor/common/model';`
	`8`	`+import { IModelDecorationsChangeAccessor, TrackedRangeStickiness } from 'vs/editor/common/model';`
`9`	`9`	`import { ModelDecorationOptions } from 'vs/editor/common/model/textModel';`
`10`	`10`	`import { IDecorationProvider } from 'vs/editor/contrib/folding/browser/foldingModel';`
`11`	`11`	`import { localize } from 'vs/nls';`
`@@ -72,11 +72,11 @@ export class FoldingDecorationProvider implements IDecorationProvider {`
`72`	`72`	`}`
`73`	`73`	`}`
`74`	`74`
`75`		`- deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[] {`
`76`		`- return this.editor.deltaDecorations(oldDecorations, newDecorations);`
`77`		`- }`
`78`		`-`
`79`	`75`	`changeDecorations<T>(callback: (changeAccessor: IModelDecorationsChangeAccessor) => T): T {`
`80`	`76`	`return this.editor.changeDecorations(callback);`
`81`	`77`	`}`
	`78`	`+`
	`79`	`+ removeDecorations(decorationIds: string[]): void {`
	`80`	`+ this.editor.removeDecorations(decorationIds);`
	`81`	`+ }`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,8 @@ import { FoldingRegion, FoldingRegions, ILineRange } from './foldingRanges';`
`9`	`9`
`10`	`10`	`export interface IDecorationProvider {`
`11`	`11`	`getDecorationOption(isCollapsed: boolean, isHidden: boolean): IModelDecorationOptions;`
`12`		`- deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];`
`13`	`12`	`changeDecorations<T>(callback: (changeAccessor: IModelDecorationsChangeAccessor) => T): T \| null;`
	`13`	`+ removeDecorations(decorationIds: string[]): void;`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`export interface FoldingModelChangeEvent {`
`@@ -162,7 +162,9 @@ export class FoldingModel {`
`162`	`162`	`k++;`
`163`	`163`	`}`
`164`	`164`
`165`		`- this._editorDecorationIds = this._decorationProvider.deltaDecorations(this._editorDecorationIds, newEditorDecorations);`
	`165`	`+ this._decorationProvider.changeDecorations((changeAccessor) => {`
	`166`	`+ this._editorDecorationIds = changeAccessor.deltaDecorations(this._editorDecorationIds, newEditorDecorations);`
	`167`	`+ });`
`166`	`168`	`this._regions = newRegions;`
`167`	`169`	`this._isInitialized = true;`
`168`	`170`	`this._updateEventEmitter.fire({ model: this });`
`@@ -207,7 +209,7 @@ export class FoldingModel {`
`207`	`209`	`}`
`208`	`210`
`209`	`211`	`public dispose() {`
`210`		`- this._decorationProvider.deltaDecorations(this._editorDecorationIds, []);`
	`212`	`+ this._decorationProvider.removeDecorations(this._editorDecorationIds);`
`211`	`213`	`}`
`212`	`214`
`213`	`215`	`getAllRegionsAtLine(lineNumber: number, filter?: (r: FoldingRegion, level: number) => boolean): FoldingRegion[] {`
Original file line number	Diff line number	Diff line change
`@@ -597,7 +597,7 @@ export class InlayHintsController implements IEditorContribution {`
`597`	`597`	`}`
`598`	`598`
`599`	`599`	`private _removeAllDecorations(): void {`
`600`		`- this._editor.deltaDecorations(Array.from(this._decorationsMetadata.keys()), []);`
	`600`	`+ this._editor.removeDecorations(Array.from(this._decorationsMetadata.keys()));`
`601`	`601`	`for (const obj of this._decorationsMetadata.values()) {`
`602`	`602`	`obj.classNameRef.dispose();`
`603`	`603`	`}`