1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { localize } from 'vs/nls';
import { URI } from 'vs/base/common/uri';
import { IDisposable, Disposable } from 'vs/base/common/lifecycle';
import { posix, win32 } from 'vs/base/common/path';
import { Emitter } from 'vs/base/common/event';
import { Extensions as WorkbenchExtensions, IWorkbenchContributionsRegistry, IWorkbenchContribution } from 'vs/workbench/common/contributions';
import { Registry } from 'vs/platform/registry/common/platform';
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
import { IWorkspaceContextService, IWorkspace, isWorkspace, ISingleFolderWorkspaceIdentifier, isSingleFolderWorkspaceIdentifier, isWorkspaceIdentifier, IWorkspaceIdentifier, toWorkspaceIdentifier, WORKSPACE_EXTENSION, isUntitledWorkspace, isTemporaryWorkspace } from 'vs/platform/workspace/common/workspace';
import { basenameOrAuthority, basename, joinPath, dirname } from 'vs/base/common/resources';
import { tildify, getPathLabel } from 'vs/base/common/labels';
import { ILabelService, ResourceLabelFormatter, ResourceLabelFormatting, IFormatterChangeEvent } from 'vs/platform/label/common/label';
import { ExtensionsRegistry } from 'vs/workbench/services/extensions/common/extensionsRegistry';
import { match } from 'vs/base/common/glob';
import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle';
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
import { IPathService } from 'vs/workbench/services/path/common/pathService';
import { isProposedApiEnabled } from 'vs/workbench/services/extensions/common/extensions';
import { OperatingSystem, OS } from 'vs/base/common/platform';
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
import { Schemas } from 'vs/base/common/network';
const resourceLabelFormattersExtPoint = ExtensionsRegistry.registerExtensionPoint<ResourceLabelFormatter[]>({
extensionPoint: 'resourceLabelFormatters',
jsonSchema: {
description: localize('vscode.extension.contributes.resourceLabelFormatters', 'Contributes resource label formatting rules.'),
type: 'array',
items: {
type: 'object',
required: ['scheme', 'formatting'],
properties: {
scheme: {
type: 'string',
description: localize('vscode.extension.contributes.resourceLabelFormatters.scheme', 'URI scheme on which to match the formatter on. For example "file". Simple glob patterns are supported.'),
},
authority: {
type: 'string',
description: localize('vscode.extension.contributes.resourceLabelFormatters.authority', 'URI authority on which to match the formatter on. Simple glob patterns are supported.'),
},
formatting: {
description: localize('vscode.extension.contributes.resourceLabelFormatters.formatting', "Rules for formatting uri resource labels."),
type: 'object',
properties: {
label: {
type: 'string',
description: localize('vscode.extension.contributes.resourceLabelFormatters.label', "Label rules to display. For example: myLabel:/${path}. ${path}, ${scheme} and ${authority} are supported as variables.")
},
separator: {
type: 'string',
description: localize('vscode.extension.contributes.resourceLabelFormatters.separator', "Separator to be used in the uri label display. '/' or '\' as an example.")
},
stripPathStartingSeparator: {
type: 'boolean',
description: localize('vscode.extension.contributes.resourceLabelFormatters.stripPathStartingSeparator', "Controls whether `${path}` substitutions should have starting separator characters stripped.")
},
tildify: {
type: 'boolean',
description: localize('vscode.extension.contributes.resourceLabelFormatters.tildify', "Controls if the start of the uri label should be tildified when possible.")
},
workspaceSuffix: {
type: 'string',
description: localize('vscode.extension.contributes.resourceLabelFormatters.formatting.workspaceSuffix', "Suffix appended to the workspace label.")
}
}
}
}
}
}
});
const sepRegexp = /\//g;
const labelMatchingRegexp = /\$\{(scheme|authority|path|(query)\.(.+?))\}/g;
function hasDriveLetterIgnorePlatform(path: string): boolean {
return !!(path && path[2] === ':');
}
class ResourceLabelFormattersHandler implements IWorkbenchContribution {
private readonly formattersDisposables = new Map<ResourceLabelFormatter, IDisposable>();
constructor(@ILabelService labelService: ILabelService) {
resourceLabelFormattersExtPoint.setHandler((extensions, delta) => {
delta.added.forEach(added => added.value.forEach(formatter => {
if (!isProposedApiEnabled(added.description, 'contribLabelFormatterWorkspaceTooltip') && formatter.formatting.workspaceTooltip) {
formatter.formatting.workspaceTooltip = undefined; // workspaceTooltip is only proposed
}
this.formattersDisposables.set(formatter, labelService.registerFormatter(formatter));
}));
delta.removed.forEach(removed => removed.value.forEach(formatter => {
this.formattersDisposables.get(formatter)!.dispose();
}));
});
}
}
Registry.as<IWorkbenchContributionsRegistry>(WorkbenchExtensions.Workbench).registerWorkbenchContribution(ResourceLabelFormattersHandler, LifecyclePhase.Restored);
export class LabelService extends Disposable implements ILabelService {
declare readonly _serviceBrand: undefined;
private formatters: ResourceLabelFormatter[] = [];
private readonly _onDidChangeFormatters = this._register(new Emitter<IFormatterChangeEvent>({ leakWarningThreshold: 400 }));
readonly onDidChangeFormatters = this._onDidChangeFormatters.event;
private os: OperatingSystem;
private userHome: URI | undefined;
constructor(
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
@IWorkspaceContextService private readonly contextService: IWorkspaceContextService,
@IPathService private readonly pathService: IPathService,
@IRemoteAgentService private readonly remoteAgentService: IRemoteAgentService
) {
super();
// Find some meaningful defaults until the remote environment
// is resolved, by taking the current OS we are running in
// and by taking the local `userHome` if we run on a local
// file scheme.
this.os = OS;
this.userHome = pathService.defaultUriScheme === Schemas.file ? this.pathService.userHome({ preferLocal: true }) : undefined;
// Remote environment is potentially long running
this.resolveRemoteEnvironment();
}
private async resolveRemoteEnvironment(): Promise<void> {
// OS
const env = await this.remoteAgentService.getEnvironment();
this.os = env?.os ?? OS;
// User home
this.userHome = await this.pathService.userHome();
}
findFormatting(resource: URI): ResourceLabelFormatting | undefined {
let bestResult: ResourceLabelFormatter | undefined;
for (const formatter of this.formatters) {
if (formatter.scheme === resource.scheme) {
if (!formatter.authority && (!bestResult || formatter.priority)) {
bestResult = formatter;
continue;
}
if (!formatter.authority) {
continue;
}
if (
match(formatter.authority.toLowerCase(), resource.authority.toLowerCase()) &&
(
!bestResult ||
!bestResult.authority ||
formatter.authority.length > bestResult.authority.length ||
((formatter.authority.length === bestResult.authority.length) && formatter.priority)
)
) {
bestResult = formatter;
}
}
}
return bestResult ? bestResult.formatting : undefined;
}
getUriLabel(resource: URI, options: { relative?: boolean; noPrefix?: boolean; separator?: '/' | '\\' } = {}): string {
let formatting = this.findFormatting(resource);
if (formatting && options.separator) {
// mixin separator if defined from the outside
formatting = { ...formatting, separator: options.separator };
}
const label = this.doGetUriLabel(resource, formatting, options);
// Without formatting we still need to support the separator
// as provided in options (https://github.com/microsoft/vscode/issues/130019)
if (!formatting && options.separator) {
return label.replace(sepRegexp, options.separator);
}
return label;
}
private doGetUriLabel(resource: URI, formatting?: ResourceLabelFormatting, options: { relative?: boolean; noPrefix?: boolean } = {}): string {
if (!formatting) {
return getPathLabel(resource, {
os: this.os,
tildify: this.userHome ? { userHome: this.userHome } : undefined,
relative: options.relative ? {
noPrefix: options.noPrefix,
getWorkspace: () => this.contextService.getWorkspace(),
getWorkspaceFolder: resource => this.contextService.getWorkspaceFolder(resource)
} : undefined
});
}
// Relative label
if (options.relative) {
const folder = this.contextService?.getWorkspaceFolder(resource);
if (folder) {
const folderLabel = this.formatUri(folder.uri, formatting, options.noPrefix);
let relativeLabel = this.formatUri(resource, formatting, options.noPrefix);
let overlap = 0;
while (relativeLabel[overlap] && relativeLabel[overlap] === folderLabel[overlap]) {
overlap++;
}
if (!relativeLabel[overlap] || relativeLabel[overlap] === formatting.separator) {
relativeLabel = relativeLabel.substring(1 + overlap);
} else if (overlap === folderLabel.length && folder.uri.path === posix.sep) {
relativeLabel = relativeLabel.substring(overlap);
}
// always show root basename if there are multiple folders
const hasMultipleRoots = this.contextService.getWorkspace().folders.length > 1;
if (hasMultipleRoots && !options.noPrefix) {
const rootName = folder?.name ?? basenameOrAuthority(folder.uri);
relativeLabel = relativeLabel ? `${rootName} • ${relativeLabel}` : rootName;
}
return relativeLabel;
}
}
// Absolute label
return this.formatUri(resource, formatting, options.noPrefix);
}
getUriBasenameLabel(resource: URI): string {
const formatting = this.findFormatting(resource);
const label = this.doGetUriLabel(resource, formatting);
let pathLib: typeof win32 | typeof posix;
if (formatting?.separator === win32.sep) {
pathLib = win32;
} else if (formatting?.separator === posix.sep) {
pathLib = posix;
} else {
pathLib = (this.os === OperatingSystem.Windows) ? win32 : posix;
}
return pathLib.basename(label);
}
getWorkspaceLabel(workspace: IWorkspace | IWorkspaceIdentifier | ISingleFolderWorkspaceIdentifier | URI, options?: { verbose: boolean }): string {
if (isWorkspace(workspace)) {
const identifier = toWorkspaceIdentifier(workspace);
if (identifier) {
return this.getWorkspaceLabel(identifier, options);
}
return '';
}
// Workspace: Single Folder (as URI)
if (URI.isUri(workspace)) {
return this.doGetSingleFolderWorkspaceLabel(workspace, options);
}
// Workspace: Single Folder (as workspace identifier)
if (isSingleFolderWorkspaceIdentifier(workspace)) {
return this.doGetSingleFolderWorkspaceLabel(workspace.uri, options);
}
// Workspace: Multi Root
if (isWorkspaceIdentifier(workspace)) {
return this.doGetWorkspaceLabel(workspace.configPath, options);
}
return '';
}
private doGetWorkspaceLabel(workspaceUri: URI, options?: { verbose: boolean }): string {
// Workspace: Untitled
if (isUntitledWorkspace(workspaceUri, this.environmentService)) {
return localize('untitledWorkspace', "Untitled (Workspace)");
}
// Workspace: Temporary
if (isTemporaryWorkspace(workspaceUri)) {
return localize('temporaryWorkspace', "Workspace");
}
// Workspace: Saved
let filename = basename(workspaceUri);
if (filename.endsWith(WORKSPACE_EXTENSION)) {
filename = filename.substr(0, filename.length - WORKSPACE_EXTENSION.length - 1);
}
let label: string;
if (options?.verbose) {
label = localize('workspaceNameVerbose', "{0} (Workspace)", this.getUriLabel(joinPath(dirname(workspaceUri), filename)));
} else {
label = localize('workspaceName', "{0} (Workspace)", filename);
}
return this.appendWorkspaceSuffix(label, workspaceUri);
}
private doGetSingleFolderWorkspaceLabel(folderUri: URI, options?: { verbose: boolean }): string {
const label = options?.verbose ? this.getUriLabel(folderUri) : basename(folderUri) || posix.sep;
return this.appendWorkspaceSuffix(label, folderUri);
}
getSeparator(scheme: string, authority?: string): '/' | '\\' {
const formatter = this.findFormatting(URI.from({ scheme, authority }));
return formatter?.separator || posix.sep;
}
getHostLabel(scheme: string, authority?: string): string {
const formatter = this.findFormatting(URI.from({ scheme, authority }));
return formatter?.workspaceSuffix || authority || '';
}
getHostTooltip(scheme: string, authority?: string): string | undefined {
const formatter = this.findFormatting(URI.from({ scheme, authority }));
return formatter?.workspaceTooltip;
}
registerFormatter(formatter: ResourceLabelFormatter): IDisposable {
this.formatters.push(formatter);
this._onDidChangeFormatters.fire({ scheme: formatter.scheme });
return {
dispose: () => {
this.formatters = this.formatters.filter(f => f !== formatter);
this._onDidChangeFormatters.fire({ scheme: formatter.scheme });
}
};
}
private formatUri(resource: URI, formatting: ResourceLabelFormatting, forceNoTildify?: boolean): string {
let label = formatting.label.replace(labelMatchingRegexp, (match, token, qsToken, qsValue) => {
switch (token) {
case 'scheme': return resource.scheme;
case 'authority': return resource.authority;
case 'path':
return formatting.stripPathStartingSeparator
? resource.path.slice(resource.path[0] === formatting.separator ? 1 : 0)
: resource.path;
default: {
if (qsToken === 'query') {
const { query } = resource;
if (query && query[0] === '{' && query[query.length - 1] === '}') {
try {
return JSON.parse(query)[qsValue] || '';
} catch { }
}
}
return '';
}
}
});
// convert \c:\something => C:\something
if (formatting.normalizeDriveLetter && hasDriveLetterIgnorePlatform(label)) {
label = label.charAt(1).toUpperCase() + label.substr(2);
}
if (formatting.tildify && !forceNoTildify) {
if (this.userHome) {
label = tildify(label, this.userHome.fsPath, this.os);
}
}
if (formatting.authorityPrefix && resource.authority) {
label = formatting.authorityPrefix + label;
}
return label.replace(sepRegexp, formatting.separator);
}
private appendWorkspaceSuffix(label: string, uri: URI): string {
const formatting = this.findFormatting(uri);
const suffix = formatting && (typeof formatting.workspaceSuffix === 'string') ? formatting.workspaceSuffix : undefined;
return suffix ? `${label} [${suffix}]` : label;
}
}
registerSingleton(ILabelService, LabelService, true);
|