chore: modernise cmake (#287)

* use imported targets where possible also for the export * cmake: remove explicit definitions for downstream projects * increase minor version will be done for all projects using cmake-exports * remove --export-dynamic linker flag because it makes no sense for libs

chore: modernise cmake (#287)
b57f9dc9 · Dietrich Rothe · GitHub · adcb1fd0 · b57f9dc9 · b57f9dc9
Unverified Commit b57f9dc9 authored 2 years ago by Dietrich Rothe Committed by GitHub 2 years ago
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
 PROJECT(ChimeraTK-ApplicationCore)
-cmake_minimum_required(VERSION 2.8)
-
-include(cmake/add_dependency.cmake)
+cmake_minimum_required(VERSION 3.16)

 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules)

 set(${PROJECT_NAME}_MAJOR_VERSION 03)
-set(${PROJECT_NAME}_MINOR_VERSION 00)
-set(${PROJECT_NAME}_PATCH_VERSION 02)
+set(${PROJECT_NAME}_MINOR_VERSION 01)
+set(${PROJECT_NAME}_PATCH_VERSION 00)
 include(cmake/set_version_numbers.cmake)

 option(BUILD_TESTS "Build tests." ON)

 # Find the ControlSystemAdapter
-add_dependency(ChimeraTK-ControlSystemAdapter 02.04 REQUIRED)
+FIND_PACKAGE(ChimeraTK-ControlSystemAdapter 02.06 REQUIRED)

 # Find the DeviceAccess
-# Although all the linker flags are added again, the include path might be different
-# if the libraries are installed in different directories for development purposes.
-add_dependency(ChimeraTK-DeviceAccess 03.03 REQUIRED)
+FIND_PACKAGE(ChimeraTK-DeviceAccess 03.08 REQUIRED)

 # Find the XML parser library libxml++
 FIND_PACKAGE(PkgConfig REQUIRED)
 set(LIBXML++_VERSION "libxml++-2.6")
-PKG_CHECK_MODULES(LibXML++ REQUIRED ${LIBXML++_VERSION})
-PKG_CHECK_MODULES(glib REQUIRED glib-2.0)
-include_directories(SYSTEM ${glib_INCLUDE_DIRS} ${LibXML++_INCLUDE_DIRS})
+PKG_CHECK_MODULES(LibXML++ REQUIRED IMPORTED_TARGET ${LIBXML++_VERSION})
+PKG_CHECK_MODULES(glib REQUIRED IMPORTED_TARGET glib-2.0)

 # Find BOOST filesystem
-# Note: we need to search this after looking for the unit_test_framework, since we must not link against the
+# Note: we need to search this before looking for the unit_test_framework, since we must not link against the
 #       unit_test_framework library (use header-only)
 FIND_PACKAGE(Boost COMPONENTS filesystem date_time chrono system thread REQUIRED)

@@ -36,21 +31,16 @@ include(cmake/set_default_build_to_release.cmake)
 include(cmake/set_default_flags.cmake)
 include(cmake/enable_code_coverage_report.cmake)

-# linker flags
-if(NOT APPLE)
-  set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--export-dynamic")
-endif()
-set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${ChimeraTK-ControlSystemAdapter_LINK_FLAGS}")
-
 include_directories(${CMAKE_SOURCE_DIR}/include)
 file(GLOB headers "${CMAKE_SOURCE_DIR}/include/*.h")
-set(${PROJECT_NAME}_INCLUDE_DIRS ${${PROJECT_NAME}_INCLUDE_DIRS} ${CMAKE_SOURCE_DIR}/include/ ${CMAKE_SOURCE_DIR}/Modules/include/)
 aux_source_directory(${CMAKE_SOURCE_DIR}/src library_sources)
+set(${PROJECT_NAME}_INCLUDE_DIRS ${${PROJECT_NAME}_INCLUDE_DIRS} ${CMAKE_SOURCE_DIR}/include/ )

 # add generic modules
 include_directories(${CMAKE_SOURCE_DIR}/Modules/include)
 file(GLOB module_headers "${CMAKE_SOURCE_DIR}/Modules/include/*.h")
-aux_source_directory(${CMAKE_SOURCE_DIR}/Modules/src library_sources)
+set(${PROJECT_NAME}_INCLUDE_DIRS ${${PROJECT_NAME}_INCLUDE_DIRS} ${CMAKE_SOURCE_DIR}/Modules/include/)
+aux_source_directory(${CMAKE_SOURCE_DIR}/Modules/src library_module_sources)

 MACRO( COPY_MAPPING_FILES )
  foreach( FILE_TO_COPY test.xlmap test.dmap )
@@ -66,16 +56,16 @@ if(BUILD_TESTS)
 endif()

 # C++ library
-add_library(${PROJECT_NAME} SHARED ${library_sources} ${headers} ${module_headers})
+add_library(${PROJECT_NAME} SHARED ${library_sources} ${library_module_sources} ${headers} ${module_headers})
 set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${${PROJECT_NAME}_FULL_LIBRARY_VERSION}
                                                 SOVERSION ${${PROJECT_NAME}_SOVERSION})
