The final cut and cleanup

Author: ClausKlein

.pre-commit-config.yaml

@@ -15,23 +15,24 @@ repos:
   # This brings in a portable version of clang-format.
   # See also: https://github.com/ssciwr/clang-format-wheel
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v21.1.7
+    rev: v21.1.8
     hooks:
     - id: clang-format
       types_or: [c++, c, json]
 
   # CMake linting and formatting
   - repo: https://github.com/BlankSpruce/gersemi
-    rev: 0.23.2
+    rev: 0.25.1
     hooks:
     - id: gersemi
       name: CMake linting
-      exclude: ^.*/tests/.*/data/ # Exclude test data directories
+      args: ["--no-warn-about-unknown-commands"]
+      exclude: ^.*/test/.*/data/ # Exclude test data directories
 
   # Markdown linting
   # Config file: .markdownlint.yaml
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.46.0
+    rev: v0.47.0
     hooks:
     - id: markdownlint
 

GNUmakefile

@@ -9,25 +9,28 @@ MAKEFLAGS+= --no-builtin-rules  # Disable the built-in implicit rules.
 export hostSystemName=$(shell uname)
 
 ifeq (${hostSystemName},Darwin)
-  export LLVM_PREFIX=$(shell brew --prefix llvm)
-  export LLVM_DIR=$(shell realpath ${LLVM_PREFIX})
+  export LLVM_PREFIX:=$(shell brew --prefix llvm)
+  export LLVM_DIR:=$(shell realpath ${LLVM_PREFIX})
   export PATH:=${LLVM_DIR}/bin:${PATH}
 
   export CMAKE_CXX_STDLIB_MODULES_JSON=${LLVM_DIR}/lib/c++/libc++.modules.json
   export CXX=clang++
-  export LDFLAGS=-L$(LLVM_DIR)/lib/c++ -lc++abi -lc++ # -lc++experimental
+  export LDFLAGS=-L$(LLVM_DIR)/lib/c++ -lc++abi # XXX -lc++ # NO! -lc++experimental
   export GCOV="llvm-cov gcov"
 
   ### TODO: to test g++-15:
-  export GCC_PREFIX=$(shell brew --prefix gcc)
-  export GCC_DIR=$(shell realpath ${GCC_PREFIX})
+  export GCC_PREFIX:=$(shell brew --prefix gcc)
+  export GCC_DIR:=$(shell realpath ${GCC_PREFIX})
 
-  # export CMAKE_CXX_STDLIB_MODULES_JSON=${GCC_DIR}/lib/gcc/current/libstdc++.modules.json
-  # export CXX:=g++-15
-  # export CXXFLAGS:=-stdlib=libstdc++
+# export CMAKE_CXX_STDLIB_MODULES_JSON:=${GCC_DIR}/lib/gcc/current/libstdc++.modules.json
+  # export CXX=g++-15
+  # export CXXFLAGS=-stdlib=libstdc++
   # export GCOV="gcov"
+
+  ### XXX: to test appleclang
+  # export CXX=/usr/bin/c++
 else ifeq (${hostSystemName},Linux)
-  # export LLVM_DIR=/usr/lib/llvm-20
+  # export LLVM_DIR:=/usr/lib/llvm-20
   # export PATH:=${LLVM_DIR}/bin:${PATH}
   # export CXX=clang++-20
 endif
@@ -36,14 +39,14 @@ CONAN_HOME=$(shell conan config home)
 # BUILD_TYPE=Release
 BUILD_TYPE=Debug
 
-.PHONY: all clean distclean check test
+.PHONY: all clean distclean check test format citest
 
 all: .init # XXX clean # NO! conan
 	cmake --workflow --preset dev
 	# TODO(CK): gcovr -v
 
 check: all
-	-run-clang-tidy -p build/dev
+	-run-clang-tidy
 
 .init: .CMakeUserPresets.json GNUmakefile
 	-pipx ensurepath
@@ -67,10 +70,22 @@ clean:
 	rm -rf build example/build
 
 distclean: clean
-	rm -rf conan stagedir .init CMakeUserPresets.json tags
+	rm -rf conan stagedir .init CMakeUserPresets.json tags compile_commands.json
 	find . -name '*~' -delete
 	# XXX NO! git clean -xdf
 
