lctags のプロジェクト簡易登録

lctags を利用するには、 解析対象のソースファイル毎にコンパイルオプションを登録する必要があります。

これは、 lctags の解析処理のバックエンドとして利用している libclang が 正確なコンパイルオプションを必要としているためです。

libclang を利用することで正確な構文解析を可能としていますが、 この登録作業は案外面倒なものです。

ちなみに、lctags のコンパイルオプションの登録方法として、 次の 2 つの方法をサポートしています。

• ファイル毎に lctags build コマンドを実行しコンパイルオプションを指定する
• 全ソースのコンパイルオプションが記載された JSON Compilation Database を用意し、 lctags register コマンドを実行する

cmake を利用しているプロジェクトでは、 CMAKE_EXPORT_COMPILE_COMMANDS:BOOL を ON にすることで JSON ファイルを生成できます。 また、GNU make の場合は https://github.com/rizsotto/Bear を利用することで、 JSON ファイルを生成できます。

JSON Compilation Database を利用することで、登録作業を簡単化出来ますが、 GNU global と比べるとまだ手軽さで劣ります。

ある程度の設定は仕方がないところではありますが、 小さなプロジェクトやサンプルコードなどでは、 そもそもコンパイルオプションが不要な場合もあります。

そのような場合に、 lctags をもっと手軽に使いたいです。

ここでは GNU global レベルの簡単さで、lctags の登録が行なえる方法について説明します。

$ cd /proj/top/dir
$ lctags init .
$ lctags lazyUpdate -j 10

$ lctags copyConf

function config:getDefaultOptionList( compiler )
   return {
      "-DHOGE",
      "-I/inc/path"
   }
end