クイック CMake チュートリアル

サンプル CMake プロジェクトを開始する

1. メインメニューからファイル | 新しいプロジェクトを選択します。

2. 左側のペインで C++ 実行ファイルを選択します。

   この例では、プロジェクト名は cmake_testapp で、選択された言語標準は C++17 です。

   

   作成をクリックします。

3. CLion は、単一のソースファイル main.cpp と CMakeLists.txt スクリプトを含むスタブプロジェクトをルートに生成します。

   

   自動生成された CMakeLists.txt には次のコマンドが含まれています。

   コマンド	説明
   cmake_minimum_required(VERSION 3.26)	デフォルトのツールチェーンで設定されているように、最低限必要な CMake のバージョンを指定(英語)します。ほとんどの場合、CMake 実行可能ファイルが意図的に変更されていなければ、これがバンドルされた CMake バージョンです。
   project(cmake_testapp)	プロジェクト作成時に指定した内容に従ってプロジェクト名を定義します。
   set(CMAKE_CXX_STANDARD 17)	プロジェクトの作成時に選択したように、CMAKE_CXX_STANDARD 変数を 17 の値に設定(英語)します。
   add_executable(cmake_testapp main.cpp)	main.cpp からビルドされる cmake_testapp 実行可能ターゲットを追加(英語)します。ターゲットについては後述します。

4. IDE の左側のツールバーにある をクリックして CMake ツールウィンドウを開き、プロジェクトのロードの進行状況とステータスを確認できます。

   

1. プロジェクトツリーでルートフォルダーを右クリックし、新規 | C/C++ ソースファイルを選択します。

   

2. ターゲットに追加チェックボックスを設定します。

   

3. OK をクリックすると、新しいファイルが add_executable コマンドに追加されます。

   

新しい実行可能ターゲット

1. プロジェクトツリーでルートフォルダーを右クリックし、新規 | C/C++ ソースファイルを再度選択します。

2. ファイル名を設定します (この例では calc)。

3. ターゲットに追加フィールドで、cmake_testapp チェックボックスをオフにします。

4. 新しいターゲットの追加リンクをクリックします。

   

5. ターゲット名 (cmake_testapp_calc) を指定し、追加をクリックします。

   

6. 新しく作成したターゲットがリストに表示されます。

   cmake_testapp_calc ターゲットのみが選択されていることを確認します。

   

   OK をクリックします。

7. CLion は新しい add_executable コマンドを CMakeLists.txt に追加し、プロジェクトを再ロードします。

   

8. 再ロード後、新しい構成が構成スイッチャーに表示されます。

   

新しいライブラリターゲット

1. プロジェクトツリーでルートフォルダーを右クリックし、新規 | C/C++ ソースファイルを再度選択します。

2. ファイル名 (calc_lib) を指定します。

3. ターゲットに追加フィールドのチェックボックスをオフにします。

4. 新しいターゲットの追加をクリックします。

   

5. ドロップダウンリストで、add_library を選択します。

   

6. ターゲット名 (cmake_testapp_lib) を設定し、追加をクリックします。

   

7. 新しく作成したターゲットがリストに表示されます。

   他のターゲットのチェックボックスがオフになっていることを確認してください。

   

   関連するヘッダーを作成するチェックボックスを設定して、ヘッダーファイル calc_lib.h も追加します。

   OK をクリックします。

8. CLion は add_library コマンドを CMakeLists.txt に追加し、プロジェクトを再ロードします。

   

9. 実行可能ターゲットの場合と同様に、CLion はライブラリターゲットの構成を自動的に作成します。

   

   ただし、これは実行不可能な構成であるため、実行またはデバッグしようとすると、「 実行可能ファイルが指定されていません」というエラーメッセージが表示されます。

   

10. ライブラリファイルを取得するには、この構成をビルドする必要があります。スイッチャーでそれを選択し、Control+F9 を押すか、ビルドアイコンをクリックします。

    

    その結果、libcmake_testapp_lib.a ファイルが cmake-build-debug フォルダーに表示されます。

    

CMake プリセット

CMake プリセット(英語)は、次の 2 つのファイルを使用して CMake オプションを構成および共有する方法です。

• プロジェクトごとのビルド用の CMakePresets.json。このファイルは VCS 経由で共有できます。

• 開発者自身のローカルビルド用の CMakeUserPresets.json。このファイルは VCS にチェックインしないでください。

これらのファイルはどちらも同じ形式で、プロジェクトのルートディレクトリに配置する必要があります。

CMake プロファイル

