CMakeで他のCMakeプロジェクトによって生成されたオブジェクトファイルを使用する

CMake の IMPORTED_OBJECTS プロパティ

IMPORTED_OBJECTS プロパティは、外部で生成されたオブジェクトファイルを CMake プロジェクトに組み込むための機能です。これは、サードパーティ製のライブラリや、他の CMake プロジェクトによって生成されたオブジェクトファイルを使用する場合に役立ちます。

設定方法

IMPORTED_OBJECTS プロパティは、target_properties() コマンドを使用して、ターゲットに設定します。以下の例は、my_library という名前のターゲットに、object1.o と object2.o という名前のオブジェクトファイルを組み込む方法を示しています。

target_properties(my_library PROPERTIES IMPORTED_OBJECTS object1.o object2.o)

オブジェクトファイルの場所

IMPORTED_OBJECTS プロパティで指定されたオブジェクトファイルは、プロジェクトのソースツリー内または外部に存在することができます。オブジェクトファイルがプロジェクトのソースツリー内に存在する場合は、相対パスで指定できます。オブジェクトファイルが外部に存在する場合は、絶対パスで指定する必要があります。

オブジェクトファイルの属性

IMPORTED_OBJECTS プロパティで指定されたオブジェクトファイルには、以下の属性を設定することができます。

• INTERFACE_COMPILE_OPTIONS: オブジェクトファイルのコンパイル時に使用されたオプションを指定します。
• INTERFACE_INCLUDE_DIRECTORIES: オブジェクトファイルのコンパイル時に使用されたインクルードディレクトリを指定します。
• INTERFACE_LINK_LIBRARIES: オブジェクトファイルのリンク時に使用されたライブラリを指定します。

使用例

以下は、IMPORTED_OBJECTS プロパティを使用する例です。

例 1: サードパーティ製のライブラリを使用する

# サードパーティ製のライブラリのヘッダーファイルをインクルードする
include_directories(${CMAKE_SOURCE_DIR}/thirdparty/my_library/include)

# サードパーティ製のライブラリのオブジェクトファイルをリンクする
target_link_libraries(my_executable PRIVATE ${CMAKE_SOURCE_DIR}/thirdparty/my_library/libmy_library.a)

# サードパーティ製のライブラリのオブジェクトファイルの属性を設定する
target_properties(my_executable PROPERTIES 
    INTERFACE_COMPILE_OPTIONS "-DUSE_MY_LIBRARY"
    INTERFACE_LINK_LIBRARIES "-Wl,-rpath,${CMAKE_SOURCE_DIR}/thirdparty/my_library/lib")

例 2: 他の CMake プロジェクトによって生成されたオブジェクトファイルを使用する

# 他の CMake プロジェクトのビルドディレクトリを指定する
set(OTHER_PROJECT_BUILD_DIR ${CMAKE_BINARY_DIR}/other_project)

# 他の CMake プロジェクトによって生成されたオブジェクトファイルを組み込む
target_properties(my_executable PROPERTIES IMPORTED_OBJECTS 
    ${OTHER_PROJECT_BUILD_DIR}/libmy_library.a)

# 他の CMake プロジェクトによって生成されたオブジェクトファイルの属性を設定する
target_properties(my_executable PROPERTIES 
    INTERFACE_COMPILE_OPTIONS "-DUSE_MY_LIBRARY"
    INTERFACE_LINK_LIBRARIES "-Wl,-rpath,${OTHER_PROJECT_BUILD_DIR}/lib")

注意事項

• IMPORTED_OBJECTS プロパティは、CMake バージョン 3.14 以降でサポートされています。
• IMPORTED_OBJECTS プロパティで指定されたオブジェクトファイルは、プロジェクトのビルドツリーにコピーされません。
• IMPORTED_OBJECTS プロパティで指定されたオブジェクトファイルは、プロジェクトのインストール時にインストールされません。

CMake の IMPORTED_OBJECTS プロパティを使用したサンプルコード

サードパーティ製ライブラリを使用する

# サードパーティ製ライブラリのヘッダーファイルをインクルードする
include_directories(${CMAKE_SOURCE_DIR}/thirdparty/my_library/include)

# サードパーティ製ライブラリのオブジェクトファイルをリンクする
target_link_libraries(my_executable PRIVATE ${CMAKE_SOURCE_DIR}/thirdparty/my_library/libmy_library.a)

# サードパーティ製ライブラリのオブジェクトファイルの属性を設定する
target_properties(my_executable PROPERTIES 
    INTERFACE_COMPILE_OPTIONS "-DUSE_MY_LIBRARY"
    INTERFACE_LINK_LIBRARIES "-Wl,-rpath,${CMAKE_SOURCE_DIR}/thirdparty/my_library/lib")

この例では、my_library という名前のサードパーティ製ライブラリを使用しています。

• include_directories() コマンドを使用して、サードパーティ製ライブラリのヘッダーファイルがインクルードされるように設定しています。
• target_link_libraries() コマンドを使用して、サードパーティ製ライブラリのオブジェクトファイルがリンクされるように設定しています。
• target_properties() コマンドを使用して、サードパーティ製ライブラリのオブジェクトファイルの属性を設定しています。

属性

