Merge pull request #953 from cppalliance/develop

Merge to Master for v5.0.0

Author: mborland

.drone.jsonnet

@@ -194,7 +194,7 @@ local windows_pipeline(name, image, environment, arch = "amd64") =
     linux_pipeline(
         "Linux 22.04 GCC 12 64 ASAN",
         "cppalliance/droneubuntu2204:1",
-        { TOOLSET: 'gcc', COMPILER: 'g++-12', CXXSTD: '03,11,14,17,20,2b', ADDRMD: '64' } + asan,
+        { TOOLSET: 'gcc', COMPILER: 'g++-12', CXXSTD: '14,20', ADDRMD: '64' } + asan,
         "g++-12-multilib",
     ),
 

.github/workflows/ci.yml

@@ -78,7 +78,14 @@ jobs:
               - g++-11-multilib
           - toolset: gcc-12
             cxxstd: "03,11,14,17,20,23"
-            address_model: 32,64
+            address_model: 64
+            os: ubuntu-latest
+            container: ubuntu:22.04
+            install:
+              - g++-12-multilib
+          - toolset: gcc-12
+            cxxstd: "03,11,14,17,20,23"
+            address_model: 32
             os: ubuntu-latest
             container: ubuntu:22.04
             install:

.github/workflows/metal.yml

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------
-#  Copyright Matt Borland 2023 - 2024.
-#  Copyright Christopher Kormanyos 2023 - 2024.
+#  Copyright Matt Borland 2023 - 2025.
+#  Copyright Christopher Kormanyos 2023 - 2025.
 #  Distributed under the Boost Software License,
 #  Version 1.0. (See accompanying file LICENSE_1_0.txt
 #  or copy at http://www.boost.org/LICENSE_1_0.txt)
@@ -33,20 +33,20 @@ jobs:
           wget http://security.ubuntu.com/ubuntu/pool/universe/n/ncurses/libncursesw5_6.3-2ubuntu0.1_amd64.deb
           sudo apt install ./libncursesw5_6.3-2ubuntu0.1_amd64.deb
           mkdir -p emu_env && cd emu_env
-          wget --no-check-certificate https://developer.arm.com/-/media/Files/downloads/gnu/13.3.rel1/binrel/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi.tar.xz
-          tar -xf arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi.tar.xz
+          wget --no-check-certificate https://developer.arm.com/-/media/Files/downloads/gnu/14.3.rel1/binrel/arm-gnu-toolchain-14.3.rel1-x86_64-arm-none-eabi.tar.xz
+          tar -xf arm-gnu-toolchain-14.3.rel1-x86_64-arm-none-eabi.tar.xz
           wget --no-check-certificate https://github.com/xpack-dev-tools/qemu-arm-xpack/releases/download/v8.2.6-1/xpack-qemu-arm-8.2.6-1-linux-x64.tar.gz
           tar -xzf xpack-qemu-arm-8.2.6-1-linux-x64.tar.gz
         working-directory: ./test/metal/
       - name: build benchmark_single-stm32f429
         run: |
-          PATH="${{ runner.workspace }}/decimal/test/metal/emu_env/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin:$PATH"
+          PATH="${{ runner.workspace }}/decimal/test/metal/emu_env/arm-gnu-toolchain-14.3.rel1-x86_64-arm-none-eabi/bin:$PATH"
           echo 'Query arm-none-eabi-g++ version'
           echo
           arm-none-eabi-g++ -v
           echo
           mkdir -p bin
