cmake_policy()コマンドを使いこなしてCMakeプロジェクトをマスター

CMakeにおけるcmake_policy()コマンドの解説

cmake_policy()コマンドの基本的な構文は以下の通りです。

cmake_policy(<policy-id> <behavior>)

• <policy-id>: ポリシーの識別子。CMP<NNNN>形式で指定されます。
• <behavior>: ポリシーの動作。OLDまたはNEWを指定します。

OLDとNEWの動作の違い

• OLD: 従来の動作。CMakeの古いバージョンと互換性のある動作です。
• NEW: 新しい動作。CMakeの新しいバージョンで導入された動作です。

cmake_policy()コマンドの使用例

# CMake 3.10以降で導入されたポリシーを有効にする
cmake_policy(CMP0070 NEW)

# 特定のポリシーをOLD動作に設定
cmake_policy(CMP0060 OLD)

cmake_policy()コマンドを使用する利点

• CMakeプロジェクトのビルド動作を明確に定義することができます。
• CMakeのバージョン間で互換性のない動作を回避することができます。
• ビルドエラーを防ぐことができます。

補足

• cmake_minimum_required()コマンドは、cmake_policy()コマンドを暗黙的に呼び出します。
• cmake_policy()コマンドは、CMakeLists.txtファイルのどこでも使用することができます。

cmake_policy()コマンドのサンプルコード

cmake_minimum_required(VERSION 3.10)

# CMake 3.10以降で導入されたポリシーを有効にする
cmake_policy(CMP0070 NEW)

project(MyProject)

# ソースファイルの追加
add_executable(my_exe main.cpp)

# ターゲットのビルド
target_link_libraries(my_exe PRIVATE Threads::Threads)

特定のポリシーをOLD動作に設定

cmake_minimum_required(VERSION 3.0)

# 特定のポリシーをOLD動作に設定
cmake_policy(CMP0060 OLD)

project(MyProject)

# ソースファイルの追加
add_executable(my_exe main.cpp)

# ターゲットのビルド
target_link_libraries(my_exe PRIVATE Threads::Threads)

複数のポリシーを設定

cmake_minimum_required(VERSION 3.10)

# 複数のポリシーを設定
cmake_policy(CMP0070 NEW)
cmake_policy(CMP0060 OLD)

project(MyProject)

# ソースファイルの追加
add_executable(my_exe main.cpp)

# ターゲットのビルド
target_link_libraries(my_exe PRIVATE Threads::Threads)

ポリシーの動作を確認

cmake_minimum_required(VERSION 3.10)

# ポリシーの動作を確認
message(STATUS "Policy CMP0070: ${CMAKE_POLICY_CMP0070}")
message(STATUS "Policy CMP0060: ${CMAKE_POLICY_CMP0060}")

project(MyProject)

# ソースファイルの追加
add_executable(my_exe main.cpp)

# ターゲットのビルド
target_link_libraries(my_exe PRIVATE Threads::Threads)

cmake_minimum_required()コマンドによる暗黙的な呼び出し

# CMake 3.10以降で導入されたポリシーを有効にする
cmake_minimum_required(VERSION 3.10)

project(MyProject)

# ソースファイルの追加
add_executable(my_exe main.cpp)

# ターゲットのビルド
target_link_libraries(my_exe PRIVATE Threads::Threads)

上記のコードは、cmake_policy(CMP0070 NEW)コマンドを明示的に呼び出すことなく、cmake_minimum_required(VERSION 3.10)コマンドによって暗黙的にCMP0070ポリシーがNEW動作に設定されます。

これらのサンプルコードは、cmake_policy()コマンドの使い方を理解するために役立ちます。

注意事項

• cmake_policy()コマンドを使用する前に、CMakeのドキュメントで該当するポリシーの詳細を確認してください。
• cmake_policy()コマンドは、CMakeプロジェクトのビルド動作を大きく変更する可能性があります。使用には注意が必要です。

cmake_policy()コマンドの代替方法

CMakeのバージョン管理

CMakeプロジェクトのビルド動作を制御するために、CMakeのバージョン管理を使用することができます。

• cmake_minimum_required()コマンド: 特定のCMakeバージョン以降でのみプロジェクトをビルドするように設定することができます。
• CMakeLists.txtファイルのバージョン管理: 異なるCMakeバージョンで異なる動作になるように、CMakeLists.txtファイルをバージョン管理することができます。

オプションの指定

プロジェクトのビルド時にオプションを指定することで、ビルド動作を制御することができます。

• オプションの追加: add_option()コマンドを使用して、プロジェクトのビルド時に設定できるオプションを追加することができます。
• オプションの利用: option()コマンドを使用して、オプションの値に基づいてビルド動作を変更することができます。

カスタムコマンドの利用

特定の動作を実現するために、カスタムコマンドを作成して実行することができます。

• カスタムコマンドの作成: add_custom_command()コマンドを使用して、カスタムコマンドを作成することができます。

外部ツールの利用

特定の動作を実現するために、外部ツールを使用することができます。

• 外部ツールの呼び出し: execute_process()コマンドを使用して、外部ツールを呼び出すことができます。
• 外部ツールの出力の利用: parse_arguments()コマンドを使用して、外部ツールの出力結果を解析することができます。

これらの代替方法は、cmake_policy()コマンドよりも柔軟性に欠ける場合もありますが、特定の状況では有効な手段となります。