CMakeでソースファイルの検証：ポリシーCMP0132、その他の方法、サンプルコード

CMake ポリシー CMP0132 は、target_sources コマンドでソースファイルのリストに追加されたファイルが、ターゲットのソースツリー内にあることを検証するオプションです。このポリシーは、誤ったパスや重複するエントリによるビルドエラーを防ぐために役立ちます。

有効化

このポリシーは、CMakeLists.txt ファイルで以下のコマンドを使用して有効化できます。

cmake_policy(CMP0132 NEW)

動作

CMP0132 が有効の場合、target_sources コマンドで追加されたファイルは以下の条件を満たす必要があります。

• ファイルがターゲットのソースツリー内に存在する必要があります。
• ファイルがすでにターゲットのソースファイルリストに存在する場合は、エラーが発生します。

条件を満たさないファイルが追加された場合、CMake は以下のメッセージを出力してビルドを中止します。

Error: Source file `<file_path>` is not in the source tree of target `<target_name>`.

例外

以下の場合、ファイルはソースツリー内に存在していなくても追加できます。

• ファイルが絶対パスで指定されている場合
• ファイルが CMAKE_MODULE_PATH または CMAKE_INCLUDE_PATH で指定されているディレクトリ内に存在する場合

使用例

以下の例は、CMP0132 ポリシーを使用して、my_target ターゲットに main.cpp と helper.cpp という 2 つのソースファイルを追加する方法を示しています。

cmake_policy(CMP0132 NEW)

add_executable(my_target main.cpp helper.cpp)

利点

• 誤ったパスによるビルドエラーを防ぐ
• ソースファイルリストの重複を防ぐ
• コードの可読性と保守性を向上させる

欠点

• すべてのプロジェクトで必要とは限らない
• 複雑なプロジェクトでは、設定が煩雑になる可能性がある

代替手段

• CMAKE_SOURCE_DIR マクロを使用して、ソースツリーのルートディレクトリを指定する
• file(GLOB) コマンドを使用して、ソースファイルを検索する

CMake ポリシー CMP0132 のサンプルコード

サンプル 1: ポリシーの有効化と基本的な使用例

cmake_policy(CMP0132 NEW)

add_executable(my_target
  main.cpp
  helper.cpp)

サンプル 2: 絶対パスを使用する例外

cmake_policy(CMP0132 NEW)

add_executable(my_target
  /path/to/main.cpp
  helper.cpp)

このコードは、my_target ターゲットに main.cpp と helper.cpp という 2 つのソースファイルを追加します。main.cpp は絶対パスで指定されているため、ソースツリー内に存在していなくても追加できます。

サンプル 3: CMAKE_MODULE_PATH を使用する例外

cmake_policy(CMP0132 NEW)

set(CMAKE_MODULE_PATH /path/to/modules)

add_executable(my_target
  main.cpp
  helper.cmake)

このコードは、my_target ターゲットに main.cpp と helper.cmake という 2 つのファイルを追加します。helper.cmake は CMAKE_MODULE_PATH で指定されているディレクトリ内に存在するため、ソースツリー内に存在していなくても追加できます。

サンプル 4: ポリシーの無効化

cmake_policy(CMP0132 OLD)

add_executable(my_target
  /path/to/main.cpp
  ../other_dir/helper.cpp)

このコードは、my_target ターゲットに main.cpp と helper.cpp という 2 つのソースファイルを追加します。CMP0132 ポリシーが無効化されているため、これらのファイルはソースツリー内に存在していなくても追加できます。

CMake ポリシー CMP0132 は、誤ったパスや重複するエントリによるビルドエラーを防ぐために役立ちます。このポリシーを有効にすることで、コードの可読性と保守性を向上させることができます。

CMake でソースファイルのリストに追加されたファイルがターゲットのソースツリー内にあることを検証する方法

CMAKE_SOURCE_DIR マクロは、ソースツリーのルートディレクトリを返します。このマクロを使用して、ソースファイルのパスを相対パスで指定することができます。

add_executable(my_target
  ${CMAKE_SOURCE_DIR}/main.cpp
  ${CMAKE_SOURCE_DIR}/helper.cpp)

このコードは、my_target ターゲットに main.cpp と helper.cpp という 2 つのソースファイルを追加します。これらのファイルは、ソースツリーのルートディレクトリに存在する必要があります。

file(GLOB) コマンドは、指定されたディレクトリ内のファイルのリストを生成します。このコマンドを使用して、ソースファイルを検索することができます。

file(GLOB_RECURSE SOURCES *.cpp)

add_executable(my_target ${SOURCES})

このコードは、my_target ターゲットに、CMakeLists.txt ファイルと同じディレクトリにあるすべての .cpp ファイルを追加します。

自作の関数を使用する

上記の 2 つの方法以外にも、自作の関数を使用してソースファイルの検証を行うことができます。

function(validate_source_file file)
  if(NOT EXISTS "${file}")
    message(FATAL_ERROR "File '${file}' does not exist.")
  endif()

  if(NOT IS_ABSOLUTE "${file}")
    set(file "${CMAKE_SOURCE_DIR}/${file}")
  endif()

  if(NOT IS_DIRECTORY "${file}")
    message(FATAL_ERROR "File '${file}' is not a directory.")
  endif()
endfunction()

add_executable(my_target
  main.cpp
  helper.cpp)

validate_source_file(main.cpp)
validate_source_file(helper.cpp)

このコードは、main.cpp と helper.cpp という 2 つのソースファイルが存在し、ソースツリー内に存在することを検証します。