-          arm-none-eabi-g++ -std=c++20 -Wall -Wextra -Wpedantic -Os -g -gdwarf-2 -ffunction-sections -fdata-sections -x c++ -fno-rtti -fno-use-cxa-atexit -fno-exceptions -fno-nonansi-builtins -fno-threadsafe-statics -fno-enforce-eh-specs -fno-inline-functions -mcpu=cortex-m4 -mtune=cortex-m4 -mthumb -mfloat-abi=soft -mno-unaligned-access -mno-long-calls -I../../include -DBOOST_DECIMAL_DISABLE_CLIB -DAPP_BENCHMARK_STANDALONE_MAIN app_benchmark_non_std_decimal.cpp ./target/micros/stm32f429/make/single/crt.cpp ./target/micros/stm32f429/make/single/mcal_gcc_cxx_completion_with_stdlib.cpp -nostartfiles -Wl,--gc-sections -Wl,-Map,./bin/app_benchmark_non_std_decimal.map -T ./target/micros/stm32f429/make/stm32f429.ld --specs=nano.specs --specs=nosys.specs -Wl,--print-memory-usage -o ./bin/app_benchmark_non_std_decimal.elf
+          arm-none-eabi-g++ -std=c++23 -Wall -Wextra -Wpedantic  -Wconversion -Wsign-conversion -Wunused-parameter -Wuninitialized -Wshadow -Os -g -gdwarf-2 -ffunction-sections -fdata-sections -x c++ -fno-rtti -fno-use-cxa-atexit -fno-exceptions -fno-nonansi-builtins -fno-threadsafe-statics -fno-enforce-eh-specs -fno-inline-functions -mcpu=cortex-m4 -mtune=cortex-m4 -mthumb -mfloat-abi=soft -mno-unaligned-access -mno-long-calls -I../../include -DBOOST_DECIMAL_DISABLE_CLIB -DAPP_BENCHMARK_STANDALONE_MAIN app_benchmark_non_std_decimal.cpp ./target/micros/stm32f429/make/single/crt.cpp ./target/micros/stm32f429/make/single/mcal_gcc_cxx_completion_with_stdlib.cpp -nostartfiles -Wl,--gc-sections -Wl,-Map,./bin/app_benchmark_non_std_decimal.map -T ./target/micros/stm32f429/make/stm32f429.ld --specs=nano.specs --specs=nosys.specs -Wl,--print-memory-usage -o ./bin/app_benchmark_non_std_decimal.elf
           arm-none-eabi-objcopy ./bin/app_benchmark_non_std_decimal.elf -O ihex ./bin/app_benchmark_non_std_decimal.hex
           ls -la ./bin/app_benchmark_non_std_decimal.elf ./bin/app_benchmark_non_std_decimal.hex ./bin/app_benchmark_non_std_decimal.map
         working-directory: ./test/metal/
@@ -59,7 +59,7 @@ jobs:
       - name: run-test-on-target
         run: |
           sleep 2
-          PATH="${{ runner.workspace }}/decimal/test/metal/emu_env/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin:$PATH"
+          PATH="${{ runner.workspace }}/decimal/test/metal/emu_env/arm-gnu-toolchain-14.3.rel1-x86_64-arm-none-eabi/bin:$PATH"
           echo 'Run test on target'
           echo
           arm-none-eabi-gdb ./bin/app_benchmark_non_std_decimal.elf -x ./target/build/test_app_benchmarks_emulator.gdb > ./app_benchmark_non_std_decimal.txt

.github/workflows/qemu.yml

@@ -42,9 +42,6 @@ jobs:
           # multiarch testing
           - { name: PPC64LE-GCC, multiarch: yes,
               compiler: gcc, cxxstd: '14', os: ubuntu-22.04, ccache: no, distro: alpine, edition: edge, arch: ppc64le }
-          - { name: PPC64LE-Clang, multiarch: yes,
-              compiler: clang, cxxstd: '14', os: ubuntu-22.04, ccache: no, distro: alpine, edition: edge, arch: ppc64le }
-
 
     timeout-minutes: 360
     runs-on: ${{matrix.os}}

README.md

