Units module

.circleci/config.yml

@@ -1,14 +1,5 @@
 version: 2
 aliases:
-  - &setup_units
-    name: setup_units
-    environment:
-    command: |
-      mkdir -p build
-      cd build
-      eval cmake .. ${CMAKE_FLAGS}
-      make -j 4
-
   - &run_units
     name: run_units
     environment:
@@ -29,13 +20,6 @@ aliases:
       make -j 4
       make QUICK_RAW_FUZZ
 
-  - &run_installer_tests
-    name: run_installer_tests
-    command: |
-      cd build
-      make install
-      ctest -V -R find-package-tests
-
 jobs:
   unitsTSan:
     machine:
@@ -92,33 +76,11 @@ jobs:
       - store_artifacts:
           path: /root/project/build/FuzzTargets/units_fail_measurement_artifact.txt
 
-  unitsInstall:
-    docker:
-      - image: helics/buildenv:builder
-    environment:
-      CMAKE_FLAGS: "-DUNITS_ENABLE_TESTS=ON -DUNITS_INSTALL_PACKAGE_TESTS=ON -DUNITS_BUILD_SHARED_LIBRARY=ON"
-    steps:
-      - checkout
-      - run: *setup_units
-      - run: *run_installer_tests
-
-  unitsInstall-alt:
-    docker:
-      - image: helics/buildenv:builder
-    environment:
-      CMAKE_FLAGS: "-DUNITS_ENABLE_TESTS=ON -DUNITS_INSTALL_PACKAGE_TESTS=ON -DUNITS_BUILD_SHARED_LIBRARY=ON -DUNITS_CMAKE_PROJECT_NAME=LLNL-UNITS"
-    steps:
-      - checkout
-      - run: *setup_units
-      - run: *run_installer_tests
-
 workflows:
   version: 2
   units_test:
     jobs:
       #      - unitsMSan
       - unitsASan
       #      - unitsTSan
-      - unitsInstall
-      - unitsInstall-alt
       - unitsFuzz

.github/workflows/packaging.yml

@@ -0,0 +1,119 @@
+name: Packaging Tests
+on:
+  push:
+    branches:
+      - main
+      - v*
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+env:
+  CTEST_OUTPUT_ON_FAILURE: "1"
+
+jobs:
+  install:
+    name: Install Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+
+      - name: Configure
+        run: |
+          cmake -S . -B build \
+            -DUNITS_ENABLE_TESTS=ON \
+            -DUNITS_INSTALL_PACKAGE_TESTS=ON \
+            -DUNITS_BUILD_SHARED_LIBRARY=ON \
+            -DCMAKE_INSTALL_PREFIX=/home/runner/work/install
+
+      - name: Build
+        run: cmake --build build -j2
+
+      - name: Install
+        run: cmake --install build
+
+      - name: Run package tests
+        run: ctest --output-on-failure -R find-package-tests
+        working-directory: build
+
+  install-alt:
+    name: Install Tests Alt Package Name
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+
+      - name: Configure
+        run: |
+          cmake -S . -B build \
+            -DUNITS_ENABLE_TESTS=ON \
+            -DUNITS_INSTALL_PACKAGE_TESTS=ON \
+            -DUNITS_BUILD_SHARED_LIBRARY=ON \
+            -DUNITS_CMAKE_PROJECT_NAME=LLNL-UNITS \
+            -DCMAKE_INSTALL_PREFIX=/home/runner/work/install
+
+      - name: Build
+        run: cmake --build build -j2
+
+      - name: Install
+        run: cmake --install build
+
+      - name: Run package tests
+        run: ctest --output-on-failure -R find-package-tests
+        working-directory: build
+
+  install-module:
+    name: Install Module Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Clang
+        uses: egor-tensin/setup-clang@v2
+        with:
+          version: 20
+          platform: x64
+      - name: Install specific libc++ version
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libc++-20-dev libc++abi-20-dev lld-20
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+
+      - uses: ./.github/actions/quick_cmake
+        with:
+          cmake-version: "4.2"
+
+      - uses: seanmiddleditch/gha-setup-ninja@master
+
+      - name: Configure
+        run: |
+          cmake -S . -B build -G Ninja \
+            -DUNITS_ENABLE_TESTS=ON \
+            -DUNITS_INSTALL_PACKAGE_TESTS=ON \
+            -DUNITS_BUILD_SHARED_LIBRARY=ON \
+            -DUNITS_BUILD_CXX_MODULE=ON \
+            -DCMAKE_CXX_STANDARD=23 \
+            -DCMAKE_INSTALL_PREFIX=/home/runner/work/install \
+            -DCMAKE_CXX_COMPILER=clang++ \
+            -DCMAKE_LINKER_TYPE=LLD \
+            -DCMAKE_CXX_FLAGS=-stdlib=libc++
+
+      - name: Build
+        run: cmake --build build -j2
+
+      - name: Install
+        run: cmake --install build
+
+      - name: Run package tests
+        run: ctest --output-on-failure -R find-package-tests
+        working-directory: build

