Add a Meson cpptools configProvider #218

deribaucourt · 2024-02-02T15:09:02Z

Description from the commit message

Untill now the meson extension provided C++ linting through
compile_commands.json. This would not configure:
 - New file that haven't been compiled yet
 - External libraries that are not part of the project (when browsing/debugging)
This was especially problematic when using a cross-compilation toolchain
since none of the default host headers should be used.

This adds a custom configuration provider for the cpptools extension. It
introspects the compiler settings of the project to configure linting
and browsing. Currently, file-specific configurations are not supported.
Some other advanced meson options might also not be supported. However
it provides a strong experience for cross-compilation and external
library support.

Here is an example settings.json configuration to activate this provider:
```json
{
  "C_Cpp.default.configurationProvider": "mesonbuild.mesonbuild"
}
```

Testing the configuration

One can quickly test the generated configuration by removing the compile_commands.json and browsing C/C++ files. Most include paths and compiler flags should still appear effective. You can for instance add a dependency to a nonstandard library and the #include statement should not produce error squiggles.
Either remove the option in the .vscode/settings.json file at runtime, or use a patch

diff --git a/src/extension.ts b/src/extension.ts
index dedc767..a51ff61 100644
--- a/src/extension.ts
+++ b/src/extension.ts
@@ -142,7 +142,7 @@ export async function activate(ctx: vscode.ExtensionContext) {
   whenFileExists(ctx, compileCommandsFile, async () => {
     if (shouldModifySetting("ms-vscode.cpptools")) {
       const conf = vscode.workspace.getConfiguration("C_Cpp");
-      conf.update("default.compileCommands", compileCommandsFile, vscode.ConfigurationTarget.Workspace);
+      // conf.update("default.compileCommands", compileCommandsFile, vscode.ConfigurationTarget.Workspace);
     }
   });

tristan957

It seems to me like a few of the commits could be squashed together.

tristan957 · 2024-02-09T04:28:10Z

src/cpptoolsconfigprovider.ts

+    this.buildDir = buildDir;
+  }
+
+  name = "Meson build";


Let's make this "Meson Build"

Make these private

Renaming to "Meson Build". However, name and extensionId have to remain public because this class implements cpptools.CustomConfigurationProvider

Ah Thanks for the explanation!

tristan957 · 2024-02-09T04:28:22Z

src/cpptoolsconfigprovider.ts

