Merge pull request #669 from dan-42/change_installed_cmake_include_path

REFACTOR: rewrite CMakeLists.txt for better inlcude and reuse

CMakeLists.txt

-cmake_minimum_required(VERSION 3.0)
+cmake_minimum_required(VERSION 3.0.0)
 
-# define the project
-project(nlohmann_json VERSION 2.1.1 LANGUAGES CXX)
+##
+## PROJECT
+## name and version
+##
+project(nlohmann_json VERSION 2.1.1)
 
+##
+## OPTIONS
+##
 option(JSON_BuildTests "Build the unit tests" ON)
 
-# define project variables
-set(JSON_TARGET_NAME ${PROJECT_NAME})
-set(JSON_PACKAGE_NAME ${JSON_TARGET_NAME})
-set(JSON_TARGETS_FILENAME "${JSON_PACKAGE_NAME}Targets.cmake")
-set(JSON_CONFIG_FILENAME "${JSON_PACKAGE_NAME}Config.cmake")
-set(JSON_CONFIGVERSION_FILENAME "${JSON_PACKAGE_NAME}ConfigVersion.cmake")
-set(JSON_CONFIG_DESTINATION "cmake")
-set(JSON_INCLUDE_DESTINATION "include/nlohmann")
+##
+## CONFIGURATION
+##
+set(NLOHMANN_JSON_TARGET_NAME               ${PROJECT_NAME})
+set(NLOHMANN_JSON_SOURCE_DIR                "src/")
+set(NLOHMANN_JSON_CONFIG_INSTALL_DIR        "lib/cmake/${PROJECT_NAME}")
+set(NLOHMANN_JSON_INCLUDE_INSTALL_DIR       "include")
+set(NLOHMANN_JSON_HEADER_INSTALL_DIR        "${NLOHMANN_JSON_INCLUDE_INSTALL_DIR}/nlohmann")
+set(NLOHMANN_JSON_TARGETS_EXPORT_NAME       "${PROJECT_NAME}Targets")
+set(NLOHMANN_JSON_CMAKE_CONFIG_TEMPLATE     "cmake/config.cmake.in")
+set(NLOHMANN_JSON_CMAKE_CONFIG_DIR          "${CMAKE_CURRENT_BINARY_DIR}/cmake_config")
+set(NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}ConfigVersion.cmake")
+set(NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Config.cmake")
 
-set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+##
+## TARGET
+## create target and add include path
+##
+add_library(${NLOHMANN_JSON_TARGET_NAME} INTERFACE)
 
-# create and configure the library target
-add_library(${JSON_TARGET_NAME} INTERFACE)
-target_include_directories(${JSON_TARGET_NAME} INTERFACE
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
-  $<INSTALL_INTERFACE:${JSON_INCLUDE_DESTINATION}>)
-
-# create and configure the unit test target
+target_include_directories(
+    ${NLOHMANN_JSON_TARGET_NAME}
+    INTERFACE $<INSTALL_INTERFACE:include/>
+)
+            
+##
+## TESTS
+## create and configure the unit test target
+##
 if(JSON_BuildTests)
     enable_testing()
+    include_directories(${NLOHMANN_JSON_SOURCE_DIR})
     add_subdirectory(test)
 endif()
 
-# generate a config and config version file for the package
+##
+## INSTALL
+## install header files, generate and install cmake config files for find_package()
+##
 include(CMakePackageConfigHelpers)
-configure_package_config_file("cmake/config.cmake.in"
-    "${CMAKE_CURRENT_BINARY_DIR}/${JSON_CONFIG_FILENAME}"
-    INSTALL_DESTINATION ${JSON_CONFIG_DESTINATION}
-    PATH_VARS JSON_INCLUDE_DESTINATION)
-write_basic_package_version_file("${CMAKE_CURRENT_BINARY_DIR}/${JSON_CONFIGVERSION_FILENAME}"
-    VERSION ${PROJECT_VERSION}
-    COMPATIBILITY SameMajorVersion)
-
-# export the library target and store build directory in package registry
-export(TARGETS ${JSON_TARGET_NAME}
-    FILE "${CMAKE_CURRENT_BINARY_DIR}/${JSON_TARGETS_FILENAME}")
-export(PACKAGE ${JSON_PACKAGE_NAME})
-
-# install library target and config files
-install(TARGETS ${JSON_TARGET_NAME}
-    EXPORT ${JSON_PACKAGE_NAME})
-install(FILES "src/json.hpp"
-    DESTINATION ${JSON_INCLUDE_DESTINATION})
-install(EXPORT ${JSON_PACKAGE_NAME}
-    FILE ${JSON_TARGETS_FILENAME}
-    DESTINATION ${JSON_CONFIG_DESTINATION})
-install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${JSON_CONFIG_FILENAME}"
-    "${CMAKE_CURRENT_BINARY_DIR}/${JSON_CONFIGVERSION_FILENAME}"
-    DESTINATION ${JSON_CONFIG_DESTINATION})
+write_basic_package_version_file(
+    ${NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE} COMPATIBILITY SameMajorVersion
+)
+configure_package_config_file(
+    ${NLOHMANN_JSON_CMAKE_CONFIG_TEMPLATE}
+    ${NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE}
+    INSTALL_DESTINATION ${NLOHMANN_JSON_CONFIG_INSTALL_DIR}
+)
+install(
+    DIRECTORY ${NLOHMANN_JSON_SOURCE_DIR}
+    DESTINATION ${NLOHMANN_JSON_HEADER_INSTALL_DIR}
+)
+install(
+    FILES ${NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE} ${NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE}
+    DESTINATION ${NLOHMANN_JSON_CONFIG_INSTALL_DIR}
+)
+install(
+    TARGETS ${NLOHMANN_JSON_TARGET_NAME}
+    EXPORT ${NLOHMANN_JSON_TARGETS_EXPORT_NAME}
+    INCLUDES DESTINATION ${NLOHMANN_JSON_INCLUDE_INSTALL_DIR}
+)
+install(
+    EXPORT ${NLOHMANN_JSON_TARGETS_EXPORT_NAME}
+    DESTINATION ${NLOHMANN_JSON_CONFIG_INSTALL_DIR}
+)

cmake/config.cmake.in

 @PACKAGE_INIT@
-set_and_check(JSON_INCLUDE_DIR "@PACKAGE_JSON_INCLUDE_DESTINATION@")
-
-cmake_policy(PUSH)
-cmake_policy(SET CMP0024 OLD)
-include(${CMAKE_CURRENT_LIST_DIR}/@JSON_TARGETS_FILENAME@)
-cmake_policy(POP)
+include("${CMAKE_CURRENT_LIST_DIR}/@NLOHMANN_JSON_TARGETS_EXPORT_NAME@.cmake")
+check_required_components("@PROJECT_NAME@")