CMake の LINK_DIRECTORIES と CMAKE_PREFIX_PATH の違い

CMake の Properties: Targets における LINK_DIRECTORIES の詳細解説

この解説では、以下の内容を詳しく説明します:

• LINK_DIRECTORIES の役割: リンカにライブラリの場所を伝える
• 設定方法:
  • link_directories() コマンド
  • target_link_directories() コマンド
  • CMAKE_MODULE_PATH 変数
  • ターゲットプロパティファイル
• 動作の詳細:
  • 複数のディレクトリ指定
  • 検索順序
  • キャッシュと再利用
  • 相対パスと絶対パス
• Generator Expressions の利用:
  • 条件分岐によるディレクトリ指定
  • 変数や環境変数による動的なディレクトリ指定
• その他の関連情報:
  • LINK_INTERFACE_DIRECTORIES プロパティ
  • list() コマンド
  • get_property() コマンド
• トラブルシューティング:
  • ライブラリが見つからない場合
  • シンボルが見つからない場合
• 参考資料:
  • CMake 公式ドキュメント
  • チュートリアル
  • 書籍

LINK_DIRECTORIES は、ターゲットがリンクする必要がある共有ライブラリや静的ライブラリを見つけるためのディレクトリをリンカに伝えます。これは、以下の状況で特に重要になります:

• ライブラリが標準の場所にインストールされていない場合: 多くの場合、サードパーティ製のライブラリは標準の場所にインストールされていないため、LINK_DIRECTORIES を使用してその場所を指定する必要があります。
• プロジェクト内でライブラリを共有する場合: プロジェクト内で作成したライブラリを他のターゲットで使用したい場合は、LINK_DIRECTORIES を使用してそのライブラリの場所を指定する必要があります。

設定方法

LINK_DIRECTORIES は、以下の方法で設定することができます:

1 link_directories() コマンド

これは、LINK_DIRECTORIES を設定する最も一般的な方法です。以下の例のように、ディレクトリをカンマ区切りで指定します:

link_directories(/usr/local/lib, /path/to/other/lib)

2 target_link_directories() コマンド

このコマンドは、特定のターゲットにのみ LINK_DIRECTORIES を設定するために使用されます。以下の例のように、ターゲット名とディレクトリを指定します:

target_link_directories(my_target PUBLIC /usr/local/lib)

CMAKE_MODULE_PATH 変数は、CMake モジュールを探すためのディレクトリを指定するために使用されますが、LINK_DIRECTORIES を設定するためにも使用できます。以下の例のように、ディレクトリをカンマ区切りで指定します:

set(CMAKE_MODULE_PATH /usr/local/lib, /path/to/other/lib)

ターゲットプロパティファイルを使用して、LINK_DIRECTORIES を設定することもできます。以下の例のように、LINK_DIRECTORIES プロパティにディレクトリを指定します:

set_target_properties(my_target PROPERTIES LINK_DIRECTORIES /usr/local/lib)

動作の詳細

1 複数のディレクトリ指定

LINK_DIRECTORIES には、複数のディレクトリをカンマ区切りで指定することができます。リンカは、これらのディレクトリを指定された順序で検索します。

2 検索順序

リンカは、以下の順序でライブラリを検索します:

1. LINK_DIRECTORIES で指定されたディレクトリ
2. ターゲットの依存関係にあるターゲットの LINK_DIRECTORIES
3. システムのデフォルトのライブラリ検索パス

3 キャッシュと再利用

LINK_DIRECTORIES で設定されたディレクトリは、CMake キャッシュに保存されます。そのため、次回ビルドを行う

CMake の LINK_DIRECTORIES に関するサンプルコード

基本的なサンプル

# ターゲット "my_exe" に対して、"/usr/local/lib" と "/path/to/other/lib" をライブラリ検索ディレクトリとして指定
target_link_directories(my_exe PUBLIC /usr/local/lib /path/to/other/lib)

# 全てのターゲットに対して、"/usr/local/lib" をライブラリ検索ディレクトリとして指定
link_directories(/usr/local/lib)

