CMakeのLANG_CPPLINTプロパティによる静的コード解析

CMakeにおけるLANG_CPPLINTの解説

LANG_CPPLINTは、CMakeでC++コードの静的コード解析を行うためのプロパティです。Properties: Targetsに設定することで、特定のターゲットに対してC++ Lintツールを実行することができます。

設定方法

LANG_CPPLINTは以下の方法で設定できます。

1. CMakeLists.txtファイル

set_property(TARGET my_target PROPERTY LANG_CPPLINT "cpplint")

上記のように、set_propertyコマンドを使用して、ターゲット名とLANG_CPPLINTプロパティを設定します。cpplintは、Google C++ Style Guideに基づいてコードをチェックするLinterツールです。

1. ターゲットの追加

add_custom_target(cpplint
  COMMAND cpplint
  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
  SOURCES ${CMAKE_SOURCE_DIR}/src/*.cpp
)

上記のように、add_custom_targetコマンドを使用して、cpplintという名前のターゲットを追加することができます。このターゲットは、cpplintコマンドを実行し、CMAKE_SOURCE_DIR/src/*.cppにあるすべてのC++ファイルをチェックします。

利用可能なLinterツール

LANG_CPPLINTプロパティで使用できるLinterツールは、CMakeによってサポートされているものに限られます。主なLinterツールは以下の通りです。

• cpplint: Google C++ Style Guideに基づいてコードをチェックする
• clang-tidy: Clang Static Analyzerに基づいてコードをチェックする
• lint: Clang Static Analyzerの簡易版
• cppcheck: C/C++コードの静的コード解析を行う

補足

• LANG_CPPLINTプロパティは、C++コードのみを対象としています。Cコードの場合は、LANG_CLANG_TIDYプロパティを使用する必要があります。
• 複数のLinterツールを同時に実行したい場合は、 ; で区切って指定することができます。

例

set_property(TARGET my_target PROPERTY LANG_CPPLINT "cpplint;clang-tidy")

上記のように、cpplintとclang-tidyの両方のLinterツールを実行することができます。

LANG_CPPLINTプロパティは、CMakeでC++コードの静的コード解析を行うための便利な機能です。コードの品質向上に役立てるために、ぜひ活用してみてください。

CMakeにおけるLANG_CPPLINTのサンプルコード

set_property(TARGET my_target PROPERTY LANG_CPPLINT "cpplint")

add_custom_command(
  TARGET my_target
  POST_BUILD
  COMMAND cpplint ${CMAKE_SOURCE_DIR}/src/*.cpp
)

上記のように、set_propertyコマンドを使用してcpplintをLANG_CPPLINTプロパティに設定し、add_custom_commandコマンドを使用して、cpplintコマンドをターゲットのビルド後に実行するように設定しています。

複数のLinterツールを使用する

set_property(TARGET my_target PROPERTY LANG_CPPLINT "cpplint;clang-tidy")

add_custom_command(
  TARGET my_target
  POST_BUILD
  COMMAND cpplint ${CMAKE_SOURCE_DIR}/src/*.cpp
  COMMAND clang-tidy ${CMAKE_SOURCE_DIR}/src/*.cpp
)

上記のように、cpplintとclang-tidyの両方のLinterツールをLANG_CPPLINTプロパティに設定し、add_custom_commandコマンドを使用して、両方のツールをターゲットのビルド後に実行するように設定しています。

Linterツールのオプションを指定する

set_property(TARGET my_target PROPERTY LANG_CPPLINT "cpplint --filter=-whitespace")

add_custom_command(
  TARGET my_target
  POST_BUILD
  COMMAND cpplint --filter=-whitespace ${CMAKE_SOURCE_DIR}/src/*.cpp
)

上記のように、cpplintコマンドの--filter=-whitespaceオプションをLANG_CPPLINTプロパティに設定し、add_custom_commandコマンドを使用して、オプションを指定してcpplintコマンドを実行するように設定しています。

特定のファイルのみをチェックする

set_property(TARGET my_target PROPERTY LANG_CPPLINT "cpplint")

add_custom_command(
  TARGET my_target
  POST_BUILD
  COMMAND cpplint ${CMAKE_SOURCE_DIR}/src/main.cpp ${CMAKE_SOURCE_DIR}/src/foo.cpp
)

上記のように、add_custom_commandコマンドを使用して、cpplintコマンドを実行する際に、特定のファイルのみをチェックするように設定することができます。

Linterツールの出力結果を処理する

set_property(TARGET my_target PROPERTY LANG_CPPLINT "cpplint")

add_custom_command(
  TARGET my_target
  POST_BUILD
  COMMAND cpplint ${CMAKE_SOURCE_DIR}/src/*.cpp
  COMMAND grep -E "error:|warning:"
)

上記のように、add_custom_commandコマンドを使用して、cpplintコマンドの出力をgrepコマンドで処理し、エラーや警告のみを表示することができます。

CMakeでC++コードの静的コード解析を行うその他の方法

IDEの統合機能を使用する

多くのIDEには、C++コードの静的コード解析機能が統合されています。これらの機能を使用することで、CMakeを介さずにコード解析を行うことができます。

外部ツールを使用する

cpplintやclang-tidyなどのLinterツールは、CMake以外にも直接実行することができます。これらのツールを直接実行することで、より詳細な設定やオプションを指定することができます。

CMakeのC++ Test Frameworkを使用する

CMakeには、C++コードのテストを行うためのC++ Test Frameworkが付属しています。C++ Test Frameworkには、静的コード解析機能も含まれています。

各方法の比較

CMakeでC++コードの静的コード解析を行う方法はいくつかあります。それぞれの方法には利点と欠点があるので、プロジェクトの状況に合わせて最適な方法を選択する必要があります。