警告メッセージの原因は？ CMakeポリシー「CMP0050」の動作と設定方法を完全理解

CMakeポリシー「CMP0050」は、プロジェクトのソースディレクトリを変更する際の動作を制御します。このポリシーは、CMake 3.13で導入され、デフォルトで有効になっています。

影響を受けるユーザー

以下のいずれかに該当する場合は、このポリシーの影響を受けます。

• CMake 3.13以降を使用している
• プロジェクトのソースディレクトリを変更するCMakeコードを使用している

ポリシーの動作

このポリシーが有効な場合、CMakeはソースディレクトリを変更する前に警告を発します。警告メッセージには、変更されるソースディレクトリと、変更の影響を受ける可能性のあるファイルやターゲットの情報が含まれます。

設定方法

このポリシーの動作は、以下の方法で設定できます。

• CMakeLists.txtファイルで cmake_policy() コマンドを使用する
• CMAKE_POLICY_CMP0050 環境変数を設定する

設定例

# CMakeLists.txtファイル

cmake_policy(CMP0050 NEW)  # ポリシーを新しい動作に設定

# 環境変数の設定

set CMAKE_POLICY_CMP0050=NEW  # ポリシーを新しい動作に設定

ポリシーの変更による影響

このポリシーの動作を変更すると、プロジェクトのビルドに影響を与える可能性があります。

• ポリシーを新しい動作に変更すると、ソースディレクトリを変更する前に警告が表示されるようになります。
• ポリシーを古い動作に変更すると、警告が表示されずにソースディレクトリが変更されます。

ポリシー変更時の注意点

このポリシーの動作を変更する前に、以下の点に注意してください。

• プロジェクトのソースディレクトリを変更するCMakeコードをすべて確認する必要があります。
• 警告メッセージの内容をよく確認し、必要に応じて対応する必要があります。

CMakeポリシー「CMP0050」のサンプルコード

サンプルコード1： ソースディレクトリ変更

# CMakeLists.txtファイル

set(CMAKE_SOURCE_DIR "/path/to/source")

# ソースディレクトリを変更
set(CMAKE_SOURCE_DIR "/path/to/new/source")

add_executable(my_app main.cpp)

このコードは、最初に CMAKE_SOURCE_DIR を /path/to/source に設定し、その後 /path/to/new/source に変更します。

出力結果

-- The source directory has changed:
--   Old: /path/to/source
--   New: /path/to/new/source
--
-- This warning is for project 'my_app'.
--
-- Call Stack (most recent call first):
--   CMakeLists.txt:2 (set)
--
-- Configuring done
-- Generating done
-- Build files have been written to: /path/to/build

サンプルコード2： ポリシー設定

# CMakeLists.txtファイル

cmake_policy(CMP0050 NEW)  # ポリシーを新しい動作に設定

set(CMAKE_SOURCE_DIR "/path/to/source")

# ソースディレクトリを変更
set(CMAKE_SOURCE_DIR "/path/to/new/source")

add_executable(my_app main.cpp)

このコードは、最初に cmake_policy() コマンドを使用して、ポリシー「CMP0050」を新しい動作に設定します。その後、ソースディレクトリを変更します。

出力結果

-- The source directory has changed:
--   Old: /path/to/source
--   New: /path/to/new/source
--
-- This warning is for project 'my_app'.
--
-- Call Stack (most recent call first):
--   CMakeLists.txt:4 (set)
--
-- Configuring done
-- Generating done
-- Build files have been written to: /path/to/build

サンプルコード3： 環境変数設定

# 環境変数の設定

set CMAKE_POLICY_CMP0050=NEW  # ポリシーを新しい動作に設定

# CMakeLists.txtファイル

set(CMAKE_SOURCE_DIR "/path/to/source")

# ソースディレクトリを変更
set(CMAKE_SOURCE_DIR "/path/to/new/source")

add_executable(my_app main.cpp)

このコードは、CMAKE_POLICY_CMP0050 環境変数を設定して、ポリシー「CMP0050」を新しい動作に設定します。その後、ソースディレクトリを変更します。

出力結果

-- The source directory has changed:
--   Old: /path/to/source
--   New: /path/to/new/source
--
-- This warning is for project 'my_app'.
--
-- Call Stack (most recent call first):
--   CMakeLists.txt:4 (set)
--
-- Configuring done
-- Generating done
-- Build files have been written to: /path/to/build

CMakeでプロジェクトのソースディレクトリを変更する他の方法

CMAKE_SOURCE_DIR 変数を設定する

これは、ソースディレクトリを変更する最も一般的な方法です。CMAKE_SOURCE_DIR 変数は、プロジェクトのソースコードを含むディレクトリを指定します。

set(CMAKE_SOURCE_DIR "/path/to/source")

add_subdirectory() コマンドは、サブディレクトリをプロジェクトに追加するために使用されます。このコマンドを使用して、サブディレクトリをソースディレクトリとして指定することができます。

add_subdirectory("/path/to/subdirectory")

CMAKE_CURRENT_SOURCE_DIR 変数は、現在処理中の CMakeLists.txt ファイルがあるディレクトリを指定します。この変数を使用して、相対パスでソースディレクトリを指定することができます。

set(SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/subdirectory")

add_executable(my_app main.cpp)

CMAKE_MODULE_PATH 変数は、CMake モジュールを探すためのパスを指定します。この変数を使用して、ソースディレクトリに配置された CMake モジュールを読み込むことができます。

set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/modules")

find_package(MyModule)

どの方法を使用するべきかは、プロジェクトの構成によって異なります。一般的には、CMAKE_SOURCE_DIR 変数を設定する方法が最も簡単で汎用性があります。

その他の注意事項

• ソースディレクトリを変更すると、プロジェクトのビルドに影響を与える可能性があります。
• ソースディレクトリを変更する前に、プロジェクトのすべての CMakeLists.txt ファイルを確認する必要があります。