Merge branch 'release/v1.0.1'

Author: ClausKlein

.clang-tidy

@@ -1,12 +1,14 @@
 ---
 Checks: "-*,\
 boost-*,\
+bugprone-*,\
 cert-*,\
 clang-analyzer-*,\
 cppcoreguidelines-*,\
--cppcoreguidelines-macro-usage,\
+cppcoreguidelines-macro-usage,\
 -cppcoreguidelines-owning-memory,\
 hicpp-*,\
+llvm-*,\
 misc-*,\
 misc-non-private-member-variables-in-classes,\
 modernize-*,\
@@ -17,7 +19,7 @@ readability-*,\
 -*magic-numbers,\
 -*avoid-c-arrays,\
 "
-WarningsAsErrors: ''
+WarningsAsErrors: 'clang-*'
 HeaderFilterRegex: '.*'
 AnalyzeTemporaryDtors: false
 FormatStyle:     file

.cmake-format

@@ -65,6 +65,7 @@ parse:
         VERSION_HEADER: 1
         EXPORT_HEADER: 1
         DISABLE_VERSION_SUFFIX: 1
+        DISABLE_CHECK_REQUIRED_COMPONENTS: 1
         DEPENDENCIES: +
     cpmusepackagelock:
       pargs: 1

CMakeLists.txt

@@ -31,77 +31,73 @@ include(cmake/CPM.cmake)
 # PackageProject.cmake will be used to make our target installable
 CPMAddPackage(
   NAME PackageProject.cmake
-  GITHUB_REPOSITORY TheLartians/PackageProject.cmake
-  VERSION 1.5.1
+  GITHUB_REPOSITORY ClausKlein/PackageProject.cmake
+  # VERSION 1.5.1
+  GIT_TAG 43fccf1a2f8f3d8dbecd547485c2278035448171
 )
 
-option(COMPONENT_TARGETS_ENABLED "Install multiple cmake config target files" NO)
+set(COMPONENT_TARGETS_ENABLED NO) # Note: DO not set! CK
 set(PROJECT_NAMESPACE ${PROJECT_NAME})
+set(PROJECT_VERSION_INCLUDE_DIR ${PROJECT_BINARY_DIR}/PackageProjectInclude)
+include_directories(${PROJECT_VERSION_INCLUDE_DIR})
+
 set(NAMESPACE_HEADER_LOCATION ${CMAKE_CURRENT_LIST_DIR}/include)
+set(INCLUDE_INSTALL_DIR include/${PROJECT_NAMESPACE}-${PROJECT_VERSION}) # XXX VERSION_SUFFIX
 string(TOLOWER ${PROJECT_NAMESPACE} PROJECT_HEADER_LOCATION)
-
-if(NOT COMPONENT_TARGETS_ENABLED)
-  message(STATUS "Install only 1 cmake config target ${PROJECT_NAMESPACE}Targets.cmake file")
-endif()
+# TODO: needed to be lower case? CK
 
 # ---- Add components libraries here ----
 
 add_subdirectory(source/Addition)
 add_subdirectory(source/SquareRoot)
-add_subdirectory(source/MathFunctions)
-
-# ---------------------------------------
 
