CMake: Install Blosc2Config.cmake

This adds a CMake installer to conserve targets and properties on install, so CMake users do not need to write `FindBlosc2.cmake` files anymore. This also helps to preserve transitive dependencies on CMake targets, especially useful for fully static builds, e.g., for Python wheels.
Blosc · Jul 26, 2023 · 04c4b6b · 04c4b6b
1 parent 2714de0
commit 04c4b6b
Show file tree

Hide file tree

Showing 6 changed files with 337 additions and 136 deletions.
diff --git a/Blosc2Config.cmake.in b/Blosc2Config.cmake.in
@@ -0,0 +1,56 @@
+# only add PUBLIC dependencies as well
+#   https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#creating-a-package-configuration-file
+include(CMakeFindDependencyMacro)
+
+# Search in <PackageName>_ROOT:
+#   https://cmake.org/cmake/help/v3.12/policy/CMP0074.html
+if(POLICY CMP0074)
+    cmake_policy(SET CMP0074 NEW)
+endif()
+
+# locate the installed FindABC.cmake modules
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
+
+# optional dependencies
+set(HAVE_ZLIB_NG @HAVE_ZLIB_NG@)
+set(DEACTIVATE_ZLIB @DEACTIVATE_ZLIB@)
+set(DEACTIVATE_ZSTD @DEACTIVATE_ZSTD@)
+set(PREFER_EXTERNAL_LZ4 @PREFER_EXTERNAL_LZ4@)
+set(PREFER_EXTERNAL_ZLIB @PREFER_EXTERNAL_ZLIB@)
+set(PREFER_EXTERNAL_ZSTD @PREFER_EXTERNAL_ZSTD@)
+
+if(PREFER_EXTERNAL_LZ4)
+    find_dependency(LZ4)
+endif()
+set(Blosc2_LZ4_FOUND TRUE)
+
+if(DEACTIVATE_ZLIB)
+    set(Blosc2_ZLIB_FOUND FALSE)
+elseif(NOT DEACTIVATE_ZLIB AND PREFER_EXTERNAL_ZLIB)
+    if(HAVE_ZLIB_NG)
+        find_dependency(ZLIB_NG)
+    else()
+        find_dependency(ZLIB)
+    endif()
+    set(Blosc2_ZLIB_FOUND TRUE)
+endif()
+
+if(DEACTIVATE_ZSTD)
+    set(Blosc2_ZSTD_FOUND FALSE)
+elseif(NOT PREFER_EXTERNAL_ZSTD AND PREFER_EXTERNAL_ZSTD)
+    find_dependency(ZSTD)
+    set(Blosc2_ZSTD_FOUND TRUE)
+endif()
+
+# define central Blosc2::blosc2_shared/static targets
+include("${CMAKE_CURRENT_LIST_DIR}/Blosc2Targets.cmake")
+
+# check if components are fulfilled and set Blosc2_<COMPONENT>_FOUND vars
+foreach(comp ${Blosc2_FIND_COMPONENTS})
+    if(NOT Blosc2_${comp}_FOUND)
+        if(Blosc2_FIND_REQUIRED_${comp})
+            set(Blosc2_FOUND FALSE)
+        endif()
+    endif()
+endforeach()
+
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -84,15 +84,15 @@ endif()
 project(blosc LANGUAGES C ASM)
 
 # parse the full version numbers from blosc2.h
-file(READ include/blosc2.h _blosc2_h_contents)
+file(READ include/blosc2.h _Blosc2_h_contents)
 string(REGEX REPLACE ".*#define[ \t]+BLOSC2_VERSION_MAJOR[ \t]+([0-9]+).*"
-    "\\1" BLOSC2_VERSION_MAJOR ${_blosc2_h_contents})
+    "\\1" BLOSC2_VERSION_MAJOR ${_Blosc2_h_contents})
 string(REGEX REPLACE ".*#define[ \t]+BLOSC2_VERSION_MINOR[ \t]+([0-9]+).*"
-    "\\1" BLOSC2_VERSION_MINOR ${_blosc2_h_contents})
+    "\\1" BLOSC2_VERSION_MINOR ${_Blosc2_h_contents})
 string(REGEX REPLACE ".*#define[ \t]+BLOSC2_VERSION_RELEASE[ \t]+([0-9]+).*"
-    "\\1" BLOSC2_VERSION_PATCH ${_blosc2_h_contents})
+    "\\1" BLOSC2_VERSION_PATCH ${_Blosc2_h_contents})
 string(REGEX REPLACE ".*#define[ \t]+BLOSC2_VERSION_STRING[ \t]+\"([-0-9A-Za-z.]+)\".*"
-    "\\1" BLOSC2_VERSION_STRING ${_blosc2_h_contents})
+    "\\1" BLOSC2_VERSION_STRING ${_Blosc2_h_contents})
 
 message("Configuring for Blosc version: " ${BLOSC2_VERSION_STRING})
 
@@ -385,23 +385,6 @@ if(NOT DEFINED BLOSC_INSTALL)
     endif()
 endif()
 
