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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { parse as jsonParse, getNodeType } from 'vs/base/common/json';
import { forEach } from 'vs/base/common/collections';
import { localize } from 'vs/nls';
import { extname, basename } from 'vs/base/common/path';
import { SnippetParser, Variable, Placeholder, Text } from 'vs/editor/contrib/snippet/browser/snippetParser';
import { KnownSnippetVariableNames } from 'vs/editor/contrib/snippet/browser/snippetVariables';
import { isFalsyOrWhitespace } from 'vs/base/common/strings';
import { URI } from 'vs/base/common/uri';
import { IFileService } from 'vs/platform/files/common/files';
import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
import { IdleValue } from 'vs/base/common/async';
import { IExtensionResourceLoaderService } from 'vs/workbench/services/extensionResourceLoader/common/extensionResourceLoader';
import { relativePath } from 'vs/base/common/resources';
import { isObject } from 'vs/base/common/types';
import { Iterable } from 'vs/base/common/iterator';
import { tail } from 'vs/base/common/arrays';
class SnippetBodyInsights {
readonly codeSnippet: string;
/** The snippet uses bad placeholders which collide with variable names */
readonly isBogous: boolean;
/** The snippet has no placeholder of the final placeholder is at the end */
readonly isTrivial: boolean;
readonly usesClipboardVariable: boolean;
readonly usesSelectionVariable: boolean;
constructor(body: string) {
// init with defaults
this.isBogous = false;
this.isTrivial = false;
this.usesClipboardVariable = false;
this.usesSelectionVariable = false;
this.codeSnippet = body;
// check snippet...
const textmateSnippet = new SnippetParser().parse(body, false);
let placeholders = new Map<string, number>();
let placeholderMax = 0;
for (const placeholder of textmateSnippet.placeholders) {
placeholderMax = Math.max(placeholderMax, placeholder.index);
}
// mark snippet as trivial when there is no placeholders or when the only
// placeholder is the final tabstop and it is at the very end.
if (textmateSnippet.placeholders.length === 0) {
this.isTrivial = true;
} else if (placeholderMax === 0) {
const last = tail(textmateSnippet.children);
this.isTrivial = last instanceof Placeholder && last.isFinalTabstop;
}
let stack = [...textmateSnippet.children];
while (stack.length > 0) {
const marker = stack.shift()!;
if (marker instanceof Variable) {
if (marker.children.length === 0 && !KnownSnippetVariableNames[marker.name]) {
// a 'variable' without a default value and not being one of our supported
// variables is automatically turned into a placeholder. This is to restore
// a bug we had before. So `${foo}` becomes `${N:foo}`
const index = placeholders.has(marker.name) ? placeholders.get(marker.name)! : ++placeholderMax;
placeholders.set(marker.name, index);
const synthetic = new Placeholder(index).appendChild(new Text(marker.name));
textmateSnippet.replace(marker, [synthetic]);
this.isBogous = true;
}
switch (marker.name) {
case 'CLIPBOARD':
this.usesClipboardVariable = true;
break;
case 'SELECTION':
case 'TM_SELECTED_TEXT':
this.usesSelectionVariable = true;
break;
}
} else {
// recurse
stack.push(...marker.children);
}
}
if (this.isBogous) {
this.codeSnippet = textmateSnippet.toTextmateString();
}
}
}
export class Snippet {
private readonly _bodyInsights: IdleValue<SnippetBodyInsights>;
readonly prefixLow: string;
constructor(
readonly scopes: string[],
readonly name: string,
readonly prefix: string,
readonly description: string,
readonly body: string,
readonly source: string,
readonly snippetSource: SnippetSource,
readonly snippetIdentifier?: string
) {
this.prefixLow = prefix.toLowerCase();
this._bodyInsights = new IdleValue(() => new SnippetBodyInsights(this.body));
}
get codeSnippet(): string {
return this._bodyInsights.value.codeSnippet;
}
get isBogous(): boolean {
return this._bodyInsights.value.isBogous;
}
get isTrivial(): boolean {
return this._bodyInsights.value.isTrivial;
}
get needsClipboard(): boolean {
return this._bodyInsights.value.usesClipboardVariable;
}
get usesSelection(): boolean {
return this._bodyInsights.value.usesSelectionVariable;
}
static compare(a: Snippet, b: Snippet): number {
if (a.snippetSource < b.snippetSource) {
return -1;
} else if (a.snippetSource > b.snippetSource) {
return 1;
} else if (a.source < b.source) {
return -1;
} else if (a.source > b.source) {
return 1;
} else if (a.name > b.name) {
return 1;
} else if (a.name < b.name) {
return -1;
} else {
return 0;
}
}
}
interface JsonSerializedSnippet {
body: string | string[];
scope: string;
prefix: string | string[] | undefined;
description: string;
}
function isJsonSerializedSnippet(thing: any): thing is JsonSerializedSnippet {
return isObject(thing) && Boolean((<JsonSerializedSnippet>thing).body);
}
interface JsonSerializedSnippets {
[name: string]: JsonSerializedSnippet | { [name: string]: JsonSerializedSnippet };
}
export const enum SnippetSource {
User = 1,
Workspace = 2,
Extension = 3,
}
export class SnippetFile {
readonly data: Snippet[] = [];
readonly isGlobalSnippets: boolean;
readonly isUserSnippets: boolean;
private _loadPromise?: Promise<this>;
constructor(
readonly source: SnippetSource,
readonly location: URI,
public defaultScopes: string[] | undefined,
private readonly _extension: IExtensionDescription | undefined,
private readonly _fileService: IFileService,
private readonly _extensionResourceLoaderService: IExtensionResourceLoaderService
) {
this.isGlobalSnippets = extname(location.path) === '.code-snippets';
this.isUserSnippets = !this._extension;
}
select(selector: string, bucket: Snippet[]): void {
if (this.isGlobalSnippets || !this.isUserSnippets) {
this._scopeSelect(selector, bucket);
} else {
this._filepathSelect(selector, bucket);
}
}
private _filepathSelect(selector: string, bucket: Snippet[]): void {
// for `fooLang.json` files all snippets are accepted
if (selector + '.json' === basename(this.location.path)) {
bucket.push(...this.data);
}
}
private _scopeSelect(selector: string, bucket: Snippet[]): void {
// for `my.code-snippets` files we need to look at each snippet
for (const snippet of this.data) {
const len = snippet.scopes.length;
if (len === 0) {
// always accept
bucket.push(snippet);
} else {
for (let i = 0; i < len; i++) {
// match
if (snippet.scopes[i] === selector) {
bucket.push(snippet);
break; // match only once!
}
}
}
}
let idx = selector.lastIndexOf('.');
if (idx >= 0) {
this._scopeSelect(selector.substring(0, idx), bucket);
}
}
private async _load(): Promise<string> {
if (this._extension) {
return this._extensionResourceLoaderService.readExtensionResource(this.location);
} else {
const content = await this._fileService.readFile(this.location);
return content.value.toString();
}
}
load(): Promise<this> {
if (!this._loadPromise) {
this._loadPromise = Promise.resolve(this._load()).then(content => {
const data = <JsonSerializedSnippets>jsonParse(content);
if (getNodeType(data) === 'object') {
forEach(data, entry => {
const { key: name, value: scopeOrTemplate } = entry;
if (isJsonSerializedSnippet(scopeOrTemplate)) {
this._parseSnippet(name, scopeOrTemplate, this.data);
} else {
forEach(scopeOrTemplate, entry => {
const { key: name, value: template } = entry;
this._parseSnippet(name, template, this.data);
});
}
});
}
return this;
});
}
return this._loadPromise;
}
reset(): void {
this._loadPromise = undefined;
this.data.length = 0;
}
private _parseSnippet(name: string, snippet: JsonSerializedSnippet, bucket: Snippet[]): void {
let { prefix, body, description } = snippet;
if (!prefix) {
prefix = '';
}
if (Array.isArray(body)) {
body = body.join('\n');
}
if (typeof body !== 'string') {
return;
}
if (Array.isArray(description)) {
description = description.join('\n');
}
let scopes: string[];
if (this.defaultScopes) {
scopes = this.defaultScopes;
} else if (typeof snippet.scope === 'string') {
scopes = snippet.scope.split(',').map(s => s.trim()).filter(s => !isFalsyOrWhitespace(s));
} else {
scopes = [];
}
let source: string;
if (this._extension) {
// extension snippet -> show the name of the extension
source = this._extension.displayName || this._extension.name;
} else if (this.source === SnippetSource.Workspace) {
// workspace -> only *.code-snippets files
source = localize('source.workspaceSnippetGlobal', "Workspace Snippet");
} else {
// user -> global (*.code-snippets) and language snippets
if (this.isGlobalSnippets) {
source = localize('source.userSnippetGlobal', "Global User Snippet");
} else {
source = localize('source.userSnippet', "User Snippet");
}
}
for (const _prefix of Array.isArray(prefix) ? prefix : Iterable.single(prefix)) {
bucket.push(new Snippet(
scopes,
name,
_prefix,
description,
body,
source,
this.source,
this._extension && `${relativePath(this._extension.extensionLocation, this.location)}/${name}`
));
}
}
}
|