-include(GenerateExportHeader)
-
-# Note: depends on target MathFunctions! CK
-string(TOLOWER ${PROJECT_NAME}/${PROJECT_NAMESPACE}_export.h EXPORT_HEADER_LOCATION)
-
-# Note: need to generate at source tree! CK
-generate_export_header(
-  ${PROJECT_NAMESPACE} EXPORT_FILE_NAME ${CMAKE_CURRENT_LIST_DIR}/include/${EXPORT_HEADER_LOCATION}
+# NO! add_subdirectory(source/MathFunctions)
+add_library(${PROJECT_NAME} source/MathFunctions/MathFunctions.cxx)
+target_include_directories(
+  ${PROJECT_NAME} PUBLIC $<BUILD_INTERFACE:${NAMESPACE_HEADER_LOCATION}>
+                         $<INSTALL_INTERFACE:${INCLUDE_INSTALL_DIR}>
 )
 
-# install generated header files
-install(
-  DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include/${PROJECT_HEADER_LOCATION}
-  TYPE INCLUDE # or: DESTINATION include/${PROJECT_NAMESPACE}
-  FILES_MATCHING
-  PATTERN "*.h"
+# Note: for SameMajorVersion upgrade stategie
+set_target_properties(
+  ${PROJECT_NAME}
+  PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR}
+             VERSION ${PROJECT_VERSION}
+             VISIBILITY_INLINES_HIDDEN ${BUILD_SHARED_LIBS}
+             CMAKE_VISIBILITY_INLINES_HIDDEN ${BUILD_SHARED_LIBS}
 )
 
-# install source tree header files
-install(
-  DIRECTORY include/${PROJECT_HEADER_LOCATION}
-  TYPE INCLUDE # or: DESTINATION include/${PROJECT_NAMESPACE}
-  FILES_MATCHING
-  PATTERN "*.h"
-)
+# ---- Create an installable target ----
+# this allows users to install and find the libraries via `find_package()`.
+
+# the location where the project's version header will be placed should match the project's regular
+# header paths
+string(TOLOWER ${PROJECT_NAMESPACE}/version.h PROJECT_VERSION_HEADER)
+string(TOLOWER ${PROJECT_NAMESPACE}/${PROJECT_NAMESPACE}_export.h PROJECT_EXPORT_HEADER)
+# TODO: needed to be lower case? CK
 
 # Note: This needs to be done after all install(TARGETS ...) commands!
 # generate and install export targets file
 install(
   EXPORT ${PROJECT_NAMESPACE}Targets
   FILE ${PROJECT_NAMESPACE}Targets.cmake
   NAMESPACE ${PROJECT_NAMESPACE}::
-  DESTINATION lib/cmake/${PROJECT_NAMESPACE}
+  DESTINATION lib/cmake/${PROJECT_NAMESPACE}-${PROJECT_VERSION} # XXX VERSION_SUFFIX
 )
 
-include(CMakePackageConfigHelpers)
-
-# generate the version file for the config file
-write_basic_package_version_file(
-  ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAMESPACE}ConfigVersion.cmake
+# Note: the export header will be installed while installing the version header! CK
+packageProject(
+  NAME ${PROJECT_NAME}
   VERSION ${PROJECT_VERSION}
+  NAMESPACE ${PROJECT_NAMESPACE}
+  BINARY_DIR ${PROJECT_BINARY_DIR}
+  INCLUDE_DIR ${NAMESPACE_HEADER_LOCATION}
+  INCLUDE_DESTINATION ${INCLUDE_INSTALL_DIR}
+  VERSION_HEADER ${PROJECT_VERSION_HEADER}
+  EXPORT_HEADER ${PROJECT_EXPORT_HEADER}
   COMPATIBILITY SameMajorVersion
-)
-
-# create config file
-configure_package_config_file(
-  ${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in
-  ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAMESPACE}Config.cmake
-  INSTALL_DESTINATION lib/cmake/${PROJECT_NAMESPACE}
-  NO_CHECK_REQUIRED_COMPONENTS_MACRO
+  # XXX DISABLE_VERSION_SUFFIX NOT YET! CK
+  DISABLE_CHECK_REQUIRED_COMPONENTS YES
 )
 
 # generate the export targets for the build tree. Note: The file created by this command is specific
@@ -111,9 +107,3 @@ export(
   FILE ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAMESPACE}Targets.cmake
   NAMESPACE ${PROJECT_NAMESPACE}::
 )
-
-# install cmake project config files
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/MathFunctionsConfig.cmake
-              ${CMAKE_CURRENT_BINARY_DIR}/MathFunctionsConfigVersion.cmake
-        DESTINATION lib/cmake/${PROJECT_NAMESPACE}
-)

GNUmakefile

@@ -4,18 +4,23 @@
 GENERATOR?=Ninja
 
 STAGE_DIR?=$(CURDIR)/stage
-BUILD_TYPE?=Release
-CMAKE_PRESET:=-G "$(GENERATOR)" -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DCMAKE_PREFIX_PATH=$(STAGE_DIR)
+BUILD_TYPE?=Debug
+CMAKE_PRESET:=-G "$(GENERATOR)" -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DCMAKE_PREFIX_PATH=$(STAGE_DIR) -DCMAKE_CXX_STANDARD=20 -DBUILD_SHARED_LIBS=1
 # Note: not needed -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
 
