CMake の CMAKE_AUTOMOC_RELAXED_MODE をマスターしよう！ 使い方と代替方法を詳しく解説

CMAKE_AUTOMOC_RELAXED_MODE は、CMake の AUTOMOC ターゲットプロパティの動作を制御する変数です。この変数は、Qt のメタオブジェクトコンパイラ（MOC）である automoc ツールの動作を決定します。

バージョン

この変数は CMake 3.15 で導入され、3.22 で廃止されました。

デフォルト値

デフォルトでは、AUTOMOC はドキュメントに記載されているとおりに動作します。

使用方法

CMAKE_AUTOMOC_RELAXED_MODE を TRUE に設定すると、automoc はより寛容なモードで動作します。具体的には、以下のようになります。

• マクロの再定義を許可する
• 名前空間のエイリアスを許可する
• ヘッダーファイル内のコメントを解析する

これらの機能は、Qt コードの開発を容易にすることができますが、潜在的な問題を引き起こす可能性もあります。

例

cmake_minimum_required(VERSION 3.15)

project(myproject)

set(CMAKE_AUTOMOC_RELAXED_MODE TRUE)

add_executable(myprogram myprogram.cpp)

上記の例では、CMAKE_AUTOMOC_RELAXED_MODE を TRUE に設定することで、automoc がより寛容なモードで動作するようにしています。

廃止

CMAKE_AUTOMOC_RELAXED_MODE は CMake 3.22 で廃止されました。代わりに、AUTOMOC_FLAG_INCLUDE_DIRECTORIES と AUTOMOC_FLAG_USE_NAMESPACE などの新しい変数が導入されました。

• AUTOMOC_FLAG_PREPROCESSOR_DEFINES: マクロの再定義を許可するかどうかを制御します。
• AUTOMOC_FLAG_USE_NAMESPACE: 名前空間のエイリアスを許可するかどうかを制御します。
• AUTOMOC_FLAG_INCLUDE_DIRECTORIES: ヘッダーファイル内のコメントを解析するかどうかを制御します。

---

cmake_minimum_required(VERSION 3.15)

project(myproject)

set(CMAKE_AUTOMOC_RELAXED_MODE TRUE)
set(AUTOMOC_FLAG_INCLUDE_DIRECTORIES TRUE)

add_executable(myprogram myprogram.cpp)

この例では、CMAKE_AUTOMOC_RELAXED_MODE を TRUE に設定し、AUTOMOC_FLAG_INCLUDE_DIRECTORIES を TRUE に設定することで、automoc がヘッダーファイル内のコメントを解析するようにしています。

例 2: 名前空間のエイリアスを許可する

cmake_minimum_required(VERSION 3.15)

project(myproject)

set(CMAKE_AUTOMOC_RELAXED_MODE TRUE)
set(AUTOMOC_FLAG_USE_NAMESPACE TRUE)

add_executable(myprogram myprogram.cpp)

この例では、CMAKE_AUTOMOC_RELAXED_MODE を TRUE に設定し、AUTOMOC_FLAG_USE_NAMESPACE を TRUE に設定することで、automoc が名前空間のエイリアスを許可するようにしています。

例 3: マクロの再定義を許可する

cmake_minimum_required(VERSION 3.15)

project(myproject)

set(CMAKE_AUTOMOC_RELAXED_MODE TRUE)
set(AUTOMOC_FLAG_PREPROCESSOR_DEFINES TRUE)

add_executable(myprogram myprogram.cpp)

この例では、CMAKE_AUTOMOC_RELAXED_MODE を TRUE に設定し、AUTOMOC_FLAG_PREPROCESSOR_DEFINES を TRUE に設定することで、automoc がマクロの再定義を許可するようにしています。

---

個別のフラグを使用する

• AUTOMOC_FLAG_PREPROCESSOR_DEFINES: マクロの再定義を許可するかどうかを制御します。
• AUTOMOC_FLAG_USE_NAMESPACE: 名前空間のエイリアスを許可するかどうかを制御します。
• AUTOMOC_FLAG_INCLUDE_DIRECTORIES: ヘッダーファイル内のコメントを解析するかどうかを制御します。

これらのフラグを個別に設定することで、CMAKE_AUTOMOC_RELAXED_MODE と同等の機能を実現できます。

例

cmake_minimum_required(VERSION 3.15)

project(myproject)

set(AUTOMOC_FLAG_INCLUDE_DIRECTORIES TRUE)
set(AUTOMOC_FLAG_USE_NAMESPACE TRUE)
set(AUTOMOC_FLAG_PREPROCESSOR_DEFINES TRUE)

add_executable(myprogram myprogram.cpp)

CMakeLists.txt ファイルを直接編集する

CMAKE_AUTOMOC_RELAXED_MODE は、AUTOMOC ターゲットプロパティに RELAXED_MODE オプションを設定することで設定できます。このオプションは CMake 3.22 以降でも使用できます。

例

cmake_minimum_required(VERSION 3.15)

project(myproject)

add_executable(myprogram myprogram.cpp)

target_properties(myprogram PROPERTIES AUTOMOC_RELAXED_MODE TRUE)

Qt Creator を使用する

Qt Creator は、CMake プロジェクトを開発するための IDE です。Qt Creator では、AUTOMOC ツールのオプションを GUI で設定できます。

手順

1. Qt Creator で CMake プロジェクトを開きます。
2. プロジェクトツリーで、AUTOMOC ターゲットを選択します。
3. 右側のインスペクターパネルで、AUTOMOC カテゴリを選択します。
4. Include Preprocessor Directives チェックボックスをオンにします。
5. Use Namespaces チェックボックスをオンにします。
6. Allow Macro Redefinitions チェックボックスをオンにします。

• 古いバージョンの CMake を使用している場合は、CMAKE_AUTOMOC_RELAXED_MODE を使用する必要があります。
• 上記の方法は、CMAKE_AUTOMOC_RELAXED_MODE と同等の機能を提供しますが、互換性があるとは限りません。