Merge pull request #9 from 7bitcoder/dev

Change Cmake build method

Author: 7bitcoder

.github/actions/cmake-build/action.yml

@@ -4,7 +4,7 @@ inputs:
   args:
     description: "Other arguments"
     required: false
-    default:  -DBUILD_TESTS:BOOL=true -DBUILD_EXAMPLES:BOOL=true
+    default: ""
   build-type:
     description: "Build type"
     required: false
@@ -13,10 +13,10 @@ inputs:
     description: "Toolchain file"
     required: false
     default: conan_toolchain.cmake
-  library-type:
-    description: "Library type"
+  shared-lib:
+    description: "Shared lib"
     required: false
-    default: Static
+    default: "OFF"
   build-dir:
     description: "Build directory"
     required: true
@@ -26,7 +26,7 @@ runs:
   steps:
     - name: Configure CMake
       working-directory: ${{ inputs.build-dir }}
-      run: cmake .. -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} -DLIBRARY_TYPE=${{ inputs.library-type }} -DCMAKE_TOOLCHAIN_FILE:STRING="${{ inputs.toolchain }}" ${{ inputs.args }}
+      run: cmake .. -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} -DSEVEN_BIT_DI_BUILD_SHARED:STRING="${{ inputs.shared-lib }}" -DCMAKE_TOOLCHAIN_FILE:STRING="${{ inputs.toolchain }}" -DSEVEN_BIT_DI_BUILD_TESTS:BOOL=true -DSEVEN_BIT_DI_BUILD_EXAMPLES:BOOL=true ${{ inputs.args }}
       shell: pwsh
 
     - name: Build

.github/workflows/DevCI.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        libraryType: [HeaderOnly, Static, Shared]
+        shared-lib: ["ON", "OFF"]
         os: [ubuntu-22.04, macos-12, windows-2022]
 
     runs-on: ${{matrix.os}}
@@ -35,7 +35,7 @@ jobs:
         with:
           build-dir: ${{ env.BUILD_DIR }}
           build-type: ${{ env.BUILD_TYPE }}
-          library-type: ${{ matrix.libraryType }}
+          shared-lib: ${{ matrix.shared-lib }}
 
       - name: Test
         working-directory: ${{ env.BUILD_DIR }}

.github/workflows/MainCI.yml

@@ -16,7 +16,6 @@ jobs:
   test-gcc:
     strategy:
       matrix:
-        libraryType: [Static]
         version: [7, 8, 10, 11]
         os: [ubuntu-20.04]
 
@@ -48,7 +47,6 @@ jobs:
   test-clang:
     strategy:
       matrix:
-        libraryType: [Static]
         version: [6, 13, 14, 15]
         os: [ubuntu-20.04]
 

CMakeLists.txt

@@ -1,30 +1,52 @@
 cmake_minimum_required(VERSION 3.15.0)
-project(7bitInjector VERSION 1.0.0)
 
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH};${CMAKE_CURRENT_SOURCE_DIR}/Cmake)
+set(SEVEN_BIT_DI_PROJECT_NAME 7bitDI)
 
-include(GoogleTest)
-include(CPack)
-enable_testing()
+set(SEVEN_BIT_DI_VERSION_MAJOR 1)
+set(SEVEN_BIT_DI_VERSION_MINOR 0)
+set(SEVEN_BIT_DI_VERSION_PATCH 0)
 
-include(Setup)
+set(SEVEN_BIT_DI_VERSION ${SEVEN_BIT_DI_VERSION_MAJOR}.${SEVEN_BIT_DI_VERSION_MINOR}.${SEVEN_BIT_DI_VERSION_PATCH})
+
+project(${SEVEN_BIT_DI_PROJECT_NAME} VERSION ${SEVEN_BIT_DI_VERSION})
+
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH};${CMAKE_CURRENT_SOURCE_DIR}/Cmake)
 
 include_directories(Include)
+include(Setup)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 add_subdirectory(Source)
 
-if(BUILD_DOCS)
+if(SEVEN_BIT_DI_BUILD_DOCS)
         add_subdirectory(Docs)
 endif()
 
-if(BUILD_TESTS)
+if(SEVEN_BIT_DI_BUILD_TESTS OR SEVEN_BIT_DI_BUILD_TESTS_HO)
+        include(GoogleTest)
+        include(CPack)
+        enable_testing()
+
         add_subdirectory(Tests)
 endif()
 
