CMakeでプリプロセッサー定義値を安全に扱う：CMP0005ポリシーの徹底解説

CMakeポリシー CMP0005: プリプロセッサー定義値のエスケープについて

CMake ポリシー CMP0005 は、add_definitions コマンドで追加されたプリプロセッサー定義値のエスケープ処理を制御します。これは、CMake バージョン 2.6 で導入された比較的新しいポリシーです。

背景

CMake バージョン 2.4 以前では、add_definitions で渡されるマクロの値は単純なものだけだと想定されていました。しかし、実際には文字列リテラルなど、エスケープが必要な複雑な値も渡されることがあります。

新しい動作 (NEW)

CMake バージョン 2.6 以降では、デフォルトで CMP0005 ポリシーが有効になり、add_definitions で渡されたすべての値が自動的にエスケープされます。これにより、ほとんどのネイティブビルドツールで正しいプリプロセッサー定義が生成されます。

古い動作 (OLD)

CMP0005 ポリシーが無効の場合、CMake は古い動作になり、エスケープ処理を行いません。これは、CMake バージョン 2.4 以前の動作と同じです。

設定方法

CMP0005 ポリシーは、cmake_policy() または cmake_minimum_required() コマンドで設定できます。

# CMake バージョン 3.0 以降
cmake_policy(CMP0005 NEW)

# CMake バージョン 2.6 から 2.8 まで
cmake_minimum_required(VERSION 2.6)
cmake_policy(CMP0005 NEW)

注意事項

• エスケープ処理にはいくつかの制限があります。詳細は、COMPILE_DEFINITIONS ターゲットプロパティのドキュメントを参照してください。
• 古い CMake バージョンとの互換性を維持したい場合は、CMP0005 ポリシーを無効にすることができます。ただし、この場合、ビルドが正しく動作しない可能性があります。

例

# プリプロセッサー定義 "FOO" に文字列リテラル "bar" を追加します。
add_definitions(-DFOO="bar")

# CMP0005 ポリシーが有効の場合、"bar" は自動的にエスケープされ、"\""bar\"" となります。

補足

• 上記の説明は、分かりやすくするために簡略化されています。詳細については、上記の参考資料を参照してください。
• 特定の状況で CMP0005 ポリシーを使用するかどうかについて疑問がある場合は、CMake コミュニティに質問することをお勧めします。

CMake ポリシー CMP0005 のサンプルコード

# CMake バージョン 3.0 以降
cmake_policy(CMP0005 NEW)

add_definitions(-DFOO="bar")

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: "bar"

説明:

• このサンプルコードでは、CMP0005 ポリシーが有効に設定されています。
• add_definitions コマンドを使用して、プリプロセッサー定義 "FOO" に文字列リテラル "bar" を追加します。
• message コマンドを使用して、FOO マクロの値を出力します。

# CMake バージョン 2.6 から 2.8 まで
cmake_minimum_required(VERSION 2.6)
cmake_policy(CMP0005 NEW)

add_definitions(-DFOO="bar")

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: bar

説明:

• このサンプルコードでは、CMake バージョン 2.6 から 2.8 を想定しています。
• CMP0005 ポリシーが有効に設定されています。

# CMake バージョン 2.4 以前
cmake_minimum_required(VERSION 2.4)

add_definitions(-DFOO="bar")

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: bar

説明:

• CMP0005 ポリシーは無効です。

# CMake バージョン 3.0 以降
cmake_policy(CMP0005 OLD)

add_definitions(-DFOO="bar")

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: bar

これらのサンプルコードは、CMake ポリシー CMP0005 の動作を理解するのに役立ちます。

CMake ポリシー CMP0005 の代替方法

手動でエスケープ処理を行う

CMP0005 ポリシーを無効にする場合は、add_definitions コマンドで渡されるマクロの値を手動でエスケープする必要があります。

# CMake バージョン 2.4 以前
cmake_minimum_required(VERSION 2.4)

add_definitions(-DFOO=\"bar\")

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: "bar"

説明:

• このサンプルコードでは、CMP0005 ポリシーが無効です。
• マクロの値 "bar" は、二重引用符で囲むことで手動でエスケープされています。

STRING() マクロを使用して、エスケープされたマクロの値を生成することができます。

# CMake バージョン 2.4 以降
cmake_minimum_required(VERSION 2.4)

add_definitions(-DFOO=$(STRING bar))

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: "bar"

説明:

• このサンプルコードでは、STRING() マクロを使用して、エスケープされたマクロの値 "bar" を生成しています。

プリプロセッサーを使用して、マクロの値をエスケープすることができます。

# CMake バージョン 2.4 以降
cmake_minimum_required(VERSION 2.4)

add_definitions(-DFOO=\\"bar\\")

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: "bar"

説明:

• このサンプルコードでは、プリプロセッサーを使用して、マクロの値 "bar" をエスケープしています。

外部ツールを使用する

エスケープ処理を行う外部ツールを使用することができます。

# CMake バージョン 2.4 以降
cmake_minimum_required(VERSION 2.4)

# 外部ツール "escape" を使用する

add_custom_command(
  OUTPUT escaped_value
  COMMAND escape bar
  VERBATIM
)

add_definitions(-DFOO=${escaped_value})

message(STATUS "FOO is defined as: ${FOO}")

出力:

FOO is defined as: "bar"

説明:

• このサンプルコードでは、外部ツール "escape" を使用して、マクロの値 "bar" をエスケープしています。

注意事項

• 手動でエスケープ処理を行う場合は、誤りが発生しやすいので注意が必要です。
• STRING() マクロを使用する方法は、比較的安全で簡単です。
• プリプロセッサーを使用する方法は、複雑なエスケープ処理を行う場合に役立ちます。
• 外部ツールを使用する方法は、柔軟性がありますが、設定が複雑になる場合があります。