クロスコンパイルもパッケージングも楽々！DESTDIRが切り開くCMakeの可能性

DESTDIRは、CMakeにおける重要な環境変数の一つであり、ソフトウェアのインストール先ディレクトリを指定するために使用されます。通常、ソフトウェアは /usr/local のようなシステムデフォルトの場所にインストールされますが、DESTDIRを使用することで、任意の場所へインストールすることができます。

利点

DESTDIRを使用する主な利点は以下の通りです。

サンドボックス環境の作成
DESTDIRを使用して、ソフトウェアをサンドボックス環境にインストールすることで、システムへの影響を制限することができます。
インストール先の柔軟性
開発者は、DESTDIRを使用して、本番環境とは異なる場所にソフトウェアをインストールすることができます。これは、テスト目的やデバッグ目的でソフトウェアをインストールする場合に役立ちます。
クロスコンパイルとパッケージング
DESTDIRは、異なるアーキテクチャ向けにソフトウェアをクロスコンパイルしたり、パッケージングシステムで使用したりする際に不可欠です。

使用方法

DESTDIRは、主に以下の2つの方法で使用されます。

CMakeの起動時
cmake コマンドを実行する際に、-DCMAKE_INSTALL_PREFIX=<DESTDIR> オプションを指定することで、DESTDIRを設定することができます。

cmake -DCMAKE_INSTALL_PREFIX=/opt/my-software <source_directory>

CMakeLists.txtファイル内
set(CMAKE_INSTALL_PREFIX <DESTDIR>) コマンドを使用して、CMakeLists.txtファイル内でDESTDIRを設定することもできます。

set(CMAKE_INSTALL_PREFIX /opt/my-software)

注意点

DESTDIRを使用する際には、以下の点に注意する必要があります。

一貫性
プロジェクト全体でDESTDIRを一貫して使用するようにしてください。
相対パス
DESTDIRは絶対パスで指定する必要があります。相対パスを使用すると、予期しない結果になる可能性があります。
Windowsでは制限がある
DESTDIRは、Windowsではドライブ文字を含むパスを指定できないため、制限があります。

DESTDIRは、CMakeのインストールパスやキャッシュディレクトリなどの他の変数と連携して使用することができます。詳細については、CMakeの公式ドキュメントを参照してください。

[CMake Tutorial - Setting the Install Prefix](https://www. cmake.org/cmake-docs/3.22/tutorial/CMakeTutorial.html#setting-the-install-prefix)

cmake_minimum_required(VERSION 3.10)

project(my-project)

set(CMAKE_INSTALL_PREFIX /opt/my-software)

add_executable(my-program main.cpp)

target_link_libraries(my-program my-library)

install(TARGETS my-program DESTINATION bin)
install(DIRECTORY docs DESTINATION share/doc/my-project)

この例では、set(CMAKE_INSTALL_PREFIX /opt/my-software) コマンドを使用して、DESTDIRを /opt/my-software に設定しています。その後、install コマンドを使用して、my-program 実行可能ファイルと docs ディレクトリを指定された場所にインストールします。

例2：CMake起動時のDESTDIR設定

cmake -DCMAKE_INSTALL_PREFIX=/opt/my-software <source_directory>

この例では、cmake コマンドを実行する際に -DCMAKE_INSTALL_PREFIX=/opt/my-software オプションを指定することで、DESTDIRを /opt/my-software に設定しています。

例3：DESTDIRを使用したクロスコンパイル

cmake -DCMAKE_TOOLCHAIN_FILE=cross-compile.cmake \
      -DCMAKE_INSTALL_PREFIX=/opt/my-software-arm \
      -DARM_ARCH_ABI=arm-linux-eabihf \
      <source_directory>

この例では、cross-compile.cmake ツールチェーンファイルを使用して、ARMアーキテクチャ向けにクロスコンパイルしています。-DCMAKE_INSTALL_PREFIX=/opt/my-software-arm オプションを使用して、DESTDIRを /opt/my-software-arm に設定しています。

インストールプレフィックス

最も一般的な代替方法は、CMAKE_INSTALL_PREFIX 変数を使用することです。これは、DESTDIRと似ていますが、いくつかの重要な違いがあります。

一貫性
プロジェクト全体で CMAKE_INSTALL_PREFIX を一貫して使用する必要があります。一方、DESTDIRは必要に応じて変更できます。
デフォルト値
CMAKE_INSTALL_PREFIX にはデフォルト値 /usr/local が設定されています。一方、DESTDIRにはデフォルト値はありません。
絶対パス
CMAKE_INSTALL_PREFIX は絶対パスで指定する必要があります。一方、DESTDIRは相対パスでも指定できます。

例

cmake -DCMAKE_INSTALL_PREFIX=/opt/my-software <source_directory>

長所

プロジェクト全体で一貫性を保ちやすい
デフォルト値が設定されている
シンプルで使いやすい

短所

常に絶対パスを指定する必要がある
相対パスを使用できない

インストール構成ファイル

もう1つの代替方法は、インストール構成ファイルを使用することです。これは、CMAKE_INSTALL_CONFIG_FILE 変数を使用して指定できます。このファイルには、インストール先ディレクトリを含む様々な設定を記述することができます。

例

set(CMAKE_INSTALL_CONFIG_FILE install_config.cmake)

configure_file(install_config.cmake ${CMAKE_BINARY_DIR}/install.cmake COPYONLY)

install(TARGETS my-program DESTINATION ${CMAKE_INSTALL_PREFIX})

install_config.cmake ファイルには以下のような内容を記述します。

set(CMAKE_INSTALL_PREFIX /opt/my-software)

長所

相対パスを使用できる
様々な設定を記述できる
柔軟性が高い

短所

インストール構成ファイルを作成する必要がある
複雑で設定が面倒

カスタムインストールコマンド

最後の代替方法は、カスタムインストールコマンドを使用することです。これは、add_custom_command コマンドを使用して指定できます。このコマンドを使用して、独自のインストールロジックを実装することができます。

例

add_custom_command(
  TARGET my-program
  POST_BUILD
  COMMAND mkdir -p /opt/my-software
  COMMAND cp $<TARGET:MY_PROGRAM> /opt/my-software
)

長所

複雑なインストールロジックを実装できる
完全な制御が可能

短所

CMakeに精通している必要がある
複雑でコード量が多くなる

DESTDIRにはいくつかの代替方法がありますが、それぞれに長所と短所があります。プロジェクトのニーズに合った方法を選択することが重要です。

詳細については、CMakeの公式ドキュメントを参照してください。
上記以外にも、様々な代替方法があります。