-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
languageConfig.ts
327 lines (300 loc) · 12.2 KB
/
languageConfig.ts
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
/* --------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All Rights Reserved.
* See 'LICENSE' in the project root for license information.
* ------------------------------------------------------------------------------------------ */
'use strict';
import * as vscode from 'vscode';
import * as nls from 'vscode-nls';
import { isString } from '../common';
import { getOutputChannel } from '../logger';
import { CppSettings } from './settings';
nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
const localize: nls.LocalizeFunc = nls.loadMessageBundle();
export interface CommentPattern {
begin: string;
continue: string;
}
interface Rules {
begin: vscode.OnEnterRule[];
continue: vscode.OnEnterRule[];
end: vscode.OnEnterRule[];
}
const escapeChars: RegExp = /[\\\^\$\*\+\?\{\}\(\)\.\!\=\|\[\]\ \/]/; // characters that should be escaped.
// Insert '\\' in front of regexp escape chars.
function escape(chars: string): string {
let result: string = "";
for (const char of chars) {
if (char.match(escapeChars)) {
result += `\\${char}`;
} else {
result += char;
}
}
return result;
}
// BEWARE: below are string representations of regular expressions, so the backslashes must all be escaped.
function getMLBeginPattern(insert: string): string | undefined {
if (insert.startsWith("/*")) {
const match: string = escape(insert.substring(2)); // trim the leading '/*' and escape any troublesome characters.
return `^\\s*\\/\\*${match}(?!\\/)([^\\*]|\\*(?!\\/))*$`;
}
return undefined;
}
function getMLSplitAfterPattern(): string {
return "^\\s*\\*\\/$";
}
function getMLPreviousLinePattern(insert: string): string | undefined {
if (insert.startsWith("/*")) {
return `(?=^(\\s*(\\/\\*\\*|\\*)).*)(?=(?!(\\s*\\*\\/)))`;
}
return undefined;
}
function getMLContinuePattern(insert: string): string | undefined {
if (insert) {
const match: string = escape(insert.trimRight());
if (match) {
const right: string = escape(insert.substring(insert.trimRight().length));
return `^(\\t|[ ])*${match}(${right}([^\\*]|\\*(?!\\/))*)?$`;
}
// else: if the continuation is just whitespace, vscode already does indentation preservation.
}
return undefined;
}
function getMLEmptyEndPattern(insert: string): string | undefined {
insert = insert.trimRight();
if (insert !== "") {
if (insert.endsWith('*')) {
insert = insert.substring(0, insert.length - 1);
}
const match: string = escape(insert.trimRight());
return `^(\\t|[ ])*${match}\\*\\/\\s*$`;
}
// else: if the continuation is just whitespace, don't mess with indentation
// since we don't know if this is a continuation line or not.
return undefined;
}
function getMLEndPattern(insert: string): string | undefined {
const match: string = escape(insert.trimRight().trimLeft());
if (match) {
return `^(\\t|[ ])*${match}[^/]*\\*\\/\\s*$`;
}
// else: if the continuation is just whitespace, don't mess with indentation
// since we don't know if this is a continuation line or not.
return undefined;
}
function getSLBeginPattern(insert: string): string {
const match: string = escape(insert.trimRight());
return `^\\s*${match}.*$`;
}
function getSLContinuePattern(insert: string): string {
const match: string = escape(insert.trimRight());
return `^\\s*${match}.+$`;
}
function getSLEndPattern(insert: string): string {
let match: string = escape(insert);
const trimmed: string = escape(insert.trimRight());
if (match !== trimmed) {
match = `(${match}|${trimmed})`;
}
return `^\\s*${match}$`;
}
// When Enter is pressed while the cursor is between '/**' and '*/' on the same line.
function getMLSplitRule(comment: CommentPattern): vscode.OnEnterRule | undefined {
const beforePattern: string | undefined = getMLBeginPattern(comment.begin);
if (beforePattern) {
return {
beforeText: new RegExp(beforePattern),
afterText: new RegExp(getMLSplitAfterPattern()),
action: {
indentAction: vscode.IndentAction.IndentOutdent,
appendText: comment.continue ? comment.continue : ''
}
};
}
return undefined;
}
// When Enter is pressed while the cursor is after '/**' and there is no '*/' on the same line after the cursor
function getMLFirstLineRule(comment: CommentPattern): vscode.OnEnterRule | undefined {
const beforePattern: string | undefined = getMLBeginPattern(comment.begin);
if (beforePattern) {
return {
beforeText: new RegExp(beforePattern),
action: {
indentAction: vscode.IndentAction.None,
appendText: comment.continue ? comment.continue : ''
}
};
}
return undefined;
}
// When Enter is pressed while the cursor is after the continuation pattern
function getMLContinuationRule(comment: CommentPattern): vscode.OnEnterRule | undefined {
const previousLinePattern: string | undefined = getMLPreviousLinePattern(comment.begin);
if (previousLinePattern) {
const beforePattern: string | undefined = getMLContinuePattern(comment.continue);
if (beforePattern) {
return {
beforeText: new RegExp(beforePattern),
previousLineText: new RegExp(previousLinePattern),
action: {
indentAction: vscode.IndentAction.None,
appendText: comment.continue.trimLeft()
}
};
}
}
return undefined;
}
// When Enter is pressed while the cursor is after '*/' (and '*/' plus leading whitespace is all that is on the line)
function getMLEndRule(comment: CommentPattern): vscode.OnEnterRule | undefined {
const beforePattern: string | undefined = getMLEndPattern(comment.continue);
if (beforePattern) {
return {
beforeText: new RegExp(beforePattern),
action: {
indentAction: vscode.IndentAction.None,
removeText: comment.continue.length - comment.continue.trimLeft().length
}
};
}
return undefined;
}
// When Enter is pressed while the cursor is after the continuation pattern and '*/'
function getMLEmptyEndRule(comment: CommentPattern): vscode.OnEnterRule | undefined {
const beforePattern: string | undefined = getMLEmptyEndPattern(comment.continue);
if (beforePattern) {
return {
beforeText: new RegExp(beforePattern),
action: {
indentAction: vscode.IndentAction.None,
removeText: comment.continue.length - comment.continue.trimLeft().length
}
};
}
return undefined;
}
// When the continue rule is different than the begin rule for single line comments
function getSLFirstLineRule(comment: CommentPattern): vscode.OnEnterRule {
const beforePattern: string = getSLBeginPattern(comment.begin);
return {
beforeText: new RegExp(beforePattern),
action: {
indentAction: vscode.IndentAction.None,
appendText: comment.continue.trimLeft()
}
};
}
// When Enter is pressed while the cursor is after the continuation pattern plus at least one other character.
function getSLContinuationRule(comment: CommentPattern): vscode.OnEnterRule {
const beforePattern: string = getSLContinuePattern(comment.continue);
return {
beforeText: new RegExp(beforePattern),
action: {
indentAction: vscode.IndentAction.None,
appendText: comment.continue.trimLeft()
}
};
}
// When Enter is pressed while the cursor is immediately after the continuation pattern
function getSLEndRule(comment: CommentPattern): vscode.OnEnterRule {
const beforePattern: string = getSLEndPattern(comment.continue);
return {
beforeText: new RegExp(beforePattern),
action: {
indentAction: vscode.IndentAction.None,
removeText: comment.continue.length - comment.continue.trimLeft().length
}
};
}
export function getLanguageConfig(languageId: string): vscode.LanguageConfiguration {
const settings: CppSettings = new CppSettings();
const patterns: (string | CommentPattern)[] | undefined = settings.commentContinuationPatterns;
return getLanguageConfigFromPatterns(languageId, patterns);
}
export function getLanguageConfigFromPatterns(languageId: string, patterns?: (string | CommentPattern)[]): vscode.LanguageConfiguration {
const beginPatterns: string[] = []; // avoid duplicate rules
const continuePatterns: string[] = []; // avoid duplicate rules
let duplicates: boolean = false;
let beginRules: vscode.OnEnterRule[] = [];
let continueRules: vscode.OnEnterRule[] = [];
let endRules: vscode.OnEnterRule[] = [];
if (!patterns) {
patterns = [ "/**" ];
}
patterns.forEach(pattern => {
const c: CommentPattern = isString(pattern) ? { begin: pattern, continue: pattern.startsWith('/*') ? " * " : pattern } : <CommentPattern>pattern;
const r: Rules = constructCommentRules(c, languageId);
if (beginPatterns.indexOf(c.begin) < 0) {
if (r.begin && r.begin.length > 0) {
beginRules = beginRules.concat(r.begin);
}
beginPatterns.push(c.begin);
} else {
duplicates = true;
}
if (continuePatterns.indexOf(c.continue) < 0) {
if (r.continue && r.continue.length > 0) {
continueRules = continueRules.concat(r.continue);
}
if (r.end && r.end.length > 0) {
endRules = endRules.concat(r.end);
}
continuePatterns.push(c.continue);
}
});
if (duplicates) {
getOutputChannel().appendLine(localize("duplicate.multiline.patterns", "Duplicate multiline comment patterns detected."));
}
return { onEnterRules: beginRules.concat(continueRules).concat(endRules).filter(e => e) }; // Remove any 'undefined' entries
}
function constructCommentRules(comment: CommentPattern, languageId: string): Rules {
if (comment?.begin?.startsWith('/*') && (languageId === 'c' || languageId === 'cpp' || languageId === 'cuda-cpp')) {
const mlBegin1: vscode.OnEnterRule | undefined = getMLSplitRule(comment);
if (!mlBegin1) {
throw new Error("Failure in constructCommentRules() - mlBegin1");
}
const mlBegin2: vscode.OnEnterRule | undefined = getMLFirstLineRule(comment);
if (!mlBegin2) {
throw new Error("Failure in constructCommentRules() - mlBegin2");
}
const mlContinue: vscode.OnEnterRule | undefined = getMLContinuationRule(comment);
if (!mlContinue) {
throw new Error("Failure in constructCommentRules() - mlContinue");
}
const mlEnd1: vscode.OnEnterRule | undefined = getMLEmptyEndRule(comment);
if (!mlEnd1) {
throw new Error("Failure in constructCommentRules() - mlEnd1");
}
const mlEnd2: vscode.OnEnterRule | undefined = getMLEndRule(comment);
if (!mlEnd2) {
throw new Error("Failure in constructCommentRules() = mlEnd2");
}
return {
begin: [ mlBegin1, mlBegin2 ],
continue: [ mlContinue ],
end: [ mlEnd1, mlEnd2 ]
};
} else if (comment?.begin?.startsWith('//') && (languageId === 'cpp' || languageId === 'cuda-cpp')) {
const slContinue: vscode.OnEnterRule = getSLContinuationRule(comment);
const slEnd: vscode.OnEnterRule = getSLEndRule(comment);
if (comment.begin !== comment.continue) {
const slBegin: vscode.OnEnterRule = getSLFirstLineRule(comment);
return {
begin: (comment.begin === comment.continue) ? [] : [ slBegin ],
continue: [ slContinue ],
end: [ slEnd ]
};
} else {
return {
begin: [],
continue: [ slContinue ],
end: [ slEnd ]
};
}
}
return {
begin: [],
continue: [],
end: []
};
}