# CMAKE_MODULE_PATH 変数を使用して、"/usr/local/lib" と "/path/to/other/lib" をライブラリ検索ディレクトリとして指定
set(CMAKE_MODULE_PATH /usr/local/lib /path/to/other/lib)

条件分岐によるディレクトリ指定

# 条件分岐によって、異なるディレクトリを指定
if(WIN32)
  link_directories(/usr/local/lib/win32)
else()
  link_directories(/usr/local/lib/linux)
endif()

変数や環境変数による動的なディレクトリ指定

# 変数を使用して、ライブラリの場所を動的に指定
set(lib_dir "/usr/local/lib")

link_directories(${lib_dir})

# 環境変数を使用して、ライブラリの場所を動的に指定
link_directories(${ENV{LIBRARY_PATH}})

その他のサンプル

• ターゲットプロパティファイルを使用する:

set(target_name "my_target")

set_target_properties(${target_name} PROPERTIES LINK_DIRECTORIES /usr/local/lib)

• 複数のターゲットに対して同時に設定する:

foreach(target IN my_targets)
  target_link_directories(${target} PUBLIC /usr/local/lib)
endforeach()

• list() コマンドを使用して、ディレクトリのリストを生成する:

set(lib_dirs)

list(APPEND lib_dirs /usr/local/lib)
list(APPEND lib_dirs /path/to/other/lib)

link_directories(${lib_dirs})

• get_property() コマンドを使用して、ターゲットの LINK_DIRECTORIES プロパティを取得する:

get_property(target_dirs TARGET my_target PROPERTY LINK_DIRECTORIES)

message("Target 'my_target' has the following library search directories: ${target_dirs}")

注意点

• LINK_DIRECTORIES で指定されたディレクトリが存在しない場合、リンカはエラーを出力します。
• ライブラリの名前は、リンカによって異なります。詳細は、リンカのマニュアルを参照してください。

CMake の LINK_DIRECTORIES を設定するその他の方法

CMAKE_PREFIX_PATH 変数は、ライブラリやヘッダーファイルを含むディレクトリを指定するために使用されます。LINK_DIRECTORIES は CMAKE_PREFIX_PATH の値を自動的に使用するため、以下のように CMAKE_PREFIX_PATH を設定することで、LINK_DIRECTORIES を設定することができます:

set(CMAKE_PREFIX_PATH /usr/local)

# "my_target" は "/usr/local/lib" 以下にあるライブラリとリンク
target_link_libraries(my_exe my_library)

インストール済みパッケージの利用

多くの場合、ライブラリはパッケージマネージャーを使用してインストールされます。CMake はこれらのパッケージを自動的に検出し、LINK_DIRECTORIES を設定することができます。

例:

• Debian/Ubuntu:

find_package(PkgConfig REQUIRED)
pkg_check_modules(PC_LIBRARY REQUIRED libmylibrary)

target_link_libraries(my_exe PUBLIC ${PC_LIBRARY_LIBDIR})

• Fedora/CentOS:

find_package(PkgConfig REQUIRED)
pkg_check_modules(PC_LIBRARY REQUIRED libmylibrary)

target_link_libraries(my_exe PUBLIC ${PC_LIBRARY_LIBDIR})

• Mac:

find_package(Cocoa REQUIRED)
find_package(MacPorts REQUIRED)

target_link_libraries(my_exe PUBLIC ${COCOA_LIBRARY_DIR} ${MACPORTS_LIBRARY_DIR})

外部モジュールの利用

CMake には、LINK_DIRECTORIES を設定するための外部モジュールが多数存在します。例:

これらのモジュールは、特定のライブラリやフレームワークを検出し、LINK_DIRECTORIES を含む必要な情報を提供します。

手動による設定

上記の方法でうまくいかない場合は、手動で LINK_DIRECTORIES を設定することができます。

例:

set(lib_dir "/path/to/my/library")

link_directories(${lib_dir})

# "my_target" は "/path/to/my/library" 以下にあるライブラリとリンク
target_link_libraries(my_exe my_library)

上記の情報に加えて、特定の状況や環境に合わせた情報が必要な場合は、Google 検索や CMake フォーラムなどを活用して情報収集を行うことをお勧めします。