-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
settings.ts
409 lines (348 loc) · 18 KB
/
settings.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
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
400
401
402
403
404
405
406
407
408
409
/* --------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All Rights Reserved.
* See 'LICENSE' in the project root for license information.
* ------------------------------------------------------------------------------------------ */
'use strict';
const elementId: { [key: string]: string } = {
// Basic settings
configName: "configName",
configNameInvalid: "configNameInvalid",
configSelection: "configSelection",
addConfigDiv: "addConfigDiv",
addConfigBtn: "addConfigBtn",
addConfigInputDiv: "addConfigInputDiv",
addConfigOk: "addConfigOk",
addConfigCancel: "addConfigCancel",
addConfigName: "addConfigName",
compilerPath: "compilerPath",
compilerPathInvalid: "compilerPathInvalid",
knownCompilers: "knownCompilers",
noCompilerPathsDetected: "noCompilerPathsDetected",
compilerArgs: "compilerArgs",
intelliSenseMode: "intelliSenseMode",
intelliSenseModeInvalid: "intelliSenseModeInvalid",
includePath: "includePath",
includePathInvalid: "includePathInvalid",
defines: "defines",
cStandard: "cStandard",
cppStandard: "cppStandard",
// Advanced settings
windowsSdkVersion: "windowsSdkVersion",
macFrameworkPath: "macFrameworkPath",
macFrameworkPathInvalid: "macFrameworkPathInvalid",
compileCommands: "compileCommands",
compileCommandsInvalid: "compileCommandsInvalid",
configurationProvider: "configurationProvider",
forcedInclude: "forcedInclude",
forcedIncludeInvalid: "forcedIncludeInvalid",
mergeConfigurations: "mergeConfigurations",
dotConfig: "dotConfig",
dotConfigInvalid: "dotConfigInvalid",
// Browse properties
browsePath: "browsePath",
browsePathInvalid: "browsePathInvalid",
limitSymbolsToIncludedHeaders: "limitSymbolsToIncludedHeaders",
databaseFilename: "databaseFilename",
databaseFilenameInvalid: "databaseFilenameInvalid",
// Other
showAdvanced: "showAdvanced",
advancedSection: "advancedSection"
};
interface VsCodeApi {
postMessage(msg: Record<string, any>): void;
setState(state: Record<string, any>): void;
getState(): any;
}
declare function acquireVsCodeApi(): VsCodeApi;
class SettingsApp {
private readonly vsCodeApi: VsCodeApi;
private updating: boolean = false;
constructor() {
this.vsCodeApi = acquireVsCodeApi();
window.addEventListener("keydown", this.onTabKeyDown.bind(this));
window.addEventListener("message", this.onMessageReceived.bind(this));
// Add event listeners to UI elements
this.addEventsToConfigNameChanges();
this.addEventsToInputValues();
document.getElementById(elementId.knownCompilers)?.addEventListener("change", this.onKnownCompilerSelect.bind(this));
// Set view state of advanced settings and add event
const oldState: any = this.vsCodeApi.getState();
const advancedShown: boolean = oldState && oldState.advancedShown;
const advancedSection: HTMLElement | null = document.getElementById(elementId.advancedSection);
if (advancedSection) {
advancedSection.style.display = advancedShown ? "block" : "none";
}
document.getElementById(elementId.showAdvanced)?.classList.toggle(advancedShown ? "collapse" : "expand", true);
document.getElementById(elementId.showAdvanced)?.addEventListener("click", this.onShowAdvanced.bind(this));
this.vsCodeApi.postMessage({
command: "initialized"
});
}
private addEventsToInputValues(): void {
const elements: NodeListOf<HTMLElement> = document.getElementsByName("inputValue");
elements.forEach(el => {
el.addEventListener("change", this.onChanged.bind(this, el.id));
});
// Special case for checkbox elements
document.getElementById(elementId.limitSymbolsToIncludedHeaders)?.addEventListener("change", this.onChangedCheckbox.bind(this, elementId.limitSymbolsToIncludedHeaders));
document.getElementById(elementId.mergeConfigurations)?.addEventListener("change", this.onChangedCheckbox.bind(this, elementId.mergeConfigurations));
}
private addEventsToConfigNameChanges(): void {
document.getElementById(elementId.configName)?.addEventListener("change", this.onConfigNameChanged.bind(this));
document.getElementById(elementId.configSelection)?.addEventListener("change", this.onConfigSelect.bind(this));
document.getElementById(elementId.addConfigBtn)?.addEventListener("click", this.onAddConfigBtn.bind(this));
document.getElementById(elementId.addConfigOk)?.addEventListener("click", this.onAddConfigConfirm.bind(this, true));
document.getElementById(elementId.addConfigCancel)?.addEventListener("click", this.onAddConfigConfirm.bind(this, false));
}
private onTabKeyDown(e: any): void {
if (e.keyCode === 9) {
document.body.classList.add("tabbing");
window.removeEventListener("keydown", this.onTabKeyDown);
window.addEventListener("mousedown", this.onMouseDown.bind(this));
}
}
private onMouseDown(): void {
document.body.classList.remove("tabbing");
window.removeEventListener("mousedown", this.onMouseDown);
window.addEventListener("keydown", this.onTabKeyDown.bind(this));
}
private onShowAdvanced(): void {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const isShown: boolean = document.getElementById(elementId.advancedSection)!.style.display === "block";
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
document.getElementById(elementId.advancedSection)!.style.display = isShown ? "none" : "block";
// Save view state
this.vsCodeApi.setState({ advancedShown: !isShown });
// Update chevron on button
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const element: HTMLElement = document.getElementById(elementId.showAdvanced)!;
element.classList.toggle("collapse");
element.classList.toggle("expand");
}
private onAddConfigBtn(): void {
this.showElement(elementId.addConfigDiv, false);
this.showElement(elementId.addConfigInputDiv, true);
}
private onAddConfigConfirm(request: boolean): void {
this.showElement(elementId.addConfigInputDiv, false);
this.showElement(elementId.addConfigDiv, true);
// If request is yes, send message to create new config
if (request) {
const el: HTMLInputElement = <HTMLInputElement>document.getElementById(elementId.addConfigName);
if (el.value !== undefined && el.value !== "") {
this.vsCodeApi.postMessage({
command: "addConfig",
name: el.value
});
el.value = "";
}
}
}
private onConfigNameChanged(): void {
if (this.updating) {
return;
}
const configName: HTMLInputElement = <HTMLInputElement>document.getElementById(elementId.configName);
const list: HTMLSelectElement = <HTMLSelectElement>document.getElementById(elementId.configSelection);
if (configName.value === "") {
(<HTMLInputElement>document.getElementById(elementId.configName)).value = list.options[list.selectedIndex].value;
return;
}
// Update name on selection
list.options[list.selectedIndex].value = configName.value;
list.options[list.selectedIndex].text = configName.value;
this.onChanged(elementId.configName);
}
private onConfigSelect(): void {
if (this.updating) {
return;
}
const el: HTMLSelectElement = <HTMLSelectElement>document.getElementById(elementId.configSelection);
(<HTMLInputElement>document.getElementById(elementId.configName)).value = el.value;
this.vsCodeApi.postMessage({
command: "configSelect",
index: el.selectedIndex
});
}
private onKnownCompilerSelect(): void {
if (this.updating) {
return;
}
const el: HTMLSelectElement = <HTMLSelectElement>document.getElementById(elementId.knownCompilers);
(<HTMLInputElement>document.getElementById(elementId.compilerPath)).value = el.value;
this.onChanged(elementId.compilerPath);
// Post message that this control was used for telemetry
this.vsCodeApi.postMessage({
command: "knownCompilerSelect"
});
}
// To enable custom entries, the compiler path control is a text box on top of a select control.
// This function ensures that the select control is updated when the text box is changed.
private fixKnownCompilerSelection(): void {
const compilerPath = (<HTMLInputElement>document.getElementById(elementId.compilerPath)).value.toLowerCase();
const knownCompilers = <HTMLSelectElement>document.getElementById(elementId.knownCompilers);
for (let n = 0; n < knownCompilers.options.length; n++) {
if (compilerPath === knownCompilers.options[n].value.toLowerCase()) {
knownCompilers.value = knownCompilers.options[n].value;
return;
}
}
knownCompilers.value = '';
}
private onChangedCheckbox(id: string): void {
if (this.updating) {
return;
}
const el: HTMLInputElement = <HTMLInputElement>document.getElementById(id);
this.vsCodeApi.postMessage({
command: "change",
key: id,
value: el.checked
});
}
private onChanged(id: string): void {
if (this.updating) {
return;
}
const el: HTMLInputElement = <HTMLInputElement>document.getElementById(id);
if (id === elementId.compilerPath) {
this.fixKnownCompilerSelection();
}
this.vsCodeApi.postMessage({
command: "change",
key: id,
value: el.value
});
}
private onMessageReceived(e: MessageEvent): void {
const message: any = e.data; // The json data that the extension sent
switch (message.command) {
case 'updateConfig':
this.updateConfig(message.config);
break;
case 'updateErrors':
this.updateErrors(message.errors);
break;
case 'setKnownCompilers':
this.setKnownCompilers(message.compilers);
break;
case 'updateConfigSelection':
this.updateConfigSelection(message);
break;
}
}
private updateConfig(config: any): void {
this.updating = true;
try {
const joinEntries: (input: any) => string = (input: string[]) => (input && input.length) ? input.join("\n") : "";
// Basic settings
(<HTMLInputElement>document.getElementById(elementId.configName)).value = config.name;
(<HTMLInputElement>document.getElementById(elementId.compilerPath)).value = config.compilerPath ? config.compilerPath : "";
this.fixKnownCompilerSelection();
(<HTMLInputElement>document.getElementById(elementId.compilerArgs)).value = joinEntries(config.compilerArgs);
(<HTMLInputElement>document.getElementById(elementId.intelliSenseMode)).value = config.intelliSenseMode ? config.intelliSenseMode : "${default}";
(<HTMLInputElement>document.getElementById(elementId.includePath)).value = joinEntries(config.includePath);
(<HTMLInputElement>document.getElementById(elementId.defines)).value = joinEntries(config.defines);
(<HTMLInputElement>document.getElementById(elementId.cStandard)).value = config.cStandard;
(<HTMLInputElement>document.getElementById(elementId.cppStandard)).value = config.cppStandard;
// Advanced settings
(<HTMLInputElement>document.getElementById(elementId.windowsSdkVersion)).value = config.windowsSdkVersion ? config.windowsSdkVersion : "";
(<HTMLInputElement>document.getElementById(elementId.macFrameworkPath)).value = joinEntries(config.macFrameworkPath);
(<HTMLInputElement>document.getElementById(elementId.compileCommands)).value = config.compileCommands ? config.compileCommands : "";
(<HTMLInputElement>document.getElementById(elementId.mergeConfigurations)).checked = config.mergeConfigurations;
(<HTMLInputElement>document.getElementById(elementId.configurationProvider)).value = config.configurationProvider ? config.configurationProvider : "";
(<HTMLInputElement>document.getElementById(elementId.forcedInclude)).value = joinEntries(config.forcedInclude);
(<HTMLInputElement>document.getElementById(elementId.dotConfig)).value = config.dotConfig ? config.dotConfig : "";
if (config.browse) {
(<HTMLInputElement>document.getElementById(elementId.browsePath)).value = joinEntries(config.browse.path);
(<HTMLInputElement>document.getElementById(elementId.limitSymbolsToIncludedHeaders)).checked =
config.browse.limitSymbolsToIncludedHeaders && config.browse.limitSymbolsToIncludedHeaders;
(<HTMLInputElement>document.getElementById(elementId.databaseFilename)).value = config.browse.databaseFilename ? config.browse.databaseFilename : "";
} else {
(<HTMLInputElement>document.getElementById(elementId.browsePath)).value = "";
(<HTMLInputElement>document.getElementById(elementId.limitSymbolsToIncludedHeaders)).checked = false;
(<HTMLInputElement>document.getElementById(elementId.databaseFilename)).value = "";
}
} finally {
this.updating = false;
}
}
private updateErrors(errors: any): void {
this.updating = true;
try {
this.showErrorWithInfo(elementId.configNameInvalid, errors.name);
this.showErrorWithInfo(elementId.intelliSenseModeInvalid, errors.intelliSenseMode);
this.showErrorWithInfo(elementId.compilerPathInvalid, errors.compilerPath);
this.showErrorWithInfo(elementId.includePathInvalid, errors.includePath);
this.showErrorWithInfo(elementId.macFrameworkPathInvalid, errors.macFrameworkPath);
this.showErrorWithInfo(elementId.forcedIncludeInvalid, errors.forcedInclude);
this.showErrorWithInfo(elementId.compileCommandsInvalid, errors.compileCommands);
this.showErrorWithInfo(elementId.browsePathInvalid, errors.browsePath);
this.showErrorWithInfo(elementId.databaseFilenameInvalid, errors.databaseFilename);
this.showErrorWithInfo(elementId.dotConfigInvalid, errors.dotConfig);
} finally {
this.updating = false;
}
}
private showErrorWithInfo(elementID: string, errorInfo: string): void {
this.showElement(elementID, errorInfo ? true : false);
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
document.getElementById(elementID)!.textContent = errorInfo ? errorInfo : "";
}
private updateConfigSelection(message: any): void {
this.updating = true;
try {
const list: HTMLSelectElement = <HTMLSelectElement>document.getElementById(elementId.configSelection);
// Clear list before updating
list.options.length = 0;
// Update list
for (const name of message.selections) {
const option: HTMLOptionElement = document.createElement("option");
option.text = name;
option.value = name;
list.append(option);
}
list.selectedIndex = message.selectedIndex;
} finally {
this.updating = false;
}
}
private setKnownCompilers(compilers: string[]): void {
this.updating = true;
try {
const list: HTMLSelectElement = <HTMLSelectElement>document.getElementById(elementId.knownCompilers);
// No need to add items unless webview is reloaded, in which case it will not have any elements.
// Otherwise, add items again.
if (list.firstChild) {
return;
}
if (compilers.length === 0) {
// Get HTML element containing the string, as we can't localize strings in HTML js
const noCompilerSpan: HTMLSpanElement = <HTMLSpanElement>document.getElementById(elementId.noCompilerPathsDetected);
const option: HTMLOptionElement = document.createElement("option");
option.text = noCompilerSpan.textContent ?? "";
option.disabled = true;
list.append(option);
} else {
for (const path of compilers) {
const option: HTMLOptionElement = document.createElement("option");
option.text = path;
option.value = path;
list.append(option);
}
}
this.showElement(elementId.compilerPath, true);
this.showElement(elementId.knownCompilers, true);
// Initialize list with no selected item
list.value = "";
} finally {
this.updating = false;
}
}
private showElement(elementID: string, show: boolean): void {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
document.getElementById(elementID)!.style.display = show ? "block" : "none";
}
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const app: SettingsApp = new SettingsApp();