Create version header (#5)

* create version header

* use correct return code

* create real dependency target

* use correct install destination

* use sudo

* update docs

Author: TheLartians

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Ubuntu
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: 1
+  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    
+    - name: test local build
+      run: |
+        cmake -Htest -Bbuild/local
+        cmake --build build/local 
+        ./build/local/test
+
+    - name: install dependency
+      run: |
+        cmake -Htest/dependency -Bbuild/dependency
+        sudo cmake --build build/dependency --target install
+
+    - name: test installed build
+      run: |
+        cmake -Htest -Bbuild/installed -DTEST_INSTALLED_VERSION=1
+        cmake --build build/installed 
+        ./build/installed/test

.gitignore

@@ -0,0 +1 @@
+/build

CMakeLists.txt

@@ -1,22 +1,49 @@
 
 set(
-  PACKAGE_PROJECT_CONFIG_FILE_PATH
-  "${CMAKE_CURRENT_LIST_DIR}/Config.cmake.in"
+  PACKAGE_PROJECT_ROOT_PATH
+  "${CMAKE_CURRENT_LIST_DIR}"
   CACHE INTERNAL
-  "The config template for the packageProject script"
+  "The path to the PackageProject directory"
 )
 
 function(packageProject)
   include(CMakePackageConfigHelpers)
   include(GNUInstallDirs)
 
-  cmake_parse_arguments(PROJECT "" "NAME;VERSION;INCLUDE_DIR;INCLUDE_DESTINATION;BINARY_DIR;COMPATIBILITY" "DEPENDENCIES" ${ARGN})
+  cmake_parse_arguments(
+    PROJECT
+    ""
+    "NAME;VERSION;INCLUDE_DIR;INCLUDE_DESTINATION;BINARY_DIR;COMPATIBILITY;VERSION_HEADER"
+    "DEPENDENCIES"
+    ${ARGN}
+  )
 
   # handle default arguments
   if (NOT DEFINED PROJECT_COMPATIBILITY)
     set(PROJECT_COMPATIBILITY AnyNewerVersion)
   endif()
 
+  if (DEFINED PROJECT_VERSION_HEADER)
+    set(PROJECT_VERSION_INCLUDE_DIR ${PROJECT_BINARY_DIR}/PackageProjectInclude)
+    string(TOUPPER ${PROJECT_NAME} UPPERCASE_PROJECT_NAME)
+    configure_file(
+      ${PACKAGE_PROJECT_ROOT_PATH}/version.h.in
+      ${PROJECT_VERSION_INCLUDE_DIR}/${PROJECT_VERSION_HEADER}
+      @ONLY
+    )
+    get_target_property(target_type ${PROJECT_NAME} TYPE)
+    if (target_type STREQUAL "INTERFACE_LIBRARY")
+      set(VISIBILITY INTERFACE)
+    else()
+      set(VISIBILITY PUBLIC)
+    endif()
+    target_include_directories(${PROJECT_NAME} ${VISIBILITY} "$<BUILD_INTERFACE:${PROJECT_VERSION_INCLUDE_DIR}>")
+    install(
+      DIRECTORY ${PROJECT_VERSION_INCLUDE_DIR}/
+      DESTINATION ${PROJECT_INCLUDE_DESTINATION}
+    )
+  endif()
+
   write_basic_package_version_file(
     "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
     VERSION ${PROJECT_VERSION}
@@ -34,7 +61,7 @@ function(packageProject)
   )
 
   configure_package_config_file(
-    ${PACKAGE_PROJECT_CONFIG_FILE_PATH}
+    ${PACKAGE_PROJECT_ROOT_PATH}/Config.cmake.in
     "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
     INSTALL_DESTINATION lib/cmake/${PROJECT_NAME}-${PROJECT_VERSION}
   )

README.md

@@ -28,7 +28,9 @@ packageProject(
   INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include
   # should match the target's INSTALL_INTERFACE include directory
   INCLUDE_DESTINATION include/${PROJECT_NAME}-${PROJECT_VERSION}
-  # semicolon separated list of the project's dependencies
+  # (optional) create a header containing the version info
+  VERSION_HEADER "${PROJECT_NAME}/version.h"
+  # (optional) semicolon separated list of the project's dependencies
   DEPENDENCIES ""
 )
 ```

test/CMakeLists.txt

@@ -0,0 +1,17 @@
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+option(TEST_INSTALLED_VERSION "Test the version found by find_package" OFF)
+
+project(PackageProjectTest 
+  VERSION 1.0
+  LANGUAGES CXX
+)
+
+if (TEST_INSTALLED_VERSION)
+  find_package(dependency 1.2.3 REQUIRED)
+else()
+  add_subdirectory(dependency)
+endif()
+
+add_executable(test main.cpp)
+target_link_libraries(test dependency)

test/dependency/CMakeLists.txt

@@ -0,0 +1,26 @@
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+project(dependency 
+  VERSION 1.2.3
+  LANGUAGES CXX
+)
+
+add_library(dependency source/dependency.cpp)
+
+target_include_directories(dependency
+  PUBLIC
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+)
+
+add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../.. ${CMAKE_CURRENT_BINARY_DIR}/PackageProject)
+
+packageProject(
+  NAME ${PROJECT_NAME}
+  VERSION ${PROJECT_VERSION}
+  BINARY_DIR ${PROJECT_BINARY_DIR}
+  INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include
+  INCLUDE_DESTINATION include/${PROJECT_NAME}-${PROJECT_VERSION}
+  VERSION_HEADER "dependency/version.h"
+  DEPENDENCIES ""
+)

test/dependency/include/dependency/dependency.h

@@ -0,0 +1,5 @@
+#pragma once
+
+#include <iostream>
+
+void dependencyFunction();

test/dependency/source/dependency.cpp

@@ -0,0 +1,6 @@
+#include <iostream>
+#include <dependency/version.h>
+
+void dependencyFunction() {
+  std::cout << "Using dependency version " << DEPENDENCY_VERSION << std::endl;
+}

test/main.cpp

@@ -0,0 +1,8 @@
+#include <dependency/dependency.h>
+#include <dependency/version.h>
+#include <string>
+
+int main() {
+  dependencyFunction();
+  return DEPENDENCY_VERSION == std::string("1.2.3") ? 0 : 1;
+}

version.h.in

@@ -0,0 +1,3 @@
+#pragma once
+
+#define @UPPERCASE_PROJECT_NAME@_VERSION "@PROJECT_VERSION@"