CMake: インポートターゲットのヘッダーファイルをシステムヘッダーファイルとして認識させない - CMAKE_NO_SYSTEM_FROM_IMPORTED徹底解説

CMAKE_NO_SYSTEM_FROM_IMPORTED は、CMake のターゲットプロパティ NO_SYSTEM_FROM_IMPORTED の初期値を設定する変数です。このプロパティは、インポートされたターゲット（つまり、プロジェクト内でビルドされていない外部ライブラリなど）のヘッダーファイルを、システムヘッダーファイルと見なすかどうかを制御します。

デフォルト値

CMAKE_NO_SYSTEM_FROM_IMPORTED のデフォルト値は NO です。つまり、インポートされたターゲットのヘッダーファイルは、デフォルトではシステムヘッダーファイルとして扱われます。

使用方法

CMAKE_NO_SYSTEM_FROM_IMPORTED を設定するには、以下のコマンドを使用します。

set(CMAKE_NO_SYSTEM_FROM_IMPORTED YES)

このコマンドを実行すると、すべてのインポートされたターゲットの NO_SYSTEM_FROM_IMPORTED プロパティが YES に設定されます。

効果

CMAKE_NO_SYSTEM_FROM_IMPORTED を YES に設定すると、以下の効果があります。

これは、インポートされたターゲットのヘッダーファイルが、システムヘッダーファイルと異なる場所にインストールされている場合に役立ちます。
これにより、コンパイラは、インポートされたターゲットのヘッダーファイルを検索する際に、システムヘッダー検索パスを使用しなくなります。
インポートされたターゲットのヘッダーファイルは、システムヘッダーファイルとして扱われなくなります。

例

以下の例は、CMAKE_NO_SYSTEM_FROM_IMPORTED を使用して、インポートされたターゲット MyImportedTarget のヘッダーファイルをシステムヘッダーファイルとして扱わないようにする方法を示しています。

# インポートされたターゲット `MyImportedTarget` を検索します。
find_package(MyImportedTarget REQUIRED)

# `MyImportedTarget` の `NO_SYSTEM_FROM_IMPORTED` プロパティを `YES` に設定します。
set_property(TARGET MyImportedTarget PROPERTY NO_SYSTEM_FROM_IMPORTED YES)

インポートされたターゲットのヘッダーファイルの場所がわかっている場合は、include_directories コマンドを使用して、その場所を明示的に指定することをお勧めします。
CMAKE_NO_SYSTEM_FROM_IMPORTED を設定すると、インポートされたターゲットのヘッダーファイルがシステムヘッダーファイルとして扱われなくなるため、コンパイラがこれらのヘッダーファイルを正しく検索できない可能性があります。

この変数は、主に古いプラットフォームや、非標準的な場所にインストールされたライブラリを使用している場合に役立ちます。
CMAKE_NO_SYSTEM_FROM_IMPORTED は、CMake 3.30 以降で使用できます。

例 1: インポートされたターゲットのヘッダーファイルをシステムヘッダーファイルとして扱わない

# インポートされたターゲット `MyImportedTarget` を検索します。
find_package(MyImportedTarget REQUIRED)

# `MyImportedTarget` の `NO_SYSTEM_FROM_IMPORTED` プロパティを `YES` に設定します。
set_property(TARGET MyImportedTarget PROPERTY NO_SYSTEM_FROM_IMPORTED YES)

# ターゲット `MyTarget` をビルドします。
add_executable(MyTarget main.cpp)
target_link_libraries(MyTarget MyImportedTarget)

この例では、MyImportedTarget という名前のインポートされたターゲットが検索されます。その後、MyImportedTarget の NO_SYSTEM_FROM_IMPORTED プロパティが YES に設定されます。これは、MyImportedTarget のヘッダーファイルがシステムヘッダーファイルとして扱われなくなることを意味します。

次に、MyTarget という名前のターゲットがビルドされます。このターゲットは、MyImportedTarget にリンクされます。MyImportedTarget のヘッダーファイルはシステムヘッダーファイルとして扱われなくなったため、コンパイラはこれらのヘッダーファイルを検索する際に、システムヘッダー検索パスを使用しません。

例 2: インポートされたターゲットのヘッダーファイルの場所を明示的に指定

# インポートされたターゲット `MyImportedTarget` を検索します。
find_package(MyImportedTarget REQUIRED)

