CMakeにおける CMAKE_TRY_COMPILE_PLATFORM_VARIABLES 変数のサンプルコード

CMakeにおけるCMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数の詳細解説

概要

• バージョン: 3.6で導入
• 目的: try_compileコマンドで生成されるテストプロジェクトに、プラットフォーム固有の変数を伝達する
• 設定方法:
  • CMakeのプラットフォーム情報モジュールによって設定される
  • ツールチェーンファイルでCMAKE_TOOLCHAIN_FILEと併用して設定可能
• 注意点:
  • プロジェクトコードで設定すべきではない
  • CMakeが自動的に伝達する変数（例：CMAKE_<LANG>_FLAGS）は、この変数で指定する必要はない

詳細解説

1 動作原理

try_compileコマンドは、ソースコードのコンパイルが成功するかどうかをテストするために使用されます。このコマンドは、テストプロジェクトを生成し、そのプロジェクトでソースコードをコンパイルします。

テストプロジェクトは、ホストプロジェクトと同じプラットフォームをターゲットにする必要があります。そのためには、テストプロジェクトにホストプロジェクトと同じプラットフォーム固有の変数を伝達する必要があります。

CMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数は、この伝達のために使用されます。この変数には、テストプロジェクトに伝達する必要がある変名のリストが指定されます。

2 設定方法

CMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数は、以下の2つの方法で設定できます。

CMakeには、各プラットフォーム固有の情報提供モジュールが用意されています。これらのモジュールは、CMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数を自動的に設定します。

例えば、Windowsプラットフォームの場合、FindWindows.cmakeモジュールがCMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数を以下のように設定します。

set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES
  CMAKE_SYSTEM_NAME
  CMAKE_SYSTEM_VERSION
  CMAKE_SYSTEM_PROCESSOR
  )

1. ツールチェーンファイルによる設定

CMAKE_TOOLCHAIN_FILEオプションを使用してツールチェーンファイルを使用している場合、CMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数をツールチェーンファイルで設定することができます。

例えば、以下のように設定できます。

set(CMAKE_SYSTEM_NAME ...)
set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES
  MY_CUSTOM_VARIABLE
  )

この場合、-DMY_CUSTOM_VARIABLE=SomeValueというオプションをCMakeに渡すと、MY_CUSTOM_VARIABLE変数は、ホストプロジェクトとtry_compileコマンドによって生成されるテストプロジェクトの両方に設定されます。

3 使用例

CMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数は、様々な状況で使用できます。

• 特定のプラットフォームに依存するコンパイラオプションをテストプロジェクトに伝達する場合
• 特定のプラットフォームに依存するヘッダーファイルの場所をテストプロジェクトに伝達する場合

補足

• CMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数は、CMake 3.6以降で使用できます。
• この変数は、主にツールチェーンファイルで使用されます。
• この変数は、テストプロジェクトのコンパイルを成功させるために必要な変数を伝達するために使用できます。

その他

• ご不明な点があれば、お気軽にご質問ください。

CMakeにおけるCMAKE_TRY_COMPILE_PLATFORM_VARIABLES変数のサンプルコード

特定のプラットフォームに依存するコンパイラオプションをテストプロジェクトに伝達する

# ホストプラットフォームがWindowsの場合
if(CMAKE_SYSTEM_NAME MATCHES Windows)
  set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES
    CMAKE_CXX_FLAGS_DEBUG "/MTd"
    )
endif()

# テストコード
try_compile(
  SOURCE_CODE main.cpp
  )

特定のプラットフォームに依存するヘッダーファイルの場所をテストプロジェクトに伝達する

# ホストプラットフォームがLinuxの場合
if(CMAKE_SYSTEM_NAME MATCHES Linux)
  set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES
    CMAKE_INCLUDE_PATH "/usr/include/my-custom-library"
    )
endif()

# テストコード
try_compile(
  SOURCE_CODE main.cpp
  )

特定のプラットフォームに依存するライブラリの場所をテストプロジェクトに伝達する

# ホストプラットフォームがMacの場合
if(CMAKE_SYSTEM_NAME MATCHES Darwin)
  set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES
    CMAKE_LIBRARY_PATH "/usr/local/lib"
    )
endif()

# テストコード
try_compile(
  SOURCE_CODE main.cpp
  LINK_LIBRARIES "my-custom-library"
  )

ツールチェーンファイルでの設定

# ツールチェーンファイル

set(CMAKE_SYSTEM_NAME ...)

# 特定のプラットフォームに依存する変数を設定
if(CMAKE_SYSTEM_NAME MATCHES Windows)
  set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES
    CMAKE_CXX_FLAGS_DEBUG "/MTd"
    )
endif()

# 他のプラットフォームの設定

補足

改善点

• サンプルコードを追加
• 各サンプルコードについて、詳細な説明を追加
• ツールチェーンファイルでの設定例を追加
• 補足事項を追加

CMakeでテストプロジェクトにプラットフォーム固有の変数を伝達する他の方法

CMAKE_CXX_FLAGSなどの変数を直接設定することで、テストプロジェクトにコンパイラオプションを伝達することができます。

# ホストプラットフォームがWindowsの場合
if(CMAKE_SYSTEM_NAME MATCHES Windows)
  set(CMAKE_CXX_FLAGS "/MTd")
endif()

# テストコード
try_compile(
  SOURCE_CODE main.cpp
  )

この方法は、単純で分かりやすいですが、複数の変数を設定する場合は冗長になります。

add_compile_optionsコマンドを使用して、テストプロジェクトにコンパイラオプションを伝達することができます。

# ホストプラットフォームがWindowsの場合
if(CMAKE_SYSTEM_NAME MATCHES Windows)
  add_compile_options("/MTd")
endif()

# テストコード
try_compile(
  SOURCE_CODE main.cpp
  )

この方法は、CMAKE_CXX_FLAGSなどの変数を直接設定するよりも簡潔に記述できます。

カスタムのターゲットプロパティを使用して、テストプロジェクトにプラットフォーム固有の変数を伝達することができます。

# テストプロジェクト用のターゲットを作成
set(TEST_PROJECT_NAME "MyTestProject")
add_executable(${TEST_PROJECT_NAME} main.cpp)

# ホストプラットフォームがWindowsの場合
if(CMAKE_SYSTEM_NAME MATCHES Windows)
  set_target_properties(${TEST_PROJECT_NAME} PROPERTIES
    COMPILE_FLAGS "/MTd"
    )
endif()

# テストコード
try_compile(
  SOURCE_CODE main.cpp
  )

この方法は、最も柔軟な方法ですが、最も複雑でもあります。

• 1つの変数を設定する場合は、CMAKE_CXX_FLAGSなどの変数を直接設定するのが最も簡単です。
• 複数の変数を設定する場合は、add_compile_optionsコマンドを使用するのが簡潔です。
• 複雑な設定が必要な場合は、カスタムのターゲットプロパティを使用するのが最