CMakeでtarget_output_directory()コマンドを使用して出力を設定する方法

CMake の RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティ

RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティは、ターゲットごとに実行可能ファイルや共有ライブラリなどの出力ファイルを配置するディレクトリを構成するために使用されます。これは、ビルド構成 (Debug、Release など) ごとに異なる出力ディレクトリを設定したい場合に便利です。

設定方法

RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティは、ターゲットのプロパティとして設定できます。以下の例では、my_target ターゲットに対して、Debug 構成では bin/debug ディレクトリ、Release 構成では bin/release ディレクトリに出力ファイルを配置するように設定しています。

target_compile_definitions(my_target PUBLIC
  $<$<CONFIG:Debug>:MY_DEBUG>
  $<$<CONFIG:Release>:MY_RELEASE>)

target_property(my_target RUNTIME_OUTPUT_DIRECTORY
  $<$<CONFIG:Debug>:bin/debug>
  $<$<CONFIG:Release>:bin/release>)

使用例

• デバッグビルドとリリースビルドで異なる出力ディレクトリを使用したい場合
• 特定の構成で生成された実行可能ファイルを異なる場所に配置したい場合
• 異なるアーキテクチャ向けのビルドで異なる出力ディレクトリを使用したい場合

注意事項

• RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティは、CMake バージョン 3.5 以降で利用可能です。
• このプロパティは、実行可能ファイルや共有ライブラリなどのターゲットにのみ適用されます。
• 出力ディレクトリは、事前に存在している必要はありません。CMake が自動的に作成します。

補足

• CMAKE_RUNTIME_OUTPUT_DIRECTORY 環境変数を設定することで、すべてのターゲットに対してデフォルトの出力を設定することができます。
• target_output_directory() コマンドを使用して、ターゲットの出力を設定することもできます。

例

以下の例では、my_target ターゲットに対して、Debug 構成では bin/debug ディレクトリ、Release 構成では bin/release ディレクトリに出力ファイルを配置するように設定しています。

cmake_minimum_required(VERSION 3.5)

project(my_project)

add_executable(my_target
  main.cpp)

target_compile_definitions(my_target PUBLIC
  $<$<CONFIG:Debug>:MY_DEBUG>
  $<$<CONFIG:Release>:MY_RELEASE>)

target_property(my_target RUNTIME_OUTPUT_DIRECTORY
  $<$<CONFIG:Debug>:bin/debug>
  $<$<CONFIG:Release>:bin/release>)

この例では、my_target ターゲットをビルドすると、以下のファイルが生成されます。

• Debug 構成:
  • bin/debug/my_target (実行可能ファイル)
• Release 構成:

RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティは、ビルド構成ごとに異なる出力ディレクトリを設定したい場合に便利な CMake プロパティです。

CMake の RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティのサンプルコード

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

cmake_minimum_required(VERSION 3.5)

project(my_project)

add_executable(my_target
  main.cpp)

target_compile_definitions(my_target PUBLIC
  $<$<CONFIG:Debug>:MY_DEBUG>
  $<$<CONFIG:Release>:MY_RELEASE>)

target_property(my_target RUNTIME_OUTPUT_DIRECTORY
  $<$<CONFIG:Debug>:bin/debug>
  $<$<CONFIG:Release>:bin/release>)

特定の構成で生成された実行可能ファイルを異なる場所に配置する

cmake_minimum_required(VERSION 3.5)

project(my_project)

add_executable(my_target
  main.cpp)

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
  target_property(my_target RUNTIME_OUTPUT_DIRECTORY bin/debug)
else()
  target_property(my_target RUNTIME_OUTPUT_DIRECTORY bin/release)
endif()

この例では、CMAKE_BUILD_TYPE 変数の値によって、my_target ターゲットの出力ディレクトリが決定されます。

• Debug 構成: bin/debug ディレクトリ
• その他の構成: bin/release ディレクトリ

異なるアーキテクチャ向けのビルドで異なる出力ディレクトリを使用する

