Add PackageProject installation for find_package support (#553)

* Add Project Interface Library + PackageProject install configuration

* Added build-time configuration of version.h

* clang-format

* Add Major, Minor, Patch versions back to version.h.in

* Make test_exe link to the new project interface target

* Link benchmark_exe to new project interface target

* Add .cache ignore

Author: jonasbhjulstad

.gitignore

@@ -40,4 +40,7 @@ packaging/
 .code-workspace
 CXXGraph.code-workspace
 # ignore visual studio files
-.vs
+.vs
+
+# cache directories
+.cache

CMakeLists.txt

@@ -2,9 +2,7 @@ cmake_minimum_required(VERSION 3.9)
 
 # set the project name and version
 project(CXXGraph VERSION 4.1.0)
-
-configure_file(CXXGraphConfig.h.in ${PROJECT_SOURCE_DIR}/include/CXXGraph/CXXGraphConfig.h)
-
+set(PROJECT_NAMESPACE ${PROJECT_NAME})
 # specify the C++ standard
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
@@ -56,4 +54,52 @@ add_subdirectory(test)
 add_subdirectory(benchmark)
 add_subdirectory(examples)
 
-install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/ DESTINATION include)
+configure_file(${PROJECT_SOURCE_DIR}/include/CXXGraph/version.h.in ${PROJECT_BINARY_DIR}/include/CXXGraph/version.h)
+
+include(${CPM_DOWNLOAD_LOCATION})
+add_library(${PROJECT_NAME} INTERFACE)
+target_include_directories(${PROJECT_NAME} INTERFACE
+#Main include dir
+$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include> 
+$<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+#Version include dir:
+$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>
+)
+CPMAddPackage("gh:TheLartians/[email protected]")
+
+packageProject(
+  # the name of the target to export
+  NAME ${PROJECT_NAME}
+  # the version of the target to export
+  VERSION ${PROJECT_VERSION}
+  # a temporary directory to create the config files
+  BINARY_DIR ${PROJECT_BINARY_DIR}
+  # location of the target's public headers
+  INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include
+  # should match the target's INSTALL_INTERFACE include directory
+  INCLUDE_DESTINATION include/${PROJECT_NAME}-${PROJECT_VERSION}
+  # (optional) option to install only header files with matching pattern
+  INCLUDE_HEADER_PATTERN "*.h *.hpp"
+  # semicolon separated list of the project's dependencies
+  DEPENDENCIES ""
+  # (optional) create a header containing the version info
+  VERSION_HEADER "${PROJECT_NAME}/version.h"
+  # (optional) create a export header using GenerateExportHeader module
+  EXPORT_HEADER "${PROJECT_NAME}/export.h"
+  # (optional) install your library with a namespace (Note: do NOT add extra '::')
+  NAMESPACE ${PROJECT_NAMESPACE}
+  # (optional) define the project's version compatibility, defaults to `AnyNewerVersion`
+  # supported values: `AnyNewerVersion|SameMajorVersion|SameMinorVersion|ExactVersion`
+  COMPATIBILITY AnyNewerVersion
+  # (optional) option to disable the versioning of install destinations
+  DISABLE_VERSION_SUFFIX YES
+  # (optional) option to ignore target architecture for package resolution
+  # defaults to YES for header only (i.e. INTERFACE) libraries
+  ARCH_INDEPENDENT YES
+  # (optional) option to generate CPack variables
+  CPACK YES
+  # (optional) relative install directory for runtimes: bins, libs, archives 
+  # by default libs will be installed to <...>/lib/<packagename-version>/
+  # / - means relative to <...>/lib, i.e. install libs to <...>/lib/, bins to <...>/bin/, etc
+  RUNTIME_DESTINATION /
+)

CXXGraphConfig.h.in

@@ -42,14 +42,15 @@ if(BENCHMARK)
 		PUBLIC WITH_COMPRESSION
 	)
 	target_include_directories(benchmark_exe PUBLIC
-		PUBLIC ${PROJECT_SOURCE_DIR}/include
 		PUBLIC ${zlib_BINARY_DIR}
 		PUBLIC ${zlib_SOURCE_DIR}
 	)
 	target_link_libraries(benchmark_exe
-		PUBLIC GTest::gtest
-		PUBLIC benchmark::benchmark
-		PUBLIC zlibstatic
+		PUBLIC 
+		GTest::gtest 
+		benchmark::benchmark 
+		zlibstatic
+		${PROJECT_NAME}
 	)
 
 	# Ensure benchmark_exe itself is built in Release mode

benchmark/CMakeLists.txt

@@ -1,7 +1,6 @@
 #ifndef __CXXGRAPH_H__
 #define __CXXGRAPH_H__
 
-#include "CXXGraph/CXXGraphConfig.h"
 #include "CXXGraph/Edge/DirectedEdge.h"
 #include "CXXGraph/Edge/DirectedWeightedEdge.h"
 #include "CXXGraph/Edge/Edge.h"
@@ -24,5 +23,6 @@
 #include "CXXGraph/Partitioning/PartitionerThread.hpp"
 #include "CXXGraph/Partitioning/PartitioningStats.hpp"
 #include "CXXGraph/Partitioning/Record.hpp"
+#include "CXXGraph/version.h"
 
 #endif  // __CXXGRAPH_H__

include/CXXGraph/CXXGraph.hpp

@@ -0,0 +1,6 @@
+#pragma once
+
+#define CXXGraph_VERSION "@PROJECT_VERSION@"
+#define CXXGraph_VERSION_MAJOR "@PROJECT_VERSION_MAJOR"
+#define CXXGraph_VERSION_MINOR "@PROJECT_VERSION_MINOR"
+#define CXXGraph_VERSION_PATCH "@PROJECT_VERSION_PATCH"

include/CXXGraph/CXXGraphConfig.h

@@ -66,14 +66,15 @@ if(TEST)
         PUBLIC WITH_COMPRESSION
     )
     target_include_directories(test_exe
-        PUBLIC "${PROJECT_SOURCE_DIR}/include"
         PUBLIC ${zlib_BINARY_DIR}
         PUBLIC ${zlib_SOURCE_DIR}
     )
 
     target_link_libraries(test_exe
-        PUBLIC GTest::gtest_main
-        PUBLIC zlibstatic
+        PUBLIC 
+        GTest::gtest_main 
+        zlibstatic
+        ${PROJECT_NAME}
     )
 
     if(NOT gtest_disable_pthreads)