CMakeのCMAKE_CFG_INTDIR変数: 非推奨と代替案

CMakeにおけるCMAKE_CFG_INTDIR変数

CMAKE_CFG_INTDIR は、CMakeプロジェクトのビルド時に、各コンフィギュレーション（Debug、Releaseなど）の出力ファイルを格納する中間ディレクトリの名前を指定する変数です。ただし、この変数はCMake 3.21以降で非推奨となり、代わりに<CONFIG>ジェネレータ式を使用することを推奨されています。

詳細

• デフォルト値: <CONFIG>
• データ型: STRING
• スコープ: CACHE

使用例

# デバッグビルドの出力ファイルを`Debug`ディレクトリに格納
set(CMAKE_CFG_INTDIR "Debug" CACHE STRING "" FORCE)

# リリースビルドの出力ファイルを`Release`ディレクトリに格納
set(CMAKE_CFG_INTDIR "Release" CACHE STRING "" FORCE)

非推奨

CMAKE_CFG_INTDIR は以下の理由で非推奨となっています。

• Ninja Multi-Config でのサポートが不十分
• <CONFIG>ジェネレータ式の存在

<CONFIG>ジェネレータ式の使用

CMAKE_CFG_INTDIR の代わりに、<CONFIG>ジェネレータ式を使用して、コンフィギュレーションごとに異なる出力ディレクトリを指定できます。

# 各コンフィギュレーションの出力ファイルを`build/<CONFIG>`ディレクトリに格納
set(CMAKE_BINARY_DIR "${CMAKE_SOURCE_DIR}/build")

# ソースファイル
add_executable(my_app main.c)

# 出力ファイル
set_target_properties(my_app PROPERTIES
  OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIG>")

CMakeのCMAKE_CFG_INTDIR変数を使ったサンプルコード

デバッグとリリースビルドで異なる中間ディレクトリを使用する

# デバッグビルドの出力ファイルを`Debug`ディレクトリに格納
set(CMAKE_CFG_INTDIR "Debug" CACHE STRING "" FORCE)

# リリースビルドの出力ファイルを`Release`ディレクトリに格納
set(CMAKE_CFG_INTDIR "Release" CACHE STRING "" FORCE)

# ソースファイル
add_executable(my_app main.c)

# 出力ファイル
set_target_properties(my_app PROPERTIES
  OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIG>")

<CONFIG>ジェネレータ式を使用して中間ディレクトリを指定する

# 各コンフィギュレーションの出力ファイルを`build/<CONFIG>`ディレクトリに格納
set(CMAKE_BINARY_DIR "${CMAKE_SOURCE_DIR}/build")

# ソースファイル
add_executable(my_app main.c)

# 出力ファイル
set_target_properties(my_app PROPERTIES
  OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIG>")

サブディレクトリを含むプロジェクトで中間ディレクトリを使用する

# サブディレクトリを含むプロジェクト
set(CMAKE_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src")

# 各コンフィギュレーションの出力ファイルを`build/<CONFIG>`ディレクトリに格納
set(CMAKE_BINARY_DIR "${CMAKE_SOURCE_DIR}/../build")

# ソースファイル
add_executable(my_app main.c)

# 出力ファイル
set_target_properties(my_app PROPERTIES
  OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIG>")

カスタムビルドルールで中間ディレクトリを使用する

# カスタムビルドルール
add_custom_command(
  TARGET my_app
  POST_BUILD
  COMMAND ${CMAKE_COMMAND} -E copy
  ARGS "<TARGET_FILE_DIR>/my_app"
  DESTINATION "${CMAKE_BINARY_DIR}/$<CONFIG>")

# ソースファイル
add_executable(my_app main.c)

CMakeで中間ディレクトリを指定する他の方法

<BUILD_TYPE>ジェネレータ式

CMAKE_CFG_INTDIR変数と同様に、<BUILD_TYPE>ジェネレータ式を使用して、ビルドタイプ（Debug、Releaseなど）ごとに異なる中間ディレクトリを指定できます。

# 各ビルドタイプの出力ファイルを`build/<BUILD_TYPE>`ディレクトリに格納
set(CMAKE_BINARY_DIR "${CMAKE_SOURCE_DIR}/build")

# ソースファイル
add_executable(my_app main.c)

# 出力ファイル
set_target_properties(my_app PROPERTIES
  OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<BUILD_TYPE>")

CMAKE_BINARY_DIR変数は、CMakeプロジェクトのビルド全体の中間ディレクトリを指定します。この変数を設定することで、すべての出力ファイルをこのディレクトリ以下に格納できます。

# 全ての出力ファイルを`build`ディレクトリに格納
set(CMAKE_BINARY_DIR "${CMAKE_SOURCE_DIR}/build")

# ソースファイル
add_executable(my_app main.c)

手動で中間ディレクトリを作成する

CMakeLists.txtファイルとは別に、手動で中間ディレクトリを作成することもできます。この方法は、複雑なプロジェクトや、特定の要件を満たす必要がある場合に役立ちます。

# 手動で中間ディレクトリを作成
mkdir -p build/Debug
mkdir -p build/Release

# ソースファイル
add_executable(my_app main.c)

# 出力ファイル
set_target_properties(my_app PROPERTIES
  OUTPUT_DIRECTORY "build/${CMAKE_BUILD_TYPE}")

外部ツールを使用する

CPackなどの外部ツールを使用して、中間ディレクトリを管理することもできます。これらのツールは、ビルド後のクリーニングや、配布パッケージの作成など、さまざまな機能を提供します。

どの方法を選択するかは、プロジェクトのニーズと要件によって異なります。 上記の情報を参考に、ご自身のプロジェクトに合った方法を選択してください。