-# uninstall target
-if(BLOSC_INSTALL)
-    include(GNUInstallDirs)
-    configure_file(
-         "${CMAKE_CURRENT_SOURCE_DIR}/blosc2.pc.in"
-         "${CMAKE_CURRENT_BINARY_DIR}/blosc2.pc"
-         @ONLY)
-    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/blosc2.pc"
-            DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig" COMPONENT DEV)
-    configure_file(
-        "${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in"
-        "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
-        @ONLY)
-    add_custom_target(uninstall
-        COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
-endif()
-
 # include directories
 include_directories(include)
 if(BUILD_PLUGINS)
@@ -440,6 +423,115 @@ if(BUILD_EXAMPLES)
     add_subdirectory(examples)
 endif()
 
+# collecting SOURCES is now complete
+if(BUILD_SHARED)
+    target_sources(blosc2_shared PRIVATE ${SOURCES})
+endif()
+if(BUILD_STATIC)
+    target_sources(blosc2_static PRIVATE ${SOURCES})
+endif()
+if(BUILD_TESTS)
+    target_sources(blosc_testing PRIVATE ${SOURCES})
+endif()
+
+# install targets
+if(BLOSC_INSTALL)
+    include(GNUInstallDirs)
+
+    # C++ files
+    install(FILES ${PROJECT_SOURCE_DIR}/include/blosc2.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} COMPONENT DEV)
+    install(FILES ${PROJECT_SOURCE_DIR}/include/b2nd.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} COMPONENT DEV)
+    install(FILES
+            ${PROJECT_SOURCE_DIR}/include/blosc2/blosc2-export.h
+            ${PROJECT_SOURCE_DIR}/include/blosc2/blosc2-common.h
+            ${PROJECT_SOURCE_DIR}/include/blosc2/blosc2-stdio.h
+            DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/blosc2 COMPONENT DEV)
+    if(BUILD_PLUGINS)
+        install(FILES
+                ${PROJECT_SOURCE_DIR}/include/blosc2/filters-registry.h
+                ${PROJECT_SOURCE_DIR}/include/blosc2/codecs-registry.h
+                ${PROJECT_SOURCE_DIR}/include/blosc2/tuners-registry.h
+                DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/blosc2 COMPONENT DEV)
+    endif()
+
+    if(BUILD_SHARED)
+        install(TARGETS blosc2_shared
+                LIBRARY COMPONENT LIB
+                ARCHIVE COMPONENT DEV
+                RUNTIME COMPONENT LIB)
+    endif()
+    if(BUILD_STATIC)
+        install(TARGETS blosc2_static COMPONENT DEV)
+    endif()
+
+    # config files
+    include(CMakePackageConfigHelpers)
+
+    if(NOT Blosc2_INSTALL_CMAKEDIR)
+        if(CMAKE_INSTALL_CMAKEDIR)
+            set(Blosc2_INSTALL_CMAKEDIR "${CMAKE_INSTALL_CMAKEDIR}/Blosc2")
+        else()
+            if(WIN32)
+                set(Blosc2_INSTALL_CMAKEDIR "cmake")
+            else()
+                set(Blosc2_INSTALL_CMAKEDIR "${CMAKE_INSTALL_LIBDIR}/cmake/Blosc2")
+            endif()
+        endif()
+    endif()
+
+    # CMake config file
+    set(Blosc2_INSTALL_TARGET_NAMES)
+    if(BUILD_SHARED)
+        list(APPEND Blosc2_INSTALL_TARGET_NAMES blosc2_shared)
+    endif()
+    if(BUILD_STATIC)
+        list(APPEND Blosc2_INSTALL_TARGET_NAMES blosc2_static)
+    endif()
+    configure_file(
+        ${PROJECT_SOURCE_DIR}/Blosc2Config.cmake.in
+        ${CMAKE_CURRENT_BINARY_DIR}/Blosc2Config.cmake
+        @ONLY
+    )
+    install(TARGETS ${Blosc2_INSTALL_TARGET_NAMES}
+        EXPORT Blosc2Targets
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+        INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+    )
+    install(EXPORT Blosc2Targets
+        FILE Blosc2Targets.cmake
+        NAMESPACE Blosc2::
+        DESTINATION ${Blosc2_INSTALL_CMAKEDIR}
+    )
+    write_basic_package_version_file("Blosc2ConfigVersion.cmake"
+        VERSION ${BLOSC2_VERSION_STRING}
+        COMPATIBILITY SameMajorVersion
+    )
+    install(
+        FILES
+            ${CMAKE_CURRENT_BINARY_DIR}/Blosc2Config.cmake
+            ${CMAKE_CURRENT_BINARY_DIR}/Blosc2ConfigVersion.cmake
+        DESTINATION ${Blosc2_INSTALL_CMAKEDIR}
+    )
+
+    # pkg-config .pc file
+    configure_file(
+         "${CMAKE_CURRENT_SOURCE_DIR}/blosc2.pc.in"
+         "${CMAKE_CURRENT_BINARY_DIR}/blosc2.pc"
+         @ONLY)
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/blosc2.pc"
+            DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig" COMPONENT DEV)
+
+    # uninstaller
+    configure_file(
+        "${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in"
+        "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
+        @ONLY)
+    add_custom_target(uninstall
+        COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
+endif()
+
 
 # packaging
 if(NOT BLOSC_IS_SUBPROJECT)

diff --git a/bench/b2nd/CMakeLists.txt b/bench/b2nd/CMakeLists.txt
@@ -12,5 +12,5 @@ foreach (source ${SOURCES})
     get_filename_component(target_name ${source} NAME_WE)
     set(target b2nd_${target_name})
     add_executable(${target} ${target_name}.c)
-    target_link_libraries(${target} blosc_testing ${LIBS})
+    target_link_libraries(${target} PUBLIC blosc_testing ${LIBS})
 endforeach (source)