Revert "Use null instead of undefined for openCodeEditor"

alexdima · alexdima · commit a38ca5b5373b · 2019-10-18T16:01:48.000+02:00
Revert "`getActiveCodeEditor` should return undefined instead of null" Revert "Make `getFocusedCodeEditor` return undefined instead of null" This reverts commit db11576. This reverts commit 0fdba09. This reverts commit b18ef0e
diff --git a/src/vs/editor/browser/services/abstractCodeEditorService.ts b/src/vs/editor/browser/services/abstractCodeEditorService.ts
@@ -70,8 +70,8 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC
 		return Object.keys(this._diffEditors).map(id => this._diffEditors[id]);
 	}
 
-	getFocusedCodeEditor(): ICodeEditor | undefined {
-		let editorWithWidgetFocus: ICodeEditor | undefined;
+	getFocusedCodeEditor(): ICodeEditor | null {
+		let editorWithWidgetFocus: ICodeEditor | null = null;
 
 		const editors = this.listCodeEditors();
 		for (const editor of editors) {
@@ -124,8 +124,8 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC
 		delete this._transientWatchers[w.uri];
 	}
 
-	abstract getActiveCodeEditor(): ICodeEditor | undefined;
-	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined>;
+	abstract getActiveCodeEditor(): ICodeEditor | null;
+	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
 }
 
 export class ModelTransientSettingWatcher {
diff --git a/src/vs/editor/browser/services/codeEditorService.ts b/src/vs/editor/browser/services/codeEditorService.ts
@@ -33,10 +33,9 @@ export interface ICodeEditorService {
 	listDiffEditors(): readonly IDiffEditor[];
 
 	/**
-	 * Returns the current focused code editor (if the focus is in the editor or in an editor widget) or
-	 * `undefined` if none.
+	 * Returns the current focused code editor (if the focus is in the editor or in an editor widget) or null.
 	 */
-	getFocusedCodeEditor(): ICodeEditor | undefined;
+	getFocusedCodeEditor(): ICodeEditor | null;
 
 	registerDecorationType(key: string, options: IDecorationRenderOptions, parentTypeKey?: string): void;
 	removeDecorationType(key: string): void;
@@ -45,6 +44,6 @@ export interface ICodeEditorService {
 	setTransientModelProperty(model: ITextModel, key: string, value: any): void;
 	getTransientModelProperty(model: ITextModel, key: string): any;
 
-	getActiveCodeEditor(): ICodeEditor | undefined;
-	openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined>;
+	getActiveCodeEditor(): ICodeEditor | null;
+	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
 }
diff --git a/src/vs/editor/browser/services/codeEditorServiceImpl.ts b/src/vs/editor/browser/services/codeEditorServiceImpl.ts
@@ -65,8 +65,8 @@ export abstract class CodeEditorServiceImpl extends AbstractCodeEditorService {
 		return provider.getOptions(this, writable);
 	}
 
-	abstract getActiveCodeEditor(): ICodeEditor | undefined;
-	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined>;
+	abstract getActiveCodeEditor(): ICodeEditor | null;
+	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
 }
 
 interface IModelDecorationOptionsProvider extends IDisposable {
diff --git a/src/vs/editor/contrib/goToDefinition/goToDefinitionCommands.ts b/src/vs/editor/contrib/goToDefinition/goToDefinitionCommands.ts
@@ -163,7 +163,7 @@ export class DefinitionAction extends EditorAction {
 		}
 	}
 
-	private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location | LocationLink, sideBySide: boolean): Promise<ICodeEditor | undefined> {
+	private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location | LocationLink, sideBySide: boolean): Promise<ICodeEditor | null> {
 		// range is the target-selection-range when we have one
 		// and the the fallback is the 'full' range
 		let range: IRange | undefined = undefined;
diff --git a/src/vs/editor/contrib/referenceSearch/peekViewWidget.ts b/src/vs/editor/contrib/referenceSearch/peekViewWidget.ts
@@ -57,8 +57,8 @@ export namespace PeekContext {
 	export const notInPeekEditor: ContextKeyExpr = inPeekEditor.toNegated();
 }
 
-export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor | undefined {
-	const editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();
+export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor | null {
+	let editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();
 	if (editor instanceof EmbeddedCodeEditorWidget) {
 		return editor.getParentEditor();
 	}
diff --git a/src/vs/editor/standalone/browser/standaloneCodeServiceImpl.ts b/src/vs/editor/standalone/browser/standaloneCodeServiceImpl.ts
@@ -15,19 +15,19 @@ import { IResourceInput } from 'vs/platform/editor/common/editor';
 
 export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {
 
-	public getActiveCodeEditor(): ICodeEditor | undefined {
-		return undefined; // not supported in the standalone case
+	public getActiveCodeEditor(): ICodeEditor | null {
+		return null; // not supported in the standalone case
 	}
 
-	public openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
+	public openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
 		if (!source) {
-			return Promise.resolve(undefined);
+			return Promise.resolve(null);
 		}
 
 		return Promise.resolve(this.doOpenEditor(source, input));
 	}
 
-	private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor | undefined {
+	private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor | null {
 		const model = this.findModel(editor, input.resource);
 		if (!model) {
 			if (input.resource) {
@@ -39,7 +39,7 @@ export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {
 					return editor;
 				}
 			}
-			return undefined;
+			return null;
 		}
 
 		const selection = <IRange>(input.options ? input.options.selection : null);
diff --git a/src/vs/editor/test/browser/editorTestServices.ts b/src/vs/editor/test/browser/editorTestServices.ts
@@ -14,10 +14,10 @@ import { IInstantiationService } from 'vs/platform/instantiation/common/instanti
 
 export class TestCodeEditorService extends AbstractCodeEditorService {
 	public lastInput?: IResourceInput;
-	public getActiveCodeEditor(): ICodeEditor | undefined { return undefined; }
-	public openCodeEditor(input: IResourceInput, _source: ICodeEditor | undefined, _sideBySide?: boolean): Promise<ICodeEditor | undefined> {
+	public getActiveCodeEditor(): ICodeEditor | null { return null; }
+	public openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
 		this.lastInput = input;
-		return Promise.resolve(undefined);
+		return Promise.resolve(null);
 	}
 	public registerDecorationType(key: string, options: IDecorationRenderOptions, parentTypeKey?: string): void { }
 	public removeDecorationType(key: string): void { }
diff --git a/src/vs/editor/test/browser/services/decorationRenderOptions.test.ts b/src/vs/editor/test/browser/services/decorationRenderOptions.test.ts
@@ -15,12 +15,12 @@ import { TestTheme, TestThemeService } from 'vs/platform/theme/test/common/testT
 const themeServiceMock = new TestThemeService();
 
 export class TestCodeEditorServiceImpl extends CodeEditorServiceImpl {
-	getActiveCodeEditor(): ICodeEditor | undefined {
-		return undefined;
+	getActiveCodeEditor(): ICodeEditor | null {
+		return null;
 	}
 
-	openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
-		return Promise.resolve(undefined);
+	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
+		return Promise.resolve(null);
 	}
 }
 
diff --git a/src/vs/workbench/browser/parts/editor/breadcrumbsControl.ts b/src/vs/workbench/browser/parts/editor/breadcrumbsControl.ts
@@ -45,7 +45,7 @@ import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
 import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';
 import { IEditorGroupView } from 'vs/workbench/browser/parts/editor/editor';
 import { onDidChangeZoomLevel } from 'vs/base/browser/browser';
-import { withNullAsUndefined } from 'vs/base/common/types';
+import { withNullAsUndefined, withUndefinedAsNull } from 'vs/base/common/types';
 import { ILabelService } from 'vs/platform/label/common/label';
 
 class Item extends BreadcrumbsItem {
@@ -485,7 +485,7 @@ export class BreadcrumbsControl {
 						selection: Range.collapseToStart(element.symbol.selectionRange),
 						revealInCenterIfOutsideViewport: true
 					}
-				}, this._getActiveCodeEditor(), group === SIDE_GROUP);
+				}, withUndefinedAsNull(this._getActiveCodeEditor()), group === SIDE_GROUP);
 			}
 		}
 	}
diff --git a/src/vs/workbench/contrib/scm/browser/dirtydiffDecorator.ts b/src/vs/workbench/contrib/scm/browser/dirtydiffDecorator.ts
@@ -149,7 +149,7 @@ function getChangeTypeColor(theme: ITheme, changeType: ChangeType): Color | unde
 	}
 }
 
