VimでのC ++コードの便利なナビゲーションとデバッグ

私が働いている会社は、Linux用のC ++ソフトウェアを開発しています。 長い間、私たちはQt Creatorを使用していましたが、EmacsとVimからは珍しい人たちが働いていました。 自分でVimに移行しようとしたとき、C ++で開発するためのプラグインの状況は非常に難しいことに気付きました。 CTagsを少し使ってみたところ、ファイルがなければVimでの作業は非常に難しいことにすぐに気付きました。

残念ながら、Vimでの作業経験が増えているため、エミュレーションモードのQt Creatorのエディターは次第に私にふさわしくなくなりました。

開発環境から自分が望む4つのことを概説しましたが、Vimで完全に切り替えるにはこれで十分です。



1.自動補完

2.コードナビゲーション

3.環境から直接デバッグする

4. Gitとの統合（特に、エディターでの直接の非難、およびGit Grep）



Vimのオートコンプリートは解決された問題であり、 YouCompleteMeソリューションの名前です。 これは非常に高品質のプラグインであり、多数のプログラミング言語、特にPythonおよびC ++の自動補完を実装しています。 うわさによると、Google YouCompleteMe内ではコードナビゲーションの2番目の問題も解決されますが、インデックス作成にはGoogleの内部ツールが使用されます。



Gitとの統合は、 vim-fugitiveを使用してある程度解決されました。 これは、Jet BrainsやVisual Studioで発生するような複雑な統合ではありませんが、Qt Creatorが提供するものに匹敵します。 私が必要とした2つのスクリプト：blameとgrep-うまくいきます。



デバッグとナビゲーションは、問題をはるかに悪化させました。 この記事では、C ++コードをナビゲートするために作成したプラグインについて説明します。 記事の最後で、統合デバッガーを使用して問題を解決した方法についても説明します。



もちろん、前述したように、ナビゲーションにCTagを使用することもできますが、CTagを使用した場合、問題を解決できないことがわかります。 C ++パーサーは非常に弱く、多くの場合、CTagsはコードの完全に誤ったセクションを検出します。



インターネットでは、数年前と現在の両方で、C ++コードを介したナビゲーションのトピックに関する唯一のものはこの記事です。 このプラグインを構成し、基本的に機能しました。 しかし、多くの苦情があり、そのうち2つが最大でした：

1.インデックス作成プロセスは手動で開始する必要があります

2.名前でシンボルを見つけることができません



最後に、Vim用の独自のプラグインの開発ですべてが終わりました。これにより、C ++コードをナビゲートできます。 コンパイルデータベースが必要です。 プロジェクトでCMakeを使用している場合、それを取得するには、

cmake . -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

それ以外の場合は、 Bearを使用するか、手でビルドできます。形式は非常に簡単です。



プラグインはCtrlKと呼ばれ、次のことを実行できます。



1.カーソルの下のキャラクター定義に移動します。

2.カーソルの下の文字のすべての出現を検索します。

3.名前でキャラクターを検索します（これにはFuzzyFinderが使用されますが、残念ながら検索はファジーではなく、部分文字列のみで行われます）。 検索は、関数、メソッド、クラス、グローバル変数、マクロ、さらには関数の引数やローカル変数に対しても機能します。

4.カーソルがステータスバーにある関数の名前を表示します。 アナウンスが画面外にあるときに大きな機能を編集する場合に非常に便利です。



さらに、カーソルの下のシンボルの定義が常に表示される別のウィンドウを表示する実験的な機会があります。 Source Insight環境でこのような機会を見ただけで、その有用性は議論の余地があるように見えますが、非常に便利だと思います。



プラグインは、コードの解析にlibclangを使用し、インデックスにleveldbを使用します。



YouCompleteMeと同様に、プラグインはサーバーパーツとクライアントで構成されます。 ここで、サーバー部分とは、Vimと並行して実行され、Vimと通信するプロセスを指します。 インストールについては、YCMとは少し異なる方法で行った。 YouCompleteMeがVundleを介してインストールした後に手でMakeを実行するように要求した場合、代わりにpipを介してサーバー側をインストールしました。

最初は、プラグイン全体をPythonで記述でき、サーバー側では実行できないように見えましたが、pythonのclangライブラリを介した多数のファイルの解析速度は非常に遅く、C ++で記述しなければなりませんでした。インストールが複雑になります。



その結果、インストールは、Pythonライブラリclang、leveldb、およびctrlkのサーバー側のインストールに要約されます。

  sudo pip install leveldb sudo pip install clang sudo pip install ctrlk
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

