vscode で gtags 相当の定義ジャンプ・参照一覧表示の設定をする

本文書は、gtags が提供している機能のうち、私がコードを読む際に利用している「カーソル位置にあるシンボルの定義へのジャンプ」「カーソル位置にあるシンボルの参照へのジャンプ」を vscode に設定する際のメモです。

設定項目

vscode で [File] > [Preferences] > [keyborad shortcuts] を選択して、以下の表の設定名で検索すると、gtagsが提供している該当機能のショートカットキー割り当てを行うことができます。

設定名	挙動
Go to Definition	カーソル位置のあるシンボル定義にジャンプする
Go to References	カーソル位置のあるシンボルを参照している箇所を表示、ジャンプする
goToNextReference	Go to References で表示した一覧上のカーソルの↓(次)の参照に移動する
goToPreviousReference	Go to References で表示した一覧上のカーソルの↑(前)の参照に移動する

環境

有識者の mattn 先生によると、vscode の各言語プラグインインストール時には、各言語の lsp サーバがインストールされているらしいです。なので、各言語の lsp サーバが動作できないような環境(例えば clangd は glibc 2.18 以上をランタイムに要求するが、それ未満のバージョンのglibcで動作している環境など)では、lsp サーバが動作せず、右クリックしたときに出てくるはずの [Go to Definition] などが利用できず、表示されなくなる模様です。そのような環境では、設定項目の欄に記述した方法で設定を行っても、該当機能群が利用できない模様です(2022/4/11に動作確認)。

last updated: 2022/04/11 (更新箇所があれば随時追記予定)