Add dotconfig property for c_cpp_properties.json

[microhobby]

Some bare metal systems, RTOS and Linux use a generated .config file
with defines needed to build the system and switch features. This patch
add the dotconfig property that will store the path for read a
.config file and will concat the defines from file to the extension
defines.

Signed-off-by: Matheus Castello matheus@castello.eng.br

[microhobby]

I thinking out loud: #7840

[sean-mcmanus]

@microhobby Is this ready for code review?

Does anyone know what "This branch is out-of-date with the base branch" means?

[microhobby]

@sean-mcmanus I will rebase it with the base branch and remove the WIP from the title, so i think it's good for the review. Open to suggestions from maintainers.

[microhobby]

@bobbrow @sean-mcmanus and @Colengms thanks for the review, I will address the comments and as soon as I send the changes commits I will remove the WIP

resetting my reviewed status

[sean-mcmanus]

@microhobby FYI, 1.6.0 is locked down for shipping next week, but this can go into 1.7.0.

[sean-mcmanus]

It seems like the package.json is missing the "default.dotConfig" setting and the package.nls.json is missing a description for that. I have a bunch of settings added in my branch at https://github.com/microsoft/vscode-cpptools/pull/7816/files if you want an example, but you don't need to use markdownDescription since that is only used in that branch and I can update it later.

[microhobby]

It seems like the package.json is missing the "default.dotConfig" setting and the package.nls.json is missing a description for that. I have a bunch of settings added in my branch at https://github.com/microsoft/vscode-cpptools/pull/7816/files if you want an example, but you don't need to use markdownDescription since that is only used in that branch and I can update it later.

@sean-mcmanus thanks for the examples, I add a commit adding it to the package and package.nls.json. Let me know if this is ok.

[sean-mcmanus]

@Colengms @michelleangela @bobbrow Does someone else want to review this too?

[michelleangela]

This property will also need to be added in the .html file of the IntelliSense Configuration UI.

See https://github.com/microsoft/vscode-cpptools/blob/main/Extension/ui/settings.html and the UI element for "Compile commands" property for example of creating a field for one file path entry.

Place UI element for dotConfig after "Forced include" in the UI. Use title "Dot Config" for the new property.

Also add this new property to https://github.com/microsoft/vscode-cpptools/blob/main/Extension/src/LanguageServer/settingsPanel.ts so that the UI will be updated with values from c_cpp_properties.json

See examples for elementId.compileCommands in settingsPanel.ts.

vscode-cpptools/Extension/src/LanguageServer/settingsPanel.ts

Line 41 in 5dcb308

compileCommands: "compileCommands",

vscode-cpptools/Extension/src/LanguageServer/settingsPanel.ts

Line 325 in 5dcb308

case elementId.compileCommands:

[michelleangela]

@microhobby
Here is how strings are localized in HTML.

To localize HTML content, the following 2 attributes are used on HTML nodes:

data-loc-id
Specifying a unique string key value using this attribute causes the content of the node to be localized associated with that key

data-loc-id-<attribute-name>
Specifying a unique string key value using this attribute causes the specified attribute of this node to be localized. For example, to localize the title attribute of a node, use: data-loc-id-title="some.title.id"

The following is an example of a span with localized content, containing a sub-node with a localized title attribute.

<span data-loc-id="switch.to.json">Switch to the <a href="command:C_Cpp.ConfigurationEditJSON" title="Edit configurations in JSON file" data-loc-id-title="edit.configurations.in.json">c_cpp_properties.json</a> file by clicking on the file link or using the command:</span>

Child nodes are not included when content of a parent node is localized. In the outer nodes of the above example, the following string will be extracted for localization:

"Switch to the {0} file by clicking on the file link or using the command:"

[microhobby]

@michelleangela thanks for the review, I will work on it.

[sean-mcmanus]

FYI, we've changed our settings strings to prefer using markdownDescription, with a hint string -- see #8129 for examples, so for this change you'd use backticks around .config and replace the "" with ``.

[microhobby]

@sean-mcmanus @michelleangela sorry for the delay, I had a few shifts in priorities these past few months, but I'm still on it. I will rebase it and address the proposed changes. Thanks.

[microhobby]

@sean-mcmanus @michelleangela first of all sorry for the delay, I rebased it and addressed the proposed changes.
@michelleangela let me know if the html UI changes looks good to you, or if I missed something.

[sean-mcmanus]

@microhobby FYI, we stopped publishing downloadable binaries so you may need to copy over updated ones (see #8691 and #8788).

[sean-mcmanus]

It says "This branch is out-of-date with the base branch" -- can that be updated?

[microhobby]

It says "This branch is out-of-date with the base branch" -- can that be updated?

@sean-mcmanus done!

[michelleangela]

@microhobby
I tested the Configuration UI changes. The input field works and updates the JSON file and vice versa. It is only missing the error message on the UI when the path file is invalid. The UI element for the error message is already there in the `settings.html' file but the string for the error message is missing.

Note that the error message for invalid paths on JSON file works.

Example of expected error on UI:

Where to get error message for the UI and updating errors on UI:

1. UI error messages are created in function private getErrorsForConfigUI(configIndex: number) (https://github.com/microsoft/vscode-cpptools/blob/main/Extension/src/LanguageServer/configurations.ts#L1365)
2. In getErrorsForConfigUI add something like errors.dotConfig = this.validatePath(config.dotConfig, false); similar to errors.compileCommands = this.validatePath(config.compileCommands, false);
3. Another string property will need to be added to interface ConfigurationErrors for dotConfig errors.
4. Errors on the UI are updated via the private updateErrors(errors: any) function in https://github.com/microsoft/vscode-cpptools/blob/main/Extension/ui/settings.ts. See examples this.showErrorWithInfo(elementId.compileCommandsInvalid, errors.compileCommands); and compileCommandsInvalid: "compileCommandsInvalid", for adding another error message to update.

[microhobby]

@michelleangela thank you very much for the valuable tips, I push a new commit, tested here and now the error message show as expected.

[michelleangela]

@microhobby Could you update your branch again so it is up-to-date with the base branch? Then I'll re-run the checks and check-in the PR.

[microhobby]

@michelleangela I rebased it with the main

[michelleangela]

@microhobby
Your changes to add dotConfig property has been checked-in. Thank you for your contribution to the extension!