-function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor | undefined {
+function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor | null {
 	const diffEditors = accessor.get(ICodeEditorService).listDiffEditors();
 
 	for (const diffEditor of diffEditors) {
diff --git a/src/vs/workbench/services/editor/browser/codeEditorService.ts b/src/vs/workbench/services/editor/browser/codeEditorService.ts
@@ -22,7 +22,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 		super(themeService);
 	}
 
-	getActiveCodeEditor(): ICodeEditor | undefined {
+	getActiveCodeEditor(): ICodeEditor | null {
 		const activeTextEditorWidget = this.editorService.activeTextEditorWidget;
 		if (isCodeEditor(activeTextEditorWidget)) {
 			return activeTextEditorWidget;
@@ -32,10 +32,10 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 			return activeTextEditorWidget.getModifiedEditor();
 		}
 
-		return undefined;
+		return null;
 	}
 
-	openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
+	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
 
 		// Special case: If the active editor is a diff editor and the request to open originates and
 		// targets the modified side of it, we just apply the request there to prevent opening the modified
@@ -62,7 +62,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 		return this.doOpenCodeEditor(input, source, sideBySide);
 	}
 
-	private async doOpenCodeEditor(input: IResourceInput, _source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
+	private async doOpenCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
 		const control = await this.editorService.openEditor(input, sideBySide ? SIDE_GROUP : ACTIVE_GROUP);
 		if (control) {
 			const widget = control.getControl();
@@ -71,7 +71,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 			}
 		}
 
-		return undefined;
+		return null;
 	}
 }
 