• INTERFACE_COMPILE_OPTIONS:** オブジェクトファイルのコンパイル時に使用されたオプションを指定します。この例では、-DUSE_MY_LIBRARYオプションを指定して、my_library` ライブラリが使用されていることをコンパイラに指示しています。
• INTERFACE_LINK_LIBRARIES:** オブジェクトファイルのリンク時に使用されたライブラリを指定します。この例では、-Wl,-rpath,${CMAKE_SOURCE_DIR}/thirdparty/my_library/libオプションを指定して、リンカーがmy_library` ライブラリを見つける場所を指示しています。

他の CMake プロジェクトによって生成されたオブジェクトファイルを使用する

# 他の CMake プロジェクトのビルドディレクトリを指定する
set(OTHER_PROJECT_BUILD_DIR ${CMAKE_BINARY_DIR}/other_project)

# 他の CMake プロジェクトによって生成されたオブジェクトファイルを組み込む
target_properties(my_executable PROPERTIES IMPORTED_OBJECTS 
    ${OTHER_PROJECT_BUILD_DIR}/libmy_library.a)

# 他の CMake プロジェクトによって生成されたオブジェクトファイルの属性を設定する
target_properties(my_executable PROPERTIES 
    INTERFACE_COMPILE_OPTIONS "-DUSE_MY_LIBRARY"
    INTERFACE_LINK_LIBRARIES "-Wl,-rpath,${OTHER_PROJECT_BUILD_DIR}/lib")

説明

この例では、other_project という名前の別の CMake プロジェクトによって生成されたオブジェクトファイルを使用しています。

• set() コマンドを使用して、OTHER_PROJECT_BUILD_DIR 変数に、other_project プロジェクトのビルドディレクトリを設定しています。
• target_properties() コマンドを使用して、other_project プロジェクトによって生成されたオブジェクトファイル libmy_library.a を my_executable ターゲットに組み込んでいます。
• target_properties() コマンドを使用して、other_project プロジェクトによって生成されたオブジェクトファイルの属性を設定しています。

属性

• INTERFACE_COMPILE_OPTIONS:** オブジェクトファイルのコンパイル時に使用されたオプションを指定します。この例では、-DUSE_MY_LIBRARYオプションを指定して、my_library` ライブラリが使用されていることをコンパイラに指示しています。
• INTERFACE_LINK_LIBRARIES:** オブジェクトファイルのリンク時に使用されたライブラリを指定します。この例では、-Wl,-rpath,${OTHER_PROJECT_BUILD_DIR}/libオプションを指定して、リンカーがmy_library` ライブラリを見つける場所を指示しています。

この URL には、IMPORTED_OBJECTS プロパティを使用したさまざまなサンプルコードがあります。

CMake で外部オブジェクトファイルを扱うその他の方法

サードパーティ製ライブラリの場合

サードパーティ製ライブラリの CMake プロジェクトを使用する

多くのサードパーティ製ライブラリは、CMake プロジェクトファイルを提供しています。これらのプロジェクトファイルを使用すると、サードパーティ製ライブラリを CMake プロジェクトに簡単に組み込むことができます。

例:

add_subdirectory(${CMAKE_SOURCE_DIR}/thirdparty/my_library)

target_link_libraries(my_executable PRIVATE my_library)

サードパーティ製ライブラリのバイナリパッケージを使用する

多くのサードパーティ製ライブラリは、バイナリパッケージとして提供されています。バイナリパッケージを使用すると、CMake プロジェクトファイルを変更することなく、サードパーティ製ライブラリをプロジェクトに組み込むことができます。

例:

find_package(my_library REQUIRED)

target_link_libraries(my_executable PRIVATE my_library::my_library)

他の CMake プロジェクトによって生成されたオブジェクトファイルの場合

add_custom_command() コマンドを使用して、他の CMake プロジェクトによって生成されたオブジェクトファイルをプロジェクトに組み込むことができます。

例:

add_custom_command(
    OUTPUT ${CMAKE_BINARY_DIR}/libmy_library.a
    COMMAND ${CMAKE_COMMAND} -E make -C ${OTHER_PROJECT_BUILD_DIR}
    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
)

target_link_libraries(my_executable PRIVATE ${CMAKE_BINARY_DIR}/libmy_library.a)

add_custom_target() コマンドを使用して、他の CMake プロジェクトによって生成されたオブジェクトファイルをプロジェクトに組み込むことができます。

例:

add_custom_target(my_library
    COMMAND ${CMAKE_COMMAND} -E make -C ${OTHER_PROJECT_BUILD_DIR}
    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
)

add_dependencies(my_executable my_library)

target_link_libraries(my_executable PRIVATE ${OTHER_PROJECT_BUILD_DIR}/libmy_library.a)

その他の方法

上記以外にも、以下の方法で外部オブジェクトファイルを扱うことができます。

• ExternalProject モジュールを使用する
• FetchContent モジュールを使用する
• サードパーティ製のビルドツールを使用する

• サードパーティ製ライブラリの CMake プロジェクトファイルが提供されている場合は、そのプロジェクトファイルを使用するのが最も簡単です。
• サードパーティ製ライブラリのバイナリパッケージが提供されている場合は、バイナリパッケージを使用するのが最も簡単です。
• 他の CMake プロジェクトによって生成されたオブジェクトファイルの場合は、add_custom_command() コマンドまたは add_custom_target() コマンドを使用するのが一般的です。

IMPORTED_OBJECTS プロパティは、外部オブジェクトファイルを CMake プロジェクトに組み込むための便利な方法ですが、他にもいくつかの方法があります。どの方法を選択するべきかは、状況によって異なります。