Skip to content

Commit bc70ea8

Browse files
sean-mcmanussean-mcmanus
authored
Merge branch 'master' into seanmcm/0_23_0_changelog2
2 parents 968d6c5 + bbfea25 commit bc70ea8

File tree

4 files changed

+148
-85
lines changed

4 files changed

+148
-85
lines changed

‎Extension/src/LanguageServer/configurations.ts

+101-63
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,18 @@ export class CppProperties {
204204
private onSelectionChanged(): void {
205205
this.selectionChanged.fire(this.CurrentConfigurationIndex);
206206
if (this.settingsPanel) {
207-
this.settingsPanel.updateConfigUI(this.configurationJson.configurations[this.currentConfigurationIndex.Value]);
207+
this.ensurePropertiesFile().then(() => {
208+
if (this.propertiesFile) {
209+
// Clear out any modifications we may have made internally by parsing the json file
210+
if (this.parsePropertiesFile()) {
211+
// Update the UI with new selected configuration
212+
this.settingsPanel.updateConfigUI(this.configurationJson.configurations[this.currentConfigurationIndex.Value]);
213+
} else {
214+
// Parse failed, open json file
215+
vscode.workspace.openTextDocument(this.propertiesFile);
216+
}
217+
}
218+
});
208219
}
209220
this.handleSquiggles();
210221
}
@@ -380,7 +391,7 @@ export class CppProperties {
380391
config.includePath = ["${default}"];
381392
}
382393
config.includePath.splice(config.includePath.length, 0, path);
383-
fs.writeFileSync(this.propertiesFile.fsPath, JSON.stringify(this.configurationJson, null, 4));
394+
this.writeToJson();
384395
this.handleConfigurationChange();
385396
});
386397
}
@@ -396,7 +407,7 @@ export class CppProperties {
396407
} else {
397408
delete config.configurationProvider;
398409
}
399-
fs.writeFileSync(this.propertiesFile.fsPath, JSON.stringify(this.configurationJson, null, 4));
410+
this.writeToJson();
400411
this.handleConfigurationChange();
401412
resolve();
402413
});
@@ -418,7 +429,7 @@ export class CppProperties {
418429
this.parsePropertiesFileAndHandleSquiggles(); // Clear out any modifications we may have made internally.
419430
let config: Configuration = this.CurrentConfiguration;
420431
config.compileCommands = path;
421-
fs.writeFileSync(this.propertiesFile.fsPath, JSON.stringify(this.configurationJson, null, 4));
432+
this.writeToJson();
422433
this.handleConfigurationChange();
423434
});
424435
}
@@ -428,6 +439,18 @@ export class CppProperties {
428439
this.handleConfigurationEditCommand(vscode.window.showTextDocument);
429440
return;
430441
}
442+
443+
// Before changing the current configuration index, save any edits from the UI.
444+
if (this.settingsPanel) {
445+
if (this.settingsPanel.isDirty()) {
446+
this.parsePropertiesFile(); // Clear out any modifications we may have made internally.
447+
// Get the changes from the UI and save to json file
448+
let config: Configuration = this.settingsPanel.getLastValuesFromConfigUI();
449+
this.configurationJson.configurations[this.currentConfigurationIndex.Value] = config;
450+
this.writeToJson();
451+
}
452+
}
453+
431454
this.currentConfigurationIndex.Value = index;
432455
this.onSelectionChanged();
433456
}
@@ -564,56 +587,6 @@ export class CppProperties {
564587
}
565588
}
566589

