CMakeポリシー CMP0097 を使用せずにターゲットのソースツリー内に存在しないファイルをソースファイルリストに追加する方法

CMakeポリシー CMP0097の詳細解説

CMakeポリシーCMP0097は、target_sources コマンドでソースファイルのリストに追加されたファイルが、ターゲットのソースツリー内に存在することを必須とするポリシーです。このポリシーは、CMakeがソースファイルを見つけるのを容易にし、ビルドエラーを防ぐために役立ちます。

有効化

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

cmake_policy(CMP0097 NEW)

影響を受けるコマンド

以下のコマンドは、CMP0097ポリシーの影響を受けます。

• target_sources
• add_custom_command
• add_custom_target

動作

CMP0097ポリシーが有効化されている場合、target_sources コマンドでソースファイルのリストに追加されたファイルが、ターゲットのソースツリー内に存在しない場合は、エラーが発生します。

例

以下の例は、CMP0097ポリシーが有効化されている場合にエラーが発生する例です。

cmake_minimum_required(VERSION 3.10)

project(myproject)

add_executable(myexe
  main.c
)

target_sources(myexe PRIVATE ../otherdir/myfile.c)

この例では、myfile.c ファイルは myexe ターゲットのソースツリー内に存在しないため、エラーが発生します。

回避策

CMP0097ポリシーによるエラーを回避するには、以下の方法があります。

• ソースファイルをターゲットのソースツリー内に移動する。
• set_source_files_properties コマンドを使用して、ソースファイルの場所を指定する。
• CMP0097 ポリシーを無効にする。

無効化

CMP0097ポリシーは、以下のコマンドを使用することで無効化できます。

cmake_policy(CMP0097 OLD)

注意事項

CMP0097ポリシーを無効化すると、CMakeがソースファイルを見つけるのが困難になり、ビルドエラーが発生する可能性が高くなります。

CMakeポリシー CMP0097 サンプルコード

サンプルコード 1: ポリシー有効化

cmake_minimum_required(VERSION 3.10)

project(myproject)

cmake_policy(CMP0097 NEW)

add_executable(myexe
  main.c
)

target_sources(myexe PRIVATE ../otherdir/myfile.c)

サンプルコード 2: ポリシー無効化

cmake_minimum_required(VERSION 3.10)

project(myproject)

cmake_policy(CMP0097 OLD)

add_executable(myexe
  main.c
)

target_sources(myexe PRIVATE ../otherdir/myfile.c)

このコードは、CMP0097ポリシーを無効化し、../otherdir/myfile.c ファイルを myexe ターゲットのソースファイルに追加します。このファイルはターゲットのソースツリー内に存在しないため、エラーは発生しません。

サンプルコード 3: set_source_files_properties コマンドの使用

cmake_minimum_required(VERSION 3.10)

project(myproject)

cmake_policy(CMP0097 NEW)

add_executable(myexe
  main.c
)

set_source_files_properties(../otherdir/myfile.c PROPERTIES SOURCE_DIR .)

target_sources(myexe PRIVATE ../otherdir/myfile.c)

このコードは、CMP0097ポリシーを有効化し、../otherdir/myfile.c ファイルを myexe ターゲットのソースファイルに追加します。set_source_files_properties コマンドを使用して、このファイルの場所をターゲットのソースツリー内に設定します。

CMakeポリシー CMP0097は、CMakeがソースファイルを見つけるのを容易にし、ビルドエラーを防ぐために役立ちます。このポリシーを有効化すると、ターゲットのソースツリー内に存在しないファイルをソースファイルリストに追加しようとすると、エラーが発生します。

CMakeでターゲットのソースツリー内に存在しないファイルをソースファイルリストに追加する他の方法

set_source_files_properties コマンドを使用して、ソースファイルの場所をターゲットのソースツリー内に設定できます。

set_source_files_properties(../otherdir/myfile.c PROPERTIES SOURCE_DIR .)

target_sources(myexe PRIVATE ../otherdir/myfile.c)

この例では、../otherdir/myfile.c ファイルの場所をターゲットのソースツリーのルートディレクトリに設定しています。

add_custom_command コマンドを使用して、ソースファイルをターゲットのソースツリー内にコピーするカスタムコマンドを作成できます。

add_custom_command(
  TARGET myexe
  POST_BUILD
  COMMAND cp ../otherdir/myfile.c .
)

target_sources(myexe PRIVATE myfile.c)

この例では、../otherdir/myfile.c ファイルをターゲットのビルドディレクトリにコピーするカスタムコマンドを作成しています。

外部プロジェクトとして追加する

ターゲットのソースツリー内に存在しないファイルは、外部プロジェクトとして追加することもできます。

add_external_project(
  NAME mylib
  SOURCE_DIR ../otherdir
  BUILD_COMMAND cmake -S . -B build
  INSTALL_COMMAND cmake -P cmake_install.cmake
)

target_link_libraries(myexe mylib)

この例では、../otherdir ディレクトリにある mylib プロジェクトを外部プロジェクトとして追加しています。

• ソースファイルがターゲットのソースツリーの一部としてビルドされる必要がある場合は、set_source_files_properties コマンドを使用するのが最良の方法です。
• ソースファイルがターゲットのソースツリーの一部としてビルドされる必要がない場合は、add_custom_command コマンドを使用するのが最良の方法です。
• ソースファイルが複雑なプロジェクトの場合は、外部プロジェクトとして追加するのが最良の方法です。

CMakeでターゲットのソースツリー内に存在しないファイルをソースファイルリストに追加するには、いくつかの方法があります。どの方法を使用するべきかは、状況によって異なります。