-#XXX export CXX=clang++
+# export CXX=/usr/local/bin/g++-10
+# export GCOV=/usr/local/bin/gcov-10
+# export CXX=clang++
+# export GCOV=llvm-cov
+
 export CPM_USE_LOCAL_PACKAGES=0
 export CPM_SOURCE_CACHE=${HOME}/.cache/CPM
 
+TOOL_NAME:=$(shell basename $(CXX))
 PROJECT_NAME:=$(shell basename $(CURDIR))
-BUILD_DIR?=../build-$(PROJECT_NAME)-$(CXX)-$(BUILD_TYPE)
+BUILD_DIR?=../build-$(PROJECT_NAME)-$(TOOL_NAME)-$(BUILD_TYPE)
 
-.PHONY: update format all test standalone doc check clean distclean
+.PHONY: update format all test standalone doc modernize clean distclean
 
 # the default target does just all, but neither standalone nor doc
 test:
@@ -33,10 +38,10 @@ update:
 
 # install the library to stagedir
 install:
-	cmake -S . -B $(BUILD_DIR)/$@ ${CMAKE_PRESET} -DCMAKE_INSTALL_PREFIX=$(STAGE_DIR) -DCMAKE_CXX_STANDARD=20 #NO! -DCMAKE_CXX_CLANG_TIDY=clang-tidy # --trace-expand
+	cmake -S . -B $(BUILD_DIR)/$@ ${CMAKE_PRESET} -DCMAKE_INSTALL_PREFIX=$(STAGE_DIR)
 	cmake --build $(BUILD_DIR)/$@ --target $@
 	perl -i.bak -pe 's#-I($$CPM_SOURCE_CACHE)#-isystem $$1#g' $(BUILD_DIR)/$@/compile_commands.json
-	run-clang-tidy.py -p $(BUILD_DIR)/$@ -quiet -header-filter='$(CURDIR)/.*' source    # Note: only local sources! CK
+	run-clang-tidy.py -p $(BUILD_DIR)/$@ -quiet -header-filter='$(CURDIR)/.*' source # Note: only local sources! CK
 
 # test the library
 test: install
@@ -45,13 +50,17 @@ test: install
 	perl -i.bak -pe 's#-I($$CPM_SOURCE_CACHE)#-isystem $$1#g' $(BUILD_DIR)/$@/compile_commands.json
 	cmake --build $(BUILD_DIR)/$@
 	cmake --build $(BUILD_DIR)/$@ --target $@
-	run-clang-tidy.py -p $(BUILD_DIR)/$@ -quiet -header-filter='$(CURDIR)/.*' test/source    # Note: only local sources! CK
+	run-clang-tidy.py -p $(BUILD_DIR)/$@ -quiet -header-filter='$(CURDIR)/.*' test/source # Note: only local sources! CK
 
 # all together
 all:
-	cmake -S $@ -B $(BUILD_DIR)/$@ ${CMAKE_PRESET} -DENABLE_TEST_COVERAGE=1 # Note: NO! -DUSE_STATIC_ANALYZER=clang-tidy CK
+	cmake -S $@ -B $(BUILD_DIR)/$@ ${CMAKE_PRESET} -DENABLE_TEST_COVERAGE=1    # NO! -DUSE_STATIC_ANALYZER=clang-tidy CK
 	cmake --build $(BUILD_DIR)/$@
 	cmake --build $(BUILD_DIR)/$@ --target test
+	gcovr --root $(BUILD_DIR)/$@ --exclude-directories test # --verbose
+	# gcovr -r $(BUILD_DIR)/$@ --html-details -o $(CURDIR)/coverage.html --verbose
+	perl -i.bak -pe 's#-I($$CPM_SOURCE_CACHE)#-isystem $$1#g' $(BUILD_DIR)/$@/compile_commands.json
+	run-clang-tidy.py -p $(BUILD_DIR)/$@ -quiet -header-filter='$(CURDIR)/.*' $(CURDIR)   # Note: only local sources! CK
 
 # GenerateDocs
 doc:
@@ -69,6 +78,7 @@ standalone:
 	perl -i.bak -pe 's#-I($$CPM_SOURCE_CACHE)#-isystem $$1#g' $(BUILD_DIR)/$@/compile_commands.json
 	cmake --build $(BUILD_DIR)/$@
 
-# check the library
-check: standalone
-	run-clang-tidy.py -p $(BUILD_DIR)/standalone -quiet -header-filter='$(CURDIR)/.*' -checks='-*,modernize-*,misc-*,hicpp-*,cert-*,readability-*,portability-*,performance-*,google-*' standalone
+# modernize the library sources
+modernize: standalone
+	run-clang-tidy.py -p $(BUILD_DIR)/standalone -quiet -header-filter='$(CURDIR)/.*' \
+	 -checks='-*,modernize-*' -j1 -fix $(CURDIR) # Note: only local sources! CK

cmake/options.cmake

@@ -9,7 +9,7 @@ endif()
 # Note: same postfix as fmt and spdlog! CK
 set(CMAKE_DEBUG_POSTFIX d)
 
-option(BUILD_SHARED_LIBS "Build shared libraries" NO)
+option(BUILD_SHARED_LIBS "Build shared libraries" YES)
 
 # build the dynamic libraries and executables together at bin directory
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
@@ -45,6 +45,11 @@ if(NOT MSVC)
         CACHE STRING "dependency flag" FORCE
     )
   endif()
+
+  if(ENABLE_TEST_COVERAGE AND "${CMAKE_BUILD_TYPE}" STREQUAL Debug)
+    add_compile_options(--coverage -O0 -g)
+    add_link_options(--coverage)
+  endif()
 endif()
 
 option(CMAKE_EXPORT_COMPILE_COMMANDS "support clang-tidy, cppcheck, ..." YES)

include/mathfunctions/Addition.h

@@ -1,5 +1,10 @@
 #pragma once
 