CMakeLists.txt

@@ -114,6 +114,11 @@ cmake_dependent_option(
     "CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME" OFF
 )
 
+cmake_dependent_option(
+    UNITS_BUILD_CXX_MODULE "Build an experimental C++20 module wrapper target" OFF
+    "NOT CMAKE_VERSION VERSION_LESS 3.28;NOT UNITS_HEADER_ONLY" OFF
+)
+
 cmake_dependent_option(
     UNITS_PYTHON_ONLY_INSTALL "Only install the python library" SKBUILD
     "UNITS_BUILD_PYTHON_LIBRARY" OFF

README.md

@@ -184,6 +184,33 @@ The second part is a few cpp files that can add some additional functionality. T
 
 It builds by default with the static library. Using `UNIT_BUILD_SHARED_LIBRARY` or `BUILD_SHARED_LIBS` will build the shared library instead. Either one can be used with CMake as a `units::units` target. The header only library target is also generated `units::header_only`. The shared/static library has a CMake target `units::units`.
 
+An experimental C++20 module wrapper can also be enabled with `-DUNITS_BUILD_CXX_MODULE=ON` when configuring with CMake 3.28 or newer. This adds a `units::module` target that exports the module name `units` from `units/units.cppm`.
+
+```cmake
+target_link_libraries(my_app PRIVATE units::module)
+target_compile_features(my_app PRIVATE cxx_std_20)
+```
+
+```cpp
+import units;
+
+int main()
+{
+    auto speed = 12.0 * units::m / units::s;
+    return (speed.units() == units::m / units::s) ? 0 : 1;
+}
+```
+
+The module currently guarantees a curated public surface in the `units::` namespace, including:
+
+- Core types and functions such as `unit`, `precise_unit`, `measurement`, `precise_measurement`, `convert`, `quick_convert`, `unit_from_string`, `measurement_from_string`, and `to_string`
+- All seven SI base units by symbol or common name: `m`/`meter`, `kg`/`kilogram`, `s`/`second`, `A`/`Ampere`, `K`/`Kelvin`, `mol`, and `cd`
+- Common SI and SI-derived units: `rad`, `Hz`, `N`, `J`, `W`, `V`, `ohm`, `Pa`, `C`, `cm`, `mm`, `km`, `L`, `g`, `degC`, and `degF`
+- Common non-SI and scalar units: `minute`, `h`, `hr`, `ft`/`foot`, `in`/`inch`, `mile`, `lb`, `gal`, `deg`, `mph`, `count`, and `currency`
+- Main prefixes as scalar units: `milli`, `micro`, `nano`, `pico`, `kilo`, `mega`, and `giga`
+
+Additional units remain available through the traditional headers, especially in `units::precise` and its subnamespaces.
+
 ## Try it out
 
 If you want to try out the string conversion components. There is server running that can do the string conversions