IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG プロパティの代替方法：手動設定、外部ライブラリのCMakeファイル、CPack

CMake の IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG プロパティ

IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG は、CMake のターゲットプロパティの一つで、外部ライブラリのコンフィギュレーション情報を指定するために使用されます。これは、IMPORTED_LINK_INTERFACE_LIBRARIES と併せて使用することで、外部ライブラリをプロジェクトに正しく統合するために必要な情報を提供します。

詳細

IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG は、以下の情報を格納します。

• 外部ライブラリのコンフィギュレーションファイルの場所
• 外部ライブラリのコンパイルオプション
• 外部ライブラリのリンカオプション

設定方法

IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG は、set_target_properties() コマンドを使用して設定できます。以下の例は、foo という名前のターゲットに対して IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG を設定する方法を示しています。

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG
  "/path/to/config.cmake")

使用例

IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG は、外部ライブラリが提供するコンフィギュレーションファイルを使用する必要がある場合に役立ちます。例えば、外部ライブラリが pkg-config ファイルを提供している場合、IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG を使用してそのファイルの場所を指定することができます。

以下の例は、pkg-config ファイルを使用して foo という名前のターゲットに対して外部ライブラリ bar をリンクする方法を示しています。

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES
  "bar")

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG
  "/usr/local/lib/pkgconfig/bar.pc")

注意事項

IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG は、CMake バージョン 3.7 以降でのみ使用できます。

補足

• 上記の説明では、IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG の基本的な使用方法について説明しました。詳細については、CMake のドキュメントを参照してください。
• IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG は、外部ライブラリの統合を簡略化するために役立ちますが、常に必要なわけではありません。外部ライブラリがコンフィギュレーションファイルを提供していない場合は、このプロパティを使用する必要はありません。

CMake の IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG プロパティのサンプルコード

シンプルな例

set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

find_package(PkgConfig REQUIRED)

pkg_check_modules(PC_BAR QUIET bar)

if(PC_BAR_FOUND)
  set(BAR_LIBRARIES ${PC_BAR_LIBRARIES})
  set(BAR_INCLUDE_DIRS ${PC_BAR_INCLUDE_DIRS})
else()
  message(FATAL_ERROR "Could not find PkgConfig module 'bar'")
endif()

add_executable(foo
  main.cpp
  ${BAR_LIBRARIES})

target_include_directories(foo
  PUBLIC ${BAR_INCLUDE_DIRS})

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES
  ${BAR_LIBRARIES})

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG
  "${CMAKE_CURRENT_BINARY_DIR}/bar.cmake")

詳細な例

set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

find_package(PkgConfig REQUIRED)

pkg_check_modules(PC_BAR QUIET bar)

if(PC_BAR_FOUND)
  set(BAR_LIBRARIES ${PC_BAR_LIBRARIES})
  set(BAR_INCLUDE_DIRS ${PC_BAR_INCLUDE_DIRS})
  set(BAR_CONFIG_CMAKE_FILE "${CMAKE_CURRENT_BINARY_DIR}/bar.cmake")

  # Generate bar.cmake file

  file(WRITE ${BAR_CONFIG_CMAKE_FILE}
    "# This file is generated by CMake

    set(BAR_LIBRARIES ${BAR_LIBRARIES})
    set(BAR_INCLUDE_DIRS ${BAR_INCLUDE_DIRS})

    # Additional configuration options

    set(BAR_COMPILE_OPTIONS "-O2 -Wall")
    set(BAR_LINK_OPTIONS "-Wl,-rpath,-L/usr/local/lib")
  ")

else()
  message(FATAL_ERROR "Could not find PkgConfig module 'bar'")
endif()

add_executable(foo
  main.cpp
  ${BAR_LIBRARIES})

target_include_directories(foo
  PUBLIC ${BAR_INCLUDE_DIRS})

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES
  ${BAR_LIBRARIES})

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG
  ${BAR_CONFIG_CMAKE_FILE})

この例では、PkgConfig を使用して外部ライブラリ bar を検索し、プロジェクトに統合します。IMPORTED_LINK_INTERFACE_LIBRARIES と IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG を使用して、bar のライブラリとコンフィギュレーション情報を foo ターゲットに提供します。

さらに、この例では、bar.cmake という名前のコンフィギュレーションファイルを作成します。このファイルは、bar ライブラリのコンパイルオプションとリンカオプションを指定します。

複数のターゲットを使用する例

set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

find_package(PkgConfig REQUIRED)

