CMakeの環境変数：LD_LIBRARY_PATH、CPATH、CMAKE_PREFIX_PATHの役割と設定方法

CMakeにおけるCMAKE_PREFIX_PATH：分かりやすく解説

CMAKE_PREFIX_PATHの概要

CMAKE_PREFIX_PATHは、find_package()、find_program()、find_library()、find_file()、**find_path()**などのコマンドが、必要なライブラリやヘッダーファイルなどを検索する際に使用するディレクトリを指定します。これは、複数のディレクトリに分散してインストールされたライブラリやヘッダーファイルを、一括して検索できるようにするためのものです。

CMAKE_PREFIX_PATHの使用方法

CMAKE_PREFIX_PATHは、以下の方法で設定できます。

• CMakeLists.txtファイル

set(CMAKE_PREFIX_PATH "/usr/local;/opt/local")

• 環境変数

export CMAKE_PREFIX_PATH="/usr/local;/opt/local"

• コマンドライン

cmake -DCMAKE_PREFIX_PATH="/usr/local;/opt/local" ..

CMAKE_PREFIX_PATHの例

以下は、CMAKE_PREFIX_PATHの使用方法の例です。

# /usr/local/libにインストールされたライブラリを検索
find_library(FOO foo)

# /opt/local/includeにインストールされたヘッダーファイルを検索
find_path(BAR bar.h)

上記の例では、CMAKE_PREFIX_PATHが**"/usr/local;/opt/local"**に設定されているため、find_library()は"/usr/local/lib"、**find_path()は"/opt/local/include"**を検索します。

CMAKE_PREFIX_PATHの設定時の注意点

• 複数のディレクトリを指定する場合は、セミコロンで区切ります
• ディレクトリの末尾にはスラッシュ（/）を含めない
• 環境変数よりもCMakeLists.txtファイルで設定した方が優先されます
• 設定したディレクトリに、必要なライブラリやヘッダーファイルが存在することを確認する必要があります

CMAKE_PREFIX_PATHのまとめ

CMAKE_PREFIX_PATHを使用したサンプルコード

set(CMAKE_PREFIX_PATH "/usr/local;/opt/local")

find_library(FOO foo)
find_path(BAR bar.h)

環境変数を使用する

export CMAKE_PREFIX_PATH="/usr/local;/opt/local"

cmake ..

コマンドラインを使用する

cmake -DCMAKE_PREFIX_PATH="/usr/local;/opt/local" ..

特定のディレクトリを優先的に検索する

set(CMAKE_PREFIX_PATH "/opt/local; /usr/local")

find_library(FOO foo)

キャッシュをクリアする

cmake clean

複数のライブラリバージョンを管理する

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "/usr/local/lib/cmake")

find_package(Foo REQUIRED)
find_package(Bar CONFIG)

if(TARGET Foo)
  message(STATUS "Found Foo version ${Foo_VERSION}")
endif()

if(TARGET Bar)
  message(STATUS "Found Bar version ${Bar_VERSION}")
endif()

外部プロジェクトをビルドする

set(CMAKE_PREFIX_PATH "/usr/local;/opt/local")

add_subdirectory(external_project)

補足

• 上記のサンプルコードは、Linux環境を想定しています。他の環境では、パス区切り文字などを適宜変更する必要があります。
• CMakeには、CMAKE_FIND_ROOT_PATH、CMAKE_FIND_LIBRARY_PATH、CMAKE_FIND_INCLUDE_PATHなどの他の関連変数もあります。これらの変数の詳細は、CMake documentation を参照してください。

CMAKE_PREFIX_PATH以外の方法

**find_package()**コマンドには、NO_CMAKE_FIND_ROOT_PATHオプションがあります。このオプションを指定すると、CMAKE_PREFIX_PATHは無視され、**find_package()**は、デフォルトの検索パスのみを使用します。

find_package(Foo NO_CMAKE_FIND_ROOT_PATH)

find_library()、find_path()コマンドのPATHSオプション

find_library()、**find_path()**コマンドには、PATHSオプションがあります。このオプションを指定すると、find_library()、**find_path()**は、指定されたディレクトリのみを検索します。

find_library(FOO foo PATHS "/usr/local/lib")
find_path(BAR bar.h PATHS "/opt/local/include")

手動でヘッダーファイルやライブラリのパスを指定する

target_include_directories()、**target_link_libraries()**コマンドを使用して、ヘッダーファイルやライブラリのパスを手動で指定することができます。

target_include_directories(my_target PUBLIC "/usr/local/include")
target_link_libraries(my_target PUBLIC "/usr/local/lib/libfoo.so")

外部プロジェクトのビルドシステムを使用する

外部プロジェクトの場合、そのプロジェクトのビルドシステムを使用することができます。

add_subdirectory(external_project)

環境変数を使用する

LD_LIBRARY_PATH、CPATHなどの環境変数を使用して、ライブラリやヘッダーファイルのパスを設定することができます。

export LD_LIBRARY_PATH="/usr/local/lib"
export CPATH="/opt/local/include"

シンボリックリンクを使用する

必要なライブラリやヘッダーファイルへのシンボリックリンクを作成することができます。

ln -s /usr/local/lib/libfoo.so /usr/lib/libfoo.so
ln -s /opt/local/include/bar.h /usr/include/bar.h

インストールパスを変更する

CMakeLists.txtファイルで、CMAKE_INSTALL_PREFIX変数を使用して、インストールパスを変更することができます。

set(CMAKE_INSTALL_PREFIX "/usr/local")

上記の方法は、CMAKE_PREFIX_PATH以外にも、必要なライブラリやヘッダーファイルを検索する方法です。状況に応じて、最適な方法を選択してください。