cmake_minimum_required(VERSION 3.5)

project(my_project)

add_executable(my_target
  main.cpp)

set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_CONFIG
  $<$<CONFIG:Debug>:bin/debug>
  $<$<CONFIG:Release>:bin/release>
  $<$<CONFIG:ARM>:bin/arm>
  $<$<CONFIG:X86>:bin/x86>)

target_compile_definitions(my_target PUBLIC
  $<$<CONFIG:Debug>:MY_DEBUG>
  $<$<CONFIG:Release>:MY_RELEASE>)

この例では、CMAKE_RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティを使用して、アーキテクチャごとに異なる出力ディレクトリを設定しています。

• Debug 構成:
  • bin/debug ディレクトリ (すべてのアーキテクチャ)
• Release 構成:
• ARM アーキテクチャ:
  • bin/arm ディレクトリ (Debug および Release 構成)

環境変数を使用してデフォルトの出力を設定する

cmake_minimum_required(VERSION 3.5)

project(my_project)

set(CMAKE_RUNTIME_OUTPUT_DIRECTORY /usr/local/bin)

add_executable(my_target
  main.cpp)

この例では、CMAKE_RUNTIME_OUTPUT_DIRECTORY 環境変数を設定することで、すべてのターゲットに対してデフォルトの出力を /usr/local/bin ディレクトリに設定しています。

target_output_directory() コマンドを使用する

cmake_minimum_required(VERSION 3.5)

project(my_project)

add_executable(my_target
  main.cpp)

target_output_directory(my_target
  Debug bin/debug
  Release bin/release)

この例では、target_output_directory() コマンドを使用して、my_target ターゲットの出力ディレクトリを設定しています。

• Release 構成: bin/release ディレクトリ

RUNTIME_OUTPUT_DIRECTORY_CONFIG プロパティは、ビルド構成やアーキテクチャなどによって異なる出力ディレクトリを設定したい場合に便利な CMake プロパティです。

CMake でターゲットの出力を設定する他の方法

CMAKE_RUNTIME_OUTPUT_DIRECTORY 環境変数を設定することで、すべてのターゲットに対してデフォルトの出力を設定することができます。

set(CMAKE_RUNTIME_OUTPUT_DIRECTORY /usr/local/bin)

add_executable(my_target
  main.cpp)

この例では、すべてのターゲットは /usr/local/bin ディレクトリに配置されます。

target_output_directory() コマンドを使用して、個々のターゲットの出力を設定することができます。

add_executable(my_target
  main.cpp)

target_output_directory(my_target
  Debug bin/debug
  Release bin/release)

この例では、my_target ターゲットは、Debug 構成では bin/debug ディレクトリ、Release 構成では bin/release ディレクトリに配置されます。

ターゲットのプロパティを設定することで、出力ディレクトリを構成することができます。

add_executable(my_target
  main.cpp)

target_property(my_target RUNTIME_OUTPUT_DIRECTORY
  $<$<CONFIG:Debug>:bin/debug>
  $<$<CONFIG:Release>:bin/release>)

この例では、my_target ターゲットは、Debug 構成では bin/debug ディレクトリ、Release 構成では bin/release ディレクトリに配置されます。

install() コマンドを使用して、ターゲットをインストール時に特定の場所に配置することができます。

install(TARGETS my_target
  RUNTIME DESTINATION /usr/local/bin)

この例では、my_target ターゲットはインストール時に /usr/local/bin ディレクトリに配置されます。

カスタムコマンドを使用して、出力ファイルを好きな場所にコピーすることができます。

add_custom_command(TARGET my_target
  POST_BUILD
  COMMAND cp $<TARGET_FILE:my_target> /usr/local/bin)

この例では、my_target ターゲットがビルドされた後、実行可能ファイルは /usr/local/bin ディレクトリにコピーされます。

これらの方法のどれを選択するかは、要件とプロジェクトのセットアップによって異なります。

ヒント:

• 複数の方法を組み合わせることもできます。
• CMake のドキュメントを参照して、各方法の詳細を確認してください。