如何为"boost-like"多组件库编写 cmake 模块?

How to write cmake modules for "boost-like" multi-component library?

本文关键字:cmake 模块 组件 boost-like      更新时间:2023-10-16

我目前正在编写一个 c++ 库,它有几个"子库",例如 boost 库。

让我们将库命名为"TestLib",将子库命名为"Base"和"Ext",其中 Base 包含基本的东西,不依赖于任何其他子库。但是,Ext 取决于某些 Base 类。

每个"子库"都应该编译成一个单独的.a或.so文件,但它们都应该共享一个命名空间(TestLib)。 现在我的目标是编写干净的 cmake 脚本来实现这一目标。

最后,我希望能够在cmake中做这样的事情:

find_package(TestLib 0.1 REQUIRED COMPONENTS Base Ext)

target_link_libraries(someapplication
PUBLIC
TestLib::Base
)

我将每个"子库"放在一个单独的 git 存储库中,并将它们作为子模块添加到只有一个 CMakeList 的新存储库中.txt 这只是在每个存储库上调用add_subdirectory。

我实现的大部分 cmake 东西,我从这个很棒的教程中得到的 https://pabloariasal.github.io/

基本部分按预期工作(这不足为奇,因为它不依赖于其他任何东西)。

但我的问题来自 Ext 部分。为了编译它,我必须链接到 Base 库,这不应该很难,并且经过一些试验和错误,我相信我会让它工作。

但我想以正确的方式去做。

我的方法是

find_package(TestLib COMPONENTS Base)

在 testLib.Ext 的 CMakeLists.txt 中。 但是这找不到,因为它没有TestLibConfig.cmake。

这是有道理的,但我不知道在这个文件中放什么。

我试图提供一些准确描述我的问题的代码,但由于这在这里发布太多了,我为此目的创建了一个 github:

https://github.com/PowerSupplyTopologies/TestLib

这应该包含所有相关代码。

这对你们中的一些人来说可能是微不足道的,但我敢打赌,有更多的人可以从这种方法中受益。

提前感谢您的任何想法。

编辑:

在 CMakeLists.txt of Base 中创建的库是:

set(TARGET_NAME testlibbase)
add_library(${TARGET_NAME}
src/ClassA.cpp
src/ClassB.cpp
)
#Add an alias so that library can be used inside the build tree, e.g.     when testing
add_library(TestLib::${TARGET_NAME} ALIAS ${TARGET_NAME})

set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/TestLib)
install(TARGETS ${TARGET_NAME}
EXPORT ${TARGET_NAME}-targets
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
)
#This is required so that the exported target has the name JSONUtils and not  jsonutils
set_target_properties(${TARGET_NAME} PROPERTIES EXPORT_NAME Base)
install(DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
#Export the targets to a script
install(EXPORT ${TARGET_NAME}-targets
FILE
TestLibBaseTargets.cmake
NAMESPACE
TestLib::
DESTINATION
${INSTALL_CONFIGDIR}
)
#Create a ConfigVersion.cmake file
include(CMakePackageConfigHelpers)
write_basic_package_version_file(
${CMAKE_CURRENT_BINARY_DIR}/TestLibBaseConfigVersion.cmake
VERSION ${PROJECT_VERSION}
COMPATIBILITY AnyNewerVersion
)
configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/cmake  /TestLibBaseConfig.cmake.in
${CMAKE_CURRENT_BINARY_DIR}/TestLibBaseConfig.cmake
INSTALL_DESTINATION ${INSTALL_CONFIGDIR}
)
#Install the config, configversion and custom find modules
install(FILES
${CMAKE_CURRENT_BINARY_DIR}/TestLibBaseConfig.cmake
${CMAKE_CURRENT_BINARY_DIR}/TestLibBaseConfigVersion.cmake
DESTINATION ${INSTALL_CONFIGDIR}
)
##############################################
## Exporting from the build tree
export(EXPORT ${TARGET_NAME}-targets FILE ${CMAKE_CURRENT_BINARY_DIR}/TestLibBaseTargets.cmake NAMESPACE TestLib::)

和分机:

set(TARGET_NAME testlibext)
add_library(${TARGET_NAME}
src/ClassC.cpp
)
#Add an alias so that library can be used inside the build tree, e.g. when   testing
add_library(TestLib::${TARGET_NAME} ALIAS ${TARGET_NAME})

在你的元项目 TestLib 中,你可以创建一个 TestLibConfig.cmake 文件,如 CMake 文档中所述。

TestLibConfig.cmake

set(_supported_components Base Ext)
foreach(_comp ${Test_FIND_COMPONENTS})
if (NOT ";${_supported_components};" MATCHES _comp)
set(TestLib_FOUND False)
set(TestLib_NOT_FOUND_MESSAGE "Unsupported component: ${_comp}")
endif()
include("${CMAKE_CURRENT_LIST_DIR}/TestLib${_comp}Targets.cmake")
endforeach()

参考: https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#creating-a-package-configuration-file