567-
private async ensurePropertiesFile(): Promise<void> {
568-
if (this.propertiesFile && fs.existsSync(this.propertiesFile.fsPath)) {
569-
return;
570-
} else {
571-
try {
572-
if (!fs.existsSync(this.configFolder)) {
573-
fs.mkdirSync(this.configFolder);
574-
}
575-
576-
let fullPathToFile: string = path.join(this.configFolder, "c_cpp_properties.json");
577-
let filePath: vscode.Uri = vscode.Uri.file(fullPathToFile).with({ scheme: "untitled" });
578-
579-
let document: vscode.TextDocument = await vscode.workspace.openTextDocument(filePath);
580-
581-
let edit: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
582-
if (this.configurationJson) {
583-
this.resetToDefaultSettings(true);
584-
}
585-
this.applyDefaultIncludePathsAndFrameworks();
586-
let settings: CppSettings = new CppSettings(this.rootUri);
587-
if (settings.defaultConfigurationProvider) {
588-
this.configurationJson.configurations.forEach(config => {
589-
config.configurationProvider = settings.defaultConfigurationProvider;
590-
});
591-
settings.update("default.configurationProvider", undefined); // delete the setting
592-
}
593-
let savedKnownCompilers: KnownCompiler[] = this.configurationJson.configurations[0].knownCompilers;
594-
delete this.configurationJson.configurations[0].knownCompilers;
595-
596-
edit.insert(document.uri, new vscode.Position(0, 0), JSON.stringify(this.configurationJson, null, 4));
597-
598-
this.configurationJson.configurations[0].knownCompilers = savedKnownCompilers;
599-
await vscode.workspace.applyEdit(edit);
600-
601-
// Fix for issue 163
602-
// https://github.com/Microsoft/vscppsamples/issues/163
603-
// Save the file to disk so that when the user tries to re-open the file it exists.
604-
// Before this fix the file existed but was unsaved, so we went through the same
605-
// code path and reapplied the edit.
606-
await document.save();
607-
608-
this.propertiesFile = vscode.Uri.file(path.join(this.configFolder, "c_cpp_properties.json"));
609-
610-
} catch (err) {
611-
vscode.window.showErrorMessage(`Failed to create "${this.configFolder}": ${err.message}`);
612-
}
613-
}
614-
return;
615-
}
616-
617590
public handleConfigurationEditCommand(onSuccess: (document: vscode.TextDocument) => void): void {
618591
let otherSettings: OtherSettings = new OtherSettings(this.rootUri);
619592
if (otherSettings.settingsEditor === "ui") {
@@ -655,15 +628,25 @@ export class CppProperties {
655628
}
656629

657630
private onSettingsPanelViewStateChanged(e: ViewStateEvent): void {
658-
if (e.isActive && this.configurationJson) {
659-
// The settings UI became visible or active.
660-
// Ensure settingsPanel is referencing current configuration
661-
this.settingsPanel.updateConfigUI(this.configurationJson.configurations[this.currentConfigurationIndex.Value]);
662-
} else {
631+
if (!e.isDirty && e.isActive && this.configurationJson) {
632+
this.ensurePropertiesFile().then(() => {
633+
if (this.propertiesFile) {
634+
if (this.parsePropertiesFile()) {
635+
// The settings UI became visible or active.
636+
// Ensure settingsPanel has copy of latest current configuration
637+
this.settingsPanel.updateConfigUI(this.configurationJson.configurations[this.currentConfigurationIndex.Value]);
638+
} else {
639+
// Parse failed, open json file
640+
vscode.workspace.openTextDocument(this.propertiesFile);
641+
}
642+
}
643+
});
644+
} else if (e.isDirty) {
663645
console.assert(this.configurationJson);
664-
// The settings UI closed or is out of focus, save any changes to current configuration
665-
// No need to get the changed values from settingsPanel because settingsPanel has a reference of this.configurationJson
666-
fs.writeFileSync(this.propertiesFile.fsPath, JSON.stringify(this.configurationJson, null, 4));
646+
this.parsePropertiesFile(); // Clear out any modifications we may have made internally.
647+
let config: Configuration = this.settingsPanel.getLastValuesFromConfigUI();
648+
this.configurationJson.configurations[this.currentConfigurationIndex.Value] = config;
649+
this.writeToJson();
667650
}
668651
}
669652

@@ -693,6 +676,56 @@ export class CppProperties {
693676
this.updateServerOnFolderSettingsChange();
694677
}
695678

679+
private async ensurePropertiesFile(): Promise<void> {
680+
if (this.propertiesFile && fs.existsSync(this.propertiesFile.fsPath)) {
681+
return;
682+
} else {
683+
try {
684+
if (!fs.existsSync(this.configFolder)) {
685+
fs.mkdirSync(this.configFolder);
686+
}
687+
688+
let fullPathToFile: string = path.join(this.configFolder, "c_cpp_properties.json");
689+
let filePath: vscode.Uri = vscode.Uri.file(fullPathToFile).with({ scheme: "untitled" });
690+
691+
let document: vscode.TextDocument = await vscode.workspace.openTextDocument(filePath);
692+
693+
let edit: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
694+
if (this.configurationJson) {
695+
this.resetToDefaultSettings(true);
696+
}
697+
this.applyDefaultIncludePathsAndFrameworks();
698+
let settings: CppSettings = new CppSettings(this.rootUri);
699+
if (settings.defaultConfigurationProvider) {
700+
this.configurationJson.configurations.forEach(config => {
701+
config.configurationProvider = settings.defaultConfigurationProvider;
702+
});
703+
settings.update("default.configurationProvider", undefined); // delete the setting
704+
}
705+
let savedKnownCompilers: KnownCompiler[] = this.configurationJson.configurations[0].knownCompilers;
706+
delete this.configurationJson.configurations[0].knownCompilers;
707+
708+
edit.insert(document.uri, new vscode.Position(0, 0), JSON.stringify(this.configurationJson, null, 4));
709+
710+
this.configurationJson.configurations[0].knownCompilers = savedKnownCompilers;
711+
await vscode.workspace.applyEdit(edit);
712+
713+
// Fix for issue 163
714+
// https://github.com/Microsoft/vscppsamples/issues/163
715+
// Save the file to disk so that when the user tries to re-open the file it exists.
716+
// Before this fix the file existed but was unsaved, so we went through the same
717+
// code path and reapplied the edit.
718+
await document.save();
719+
720+
this.propertiesFile = vscode.Uri.file(path.join(this.configFolder, "c_cpp_properties.json"));
721+
722+
} catch (err) {
723+
vscode.window.showErrorMessage(`Failed to create "${this.configFolder}": ${err.message}`);
724+
}
725+
}
726+
return;
727+
}
728+
696729
private parsePropertiesFileAndHandleSquiggles(): void {
697730
if (this.parsePropertiesFile()) {
698731
this.handleSquiggles();
@@ -773,7 +806,7 @@ export class CppProperties {
773806

774807
if (dirty) {
775808
try {
776-
fs.writeFileSync(this.propertiesFile.fsPath, JSON.stringify(this.configurationJson, null, 4));
809+
this.writeToJson();
777810
} catch (err) {
778811
// Ignore write errors, the file may be under source control. Updated settings will only be modified in memory.
779812
vscode.window.showWarningMessage(`Attempt to update "${this.propertiesFile.fsPath}" failed (do you have write access?)`);
@@ -1073,6 +1106,11 @@ export class CppProperties {
10731106
}
10741107
}
10751108

1109+
private writeToJson(): void {
1110+
console.assert(this.propertiesFile);
1111+
fs.writeFileSync(this.propertiesFile.fsPath, JSON.stringify(this.configurationJson, null, 4));
1112+
}
1113+
10761114
public checkCppProperties(): void {
10771115
// Check for change properties in case of file watcher failure.
10781116
let propertiesFile: string = path.join(this.configFolder, "c_cpp_properties.json");

‎Extension/src/LanguageServer/settingsPanel.ts

+21-8
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@ const elementId: { [key: string]: string } = {
2323

2424
export interface ViewStateEvent {
2525
isActive: boolean;
26+
isDirty: boolean;
2627
}
2728

2829
export class SettingsPanel {
2930
private configValues: config.Configuration;
31+
private isIntelliSenseModeDefined: boolean = false;
3032
private configDirty: boolean = false;
3133
private settingsPanelViewStateChanged = new vscode.EventEmitter<ViewStateEvent>();
3234
private panel: vscode.WebviewPanel;
@@ -89,6 +91,10 @@ export class SettingsPanel {
8991
return this.settingsPanelViewStateChanged.event;
9092
}
9193

94+
public isDirty(): boolean {
95+
return this.configDirty;
96+
}
97+
9298
public getLastValuesFromConfigUI(): config.Configuration {
9399
return this.configValues;
94100
}
@@ -122,7 +128,7 @@ export class SettingsPanel {
122128
private onPanelDisposed(): void {
123129
// Notify listener config panel is not active
124130
if (this.configDirty) {
125-
let viewState: ViewStateEvent = { isActive: false };
131+
let viewState: ViewStateEvent = { isActive: false, isDirty: this.configDirty };
126132
this.settingsPanelViewStateChanged.fire(viewState);
127133
}
128134

@@ -133,25 +139,28 @@ export class SettingsPanel {
133139
}
134140

135141
private updateWebview(configuration: config.Configuration): void {
136-
this.configValues = configuration;
137-
// Send a message to the webview to update the values from json.
142+
this.configValues = Object.assign({}, configuration); // Copy configuration values
143+
this.isIntelliSenseModeDefined = (this.configValues.intelliSenseMode !== undefined);
138144
if (this.panel) {
139-
this.panel.webview.postMessage({ command: 'update', config: configuration });
145+
// Send a message to the webview to update the values
146+
this.panel.webview.postMessage({ command: 'update', config: this.configValues });
140147
this.configDirty = false;
141148
}
142149
}
143150

144151
private onViewStateChanged(e: vscode.WebviewPanelOnDidChangeViewStateEvent): void {
145-
let viewState: ViewStateEvent = { isActive: e.webviewPanel.active };
152+
let viewState: ViewStateEvent = { isActive: e.webviewPanel.active, isDirty: this.configDirty };
146153
if (this.configDirty || e.webviewPanel.active) {
147154
this.settingsPanelViewStateChanged.fire(viewState);
155+
this.configDirty = false;
148156
}
149157
}
150158

151159
private onWindowStateChanged(e: vscode.WindowState): void {
152-
let viewState: ViewStateEvent = { isActive: e.focused };
153-
if (this.configDirty || e.focused) {
160+
let viewState: ViewStateEvent = { isActive: this.panel.active, isDirty: this.configDirty };
161+
if (this.configDirty || this.panel.active) {
154162
this.settingsPanelViewStateChanged.fire(viewState);
163+
this.configDirty = false;
155164
}
156165
}
157166

@@ -185,7 +194,11 @@ export class SettingsPanel {
185194
this.configValues.defines = entries.filter(e => e);
186195
break;
187196
case elementId.intelliSenseMode:
188-
this.configValues.intelliSenseMode = message.value;
197+
if (message.value !== "${default}" || this.isIntelliSenseModeDefined) {
198+
this.configValues.intelliSenseMode = message.value;
199+
} else {
200+
this.configValues.intelliSenseMode = undefined;
201+
}
189202
break;
190203
case elementId.cStandard:
191204
this.configValues.cStandard = message.value;

‎Extension/ui/settings.html

+12-6
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@
125125
}
126126

127127
textarea {
128+
white-space: nowrap;
128129
padding: 4px;
129130
font-size: 13px;
130131
font-family: Menlo, Monaco, Consolas, "Droid Sans Mono", "Courier New", monospace, "Droid Sans Fallback";
@@ -322,7 +323,8 @@
322323
<div class="main-title">IntelliSense Configurations</div>
323324
<div style="color: var(--vscode-foreground);">
324325
Use this editor to edit basic IntelliSense settings defined in the underlying <a href="command:C_Cpp.ConfigurationEditJSON" title="Edit configurations in JSON file">c_cpp_properties.json</a> file.
325-
Only the setting values of the active configuration can be modified at a time. Switch active configurations to modify a different configurations on this editor. To edit multiple configurations or set additional settings go to <a href="command:C_Cpp.ConfigurationEditJSON" title="Edit configurations in JSON file">c_cpp_properties.json</a>.
326+
Changes made in this editor only apply to the active configuration. To modify other configurations <a href="command:C_Cpp.ConfigurationSelect" title="Change the active configuration">change the active configuration</a>.
327+
To edit multiple configurations at once, or additional settings not shown here, go to <a href="command:C_Cpp.ConfigurationEditJSON" title="Edit configurations in JSON file">c_cpp_properties.json</a>.
326328
</div>
327329
</div>
328330

@@ -331,19 +333,20 @@
331333

332334
<!-- sections -->
333335
<div class="section">
334-
<div class="section-title">Configuration identifier</div>
336+
<div class="section-title">Configuration name</div>
335337
<div class="section-text">
336-
The identifier of the active configuration. <code>Mac</code>, <code>Linux</code>, and <code>Win32</code> are special identifiers for configurations that will be auto-selected on those platforms, but the identifier can be anything.
338+
A friendly name that identifies a configuration. <code>Mac</code>, <code>Linux</code>, and <code>Win32</code> are special identifiers for configurations that will be auto-selected on those platforms, but the name of the identifier can be anything.
339+
To edit the name of the current active configuration, go to the <a href="command:C_Cpp.ConfigurationEditJSON" title="Edit configurations in JSON file">c_cpp_properties.json</a> file and edit the <code>name</code> property.
337340
</div>
338341
<div class="section-input"><input class="input-disabled" type="text" id=activeConfig style="width: 290px" disabled>
339-
<a style="padding-left: 6px;" href="command:C_Cpp.ConfigurationSelect" title="Select active configuration">Select active configuration</a>
342+
<a style="padding-left: 6px;" href="command:C_Cpp.ConfigurationSelect" title="Change the active configuration">Change the active configuration</a>
340343
</div>
341344
</div>
342345

343346
<div class="section">
344347
<div class="section-title">Compiler path</div>
345348
<div class="section-text">
346-
Full path of the compiler being used to build, e.g. <code>/usr/bin/gcc</code>, to enable more accurate IntelliSense.
349+
The full path of the compiler being used to build, e.g. <code>/usr/bin/gcc</code>, to enable more accurate IntelliSense.
347350
Args can be added to modify the includes/defines used, e.g. <code>-nostdinc++</code>, <code>-m32</code>, etc., but paths with spaces must be surrounded by double quotes <code>"</code> if args are used.
348351
</div>
349352
<div class="section-input">
@@ -354,10 +357,13 @@
354357
<div class="section">
355358
<div class="section-title">IntelliSense mode</div>
356359
<div class="section-text">
357-
If set, it overrides the default mode used by the IntelliSense engine. Windows defaults to msvc-x64, Linux defaults to gcc-x64, and Mac defaults to clang-x64.
360+
The IntelliSense mode used by the IntelliSense engine. The <code>${default}</code> mode will choose the default for that platform.
361+
Windows defaults to <code>msvc-x64</code>, Linux defaults to <code>gcc-x64</code>, and Mac defaults to <code>clang-x64</code>.
362+
Select a specific IntelliSense mode to override the <code>${default}</code> mode.
358363
</div>
359364
<div class="section-input">
360365
<select id="intelliSenseMode">
366+
<option value="${default}">${default}</option>
361367
<option value="msvc-x64">msvc-x64</option>
362368
<option value="gcc-x64">gcc-x64</option>
363369
<option value="clang-x64">clang-x64</option>

0 commit comments

Comments
 (0)