+citest: distclean
+	cmake --preset ci-Darwin # XXX --log-level=VERBOSE --fresh
+	ninja -C build
+	ctest --test-dir build --verbose
+	cd build && cmake -L . && cd ..
+	ln -fs build/compile_commands.json .
+	run-clang-tidy
+
+format:
+	-pre-commit autoupdate
+	pre-commit run --all
+
 GNUmakefile :: ;
 *.txt :: ;
 *.json :: ;

cmake/cxx-modules-rules.cmake

@@ -1,10 +1,21 @@
 include_guard()
 
-# Use modules?
+# Use modules? default NO!
 set(ALGO_USE_MODULES OFF)
 
 set(CMAKE_SKIP_TEST_ALL_DEPENDENCY OFF)
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# gersemi: off
+option(CMAKE_EXPORT_COMPILE_COMMANDS "Prepare run-clang-tidy" ${PROJECT_IS_TOP_LEVEL})
+if(CMAKE_EXPORT_COMPILE_COMMANDS)
+    message(
+        STATUS
+        "CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES=${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES}"
+    )
+    set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES ${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES}
+    )
+endif()
+# gersemi: on
 
 # Ensure non-empty default build type for single-config
 get_property(isMultiConfig GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
@@ -13,16 +24,19 @@ if(NOT isMultiConfig)
 endif()
 set(CMAKE_DEBUG_POSTFIX _debug)
 
-# This property setting also needs to be consistent between the
-# installed shared library and its consumer, otherwise most
-# toolchains will once again reject the consumer's generated BMI.
+# This property setting also needs to be consistent between the installed shared
+# library and its consumer, otherwise most toolchains will once again reject the
+# consumer's generated BMI.
 if(NOT DEFINED CMAKE_CXX_STANDARD)
     set(CMAKE_CXX_STANDARD 23)
-    set(CMAKE_CXX_EXTENSIONS ON)
-    set(CMAKE_CXX_STANDARD_REQUIRED ON)
 endif()
 
-if(CMAKE_GENERATOR STREQUAL "Ninja")
+# Neither of these two are technically needed, but they make the expectation clear
+set(CMAKE_CXX_EXTENSIONS ON)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# NOTE: only with Ninja generator install of bmi files works yet!
+if(CMAKE_GENERATOR MATCHES "Ninja")
     if(
         CMAKE_CXX_COMPILER_ID STREQUAL "Clang"
         AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 19.0
@@ -61,13 +75,17 @@ if(${CMAKE_CXX_STANDARD} IN_LIST CMAKE_CXX_COMPILER_IMPORT_STD)
 endif()
 
 message(STATUS "ALGO_USE_MODULES=${ALGO_USE_MODULES}")
-message(
-    STATUS
-    "CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES=${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES}"
-)
 
+# Avoid creating CMAKE_..._OUTPUT_DIRECTORY as cache variables, they should not
+# be under the control of the developer. They should be controlled by the
+# project because parts of the project may make assumptions about the relative
+# layout of the binaries. More importantly, leaving them as ordinary variables
+# also means they can be unset within subdirectories where test executables are
+# defined, allowing them to avoid being collected with the other main binaries
+# and cluttering up that area.
 set(stageDir ${CMAKE_CURRENT_BINARY_DIR}/stagedir)
 include(GNUInstallDirs)
+
 if(NOT CMAKE_RUNTIME_OUTPUT_DIRECTORY)
     set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${stageDir}/${CMAKE_INSTALL_BINDIR})
 endif()

cmake/prelude.cmake

@@ -11,14 +11,38 @@ if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
 endif()
 
 # gersemi: off
-if(CMAKE_VERSION VERSION_EQUAL 4.2)
+# ---------------------------------------------------------------------------
+# use ccache if found
+# ---------------------------------------------------------------------------
+find_program(CCACHE_EXECUTABLE "ccache" HINTS /usr/local/bin /opt/local/bin)
+if(CCACHE_EXECUTABLE)
+    message(STATUS "use ccache")
+    set(CMAKE_CXX_COMPILER_LAUNCHER "${CCACHE_EXECUTABLE}" CACHE PATH "ccache")
+    set(CMAKE_C_COMPILER_LAUNCHER "${CCACHE_EXECUTABLE}" CACHE PATH "ccache")
+endif()
+
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR})
+
+# ---------------------------------------------------------------------------
+# check if import std; is supported by CMAKE_CXX_COMPILER
+# ---------------------------------------------------------------------------
+if(CMAKE_VERSION VERSION_GREATER_EQUAL 4.2)
     set(CMAKE_EXPERIMENTAL_CXX_IMPORT_STD "d0edc3af-4c50-42ea-a356-e2862fe7a444")
 endif()
 # gersemi: on
 