# `MyImportedTarget` のヘッダーファイルの場所を指定します。
set(MyImportedTarget_INCLUDE_DIR "/path/to/MyImportedTarget/include")

# ターゲット `MyTarget` をビルドします。
add_executable(MyTarget main.cpp)
target_include_directories(MyTarget PRIVATE ${MyImportedTarget_INCLUDE_DIR})
target_link_libraries(MyTarget MyImportedTarget)

この例では、MyImportedTarget という名前のインポートされたターゲットが検索されます。その後、MyImportedTarget のヘッダーファイルの場所が /path/to/MyImportedTarget/include に設定されます。

次に、MyTarget という名前のターゲットがビルドされます。このターゲットは、MyImportedTarget にリンクされます。MyImportedTarget のヘッダーファイルの場所が明示的に指定されているため、コンパイラはこれらのヘッダーファイルを検索する際に、システムヘッダー検索パスを使用しません。

これらの例は、CMAKE_NO_SYSTEM_FROM_IMPORTED 変数の基本的な使用方法を示しています。実際の使用方法は、プロジェクトの要件によって異なります。

target_include_directories コマンドを使用する

target_include_directories コマンドは、ターゲットが使用するヘッダーファイルの場所を明示的に指定するために使用できます。この方法は、インポートされたターゲットのヘッダーファイルの場所がわかっている場合に有効です。

例

# インポートされたターゲット `MyImportedTarget` を検索します。
find_package(MyImportedTarget REQUIRED)

# `MyImportedTarget` のヘッダーファイルの場所を指定します。
set(MyImportedTarget_INCLUDE_DIR "/path/to/MyImportedTarget/include")

# ターゲット `MyTarget` をビルドします。
add_executable(MyTarget main.cpp)
target_include_directories(MyTarget PRIVATE ${MyImportedTarget_INCLUDE_DIR})
target_link_libraries(MyTarget MyImportedTarget)

この例では、MyImportedTarget のヘッダーファイルの場所が /path/to/MyImportedTarget/include に設定されています。target_include_directories コマンドを使用して、この場所を MyTarget ターゲットに渡します。

インストール済みヘッダーファイルを使用する

多くの場合、インポートされたターゲットは、インストール時にヘッダーファイルをシステムヘッダーディレクトリにコピーします。この場合、CMAKE_NO_SYSTEM_FROM_IMPORTED 変数は必要ありません。

カスタム検索パスを使用する

CMAKE_MODULE_PATH 変数を使用して、カスタム検索パスを設定できます。この方法は、インポートされたターゲットのヘッダーファイルの場所がわかっている場合に有効です。

例

# カスタム検索パスを指定します。
set(CMAKE_MODULE_PATH "/path/to/custom/modules")

# インポートされたターゲット `MyImportedTarget` を検索します。
find_package(MyImportedTarget REQUIRED)

# ターゲット `MyTarget` をビルドします。
add_executable(MyTarget main.cpp)
target_link_libraries(MyTarget MyImportedTarget)

この例では、/path/to/custom/modules ディレクトリがカスタム検索パスとして設定されています。find_package コマンドは、このディレクトリで MyImportedTarget モジュールを検索します。

CMakeLists.txt ファイルを編集する

インポートされたターゲットの CMakeLists.txt ファイルを編集して、ヘッダーファイルの場所を明示的に指定することもできます。この方法は、インポートされたターゲットのソースコードにアクセスできる場合にのみ有効です。

注意事項

上記の方法を使用する場合は、以下の点に注意してください。

CMakeLists.txt ファイルを編集する場合は、元のファイルのバックアップを取っておいてください。
カスタム検索パスを使用する場合は、そのパスがすべてのコンパイラで認識されることを確認してください。
インポートされたターゲットのヘッダーファイルの場所がわかっていることを確認してください。
使用する方法は、プロジェクトの要件によって異なります。

CMAKE_NO_SYSTEM_FROM_IMPORTED 変数は、インポートされたターゲットのヘッダーファイルをシステムヘッダーファイルとして扱わないようにするための便利なツールですが、状況によっては代替方法の方が適している場合があります。

CMake: ビルドプロセスをもっと自由に！「CMAKE_PROJECT_INCLUDE」でカスタムコードを挿入する方法

"CMAKE_PROJECT_INCLUDE" は、CMake の "project()" コマンドで呼び出されるすべてのプロジェクトの最後に CMake 言語ファイルまたはモジュールをインクルードするために使用される変数です。これは、ソースコードを変更することなく、プロジェクトのビルドにカスタムコードを挿入するために役立ちます。

