CMakeLists.txtファイルで重複するソースファイルエントリを処理する方法

CMake ポリシー CMP0089 の詳細解説

CMake ポリシー CMP0089 は、target_sources コマンドでソースファイルのリストを指定する際に、重複するエントリを許可するかどうかに影響します。デフォルトでは無効化されており、重複するエントリが存在するとエラーが発生します。

有効化

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

cmake_policy(CMP0089 NEW)

影響

このポリシーが有効化されると、target_sources コマンドで指定されたソースファイルリストに重複するエントリが存在しても、エラーが発生しなくなります。

使用例

以下の例では、target_sources コマンドで main.c ファイルを2回指定しています。CMP0089 ポリシーが無効化されている場合、このコードはエラーになります。

add_executable(my_app main.c main.c)

しかし、CMP0089 ポリシーを有効化すると、このコードはエラーにならずにコンパイルされます。

注意事項

• 重複するエントリを許可すると、ビルドプロセスが複雑になり、意図しない動作が発生する可能性があります。
• 重複するエントリが存在する場合は、CMakeLists.txt ファイルを修正して、重複をなくすことを推奨します。
• このポリシーは、CMake バージョン 3.13 以降でのみ使用できます。

補足

• 上記の説明は、CMake ポリシー CMP0089 の概要を分かりやすく解説することを目的としています。詳細については、上記の参考資料を参照してください。

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

cmake_policy(CMP0089 NEW)

add_executable(my_app main.c main.c)

このコードは、main.c ファイルを2回 target_sources コマンドで指定しています。CMP0089 ポリシーが有効化されているため、このコードはエラーにならずにコンパイルされます。

重複するエントリを許可しない例

# CMakeLists.txt

set(SRC_FILES main.c other.c)

add_executable(my_app ${SRC_FILES})

このコードは、SRC_FILES 変数を使用してソースファイルのリストを定義しています。add_executable コマンドは、SRC_FILES 変数で指定されたファイルをすべてビルド対象に追加します。この例では、main.c ファイルと other.c ファイルがビルド対象に追加されます。

重複するエントリを検出する例

# CMakeLists.txt

set(SRC_FILES main.c other.c)

# 重複するエントリを検出する
list(REMOVE_DUPLICATES SRC_FILES)

add_executable(my_app ${SRC_FILES})

このコードは、list(REMOVE_DUPLICATES) コマンドを使用して、SRC_FILES 変数内の重複するエントリを削除しています。この例では、main.c ファイルと other.c ファイルのみがビルド対象に追加されます。

補足

• 上記のサンプルコードは、CMake ポリシー CMP0089 の使用方法を理解するのに役立ちます。
• 具体的なコードは、プロジェクトの要件に合わせて変更する必要があります。

CMake で重複するソースファイルエントリを扱う他の方法

list(REMOVE_DUPLICATES) コマンドを使用して、ソースファイルリスト内の重複するエントリを削除することができます。

# CMakeLists.txt

set(SRC_FILES main.c other.c main.c)

# 重複するエントリを削除する
list(REMOVE_DUPLICATES SRC_FILES)

add_executable(my_app ${SRC_FILES})

この例では、main.c ファイルが2回リストに存在しますが、list(REMOVE_DUPLICATES) コマンドによって重複が削除され、my_app ターゲットには main.c と other.c ファイルのみが追加されます。

SET_SOURCE_FILES_PROPERTIES コマンドを使用して、ソースファイルのプロパティを設定することができます。このコマンドを使用して、ソースファイルが重複しているかどうかを指定することができます。

# CMakeLists.txt

set(SRC_FILES main.c other.c main.c)

# ソースファイルのプロパティを設定する
set_source_files_properties(${SRC_FILES} DUPLICATE NO)

add_executable(my_app ${SRC_FILES})

この例では、SET_SOURCE_FILES_PROPERTIES コマンドを使用して、SRC_FILES リスト内のすべてのソースファイルの DUPLICATE プロパティを NO に設定しています。これにより、main.c ファイルが2回リストに存在していても、重複として扱われなくなります。

ソースファイルリストをループ処理する

foreach コマンドを使用して、ソースファイルリストをループ処理し、重複するエントリを検出することができます。

# CMakeLists.txt

set(SRC_FILES main.c other.c main.c)

# ソースファイルリストをループ処理する
foreach(file ${SRC_FILES})
  # 重複しているかどうかをチェックする
  if(file IN_LIST processed_files)
    continue()
  endif()

  # ソースファイルを追加する
  list(APPEND processed_files ${file})
  add_executable(my_app ${file})
endforeach()

この例では、foreach コマンドを使用して SRC_FILES リストをループ処理し、processed_files リストにすでに存在するファイルはスキップしています。

カスタム CMake モジュールを使用する

重複するソースファイルエントリを処理するカスタム CMake モジュールを作成することができます。

補足

• 上記の方法は、CMake で重複するソースファイルエントリを扱うためのいくつかの例です。