Merge pull request #15 from lefticus/cleanups_add_missing_features

Cleanups add missing features

Author: lefticus

.clang-tidy

@@ -1,4 +1,7 @@
 ---
+
+# Unfortunately const-correctness seems to be almost completely broken
+# (clang 19)
 Checks: "*,
         -abseil-*,
         -altera-*,
@@ -11,18 +14,29 @@ Checks: "*,
         -readability-else-after-return,
         -readability-static-accessed-through-instance,
         -readability-avoid-const-params-in-decls,
+        -readability-simplify-boolean-expr,
         -cppcoreguidelines-non-private-member-variables-in-classes,
         -misc-non-private-member-variables-in-classes,
+        -misc-const-correctness,
 "
 WarningsAsErrors: ''
-HeaderFilterRegex: ''
+HeaderFilterRegex: '^(src|include)/.*'
 FormatStyle:     none
 
-CheckOptions:
-  readability-identifier-length.IgnoredVariableNames: 'x|y|z|id|ch'
-  readability-identifier-length.IgnoredParameterNames: 'x|y|z|id|ch'
-
 
+# Command line options
+ExtraArgs: [
+  '-Wno-unknown-warning-option',
+  '-Wno-ignored-optimization-argument',
+  '-Wno-unused-command-line-argument',
+  '-Wno-unknown-argument',
+  '-Wno-gcc-compat'
+]
 
+# Quiet mode is set via command line with --quiet
+# It doesn't have a YAML equivalent
 
+CheckOptions:
+  readability-identifier-length.IgnoredVariableNames: 'x|y|z|id|ch|to'
+  readability-identifier-length.IgnoredParameterNames: 'x|y|z|id|ch|to'
 

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on:
       - develop
 
 env:
-  CLANG_TIDY_VERSION: "16.0.0"
+  CLANG_TIDY_VERSION: "19.1.1"
   VERBOSE: 1
 
 
@@ -29,10 +29,11 @@ jobs:
       # and your own projects needs
       matrix:
         os:
-          - ubuntu-22.04
+          - ubuntu-latest
         compiler:
           # you can specify the version after `-` like "llvm-16.0.0".
-          - gcc-13
+          - gcc-14
+          - llvm-19.1.1
         generator:
           - "Ninja Multi-Config"
         build_type:
@@ -45,8 +46,8 @@ jobs:
         include:
           # Add appropriate variables for gcov version required. This will intentionally break
           # if you try to use a compiler that does not have gcov set
-          - compiler: gcc-13
-            gcov_executable: gcov
+          - compiler: gcc-14
+            gcov_executable: gcov-14
             enable_ipo: On
 
 
@@ -55,6 +56,10 @@ jobs:
             packaging_maintainer_mode: OFF
             package_generator: TBZ2
 
+          - compiler: llvm-19.1.1
+            enable_ip: Off
+            gcov_executable: "llvm-cov gcov"
+            
 
     steps:
       - name: Check for llvm version mismatches
@@ -114,7 +119,7 @@ jobs:
         # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
         run: |
           ctest -C ${{matrix.build_type}}
-          gcovr -j ${{env.nproc}} --delete --root ../ --print-summary --xml-pretty --xml coverage.xml . --gcov-executable '${{ matrix.gcov_executable }}'
+          gcovr -j ${{env.nproc}} --root ../ --print-summary --xml-pretty --xml coverage.xml . --gcov-executable '${{ matrix.gcov_executable }}'
 
       - name: Windows - Test and coverage
         if: runner.os == 'Windows'
@@ -139,6 +144,8 @@ jobs:
       - name: Publish to codecov
         uses: codecov/codecov-action@v2
         with:
+          fail_ci_if_error: true
           flags: ${{ runner.os }}
           name: ${{ runner.os }}-coverage
+          token: ${{ secrets.CODECOV_TOKEN }}
           files: ./build/coverage.xml

.github/workflows/wasm.yml

