C/C++開発の鬼門、ヘッダーファイル検索を制覇せよ！ CMakeの秘密兵器、CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES

CMakeの変数 CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES の詳細解説

CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES は、CMake の変数の一つで、コンパイラがヘッダーファイルの検索に使用する暗黙のインクルードディレクトリを指定します。この変数を設定することで、#include ディレクティブで指定されたヘッダーファイルが見つかりやすくなります。

詳細

• 変数の形式: CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES
  • <LANG> は、C 言語の場合は C、C++ 言語の場合は CXX など、対象となる言語を表す文字列に置き換えます。
• 設定方法:
  • set(CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES <dir1> <dir2> ...) コマンドを使用します。
  • <dir1>, <dir2> は、検索対象となるディレクトリを指定します。
• 動作:
  • CMake は、#include ディレクティブで指定されたヘッダーファイルが見つからない場合、CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES で設定されたディレクトリを検索します。
  • 検索は、ディレクトリ内のファイル名とヘッダーファイル名が一致するまで、再帰的に行われます。
• 注意事項:
  • この変数は、システムヘッダーファイルの検索には使用されません。システムヘッダーファイルは、コンパイラ固有のパスで検索されます。
  • この変数を設定すると、コンパイラ警告が発生する可能性があります。これは、コンパイラが標準ライブラリのヘッダーファイルよりも、ユーザー定義のヘッダーファイルを優先してしまうためです。
  • この変数を設定する場合は、ヘッダーファイルの検索パスを慎重に検討する必要があります。

例

set(CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES /usr/local/include)
set(CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES /usr/local/include/c++/)

この例では、C 言語のヘッダーファイルは /usr/local/include ディレクトリ、C++ 言語のヘッダーファイルは /usr/local/include/c++/ ディレクトリで検索されます。

CMake の CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES を使ったサンプルコード

set(CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES /usr/local/include)

add_executable(my_program
  main.c)

target_link_libraries(my_program
  stdc++
)

このコードは、/usr/local/include ディレクトリにあるヘッダーファイルを含む C 言語プログラム my_program をビルドします。

C++ 言語

set(CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES /usr/local/include/c++/)

add_executable(my_program
  main.cpp)

target_link_libraries(my_program
  stdc++
)

このコードは、/usr/local/include/c++/ ディレクトリにあるヘッダーファイルを含む C++ 言語プログラム my_program をビルドします。

複数のディレクトリ

set(CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES
  /usr/local/include
  /opt/include)

set(CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES
  /usr/local/include/c++/
  /opt/include/c++/)

add_executable(my_program
  main.c
  main.cpp)

target_link_libraries(my_program
  stdc++
)

このコードは、/usr/local/include と /opt/include ディレクトリにある C 言語のヘッダーファイル、 /usr/local/include/c++/ と /opt/include/c++/ ディレクトリにある C++ 言語のヘッダーファイルを含むプログラム my_program をビルドします。

サブディレクトリ

set(CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES
  ${CMAKE_SOURCE_DIR}/include)

set(CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES
  ${CMAKE_SOURCE_DIR}/include/c++/)

add_executable(my_program
  main.c
  main.cpp)

target_link_libraries(my_program
  stdc++
)

このコードは、プロジェクトソースディレクトリの include サブディレクトリにある C 言語のヘッダーファイルと、include/c++ サブディレクトリにある C++ 言語のヘッダーファイルを含むプログラム my_program をビルドします。

環境変数

set(CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES
  ${ENV{HOME}/include)

set(CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES
  ${ENV{HOME}/include/c++/)

add_executable(my_program
  main.c
  main.cpp)

target_link_libraries(my_program
  stdc++
)

このコードは、環境変数 HOME で指定されたディレクトリにある C 言語と C++ 言語のヘッダーファイルを含むプログラム my_program をビルドします。

補足

• これらのサンプルコードは、あくまでも参考です。
• 実際のプロジェクトでは、プロジェクトの構成に合わせて変数を設定する必要があります。

CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES 以外の方法

方法

• target_include_directories() コマンドを使う
  • このコマンドは、特定のターゲットに対してのみ、インクルードディレクトリを指定することができます。
  • 例：

add_executable(my_program
  main.c)

target_include_directories(my_program
  PRIVATE
    /usr/local/include)

target_link_libraries(my_program
  stdc++
)

• compile_options() コマンドを使う
  • このコマンドは、コンパイラオプションを指定することができます。

add_executable(my_program
  main.c)

target_compile_options(my_program
  PRIVATE
    -I/usr/local/include)

target_link_libraries(my_program
  stdc++
)

• include_directories() コマンドを使う
  • このコマンドは、プロジェクト全体のインクルードディレクトリを指定することができます。

include_directories(/usr/local/include)

add_executable(my_program
  main.c)

target_link_libraries(my_program
  stdc++
)

• CMAKE_MODULE_PATH 変数を設定する
  • この変数は、CMake モジュールを検索するパスを指定します。
  • CMake モジュールは、include_directories() コマンドなどの機能を提供することができます。

set(CMAKE_MODULE_PATH /usr/local/cmake/Modules)

add_executable(my_program
  main.c)

target_link_libraries(my_program
  stdc++
)

どの方法を使うべきかは、プロジェクトの構成や要件によって異なります。

• target_include_directories() コマンド: 特定のターゲットに対してのみ、インクルードディレクトリを指定したい場合
• compile_options() コマンド: コンパイラオプションを細かく制御したい場合
• include_directories() コマンド: プロジェクト全体のインクルードディレクトリを指定したい場合
• CMAKE_MODULE_PATH 変数: CMake モジュールを使って、インクルードディレクトリを指定したい場合