メジャーバージョンアップをスマートに！CMakeで`CMAKE_PROJECT_VERSION_MAJOR`変数を使いこなす

CMAKE_PROJECT_VERSION_MAJORは、CMakeプロジェクトのバージョン情報の一部を構成する変数です。具体的には、プロジェクトのメジャーバージョンを表します。バージョン番号の構成CMakeプロジェクトのバージョン情報は、以下の3つのコンポーネントで構成されます。

CMakeで実行可能ファイルの出力ディレクトリを自在に操る！ CMAKE_RUNTIME_OUTPUT_DIRECTORY徹底解説

CMAKE_RUNTIME_OUTPUT_DIRECTORYは、CMakeプロジェクトにおける実行可能ファイルの出力ディレクトリを指定するための変数です。この変数を使用することで、ビルドされた実行可能ファイルが配置される場所を制御することができます。

CMake: サブディレクトリ内のCMakeLists.txtファイルを正しく実行する

用途現在実行されている CMake スクリプトファイルの場所を特定するスクリプト内の相対パスを処理するスクリプト固有の設定や情報をロードする現在実行されている CMake スクリプトファイルの場所を特定するスクリプト内の相対パスを処理するスクリプト固有の設定や情報をロードする

CMakeの`set_target_properties`コマンド：ターゲット固有のリンカフラグ設定

CMake 変数 CMAKE_SHARED_LINKER_FLAGS は、共有ライブラリを作成する際に使用するリンカフラグを指定するために使用されます。これらのフラグは、リンカが共有ライブラリを生成する際に渡されます。用途CMAKE_SHARED_LINKER_FLAGS は、以下の用途に使用できます。

CMake: 共有ライブラリのリンカフラグ設定のすべてがわかる！「CMAKE_SHARED_LINKER_FLAGS_CONFIG_INIT」の公式ドキュメントを日本語で解説

"CMAKE_SHARED_LINKER_FLAGS_CONFIG_INIT" は、CMake の変数の一つであり、共有ライブラリのリンカフラグを構成するための初期値を設定するために使用されます。この変数は、CMake 3.7 以降で導入されました。

CMake: 静的ライブラリのリンカフラグ設定をもっと簡単に！CMAKE_STATIC_LINKER_FLAGSの便利な使い方

CMake 変数 CMAKE_STATIC_LINKER_FLAGS は、静的ライブラリを生成する際にアーカイバに渡されるリンカフラグを設定するために使用されます。これらのフラグは、ライブラリのビルド方法や動作を制御するために使用できます。

CMake: 奥深い設定を攻略！ "CMAKE_SYSROOT_COMPILE"と"CMAKE_FIND_ROOT_PATH"の賢い使い分け

CMAKE_SYSROOT_COMPILEは、CMakeにおける重要な変数の1つであり、クロスコンパイル環境においてソースコードのコンパイル時に使用されるシステムルートディレクトリを指定するために用いられます。用途クロスコンパイルとは、異なるアーキテクチャやオペレーティングシステム向けにプログラムを生成するコンパイル手法です。CMAKE_SYSROOT_COMPILE変数は、このクロスコンパイルにおいて、コンパイラがヘッダーファイルやライブラリを検索する際に参照すべきディレクトリを指定することで、適切なファイルを見つけられるようにします。

CMake: Boost ライブラリ探しを簡単にする - CMAKE_SYSTEM_PREFIX_PATH と CMAKE_PREFIX_PATH の使い分け

プロジェクト自体では変更しないようになっています。代わりに、CMAKE_PREFIX_PATH 変数を使用してください。環境変数に基づいて値が自動的に設定されます。CMAKE_INSTALL_PREFIX と CMAKE_STAGING_PREFIX で指定されたパスも含まれます。

CMake: 変数「CMAKE_TLS_VERIFY」でHTTPS通信のセキュリティを強化！ダウンロードとアップロードを安全に

CMAKE_TLS_VERIFY は、CMake の環境変数であり、file(DOWNLOAD) と file(UPLOAD) コマンドの TLS_VERIFY オプションのデフォルト値を指定します。この変数が設定されていない場合は、CMAKE_TLS_VERIFY 環境変数がチェックされます。どちらも設定されていない場合は、デフォルトは OFF となります。