CMakeの達人になるための秘訣！CMP0100ポリシーを使いこなして開発効率をアップ

CMake ポリシー CMP0100 の詳細解説

このポリシーが解決する問題

CMake では、ターゲットの PUBLIC インターフェースに追加されたヘッダーファイルは、そのターゲットに依存する他のターゲットからも直接インクルードできるようになっています。しかし、この仕組みにはいくつかの問題がありました。

• ヘッダーファイルの重複: 複数のターゲットで同じヘッダーファイルが PUBLIC インターフェースに追加されると、そのヘッダーファイルが重複してインクルードされる可能性があります。
• ヘッダーファイルの依存関係: ヘッダーファイル同士に依存関係がある場合、その依存関係が正しく解決されない可能性があります。

CMP0100 ポリシーは、これらの問題を解決するために導入されました。このポリシーは以下の動作をします。

• ヘッダーファイルの重複排除: 同じヘッダーファイルが複数のターゲットで PUBLIC インターフェースに追加されても、重複してインクルードされることはありません。
• ヘッダーファイルの依存関係の解決: ヘッダーファイル同士の依存関係が正しく解決されます。

CMP0100 ポリシーは以下の方法で設定できます。

• CMakeLists.txt ファイル

cmake_policy(CMP0100 NEW)

• コマンドライン

cmake -DCMP0100=NEW ..

CMP0100 ポリシーは、CMake バージョン 3.13 以降でのみ使用できます。古いバージョンの CMake を使用している場合は、このポリシーを使用できません。

また、CMP0100 ポリシーを有効にすると、既存のコードの動作が変わる可能性があります。そのため、このポリシーを有効にする前に、コードをよく確認する必要があります。

CMP0100 ポリシーは、以下の様な場合に使用できます。

• ヘッダーファイルの重複を避けたい場合
• ヘッダーファイルの依存関係を正しく解決したい場合

• 上記の説明は、CMP0100 ポリシーの基本的な動作についてのみ説明しています。詳細については、上記の参考資料を参照してください。
• CMP0100 ポリシーの使用には、いくつかの注意点があります。詳細は、上記の注意点を参照してください。

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

ヘッダーファイルの重複排除

# ターゲット A
add_library(A INTERFACE)
target_sources(A INTERFACE
  "a.h"
)

# ターゲット B
add_library(B INTERFACE)
target_sources(B INTERFACE
  "a.h"
)

# ターゲット C
add_library(C INTERFACE)
target_sources(C INTERFACE
  "a.h"
  "b.h"
)

# ヘッダーファイル "a.h" は重複してインクルードされない
target_link_libraries(C A B)

ヘッダーファイルの依存関係の解決

# ターゲット A
add_library(A INTERFACE)
target_sources(A INTERFACE
  "a.h"
)

# ターゲット B
add_library(B INTERFACE)
target_sources(B INTERFACE
  "b.h"
  "a.h"
)

# ヘッダーファイル "b.h" は "a.h" に依存するため、
# ターゲット C は "a.h" もインクルードする
target_link_libraries(C A B)

ポリシーの有効化

cmake_policy(CMP0100 NEW)

# 上記のサンプルコードをここに記述

CMake でヘッダーファイルのインクルードパスを指定する他の方法

ヘッダーファイルのインストール

ヘッダーファイルをシステムヘッダーファイルと同じ場所にインストールすれば、include_directories コマンドを使用せずにインクルードできます。

install(FILES a.h DESTINATION include)

ターゲットの PUBLIC インターフェースにヘッダーファイルを追加すると、そのターゲットに依存する他のターゲットからも直接インクルードできるようになります。

add_library(A INTERFACE)
target_sources(A INTERFACE
  "a.h"
)

# ターゲット B はターゲット A のヘッダーファイル "a.h" を直接インクルードできる
add_executable(B
  "b.cpp"
)
target_link_libraries(B A)

target_include_directories コマンドを使用して、特定のターゲットのみにインクルードパスを指定できます。

add_library(A INTERFACE)
target_sources(A INTERFACE
  "a.h"
)

target_include_directories(A PUBLIC
  "/path/to/include"
)

# ターゲット B はターゲット A のヘッダーファイル "a.h" を直接インクルードできる
add_executable(B
  "b.cpp"
)
target_link_libraries(B A)

CMAKE_MODULE_PATH 変数を使用して、CMake モジュールの検索パスを指定できます。CMake モジュールは、ヘッダーファイルのインクルードパスを指定するために使用できます。

set(CMAKE_MODULE_PATH "/path/to/modules")

find_package(MyModule)

# MyModule モジュールはヘッダーファイル "my.h" をインストールする
include_directories(${MyModule_INCLUDE_DIRS})

# ターゲット B は MyModule モジュールのヘッダーファイル "my.h" を直接インクルードできる
add_executable(B
  "b.cpp"
)
target_link_libraries(B MyModule)

add_custom_command コマンドを使用して、独自のインクルードパス設定を行うことができます。

add_custom_command(
  TARGET A
  POST_BUILD
  COMMAND echo "#include <a.h>" > a.inc
)

# ターゲット B は "a.inc" を介してヘッダーファイル "a.h" をインクルードできる
add_executable(B
  "b.cpp"
  "a.inc"
)
target_link_libraries(B A)

どの方法を使用するべきかは、プロジェクトの状況によって異なります。一般的には、include_directories コマンドを使用するのが最も簡単で効率的な方法です。しかし、他の方法の方が適している場合もあります。