プラグインをインストールします（CtrlKが依存するL9とFuzzyFinderも同様）。 これを行う最も簡単な方法は、 Vundleを使用することです 。

  Plugin 'L9' Plugin 'FuzzyFinder' Plugin 'SkidanovAlex/CtrlK'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして、vimrcを少し調整します

  let g:ctrlk_clang_library_path="/home/user/llvm/lib" nmap <F3> :call GetCtrlKState()<CR> nmap <Ck> :call CtrlKNavigateSymbols()<CR> nmap <F2> :call CtrlKGoToDefinition()<CR> nmap <F12> :call CtrlKGetReferences()<CR>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで、g_ctrlk_clang_library_pathはlibclang.soへのパスを指す必要があります。 たとえば、次を実行して見つけることができます

 locate libclang.so
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その後、コンパイルデータベースディレクトリ（またはそのサブディレクトリ）から起動されたvimはファイルのインデックス作成を開始し、しばらくするとファイルのナビゲートを開始できます。 F3はパーサーの現在のステータスを表示し、Ctrl + Kは文字を検索できるFuzzyFinderを開き、F2は文字定義にジャンプし、F12はカーソルの下の文字が使用されているコード内のすべての場所を表示します。



ステータスバーに現在の関数の名前を表示する場合は、たとえば次のように構成できます。

  hi User1 ctermbg=darkgreen ctermfg=black guibg=darkgreen guifg=black hi User2 ctermbg=gray ctermfg=black guibg=gray guifg=black hi User3 ctermbg=darkgray ctermfg=gray guibg=darkgray guifg=gray set statusline=%1*\ %{CtrlKGetCurrentScope()}\ %2*\ %F%m%r%h\ %w\ \ %3*\ %r%{getcwd()}%h%=%l:%c set laststatus=2
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

作業の例を2つ示します。 最初の例では、プロジェクトフォルダーからVimを起動し、Ctrl + Kを押して、ファイルに移動します。 これはあまり良い例ではありません。ファジーファインダーまたはCtrlPを使用してファイルに簡単に移動できますが、CtrlKでは同じ方法で任意のクラスまたは他の文字に移動できます。







2番目の例では、もう一度Ctrl + Kを使用してRestoreStartWorker関数を見つけ、その中のCodePrinterクラスにカーソルを置き、F12を押してコード内のこのクラスへのすべての参照を見つけます。 F2を押すと、Vimはすぐにクラスの定義にジャンプします。







この例では、すべての発生を見つけるのにわずかな遅延があります。 実際、すぐに動作しますが、ファイルを最初に開いた後、解析に1〜3秒かかり、解析が終了するまで、エントリの決定と検索への移行は機能しません。



結論として、デバッグについて少し説明します。 デバッグ用のプラグインがいくつかあり、それらはすべて非常に悪いです。 私は数日を過ごしましたが、それでもPyClewnをインストールして動作させることができました。 PyClewnを使用すると、ブレークポイントの設定、ローカル変数の確認、Vimからのプログラム出力の直接監視、GDBのコマンドの入力ができます。 これは、たとえばQtCreatorや他の本格的な開発環境との統合よりもはるかに便利ではありませんが、GDBを別のターミナルで実行するよりもわずかに優れています。 PyClewnは一般に問題を解決しましたが、もっと欲しかったです。

私の同僚は、TMuxを使用して1つの画面でVimの隣にGDBを起動し、Vimから直接制御する（たとえば、ブレークポイントを設定し、変数値を見る）、またはGDBウィンドウに切り替えてGDBを操作するVimのプラグインを作成しました。 ローカル変数またはオブジェクトフィールドは、オタクツリーのツリーとして表示できます。 残念ながら、プラグインにはドキュメントがありませんが、インストールは非常に簡単です。 Vundleを介して2つのプラグインをインストールし、vimrcを構成する必要があります。

 Plugin 'ManOfTeflon/exterminator' Plugin 'ManOfTeflon/nerdtree-json'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

標準のnerdtreeが既に使用されている場合は、削除する必要があります。 nerttree-jsonはnerdtreeのフォークであり、これにより機能を拡張し、ツリー要素の遅延計算を行うことができます。



次に、プラグインの作成者による害虫駆除器の構成の例を示します。







TMuxからVimを実行するこの構成では、\ Bからデバッグを開始できます。その結果、TMuxは画面を2つに分割し、2番目にVD関連のGDBを起動します。 特に、GDBでフレームをナビゲートするとき、Vimは現在のフレームのコードを表示し、Vimから、ホットキーを使用してフレームをナビゲートし、ブレークポイントを設定し、プログラムを段階的に実行し、nerdtreeで変数の値を表示できます。 特に、F5はすべてのローカル変数の値を表示し、F6はカーソルの下の変数を表示します。



C ++とそのサーバー側をナビゲートするためのプラグインコードは公開されており、MITライセンスの下でGitHubで利用できます。

https://github.com/SkidanovAlex/CtrlK

https://github.com/SkidanovAlex/py-ctrlk



デバッグプラグインコードも公開されており、WTFPLライセンスで利用できます。

https://github.com/ManOfTeflon/exterminator