CMakeの add_imported_target と target_link_libraries コマンドを徹底解説

CMake の "Properties: Targets" における "IMPORTED_NO_SYSTEM" プロパティ

IMPORTED_NO_SYSTEM プロパティは、CMake において インポートされたターゲット が システムライブラリ でないことを指定するために使用されます。これは、ターゲットがシステムにデフォルトでインストールされているライブラリではなく、プロジェクト固有のライブラリであることを示します。

影響

このプロパティを設定すると、以下の影響が発生します。

• インクルードディレクトリの扱い: インポートされたターゲットの INTERFACE_INCLUDE_DIRECTORIES プロパティで指定されたディレクトリは、デフォルトでは システムインクルードディレクトリ として扱われます。しかし、IMPORTED_NO_SYSTEM プロパティを設定すると、これらのディレクトリはシステムインクルードディレクトリではなく、通常のインクルードディレクトリとして扱われます。これは、コンパイラがこれらのディレクトリを検索する順序に影響を与えます。
• インストール: install(EXPORT) コマンドや export() コマンドを使用してインポートされたターゲットをインストールする場合、IMPORTED_NO_SYSTEM プロパティが設定されていると、そのターゲットのインクルードディレクトリは システムインクルードディレクトリ としてインストールされません。

例

以下の例は、IMPORTED_NO_SYSTEM プロパティを使用して、インポートされたターゲットのインクルードディレクトリがシステムインクルードディレクトリとして扱われないようにする方法を示しています。

# インポートされたターゲット "foo" を定義します。
add_imported_target(foo SHARED $<TARGET_LOCATION:foo>)

# foo のインクルードディレクトリを指定します。
target_properties(foo PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${foo_include_dir}")

# foo がシステムライブラリではないことを指定します。
set_target_properties(foo PROPERTIES IMPORTED_NO_SYSTEM TRUE)

補足

• IMPORTED_NO_SYSTEM プロパティは、CMake 3.23 以降で使用できます。
• システムライブラリかどうか分からない場合は、IMPORTED_NO_SYSTEM プロパティを設定しないことをお勧めします。

CMake のサンプルコード

シンプルなプロジェクト

この例では、main.cpp という名前のソースコードファイルと、CMakeLists.txt という名前の CMakeLists ファイルを使用して、シンプルな実行ファイルを作成します。

// main.cpp
#include <iostream>

int main() {
  std::cout << "Hello, world!" << std::endl;
  return 0;
}

# CMakeLists.txt
cmake_minimum_required(VERSION 3.0)

project(hello_world)

add_executable(hello_world main.cpp)

このコードを実行するには、以下のコマンドを実行します。

cmake .
make

ライブラリを使用するプロジェクト

この例では、foo.h という名前のヘッダーファイルと foo.cpp という名前のソースコードファイルを使用して、ライブラリを作成します。次に、main.cpp という名前のソースコードファイルを使用して、ライブラリを使用する実行ファイルを作成します。

// foo.h
#ifndef FOO_H
#define FOO_H

int foo(int x);

#endif

// foo.cpp
#include "foo.h"

int foo(int x) {
  return x * x;
}

// main.cpp
#include <iostream>
#include "foo.h"

int main() {
  int x = 5;
  int y = foo(x);
  std::cout << "foo(" << x << ") = " << y << std::endl;
  return 0;
}

# CMakeLists.txt
cmake_minimum_required(VERSION 3.0)

project(hello_world)

add_library(foo foo.cpp foo.h)
target_link_directories(hello_world PUBLIC ${CMAKE_CURRENT_BINARY_DIR})

add_executable(hello_world main.cpp)
target_link_libraries(hello_world foo)

このコードを実行するには、以下のコマンドを実行します。

cmake .
make

サブディレクトリを含むプロジェクト

この例では、src ディレクトリに main.cpp という名前のソースコードファイルと CMakeLists.txt という名前の CMakeLists ファイルがあり、include ディレクトリに foo.h という名前のヘッダーファイルがあります。

// src/main.cpp
#include <iostream>
#include "foo.h"

int main() {
  int x = 5;
  int y = foo(x);
  std::cout << "foo(" << x << ") = " << y << std::endl;
  return 0;
}

# CMakeLists.txt
cmake_minimum_required(VERSION 3.0)

project(hello_world)

add_subdirectory(src)

# src/CMakeLists.txt
add_executable(hello_world main.cpp)
target_include_directories(hello_world PRIVATE include)

このコードを実行するには、以下のコマンドを実行します。

cmake .
make

インストール

この例では、foo.h という名前のヘッダーファイルと foo.cpp という名前のソースコードファイルを使用して、ライブラリを作成します。次に、ライブラリを DESTDIR ディレクトリにインストールします。

// foo.h
#ifndef FOO_H
#define FOO_H

int foo(int x);

#endif

// foo.cpp
#include "foo.h"

int foo(int x) {
  return x * x;
}

# CMakeLists.txt
cmake_minimum_required(VERSION 3.0)

project(hello_world)

add_library(foo foo.cpp foo.h)

install(TARGETS foo DESTDIR ${DESTDIR})
install(DIRECTORY include DESTDIR ${DESTDIR}/include)

このコードを実行するには、以下のコマンドを実行します。

cmake -DCMAKE_INSTALL_PREFIX=/path/to/install .
make
make install

クロスコンパイル

この例では、main.cpp という名前のソースコードファイルを使用して、クロスコンパイル可能な実行ファイルを作成

CMakeでターゲットをインポートする方法

add_imported_target コマンドを使用する

この方法は、CMakeLists.txtファイル内で、外部プロジェクトからビルドされたターゲットをインポートするために使用されます。

add_imported_target(target_name STATIC | SHARED | EXECUTABLE
  [GLOBAL]
  source_directory
  [<source_files>]
  [IMPORTED_TARGETS target_name ...]
  [PROPERTIES ...])

上記のコマンドの引数は以下の通りです。

• target_name: インポートするターゲットの名前
• STATIC, SHARED, EXECUTABLE: ターゲットの種類
• GLOBAL: オプション。このオプションを指定すると、インポートされたターゲットがグローバルスコープで利用可能になります。
• source_directory: ターゲットのソースディレクトリ
• <source_files>: オプション。ターゲットを構成するソースファイル
• IMPORTED_TARGETS: オプション。依存関係となる他のインポート済みターゲット

例

以下の例は、foo という名前のライブラリをインポートする方法を示しています。

add_imported_target(foo SHARED ${CMAKE_CURRENT_BINARY_DIR}/foo/libfoo.so)

target_link_libraries コマンドを使用する

この方法は、プロジェクト内のターゲットに別のターゲットをリンクするために使用されます。

target_link_libraries(target_name target1 target2 ...)

上記のコマンドの引数は以下の通りです。

• target1, target2: リンクするターゲット

例

以下の例は、main という名前の実行ファイルに foo というライブラリをリンクする方法を示しています。

target_link_libraries(main foo)

補足

• インポートするターゲットがCMakeLists.txtファイルと同じディレクトリにある場合は、source_directory 引数を省略できます。
• インポートするターゲットが静的ライブラリの場合は、IMPORTED_LINK_FLAGS プロパティを使用して、インポートするライブラリに必要なリンカフラグを指定できます。
• インポートするターゲットが共有ライブラリまたは実行ファイルの場合は、IMPORTED_LINK_LIBRARIES プロパティを使用して、インポートするターゲットに必要なライブラリを指定できます。

上記以外にも、CMakeでターゲットをインポートする方法はいくつかあります。詳細については、CMakeのドキュメントを参照してください。