perf: add a module type

Signed-off-by: l.feng <43399351+msclock@users.noreply.github.com>

Author: msclock

.github/workflows/ci.yml

@@ -177,19 +177,24 @@ jobs:
       - name: Install compilers and tools
         run: |
           brew install ${{ matrix.compiler }} cmake ninja ccache lcov
+          brew link ${{ matrix.compiler }} --force
 
       - name: Prepare PATH for compilers
         run: echo "PATH=/usr/local/opt/${{ matrix.compiler }}/bin:$PATH" >> $GITHUB_ENV
 
       - name: Prepare for llvm
         if: contains(matrix.compiler, 'llvm')
         run: |
+          clang --version
+          clang++ --version
           echo "CC=clang" >> $GITHUB_ENV
           echo "CXX=clang++" >> $GITHUB_ENV
 
       - name: Prepare for gcc
         if: contains(matrix.compiler, 'gcc')
         run: |
+          gcc --version
+          g++ --version
           echo "CC=gcc" >> $GITHUB_ENV
           echo "CXX=g++" >> $GITHUB_ENV
           compiler=${{ matrix.compiler }}

README.md

@@ -39,7 +39,7 @@ A continuously evolving basic template for cpp development.
   - Provides `static/runtime analysis`including [clang-tidy](https://clang.llvm.org/extra/clang-tidy/), [cppcheck](http://cppcheck.net/manual.html), [sanitizers](https://clang.llvm.org/docs/index.html), [valgrind](https://valgrind.org/docs/manual/manual.html).
   - Supports `code coverage` with [lcov](https://github.com/linux-test-project/lcov), [gcovr](https://github.com/gcovr/gcovr), llvm-cov, and [opencppcoverage](https://github.com/OpenCppCoverage/OpenCppCoverage).
   - Supports `hardening compilation `for MSVC, Clang, and GCC.
-  - Provides compile, header, application target generation.
+  - Provide generation of various targets for compile library, header library, application and so on.
   - Build with preset build types: Debug(Default), Release, RelWithDebInfo, MinSizeRel.
   - Supports package managers: [vcpkg](https://github.com/microsoft/vcpkg), [conan](https://github.com/conan-io/cmake-conan), and [cpm](https://github.com/cpm-cmake/CPM.cmake).
 - Use [cmake-registry](https://github.com/msclock/cmake-registry) to provide various cmake modules and scripts.

copier.yml

@@ -179,6 +179,11 @@ compile_target:
   help: Add a compile lib target, and skip leaving it empty.
   type: str
 
+compile_module_target:
+  default: compile_module
+  help: Add a compile module lib target, and skip leaving it empty.
+  type: str
+
 use_codecov:
   default: true
   help: 'Whether to add codecov integration:'

includes/copier-answers-sample.yml

@@ -4,6 +4,7 @@ author_name: msclock
 codecov_notify_builds: 1
 codecov_threshold: 5%
 compile_target: compile
+compile_module_target: compile_module
 copyright_holder: Serious Scaffold
 copyright_license: MIT License
 copyright_year: 2022-2024

src/compile_module/CMakeLists.txt

@@ -0,0 +1,43 @@
+#[[
+To build this requires cmake specification from [cxxmodules](https://cmake.org/cmake/help/latest/manual/cmake-cxxmodules.7.html).
+
+]]
+cmake_minimum_required(VERSION 3.28.2)
+
+set(target_name compile_module)
+
+file(GLOB _interfaces "include/*.ixx")
+file(GLOB _srcs "src/*.cpp")
+
+add_library(${target_name})
+warn_target(${target_name})
+harden_target(${target_name})
+sanitize_target(${target_name})
+target_code_coverage(${target_name} ALL)
+
+generate_git_header(VERSION_NAMESPACE_PREFIX ${target_name})
+
+target_sources(
+  ${target_name}
+  PUBLIC FILE_SET
+         cxx_modules
+         TYPE
+         CXX_MODULES
+         FILES
+         ${_interfaces}
+         BASE_DIRS
+         ${CMAKE_CURRENT_SOURCE_DIR}/include
+  PRIVATE ${_srcs})
+
+target_include_interface_directories(
+  ${target_name} ${CMAKE_CURRENT_SOURCE_DIR}/include
+  ${CMAKE_CURRENT_BINARY_DIR}/git_version)
+
+target_compile_features(${target_name} PUBLIC cxx_std_23)
+set_property(TARGET ${target_name} PROPERTY CXX_SCAN_FOR_MODULES ON)
+
+install_dependency(TARGETS ${target_name})
+
+if(BUILD_TESTING)
+  add_test_subdirectory(tests)
+endif()

src/compile_module/include/compile_module.ixx

@@ -0,0 +1,9 @@
+module;
+
+export module compile_module;
+
+namespace compile_module {
+namespace distribution {
+export bool is_debug() noexcept;
+} // namespace distribution
+} // namespace compile_module

src/compile_module/src/compile_module.cpp

@@ -0,0 +1,15 @@
+module;
+
+module compile_module;
+
+namespace compile_module {
+namespace distribution {
+bool is_debug() noexcept {
+#ifdef _DEBUG
+    return true;
+#else
+    return false;
+#endif
+}
+} // namespace distribution
+} // namespace compile_module

src/compile_module/tests/CMakeLists.txt

@@ -0,0 +1,19 @@
+find_package(GTest CONFIG REQUIRED)
+
+include(GoogleTest)
+
+file(GLOB files "*.cpp")
+
+foreach(_file ${files})
+  get_filename_component(file_basename ${_file} NAME_WE)
+  add_executable(${file_basename} ${_file})
+  target_link_libraries(${file_basename} PRIVATE GTest::gtest_main
+                                                 compile_module)
+  target_compile_features(${file_basename} PUBLIC cxx_std_23)
+  set_property(TARGET ${file_basename} PROPERTY CXX_SCAN_FOR_MODULES ON)
+  warn_target(${file_basename})
+  harden_target(${file_basename})
+  sanitize_target(${file_basename})
+  target_code_coverage(${file_basename} ALL)
+  gtest_discover_tests(${file_basename})
+endforeach()

src/compile_module/tests/test_compile_module.cpp

@@ -0,0 +1,20 @@
+import compile_module;
+
+#include <gtest/gtest.h>
+#include "_version.hpp"
+
+#ifdef _DEBUG
+#define DIST_FLAG 1
+#else
+#define DIST_FLAG 0
+#endif
+
+TEST(compile_module, version) {
+    const auto* const version = git_ProjectVersion();
+    EXPECT_STRNE(version, "");
+}
+
+TEST(compile_module, distribution) {
+    const auto is_debug = compile_module::distribution::is_debug();
+    EXPECT_EQ(is_debug, DIST_FLAG);
+}

template/README.md.jinja

@@ -44,7 +44,7 @@
   - Provides `static/runtime analysis`including [clang-tidy](https://clang.llvm.org/extra/clang-tidy/), [cppcheck](http://cppcheck.net/manual.html), [sanitizers](https://clang.llvm.org/docs/index.html), [valgrind](https://valgrind.org/docs/manual/manual.html).
   - Supports `code coverage` with [lcov](https://github.com/linux-test-project/lcov), [gcovr](https://github.com/gcovr/gcovr), llvm-cov, and [opencppcoverage](https://github.com/OpenCppCoverage/OpenCppCoverage).
   - Supports `hardening compilation `for MSVC, Clang, and GCC.
-  - Provides compile, header, application target generation.
+  - Provide generation of various targets for compile library, header library, application and so on.
   - Build with preset build types: Debug(Default), Release, RelWithDebInfo, MinSizeRel.
   - Supports package managers: [vcpkg](https://github.com/microsoft/vcpkg), [conan](https://github.com/conan-io/cmake-conan), and [cpm](https://github.com/cpm-cmake/CPM.cmake).
 - Use [cmake-registry](https://github.com/msclock/cmake-registry) to provide various cmake modules and scripts.