diff --git a/src/vs/workbench/test/workbenchTestServices.ts b/src/vs/workbench/test/workbenchTestServices.ts
@@ -1165,14 +1165,14 @@ export class TestCodeEditorService implements ICodeEditorService {
 	addDiffEditor(_editor: IDiffEditor): void { }
 	removeDiffEditor(_editor: IDiffEditor): void { }
 	listDiffEditors(): IDiffEditor[] { return []; }
-	getFocusedCodeEditor(): ICodeEditor | undefined { return undefined; }
+	getFocusedCodeEditor(): ICodeEditor | null { return null; }
 	registerDecorationType(_key: string, _options: IDecorationRenderOptions, _parentTypeKey?: string): void { }
 	removeDecorationType(_key: string): void { }
 	resolveDecorationOptions(_typeKey: string, _writable: boolean): IModelDecorationOptions { return Object.create(null); }
 	setTransientModelProperty(_model: ITextModel, _key: string, _value: any): void { }
 	getTransientModelProperty(_model: ITextModel, _key: string) { }
-	getActiveCodeEditor(): ICodeEditor | undefined { return undefined; }
-	openCodeEditor(_input: IResourceInput, _source: ICodeEditor, _sideBySide?: boolean): Promise<ICodeEditor | undefined> { return Promise.resolve(undefined); }
+	getActiveCodeEditor(): ICodeEditor | null { return null; }
+	openCodeEditor(_input: IResourceInput, _source: ICodeEditor, _sideBySide?: boolean): Promise<ICodeEditor | null> { return Promise.resolve(null); }
 }
 
 export class TestLifecycleService implements ILifecycleService {

Original file line number	Diff line number	Diff line change
`@@ -70,8 +70,8 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC`
`70`	`70`	`return Object.keys(this._diffEditors).map(id => this._diffEditors[id]);`
`71`	`71`	`}`
`72`	`72`
`73`		`- getFocusedCodeEditor(): ICodeEditor \| undefined {`
`74`		`- let editorWithWidgetFocus: ICodeEditor \| undefined;`
	`73`	`+ getFocusedCodeEditor(): ICodeEditor \| null {`
	`74`	`+ let editorWithWidgetFocus: ICodeEditor \| null = null;`
`75`	`75`
`76`	`76`	`const editors = this.listCodeEditors();`
`77`	`77`	`for (const editor of editors) {`
`@@ -124,8 +124,8 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC`
`124`	`124`	`delete this._transientWatchers[w.uri];`
`125`	`125`	`}`
`126`	`126`
`127`		`- abstract getActiveCodeEditor(): ICodeEditor \| undefined;`
`128`		`- abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined>;`
	`127`	`+ abstract getActiveCodeEditor(): ICodeEditor \| null;`
	`128`	`+ abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`export class ModelTransientSettingWatcher {`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,8 @@ export abstract class CodeEditorServiceImpl extends AbstractCodeEditorService {`
`65`	`65`	`return provider.getOptions(this, writable);`
`66`	`66`	`}`
`67`	`67`
`68`		`- abstract getActiveCodeEditor(): ICodeEditor \| undefined;`
`69`		`- abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined>;`
	`68`	`+ abstract getActiveCodeEditor(): ICodeEditor \| null;`
	`69`	`+ abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`interface IModelDecorationOptionsProvider extends IDisposable {`
Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,7 @@ export class DefinitionAction extends EditorAction {`
`163`	`163`	`}`
`164`	`164`	`}`
`165`	`165`
`166`		`- private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location \| LocationLink, sideBySide: boolean): Promise<ICodeEditor \| undefined> {`
	`166`	`+ private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location \| LocationLink, sideBySide: boolean): Promise<ICodeEditor \| null> {`
`167`	`167`	`// range is the target-selection-range when we have one`
`168`	`168`	`// and the the fallback is the 'full' range`
`169`	`169`	`let range: IRange \| undefined = undefined;`
Original file line number	Diff line number	Diff line change
`@@ -57,8 +57,8 @@ export namespace PeekContext {`
`57`	`57`	`export const notInPeekEditor: ContextKeyExpr = inPeekEditor.toNegated();`
`58`	`58`	`}`
`59`	`59`
`60`		`-export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor \| undefined {`
`61`		`- const editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();`
	`60`	`+export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor \| null {`
	`61`	`+ let editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();`
`62`	`62`	`if (editor instanceof EmbeddedCodeEditorWidget) {`
`63`	`63`	`return editor.getParentEditor();`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,19 +15,19 @@ import { IResourceInput } from 'vs/platform/editor/common/editor';`
`15`	`15`
`16`	`16`	`export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`17`	`17`
`18`		`- public getActiveCodeEditor(): ICodeEditor \| undefined {`
`19`		`- return undefined; // not supported in the standalone case`
	`18`	`+ public getActiveCodeEditor(): ICodeEditor \| null {`
	`19`	`+ return null; // not supported in the standalone case`
`20`	`20`	`}`
`21`	`21`
`22`		`- public openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined> {`
	`22`	`+ public openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null> {`
`23`	`23`	`if (!source) {`
`24`		`- return Promise.resolve(undefined);`
	`24`	`+ return Promise.resolve(null);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`return Promise.resolve(this.doOpenEditor(source, input));`
`28`	`28`	`}`
`29`	`29`
`30`		`- private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor \| undefined {`
	`30`	`+ private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor \| null {`
`31`	`31`	`const model = this.findModel(editor, input.resource);`
`32`	`32`	`if (!model) {`
`33`	`33`	`if (input.resource) {`
`@@ -39,7 +39,7 @@ export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`39`	`39`	`return editor;`
`40`	`40`	`}`
`41`	`41`	`}`
`42`		`- return undefined;`
	`42`	`+ return null;`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`const selection = <IRange>(input.options ? input.options.selection : null);`
Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,12 @@ import { TestTheme, TestThemeService } from 'vs/platform/theme/test/common/testT`
`15`	`15`	`const themeServiceMock = new TestThemeService();`
`16`	`16`
`17`	`17`	`export class TestCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`18`		`- getActiveCodeEditor(): ICodeEditor \| undefined {`
`19`		`- return undefined;`
	`18`	`+ getActiveCodeEditor(): ICodeEditor \| null {`
	`19`	`+ return null;`
`20`	`20`	`}`
`21`	`21`
`22`		`- openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined> {`
`23`		`- return Promise.resolve(undefined);`
	`22`	`+ openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null> {`
	`23`	`+ return Promise.resolve(null);`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';`
`45`	`45`	`import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';`
`46`	`46`	`import { IEditorGroupView } from 'vs/workbench/browser/parts/editor/editor';`
`47`	`47`	`import { onDidChangeZoomLevel } from 'vs/base/browser/browser';`
`48`		`-import { withNullAsUndefined } from 'vs/base/common/types';`
	`48`	`+import { withNullAsUndefined, withUndefinedAsNull } from 'vs/base/common/types';`
`49`	`49`	`import { ILabelService } from 'vs/platform/label/common/label';`
`50`	`50`
`51`	`51`	`class Item extends BreadcrumbsItem {`
`@@ -485,7 +485,7 @@ export class BreadcrumbsControl {`
`485`	`485`	`selection: Range.collapseToStart(element.symbol.selectionRange),`
`486`	`486`	`revealInCenterIfOutsideViewport: true`
`487`	`487`	`}`
`488`		`- }, this._getActiveCodeEditor(), group === SIDE_GROUP);`
	`488`	`+ }, withUndefinedAsNull(this._getActiveCodeEditor()), group === SIDE_GROUP);`
`489`	`489`	`}`
`490`	`490`	`}`
`491`	`491`	`}`
Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ function getChangeTypeColor(theme: ITheme, changeType: ChangeType): Color \| unde`
`149`	`149`	`}`
`150`	`150`	`}`
`151`	`151`
`152`		`-function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor \| undefined {`
	`152`	`+function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor \| null {`
`153`	`153`	`const diffEditors = accessor.get(ICodeEditorService).listDiffEditors();`
`154`	`154`
`155`	`155`	`for (const diffEditor of diffEditors) {`