-if($ENV{CXX} MATCHES "clang" OR CMAKE_CXX_COMPILER MATCHES "clang")
+if("$ENV{CXX}" STREQUAL "")
+    message(WARNING "\$CXX is not set")
+    # if(UNIX)
+    #     set(ENV{CXX} clang++)
+    # else()
+    #     set(ENV{CXX} cl)
+    # endif()
+endif()
+
+if(CMAKE_VERSION VERSION_GREATER 4.1 AND ("$ENV{CXX}" MATCHES "clang" OR CMAKE_CXX_COMPILER MATCHES "clang"))
+    # NOTE: Always use libc++
     # see https://releases.llvm.org/19.1.0/projects/libcxx/docs/index.html
-    # Always use libc++
     set(ENV{CXXFLAGS} -stdlib=libc++)
     message(STATUS "CXXFLAGS=-stdlib=libc++")
 
@@ -39,7 +63,7 @@ if($ENV{CXX} MATCHES "clang" OR CMAKE_CXX_COMPILER MATCHES "clang")
         set(CMAKE_CXX_STDLIB_MODULES_JSON
             ${LLVM_DIR}/lib/c++/libc++.modules.json
         )
-    elseif(LINUX AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 21.0)
+    elseif(LINUX)
         execute_process(
             OUTPUT_VARIABLE LLVM_MODULES
             COMMAND clang++ -print-file-name=c++/libc++.modules.json
@@ -56,12 +80,21 @@ if($ENV{CXX} MATCHES "clang" OR CMAKE_CXX_COMPILER MATCHES "clang")
     endif()
 
     if(EXISTS ${CMAKE_CXX_STDLIB_MODULES_JSON})
+        message(
+            STATUS
+            "CMAKE_CXX_STDLIB_MODULES_JSON=${CMAKE_CXX_STDLIB_MODULES_JSON}"
+        )
         # gersemi: off
         set(CACHE{CMAKE_CXX_STDLIB_MODULES_JSON}
             TYPE FILEPATH
             HELP "Result of: clang++ -print-file-name=c++/libc++.modules.json"
             VALUE ${CMAKE_CXX_STDLIB_MODULES_JSON}
         )
         # gersemi: on
+    else()
+        message(
+            WARNING
+            "File does NOT EXISTS! ${CMAKE_CXX_STDLIB_MODULES_JSON}"
+        )
     endif()
 endif()

example/CMakeLists.txt

@@ -5,7 +5,6 @@ include(../cmake/prelude.cmake)
 project(cmake-init-modulesExamples LANGUAGES CXX)
 
 if(PROJECT_IS_TOP_LEVEL)
-    # Neither of these two are technically needed, but they make the expectation clear
     include(../cmake/cxx-modules-rules.cmake)
 
     find_package(my_package 0.2.0 EXACT REQUIRED)
@@ -48,6 +47,7 @@ if(NOT PROJECT_IS_TOP_LEVEL AND CMAKE_BUILD_TYPE STREQUAL Release)
             --build-options #
             "-D CMAKE_BUILD_TYPE=$<CONFIG>"
             "-D CMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}"
+            "-D CMAKE_CXX_STANDARD=${CMAKE_CXX_STANDARD}"
             "-D CMAKE_CXX_STDLIB_MODULES_JSON=${CMAKE_CXX_STDLIB_MODULES_JSON}"
             "-D CMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}"
             "-D CMAKE_PREFIX_PATH=${CMAKE_BINARY_DIR}/stagedir"

requirements.txt

@@ -6,14 +6,14 @@ Pygments
 black
 builddriver
 cmake-init>=0.41.1
-cmake>=4.2
+cmake>=4.2.1
 codespell>=2.4.1
-conan>=2.23
-gcovr>=8.4
-gersemi>=0.23.2
+conan>=2.24.0
+gcovr>=8.6
+gersemi>=0.25.1
 isort
 jinja2>=3.1.3
 ninja>=1.13.0
-pre-commit>=4.5.0
+pre-commit>=4.5.1
 pylint
 yamllint