CMake: プロジェクト全体で一貫性を！add_compile_definitions() と CMAKE_CXX_FLAGS/CMAKE_C_FLAGS の賢い使い分け

add_compile_definitions() コマンドは、CMakeLists.txt ファイル内で、特定のターゲットに対してコンパイラフラグを定義する際に使用されます。これらのフラグは、プリプロセッサによって処理され、ソースコード内のマクロや定数を設定します。

構文

target_compile_definitions( <target> [PRIVATE | PUBLIC] [INTERFACE] <definition1> [<definition2> ...])

引数

<definition>: 1 つ以上のコンパイラフラグ。スペースで区切ります。
INTERFACE: 定義はターゲットと、そのターゲットに依存するターゲットで使用可能になります。
PRIVATE または PUBLIC:
- PRIVATE: 定義はターゲットのみで使用可能になります。
- PUBLIC: 定義はターゲットと、そのターゲットに依存するターゲットで使用可能になります。
<target>: コマンドの対象となるターゲット。ターゲットは、add_executable() や add_library() などのコマンドで作成されたものである必要があります。

例

target_compile_definitions(my_target PRIVATE DEBUG MY_VERSION=1.0)

この例では、my_target ターゲットに対して、以下のコンパイラフラグが設定されます。

-DMY_VERSION=1.0
-DDEBUG

利点

異なるコンパイラやプラットフォーム間でコードを移植しやすくなります。
ビルドシステムの複雑さを軽減できます。
特定のターゲットに対してのみフラグを定義できるため、コードの可読性と保守性が向上します。

フラグ名の前に -D を付ける必要はありません。CMake が自動的に追加します。
同じターゲットに対して複数の add_compile_definitions() コマンドを呼び出すと、フラグは追加されます。
add_compile_definitions() コマンドは、ターゲットが作成された後にのみ使用できます。

CMake は、クロスプラットフォームのビルドシステムを構築するための強力なツールです。上記の例は、add_compile_definitions() コマンドの基本的な使用方法を示すものです。詳細については、CMake の公式ドキュメントを参照してください。
add_compile_definitions() コマンド以外にも、CMake には add_definitions() コマンドがあります。このコマンドは、グローバルなコンパイラフラグを定義するために使用されます。

例 1: 特定のターゲットに対してのみフラグを定義する

cmake_minimum_required(VERSION 3.12)

project(myproject)

add_executable(myprogram main.cpp)

target_compile_definitions(myprogram PRIVATE DEBUG MY_VERSION=1.0)

この例では、myprogram ターゲットに対してのみ DEBUG と MY_VERSION=1.0 のフラグが設定されます。

例 2: 複数のフラグを定義する

cmake_minimum_required(VERSION 3.12)

project(myproject)

add_executable(myprogram main.cpp)

target_compile_definitions(myprogram PRIVATE DEBUG MY_VERSION=1.0 NDEBUG)

この例では、myprogram ターゲットに対して DEBUG、MY_VERSION=1.0、NDEBUG のフラグが設定されます。

例 3: PUBLIC フラグを使用して依存ターゲットにフラグを伝達する

cmake_minimum_required(VERSION 3.12)

project(myproject)

add_library(mylib mylib.cpp)
add_executable(myprogram main.cpp mylib)

target_compile_definitions(mylib PUBLIC MY_LIB_API)

この例では、mylib ライブラリに対して MY_LIB_API フラグが PUBLIC フラグを使用して設定されます。このフラグは、myprogram 実行可能ファイルにも伝達されます。

例 4: INTERFACE フラグを使用して依存ターゲットにフラグを伝達する

cmake_minimum_required(VERSION 3.12)

project(myproject)

add_library(mylib mylib.cpp)
add_executable(myprogram main.cpp mylib)

target_compile_definitions(mylib INTERFACE MY_LIB_API)

この例では、mylib ライブラリに対して MY_LIB_API フラグが INTERFACE フラグを使用して設定されます。このフラグは、myprogram 実行可能ファイルには伝達されませんが、mylib に依存する他のターゲットには伝達されます。

これらの例は、add_compile_definitions() コマンドの基本的な使用方法を示すものです。詳細については、CMake の公式ドキュメントを参照してください。

CMake には、add_compile_options() コマンドなど、コンパイラオプションを設定するための他のコマンドも用意されています。
上記の例は、Linux または macOS でコンパイルすることを想定しています。Windows でコンパイルする場合は、適切なフラグを追加する必要があります。

ターゲットプロパティの使用

CMake 3.12 以降では、ターゲットプロパティを使用してコンパイラフラグを定義することができます。この方法は、以下の点で add_compile_definitions コマンドよりも優れています。

キャッシュがより効率的に動作します。
読みやすく、メンテナンスしやすいコードになります。

target_compile_options(mytarget PRIVATE
  -DDEBUG
  -DMY_VERSION=1.0
)

利点

キャッシュのパフォーマンスが向上
コードがより明確で簡潔になる

欠点

CMake 3.12 より古いバージョンでは使用できない

CMAKE_CXX_FLAGS または CMAKE_C_FLAGS の使用

CMake 変数 CMAKE_CXX_FLAGS または CMAKE_C_FLAGS を使用して、すべてのターゲットに対してグローバルなコンパイラフラグを定義することができます。これは、特定のターゲットにのみ適用されるフラグを定義する場合には適切ではありませんが、プロジェクト全体で一貫したフラグセットを定義する場合には役立ちます。

set(CMAKE_CXX_FLAGS "-DDEBUG -DMY_VERSION=1.0")

利点

プロジェクト全体で一貫したフラグセットを簡単に定義できる

欠点

特定のターゲットにのみ適用されるフラグを定義するには不向き

ターゲットソースディレクトリ内のヘッダーファイルの使用

#define ディレクティブを含むヘッダーファイルをターゲットソースディレクトリに配置することで、コンパイラフラグを定義することができます。この方法は、単純なフラグを定義する場合に役立ちますが、複雑なフラグセットを定義する場合には適切ではありません。

// main.cpp を含むターゲットソースディレクトリに mydefs.h を配置する

#ifndef MY_VERSION
#define MY_VERSION 1.0
#endif

#ifndef DEBUG
#define DEBUG
#endif

利点

ヘッダーファイルを使用してフラグを定義することで、コードをコンパイルシステムから分離できる

欠点

コードが読みづらくなる可能性がある
複雑なフラグセットを定義するには不向き

カスタム CMake モジュールの使用

add_compile_definitions コマンドの代替機能を提供するカスタム CMake モジュールを作成することができます。これは、複雑なロジックに基づいてフラグを定義する場合や、コードを再利用したい場合に役立ちます。

利点

コードを再利用できる
複雑なロジックに基づいてフラグを定義できる

欠点

開発と保守の手間がかかる

方法	利点	欠点
ターゲットプロパティ	読みやすく、メンテナンスしやすいコード、キャッシュのパフォーマンス向上	CMake 3.12 より古いバージョンでは使用できない
CMAKE_CXX_FLAGS または CMAKE_C_FLAGS	プロジェクト全体で一貫したフラグセットを簡単に定義できる	特定のターゲットにのみ適用されるフラグを定義するには不向き
ターゲットソースディレクトリ内のヘッダーファイル	コードをコンパイルシステムから分離できる	複雑なフラグセットを定義するには不向き、コードが読みづらくなる可能性がある
カスタム CMake モジュール	複雑なロジックに基づいてフラグを定義できる、コードを再利用できる	開発と保守の手間がかかる