🥇CMake と C++ は永遠の兄弟です

開発中は、コンパイラ、ビルドモード、依存関係のバージョンを変更し、静的解析を実行し、パフォーマンスを測定し、カバレッジを収集し、ドキュメントを生成することが好きです。私は CMake が大好きです。やりたいことはすべてできるからです。

CMake を批判する人は多く、当然のことも多いですが、よく見ると、すべてがそれほど悪いわけではありません。 悪くない、全く、開発の方向性は非常に前向きです。

このノートでは、CMake システムの C++ でヘッダーライブラリを簡単に編成して、次の機能を取得する方法を説明したいと思います。

組み立て;
自動実行テスト。
コードカバレッジの測定。
インストール;
自動文書化。
オンラインサンドボックス生成。
静的解析。

利点と C-make をすでに理解している人は、簡単にプロジェクトテンプレートをダウンロードするそして使い始めてください。

最初のオプションは MYLIB_TESTING — 単体テストを無効にします。これは、テストですべてが順調であることを確認しているが、たとえば、プロジェクトをインストールまたはパッケージ化したいだけである場合に必要になる可能性があります。または、プロジェクトがサブプロジェクトとして含まれています。この場合、プロジェクトのユーザーはテストの実行に興味がありません。使用する依存関係をテストしませんよね?

option(MYLIB_TESTING "Включить модульное тестирование" ON)

また、別途オプションにて対応させていただきます MYLIB_COVERAGE テストによるコードカバレッジの測定には追加のツールが必要となるため、明示的に有効にする必要があります。

option(MYLIB_COVERAGE "Включить измерение покрытия кода тестами" OFF)

コンパイルオプション

もちろん、私たちは優秀なプログラマであるため、コンパイラからのコンパイル時診断の最大レベルが必要です。ネズミ一匹もすり抜けません。

add_compile_options(
    -Werror

    -Wall
    -Wextra
    -Wpedantic

    -Wcast-align
    -Wcast-qual
    -Wconversion
    -Wctor-dtor-privacy
    -Wenum-compare
    -Wfloat-equal
    -Wnon-virtual-dtor
    -Wold-style-cast
    -Woverloaded-virtual
    -Wredundant-decls
    -Wsign-conversion
    -Wsign-promo
)

また、C++ 言語標準に完全に準拠するために、拡張機能も無効にします。 CMake ではデフォルトで有効になっています。

if(NOT CMAKE_CXX_EXTENSIONS)
    set(CMAKE_CXX_EXTENSIONS OFF)
endif()

主な目標

私たちのライブラリはヘッダーファイルのみで構成されています。つまり、静的ライブラリまたは動的ライブラリの形式での出力はありません。一方、ライブラリを外部で使用するには、ライブラリをインストールし、システム内で検出可能にしてプロジェクトに接続する必要があります。同時に、これらの同じヘッダーと、場合によっては追加のヘッダーも必要です。プロパティにアタッチされます。

この目的のために、インターフェイスライブラリを作成します。

add_library(mylib INTERFACE)

ヘッダーをインターフェイスライブラリにバインドします。

現代的でファッショナブルな若者による CMake の使用は、ヘッダーやプロパティなどを意味します。単一のターゲットを介して送信されます。これだけ言えば十分です target_link_libraries(target PRIVATE dependency)、およびターゲットに関連付けられているすべてのヘッダー dependency、ターゲットに属するソースで利用可能になります target。そして何も必要ありません [target_]include_directories。これについては、以下の分析で説明します。単体テスト用の CMake スクリプト.

いわゆるものにも注意を払う価値があります。 выражения-генераторы: $<...>.

このコマンドは、必要なヘッダーをインターフェイスライブラリに関連付けます。ライブラリが同じ CMake 階層内のターゲットに接続されている場合、ディレクトリのヘッダーがそれに関連付けられます。 ${CMAKE_CURRENT_SOURCE_DIR}/includeライブラリがシステムにインストールされており、コマンドを使用して別のプロジェクトに接続されている場合 find_package、その後、ディレクトリのヘッダーがそれに関連付けられます include インストールディレクトリからの相対パス。

target_include_directories(mylib INTERFACE
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
    $<INSTALL_INTERFACE:include>
)

言語の標準を設定しましょう。もちろん、一番最後です。同時に、標準を含めるだけでなく、ライブラリを使用する人々にもそれを拡張します。これは、設定されたプロパティにカテゴリがあるという事実によって実現されます。 INTERFACE （参照してください。 target_compile_features コマンド).

target_compile_features(mylib INTERFACE cxx_std_17)

