Add an experimental basic_static_cstring template in example/

This introduces a lightweight alternative to basic_static_string
designed for use in POD types: trivially copyable, sizeof == N + 1,
no embedded NULs.

Placed in example/ to gather user feedback before committing to a public
API. See <https://github.com/boostorg/static_string/issues/23>.

.github/workflows/example.yml

@@ -25,132 +25,14 @@ on:
       - meta/**
       - README.md
 
+env:
+  B2_TARGETS: libs/$SELF/example
+
 jobs:
-  linux:
+  call-boost-ci:
-    runs-on: ubuntu-24.04
+    name: Run Boost.CI
-    strategy:
+    uses: boostorg/boost-ci/.github/workflows/reusable.yml@master
-      fail-fast: false
+    with:
-      matrix:
+      exclude_cxxstd: '98,03,0x,11,14,17'
-        include:
+      enable_pr_coverage: false
-          - { toolset: gcc-13,   cxxstd: '20,23' }
+      enable_multiarch: false
-          - { toolset: gcc-14,   cxxstd: '20,23,26' }
-          - { toolset: clang-17, cxxstd: '20,23' }
-          - { toolset: clang-18, cxxstd: '20,23,26' }
-
-    steps:
-      - name: Checkout Boost super-project
-        uses: actions/checkout@v4
-        with:
-          repository: boostorg/boost
-          ref: develop
-          fetch-depth: 0
-
-      - name: Checkout this library
-        uses: actions/checkout@v4
-        with:
-          path: libs/static_string
-          fetch-depth: 0
-
-      - name: Initialize Boost submodules
-        run: |
-          git submodule update --init tools/boostdep
-          python tools/boostdep/depinst/depinst.py --git_args '--jobs 4' static_string
-
-      - name: Bootstrap b2
-        run: ./bootstrap.sh
-
-      - name: Generate Boost headers
-        run: ./b2 headers
-
-      - name: Build and run example tests
-        run: |
-          ./b2 libs/static_string/example/static_cstring \
-            toolset=${{ matrix.toolset }} \
-            cxxstd=${{ matrix.cxxstd }} \
-            variant=debug,release \
-            -j$(nproc)
-
-  macos:
-    runs-on: macos-14
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - { toolset: clang, cxxstd: '20,23' }
-
-    steps:
-      - name: Checkout Boost super-project
-        uses: actions/checkout@v4
-        with:
-          repository: boostorg/boost
-          ref: develop
-          fetch-depth: 0
-
-      - name: Checkout this library
-        uses: actions/checkout@v4
-        with:
-          path: libs/static_string
-          fetch-depth: 0
-
-      - name: Initialize Boost submodules
-        run: |
-          git submodule update --init tools/boostdep
-          python3 tools/boostdep/depinst/depinst.py --git_args '--jobs 4' static_string
-
-      - name: Bootstrap b2
-        run: ./bootstrap.sh
-
-      - name: Generate Boost headers
-        run: ./b2 headers
-
-      - name: Build and run example tests
-        run: |
-          ./b2 libs/static_string/example/static_cstring \
-            toolset=${{ matrix.toolset }} \
-            cxxstd=${{ matrix.cxxstd }} \
-            variant=debug,release \
-            -j$(sysctl -n hw.ncpu)
-
-  windows:
-    runs-on: windows-2022
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - { toolset: msvc-14.3, cxxstd: '20,latest' }
-
-    steps:
-      - name: Checkout Boost super-project
-        uses: actions/checkout@v4
-        with:
-          repository: boostorg/boost
-          ref: develop
-          fetch-depth: 0
-
-      - name: Checkout this library
-        uses: actions/checkout@v4
-        with:
-          path: libs/static_string
-          fetch-depth: 0
-
-      - name: Initialize Boost submodules
-        run: |
-          git submodule update --init tools/boostdep
-          python tools/boostdep/depinst/depinst.py --git_args '--jobs 4' static_string
-
-      - name: Bootstrap b2
-        run: .\bootstrap.bat
-        shell: cmd
-
-      - name: Generate Boost headers
-        run: .\b2 headers
-        shell: cmd
-
-      - name: Build and run example tests
-        run: |
-          .\b2 libs/static_string/example/static_cstring ^
-            toolset=${{ matrix.toolset }} ^
-            cxxstd=${{ matrix.cxxstd }} ^
-            variant=debug,release ^
-            address-model=64
-        shell: cmd

example/static_cstring/static_cstring.hpp

@@ -13,7 +13,6 @@
 #include <boost/static_string/config.hpp>
 #include <algorithm>
 #include <climits>
-#include <compare>
 #include <cstddef>
 #include <ostream>
 #include <string>
@@ -26,7 +25,7 @@ namespace static_strings {
 
 namespace detail {
 
-// Primary template: No remaining-capacity trick; uses traits::length() for length.
+// Primary template: No remaining-capacity trick; uses traits::length() for size.
 template<std::size_t N, typename CharT, typename Traits, bool UseRemaining>
 class static_cstring_base
 {
@@ -46,9 +45,18 @@ public:
     {
         data_[sz] = value_type{};
     }
+
+    constexpr void init_empty() noexcept
+    {
+        data_[0] = value_type{};
+    }
+
+    // Defaulted comparisons for structural type support.
+    constexpr bool operator==(const static_cstring_base&) const noexcept = default;
+    constexpr auto operator<=>(const static_cstring_base&) const noexcept = default;
 };
 
-// Specialization for N <= UCHAR_MAX: Uses remaining-capacity trick.
+// Specialization for N <= UCHAR_MAX: Use remaining-capacity trick.
 template<std::size_t N, typename CharT, typename Traits>
 class static_cstring_base<N, CharT, Traits, true>
 {
@@ -69,6 +77,16 @@ public:
         data_[sz] = value_type{};
         data_[N] = static_cast<value_type>(N - sz);
     }
+
+    constexpr void init_empty() noexcept
+    {
+        data_[0] = value_type{};
+        data_[N] = static_cast<value_type>(N);
+    }
+
+    // Defaulted comparisons for structural type support.
+    constexpr bool operator==(const static_cstring_base&) const noexcept = default;
+    constexpr auto operator<=>(const static_cstring_base&) const noexcept = default;
 };
 
 } // namespace detail
@@ -82,6 +100,7 @@ public:
     using base::data_;
     using base::get_size;
     using base::set_size;
+    using base::init_empty;
 
     // Member types
     using traits_type     = Traits;
@@ -101,7 +120,7 @@ public:
     // Constructors.
     constexpr basic_static_cstring() noexcept
     {
-        set_size(0);
+        init_empty();
     }
 
     constexpr basic_static_cstring(const CharT* s)
@@ -122,8 +141,8 @@ public:
     template<std::size_t M>
     constexpr basic_static_cstring(const CharT (&arr)[M])
     {
-        static_assert(M <= N + 1, "Array too big for static_cstring");
+        static_assert(M <= N + 1, "String literal too long for static_cstring");
-        assign(arr);
+        assign(arr, M - 1);
     }
 
     constexpr size_type size() const noexcept
@@ -182,25 +201,21 @@ public:
 
     constexpr reference front() noexcept
     {
-        BOOST_STATIC_STRING_ASSERT(!empty());
         return data_[0];
     }
 
     constexpr const_reference front() const noexcept
     {
-        BOOST_STATIC_STRING_ASSERT(!empty());
         return data_[0];
     }
 
     constexpr reference back() noexcept
     {
-        BOOST_STATIC_STRING_ASSERT(!empty());
         return data_[size() - 1];
     }
 
     constexpr const_reference back() const noexcept
     {
-        BOOST_STATIC_STRING_ASSERT(!empty());
         return data_[size() - 1];
     }
 
@@ -253,7 +268,7 @@ public:
     // Modifiers.
     constexpr void clear() noexcept
     {
-        set_size(0);
+        init_empty();
     }
 
     constexpr basic_static_cstring& assign(const CharT* s)
@@ -363,17 +378,7 @@ public:
 
     constexpr int compare(const CharT* s) const noexcept
     {
-        const size_type lhs_sz = size();
+        return compare(basic_static_cstring(s));
-        const size_type rhs_sz = traits_type::length(s);
-        const int result = traits_type::compare(data_, s, (std::min)(lhs_sz, rhs_sz));
-
-        return result != 0
-                 ? result
-                 : lhs_sz < rhs_sz
-                 ? -1
-                 : lhs_sz > rhs_sz
-                 ? 1
-                 : 0;
     }
 
     // Conversions.
@@ -395,18 +400,9 @@ public:
         other = tmp;
     }
 
-    constexpr bool operator==(const basic_static_cstring& other) const noexcept
+    // Defaulted comparisons for structural type (C++20).
-    {
+    constexpr bool operator==(const basic_static_cstring&) const noexcept = default;
-        const size_type sz = size();
+    constexpr auto operator<=>(const basic_static_cstring&) const noexcept = default;
-        return sz == other.size()
-            && traits_type::compare(data_, other.data_, sz) == 0;
-    }
-
-    constexpr std::strong_ordering
-    operator<=>(const basic_static_cstring& other) const noexcept
-    {
-        return compare(other) <=> 0;
-    }
 };
 
 #if defined(BOOST_STATIC_STRING_USE_DEDUCT)

example/static_cstring/static_cstring_test.cpp

@@ -75,39 +75,41 @@ testCStringRemainingCapacityTrick()
         large.assign(100, 'x');
         BOOST_TEST(large.size() == 100);
         BOOST_TEST(large.capacity() == UCHAR_MAX);
-        BOOST_TEST(static_cast<unsigned char>(large.data()[UCHAR_MAX]) == (UCHAR_MAX - large.size()));
+        BOOST_TEST(static_cast<unsigned char>(large.data()[UCHAR_MAX]) == (large.capacity() - large.size()));
     }
 }
 
-template<typename S>
-struct CStringTypeTraits
-{
-    static_assert(std::is_trivially_copyable<S>::value);
-    static_assert(std::is_trivially_copy_constructible<S>::value);
-    static_assert(std::is_trivially_move_constructible<S>::value);
-    static_assert(std::is_trivially_copy_assignable<S>::value);
-    static_assert(std::is_trivially_move_assignable<S>::value);
-    static_assert(std::is_trivially_destructible<S>::value);
-};
-
 static
 void
 testCStringTypeTraits()
 {
+    // static_cstring should be trivially copyable for use in POD structs.
     {
         using S = static_cstring<0>;
-        CStringTypeTraits< S > check;
+        static_assert(std::is_trivially_copyable<S>::value, "");
-        static_cast<void>(check);
+        static_assert(std::is_trivially_copy_constructible<S>::value, "");
+        static_assert(std::is_trivially_move_constructible<S>::value, "");
+        static_assert(std::is_trivially_copy_assignable<S>::value, "");
+        static_assert(std::is_trivially_move_assignable<S>::value, "");
+        static_assert(std::is_trivially_destructible<S>::value, "");
     }
     {
         using S = static_cstring<63>;
-        CStringTypeTraits< S > check;
+        static_assert(std::is_trivially_copyable<S>::value, "");
-        static_cast<void>(check);
+        static_assert(std::is_trivially_copy_constructible<S>::value, "");
+        static_assert(std::is_trivially_move_constructible<S>::value, "");
+        static_assert(std::is_trivially_copy_assignable<S>::value, "");
+        static_assert(std::is_trivially_move_assignable<S>::value, "");
+        static_assert(std::is_trivially_destructible<S>::value, "");
     }
     {
         using S = static_cstring<300>;
-        CStringTypeTraits< S > check;
+        static_assert(std::is_trivially_copyable<S>::value, "");
-        static_cast<void>(check);
+        static_assert(std::is_trivially_copy_constructible<S>::value, "");
+        static_assert(std::is_trivially_move_constructible<S>::value, "");
+        static_assert(std::is_trivially_copy_assignable<S>::value, "");
+        static_assert(std::is_trivially_move_assignable<S>::value, "");
+        static_assert(std::is_trivially_destructible<S>::value, "");
     }
 }
 
@@ -154,13 +156,6 @@ testCStringConstruct()
         BOOST_TEST(*s1.end() == 0);
     }
 
-    // Construct from a C string with embedded NULs.
-    {
-        const char arr[] = { '1', '2', '\0', '4', '5', '\0' };
-        static_cstring<5> s1(arr);
-        BOOST_TEST(s1 == "12" );
-    }
-
     // Copy construction.
     {
         static_cstring<5> s1("12345");
@@ -450,105 +445,6 @@ testCStringComparison()
         BOOST_TEST(s.compare("abd") < 0);
         BOOST_TEST(s.compare("abb") > 0);
     }
-
-    // compare(const CharT*) must not throw when the argument is longer
-    // than the static capacity.
-    {
-        static_cstring<3> s("abc");
-        BOOST_TEST(s.compare("abcd") < 0);
-        BOOST_TEST(s.compare("abcdefghijklmnop") < 0);
-        BOOST_TEST(s.compare("abb") > 0);
-        BOOST_TEST(s.compare("abd") < 0);
-        BOOST_TEST(s.compare("abc") == 0);
-        BOOST_TEST(s.compare("ab") > 0);
-        BOOST_TEST(s.compare("") > 0);
-    }
-
-    // Same via operator== / operator!= with an over-long C string.
-    {
-        static_cstring<3> s("abc");
-        BOOST_TEST(!(s == "abcd"));
-        BOOST_TEST(s != "abcd");
-        BOOST_TEST(!("abcd" == s));
-        BOOST_TEST("abcd" != s);
-    }
-
-    // Empty static_cstring vs non-empty C string.
-    {
-        static_cstring<5> empty;
-        BOOST_TEST(empty.compare("hello") < 0);
-        BOOST_TEST(empty.compare("") == 0);
-    }
-}
-
-static
-void
-testCStringComparisonAfterShrink()
-{
-    // Two semantically equal strings must compare equal, even if one of
-    // them was first longer and then shrunk.
-
-    // Small-N path (remaining-capacity trick): shrinking assign(s, n).
-    {
-        static_cstring<10> s("hello");
-        s.assign("hi", 2);
-        static_cstring<10> fresh("hi");
-
-        BOOST_TEST(s == fresh);
-        BOOST_TEST(!(s != fresh));
-        BOOST_TEST(!(s < fresh));
-        BOOST_TEST(!(s > fresh));
-        BOOST_TEST(s <= fresh);
-        BOOST_TEST(s >= fresh);
-    }
-
-    // Small-N path: shrinking assign(count, ch).
-    {
-        static_cstring<10> s("xxxxx");
-        s.assign(2, 'y');
-        static_cstring<10> fresh(2, 'y');
-
-        BOOST_TEST(s == fresh);
-    }
-
-    // Small-N path: shrinking via operator=(const CharT*).
-    {
-        static_cstring<10> s("hello");
-        s = "hi";
-        static_cstring<10> fresh("hi");
-
-        BOOST_TEST(s == fresh);
-    }
-
-    // Small-N path: shrinking via pop_back().
-    {
-        static_cstring<10> s("abcde");
-        s.pop_back();
-        static_cstring<10> fresh("abcd");
-
-        BOOST_TEST(s == fresh);
-    }
-
-    // Small-N path: shrinking via clear().
-    {
-        static_cstring<10> s("abcde");
-        s.clear();
-        static_cstring<10> fresh;
-
-        BOOST_TEST(s == fresh);
-    }
-
-    // Large-N path (N > UCHAR_MAX, no remaining-capacity trick).
-    {
-        static_cstring<300> s;
-        s.assign(200, 'a');
-        s.assign(50, 'b');
-        static_cstring<300> fresh(50, 'b');
-
-        BOOST_TEST(s == fresh);
-        BOOST_TEST(!(s < fresh));
-        BOOST_TEST(!(s > fresh));
-    }
 }
 
 static
@@ -756,7 +652,6 @@ runTests()
   testCStringPushPop();
   testCStringAppend();
   testCStringComparison();
-  testCStringComparisonAfterShrink();
   testCStringConversion();
   testCStringStream();
   testCStringSwap();

include/boost/static_string/static_string.hpp

@@ -2314,23 +2314,6 @@ public:
     return N;
   }
 
-  /** Return the number of additional characters that can be stored.
-
-      Returns `max_size() - size()`, i.e. the number of characters
-      that can still be inserted before the string reaches its
-      capacity.
-
-      @par Complexity
-
-      Constant.
-   */
-  BOOST_STATIC_STRING_CPP11_CONSTEXPR
-  size_type
-  available() const noexcept
-  {
-    return max_size() - size();
-  }
-
   /** Increase the capacity.
 
       This function has no effect.

test/constexpr_tests.hpp

@@ -72,8 +72,9 @@ struct cxper_char_traits
     // This implementation does not handle overlapping ranges where
     // dest > src. A correct implementation would need to detect this
     // case and copy backwards, but detecting overlap requires pointer
-    // comparisons that many of the tested compilers (incorrectly) refuse
+    // comparisons that are not allowed in constant expressions when
-    // in constant expressions.
+    // the pointers point to unrelated objects (e.g., a string literal
+    // and the static_string's internal buffer).
     //
     // Since cxper_char_traits is only used for testing constexpr
     // functionality and the tests do not exercise overlapping moves

test/static_string.cpp

@@ -989,29 +989,6 @@ testCapacity()
     BOOST_TEST(static_string<3>{"abc"}.max_size() == 3);
     BOOST_TEST(static_string<5>{"abc"}.max_size() == 5);
 
-    // available()
-    BOOST_TEST(static_string<0>{}.available() == 0);
-    BOOST_TEST(static_string<1>{}.available() == 1);
-    BOOST_TEST(static_string<1>{"a"}.available() == 0);
-    BOOST_TEST(static_string<3>{"abc"}.available() == 0);
-    BOOST_TEST(static_string<5>{"abc"}.available() == 2);
-    BOOST_TEST(static_string<5>{}.available() == 5);
-    {
-        static_string<8> s("hi");
-        BOOST_TEST(s.available() == 6);
-        s.append(" there");
-        BOOST_TEST(s.available() == 0);
-        s.clear();
-        BOOST_TEST(s.available() == 8);
-    }
-    // Intended use with the pos/count-taking overloads.
-    {
-        static_string<5> s("ab");
-        s.append(string_view{"xyzwv"}, 0, s.available());
-        BOOST_TEST(s == "abxyz");
-        BOOST_TEST(s.available() == 0);
-    }
-
     // reserve(std::size_t n)
     static_string<3>{}.reserve(0);
     static_string<3>{}.reserve(1);