CMake プロジェクトで CMAKE_PROJECT_INCLUDE を活用する

CMakeにおける CMAKE_PROJECT_INCLUDE 変数の詳細解説

CMAKE_PROJECT_INCLUDE は、CMakeプロジェクト内のすべてのプロジェクト呼び出しの最後のステップとして、CMake言語ファイルまたはモジュールを挿入するために使用する変数です。ソースコードを変更することなく、プロジェクトビルドにカスタムコードを挿入したい場合に便利です。

機能

• CMake 3.15で導入されました。
• 複数のファイルパスをセミコロンで区切って指定できます。
• CMake 3.29から、CMAKE_MODULE_PATH または CMake に組み込まれたモジュール名も指定できます。
• 以下の変数と関連しています。
  • CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE
  • CMAKE_PROJECT_INCLUDE_BEFORE

使用例

1. カスタムコマンドの挿入

set(CMAKE_PROJECT_INCLUDE "${CMAKE_SOURCE_DIR}/custom_commands.cmake")

project(my_project)

# カスタムコマンドがすべてのターゲットビルドの前に実行されます

1. 外部モジュールの読み込み

set(CMAKE_PROJECT_INCLUDE "FindPkgConfig.cmake")

project(my_project)

find_package(PkgConfig REQUIRED)

注意事項

• CMAKE_PROJECT_INCLUDE は、プロジェクト内のすべてのターゲットビルドに影響を与えます。特定のターゲットにのみ影響を与えたい場合は、add_custom_command や target_include_directories などの他の方法を使用する必要があります。
• コードの再利用性を高めるために、カスタムコードを個別の CMake モジュールに格納することをお勧めします。

補足

• 質問は日本語で受け付けています。

CMakeにおける CMAKE_PROJECT_INCLUDE 変数のサンプルコード

# カスタムコマンドを定義するファイル
set(CUSTOM_COMMAND_FILE "${CMAKE_SOURCE_DIR}/custom_commands.cmake")

# CMAKE_PROJECT_INCLUDE でカスタムコマンドファイルを挿入
set(CMAKE_PROJECT_INCLUDE "${CUSTOM_COMMAND_FILE}")

project(my_project)

# カスタムコマンドがすべてのターゲットビルドの前に実行されます

外部モジュールの読み込み

# FindPkgConfig モジュールを読み込む
set(CMAKE_PROJECT_INCLUDE "FindPkgConfig.cmake")

project(my_project)

find_package(PkgConfig REQUIRED)

ヘッダーファイルの追加

# プロジェクト内のすべてのソースファイルにヘッダーファイルを追加
set(CMAKE_PROJECT_INCLUDE "${CMAKE_SOURCE_DIR}/include")

project(my_project)

# ヘッダーファイルは自動的にインクルードパスに追加されます

ターゲット固有のインクルードパス設定

# ターゲット固有のインクルードパスを設定する
set(CMAKE_PROJECT_INCLUDE_BEFORE "target_specific_includes.cmake")

project(my_project)

add_library(my_library SHARED
  src/main.cpp)

# my_library ターゲットのみ "target_specific_includes.cmake" が読み込まれます
target_include_directories(my_library PUBLIC "${CMAKE_SOURCE_DIR}/target_specific")

複数の CMakeLists.txt ファイルで CMAKE_PROJECT_INCLUDE を使用する

# 親ディレクトリの CMakeLists.txt ファイル
set(CMAKE_PROJECT_INCLUDE "${CMAKE_SOURCE_DIR}/common.cmake")

# 子ディレクトリの CMakeLists.txt ファイル
project(my_subproject)

# 親ディレクトリで設定された "common.cmake" が読み込まれます

CMAKE_PROJECT_INCLUDE 以外の方法

add_custom_command

特定のターゲットビルドの前または後にカスタムコマンドを実行したい場合に便利です。

add_custom_command(
  TARGET my_target
  PRE_BUILD
  COMMAND ${CMAKE_COMMAND} -E echo "Custom command before build")

add_custom_command(
  TARGET my_target
  POST_BUILD
  COMMAND ${CMAKE_COMMAND} -E echo "Custom command after build")

target_include_directories

特定のターゲットにのみインクルードパスを追加したい場合に便利です。

target_include_directories(my_target PUBLIC "${CMAKE_SOURCE_DIR}/custom_includes")

CMake モジュールの作成

コードの再利用性を高めるために、カスタムコードを個別の CMake モジュールに格納することができます。

# custom_module.cmake
function(custom_function)
  # カスタムコード
endfunction()

# CMakeLists.txt ファイル
set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/modules")

project(my_project)

include(custom_module)

custom_function()

CMakeLists.txt ファイルの直接編集

簡単な変更であれば、CMakeLists.txt ファイルを直接編集することもできます。

project(my_project)

# ソースファイルに直接ヘッダーファイルをインクルード
add_executable(my_executable src/main.cpp)

# ターゲットに直接カスタムコマンドを追加
add_custom_command(
  TARGET my_executable
  POST_BUILD
  COMMAND ${CMAKE_COMMAND} -E echo "Custom command after build")

プロジェクトの要件に応じて、最適な方法を選択する必要があります。

• すべてのターゲットビルドに影響を与えたい場合は、CMAKE_PROJECT_INCLUDE を使用します。
• 特定のターゲットのみ