+
+export class CpptoolsProvider implements cpptools.CustomConfigurationProvider {
+  cppToolsAPI?: cpptools.CppToolsApi;
+  private buildDir: string = "";


Remove the default value

tristan957 · 2024-02-09T04:28:39Z

src/cpptoolsconfigprovider.ts

+import * as vscode from "vscode";
+import * as cpptools from "vscode-cpptools";
+import { getMesonBuildOptions, getMesonCompilers, getMesonDependencies } from "./introspection";
+var fs = require("fs");


Don't use require. Use import.

tristan957 · 2024-02-09T04:31:13Z

src/cpptoolsconfigprovider.ts

+    let machine = "";
+    const buildOptions = await getMesonBuildOptions(this.buildDir);
+    for (let option of buildOptions) {
+      if (option.name === "cpp_std") {
+        browseConfig = Object.assign({}, browseConfig, { standard: option.value });
+        machine = option.machine;
+      }
+    }


Is it possible for us to not have a machine?

I tested the simple meson test-case gtk-doc with a native build. A machine was also defined ("host"). So it looks like meson always defines a machine, even with empty/default options.

Let's add an assert and make machine string | undefined

Alright! Added a commit to handle an undefined machine. I used an if rather than assert because we are still able to provide a browsePath without this option.

tristan957 · 2024-02-09T04:31:24Z

src/cpptoolsconfigprovider.ts

+    };
+
+    const dependencies = await getMesonDependencies(this.buildDir);
+    for (let dep of dependencies) {


Use const instead of let

tristan957 · 2024-02-09T04:31:40Z

src/cpptoolsconfigprovider.ts

+  canProvideBrowseConfigurationsPerFolder(token?: vscode.CancellationToken | undefined): Thenable<boolean> {
+    return Promise.resolve(false);
+  }
+  async provideFolderBrowseConfiguration(


Whitespace around functions

tristan957 · 2024-02-09T04:32:09Z

src/cpptoolsconfigprovider.ts

+var fs = require("fs");
+
+export class CpptoolsProvider implements cpptools.CustomConfigurationProvider {
+  cppToolsAPI?: cpptools.CppToolsApi;


Make this private?

It needs to be accessed by registerCppToolsProvider

tristan957 · 2024-02-09T04:32:28Z

src/extension.ts

+  cpptools = new CpptoolsProvider(buildDir);
+  registerCppToolsProvider(ctx, cpptools);


Should we only do this if it is a C or C++ project?

I don't think it matters. If the user does not add the "C_Cpp.default.configurationProvider": "mesonbuild.mesonbuild" setting, then non of the configuration methods will be called. And they do, this only affects C/C++ files detected by the cpptools extension.

tristan957 · 2024-02-09T04:33:38Z

src/cpptoolsconfigprovider.ts

@@ -0,0 +1,120 @@
+import path = require("path");


We should document this in the README.md somewhere.

The compiler fields will be used to provide the configuration for the cpptools extension.

This contains the API required to register as a configProvider with the C/C++ extension.

Untill now the meson extension provided C++ linting through compile_commands.json. This would not configure: - New file that haven't been compiled yet - External libraries that are not part of the project (when browsing/debugging) This was especially problematic when using a cross-compilation toolchain since none of the default host headers should be used. This adds a custom configuration provider for the cpptools extension. It introspects the compiler settings of the project to configure linting and browsing. Currently, file-specific configurations are not supported. Some other advanced meson options might also not be supported. However it provides a strong experience for cross-compilation and external library support. Here is an example settings.json configuration to activate this provider: ```json { "C_Cpp.default.configurationProvider": "mesonbuild.mesonbuild" } ```

The meson docs specifies that meson-info.json is the last file to be updated when reconfiguring a project. We use this as an event to notify that the configuration must be reloaded.

Meson projects which do not use C++ have different configurations which we must handle separately. If both are defined, we can only provide one, hence C++ since it is "compatible" with C.

Similarly to us configuring the compile_commands.json, we can configure the default configuration provider.

For simple projects which do not define an explicit compiler, the introspection unit will throw an error. This commit adds a try-catch to handle this case with default arguments.

deribaucourt · 2024-02-09T14:41:14Z

Thanks a lot for your review. I made the recommended changes. Also added 2 commits for default configurations that improved the experience when I tested a native simple meson test-case.

The machine configuration is usually defined in meson introspection. Just to be sure, add a check for undefined machine. For instance, if someone or something has tampered with the build files.

tristan957 reviewed Feb 9, 2024

View reviewed changes

deribaucourt added 8 commits February 9, 2024 10:23

Add method to get compilers from introspection file

df23bd0

The compiler fields will be used to provide the configuration for the cpptools extension.

Install vscode-cpptools dependency

f0f791a

This contains the API required to register as a configProvider with the C/C++ extension.

Refresh cpptools configuration on meson reconfiguration

6eb5995

The meson docs specifies that meson-info.json is the last file to be updated when reconfiguring a project. We use this as an event to notify that the configuration must be reloaded.

Support C configurations for cpptools configProvider

571b796

Meson projects which do not use C++ have different configurations which we must handle separately. If both are defined, we can only provide one, hence C++ since it is "compatible" with C.

Document the C/C++ configuration provider for Intellisense

f3535fb

Configure mesonbuild as the default config provider for C/C++

10094cb

Similarly to us configuring the compile_commands.json, we can configure the default configuration provider.

Handle default compiler in cpptoolsconfigprovider.ts

fac5db2

For simple projects which do not define an explicit compiler, the introspection unit will throw an error. This commit adds a try-catch to handle this case with default arguments.

deribaucourt force-pushed the main branch from 086f4b7 to fac5db2 Compare February 9, 2024 14:40

Handle undefined machine in cpptoolsconfigprovider.ts

3af2d02

The machine configuration is usually defined in meson introspection. Just to be sure, add a check for undefined machine. For instance, if someone or something has tampered with the build files.

deribaucourt requested a review from tristan957 February 12, 2024 09:44

tristan957 approved these changes Mar 9, 2024

View reviewed changes

tristan957 merged commit 188355d into mesonbuild:main Mar 9, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a Meson cpptools configProvider #218

Add a Meson cpptools configProvider #218

deribaucourt commented Feb 2, 2024

tristan957 left a comment

tristan957 Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024 •

edited

Loading

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

tristan957 Feb 9, 2024

deribaucourt Feb 9, 2024

deribaucourt commented Feb 9, 2024

		cpptools = new CpptoolsProvider(buildDir);
		registerCppToolsProvider(ctx, cpptools);

Add a Meson cpptools configProvider #218

Add a Meson cpptools configProvider #218

Conversation

deribaucourt commented Feb 2, 2024

Description from the commit message

Testing the configuration

tristan957 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deribaucourt Feb 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deribaucourt commented Feb 9, 2024

deribaucourt Feb 9, 2024 •

edited

Loading