CMakeポリシー CMP0087 の影響を受けるコマンド

CMakeポリシー CMP0087 は、install(CODE) と install(SCRIPT) コマンドにおけるジェネレータ式(generator expressions)の評価方法を制御します。このポリシーは CMake 3.2 で導入されました。

旧動作と新動作

旧動作 (CMake 3.1 以前):

• ジェネレータ式は、install(CODE) と install(SCRIPT) コマンドが実行される前に評価されます。
• つまり、インストール先のパスは、CMake のconfigure段階で決定されます。

新動作 (CMake 3.2 以降):

• ジェネレータ式は、install() コマンドが実行される直前に評価されます。
• つまり、インストール先のパスは、ビルド段階で決定されます。

ポリシー設定方法

以下のコマンドで、ポリシーの動作を設定できます。

cmake_policy(CMP0087 NEW)  # 新動作を有効にする
cmake_policy(CMP0087 OLD)  # 旧動作を有効にする

影響を受けるコマンド

以下のコマンドは、CMP0087 ポリシーの影響を受けます。

• install(CODE)
• install(SCRIPT)

例

以下の例は、install(CODE) コマンドでジェネレータ式を使用する例です。

set(CMAKE_INSTALL_PREFIX "/usr/local")

# 新動作の場合、インストール先のパスは "/usr/local/bin" になります。
install(CODE "
  message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/bin/my_program\")
  install(PROGRAMS my_program DESTINATION bin)
")

# 旧動作の場合、インストール先のパスは "/usr/local" になります。
install(CODE "
  message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/my_program\")
  install(PROGRAMS my_program DESTINATION .)
")

注意事項

• CMP0087 ポリシーは、CMake 3.2 以降でのみ使用できます。
• 新動作を使用する場合は、ジェネレータ式がビルド段階で評価されることを考慮する必要があります。

• 上記の説明で不明な点があれば、遠慮なく質問してください。
• CMake に関する情報は、公式ドキュメントやチュートリアルを参照することをお勧めします。

CMake ポリシー CMP0087 のサンプルコード

サンプルコード 1: インストール先のパスを取得する

# 新動作の場合、インストール先のパスは "/usr/local/bin" になります。
install(CODE "
  message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/bin/my_program\")
  install(PROGRAMS my_program DESTINATION bin)
")

# 旧動作の場合、インストール先のパスは "/usr/local" になります。
install(CODE "
  message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/my_program\")
  install(PROGRAMS my_program DESTINATION .)
")

このサンプルコードは、install(CODE) コマンドでジェネレータ式を使用して、インストール先のパスを取得する方法を示しています。

新動作の場合、ジェネレータ式は install() コマンドが実行される直前に評価されるため、インストール先のパスは ${CMAKE_INSTALL_PREFIX}/bin になります。

旧動作の場合、ジェネレータ式は CMake のconfigure段階で評価されるため、インストール先のパスは ${CMAKE_INSTALL_PREFIX} になります。

サンプルコード 2: ファイル名にビルド情報を追加する

set(BUILD_VERSION "1.0.0")

# 新動作の場合、インストールされるファイル名は "my_program-1.0.0" になります。
install(CODE "
  message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/bin/my_program-${BUILD_VERSION}\")
  install(PROGRAMS my_program DESTINATION bin RENAME my_program-${BUILD_VERSION})
")

# 旧動作の場合、インストールされるファイル名は "my_program" になります。
install(CODE "
  message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/bin/my_program\")
  install(PROGRAMS my_program DESTINATION bin)
")

説明

このサンプルコードは、install(CODE) コマンドでジェネレータ式を使用して、ファイル名にビルド情報を追加する方法を示しています。

新動作の場合、ジェネレータ式は install() コマンドが実行される直前に評価されるため、ファイル名は "my_program-${BUILD_VERSION}" になります。

旧動作の場合、ジェネレータ式は CMake のconfigure段階で評価されるため、ファイル名は "my_program" になります。

サンプルコード 3: 条件付きインストール

set(CONDITION TRUE)

# 新動作の場合、CONDITION が TRUE の場合のみ、my_program がインストールされます。
install(CODE "
  if(${CONDITION})
    message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/bin/my_program\")
    install(PROGRAMS my_program DESTINATION bin)
  endif()
")

# 旧動作の場合、CONDITION に関係なく、my_program がインストールされます。
install(CODE "
  message(\"-- Installing executable: ${CMAKE_INSTALL_PREFIX}/bin/my_program\")
  install(PROGRAMS my_program DESTINATION bin)
")

説明

このサンプルコードは、install(CODE) コマンドでジェネレータ式を使用して、条件付きインストールを行う方法を示しています。

新動作の場合、ジェネレータ式は install() コマンドが実行される直前に評価されるため、CONDITION が TRUE の場合のみ my_program がインストールされます。

旧動作の場合、ジェネレータ式は CMake のconfigure段階で評価されるため、CONDITION に関係なく my_program がインストールされます。

上記は、CMake ポリシー CMP0087 のサンプルコードです。これらのサンプルコードを参考に、実際のプロジェクトで CMP0087 ポリシーを活用してください。

• 上記のサンプルコードは、あくまでも参考例です。
• ご質問やご不明な点がございましたら、遠慮なくお声掛けください。

CMake ポリシー CMP0087 の代替方法

カスタムコマンドを使用する

install(CODE) と install(SCRIPT) コマンドの代わりに、カスタムコマンドを使用してインストール処理を行うことができます。カスタムコマンドでは、ジェネレータ式を自由に使用できます。

例

add_custom_command(
  TARGET my_program
  POST_BUILD
  COMMAND ${CMAKE_COMMAND} -E echo "Installing executable: ${CMAKE_INSTALL_PREFIX}/bin/my_program"
  COMMAND ${CMAKE_COMMAND} -E install PROGRAMS my_program DESTINATION bin
)

説明

この例では、add_custom_command コマンドを使用して、my_program のインストール処理を定義しています。

POST_BUILD オプションにより、my_program のビルド後にインストール処理が実行されます。

-E echo コマンドにより、インストール先のパスを出力しています。

-E install コマンドにより、my_program をインストールしています。

インストールスクリプトを使用する

install(SCRIPT) コマンドの代わりに、インストールスクリプトを使用してインストール処理を行うことができます。インストールスクリプトでは、任意の言語を使用してジェネレータ式を評価できます。

例

# install.sh

#!/bin/bash

set -e

echo "Installing executable: /usr/local/bin/my_program"

install my_program /usr/local/bin

説明

この例では、install.sh という名前のインストールスクリプトを作成しています。

このスクリプトは、my_program を /usr/local/bin ディレクトリにインストールします。

スクリプト内で、echo コマンドを使用してインストール先のパスを出力しています。

CMake 変数を使用する

ジェネレータ式で必要な情報