CMake の INTERFACE_SYSTEM_INCLUDE_DIRECTORIES とは？

CMake の Properties: Targets における INTERFACE_SYSTEM_INCLUDE_DIRECTORIES の解説

INTERFACE_SYSTEM_INCLUDE_DIRECTORIES は、CMake のターゲットプロパティの一つであり、他のターゲットがこのターゲットを依存関係として使用する際に、コンパイル時に自動的に追加されるシステムヘッダーディレクトリを指定します。これは、ターゲットが提供するインターフェースの一部として公開されるヘッダーファイルへのパスを指定するために使用されます。

主なポイント

• INTERFACE_SYSTEM_INCLUDE_DIRECTORIES は、ターゲットのインターフェースにのみ影響を与えます。つまり、このターゲットを直接ビルドする際には使用されません。
• システムヘッダーディレクトリは、コンパイラによって自動的に検索されるため、target_include_directories() コマンドで指定する必要はありません。
• 複数のターゲットで同じシステムヘッダーディレクトリを共有する必要がある場合は、INTERFACE_SYSTEM_INCLUDE_DIRECTORIES を使用することで重複を避けることができます。
• このプロパティは、PUBLIC または INTERFACE キーワードと共に使用できます。

詳細

• PUBLIC キーワードは、このターゲットを依存関係として使用するすべてのターゲットにヘッダーディレクトリを公開することを意味します。
• INTERFACE キーワードは、このターゲットを直接ビルドするターゲットにはヘッダーディレクトリを公開せず、このターゲットを依存関係として使用するターゲットにのみ公開することを意味します。
• 複数のディレクトリを指定する場合は、 ; で区切ります。
• 相対パスは、ターゲットのソースディレクトリからの相対パスとして解釈されます。
• 絶対パスは、そのまま使用されます。

例

add_library(mylib INTERFACE)

target_include_directories(mylib PUBLIC "include")

set_target_properties(mylib PROPERTIES
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/usr/include/mylib")

この例では、mylib ターゲットは include ディレクトリ内のヘッダーファイルを公開します。また、mylib ターゲットを依存関係として使用するターゲットは、/usr/include/mylib ディレクトリ内のシステムヘッダーファイルも自動的に使用することができます。

CMake の INTERFACE_SYSTEM_INCLUDE_DIRECTORIES のサンプルコード

基本的な例

add_library(mylib INTERFACE)

target_include_directories(mylib PUBLIC "include")

set_target_properties(mylib PROPERTIES
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/usr/include/mylib")

複数のディレクトリを指定する例

add_library(mylib INTERFACE)

target_include_directories(mylib PUBLIC "include1" "include2")

set_target_properties(mylib PROPERTIES
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/usr/include/mylib1" "/usr/include/mylib2")

この例では、mylib ターゲットは include1 と include2 ディレクトリ内のヘッダーファイルを公開します。また、mylib ターゲットを依存関係として使用するターゲットは、/usr/include/mylib1 と /usr/include/mylib2 ディレクトリ内のシステムヘッダーファイルも自動的に使用することができます。

相対パスを使用する例

add_library(mylib INTERFACE)

target_include_directories(mylib PUBLIC ".")

set_target_properties(mylib PROPERTIES
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "../include")

この例では、mylib ターゲットは現在のディレクトリ内のヘッダーファイルを公開します。また、mylib ターゲットを依存関係として使用するターゲットは、../include ディレクトリ内のシステムヘッダーファイルも自動的に使用することができます。

PUBLIC と INTERFACE キーワードの違い

add_library(mylib1 INTERFACE)
add_library(mylib2 INTERFACE)

target_include_directories(mylib1 PUBLIC "include")

set_target_properties(mylib2 PROPERTIES
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/usr/include/mylib")

add_executable(myexe)

target_link_libraries(myexe mylib1 mylib2)

この例では、myexe は mylib1 と mylib2

CMake でシステムヘッダーディレクトリを指定する他の方法

target_include_directories() コマンドは、ターゲットのビルド時に使用されるヘッダーディレクトリを指定します。これは、ターゲットが提供するインターフェースの一部として公開されるヘッダーファイルだけでなく、ターゲット自身が使用するヘッダーファイルも指定するために使用できます。

add_library(mylib)

target_include_directories(mylib PUBLIC "include")

target_link_libraries(mylib "/usr/lib/mylib.so")

この例では、mylib ターゲットは include ディレクトリ内のヘッダーファイルを使用します。また、mylib ターゲットは /usr/lib/mylib.so ライブラリにリンクされます。

find_package() コマンドは、特定のライブラリまたはフレームワークのヘッダーファイルとライブラリファイルを自動的に検出します。

find_package(Pkg REQUIRED)

target_include_directories(mylib PUBLIC ${Pkg_INCLUDE_DIRS})

target_link_libraries(mylib ${Pkg_LIBRARIES})

この例では、Pkg というライブラリまたはフレームワークが自動的に検出されます。mylib ターゲットは、Pkg_INCLUDE_DIRS 変数に格納されているヘッダーファイルを使用し、Pkg_LIBRARIES 変数に格納されているライブラリファイルにリンクされます。

環境変数

C_INCLUDE_PATH や CPLUS_INCLUDE_PATH などの環境変数を使用して、システムヘッダーディレクトリを指定することができます。

set(ENV{C_INCLUDE_PATH} "/usr/include")
set(ENV{CPLUS_INCLUDE_PATH} "/usr/include/c++")

add_library(mylib)

この例では、mylib ターゲットは /usr/include と /usr/include/c++ ディレクトリ内のシステムヘッダーファイルを使用します。

手動でヘッダーファイルを指定する

ソースファイルに直接ヘッダーファイルのパスを指定することができます。

#include "/usr/include/mylib.h"

int main() {
  // ...
}

この例では、main.c ファイルは /usr/include/mylib.h ヘッダーファイルを直接インクルードします。

• ターゲットが提供するインターフェースの一部として公開されるヘッダーファイルには、INTERFACE_SYSTEM_INCLUDE_DIRECTORIES を使用するのがおすすめです。
• ターゲット自身が使用するヘッダーファイルには、target_include_directories() コマンドを使用するのがおすすめです。
• 特定のライブラリまたはフレームワークのヘッダーファイルとライブラリファイルを自動的に検出したい場合は、find_package() コマンドを使用するのがおすすめです。
• 環境変数は、すべてのターゲットに適用されるため、慎重に使用해야します。
• 手動でヘッダーファイルを指定するのは、最後の手段として使用するのがおすすめです。

CMake でシステムヘッダーディレクトリを指定するには、いくつかの方法があります。どの方法を使用するべきかは、状況によって異なります。