-set_target_properties(${PROJECT_NAME} PROPERTIES LINK_FLAGS "${ChimeraTK-ControlSystemAdapter_LINK_FLAGS}")
-target_link_libraries(${PROJECT_NAME} ${ChimeraTK-ControlSystemAdapter_LIBRARIES}
-                                      ${Boost_LIBRARIES}
-                                      pthread
-                                      ${LibXML++_LIBRARIES}
-                                      ${glib_LIBRARIES}
-                                      ${HDF5_LIBRARIES})
+# exported includes are all under ${CMAKE_INSTALL_PREFIX}/include
+target_include_directories(${PROJECT_NAME} INTERFACE "$<INSTALL_INTERFACE:include>")
+target_link_libraries(${PROJECT_NAME} 
+    # put ControlSystemAdapter public since implicit dep DeviceAccess must be public
+    PUBLIC ChimeraTK::ChimeraTK-ControlSystemAdapter
+    PUBLIC ${Boost_LIBRARIES}
+    PRIVATE pthread PkgConfig::LibXML++ PkgConfig::glib ${HDF5_LIBRARIES})

 # do not remove runtime path of the library when installing
 set_property(TARGET ${PROJECT_NAME} PROPERTY INSTALL_RPATH_USE_LINK_PATH TRUE)
@@ -87,7 +77,10 @@ include(cmake/enable_doxygen_documentation.cmake)
 include(cmake/enable_code_style_check.cmake)

 # Install the library and the executables
-install( TARGETS ${PROJECT_NAME} RUNTIME DESTINATION bin LIBRARY DESTINATION lib )
+install( TARGETS ${PROJECT_NAME} 
+    EXPORT ${PROJECT_NAME}Targets
+    RUNTIME DESTINATION bin 
+    LIBRARY DESTINATION lib )

 # all include files go into include/PROJECT_NAME
 # The exclusion of ${PROJECT_NAME} prevents the recursive installation of the files just being installed.
@@ -97,11 +90,8 @@ install(DIRECTORY ${${PROJECT_NAME}_INCLUDE_DIRS} DESTINATION include/ChimeraTK/
                                                                 PATTERN ".svn" EXCLUDE
                                                                 PATTERN "${PROJECT_NAME}" EXCLUDE)

-set(${PROJECT_NAME}_INCLUDE_DIRS "${CMAKE_INSTALL_PREFIX}/include")
-set(${PROJECT_NAME}_LIBRARIES "${ChimeraTK-ControlSystemAdapter_LIBRARIES}")
-set(${PROJECT_NAME}_LIBRARY_DIRS "${CMAKE_INSTALL_PREFIX}/lib")
-set(${PROJECT_NAME}_CXX_FLAGS "${ChimeraTK-ControlSystemAdapter_CXX_FLAGS}")
-set(${PROJECT_NAME}_LINK_FLAGS "${ChimeraTK-ControlSystemAdapter_LINK_FLAGS}")
-
-list(APPEND ${PROJECT_NAME}_PUBLIC_DEPENDENCIES "Boost COMPONENTS system thread chrono filesystem date_time atomic")
+# we need the public dependencies so create_cmake_config_files can find them as implicit dependencies
+list(APPEND ${PROJECT_NAME}_PUBLIC_DEPENDENCIES "Boost COMPONENTS system thread chrono filesystem date_time;ChimeraTK-ControlSystemAdapter")
+# we support our cmake EXPORTS as imported targets
+set(PROVIDES_EXPORTED_TARGETS 1)
 include(${CMAKE_SOURCE_DIR}/cmake/create_cmake_config_files.cmake)
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -8,8 +8,8 @@ foreach( testExecutableSrcFile ${testExecutables})
  get_filename_component(executableName ${testExecutableSrcFile} NAME_WE)
  add_executable(${executableName} ${testExecutableSrcFile} ${test_headers})
  # do not link against the boost unit test library, the tests are not written for it!
-  target_link_libraries(${executableName} ${PROJECT_NAME} ${ChimeraTK-ControlSystemAdapter_LIBRARIES} ${HDF5_LIBRARIES})
-  set_target_properties(${executableName} PROPERTIES LINK_FLAGS "-Wl,-rpath,${PROJECT_BINARY_DIR} ${Boost_LINK_FLAGS} ${ChimeraTK-ControlSystemAdapter_LINK_FLAGS}")
+  target_link_libraries(${executableName} 
+    PRIVATE ${PROJECT_NAME} ChimeraTK::ChimeraTK-ControlSystemAdapter PkgConfig::LibXML++ ${HDF5_LIBRARIES})
  add_test(${executableName} ${executableName})
 endforeach( testExecutableSrcFile )