@@ -6,6 +6,7 @@
 | Github Actions   | [![CI](https://github.com/cppalliance/decimal/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/cppalliance/decimal/actions/workflows/ci.yml) | [![CI](https://github.com/cppalliance/decimal/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/cppalliance/decimal/actions/workflows/ci.yml)
 | Codecov          | [![codecov](https://codecov.io/gh/cppalliance/decimal/branch/master/graph/badge.svg?token=drvY8nnV5S)](https://codecov.io/gh/cppalliance/decimal)                 | [![codecov](https://codecov.io/gh/cppalliance/decimal/graph/badge.svg?token=drvY8nnV5S)](https://codecov.io/gh/cppalliance/decimal) |
 | Fuzzing          | [![Fuzzing](https://github.com/cppalliance/decimal/actions/workflows/fuzz.yml/badge.svg?branch=master)](https://github.com/cppalliance/decimal/actions/workflows/fuzz.yml) | [![Fuzzing](https://github.com/cppalliance/decimal/actions/workflows/fuzz.yml/badge.svg?branch=develop)](https://github.com/cppalliance/decimal/actions/workflows/fuzz.yml) |
+| Metal            | [![Metal](https://github.com/cppalliance/decimal/actions/workflows/metal.yml/badge.svg?branch=master)](https://github.com/cppalliance/decimal/actions/workflows/metal.yml) | [![Metal](https://github.com/cppalliance/decimal/actions/workflows/metal.yml/badge.svg?branch=develop)](https://github.com/cppalliance/decimal/actions/workflows/metal.yml) |
 
 ---
 
@@ -51,12 +52,12 @@ conan create decimal/conan --build missing
 
 # Supported Platforms
 
-Boost.Decimal is tested natively on Ubuntu (x86_64, s390x, and aarch64), macOS (x86_64, and Apple Silicon), and Windows (x32 and x64);
-as well as emulated PPC64LE and STM32 using QEMU with the following compilers:
+Boost.Decimal is tested natively on Ubuntu (x86_64, s390x, and aarch64), macOS (x86_64, and Apple Silicon),
+and Windows (x32 and x64); as well as emulated PPC64LE and ARM Cortex-M using QEMU with the following compilers:
 
 * GCC 7 and later
 * Clang 6 and later
-* Visual Studio 2017 and later
+* Visual Studio 2019 and later
 * Intel OneAPI DPC++
 
 # Synopsis
@@ -67,9 +68,9 @@ Decimal provides 3 IEEE-754 compliant types:
 namespace boost {
 namespace decimal {
 
-class decimal32;
-class decimal64;
-class decimal128;
+class decimal32_t;
+class decimal64_t;
+class decimal128_t;
 
 } //namespace decimal
 } //namespace boost
@@ -81,9 +82,9 @@ and also 3 similar but non-compliant types with improved runtime performance:
 namespace boost {
 namespace decimal {
 
-class decimal32_fast;
-class decimal64_fast;
-class decimal128_fast;
+class decimal_fast32_t;
+class decimal_fast64_t;
+class decimal_fast128_t;
 
 } //namespace decimal
 } //namespace boost
@@ -103,10 +104,10 @@ Using the decimal types is simple.
 
 int main()
 {
-    using boost::decimal::decimal32;
+    using boost::decimal::decimal32_t;
 
-    constexpr decimal32 a {2, -1}; // Constructs the number 0.2
-    constexpr decimal32 b {1, -1}; // Constructs the number 0.1
+    constexpr decimal32_t a {2, -1}; // Constructs the number 0.2
+    constexpr decimal32_t b {1, -1}; // Constructs the number 0.1
     auto sum {a + b};
 
     std::cout << sum << std::endl; // prints 0.3
@@ -122,7 +123,7 @@ int main()
 ```
 
 This intuitive straightforwardness is the same when using Standard-Library
-functions (such as STL functions, `<cmath>`-like functions and the like).
+functions (such as STL functions, `<cmath>` functions and the like).
 
 ```cpp
 #include <boost/decimal.hpp>
@@ -133,15 +134,15 @@ int main()
 {
     using namespace boost::decimal;
 
-    decimal64 val {-0.25}; // Construction from a double
+    decimal64_t val {-0.25}; // Construction from a double
     val = abs(val); // DO NOT call std::abs
 
     char buffer[256];
     auto r_to = to_chars(buffer, buffer + sizeof(buffer) - 1, val);
     assert(r_to); // checks std::errc()
     *r_to.ptr = '\0';
 
-    decimal64 return_value;
+    decimal64_t return_value;
     auto r_from = from_chars(buffer, buffer + std::strlen(buffer), return_value);
 
     assert(val == return_value);

doc/.gitignore

@@ -1,2 +1,4 @@
 /pdf/
 /html/
+/build/
+/node_modules/

doc/Jamfile

@@ -0,0 +1,57 @@
+import generate ;
+import path ;
+import property-set ;
+import virtual-target ;
+
+path-constant HERE : . ;
+
+make html/index.html : build_antora.sh : @run-script ;
+generate files-to-install : html/index.html : <generating-rule>@delayed-glob ;
+install install
+  : files-to-install
+  : <location>html
+    <install-source-root>html/decimal
+  ;
+explicit html/index.html files-to-install ;
+
+# this runs the antora script
+actions run-script
+{
+    bash $(>)
+}
+
+# this globs after its sources are created
+rule delayed-glob ( project name : property-set : sources * )
+{
+  for local src in $(sources)
+  {
+    # the next line causes the source to be generated immediately
+    # and not later (which it normally would)
+    UPDATE_NOW [ $(src).actualize ] ;
+  }
+
+  # we need to construct the path to the globbed directory;
+  # this path would be <current-project>/antora
+  local root = [ path.root html [ $(project).location ] ] ;
+  local files ;
+
+  # actual globbing happens here
+  for local file in [ path.glob-tree $(root) : * ]
+  {
+    # we have to skip directories, because our match expression accepts anything
+    if [ CHECK_IF_FILE $(file) ]
+    {
+      # we construct a list of targets to copy
+      files += [ virtual-target.from-file $(file:D=) : $(file:D) : $(project) ] ;
+    }
+  }
+
+  # we prepend empty usage requirements to the result
+  return [ property-set.empty ] $(files) ;
+}
+
+###############################################################################
+alias boostdoc ;
+explicit boostdoc ;
+alias boostrelease : install ;
+explicit boostrelease ;

doc/Jamfile.v2

@@ -0,0 +1,6 @@
+name: decimal
+version: ~
+title: Boost.Decimal
+nav:
+  - modules/ROOT/nav.adoc
+start_page: overview.adoc

doc/antora.yml

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -ex
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd "$SCRIPT_DIR"
+
+npm ci
+npx antora decimal-playbook.yml