プロファイルには、ツールチェーンとビルド型、およびジェネレーターや環境変数などの CMake オプションが含まれます。たとえば、異なるコンパイラーを使用したり、異なる設定でターゲットをビルドしたりするために、プロジェクトに複数のプロファイルを構成できます。

リリースビルド用のプロファイルを追加する例については、次の章を参照してください。

1. 例として、プロジェクトルートに 3 つのディレクトリ includes、includes/general、includes/math を作成してみましょう。プロジェクトツリーのコンテキストメニューで新規 | ディレクトリオプションを使用します。

   

2. CMakeLists.txt を開き、次のコマンドを追加します。

   target_include_directories (cmake_testapp_lib PUBLIC includes/math) target_include_directories (cmake_testapp_lib PUBLIC includes/general)

   これら 2 つのコマンドにより、general および math にあるヘッダーを cmake_testapp_lib ターゲットのソースから利用できるようになります。

   例: header_math.h というヘッダーを includes/math フォルダー内に配置すると、#include "header_math.h" を使用して calc_lib.cpp からヘッダーをインクルードできます。

1. 1 つまたは複数の CMakeLists.txt ファイルにブレークポイントを配置します。

2. 最上位の CMakeLists.txt を開き、最初のコマンドの横にあるガターアイコンをクリックして、デバッグを選択します。

   

3. CLion は CMake デバッグセッションを開始します。

   

   詳細については、CMake デバッグ機能を参照してください。

サンプルプロジェクトに CTest を追加する

1. プロジェクトルートに ctest ディレクトリを作成します。

2. 次のファイルを ctest ディレクトリに追加します。

   • ソースファイル addvalues_zero.cpp。現時点では、このファイルを CMake ターゲットにリンクしないでください。

   • ヘッダーファイル assert_macro.h。現時点では、このファイルを CMake ターゲットにリンクしないでください。

   • CMakeLists.txt スクリプト。

   

3. ctest/CMakeLists.txt に次の行を追加します。

   cmake_minimum_required(VERSION 3.14.0 FATAL_ERROR) add_executable(ctest_exe_addvalues_zero addvalues_zero.cpp) add_test(ctest_addvalues_zero ctest_exe_addvalues_zero)

   最初の行は、CMake のバージョン 3.14 に対応する CTest のサポートされている最小バージョンを示しています。

   ここでは add_test(英語) コマンドを使用して、ctest_exe_addvalues_zero 実行可能ファイルを CTest に登録しています。

4. これで、実際のコードをテストソース内に配置できます。

   • assert_macro.h :

     #include <iostream> #include <sstream> #define assertEqual( ... ) \ do { \ if( !( __VA_ARGS__ ) ) { \ std::cerr << "Unit test assert [ " \ << ( #__VA_ARGS__ ) \ << " ] failed in line [ " \ << __LINE__ \ << " ] file [ " \ << __FILE__ << " ]" \ << std::endl; \ err_code = 1; \ } \ } while( false )

   • addvalues_zero.cpp :

     #include "assert_macro.h" int test_addvalues_zero() { int err_code = 0; assertEqual (0+0 == 0); assertEqual ((-5)+5 == 0); return err_code; } int main() { return test_addvalues_zero(); }

5. 次に、CTest を有効にして、トップレベルの CMakeLists.txt でサブプロジェクトを宣言する必要があります。

   enable_testing() add_subdirectory(ctest)

   enable_testing(英語) コマンドは、CTest を実行する組み込みのターゲット test を作成します。

6. プロジェクトを再読み込みしてください。

テストするコードを追加する

CTest でテストするコードを準備しましょう。

1. calc_lib.cpp に簡単な関数を追加します

   int add_values (int a, int b) { return a+b;}

2. 関連付けられたヘッダー calc_lib.h に、関数宣言を追加します。

   int add_values (int a, int b);

CTest 構成を編集する

1. 実行 | 実行構成の編集に移動します。

2. CTest アプリケーションノードに、自動的に作成されたすべての CTest 構成があります。

   テストする関数は cmake_testapp_lib ライブラリにあるため、構成設定で構築するターゲットを変更する必要があります。

   

3. 実行するテストリストフィールドも確認してみましょう。ペンアイコンをクリックして利用可能なテストのリストダイアログを開き、一連のテストを表示および調整できます。

   

CTest 構成を実行して結果を調べる

1. 構成スイッチャーですべての CTest を選択し、 をクリックするか、Shift+F10 を押します。

   

2. テストランナーウィンドウで結果を見つけます。