pkg_check_modules(PC_BAR QUIET bar)

if(PC_BAR_FOUND)
  set(BAR_LIBRARIES ${PC_BAR_LIBRARIES})
  set(BAR_INCLUDE_DIRS <span class="math-inline">\{PC\_BAR\_INCLUDE\_DIRS\}\)
set\(BAR\_CONFIG\_CMAKE\_FILE "</span>{CMAKE_CURRENT_BINARY_DIR}/bar.cmake")

  # Generate bar.cmake file

  file(WRITE ${BAR_CONFIG_CMAKE_FILE}
    "# This file is generated by CMake

    set(BAR_LIBRARIES ${BAR_LIBRARIES})
    set(BAR_INCLUDE_DIRS ${BAR_INCLUDE_DIRS})

    # Additional configuration options

    set(BAR_COMPILE_OPTIONS "-O2 -Wall")
    set(BAR_LINK_OPTIONS "-Wl,-rpath,-L/usr

CMake の IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG プロパティの代替方法

手動でコンフィギュレーション情報を設定する

IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG プロパティを使用する代わりに、以下の方法で外部ライブラリのコンフィギュレーション情報を手動で設定することができます。

• target_compile_options() コマンドを使用して、ターゲットのコンパイルオプションを設定します。
• target_include_directories() コマンドを使用して、ターゲットのインクルードディレクトリを設定します。

以下の例は、bar ライブラリの手動設定方法を示しています。

set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

find_package(PkgConfig REQUIRED)

pkg_check_modules(PC_BAR QUIET bar)

if(PC_BAR_FOUND)
  set(BAR_LIBRARIES ${PC_BAR_LIBRARIES})
  set(BAR_INCLUDE_DIRS ${PC_BAR_INCLUDE_DIRS})
else()
  message(FATAL_ERROR "Could not find PkgConfig module 'bar'")
endif()

add_executable(foo
  main.cpp
  ${BAR_LIBRARIES})

target_include_directories(foo
  PUBLIC ${BAR_INCLUDE_DIRS})

target_compile_options(foo
  PUBLIC "-O2 -Wall")

target_link_options(foo
  PUBLIC "-Wl,-rpath,-L/usr/local/lib")

外部ライブラリの CMake ファイルを使用する

多くの外部ライブラリは、CMake を使用してビルドするためのファイルを提供しています。これらのファイルは、add_library() コマンドを使用してライブラリをターゲットに追加し、target_link_libraries() コマンドを使用してターゲットにライブラリをリンクするのに役立ちます。

以下の例は、bar ライブラリの CMake ファイルを使用する方法を示しています。

set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

find_package(PkgConfig REQUIRED)

pkg_check_modules(PC_BAR QUIET bar)

if(PC_BAR_FOUND)
  set(BAR_CONFIG_CMAKE_FILE "${CMAKE_CURRENT_BINARY_DIR}/bar.cmake")

  # Generate bar.cmake file

  file(WRITE ${BAR_CONFIG_CMAKE_FILE}
    "# This file is generated by CMake

    include(${CMAKE_CURRENT_SOURCE_DIR}/bar/bar.cmake)
  ")

else()
  message(FATAL_ERROR "Could not find PkgConfig module 'bar'")
endif()

add_executable(foo
  main.cpp)

add_library(bar SHARED
  ${BAR_SOURCE_FILES})

target_link_libraries(foo
  PUBLIC bar)

set_target_properties(foo
  PROPERTIES
  IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG
  ${BAR_CONFIG_CMAKE_FILE})

CPack を使用する

CPack は、CMake で生成されたプロジェクトをパッケージ化するためのツールです。CPack を使用して、外部ライブラリのコンフィギュレーション情報を自動的にパッケージ化することができます。

以下の例は、CPack を使用して bar ライブラリをパッケージ化する方法を示しています。

set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

find_package(PkgConfig REQUIRED)

pkg_check_modules(PC_BAR QUIET bar)

if(PC_BAR_FOUND)
  set(BAR_LIBRARIES ${PC_BAR_LIBRARIES})
  set(BAR_INCLUDE_DIRS ${PC_BAR_INCLUDE_DIRS})
else()
  message(FATAL_ERROR "Could not find PkgConfig module 'bar'")
endif()

add_executable(foo
  main.cpp
  ${BAR_LIBRARIES})

target_include_directories(foo
  PUBLIC ${BAR_INCLUDE_DIRS})

set_target_properties(foo
  PROPERTIES
  CPack