CMake find_libraryコマンドとfind_packageモジュールの比較

CMake find_library コマンド解説

find_library() コマンドは、CMake で外部ライブラリを見つけるために使用されます。これは、プロジェクトに必要なライブラリを自動的に検出して、ビルドプロセスを簡略化するのに役立ちます。

コマンドフォーマット

find_library(<VAR> <NAME> [<PATHS>...])

• <VAR>: 検索結果を格納する変数名
• <NAME>: 探しているライブラリの名前
• <PATHS>: ライブラリファイルが格納されている可能性のあるパス (オプション)

オプション

• REQUIRED: ライブラリが見つからない場合、エラーが発生します。
• NO_DEFAULT_PATH: システムパスを検索しません。
• PATHS: ライブラリファイルを探すパスを指定します。
• NAMES: 複数の名前でライブラリを検索します。

動作

find_library() コマンドは、以下の手順でライブラリを探します。

1. <PATHS> で指定されたパスを検索します。
2. システムパスを検索します (NO_DEFAULT_PATH オプションが指定されていない場合)。
3. キャッシュ内の情報を確認します。

例

find_library(FOO foo)

# ライブラリが見つかった場合
if(FOO)
  message("ライブラリ foo が見つかりました。")
else()
  message("ライブラリ foo が見つかりませんでした。")
endif()

補足

• find_library() コマンドは、ヘッダーファイルだけでなく、ライブラリファイル (.so や .dll など) も検索します。
• ライブラリが見つからない場合は、find_package() コマンドを使用することもできます。
• find_library() コマンドは、複雑な設定も可能です。詳細は上記のドキュメントを参照してください。

• CMake には、find_path() や find_file() などの他の検索コマンドもあります。
• CMake のコマンドは、大文字と小文字が区別されます。

find_library コマンドのサンプルコード

基本的なサンプル

find_library(FOO foo)

# ライブラリが見つかった場合
if(FOO)
  message("ライブラリ foo が見つかりました。")
else()
  message("ライブラリ foo が見つかりませんでした。")
endif()

パスを指定する

find_library(FOO foo /usr/local/lib)

# ライブラリが見つかった場合
if(FOO)
  message("ライブラリ foo が見つかりました。")
else()
  message("ライブラリ foo が見つかりませんでした。")
endif()

複数の名前で検索する

find_library(FOO foo bar)

# ライブラリが見つかった場合
if(FOO)
  message("ライブラリ foo または bar が見つかりました。")
else()
  message("ライブラリ foo または bar が見つかりませんでした。")
endif()

ライブラリが見つからなかった場合の処理

find_library(FOO foo REQUIRED)

# ライブラリが見つかった場合
if(FOO)
  message("ライブラリ foo が見つかりました。")
else()
  message(FATAL_ERROR "ライブラリ foo が見つかりませんでした。")
endif()

キャッシュを使用する

find_library(FOO foo)

# キャッシュにライブラリ情報がない場合
if(NOT FOO)
  # ライブラリを探す処理
  ...
  set(FOO ...)
  cache(FOO ...)
endif()

# ライブラリ情報を利用する
...

find_package コマンドを使用する

find_package(Foo REQUIRED)

# ライブラリが見つかった場合
if(Foo_FOUND)
  message("ライブラリ Foo が見つかりました。")
  # Foo_LIBRARIES などの変数を利用する
else()
  message(FATAL_ERROR "ライブラリ Foo が見つかりませんでした。")
endif()

CMakeで外部ライブラリを見つける方法

手動で設定する

target_link_libraries() コマンドを使用して、ライブラリのパスと名前を手動で設定できます。

target_link_libraries(my_target /usr/local/lib/libfoo.so)

find_package モジュールを使用する

特定のライブラリ用の find_package モジュールが用意されている場合があります。これらのモジュールは、ライブラリの検索と設定を自動化します。

find_package(Foo REQUIRED)

target_link_libraries(my_target Foo::Foo)

外部ツールを使用する

cpack や conan などの外部ツールを使用して、ライブラリのインストールと設定を管理できます。

ソースコードからビルドする

必要なライブラリがソースコードとして提供されている場合は、CMake で直接ビルドすることができます。

add_subdirectory(external/foo)

target_link_libraries(my_target foo)

• ライブラリが標準的なものであれば、find_library() コマンドを使うのが最も簡単です。
• 特定のライブラリ用の find_package モジュールが用意されている場合は、それを利用するのがおすすめです。
• ライブラリのインストールや設定が複雑な場合は、外部ツールを使うと便利です。
• ライブラリのソースコードが提供されている場合は、ソースコードからビルドするのが最も柔軟な方法です。

CMakeで外部ライブラリを見つける方法はいくつかあります。状況に合わせて適切な方法を選択してください。