-if(BUILD_EXAMPLES)
+if(SEVEN_BIT_DI_BUILD_EXAMPLES OR SEVEN_BIT_DI_BUILD_EXAMPLE_HO)
         add_subdirectory(Examples)
 endif()
 
-install(DIRECTORY Include/ DESTINATION include)
+install(DIRECTORY ${SEVEN_BIT_DI_HEADERS_DIR}/ DESTINATION include)
+
+export(
+        TARGETS 7BitDI
+        NAMESPACE 7BitDI::
+        FILE ${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_TARGETS_FILE})
+install(EXPORT 7BitDI DESTINATION ${EXPORT_DEST_DIR} NAMESPACE 7BitDI:: FILE ${CONFIG_TARGETS_FILE})
+
+include(CMakePackageConfigHelpers)
+configure_package_config_file(${PROJECT_CONFIG_IN} ${PROJECT_CONFIG_OUT}
+        INSTALL_DESTINATION ${EXPORT_DEST_DIR})
+
+write_basic_package_version_file(${VERSIONS_CONFIG_FILE} COMPATIBILITY SameMajorVersion)
+install(FILES ${PROJECT_CONFIG_OUT} ${VERSIONS_CONFIG_FILE} DESTINATION ${EXPORT_DEST_DIR})

Cmake/7bitDIConfig.cmake.in

@@ -0,0 +1,5 @@
+@PACKAGE_INIT@
+
+include("${CMAKE_CURRENT_LIST_DIR}/${config_targets_file}")
+
+check_required_components(spdlog)

Cmake/Setup.cmake

@@ -1,7 +1,8 @@
 include(Functions)
 
-set(CPACK_PROJECT_NAME ${PROJECT_NAME})
-set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
+if(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose Release or Debug" FORCE)
+endif()
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/bin)
@@ -13,43 +14,61 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/lib)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}/lib)
 
+set(CPACK_PROJECT_NAME ${SEVEN_BIT_DI_PROJECT_NAME})
+set(CPACK_PROJECT_VERSION ${SEVEN_BIT_DI_VERSION})
+
 set(CMAKE_INSTALL_PREFIX ${CMAKE_BINARY_DIR}/publish)
 
-SET(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_RPATH}:\$ORIGIN/../bin:\$ORIGIN)
+set(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_RPATH}:\$ORIGIN/../bin:\$ORIGIN)
+
+set(SEVEN_BIT_DI_HEADERS_DIR "${CMAKE_SOURCE_DIR}/Include")
 
-set(LIBRARY_TYPE "HeaderOnly" CACHE STRING
-    "Library build type: Shared;Static;HeaderOnly")
+file(GLOB SEVEN_BIT_DI_TOP_HEADERS "${SEVEN_BIT_DI_HEADERS_DIR}/SevenBit/DI/*.hpp")
+file(GLOB SEVEN_BIT_DI_DETAILS_HEADERS "${SEVEN_BIT_DI_HEADERS_DIR}/SevenBit/DI/Details/*.hpp")
+file(GLOB SEVEN_BIT_DI_IMPL_HEADERS "${SEVEN_BIT_DI_HEADERS_DIR}/SevenBit/DI/Impl/*.hpp")
+set(SEVEN_BIT_DI_ALL_HEADERS ${SEVEN_BIT_DI_TOP_HEADERS} ${SEVEN_BIT_DI_DETAILS_HEADERS} ${SEVEN_BIT_DI_IMPL_HEADERS})
 
-set(LIBRARY_TYPE_VALUES "Shared;Static;HeaderOnly" CACHE STRING
-    "List of possible BUILD_LIBRARY_Type values")
+source_group("Header Files\\SevenBit" FILES ${SEVEN_BIT_DI_TOP_HEADERS})
+source_group("Header Files\\SevenBit\\Details" FILES ${SEVEN_BIT_DI_DETAILS_HEADERS})
+source_group("Header Files\\SevenBit\\Details\\Impl" FILES ${SEVEN_BIT_DI_IMPL_HEADERS})
 
-set_property(CACHE LIBRARY_TYPE PROPERTY STRINGS ${LIBRARY_TYPE_VALUES})
+# build shared option
+option(SEVEN_BIT_DI_BUILD_SHARED "Build shared library" OFF)
 
