CMake: C/C++プロジェクトにおける「CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES」変数の詳細解説
"CMake_LANG_STANDARD_INCLUDE_DIRECTORIES" は、CMake における変数の一つで、特定のプログラミング言語（LANG）でコンパイルされるすべてのソースファイルに対して、システム標準のインクルードディレクトリを指定するために使用されます。これらのディレクトリには、C++ や C などの言語で標準的に使用されるヘッダーファイルが含まれています。
用途
この変数は、プロジェクトで使用されるプログラミング言語に対応した標準ヘッダーファイルを自動的にインクルードパスに追加するために使用されます。これにより、開発者は、各ソースファイルで個別にインクルードディレクトリを指定する必要がなくなり、コードの簡潔性と保守性を向上させることができます。
設定方法
"CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES" 変数は、CMake のプロジェクトファイル（CMakeLists.txt）内で設定することができます。具体的には、以下の形式で設定します。
set(CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES "<dir1> <dir2> ...")
上記の例では、<dir1>, <dir2>, ... は、システム標準のインクルードディレクトリへのパスを表す文字列です。これらのディレクトリは、スペースで区切って指定します。
注意事項
- 個々のソースファイルに対して異なるインクルードディレクトリを指定したい場合は、
target_include_directoriesプロパティを使用することができます。 - この変数の設定は、プロジェクトで使用されるすべてのソースファイルに対して適用されます。
- この変数は、プロジェクトコードではなく、CMake のプラットフォーム情報モジュールまたはツールチェーンファイルによって設定されるように設計されています。
- この変数は、CMake のバージョン 3.6 以降でのみ使用可能です。
例
以下の例は、C++ プロジェクトで "CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES" 変数を使用する方法を示しています。
cmake_minimum_required(VERSION 3.6)
project(myproject)
set(CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES "/usr/include /usr/local/include")
add_executable(myprogram main.cpp)
この例では、myproject という名前のプロジェクトが作成され、main.cpp というソースファイルを使用して myprogram という名前の実行可能ファイルがビルドされます。CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES 変数には、/usr/include と /usr/local/include という 2 つのシステム標準インクルードディレクトリが指定されています。これらのディレクトリには、C++ 標準ライブラリのヘッダーファイルが含まれているため、main.cpp ファイルでこれらのヘッダーファイルをインクルードする必要はありません。
cmake_minimum_required(VERSION 3.6)
project(myproject)
set(CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES "/usr/include /usr/local/include")
add_executable(myprogram main.cpp)
説明
このコードは、以下の操作を実行します。
- CMake のバージョン 3.6 以降を必要とします。
myprojectという名前のプロジェクトを作成します。/usr/includeと/usr/local/includeという 2 つのシステム標準インクルードディレクトリをCMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES変数に設定します。main.cppというソースファイルを使用してmyprogramという名前の実行可能ファイルを作成します。
C プロジェクト
cmake_minimum_required(VERSION 3.6)
project(myproject)
set(CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES "/usr/include")
add_executable(myprogram main.c)
説明
このコードは、C++ プロジェクトのコードとほぼ同様ですが、以下の点が異なります。
- これにより、
myprogram実行可能ファイルは C 言語でコンパイルされます。 add_executableコマンドの引数がmain.cppからmain.cに変更されています。
上記の例は、"CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES" 変数の基本的な使用方法を示しています。この変数は、さまざまな方法で使用することができます。以下に、いくつかの例を示します。
- デフォルトの標準インクルードディレクトリを無効にする。
- プロジェクト固有のインクルードディレクトリを指定する。
- 特定のコンパイラまたはプラットフォーム用の標準インクルードディレクトリを指定する。
個別のインクルードディレクトリを指定する
"target_include_directories" プロパティを使用することで、個々のソースファイルまたはターゲットに対してインクルードディレクトリを指定することができます。これは、プロジェクト内の特定のソースファイルにのみ標準ヘッダーファイルが必要な場合に役立ちます。
target_include_directories(myprogram PRIVATE "/usr/include/boost")
利点
- プロジェクト全体の標準ヘッダーファイル設定を変更する必要がありません。
- 特定のソースファイルまたはターゲットにのみ標準ヘッダーファイルを限定することができます。
欠点
- プロジェクト全体で一貫性を保つのが難しい場合があります。
- すべての必要なインクルードディレクトリを個別に指定する必要があるため、煩雑になる可能性があります。
"find_package" モジュールを使用する
"find_package" モジュールを使用することで、特定のライブラリまたはフレームワークに必要なインクルードディレクトリを自動的に検出することができます。これは、Boost や Qt などの一般的なライブラリを使用している場合に役立ちます。
find_package(Boost REQUIRED COMPONENTS system)
利点
- 個別にインクルードディレクトリを指定する必要がありません。
- ライブラリに必要なインクルードディレクトリを自動的に検出することができます。
欠点
- プロジェクト全体の標準ヘッダーファイル設定を変更する必要はありません。
- すべてのライブラリに対して "find_package" モジュールが利用可能とは限らない。
カスタムインクルードパスを設定する
"CMAKE_INCLUDE_PATH" 変数を使用することで、プロジェクト全体のインクルードパスを設定することができます。これは、すべてのソースファイルで共通の標準ヘッダーファイルが必要な場合に役立ちます。
set(CMAKE_INCLUDE_PATH "/usr/include/boost /usr/local/include")
利点
- 個別にインクルードディレクトリを指定する必要がありません。
- プロジェクト全体のすべてのソースファイルに対して標準ヘッダーファイルを指定することができます。
欠点
- "CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES" 変数よりも柔軟性に欠けます。
- プロジェクトで使用されないヘッダーファイルも含めてしまう可能性があるため、注意が必要です。
CMakeLists.txt ファイルを直接編集する
最後の手段として、CMakeLists.txt ファイルを直接編集して、必要なインクルードディレクトリを #include ディレクティブに追加することができます。これは、他の方法がうまくいかない場合にのみ使用することをお勧めします。
add_executable(myprogram main.cpp)
target_sources(myprogram PRIVATE main.cpp)
target_include_directories(myprogram PRIVATE "/usr/include/boost")
利点
- 他の方法では不可能なレベルのカスタマイズが可能になります。
欠点
- プロジェクトの保守性が低下する。
- 複雑でエラーが発生しやすい。
"CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES" 変数は、多くの場合、プロジェクトで使用されるプログラミング言語に対応した標準ヘッダーファイルを自動的にインクルードパスに追加するための便利な方法です。しかし、上記で紹介した代替方法も、状況によっては有効な選択肢となります。