CMAKE_DISABLE_PRECOMPILE_HEADERS を使用したサンプルコード

CMake の CMAKE_DISABLE_PRECOMPILE_HEADERS 変数解説

CMAKE_DISABLE_PRECOMPILE_HEADERS は、CMake でプリコンパイルされたヘッダーファイルの生成を無効にするブール型の変数です。デフォルトでは OFF に設定されており、プロジェクト内のすべてのターゲットに対してプリコンパイルされたヘッダーファイルが生成されます。

設定方法

以下の方法で CMAKE_DISABLE_PRECOMPILE_HEADERS を設定できます。

• CMakeLists.txt ファイル

set(CMAKE_DISABLE_PRECOMPILE_HEADERS ON)

• コマンドライン

cmake -DCMAKE_DISABLE_PRECOMPILE_HEADERS=ON ..

影響

CMAKE_DISABLE_PRECOMPILE_HEADERS を ON に設定すると、以下の影響があります。

• プロジェクト内のすべてのターゲットに対して、プリコンパイルされたヘッダーファイルは生成されません。
• target_precompile_headers() コマンドで指定されたヘッダーファイルは、コンパイル時に直接インクルードされます。
• プリコンパイルされたヘッダーファイルを使用するコードは、コンパイルエラーになる可能性があります。

使用例

以下の例では、CMAKE_DISABLE_PRECOMPILE_HEADERS を ON に設定して、プロジェクト内のすべてのターゲットに対してプリコンパイルされたヘッダーファイルの生成を無効にしています。

set(CMAKE_DISABLE_PRECOMPILE_HEADERS ON)

add_executable(my_app main.cpp)

注意事項

• プリコンパイルされたヘッダーファイルを使用するコードをコンパイルする前に、CMAKE_DISABLE_PRECOMPILE_HEADERS の設定を確認する必要があります。
• CMAKE_DISABLE_PRECOMPILE_HEADERS を ON に設定すると、コンパイル時間が長くなる可能性があります。

補足

• CMAKE_DISABLE_PRECOMPILE_HEADERS は CMake 3.16 以降で利用可能です。
• 特定のターゲットに対してのみプリコンパイルされたヘッダーファイルを無効にするには、set_target_properties() コマンドを使用できます。

CMAKE_DISABLE_PRECOMPILE_HEADERS を使用したサンプルコード

サンプルコード 1: すべてのターゲットに対してプリコンパイルされたヘッダーファイルを無効にする

set(CMAKE_DISABLE_PRECOMPILE_HEADERS ON)

add_executable(my_app main.cpp)

# プリコンパイルされたヘッダーファイルを使用するコード
# ...

サンプルコード 2: 特定のターゲットに対してのみプリコンパイルされたヘッダーファイルを無効にする

add_executable(my_app main.cpp)

# ターゲット "my_app" に対してのみプリコンパイルされたヘッダーファイルを無効にする
set_target_properties(my_app PROPERTIES CMAKE_DISABLE_PRECOMPILE_HEADERS ON)

# プリコンパイルされたヘッダーファイルを使用するコード
# ...

サンプルコード 3: プリコンパイルされたヘッダーファイルの生成を無効にする条件を設定する

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
  set(CMAKE_DISABLE_PRECOMPILE_HEADERS ON)
endif()

add_executable(my_app main.cpp)

# プリコンパイルされたヘッダーファイルを使用するコード
# ...

CMAKE_DISABLE_PRECOMPILE_HEADERS 以外の方法

target_precompile_headers() コマンドを使用せずに、#include ディレクティブで直接ヘッダーファイルをインクルードすることができます。

add_executable(my_app main.cpp)

# 直接ヘッダーファイルをインクルードする
#include "my_header.h"

target_compile_options() コマンドを使用して、-Xpreprocessor オプションを指定することで、特定のターゲットに対してプリコンパイルされたヘッダーファイルの生成を無効にすることができます。

add_executable(my_app main.cpp)

# ターゲット "my_app" に対してのみプリコンパイルされたヘッダーファイルを無効にする
target_compile_options(my_app PRIVATE "-Xpreprocessor")

# プリコンパイルされたヘッダーファイルを使用するコード
# ...

プリコンパイルされたヘッダーファイルに依存しないコードを書くことで、プリコンパイルされたヘッダーファイルの生成を回避することができます。

以下は、それぞれの方法の利点と欠点です。

target_precompile_headers() コマンドを使用しない方法

利点

• シンプルで分かりやすい

欠点

• コードの可読性が低下する可能性がある

target_compile_options() コマンドを使用する方法

利点

• コードの可読性を維持できる

欠点

• CMake のバージョンによっては対応していない

プリコンパイルされたヘッダーファイルを使用しないコードを書く方法

利点

• 最も柔軟な方法

欠点

• コードの書き換えが必要になる

X 0 まとめ

• CMAKE_DISABLE_PRECOMPILE_HEADERS は、CMake でプリコンパイルされたヘッダーファイルの生成を無効にするブール型の変数です。
• CMAKE_DISABLE_PRECOMPILE_HEADERS を ON に設定すると、プロジェクト内のすべてのターゲットに対してプリコンパイルされたヘッダーファイルは生成されません。
• CMAKE_DISABLE_PRECOMPILE_HEADERS 以外にも、プリコンパイルされたヘッダーファイルの生成を制御する方法があります。
• どの方法を選択するかは、プロジェクトの状況によって異なります。