editors - add label property to file inputs

Benjamin Pasero · Benjamin Pasero · commit aa06a3d3b9d8 · 2020-06-20T09:55:02.000+02:00
diff --git a/src/vs/workbench/common/editor.ts b/src/vs/workbench/common/editor.ts
@@ -649,10 +649,16 @@ export interface IModeSupport {
 export interface IFileEditorInput extends IEditorInput, IEncodingSupport, IModeSupport {
 
 	/**
-	 * Gets the resource this editor is about.
+	 * Gets the resource this file input is about.
 	 */
 	readonly resource: URI;
 
+	/**
+	 * Gets the label of the editor. In most cases this will
+	 * be identical to the resource.
+	 */
+	readonly label: URI;
+
 	/**
 	 * Sets the preferred label to use for this file input.
 	 */
diff --git a/src/vs/workbench/common/editor/textResourceEditorInput.ts b/src/vs/workbench/common/editor/textResourceEditorInput.ts
@@ -22,7 +22,8 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {
 
 	private static readonly MEMOIZER = createMemoizer();
 
-	private label: URI;
+	private _label: URI;
+	get label(): URI { return this._label; }
 
 	constructor(
 		public readonly resource: URI,
@@ -36,7 +37,7 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {
 	) {
 		super();
 
-		this.label = preferredLabel || resource;
+		this._label = preferredLabel || resource;
 
 		this.registerListeners();
 	}
@@ -50,7 +51,7 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {
 	}
 
 	private onLabelEvent(scheme: string): void {
-		if (scheme === this.label.scheme) {
+		if (scheme === this._label.scheme) {
 			this.updateLabel();
 		}
 	}
@@ -65,15 +66,15 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {
 	}
 
 	setLabel(label: URI): void {
-		if (!extUri.isEqual(label, this.label)) {
-			this.label = label;
+		if (!extUri.isEqual(label, this._label)) {
+			this._label = label;
 
 			this.updateLabel();
 		}
 	}
 
 	getLabel(): URI {
-		return this.label;
+		return this._label;
 	}
 
 	getName(): string {
@@ -82,7 +83,7 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {
 
 	@AbstractTextResourceEditorInput.MEMOIZER
 	private get basename(): string {
-		return this.labelService.getUriBasenameLabel(this.label);
+		return this.labelService.getUriBasenameLabel(this._label);
 	}
 
 	getDescription(verbosity: Verbosity = Verbosity.MEDIUM): string | undefined {
@@ -99,17 +100,17 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {
 
 	@AbstractTextResourceEditorInput.MEMOIZER
 	private get shortDescription(): string {
-		return this.labelService.getUriBasenameLabel(dirname(this.label));
+		return this.labelService.getUriBasenameLabel(dirname(this._label));
 	}
 
 	@AbstractTextResourceEditorInput.MEMOIZER
 	private get mediumDescription(): string {
-		return this.labelService.getUriLabel(dirname(this.label), { relative: true });
+		return this.labelService.getUriLabel(dirname(this._label), { relative: true });
 	}
 
 	@AbstractTextResourceEditorInput.MEMOIZER
 	private get longDescription(): string {
-		return this.labelService.getUriLabel(dirname(this.label));
+		return this.labelService.getUriLabel(dirname(this._label));
 	}
 
 	@AbstractTextResourceEditorInput.MEMOIZER
@@ -119,12 +120,12 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {
 
 	@AbstractTextResourceEditorInput.MEMOIZER
 	private get mediumTitle(): string {
-		return this.labelService.getUriLabel(this.label, { relative: true });
+		return this.labelService.getUriLabel(this._label, { relative: true });
 	}
 
 	@AbstractTextResourceEditorInput.MEMOIZER
 	private get longTitle(): string {
-		return this.labelService.getUriLabel(this.label);
+		return this.labelService.getUriLabel(this._label);
 	}
 
 	getTitle(verbosity: Verbosity): string {
diff --git a/src/vs/workbench/services/editor/test/browser/editorService.test.ts b/src/vs/workbench/services/editor/test/browser/editorService.test.ts
@@ -1084,7 +1084,7 @@ suite('EditorService', () => {
 		const editor = await service.openEditor(input1, { pinned: true });
 		await service.openEditor(input2, { pinned: true });
 
-		const whenClosed = service.whenClosed([input1, input2]);
+		const whenClosed = service.whenClosed([{ resource: input1.resource }, { resource: input2.resource }]);
 
 		editor?.group?.closeAllEditors();
 

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {`
`22`	`22`
`23`	`23`	`private static readonly MEMOIZER = createMemoizer();`
`24`	`24`
`25`		`- private label: URI;`
	`25`	`+ private _label: URI;`
	`26`	`+ get label(): URI { return this._label; }`
`26`	`27`
`27`	`28`	`constructor(`
`28`	`29`	`public readonly resource: URI,`
`@@ -36,7 +37,7 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {`
`36`	`37`	`) {`
`37`	`38`	`super();`
`38`	`39`
`39`		`- this.label = preferredLabel \|\| resource;`
	`40`	`+ this._label = preferredLabel \|\| resource;`
`40`	`41`
`41`	`42`	`this.registerListeners();`
`42`	`43`	`}`
`@@ -50,7 +51,7 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`private onLabelEvent(scheme: string): void {`
`53`		`- if (scheme === this.label.scheme) {`
	`54`	`+ if (scheme === this._label.scheme) {`
`54`	`55`	`this.updateLabel();`
`55`	`56`	`}`
`56`	`57`	`}`
`@@ -65,15 +66,15 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {`
`65`	`66`	`}`
`66`	`67`
`67`	`68`	`setLabel(label: URI): void {`
`68`		`- if (!extUri.isEqual(label, this.label)) {`
`69`		`- this.label = label;`
	`69`	`+ if (!extUri.isEqual(label, this._label)) {`
	`70`	`+ this._label = label;`
`70`	`71`
`71`	`72`	`this.updateLabel();`
`72`	`73`	`}`
`73`	`74`	`}`
`74`	`75`
`75`	`76`	`getLabel(): URI {`
`76`		`- return this.label;`
	`77`	`+ return this._label;`
`77`	`78`	`}`
`78`	`79`
`79`	`80`	`getName(): string {`
`@@ -82,7 +83,7 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {`
`82`	`83`
`83`	`84`	`@AbstractTextResourceEditorInput.MEMOIZER`
`84`	`85`	`private get basename(): string {`
`85`		`- return this.labelService.getUriBasenameLabel(this.label);`
	`86`	`+ return this.labelService.getUriBasenameLabel(this._label);`
`86`	`87`	`}`
`87`	`88`
`88`	`89`	`getDescription(verbosity: Verbosity = Verbosity.MEDIUM): string \| undefined {`
`@@ -99,17 +100,17 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {`
`99`	`100`
`100`	`101`	`@AbstractTextResourceEditorInput.MEMOIZER`
`101`	`102`	`private get shortDescription(): string {`
`102`		`- return this.labelService.getUriBasenameLabel(dirname(this.label));`
	`103`	`+ return this.labelService.getUriBasenameLabel(dirname(this._label));`
`103`	`104`	`}`
`104`	`105`
`105`	`106`	`@AbstractTextResourceEditorInput.MEMOIZER`
`106`	`107`	`private get mediumDescription(): string {`
`107`		`- return this.labelService.getUriLabel(dirname(this.label), { relative: true });`
	`108`	`+ return this.labelService.getUriLabel(dirname(this._label), { relative: true });`
`108`	`109`	`}`
`109`	`110`
`110`	`111`	`@AbstractTextResourceEditorInput.MEMOIZER`
`111`	`112`	`private get longDescription(): string {`
`112`		`- return this.labelService.getUriLabel(dirname(this.label));`
	`113`	`+ return this.labelService.getUriLabel(dirname(this._label));`
`113`	`114`	`}`
`114`	`115`
`115`	`116`	`@AbstractTextResourceEditorInput.MEMOIZER`
`@@ -119,12 +120,12 @@ export abstract class AbstractTextResourceEditorInput extends EditorInput {`
`119`	`120`
`120`	`121`	`@AbstractTextResourceEditorInput.MEMOIZER`
`121`	`122`	`private get mediumTitle(): string {`
`122`		`- return this.labelService.getUriLabel(this.label, { relative: true });`
	`123`	`+ return this.labelService.getUriLabel(this._label, { relative: true });`
`123`	`124`	`}`
`124`	`125`
`125`	`126`	`@AbstractTextResourceEditorInput.MEMOIZER`
`126`	`127`	`private get longTitle(): string {`
`127`		`- return this.labelService.getUriLabel(this.label);`
	`128`	`+ return this.labelService.getUriLabel(this._label);`
`128`	`129`	`}`
`129`	`130`
`130`	`131`	`getTitle(verbosity: Verbosity): string {`