ライブラリのエイリアスを作成しましょう。さらに、美しさのために、それは特別な「名前空間」にあります。これは、さまざまなモジュールがライブラリに表示され、それらを互いに独立して接続する場合に役立ちます。たとえばバスタのように.

add_library(Mylib::mylib ALIAS mylib)

インストール

ヘッダーをシステムにインストールします。ここではすべてがシンプルです。すべてのヘッダーを含むフォルダーはディレクトリに配置する必要があると言います。 include 設置場所を基準にして。

install(DIRECTORY include/mylib DESTINATION include)

次に、サードパーティプロジェクトでコマンドを呼び出せるようにすることをビルドシステムに通知します。 find_package(Mylib) そしてゴールを得る Mylib::mylib.

install(TARGETS mylib EXPORT MylibConfig)
install(EXPORT MylibConfig NAMESPACE Mylib:: DESTINATION share/Mylib/cmake)

次の呪文はこのように理解する必要があります。サードパーティのプロジェクトでコマンドを呼び出す場合 find_package(Mylib 1.2.3 REQUIRED)、インストールされているライブラリの実際のバージョンは、そのバージョンと互換性がありません。 1.2.3CMake は自動的にエラーを生成します。つまり、手動でバージョンを追跡する必要はありません。

include(CMakePackageConfigHelpers)
write_basic_package_version_file("${PROJECT_BINARY_DIR}/MylibConfigVersion.cmake"
    VERSION
        ${PROJECT_VERSION}
    COMPATIBILITY
        AnyNewerVersion
)
install(FILES "${PROJECT_BINARY_DIR}/MylibConfigVersion.cmake" DESTINATION share/Mylib/cmake)

テスト

テストが明示的に無効になっている場合は、対応するオプションまたは、プロジェクトはサブプロジェクトです。つまり、次のコマンドを使用して別の CMake プロジェクトに接続されています。 add_subdirectory、階層に沿ってさらに進むことはなく、テストを生成および実行するためのコマンドを記述したスクリプトは単に実行されません。

if(NOT MYLIB_TESTING)
    message(STATUS "Тестирование проекта Mylib выключено")
elseif(IS_SUBPROJECT)
    message(STATUS "Mylib не тестируется в режиме подмодуля")
else()
    add_subdirectory(test)
endif()

Документация

サブプロジェクトの場合、ドキュメントも生成されません。

if(NOT IS_SUBPROJECT)
    add_subdirectory(doc)
endif()

オンラインサンドボックス

同様に、サブプロジェクトにもオンラインサンドボックスはありません。

if(NOT IS_SUBPROJECT)
    add_subdirectory(online)
endif()

テストスクリプト (test/CMakeLists.txt)

テスト

まず、必要なテストフレームワークを含むパッケージを見つけます (お気に入りのものに置き換えます)。

find_package(doctest 2.3.3 REQUIRED)

テストを含む実行可能ファイルを作成しましょう。通常、関数を含むファイルのみを実行可能バイナリに直接追加します。 main.

add_executable(mylib-unit-tests test_main.cpp)

そして、テスト自体を後で説明するファイルを追加します。しかし、そんなことをする必要はありません。

target_sources(mylib-unit-tests PRIVATE mylib/myfeature.cpp)

依存関係を結び付けます。必要な CMake ターゲットのみをバイナリにリンクし、コマンドを呼び出していないことに注意してください。 target_include_directories。テストフレームワークと私たちの見出し Mylib::mylib、ビルドパラメーター (この場合、これは C++ 言語標準) も、これらの目標とともに達成されました。

target_link_libraries(mylib-unit-tests
    PRIVATE
        Mylib::mylib
        doctest::doctest
)

最後に、ダミーターゲットを作成します。その「ビルド」はテストの実行に相当し、このターゲットをデフォルトのビルドに追加します (属性はこれを担当します) ALL）。これは、デフォルトのビルドがテストの実行をトリガーすることを意味し、テストの実行を忘れることはありません。

add_custom_target(check ALL COMMAND mylib-unit-tests)

Покрытие

次に、適切なオプションが指定されている場合、コードカバレッジ測定を有効にします。これらは CMake よりもカバレッジを測定するツールに関連するため、詳細には触れません。結果に基づいて目標が作成されることに注意してください。 coverageこれを使用すると、カバレッジの測定を開始するのに便利です。

find_program(GCOVR_EXECUTABLE gcovr)
if(MYLIB_COVERAGE AND GCOVR_EXECUTABLE)
    message(STATUS "Измерение покрытия кода тестами включено")

    target_compile_options(mylib-unit-tests PRIVATE --coverage)
    target_link_libraries(mylib-unit-tests PRIVATE gcov)

    add_custom_target(coverage
        COMMAND
            ${GCOVR_EXECUTABLE}
                --root=${PROJECT_SOURCE_DIR}/include/
                --object-directory=${CMAKE_CURRENT_BINARY_DIR}
        DEPENDS
            check
    )