+// quickhack for now! CK
+#ifdef Addition_EXPORTS
+#  define MathFunctions_EXPORTS
+#endif
+
 #include <mathfunctions/mathfunctions_export.h>
 
 namespace MathFunctions {

include/mathfunctions/SquareRoot.h

@@ -1,5 +1,10 @@
 #pragma once
 
+// quickhack for now! CK
+#ifdef SquareRoot_EXPORTS
+#  define MathFunctions_EXPORTS
+#endif
+
 #include <mathfunctions/mathfunctions_export.h>
 
 namespace MathFunctions {

source/Addition/CMakeLists.txt

@@ -18,24 +18,27 @@ set_target_properties(
 
 # add include directories
 target_include_directories(
-  Addition PUBLIC $<BUILD_INTERFACE:${NAMESPACE_HEADER_LOCATION}> $<INSTALL_INTERFACE:include>
+  Addition
+  PUBLIC $<BUILD_INTERFACE:${NAMESPACE_HEADER_LOCATION}>
+         $<BUILD_INTERFACE:${PROJECT_VERSION_INCLUDE_DIR}>
+         $<INSTALL_INTERFACE:${INCLUDE_INSTALL_DIR}>
 )
 
 # install the target and create export-set
 install(
   TARGETS Addition
   EXPORT ${PROJECT_NAMESPACE}Targets
-  ARCHIVE DESTINATION lib
-  LIBRARY DESTINATION lib
-  RUNTIME DESTINATION bin
+  ARCHIVE DESTINATION lib/${PROJECT_NAMESPACE}-${PROJECT_VERSION} # XXX VERSION_SUFFIX
+  LIBRARY DESTINATION lib/${PROJECT_NAMESPACE}-${PROJECT_VERSION} # XXX VERSION_SUFFIX
+  RUNTIME DESTINATION bin/${PROJECT_NAMESPACE}-${PROJECT_VERSION} # XXX VERSION_SUFFIX
   INCLUDES
-  DESTINATION include
+  DESTINATION ${INCLUDE_INSTALL_DIR}
 )
 
 # MAYBE: install public header files
 # string(TOLOWER ${PROJECT_NAMESPACE} HEADER_LOCATION)
 # install(FILES ${NAMESPACE_HEADER_LOCATION}/${PROJECT_NAMESPACE}/Addition.h
-#         DESTINATION include/${HEADER_LOCATION}
+#         DESTINATION ${INCLUDE_INSTALL_DIR}/${PROJECT_NAMESPACE}
 # )
 
 if(COMPONENT_TARGETS_ENABLED)

source/MathFunctions/CMakeLists.txt

@@ -19,7 +19,8 @@ set_target_properties(
 
 # add include directories
 target_include_directories(
-  MathFunctions PUBLIC $<BUILD_INTERFACE:${NAMESPACE_HEADER_LOCATION}> $<INSTALL_INTERFACE:include>
+  MathFunctions PUBLIC $<BUILD_INTERFACE:${NAMESPACE_HEADER_LOCATION}>
+                       $<INSTALL_INTERFACE:${INCLUDE_INSTALL_DIR}>
 )
 
 # install the target and create export-set
@@ -34,9 +35,8 @@ install(
 )
 
 # MAYBE: install public header files
-# string(TOLOWER ${PROJECT_NAMESPACE} HEADER_LOCATION)
 # install(FILES ${NAMESPACE_HEADER_LOCATION}/${PROJECT_NAMESPACE}/MathFunctions.h
-#         DESTINATION include/${HEADER_LOCATION}
+#         DESTINATION ${INCLUDE_INSTALL_DIR}/${PROJECT_NAMESPACE}
 # )
 
 if(COMPONENT_TARGETS_ENABLED)

source/MathFunctions/MathFunctions.cxx

@@ -1,4 +1,4 @@
-#include "mathfunctions/MathFunctions.h"
+#include <mathfunctions/MathFunctions.h>
 
 #include <cmath>
 

source/SquareRoot/CMakeLists.txt

@@ -18,24 +18,27 @@ set_target_properties(
 
 # add include directories
 target_include_directories(
-  SquareRoot PUBLIC $<BUILD_INTERFACE:${NAMESPACE_HEADER_LOCATION}> $<INSTALL_INTERFACE:include>
+  SquareRoot
+  PUBLIC $<BUILD_INTERFACE:${NAMESPACE_HEADER_LOCATION}>
+         $<BUILD_INTERFACE:${PROJECT_VERSION_INCLUDE_DIR}>
+         $<INSTALL_INTERFACE:${INCLUDE_INSTALL_DIR}>
 )
 
 # install the target and create export-set
 install(
   TARGETS SquareRoot
   EXPORT ${PROJECT_NAMESPACE}Targets
-  ARCHIVE DESTINATION lib
-  LIBRARY DESTINATION lib
-  RUNTIME DESTINATION bin
+  ARCHIVE DESTINATION lib/${PROJECT_NAMESPACE}-${PROJECT_VERSION} # XXX VERSION_SUFFIX
+  LIBRARY DESTINATION lib/${PROJECT_NAMESPACE}-${PROJECT_VERSION} # XXX VERSION_SUFFIX
+  RUNTIME DESTINATION bin/${PROJECT_NAMESPACE}-${PROJECT_VERSION} # XXX VERSION_SUFFIX
   INCLUDES
-  DESTINATION include
+  DESTINATION ${INCLUDE_INSTALL_DIR}
 )
 
 # MAYBE: install public header files
 # string(TOLOWER ${PROJECT_NAMESPACE} HEADER_LOCATION)
 # install(FILES ${NAMESPACE_HEADER_LOCATION}/${PROJECT_NAMESPACE}/SquareRoot.h
-#         DESTINATION include/${PROJECT_NAMESPACE}
+#         DESTINATION ${INCLUDE_INSTALL_DIR}/${PROJECT_NAMESPACE}
 # )
 
 if(COMPONENT_TARGETS_ENABLED)

standalone/CMakeLists.txt

@@ -25,7 +25,7 @@ CPMAddPackage(
 )
 
 CPMAddPackage(NAME MathFunctions SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
-# same as: add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/.. MathFunctions)
+# Not same as! add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/.. MathFunctions)
 
 # ---- Create standalone executable ----
 

standalone/source/main.cxx

@@ -13,7 +13,7 @@ auto main(int argc, char* argv[]) -> int {
   }
 
   // convert input to double
-  const double inputValue = std::stod(argv[1]);
+  const double inputValue = std::stod(argv[1]);  // NOLINT Note: may throw! CK
 
   // calculate square root
   const double sqrt = MathFunctions::sqrt(inputValue);