cmake find_package() (#84)

Author: tzaeschke

CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   - linting for C++ and bazel files.
   - Added CI status badges.
   - Added test coverage
+- Added support for cmake `FetchContent`.
+  See README for details. [#75](https://github.com/tzaeschke/phtree-cpp/issues/75)
+- Added support for cmake `find_packet()` and direct import via `add_sub_directory()`.
+  See README for details. [#83](https://github.com/tzaeschke/phtree-cpp/issues/83)
 
 ### Changed
 - Cleaned up build scripts. [#53](https://github.com/tzaeschke/phtree-cpp/issues/53)

CMakeLists.txt

@@ -34,6 +34,9 @@ endif ()
 # bench options
 option(PHTREE_BUILD_BENCHMARKS "Build benchmarks (Requires https://github.com/google/benchmark.git to be installed)" OFF)
 
+# install options
+option(PHTREE_INSTALL "Generate the install target" OFF)
+
 
 # ---------------------------------------------------------------------------------------
 # Compiler config
@@ -82,7 +85,7 @@ else ()
     endif ()
     if (PHTREE_CODE_COVERAGE)
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --coverage") # -Wa,-mbig-obj")
-        set(CMAKE_EXE_LINKER_FLAGS  "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
     endif ()
 endif ()
 
@@ -98,8 +101,8 @@ add_library(phtree::phtree ALIAS phtree)
 target_compile_features(phtree INTERFACE cxx_std_17)
 
 target_include_directories(phtree INTERFACE
-    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
 
 if (PHTREE_BUILD_EXAMPLES OR PHTREE_BUILD_ALL)
     message(STATUS "Generating examples")
@@ -117,3 +120,42 @@ if (PHTREE_BUILD_TESTS OR PHTREE_BUILD_ALL)
     include(GoogleTest)
     add_subdirectory(test)
 endif ()
+
+# ---------------------------------------------------------------------------------------
+# Install
+# ---------------------------------------------------------------------------------------
+if (PHTREE_INSTALL)
+    include(GNUInstallDirs)
+
+    install(TARGETS phtree
+            EXPORT ${PROJECT_NAME}_Targets
+            ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+
+    include(CMakePackageConfigHelpers)
+    write_basic_package_version_file("phtreeConfigVersion.cmake"
+            VERSION ${PROJECT_VERSION}
+            COMPATIBILITY SameMajorVersion)
+
+    configure_package_config_file(
+            "${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in"
+            "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+            INSTALL_DESTINATION
+            ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
+
+    install(EXPORT ${PROJECT_NAME}_Targets
+            FILE ${PROJECT_NAME}Targets.cmake
+            NAMESPACE phtree::
+            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
+
+    install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+            "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
+
+    install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/phtree
+            DESTINATION include
+            PATTERN "BUILD" EXCLUDE
+            PATTERN "*.md" EXCLUDE)
+
+endif ()

README.md

@@ -594,7 +594,11 @@ bazel run //benchmark:update_mm_d_benchmark --config=benchmark  -- --benchmark_c
 <a id="cmake"></a>
 
 ### cmake
-<!--With `FetchContent_...()`: ***NOTE This will only work once v1.4.0 has been released!***
+<!--
+The library supports three types of cmake dependency management, `FetchContent`, `find_package()` and `add_subfolder()`.
+All three approaches are used in [this example project](https://github.com/tzaeschke/test-phtree-cpp-cmake).
+#### FetchContent
+With `FetchContent_...()`: ***NOTE This will only work once v1.4.0 has been released!***
 ```
 include(FetchContent)
 FetchContent_Declare(
@@ -605,6 +609,25 @@ FetchContent_Declare(
 )
 FetchContent_MakeAvailable(phtree)
 ```
+
+#### find_package()
+You need to build the library with:
+```
+mkdir out && cd out
+cmake .. -DPHTREE_INSTALL=on
+sudo cmake --build . --config Release --target install -- -j <number of cores>
+```
+Note that the option `CMAKE_INSTALL_PREFIX:PATH=...` does _not_ work.
+The library can then be included with:
+```
+find_package(phtree CONFIG REQUIRED)
+add_executable(ExampleProject example.cc)
+target_link_libraries(ExampleProject phtree::phtree)
+```
+
+#### add_subfolder()
+For this you can simply copy the PH-Tree source code into your project (you can skip `benchmark` and `test`) and
+then include the folder with `add_subdirectory(phtree-cpp)`.
 -->
 
 `cmake` uses `ccache` when available.

cmake/phtreeConfig.cmake.in

@@ -0,0 +1,4 @@
+@PACKAGE_INIT@
+
+include("${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@Targets.cmake")
+check_required_components("@PROJECT_NAME@")