初めての CMake Modules: FindPkgConfig で外部ライブラリを使いこなす

CMake Modules における FindPkgConfig の詳細解説

この解説では、FindPkgConfig の仕組み、使用方法、オプション、および高度な使い方について詳しく説明します。

FindPkgConfig は、CMake モジュールの一つであり、以下の機能を提供します。

• pkg-config との連携: インストール済みパッケージの情報を検索し、解析します。
• ビルド情報の自動設定: ヘッダーファイル、ライブラリファイル、リンカーオプションなどの情報を設定します。
• 依存関係の管理: プロジェクトに必要な依存関係を自動的に解決します。

FindPkgConfig は、以下の利点があります。

• 簡便性: 手動で設定ファイルを編集する必要がなくなり、ビルド工程を簡略化できます。
• 移植性: プラットフォームや環境に依存せずに、プロジェクトをビルドできます。
• 信頼性: 設定ミスによるエラーを減らすことができます。

1 基本的な使い方

FindPkgConfig を使用するには、CMakeLists.txt ファイルに以下のコマンドを追加します。

find_package(PkgName [REQUIRED] [QUIET])

• PkgName: 検索するパッケージの名前
• REQUIRED: オプション。指定すると、パッケージが見つからない場合にエラーが発生します。
• QUIET: オプション。指定すると、検索結果のメッセージを出力しません。

例:

find_package(SDL2 REQUIRED)

このコマンドは、SDL2 パッケージを検索し、見つかった場合は以下の情報を設定します。

• SDL2_FOUND: 変数。パッケージが見つかった場合は TRUE に設定されます。
• SDL2_INCLUDE_DIRS: 変数。SDL2 のヘッダーファイルのディレクトリパス
• SDL2_LIBRARIES: 変数。SDL2 のライブラリファイル

これらの変数は、プロジェクトのソースコードで直接使用できます。

2 詳細なオプション

FindPkgConfig には、以下のオプションがあります。

• CONFIG: パッケージの構成オプションを指定します。
• COMPONENTS: パッケージのコンポーネントを指定します。
• NO_POLICY_SCOPE: ポリシースコープを無効にします。
• EXACT_VERSION: バージョンを厳密に一致させるかどうかを指定します。

例:

find_package(SDL2 REQUIRED CONFIG=static COMPONENTS=gfx)

このコマンドは、SDL2 パッケージの静的ライブラリと gfx コンポーネントを検索します。

高度な使い方

1 複数のバージョンを扱う

FindPkgConfig は、複数のバージョンのパッケージを扱うことができます。

find_package(PkgName [MAJOR.MINOR] [EXACT_VERSION])

• MAJOR.MINOR: 検索するパッケージのバージョン

例:

find_package(Qt5 5.12 EXACT_VERSION)

このコマンドは、Qt5 のバージョン 5.12 を検索します。

2 モジュールの作成

FindPkgConfig モジュールを作成することで、独自の検索ロジックを実装できます。

詳細は、CMake のドキュメントを参照してください。

まとめ

FindPkgConfig は、CMake Modules における強力なツールです。 理解して使いこなすことで、プロジェクトのビルドを効率化できます。

FindPkgConfig のサンプルコード

基本的なサンプル

find_package(SDL2 REQUIRED)

# SDL2 のヘッダーファイルのインクルード
include_directories(${SDL2_INCLUDE_DIRS})

# SDL2 のライブラリとのリンク
link_libraries(${SDL2_LIBRARIES})

バージョン指定

find_package(Qt5 5.12 EXACT_VERSION)

# Qt5 のヘッダーファイルのインクルード
include_directories(${Qt5_INCLUDE_DIRS})

# Qt5 のライブラリとのリンク
link_libraries(${Qt5_LIBRARIES})

コンポーネント指定

find_package(SDL2 REQUIRED CONFIG=static COMPONENTS=gfx)

# SDL2 の静的ライブラリとのリンク
link_libraries(${SDL2_LIBRARIES})

モジュールの作成

# FindPkgConfig モジュールを作成

set(MODULE_NAME MyModule)

# モジュールファイルのパス
set(MODULE_FILE ${CMAKE_CURRENT_SOURCE_DIR}/${MODULE_NAME}.cmake)

# モジュールの作成
add_custom_target(${MODULE_NAME} ALL
  COMMAND ${CMAKE_COMMAND} -E copy
    ${CMAKE_CURRENT_SOURCE_DIR}/Find${MODULE_NAME}.cmake
    ${CMAKE_BINARY_DIR}/Modules/${MODULE_NAME}.cmake)

# モジュールの使用
find_package(${MODULE_NAME} REQUIRED)

# モジュールによって設定された変数
message(${MYMODULE_FOUND})
message(${MYMODULE_INCLUDE_DIRS})
message(${MYMODULE_LIBRARIES})

補足

FindPkgConfig に関するご質問は、お気軽にお尋ねください。

CMakeで外部ライブラリを扱うその他の方法

手動設定

FindPkgConfig を使用せずに、以下の情報を手動で設定できます。

• ヘッダーファイルのインクルードパス
• ライブラリファイルのパス
• リンカーオプション

この方法は、比較的単純なプロジェクトの場合に有効です。

CMake モジュールの作成

FindPkgConfig のような独自の CMake モジュールを作成できます。

この方法は、複雑なプロジェクトや、特定のニーズを満たす必要がある場合に有効です。

サードパーティ製のツール

CPack や Conan などのサードパーティ製のツールを使用して、外部ライブラリを管理できます。

これらのツールは、プロジェクトの依存関係を自動的にダウンロード、インストール、設定することができます。

それぞれの方法の比較

どの方法を選択するかは、プロジェクトの規模、複雑性、およびニーズによって異なります。

• シンプルなプロジェクトの場合は、FindPkgConfig または手動設定が適切です。
• 複雑なプロジェクトや、特定のニーズを満たす必要がある場合は、CMake モジュールの作成またはサードパーティ製のツールの使用を検討してください。

これらの方法に関するご質問は、お気軽にお尋ねください。