Feature/export cmake config package

.cmake-format

@@ -0,0 +1,19 @@
+format:
+  line_width: 119
+  tab_size: 4
+  max_subgroups_hwrap: 4
+  max_rows_cmdline: 8
+  separate_ctrl_name_with_space: false
+  separate_fn_name_with_space: false
+  dangle_parens: true
+  dangle_align: prefix
+  line_ending: unix
+  keyword_case: upper
+  always_wrap:
+  - file
+  - install
+  - project
+  - write_basic_package_version_file
+
+markup:
+  enable_markup: false

.github/workflows/ci_tests.yml

@@ -11,21 +11,38 @@ on:
     - cron: '30 15 * * *'
 
 jobs:
-  # preset-test:
-  #   runs-on: ubuntu-latest
-  #   strategy:
-  #     matrix:
-  #       preset: []
-  #   name: "Preset Test: ${{ matrix.preset }}"
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - name: Setup build environment
-  #       uses: lukka/get-cmake@latest
-  #       with:
-  #         cmakeVersion: "~3.25.0"
-  #         ninjaVersion: "^1.11.1"
-  #     - name: Run preset
-  #       run: cmake --workflow --preset ${{ matrix.preset }}
+  preset-test:
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        preset: [debug, release, gcov, asan, lsan, usan]
+        compiler:
+          - cpp: g++-14
+            c: gcc-14
+            gcov: ""
+          - cpp: clang++-18
+            c: clang-18
+            gcov: llvm-cov-18
+    name: "Preset Test: ${{ matrix.preset }} ${{ matrix.compiler.cpp }}"
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup build environment
+        uses: aminya/setup-cpp@v1
+        with:
+          # cmake: true
+          ninja: true
+          gcovr: true
+
+      - name: Run preset ${{ matrix.preset }} ${{ matrix.compiler.cpp }}
+        run: |
+          which llvm-cov gcov gcovr || echo ignored
+          cmake --workflow --preset ${{ matrix.preset }}
+        env:
+          CC: ${{ matrix.compiler.c }}
+          CXX: ${{ matrix.compiler.cpp }}
+          GCOV: ${{ matrix.compiler.gcov }}
 
   test:
     strategy:
@@ -82,7 +99,7 @@ jobs:
           ninja --version
       - name: Configure CMake
         run: |
-          cmake -B build -S . "-DCMAKE_CXX_STANDARD=${{ matrix.cpp_version }} ${{ matrix.cmake_args.args }}"
+          cmake -B build -S . -DCMAKE_PREFIX_PATH=/tmp/beman.inplace_vector "-DCMAKE_CXX_STANDARD=${{ matrix.cpp_version }} ${{ matrix.cmake_args.args }}"
         env:
           CC: ${{ matrix.compiler.c }}
           CXX: ${{ matrix.compiler.cpp }}

.github/workflows/macos.yml

@@ -0,0 +1,44 @@
+# .github/workflows/macos.yml
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+name: Macos Build
+
+on:
+  push:
+    branches: ["main", "develop"]
+  pull_request:
+    branches: ["main", "develop"]
+
+jobs:
+  build:
+    runs-on: macos-15
+    strategy:
+      fail-fast: false
+
+      matrix:
+        preset: [debug, release, gcov, asan, lsan, usan]
+        # TODO: compiler: [g++, clang++-19]
+        compiler: [clang++-19]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Cpp
+        uses: aminya/setup-cpp@v1
+        with:
+          # cmake: true
+          ninja: true
+          gcovr: true
+
+      - name: Install llvm-19
+        if: startsWith(matrix.compiler, 'clang')
+        run: |
+          brew install llvm@19
+
+      - name: macos clang++-19 ${{ matrix.preset }}
+        if: startsWith(matrix.compiler, 'clang')
+        run: GCOV=$(brew --prefix llvm@19)/bin/llvm-cov CXX=$(brew --prefix llvm@19)/bin/clang++ cmake --workflow --preset ${{ matrix.preset }}
+
+      - name: macos g++ ${{ matrix.preset }}
+        if: startsWith(matrix.compiler, 'g++')
+        run: CXX=${{ matrix.compiler }} cmake --workflow --preset ${{ matrix.preset }}

.github/workflows/windows.yml

@@ -0,0 +1,48 @@
+# .github/workflows/windows.yml
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+name: Windows Build
+
+on:
+  push:
+    branches: ["main", "develop"]
+  pull_request:
+    branches: ["main", "develop"]
+
+jobs:
+  build:
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+
+      matrix:
+        preset: [debug, release]
+        # TODO: compiler: [cl, clang-cl]
+        compiler: [cl]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # see https://github.com/marketplace/actions/enable-developer-command-prompt
+      - uses: ilammy/msvc-dev-cmd@v1
+        with:
+          vsversion: 2022
+
+      # - name: build environment
+      #   run: pip install -r requirements.txt
+
+      - name: cmake workflow ${{ matrix.preset }}
+        shell: bash
+        run: |
+          cmake --version
+          ninja --version
+          CXX=${{ matrix.compiler }} cmake --workflow --preset ${{ matrix.preset }}
+
+      # - name: configure
+      #   run: CXX=${{ matrix.compiler }} cmake --preset ${{ matrix.preset }}
+
+      # - name: build
+      #   run: cmake --build --preset ${{ matrix.preset }}
+
+      # - name: ctest
+      #   run: ctest --preset ${{ matrix.preset }}

