[clangd] Add 'Switch header/source' command in clangd-vscode

[malaperle]

Summary

Alt+o is used on Windows/Linux and Option+Cmd+o on macOS.

Signed-off-by: Marc-Andre Laperle <[e-mail]>

[malaperle]

Fix a bad change

[ioeric]

lgtm

Could you run clang-format on the changed lines?

clangd/clients/clangd-vscode/package.json

81 ↗

(On Diff #174866)

and objc?

clangd/clients/clangd-vscode/src/extension.ts

55 ↗

(On Diff #174866)

We might want to share the logic for converting protocol URI to vscode URI.

[ilya-biryukov]

Overall LG, merely stylistic NITs.

clangd/clients/clangd-vscode/src/extension.ts

69 ↗

(On Diff #174866)

Maybe use async/await to improve readabiity? I.e.

/*...*/push(registerCommand('...', async() => {
        // ...
        const sourceUri = await clangdClient.sendRequest(SwitchSourceHeaderRequest.type, docIdentifier);
        if (!sourceUri) {
           return;
        }
        const doc = await // ....
}

70 ↗

(On Diff #174866)

Maybe do if (!sourceUri) to use consistent style with the first check in the lambda (i.e. if (!uri))

[ilya-biryukov]

And many thanks for the change! I've tried it out, will definitely be one of the most-used clangd features for me :-)

[hokein]

clangd/clients/clangd-vscode/src/extension.ts

4 ↗

(On Diff #174866)

We have imported the whole module as vscodelc, maybe just use vscodelc.RequestType, vscodelc.TextDocumentIdentifier?

16 ↗

(On Diff #174866)

Do we want to export this SwitchSourceHeaderRequest? it seems that we only use it in this module.

17 ↗

(On Diff #174866)

Is textDocument/switchSourceHeader a built-in support in vscode? Is it documented somewhere? I couldn't find any official document at https://code.visualstudio.com. Am I missing anything here?

[hokein]

clangd/clients/clangd-vscode/src/extension.ts

17 ↗

(On Diff #174866)

nvm, just realize that this is an LSP extension implemented inside clangd.

[malaperle]

Address comments.

[malaperle]

In D54781#1306102, @ioeric wrote:

Could you run clang-format on the changed lines?

I didn't know clang-format could be used for Typescript. I ran it and it's a bit inconsistent with the rest of the file but I don't want to format the whole file.

clangd/clients/clangd-vscode/package.json

81 ↗

(On Diff #174866)

I just removed the languages. It's a bit much to have all of them.

clangd/clients/clangd-vscode/src/extension.ts

55 ↗

(On Diff #174866)

What do you have in mind? I'm not sure there is much to share since I'm not sure we should be using readpathSync for the toggle header/source. If the source is opened as a symlink and the header also exists as a symlink then I think it's OK to open the symlink.

[sammccall]

This is great!

I'm slightly nervous - the way we've extended the protocol with textDocument/switchSourceHeader is pretty hard to extend, itself (since the response is a string directly).
This is only tangentially related to this patch, the same issue exists with Theia (I thought it was version locked to clangd, but it seems not to be).

I think this is fine. We may want to revise the protocol to wrap the URI in a struct (which should be soon!). Since VSCode plugin can be assumed to be newer than clangd, we can make it accept both versions.

[malaperle]

In D54781#1306872, @sammccall wrote:

This is great!

I'm slightly nervous - the way we've extended the protocol with textDocument/switchSourceHeader is pretty hard to extend, itself (since the response is a string directly).
This is only tangentially related to this patch, the same issue exists with Theia (I thought it was version locked to clangd, but it seems not to be).

I think this is fine. We may want to revise the protocol to wrap the URI in a struct (which should be soon!). Since VSCode plugin can be assumed to be newer than clangd, we can make it accept both versions.

I think it does make the to revise it. I don't think anything outside Theia and this vscode extension uses it. This might be a good opportunity to make it a proper protocol extension as explained here: https://github.com/Microsoft/language-server-protocol/blob/master/contributing.md#how-to-create-a-protocol-extension

[hokein]

@malaperle, do you want a new release of vscode-clangd extension for this?

[malaperle]

In D54781#1307755, @hokein wrote:

@malaperle, do you want a new release of vscode-clangd extension for this?

I don't plan on doing changes for a little while in vscode-clangd so it would be good indeed to have a new release. Unless you know of some upcoming change that could also piggy back a new release? Thanks!

[ilya-biryukov]

+1 to the new release D52311 (documentSymbol) needs a bump of the dependencies' versions.

[hokein]

Just made a new release v0.0.7, please try to use it (it works on my machine).

[ilya-biryukov]

In D54781#1311038, @hokein wrote:

Just made a new release v0.0.7, please try to use it (it works on my machine).

Many thanks! Works for me

[malaperle]

In D54781#1311038, @hokein wrote:

Just made a new release v0.0.7, please try to use it (it works on my machine).

Works great! Thanks a lot!

clang-tools-extra/trunk/clangd/clients/clangd-vscode/package.json

"contributes": {
                     "default": true,
                     "description": "Whether or not to send file events to clangd (File created, changed or deleted). This can be disabled for performance consideration."
                 },
                 "clangd.trace": {
                     "type": "string",
                     "description": "Names a file that clangd should log a performance trace to, in chrome trace-viewer JSON format."
                 }
             }
+        },
+        "commands": [
+            {
+                "command": "clangd-vscode.switchheadersource",
+                "title": "Switch between Source/Header"
+            }
+        ],
+        "keybindings": [
+            {
+                "command": "clangd-vscode.switchheadersource",
+                "key": "Alt+o",
+                "mac": "Alt+cmd+o",
+                "when": "editorTextFocus"
             }
+        ]
     }
 }

clang-tools-extra/trunk/clangd/clients/clangd-vscode/src/extension.ts

 import * as vscode from 'vscode';
 import * as vscodelc from 'vscode-languageclient';
 import { realpathSync } from 'fs';
 
 /**
  * Method to get workspace configuration option
  * @param option name of the option (e.g. for clangd.path should be path)
  * @param defaultValue default value to return if option is not set
  */
 function getConfig<T>(option: string, defaultValue?: any): T {
     const config = vscode.workspace.getConfiguration('clangd');
     return config.get<T>(option, defaultValue);
 }
 
+namespace SwitchSourceHeaderRequest {
+export const type =
+    new vscodelc.RequestType<vscodelc.TextDocumentIdentifier, string|undefined,
+                             void, void>('textDocument/switchSourceHeader');
+}
+
 /**
  *  this method is called when your extension is activate
  *  your extension is activated the very first time the command is executed
  */
 export function activate(context: vscode.ExtensionContext) {
     const syncFileEvents = getConfig<boolean>('syncFileEvents', true);
 
     const clangd: vscodelc.Executable = {
const clientOptions: vscodelc.LanguageClientOptions = {
         // symlinks where needed (or if this causes problems for other workflows).
         uriConverters: {
             code2Protocol: (value: vscode.Uri) => value.toString(),
             protocol2Code: (value: string) =>
                 vscode.Uri.file(realpathSync(vscode.Uri.parse(value).fsPath))
         }
     };
 
-    const clangdClient = new vscodelc.LanguageClient('Clang Language Server', serverOptions, clientOptions);
-    console.log('Clang Language Server is now active!');
-
-    const disposable = clangdClient.start();
+  context.subscriptions.push(clangdClient.start());
+  context.subscriptions.push(vscode.commands.registerCommand(
+      'clangd-vscode.switchheadersource', async () => {
+        const uri =
+            vscode.Uri.file(vscode.window.activeTextEditor.document.fileName);
+        if (!uri) {
+          return;
+        }
+        const docIdentifier =
+            vscodelc.TextDocumentIdentifier.create(uri.toString());
+        const sourceUri = await clangdClient.sendRequest(
+            SwitchSourceHeaderRequest.type, docIdentifier);
+        if (!sourceUri) {
+          return;
+        }
+        const doc = await vscode.workspace.openTextDocument(
+            vscode.Uri.parse(sourceUri));
+        vscode.window.showTextDocument(doc);
+      }));
 }