[CMake] FetchContent: 외부 라이브러리를 사용하자~

💡 본 문서는 CMake로 환경을 build하는 중 외부의 필요한 라이브러리를 가져오는 FetchContent과정에 대해 자세히 설명합니다.

1. FetchContent

• FetchContent: 'configure time'에 외부 라이브러리를 가져옵니다(populating).
  • configure time: CMake를 실행하는 시점
• ExternalProject_Add(): 외부 라이브러리를 'build time'에 가져옵니다.
  • build time: makefile을 활용하여 make 하는 시점.
• the FetchContent module makes content available immediately, allowing the configure step to use the content in commands like add_subdirectory(), include() or file() operations.

1.1 FetchContent 정의: 외부 프로젝트의 저장소 정의

typical example of declaring content details for some dependencies

FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG        703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
)

then ensuring they are populated with a separate call: 외부 프로젝트 설정

• Default Population: performing the population using FetchContent_MakeAvailable()
• Costom Population: the lower level FetchContent_GetProperties() and FetchContent_Populate() commands can be used (하단 'FetchContent Custom Population' 참조)

 1.1.1 FetchContent Default Population: FetchContent_MakeAvailable

include(FetchContent)
FetchContent_Declare(
  <name>
  <contentOptions>...
  [OVERRIDE_FIND_PACKAGE |
   FIND_PACKAGE_ARGS args...]
)
FetchContent_MakeAvilable(<name>)

include(FetchContent)
FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG        703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
)
FetchContent_MakeAvailable(googletest)

• FetchContent_MakeAvailable : () 내부에 대소문자 허용

1.1.2 FetchContent Custom Population: FetchContent_Populate

Content population details should be defined separately from the command that performs the actual population.

# NOTE: Where possible, prefer to use FetchContent_MakeAvailable()
#       instead of custom logic like this

# Check if population has already been performed
FetchContent_GetProperties(${PROJECT_NAME})
if(NOT ${PROJECT_NAME}_POPULATED)
  # Fetch the content using previously declared details
  FetchContent_Populate(${PROJECT_NAME})

  # Set custom variables, policies, etc.
  # ...

  # Bring the populated content into the build
  add_subdirectory(${PROJECT_SOURCE_DIR} ${PROJECT_BINARY_DIR})
endif()

• FetchContent_GetProperties : () 내부에 소문자만 허용
• FetchContent_Populate(${PROJECT_NAME})을 하면 PROJECT_SOURCE_DIR, PROJECT_BINARY_DIR과 같은 변수도 생성해줍니다. 따라서 다음과 같은 변수를 이용하기 위해서는 MakeAvailable을 사용하면 안됩니다.

1.2 Example of FetchContent

message(STATUS "Fetching googletest...")
FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG        release-1.10.0 # GCC 5.0 미만을 사용하는 경우 is_trivially_copy_constructible 지원이 되지 않으므로 1.11.0 이후는 사용 불가
)
FetchContent_GetProperties(googletest)
if(NOT googletest_POPULATED)
  FetchContent_Populate(googletest)
  set(gtest_build_tests OFF CACHE BOOL "Enable gtest tests" FORCE)
  add_subdirectory(${googletest_SOURCE_DIR} ${googletest_BINARY_DIR} EXCLUDE_FROM_ALL)
endif()

• <name>_SOURCE_DIR: ./build/_deps/<name>-src"
• <name>_BINARY_DIR: ./build/_deps/<name>-build"
• EXCLUDE_FROM_ALL: /build/bin 폴더에 필요 없는 binary file 컴파일을 막기 위해서 FetchContent_MakeAvailable 대신에 FetchContent_GetProperties와 FetchContent_Populate를 사용해서 EXCLUDE_FROM_ALL 설정을 해주면 필요없는 파일을 생성하지 않는다. 

+ FetchContent를 통해 생성된 폴더 구조

• <name>_SOURCE_DIR: ${CMAKE_CURRENT_BINARY_DIR}/<lowercaseName>-src
  • ./build/_deps/<name>-src"
  • 외부 프로젝트의 저장소에 있는 전체 파일
• <name>_BINARY_DIR: ${CMAKE_CURRENT_BINARY_DIR}/<lowercaseName>-build
  • ./build/_deps/<name>-build"
  • 외부 프로젝트를 빌드해서 얻은 라이브러리 및 *.cpp를 컴파일한 *.o, *.o.d 파일들
• <name>_SUBBUILD_DIR: ${CMAKE_CURRENT_BINARY_DIR}/<lowercaseName>-subbuild
  • ./build/_deps/<name>-subbuild"

참고

• [Official CMake] FatchContent: https://cmake.org/cmake/help/latest/module/FetchContent.html#integrating-with-find-package
• cmake source usage #187: https://github.com/open-source-parsers/jsoncpp/issues/187
• [runebook] FetchContent: https://runebook.dev/ko/docs/cmake/module/fetchcontent
• 구글 테스트 툴을 이용한 UnitTest용 CMakefile: https://object-world.tistory.com/25