Make IEditor.setSelections take a readonly array

mjbvz · mjbvz · commit 7e99bd32f0c7 · 2019-09-19T17:55:00.000-07:00
This array cannot be modified after it is passed to the editor to update the selections
diff --git a/src/vs/editor/browser/widget/codeEditorWidget.ts b/src/vs/editor/browser/widget/codeEditorWidget.ts
@@ -737,7 +737,7 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 		);
 	}
 
-	public setSelections(ranges: ISelection[], source: string = 'api'): void {
+	public setSelections(ranges: readonly ISelection[], source: string = 'api'): void {
 		if (!this._modelData) {
 			return;
 		}
diff --git a/src/vs/editor/browser/widget/diffEditorWidget.ts b/src/vs/editor/browser/widget/diffEditorWidget.ts
@@ -723,7 +723,7 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 		this.modifiedEditor.setSelection(something);
 	}
 
-	public setSelections(ranges: ISelection[]): void {
+	public setSelections(ranges: readonly ISelection[]): void {
 		this.modifiedEditor.setSelections(ranges);
 	}
 
diff --git a/src/vs/editor/common/controller/cursor.ts b/src/vs/editor/common/controller/cursor.ts
@@ -424,7 +424,7 @@ export class Cursor extends viewEvents.ViewEventEmitter implements ICursors {
 		return this._cursors.getPrimaryCursor().modelState.position;
 	}
 
-	public setSelections(source: string, selections: ISelection[]): void {
+	public setSelections(source: string, selections: readonly ISelection[]): void {
 		this.setStates(source, CursorChangeReason.NotSet, CursorState.fromModelSelections(selections));
 	}
 
diff --git a/src/vs/editor/common/controller/cursorCommon.ts b/src/vs/editor/common/controller/cursorCommon.ts
@@ -460,7 +460,7 @@ export class CursorState {
 		return CursorState.fromModelState(modelState);
 	}
 
-	public static fromModelSelections(modelSelections: ISelection[]): PartialModelCursorState[] {
+	public static fromModelSelections(modelSelections: readonly ISelection[]): PartialModelCursorState[] {
 		let states: PartialModelCursorState[] = [];
 		for (let i = 0, len = modelSelections.length; i < len; i++) {
 			states[i] = this.fromModelSelection(modelSelections[i]);
diff --git a/src/vs/editor/common/editorCommon.ts b/src/vs/editor/common/editorCommon.ts
@@ -389,7 +389,7 @@ export interface IEditor {
 	 * Set the selections for all the cursors of the editor.
 	 * Cursors will be removed or added, as necessary.
 	 */
-	setSelections(selections: ISelection[]): void;
+	setSelections(selections: readonly ISelection[]): void;
 
 	/**
 	 * Scroll vertically as necessary and reveal lines.
diff --git a/src/vs/editor/contrib/cursorUndo/cursorUndo.ts b/src/vs/editor/contrib/cursorUndo/cursorUndo.ts
@@ -14,9 +14,9 @@ import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
 import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
 
 class CursorState {
-	readonly selections: Selection[];
+	readonly selections: readonly Selection[];
 
-	constructor(selections: Selection[]) {
+	constructor(selections: readonly Selection[]) {
 		this.selections = selections;
 	}
 
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -2152,7 +2152,7 @@ declare namespace monaco.editor {
 		 * Set the selections for all the cursors of the editor.
 		 * Cursors will be removed or added, as necessary.
 		 */
-		setSelections(selections: ISelection[]): void;
+		setSelections(selections: readonly ISelection[]): void;
 		/**
 		 * Scroll vertically as necessary and reveal lines.
 		 */

Original file line number	Diff line number	Diff line change
`@@ -737,7 +737,7 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE`
`737`	`737`	`);`
`738`	`738`	`}`
`739`	`739`
`740`		`- public setSelections(ranges: ISelection[], source: string = 'api'): void {`
	`740`	`+ public setSelections(ranges: readonly ISelection[], source: string = 'api'): void {`
`741`	`741`	`if (!this._modelData) {`
`742`	`742`	`return;`
`743`	`743`	`}`
Original file line number	Diff line number	Diff line change
`@@ -723,7 +723,7 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE`
`723`	`723`	`this.modifiedEditor.setSelection(something);`
`724`	`724`	`}`
`725`	`725`
`726`		`- public setSelections(ranges: ISelection[]): void {`
	`726`	`+ public setSelections(ranges: readonly ISelection[]): void {`
`727`	`727`	`this.modifiedEditor.setSelections(ranges);`
`728`	`728`	`}`
`729`	`729`
Original file line number	Diff line number	Diff line change
`@@ -424,7 +424,7 @@ export class Cursor extends viewEvents.ViewEventEmitter implements ICursors {`
`424`	`424`	`return this._cursors.getPrimaryCursor().modelState.position;`
`425`	`425`	`}`
`426`	`426`
`427`		`- public setSelections(source: string, selections: ISelection[]): void {`
	`427`	`+ public setSelections(source: string, selections: readonly ISelection[]): void {`
`428`	`428`	`this.setStates(source, CursorChangeReason.NotSet, CursorState.fromModelSelections(selections));`
`429`	`429`	`}`
`430`	`430`
Original file line number	Diff line number	Diff line change
`@@ -460,7 +460,7 @@ export class CursorState {`
`460`	`460`	`return CursorState.fromModelState(modelState);`
`461`	`461`	`}`
`462`	`462`
`463`		`- public static fromModelSelections(modelSelections: ISelection[]): PartialModelCursorState[] {`
	`463`	`+ public static fromModelSelections(modelSelections: readonly ISelection[]): PartialModelCursorState[] {`
`464`	`464`	`let states: PartialModelCursorState[] = [];`
`465`	`465`	`for (let i = 0, len = modelSelections.length; i < len; i++) {`
`466`	`466`	`states[i] = this.fromModelSelection(modelSelections[i]);`
Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,9 @@ import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';`
`14`	`14`	`import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';`
`15`	`15`
`16`	`16`	`class CursorState {`
`17`		`- readonly selections: Selection[];`
	`17`	`+ readonly selections: readonly Selection[];`
`18`	`18`
`19`		`- constructor(selections: Selection[]) {`
	`19`	`+ constructor(selections: readonly Selection[]) {`
`20`	`20`	`this.selections = selections;`
`21`	`21`	`}`
`22`	`22`