CMake IMPORTED Target

Seongcheol Jeon·2024년 10월 9일

CMake IMPORTED cmake

CMake

목록 보기

14/17

IMPORTED Target

CMake 프로젝트 이외에서 작성된 기존 라이브러리와 독점 라이브러리로 소스 코드가 공개 되지 않은 라이브러리를 CMake 프로젝트에서 사용하고 싶은 경우가 있다.

이러한 라이브러리를 CMake의 타겟으로 취급하기 위한 구조가 바로 IMPORTED 타겟이다. (라이브러리뿐만 아니라 실행 파일을 IMPORTED 타겟으로 정의할 수 있다.)

이 밖에도 package-config.cmake를 작성할 때 설치 트리의 라이브러리 파일을 IMPORTED 대상으로 정의하는 용도도 있다. 엄밀히 말하면 install(EXPORT) 명령이 생성하는 export.cmake는 IMPORTED 타겟을 사용하고 있다.

IMPORTED 라이브러리 정의

add_library() 명령에 IMPORTED 옵션을 지정하면, 타겟을 IMPORTED 타겟으로 정의할 수 있다. 또한 일반적으로 의식 할 필요는 없지만 타겟 속성에 IMPORTED가 정의된다.

add_library(foo SHARED IMPORTED)

정확한 구문은 아래와 같다.

add_library(<name> <SHARED | STATIC | MODULE | UNKNOWN> IMPORTED [GLOBAL])

IMPORTED 타겟은 정의된 디렉토리나 그 아래의(즉, add_subdirectory) 디렉토리에서 찾을 수 있다. 상위 디렉토리에서 참조할 수 없다.
만약 상위 디렉토리에서 참조하려면, GLOBAL 옵션을 부여한다.

IMPORTED_LOCATION

라이브러리 파일의 위치 지정

add_library(... IMPORTED) 한 것만으로는 실제 라이브러리 파일의 위치를 CMake가 알 수 없기 때문에, 사용자가 명시적으로 라이브러리 파일의 위치를 CMake에 알려야 한다.

라이브러리 파일의 위치를 전달하려면, 다음과 같이 IMPORTED_LOCATION 속성을 설정한다.

// IMPORTED_LOCATION 설정

set_target_properties(
	foo PROPERTIES
    IMPORTED_LOCATION /path/to/library/libfoo.so
)

또한 DLL 환경에서 SHARED 라이브러리의 위치를 IMPORTED_LOCATION에 지정하는 경우에는 .lib 파일이 아닌 .dll 파일을 지정한다.
import 라이브러리(.lib) 파일의 위치는 IMPORTED_IMPLIB 또는 IMPORTED_IMPLIB_로 지정한다.

SONAME 지정 (IMPORTED_SONAME)

IMPORTED_SONAME 또는 IMPORTED_SONAME_ 속성을 사용하면 SONAME을 지정할 수 있다.

INTERFACE_INCLUDE_DIRECTORIES

클라이언트 타겟이 사용해야 할 include 디렉토리 지정

IMPORTED 라이브러리를 사용하는 프로그램을 컴파일 할 때, include 디렉토리에 존재하는 헤더 파일의 include를 요구하는 경우가 있다.

INTERFACE_INCLUDE_DIRECTORIES 속성을 지정하면, target_link_libraries(client foo) 같은 foo 라이브러리를 링크 지정하여 client 타겟에 target_include_directories에서 foo의 INTERFACE_INCLUDE_DIRECTORIES에서 지정한 디렉토리가 부여된다.

set_target_properties(foo PROPERTIES INTERFACE_INCLUDE_DIRECTORIES /path/to/foo/header)

// 다른 어딘가
add_executable(client client.cpp)
target_link_libraries(client foo)

// INTERFACE_INCLUDE_DIRECTORIES 속성으로 인하여 생략 가능
// target_include_directories(client /path/to/foo/headers)

이처럼 INTERFACE_INCLUDE_DIRECTORIES를 활용하면, /path/to/foo/headers 변수 foo_INCLUDE_DIRECTORIES로 설정하여 개별 대상에 target_include_directories 명령을 부여하는 번거로운 작업을 생략할 수 있다.

INTERFACE_COMPILE_DEFINITIONS

클라이언트 타겟이 사용해야 할 컴파일러 정의를 지정

이 라이브러리를 링크하는 실행 파일이나 다른 라이브러리를 컴파일 할 때 부여해야 할 컴파일러 정의를 지정한다.

IMPORTED 대상 이외에도 사용할 수 있지만, 이 경우 라이브러리 대상에 target_compile_definitions() 명령으로 지정할 때 PUBLIC 이나 INTERFACE 옵션을 부여하는 것으로, 이 속성이 자동으로 설정된다.

INTERFACE_COMPILE_OPTIONS

클라이언트 타겟이 사용해야 할 컴파일러 옵션 지정

이 라이브러리를 링크하는 실행 파일이나 다른 라이브러리를 컴파잉ㄹ 할 때, 부여해야 할 컴파일러 옵션을 지정한다. IMPORTED 타겟 이외에도 사용할 수 있다.
타겟이 IMPORTED 타겟이 아니면, target_compile_options 명령에 INTERFACE 또는 PUBLIC 옵션을 부여하여 자동으로 설정할 수 있다.