.gitignore

@@ -1,3 +1,4 @@
+/stagedir
 /build
 /out
 CMakeUserPresets.json

CMakeLists.txt

@@ -3,16 +3,22 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 # cmake-format: on
 
-cmake_minimum_required(VERSION 3.23)
+set(CMAKE_SKIP_TEST_ALL_DEPENDENCY FALSE)
+
+cmake_minimum_required(VERSION 3.25...3.31)
 
 project(
-    beman.inplace_vector
+    beman_inplace_vector
     VERSION 1.0.0
     DESCRIPTION
         "A dynamically-resizable vector with fixed capacity and embedded storage"
     LANGUAGES CXX
 )
 
+if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
+    message(FATAL_ERROR "In-source builds are not allowed!")
+endif()
+
 # [CMAKE.SKIP_EXAMPLES]
 option(
     BEMAN_EXEMPLAR_BUILD_EXAMPLES
@@ -27,41 +33,102 @@ option(
     ${PROJECT_IS_TOP_LEVEL}
 )
 
+# includes
 include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
 
-add_library(beman.inplace_vector INTERFACE)
+add_library(beman_inplace_vector INTERFACE)
 # [CMAKE.LIBRARY_ALIAS]
-add_library(beman::inplace_vector ALIAS beman.inplace_vector)
+add_library(beman::beman_inplace_vector ALIAS beman_inplace_vector)
 
-target_include_directories(
-    beman.inplace_vector
+target_sources(
+    beman_inplace_vector
+    PUBLIC
+        FILE_SET inplace_vector_public_headers
+        TYPE HEADERS
+        BASE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/include
+        FILES
+            "${CMAKE_CURRENT_SOURCE_DIR}/include/beman/inplace_vector/inplace_vector.hpp"
+)
+set_target_properties(
+    beman_inplace_vector
+    PROPERTIES VERIFY_INTERFACE_HEADER_SETS ON
+)
+target_compile_features(
+    beman_inplace_vector
     INTERFACE
-        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-        $<INSTALL_INTERFACE:include>
+        "$<$<COMPILE_FEATURES:cxx_std_23>:cxx_std_23>"
+        "$<$<NOT:$<COMPILE_FEATURES:cxx_std_23>>:cxx_std_20>"
 )
 
-# Install the InplaceVector library to the appropriate destination
-install(
-    TARGETS beman.inplace_vector
-    EXPORT ${TARGETS_EXPORT_NAME}
-    DESTINATION
-    ${CMAKE_INSTALL_LIBDIR}
-)
+# export cmake config package
+block()
+    # NOTE: copied from execution26:
+    # FIXME: but not yet used? CK
+    # set(TARGET_NAME inplace_vector)
+    # set(TARGET_NAMESPACE beman)
+    # set(TARGET_PREFIX ${TARGET_NAMESPACE}.${TARGET_NAME})
+    # set(TARGET_LIBRARY ${PROJECT_NAME})
+    # set(TARGET_ALIAS ${TARGET_NAMESPACE}::${TARGET_LIBRARY})
 
-# Install the header files to the appropriate destination
-install(
-    DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
-    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${CMAKE_PROJECT_NAME}
-    FILES_MATCHING
-    PATTERN
-    "${CMAKE_CURRENT_SOURCE_DIR}/include/beman/inplace_vector/inplace_vector.hpp"
-)
+    set(TARGET_PACKAGE_NAME ${PROJECT_NAME}-config)
+    set(TARGETS_EXPORT_NAME ${PROJECT_NAME}-targets)
+    set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
+
+    # Install the InplaceVector library to the appropriate destination
+    install(
+        TARGETS beman_inplace_vector
+        EXPORT ${TARGETS_EXPORT_NAME}
+        FILE_SET inplace_vector_public_headers
+    )
+
+    write_basic_package_version_file(
+        ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}-version.cmake
+        VERSION ${PROJECT_VERSION}
+        COMPATIBILITY AnyNewerVersion
+    )
+
+    configure_package_config_file(
+        cmake/Config.cmake.in
+        ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}.cmake
+        INSTALL_DESTINATION ${INSTALL_CONFIGDIR}
+    )
+
+    install(
+        FILES
+            ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}.cmake
+            ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}-version.cmake
+        DESTINATION ${INSTALL_CONFIGDIR}
+    )
+
+    install(
+        EXPORT ${TARGETS_EXPORT_NAME}
+        FILE ${TARGETS_EXPORT_NAME}.cmake
+        DESTINATION "${INSTALL_CONFIGDIR}"
+        NAMESPACE beman::
+    )
+
+    set(CPACK_GENERATOR TGZ)
+    include(CPack)
+endblock()
 
 if(BEMAN_INPLACE_VECTOR_BUILD_TESTS)
-    include(CTest)
+    enable_testing()
     add_subdirectory(tests/beman/inplace_vector)
 endif()
 
 if(BEMAN_EXEMPLAR_BUILD_EXAMPLES)
     add_subdirectory(examples)
 endif()
+
+# Coverage
+configure_file(cmake/gcovr.cfg.in gcovr.cfg @ONLY)
+
+add_custom_target(
+    process_coverage
+    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    DEPENDS test
+    COMMENT "Running gcovr to process coverage results"
+    COMMAND mkdir -p coverage
+    COMMAND gcovr --config gcovr.cfg .
+)