@@ -0,0 +1,59 @@
+name: Build Intro WASM and Deploy to GitHub Pages
+
+on:
+  pull_request:
+  release:
+    types: [published]
+  push:
+    branches: [main, develop]
+    tags: ['**']
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Emscripten
+        uses: mymindstorm/setup-emsdk@v14
+        with:
+          version: 'latest'
+
+      - name: Install Ninja
+        run: sudo apt-get install -y ninja-build
+
+      - name: Configure CMake
+        run: emcmake cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
+
+      - name: Build all WASM targets
+        run: emmake cmake --build build --target web-dist
+
+      - name: Prepare deployment
+        run: |
+          # web-dist target already created build/web-dist/
+          # Just copy it to dist/ for GitHub Pages action
+          cp -r build/web-dist dist
+
+      - name: Determine deploy path
+        id: deploy-path
+        if: github.event_name != 'pull_request' && github.event_name != 'release'
+        run: |
+          if [[ "$GITHUB_REF" == refs/tags/* ]]; then
+            echo "path=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+          elif [[ "$GITHUB_REF" == refs/heads/main ]]; then
+            echo "path=." >> $GITHUB_OUTPUT
+          elif [[ "$GITHUB_REF" == refs/heads/develop ]]; then
+            echo "path=develop" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name != 'pull_request' && github.event_name != 'release'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist
+          destination_dir: ${{ steps.deploy-path.outputs.path }}
+          keep_files: true

.gitignore

@@ -32,3 +32,5 @@ $RECYCLE.BIN/
 .TemporaryItems
 ehthumbs.db
 Thumbs.db
+
+**/.claude/settings.local.json

CLAUDE.md

@@ -2,6 +2,12 @@
 
 This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
 
+You are an expert in C++. You use C++23 and prefer to use constexpr wherever possible. You always apply C++ Best Practices as taught by Jason Turner.
+
+You are also an expert in scheme-like languages and know the pros and cons of various design decisions.
+
+
+
 ## Build Commands
 - Configure: `cmake -S . -B ./build`
 - Build: `cmake --build ./build`
@@ -16,6 +22,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 - `constexpr_tests` target compiles tests with static assertions
   - Will fail to compile if tests fail since they use static assertions
   - Makes debugging difficult as you won't see which specific test failed
+  - Will always fail to compile if there's a fail test; use relaxed_constexpr_tests or directly execute the tests with cons_expr command line tool for debugging
 - `relaxed_constexpr_tests` target compiles with runtime assertions
   - Preferred for debugging since it shows which specific tests fail
   - Use this target when developing/debugging: 
@@ -57,6 +64,10 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 - Header files follow #ifndef/#define guard pattern
 - Entire system is `constexpr` capable unless it uses IO
 - Use modern C++ style casts over C-style casts
+- Avoid macros completely except for header guards
+- Prefer templates, constexpr functions or concepts over macros
+- Use `static constexpr` for compile-time known constants
+- Prefer local constants within functions over function variables for readability
 
 ## Naming and Structure
 - Namespace: lefticus

CMakeLists.txt

@@ -23,8 +23,19 @@ project(
   LANGUAGES CXX C)
 
 include(cmake/PreventInSourceBuilds.cmake)
+include(cmake/Emscripten.cmake)
 include(ProjectOptions.cmake)
 
+if(MSVC)
+  
+elseif(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
+  add_compile_options(-fconstexpr-steps=12712420)
+elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+  
+else()
+  
+  # TODO support Intel compiler
+endif()
 
 cons_expr_setup_options()
 
@@ -67,6 +78,11 @@ add_subdirectory(src)
 
 add_subdirectory(examples)
 
+# Create unified web deployment directory (for WASM builds)
+if(EMSCRIPTEN)
+  cons_expr_create_web_dist()
+endif()
+
 # Don't even look at tests if we're not top level
 if(NOT PROJECT_IS_TOP_LEVEL)
   return()

Dependencies.cmake

@@ -21,7 +21,7 @@ function(cons_expr_setup_dependencies)
   endif()
 
   if(NOT TARGET Catch2::Catch2WithMain)
-    cpmaddpackage("gh:catchorg/Catch2@3.7.0")
+    cpmaddpackage("gh:catchorg/Catch2@3.8.1")
   endif()
 
   if(NOT TARGET CLI11::CLI11)

ProjectOptions.cmake

@@ -4,17 +4,57 @@ include(CMakeDependentOption)
 include(CheckCXXCompilerFlag)
 
 
+include(CheckCXXSourceCompiles)
+
+
 macro(cons_expr_supports_sanitizers)
-  if((CMAKE_CXX_COMPILER_ID MATCHES ".*Clang.*" OR CMAKE_CXX_COMPILER_ID MATCHES ".*GNU.*") AND NOT WIN32)
-    set(SUPPORTS_UBSAN ON)
+  # Emscripten doesn't support sanitizers
+  if(EMSCRIPTEN)
+    set(SUPPORTS_UBSAN OFF)
+    set(SUPPORTS_ASAN OFF)
+  elseif((CMAKE_CXX_COMPILER_ID MATCHES ".*Clang.*" OR CMAKE_CXX_COMPILER_ID MATCHES ".*GNU.*") AND NOT WIN32)
+
+    message(STATUS "Sanity checking UndefinedBehaviorSanitizer, it should be supported on this platform")
+    set(TEST_PROGRAM "int main() { return 0; }")
+
+    # Check if UndefinedBehaviorSanitizer works at link time
+    set(CMAKE_REQUIRED_FLAGS "-fsanitize=undefined")
+    set(CMAKE_REQUIRED_LINK_OPTIONS "-fsanitize=undefined")
+    check_cxx_source_compiles("${TEST_PROGRAM}" HAS_UBSAN_LINK_SUPPORT)
+
+    if(HAS_UBSAN_LINK_SUPPORT)
+      message(STATUS "UndefinedBehaviorSanitizer is supported at both compile and link time.")
+      set(SUPPORTS_UBSAN ON)
+    else()
+      message(WARNING "UndefinedBehaviorSanitizer is NOT supported at link time.")
+      set(SUPPORTS_UBSAN OFF)
+    endif()
   else()
     set(SUPPORTS_UBSAN OFF)
   endif()
 
   if((CMAKE_CXX_COMPILER_ID MATCHES ".*Clang.*" OR CMAKE_CXX_COMPILER_ID MATCHES ".*GNU.*") AND WIN32)
     set(SUPPORTS_ASAN OFF)
   else()
-    set(SUPPORTS_ASAN ON)
+    if (NOT WIN32)
+      message(STATUS "Sanity checking AddressSanitizer, it should be supported on this platform")
+      set(TEST_PROGRAM "int main() { return 0; }")
+
+      # Check if AddressSanitizer works at link time
+      set(CMAKE_REQUIRED_FLAGS "-fsanitize=address")
+      set(CMAKE_REQUIRED_LINK_OPTIONS "-fsanitize=address")
+      check_cxx_source_compiles("${TEST_PROGRAM}" HAS_ASAN_LINK_SUPPORT)
+
+      if(HAS_ASAN_LINK_SUPPORT)
+        message(STATUS "AddressSanitizer is supported at both compile and link time.")
+        set(SUPPORTS_ASAN ON)
+      else()
+        message(WARNING "AddressSanitizer is NOT supported at link time.")
+        set(SUPPORTS_ASAN OFF)
+      endif()
+    else()
+      set(SUPPORTS_ASAN ON)
+    endif()
   endif()
 endmacro()
 
@@ -54,8 +94,8 @@ macro(cons_expr_setup_options)
     option(cons_expr_ENABLE_SANITIZER_THREAD "Enable thread sanitizer" OFF)
     option(cons_expr_ENABLE_SANITIZER_MEMORY "Enable memory sanitizer" OFF)
     option(cons_expr_ENABLE_UNITY_BUILD "Enable unity builds" OFF)
-    option(cons_expr_ENABLE_CLANG_TIDY "Enable clang-tidy" OFF)
-    option(cons_expr_ENABLE_CPPCHECK "Enable cpp-check analysis" OFF)
+    option(cons_expr_ENABLE_CLANG_TIDY "Enable clang-tidy" ON)
+    option(cons_expr_ENABLE_CPPCHECK "Enable cpp-check analysis" ON)
     option(cons_expr_ENABLE_PCH "Enable precompiled headers" OFF)
     option(cons_expr_ENABLE_CACHE "Enable ccache" ON)
   endif()
@@ -130,19 +170,22 @@ macro(cons_expr_local_options)
     ""
     "")
 
-  if(cons_expr_ENABLE_USER_LINKER)
-    include(cmake/Linker.cmake)
-    configure_linker(cons_expr_options)
-  endif()
+  # Linker and sanitizers not supported in Emscripten
+  if(NOT EMSCRIPTEN)
+    if(cons_expr_ENABLE_USER_LINKER)
+      include(cmake/Linker.cmake)
+      cons_expr_configure_linker(cons_expr_options)
+    endif()
 
-  include(cmake/Sanitizers.cmake)
-  cons_expr_enable_sanitizers(
-    cons_expr_options
-    ${cons_expr_ENABLE_SANITIZER_ADDRESS}
-    ${cons_expr_ENABLE_SANITIZER_LEAK}
-    ${cons_expr_ENABLE_SANITIZER_UNDEFINED}
-    ${cons_expr_ENABLE_SANITIZER_THREAD}
-    ${cons_expr_ENABLE_SANITIZER_MEMORY})
+    include(cmake/Sanitizers.cmake)
+    cons_expr_enable_sanitizers(
+      cons_expr_options
+      ${cons_expr_ENABLE_SANITIZER_ADDRESS}
+      ${cons_expr_ENABLE_SANITIZER_LEAK}
+      ${cons_expr_ENABLE_SANITIZER_UNDEFINED}
+      ${cons_expr_ENABLE_SANITIZER_THREAD}
+      ${cons_expr_ENABLE_SANITIZER_MEMORY})
+  endif()
 
   set_target_properties(cons_expr_options PROPERTIES UNITY_BUILD ${cons_expr_ENABLE_UNITY_BUILD})
 

README.md

@@ -32,7 +32,15 @@
 * For C++23
    * Currently only known to work with GCC 13.1.
 
+* WebAssembly build support with automatic GitHub Pages deployment
 
+**Live Demo:** If you enable GitHub Pages in your project created from this template, you'll have a working example like this:
+
+- Main: [https://cpp-best-practices.github.io/cmake_template/](https://cpp-best-practices.github.io/cmake_template/)
+- Develop: [https://cpp-best-practices.github.io/cmake_template/develop/](https://cpp-best-practices.github.io/cmake_template/develop/)
+
+The `main` branch deploys to the root, `develop` to `/develop/`, and tags to `/tagname/`.
+ 
 ## Command Line Inspection Tool
 
 `ccons_expr` can be used to execute scripts and inspect the state of the runtime system live