[CMake] configure_file(): CMake 변수값을 소스코드에서 사용!

💡 본 문서는 'CMake 변수값을 소스코드에서 사용하는 방법'에 대해 정리해놓은 글입니다.
configure_file을 통해 CMake 변수값을 소스코드에서 사용하는 방법에 대해 정리하였으니 참고하시기 바랍니다.

1. 프로젝트 구성

1.1 CMakeLists.txt 파일: configure_file 사용

CMakeLists.txt에서 설정한 변수값을 소스파일에서도 사용하기 위한 configure_file 함수를 사용하는 방법은 다음과 같습니다!
차근차근 CMakeLists.txt을 왜 이렇게 작성했는지, 소스에 대해 설명해드리겠습니다. 

...
option(USING_NLOHMANNJSON "using nlohmann_json" ON)
option(USING_LEVELDB "using leveldb" ON)

# configure a header file to pass some of the CMake settings to the source code
configure_file(config.h.cmake ${PROJECT_BINARY_DIR}/include/config.h)

add_library(${PROJECT_NAME})
target_include_directories(${PROJECT_NAME}
  PUBLIC
    ${PROJECT_BINARY_DIR}/include
    ...
)
...

+ configure_file()

configure_file 명령어는 어떠한 파일을 다른 위치에 복사하거나 CMake 변수값들을 파일에 쓸 수 있도록 할 수 있습니다.

# configure a header file to pass some of the CMake settings
# to the source code
configure_file(config.h.cmake ${PROJECT_BINARY_DIR}/include/config.h)

• 첫 번째 argument는 소스가 되는 파일이며,
• 두 번째 argument는 결과물의 파일명입니다.
  (절대경로가 아닌 파일명만 입력하면, 현재 CMakeLists.txt가 존재하는 경로를 기준으로 상대경로로 인식하게 됩니다.)

1.2 config.h.cmake 또는 config.h.in 파일 만들기

생성할 헤더파일의 포맷이 되는 파일인 config.h.cmake이나 config.h.in를 정의해주어야 합니다. 참고로, 두 파일은 확장자만 다를 뿐 동일한 소스로 구성되어 있습니다!

// the configured options and settings for Tutorial
#define VERSION_MAJOR @VERSION_MAJOR@
#define VERSION_MINOR @VERSION_MINOR@

• define을 통해서 Tutorial_VERSION_MAJOR와 Tutorial_VERSION_MINOR를 정의해주는데 이 값은 CMake에서 정의된 버전 변수명으로 접근하고 있습니다. 
• CMake 변수에 접근하기 위해서 변수명의 양 끝을 '@'로 감싸주면 되는데, '@'로 감싸주게 되면 configure_file을 통해서 파일이 copy될 때, 해당 변수의 값으로 대체되게 됩니다.
  • 따라서, CMake 내에서 option이나 set으로 변수를 정의한 후에 configure_file 명령어를 통해 설정 파일을 생성해야 생성된 파일에 반영됩니다!
  • option(USING_NLOHMANNJSON "using nlohmann_json" ON)
    option(USING_LEVELDB "using leveldb" ON)
    configure_file("config.h.cmake" ${PROJECT_BINARY_DIR}/include/piclUtilCfg.h)

2. 프로젝트 빌드

cmake ..으로 빌드파일을 생성하면, ${PROJECT_BINARY_DIR}인 build 폴더 내 include/piclUtilCfg.h파일이 생긴 것을 확인할 수 있습니다.

생성된 헤더파일 사용하기

이렇게 생성된 헤더파일을 우리가 생성할 실행파일(즉, 소스코드)에서 사용하려면, 

• add_library 명령어를 통해 라이브러리를 만들고,
• target_include_directories 명령어를 통해서 include 시켜주어야 합니다.

add_library(${PROJECT_NAME})
target_include_directories(${PROJECT_NAME}
  PUBLIC
    ${PROJECT_BINARY_DIR}/include
    ...
)

참고

• [Blog] Tutorial (1) - Start CMake: https://junstar92.tistory.com/204