CMake: オプション設定ロジックを簡潔に記述する方法とは？CMakeDependentOptionモジュールが役立つ

CMakeDependentOption モジュールは、CMake のオプション設定機能を拡張するものです。このモジュールを使用すると、あるオプションの表示と設定を、他のオプションの状態に依存させることができます。これは、複雑なオプション設定ロジックを簡潔かつ柔軟に記述するのに役立ちます。

使用方法

CMakeDependentOption モジュールの基本的な使用方法は以下の通りです。

CMAKE_DEPENDENT_OPTION(<option_name> "<option_description>" <depends> <default_value>)

このマクロは以下の引数を取ります。

<default_value>: オプションのデフォルト値
<depends>: オプションを表示する条件をセミコロンで区切ったリスト
<option_description>: オプションの説明
<option_name>: オプションの名前

条件の指定

<depends> 引数には、オプションを表示する条件をセミコロンで区切って指定します。条件は以下のいずれかになります。

OR 複数の条件を論理和で結合
AND 複数の条件を論理積で結合
NOT オプション名: オプションが存在せず、または値が OFF である場合
オプション名: オプションが存在し、かつ値が ON である場合

オプションの表示と設定

<depends> で指定された条件が満たされる場合、<option_name> オプションがユーザーに表示されます。ユーザーはこのオプションに対して ON または OFF を設定できます。

デフォルト値の処理

<default_value> 引数に指定されたデフォルト値は、以下の場合に使用されます。

ユーザーが <option_name> オプションに対して明示的に値を設定していない場合
<depends> で指定された条件が満たされない場合

保存と再読み込み

CMakeDependentOption モジュールは、<option_name> オプションの値を保存し、CMake の再実行時に再読み込みすることができます。これにより、ユーザーが設定したオプション値が次回の CMake 実行時に保持されます。

例

以下の例は、USE_FOO オプションを USE_BAR オプションと NOT USE_ZOT オプションに依存させて設定する方法を示しています。

CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON "USE_BAR;NOT USE_ZOT" OFF)

この例では、USE_BAR オプションが ON であり、USE_ZOT オプションが OFF である場合のみ、USE_FOO オプションが表示されます。USE_FOO オプションのデフォルト値は OFF です。

利点

CMakeDependentOption モジュールを使用する利点は次のとおりです。

ユーザー設定を次回の CMake 実行時に保持できる
オプション設定を他のオプションの状態に依存させることができる
複雑なオプション設定ロジックを簡潔に記述できる

CMakeDependentOption モジュールは、CMake のオプション設定機能を拡張し、複雑なオプション設定ロジックを簡潔かつ柔軟に記述できるようにする便利なツールです。

例 1: オプションの表示と設定

cmake_minimum_required(VERSION 3.4.0)
project(myproject)

option(USE_FOO "Use Foo" OFF)

if(USE_FOO)
  message(STATUS "Using Foo")
else()
  message(STATUS "Not using Foo")
endif()

この例では、USE_FOO オプションはデフォルトで OFF に設定されています。ユーザーがこのオプションを ON に設定すると、Using Foo というメッセージが表示されます。

例 2: オプションの依存関係

以下の例は、USE_FOO オプションを USE_BAR オプションに依存させて設定する方法を示しています。

cmake_minimum_required(VERSION 3.4.0)
project(myproject)

option(USE_BAR "Use Bar" OFF)
CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON "USE_BAR" OFF)

if(USE_FOO)
  message(STATUS "Using Foo")
else()
  message(STATUS "Not using Foo")
endif()

この例では、USE_FOO オプションはデフォルトで OFF に設定されています。USE_BAR オプションが ON である場合のみ、USE_FOO オプションが表示されます。ユーザーがこのオプションを ON に設定すると、Using Foo というメッセージが表示されます。

以下の例は、USE_FOO オプションが ON である場合にのみ、FOO_LIB ライブラリをリンクする方法を示しています。

cmake_minimum_required(VERSION 3.4.0)
project(myproject)

option(USE_FOO "Use Foo" OFF)
CMAKE_DEPENDENT_OPTION(USE_FOO_LIB "Use Foo library" ON "USE_FOO" OFF)

if(USE_FOO_LIB)
  find_package(FOO_LIB REQUIRED)
  target_link_libraries(myproject FOO_LIB)
endif()

この例では、USE_FOO_LIB オプションはデフォルトで OFF に設定されています。USE_FOO オプションが ON である場合のみ、USE_FOO_LIB オプションが表示されます。ユーザーがこのオプションを ON に設定すると、FOO_LIB ライブラリが検索され、プロジェクトにリンクされます。

CMake の標準的なオプション機能

CMake には、option() マクロなどの標準的なオプション機能が用意されています。これらの機能を使用して、基本的なオプション設定ロジックを記述することができます。

カスタムモジュール

複雑なオプション設定ロジックを記述する必要がある場合は、カスタムモジュールを作成することができます。カスタムモジュールは、CMake の機能を拡張して、独自のオプション設定ロジックを実装することができます。

サードパーティ製モジュール

CMake には、オプション設定機能を拡張するサードパーティ製モジュールがいくつか用意されています。これらのモジュールを使用して、より高度な機能を利用することができます。

代替方法を選択する際の考慮事項

CMakeDependentOption の代替方法を選択する際には、以下の点を考慮する必要があります。

開発者の経験
必要な機能
オプション設定ロジックの複雑さ

具体的な代替方法

以下に、具体的な代替方法の例をいくつか紹介します。

オプション設定を他の CMake プロジェクトに再利用したい場合: カスタムモジュールを作成するか、サードパーティ製モジュールを使用します。
条件付きオプション設定が必要な場合: CMakeDependentOption モジュールを使用するか、カスタムモジュールを作成します。
複雑なオプション設定ロジックの場合: カスタムモジュールを作成するか、サードパーティ製モジュールを使用します。
シンプルなオプション設定ロジックの場合: CMake の標準的なオプション機能を使用します。

例

以下の例は、CMake の標準的なオプション機能を使用して、USE_FOO オプションをユーザーに表示し、設定できるようにする方法を示しています。

cmake_minimum_required(VERSION 3.4.0)
project(myproject)

option(USE_FOO "Use Foo" OFF)

if(USE_FOO)
  message(STATUS "Using Foo")
else()
  message(STATUS "Not using Foo")
endif()

この例は、CMakeDependentOption モジュールの代わりに CMake の標準的なオプション機能を使用する方法を示しています。