Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
String.h
1// Copyright (c) Stefano Cristiano
2// SPDX-License-Identifier: MIT
3#pragma once
4#include "../Foundation/StringSpan.h"
5#include "../Memory/Buffer.h"
6
7namespace SC
8{
9struct SC_COMPILER_EXPORT String;
10template <int N>
11struct SmallString;
12namespace Reflection
13{
14template <typename T>
15struct Reflect;
16}
17} // namespace SC
18
21
29{
32 String(StringEncoding encoding = StringEncoding::Utf8) : encoding(encoding) {}
33
38
41 String(Buffer&& otherData, StringEncoding encoding);
42
47 template <size_t N>
48 String(const char (&text)[N])
49 {
50 SC_ASSERT_RELEASE(assign(StringSpan({text, N - 1}, true, StringEncoding::Ascii)));
51 }
52
56 [[nodiscard]] bool owns(StringSpan view) const;
57
62 [[nodiscard]] bool assign(StringSpan sv);
63
66 [[nodiscard]] StringEncoding getEncoding() const { return encoding; }
67
70 [[nodiscard]] size_t sizeInBytesIncludingTerminator() const { return data.size(); }
71
74 [[nodiscard]] const char* bytesIncludingTerminator() const { return data.data(); }
75
78 [[nodiscard]] bool isEmpty() const { return data.isEmpty(); }
79
82 [[nodiscard]] StringSpan view() const SC_LANGUAGE_LIFETIME_BOUND;
83
87 [[nodiscard]] bool operator==(const String& other) const { return view() == (other.view()); }
88
92 [[nodiscard]] bool operator!=(const String& other) const { return not operator==(other); }
93
97 [[nodiscard]] bool operator==(const StringSpan other) const { return view() == (other); }
98
102 [[nodiscard]] bool operator!=(const StringSpan other) const { return not operator==(other); }
103
108 template <size_t N>
109 [[nodiscard]] bool operator==(const char (&other)[N]) const
110 {
111 return view() == other;
112 }
117 template <size_t N>
118 [[nodiscard]] bool operator!=(const char (&other)[N]) const
119 {
120 return view() != other;
121 }
122
126 [[nodiscard]] bool operator<(const StringSpan other) const { return view() < other; }
127
133 template <size_t N>
134 String& operator=(const char (&text)[N])
135 {
136 SC_ASSERT_RELEASE(assign(StringSpan({text, N - 1}, true, StringEncoding::Ascii)));
137 return *this;
138 }
139
143
144 protected:
145 struct Internal;
146
147 friend struct StringTest;
148 template <typename T>
149 friend struct Reflection::Reflect;
150
151 template <typename T>
152 friend struct GrowableBuffer;
153 struct SC_COMPILER_EXPORT GrowableImplementation
154 {
155 String& string;
156
157 IGrowableBuffer::DirectAccess& da;
158
159 GrowableImplementation(String& string, IGrowableBuffer::DirectAccess& da);
161 bool tryGrowTo(size_t newSize);
162 };
163
164 StringEncoding encoding;
165 Buffer data;
166
167 String(StringEncoding encoding, uint32_t inlineCapacity);
168 String(Buffer&& otherData, StringEncoding encoding, uint32_t inlineCapacity);
169};
170
173template <int N>
174struct SC::SmallString : public String
175{
176 // Unfortunately we have to repeat all these overloads to set inline capacity and hasInlineData flag
177 SmallString(StringEncoding encoding = StringEncoding::Utf8) : String(encoding, N) {}
178 SmallString(const SmallString& other) : SmallString(other.getEncoding()) { String::operator=(other); }
180 String& operator=(const SmallString& other) { return String::operator=(other); }
181 String& operator=(SmallString&& other) { return String::operator=(move(other)); }
182
183 SmallString(const String& other) : SmallString(other.getEncoding()) { String::operator=(other); }
184 SmallString(String&& other) : SmallString(other.getEncoding()) { String::operator=(move(other)); }
186 SmallString(Buffer&& otherData, StringEncoding encoding) : String(move(otherData), encoding, N) {}
187 template <size_t Q>
188 SmallString(const char (&text)[Q]) : SmallString(StringSpan({text, Q - 1}, true, StringEncoding::Ascii))
189 {}
190
191 private:
192 uint64_t inlineCapacity = N;
193 char buffer[N];
194};
196
197namespace SC
198{
199template <int N>
200using SmallStringNative = SmallString<N * sizeof(native_char_t)>;
201
202// Allows using this type across Plugin boundaries
203SC_COMPILER_EXTERN template struct SC_COMPILER_EXPORT SmallString<64>;
204SC_COMPILER_EXTERN template struct SC_COMPILER_EXPORT SmallString<128 * sizeof(native_char_t)>;
205SC_COMPILER_EXTERN template struct SC_COMPILER_EXPORT SmallString<255 * sizeof(native_char_t)>;
206SC_COMPILER_EXTERN template struct SC_COMPILER_EXPORT SmallString<512 * sizeof(native_char_t)>;
207SC_COMPILER_EXTERN template struct SC_COMPILER_EXPORT SmallString<1024 * sizeof(native_char_t)>;
208
209// Enables File library from reading data from file descriptor into a String
210template <>
211struct SC_COMPILER_EXPORT GrowableBuffer<String> final : public IGrowableBuffer
212{
214 GrowableBuffer(String& string) : gi(string, IGrowableBuffer::directAccess) {}
215 virtual bool tryGrowTo(size_t newSize) override { return gi.tryGrowTo(newSize); }
216};
217
218template <int N>
219struct SC_COMPILER_EXPORT GrowableBuffer<SmallString<N>> final : public IGrowableBuffer
220{
222 GrowableBuffer(String& string) : gi(string, IGrowableBuffer::directAccess) {}
223 virtual bool tryGrowTo(size_t newSize) override { return gi.tryGrowTo(newSize); }
224};
225} // namespace SC
#define SC_COMPILER_EXTERN
Define compiler-specific export macros for DLL visibility.
Definition Compiler.h:74
#define SC_ASSERT_RELEASE(e)
Assert expression e to be true.
Definition Assert.h:42
constexpr T && move(T &value)
Converts an lvalue to an rvalue reference.
Definition Compiler.h:257
unsigned long long uint64_t
Platform independent (8) bytes unsigned int.
Definition PrimitiveTypes.h:42
unsigned int uint32_t
Platform independent (4) bytes unsigned int.
Definition PrimitiveTypes.h:38
char native_char_t
The native char for the platform (wchar_t (4 bytes) on Windows, char (1 byte) everywhere else )
Definition PrimitiveTypes.h:34
An heap allocated byte buffer that can optionally use an inline buffer.
Definition Buffer.h:29
String with compile time configurable inline storage (small string optimization)
Definition String.h:175
An read-only view over a string (to avoid including Strings library when parsing is not needed).
Definition StringSpan.h:37
Definition String.h:154
A non-modifiable owning string with associated encoding.
Definition String.h:29
StringEncoding getEncoding() const
Get StringSpan encoding.
Definition String.h:66
bool operator!=(const String &other) const
Check if current String is different from other String.
Definition String.h:92
bool operator==(const String &other) const
Check if current String is same as other String.
Definition String.h:87
bool operator<(const StringSpan other) const
Check if current String is smaller to another StringView (using StringView::compare)
Definition String.h:126
bool operator!=(const char(&other)[N]) const
Check if current String is different from the ascii string literal.
Definition String.h:118
StringSpan view() const SC_LANGUAGE_LIFETIME_BOUND
Obtain a null-terminated StringSpan from current String.
String(const char(&text)[N])
Builds String with a null terminated char string literal.
Definition String.h:48
bool owns(StringSpan view) const
Checks if the memory pointed by the StringSpan is owned by this String.
size_t sizeInBytesIncludingTerminator() const
Get length of the string in bytes (including null terminator bytes)
Definition String.h:70
String(StringEncoding encoding=StringEncoding::Utf8)
Builds an empty String with a given Encoding.
Definition String.h:32
bool operator!=(const StringSpan other) const
Check if current String is different from other StringSpan.
Definition String.h:102
String & operator=(const char(&text)[N])
Assigns an ascii string literal to current String.
Definition String.h:134
bool assign(StringSpan sv)
Assigns a StringSpan to this String, replacing existing contents.
bool operator==(const StringSpan other) const
Check if current String is same as other StringSpan.
Definition String.h:97
String & operator=(StringSpan view)
Assigns (copy) contents of given StringSpan in current String.
bool isEmpty() const
Check if String is empty.
Definition String.h:78
const char * bytesIncludingTerminator() const
Access current string content as read-only null-terminated const char*
Definition String.h:74
String(Buffer &&otherData, StringEncoding encoding)
Builds a String from a buffer ensuring zero termination.
String(StringSpan sv)
Builds String from a StringSpan.
Definition String.h:37
bool operator==(const char(&other)[N]) const
Check if current String is equal to the ascii string literal.
Definition String.h:109