elseif(MYLIB_COVERAGE AND NOT GCOVR_EXECUTABLE)
    set(MYLIB_COVERAGE OFF)
    message(WARNING "Для замеров покрытия кода тестами требуется программа gcovr")
endif()

ドキュメント用のスクリプト (doc/CMakeLists.txt)

ドキシゲンを見つけました.

find_package(Doxygen)

次に、ユーザーが言語変数を設定したかどうかを確認します。「はい」の場合は触れませんが、そうでない場合はロシア語を使用します。次に、Doxygen システムファイルを構成します。言語を含む必要なすべての変数は、構成プロセス中にそこに移動します (「. команду configure_file).

次に、目標を作成します doc、ドキュメントの生成が開始されます。開発プロセスではドキュメントの生成が最大のニーズではないため、ターゲットはデフォルトでは有効化されず、明示的に起動する必要があります。

if (Doxygen_FOUND)
    if (NOT MYLIB_DOXYGEN_LANGUAGE)
        set(MYLIB_DOXYGEN_LANGUAGE Russian)
    endif()
    message(STATUS "Doxygen documentation will be generated in ${MYLIB_DOXYGEN_LANGUAGE}")
    configure_file(Doxyfile.in Doxyfile)
    add_custom_target(doc COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
endif ()

オンラインサンドボックス用のスクリプト (online/CMakeLists.txt)

ここで XNUMX 番目の Python を見つけてターゲットを作成します wandbox、サービス API に対応するリクエストを生成しますワンドボックスと送り返します。応答には、完成したサンドボックスへのリンクが含まれています。

find_program(PYTHON3_EXECUTABLE python3)
if(PYTHON3_EXECUTABLE)
    set(WANDBOX_URL "https://wandbox.org/api/compile.json")

    add_custom_target(wandbox
        COMMAND
            ${PYTHON3_EXECUTABLE} wandbox.py mylib-example.cpp "${PROJECT_SOURCE_DIR}" include |
            curl -H "Content-type: application/json" -d @- ${WANDBOX_URL}
        WORKING_DIRECTORY
            ${CMAKE_CURRENT_SOURCE_DIR}
        DEPENDS
            mylib-unit-tests
    )
else()
    message(WARNING "Для создания онлайн-песочницы требуется интерпретатор ЯП python 3-й версии")
endif()

屋外でのプロジェクト

それでは、これらすべての使用方法を見てみましょう。

組立

このプロジェクトのビルドは、CMake ビルドシステム上の他のプロジェクトと同様に、次の XNUMX つの段階で構成されます。

世代

cmake -S путь/к/исходникам -B путь/к/сборочной/директории [опции ...]

CMake のバージョンが古いために上記のコマンドが機能しなかった場合は、省略してみてください。 -S:
cmake путь/к/исходникам -B путь/к/сборочной/директории [опции ...]

オプションの詳細.

プロジェクトの構築

cmake --build путь/к/сборочной/директории [--target target]

アセンブリの目標の詳細.

オプション

MYLIB_COVERAGE

cmake -S ... -B ... -DMYLIB_COVERAGE=ON [прочие опции ...]

ターゲットを含む coverageこれを使用して、テストによるコードカバレッジの測定を開始できます。

MYLIB_TESTING

cmake -S ... -B ... -DMYLIB_TESTING=OFF [прочие опции ...]

単体テストのビルドとターゲットを無効にする機能を提供します check。その結果、テストによるコードカバレッジの測定はオフになります (「. MYLIB_COVERAGE).

コマンドを使用してプロジェクトがサブプロジェクトとして別のプロジェクトに接続されている場合も、テストは自動的に無効になります。 add_subdirectory.

MYLIB_DOXYGEN_LANGUAGE

cmake -S ... -B ... -DMYLIB_DOXYGEN_LANGUAGE=English [прочие опции ...]

ターゲットが生成するドキュメントの言語を切り替えます。 doc 与えられたものに。利用可能な言語のリストについては、を参照してください。 Doxygen システムの Web サイト.

ロシア語はデフォルトで有効になっています。

組み立て対象

Поумолчанию

cmake --build path/to/build/directory
cmake --build path/to/build/directory --target all

ターゲットが指定されていない場合 (ターゲットと同等) all）、可能な限りすべてを収集し、ターゲットを呼び出します check.

mylib-単体テスト

cmake --build path/to/build/directory --target mylib-unit-tests

単体テストをコンパイルします。デフォルトで有効になっています。

チェック

cmake --build путь/к/сборочной/директории --target check

収集された (まだ収集されていない場合は) 単体テストを実行します。デフォルトで有効になっています。

См。 также mylib-unit-tests.

カバレッジ

cmake --build путь/к/сборочной/директории --target coverage

プログラムを使用したテストによるコードカバレッジについて、実行中の単体テスト (まだ実行されていない場合は実行) を分析します。 gcovr.

コーティングの排気は次のようになります。

------------------------------------------------------------------------------
                           GCC Code Coverage Report
Directory: /path/to/cmakecpptemplate/include/
------------------------------------------------------------------------------
File                                       Lines    Exec  Cover   Missing
------------------------------------------------------------------------------
mylib/myfeature.hpp                            2       2   100%   
------------------------------------------------------------------------------
TOTAL                                          2       2   100%
------------------------------------------------------------------------------

ターゲットは、オプションが有効な場合にのみ使用できます。 MYLIB_COVERAGE.

См。 также check.

DOC

cmake --build путь/к/сборочной/директории --target doc

システムを使用してコードドキュメントの生成を開始しますドキシゲン.

ワンドボックス

cmake --build путь/к/сборочной/директории --target wandbox

サービスからの応答は次のようになります。

{
    "permlink" :    "QElvxuMzHgL9fqci",
    "status" :  "0",
    "url" : "https://wandbox.org/permlink/QElvxuMzHgL9fqci"
}

このサービスはこのために使用されますワンドボックス。彼らのサーバーがどれほど柔軟であるかはわかりませんが、この機会を悪用すべきではないと思います。

例

カバレッジ測定を使用してデバッグモードでプロジェクトをビルドする

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DMYLIB_COVERAGE=ON
cmake --build путь/к/сборочной/директории --target coverage --parallel 16

事前の組み立てやテストを行わずにプロジェクトをインストールする

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DMYLIB_TESTING=OFF -DCMAKE_INSTALL_PREFIX=путь/к/установойной/директории
cmake --build путь/к/сборочной/директории --target install

指定されたコンパイラを使用してリリースモードでビルドする

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-8 -DCMAKE_PREFIX_PATH=путь/к/директории/куда/установлены/зависимости
cmake --build путь/к/сборочной/директории --parallel 4

英語でのドキュメントの作成

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DMYLIB_DOXYGEN_LANGUAGE=English
cmake --build путь/к/сборочной/директории --target doc

ツール

CMake 3.13

実際、CMake バージョン 3.13 は、このヘルプで説明されているコンソールコマンドの一部を実行する場合にのみ必要です。 CMake スクリプトの構文の観点から見ると、生成が他の方法で呼び出される場合は、バージョン 3.8 で十分です。
テストライブラリドクターテスト

テストは無効にすることができます (「 опцию MYLIB_TESTING).
ドキシゲン

ドキュメントを生成する言語を切り替えるためのオプションが提供されています。 MYLIB_DOXYGEN_LANGUAGE.
言語通訳者 Pythonの3

自動生成の場合オンラインサンドボックス.

静的解析

CMake といくつかの優れたツールを使用すると、最小限の労力で静的分析を行うことができます。

Cppチェック

CMake には静的分析ツールのサポートが組み込まれています Cppチェック.

これを行うには、オプションを使用する必要があります CMAKE_CXX_CPPCHECK:

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_CPPCHECK="cppcheck;--enable=all;-Iпуть/к/исходникам/include"

これ以降、ソースがコンパイルおよび再コンパイルされるたびに、静的解析が自動的に開始されます。追加で何もする必要はありません。

クラン

素晴らしいツールの助けを借りて scan-build 静的分析をすぐに実行することもできます。

scan-build cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug
scan-build cmake --build путь/к/сборочной/директории

ここでは、Cppcheck の場合とは異なり、毎回ビルドを実行する必要があります。 scan-build.

後書き

CMake は、あらゆる好みや色に合わせた機能を実装できる、非常に強力で柔軟なシステムです。そして、構文には改善の余地がある場合もありますが、悪魔は描かれているほど恐ろしいものではありません。社会と健康のために CMake ビルドシステムを使用してください。

→ プロジェクトテンプレートをダウンロード

出所： habr.com

CMake と C++ は永遠の兄弟です

ページ内容

カバレッジ測定を使用してデバッグ モードでプロジェクトをビルドする

事前の組み立てやテストを行わずにプロジェクトをインストールする

指定されたコンパイラを使用してリリース モードでビルドする

英語でのドキュメントの作成

Cppチェック

クラン

コメントを追加します 返信をキャンセル

カバレッジ測定を使用してデバッグモードでプロジェクトをビルドする

指定されたコンパイラを使用してリリースモードでビルドする

コメントを追加します返信をキャンセル