-set(BUILD_DOCS false CACHE BOOL "Turn on to build documentation")
-set(BUILD_TESTS false CACHE BOOL "Turn on to build tests")
-set(BUILD_EXAMPLES false CACHE BOOL "Turn on to build examples")
+# build position independent code
+option(SEVEN_BIT_DI_BUILD_PIC "Build position independent code (-fPIC)" OFF)
 
-set(SEVEN_BIT_INJECTOR_VERSION ${CMAKE_PROJECT_VERSION})
+# example options
+option(SEVEN_BIT_DI_BUILD_EXAMPLES "Build example" OFF)
+option(SEVEN_BIT_DI_BUILD_EXAMPLES_HO "Build header only example" OFF)
 
-if(LIBRARY_TYPE STREQUAL "Shared")
-    set(BUILD_LIBRARY_TYPE "Shared")
-    set(SEVEN_BIT_INJECTOR_SHARED_LIB true)
-elseif(LIBRARY_TYPE STREQUAL "Static")
-    set(BUILD_LIBRARY_TYPE "Static")
-    set(SEVEN_BIT_INJECTOR_STATIC_LIB true)
-else() # headerOnly
-    set(BUILD_LIBRARY_TYPE "HeaderOnly")
-    set(SEVEN_BIT_INJECTOR_HEADER_ONLY_LIB true)
+# testing options
+option(SEVEN_BIT_DI_BUILD_TESTS "Build tests" OFF)
+option(SEVEN_BIT_DI_BUILD_TESTS_HO "Build tests using the header only version" OFF)
+
+# build documentation option (requires sphinx and doxygen installed)
+option(SEVEN_BIT_DI_BUILD_DOCS "Turn on to build documentation" OFF)
+
+if(SEVEN_BIT_DI_BUILD_PIC)
+    set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 endif()
 
-configure_file(Include/SevenBit/DI/CmakeDef.hpp.input ${PROJECT_SOURCE_DIR}/Include/SevenBit/DI/CmakeDef.hpp)
+set(PROJECT_CONFIG_IN ${CMAKE_SOURCE_DIR}/Cmake/7bitDIConfig.cmake.in)
+set(PROJECT_CONFIG_OUT ${CMAKE_BINARY_DIR}/7bitDIConfig.cmake)
+set(CONFIG_TARGETS_FILE 7bitDIConfigTargets.cmake)
+set(VERSIONS_CONFIG_FILE ${CMAKE_BINARY_DIR}/7bitDIConfigVersion.cmake)
+set(EXPORT_DEST_DIR cmake/7bitDI)
+
+configure_file(${CMAKE_SOURCE_DIR}/Include/SevenBit/DI/Version.hpp.input ${CMAKE_SOURCE_DIR}/Include/SevenBit/DI/Version.hpp)
 
 set(INFOS
-    "${CMAKE_PROJECT_NAME} version: ${SEVEN_BIT_INJECTOR_VERSION}"
-    "${CMAKE_PROJECT_NAME} build as ${BUILD_LIBRARY_TYPE} library"
+    "${SEVEN_BIT_DI_PROJECT_NAME} version: ${SEVEN_BIT_DI_VERSION}"
+    "${SEVEN_BIT_DI_PROJECT_NAME} build as shared library ${SEVEN_BIT_DI_BUILD_SHARED} "
     "=================================================="
-    "Build tests: ${BUILD_TESTS}"
-    "Build examples: ${BUILD_EXAMPLES}"
-    "Build documentation: ${BUILD_DOCS}"
+    "Build tests: ${SEVEN_BIT_DI_BUILD_TESTS}"
+    "Build tests header only: ${SEVEN_BIT_DI_BUILD_TESTS_HO}"
+    "Build examples: ${SEVEN_BIT_DI_BUILD_EXAMPLES}"
+    "Build examples header only: ${SEVEN_BIT_DI_BUILD_EXAMPLES_HO}"
+    "Build documentation: ${SEVEN_BIT_DI_BUILD_DOCS}"
 )
 printInfo("${INFOS}" = 50 7 0)

Docs/CMakeLists.txt

@@ -30,5 +30,6 @@ add_custom_target(GenerateDoc
 )
 
 include(GNUInstallDirs)
+
 install(DIRECTORY ${SPHINX_BUILD}
-        DESTINATION ${CMAKE_INSTALL_DOCDIR})
+        DESTINATION doc)