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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as glob from 'vs/base/common/glob';
import { Event } from 'vs/base/common/event';
import { IDisposable } from 'vs/base/common/lifecycle';
import { Schemas } from 'vs/base/common/network';
import { posix } from 'vs/base/common/path';
import { basename } from 'vs/base/common/resources';
import { URI } from 'vs/base/common/uri';
import { localize } from 'vs/nls';
import { workbenchConfigurationNodeBase } from 'vs/workbench/common/configuration';
import { Extensions as ConfigurationExtensions, IConfigurationNode, IConfigurationRegistry } from 'vs/platform/configuration/common/configurationRegistry';
import { IResourceEditorInput, ITextResourceEditorInput } from 'vs/platform/editor/common/editor';
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
import { Registry } from 'vs/platform/registry/common/platform';
import { EditorInputWithOptions, EditorInputWithOptionsAndGroup, IResourceDiffEditorInput, IResourceMergeEditorInput, IUntitledTextResourceEditorInput, IUntypedEditorInput } from 'vs/workbench/common/editor';
import { IEditorGroup } from 'vs/workbench/services/editor/common/editorGroupsService';
import { PreferredGroup } from 'vs/workbench/services/editor/common/editorService';
export const IEditorResolverService = createDecorator<IEditorResolverService>('editorResolverService');
//#region Editor Associations
// Static values for registered editors
export type EditorAssociation = {
readonly viewType: string;
readonly filenamePattern?: string;
};
export type EditorAssociations = readonly EditorAssociation[];
export const editorsAssociationsSettingId = 'workbench.editorAssociations';
const configurationRegistry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration);
const editorAssociationsConfigurationNode: IConfigurationNode = {
...workbenchConfigurationNodeBase,
properties: {
'workbench.editorAssociations': {
type: 'object',
markdownDescription: localize('editor.editorAssociations', "Configure glob patterns to editors (e.g. `\"*.hex\": \"hexEditor.hexEdit\"`). These have precedence over the default behavior."),
additionalProperties: {
type: 'string'
}
}
}
};
export interface IEditorType {
readonly id: string;
readonly displayName: string;
readonly providerDisplayName: string;
}
configurationRegistry.registerConfiguration(editorAssociationsConfigurationNode);
//#endregion
//#region EditorResolverService types
export enum RegisteredEditorPriority {
builtin = 'builtin',
option = 'option',
exclusive = 'exclusive',
default = 'default'
}
/**
* If we didn't resolve an editor dictates what to do with the opening state
* ABORT = Do not continue with opening the editor
* NONE = Continue as if the resolution has been disabled as the service could not resolve one
*/
export const enum ResolvedStatus {
ABORT = 1,
NONE = 2,
}
export type ResolvedEditor = EditorInputWithOptionsAndGroup | ResolvedStatus;
export type RegisteredEditorOptions = {
/**
* If your editor cannot be opened in multiple groups for the same resource
*/
singlePerResource?: boolean | (() => boolean);
/**
* If your editor supports diffs
*/
canHandleDiff?: boolean | (() => boolean);
/**
* Whether or not you can support opening the given resource.
* If omitted we assume you can open everything
*/
canSupportResource?: (resource: URI) => boolean;
};
export type RegisteredEditorInfo = {
id: string;
label: string;
detail?: string;
priority: RegisteredEditorPriority;
};
type EditorInputFactoryResult = EditorInputWithOptions | Promise<EditorInputWithOptions>;
export type EditorInputFactoryFunction = (editorInput: IResourceEditorInput | ITextResourceEditorInput, group: IEditorGroup) => EditorInputFactoryResult;
export type UntitledEditorInputFactoryFunction = (untitledEditorInput: IUntitledTextResourceEditorInput, group: IEditorGroup) => EditorInputFactoryResult;
export type DiffEditorInputFactoryFunction = (diffEditorInput: IResourceDiffEditorInput, group: IEditorGroup) => EditorInputFactoryResult;
export type MergeEditorInputFactoryFunction = (mergeEditorInput: IResourceMergeEditorInput, group: IEditorGroup) => EditorInputFactoryResult;
export interface IEditorResolverService {
readonly _serviceBrand: undefined;
/**
* Given a resource finds the editor associations that match it from the user's settings
* @param resource The resource to match
* @return The matching associations
*/
getAssociationsForResource(resource: URI): EditorAssociations;
/**
* Updates the user's association to include a specific editor ID as a default for the given glob pattern
* @param globPattern The glob pattern (must be a string as settings don't support relative glob)
* @param editorID The ID of the editor to make a user default
*/
updateUserAssociations(globPattern: string, editorID: string): void;
/**
* Emitted when an editor is registered or unregistered.
*/
readonly onDidChangeEditorRegistrations: Event<void>;
/**
* Registers a specific editor.
* @param globPattern The glob pattern for this registration
* @param editorInfo Information about the registration
* @param options Specific options which apply to this registration
* @param createEditorInput The factory method for creating inputs
*/
registerEditor(
globPattern: string | glob.IRelativePattern,
editorInfo: RegisteredEditorInfo,
options: RegisteredEditorOptions,
createEditorInput: EditorInputFactoryFunction,
createUntitledEditorInput?: UntitledEditorInputFactoryFunction,
createDiffEditorInput?: DiffEditorInputFactoryFunction,
createMergeEditorInput?: MergeEditorInputFactoryFunction
): IDisposable;
/**
* Given an editor resolves it to the suitable EditorInputWithOptionsAndGroup based on user extensions, settings, and built-in editors
* @param editor The editor to resolve
* @param preferredGroup The group you want to open the editor in
* @returns An EditorInputWithOptionsAndGroup if there is an available editor or a status of how to proceed
*/
resolveEditor(editor: EditorInputWithOptions | IUntypedEditorInput, preferredGroup: PreferredGroup | undefined): Promise<ResolvedEditor>;
/**
* Given a resource returns all the editor ids that match that resource. If there is exclusive editor we return an empty array
* @param resource The resource
* @returns A list of editor ids
*/
getEditors(resource: URI): RegisteredEditorInfo[];
/**
* A set of all the editors that are registered to the editor resolver.
*/
getEditors(): RegisteredEditorInfo[];
}
//#endregion
//#region Util functions
export function priorityToRank(priority: RegisteredEditorPriority): number {
switch (priority) {
case RegisteredEditorPriority.exclusive:
return 5;
case RegisteredEditorPriority.default:
return 4;
case RegisteredEditorPriority.builtin:
return 3;
// Text editor is priority 2
case RegisteredEditorPriority.option:
default:
return 1;
}
}
export function globMatchesResource(globPattern: string | glob.IRelativePattern, resource: URI): boolean {
const excludedSchemes = new Set([
Schemas.extension,
Schemas.webviewPanel,
Schemas.vscodeWorkspaceTrust,
Schemas.walkThrough,
Schemas.vscodeSettings
]);
// We want to say that the above schemes match no glob patterns
if (excludedSchemes.has(resource.scheme)) {
return false;
}
const matchOnPath = typeof globPattern === 'string' && globPattern.indexOf(posix.sep) >= 0;
const target = matchOnPath ? `${resource.scheme}:${resource.path}` : basename(resource);
return glob.match(typeof globPattern === 'string' ? globPattern.toLowerCase() : globPattern, target.toLowerCase());
}
//#endregion
|