SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
SDL3pp_strings.h
1#ifndef SDL3PP_STRINGS_H_
2#define SDL3PP_STRINGS_H_
3
4#include <span>
5#include <string>
6#include <string_view>
7#include <variant>
8#include <SDL3/SDL_stdinc.h>
9#include "SDL3pp_ownPtr.h"
10
11namespace SDL {
12
21#ifndef SDL3PP_ENABLE_STRING_PARAM
22
23#ifndef SDL3PP_DISABLE_STRING_PARAM
24#define SDL3PP_ENABLE_STRING_PARAM
25#endif // SDL3PP_DISABLE_STRING_PARAM
26
27#endif // SDL3PP_ENABLE_STRING_PARAM
28
29#ifdef SDL3PP_ENABLE_STRING_PARAM
30
43{
44 std::variant<const char*, std::string> data;
45
46public:
48 constexpr StringParam(std::nullptr_t = nullptr)
49 : data("")
50 {
51 }
52
62 constexpr StringParam(const char* str)
63 : data(str ?: "")
64 {
65 }
66
77 constexpr StringParam(const std::string& str)
78 : StringParam(str.c_str())
79 {
80 }
81
90 constexpr StringParam(std::string&& str)
91 : data(std::move(str))
92 {
93 }
94
104 StringParam(std::string_view str)
105 : StringParam(std::string{str})
106 {
107 }
108
109 StringParam(const StringParam&) = delete;
110 StringParam& operator=(const StringParam&) = delete;
111
114
117
124 constexpr const char* c_str() const
125 {
126 struct Visitor
127 {
128 const char* operator()(const char* a) const { return a; }
129 const char* operator()(const std::string& s) const { return s.c_str(); }
130 };
131 return std::visit(Visitor{}, data);
132 }
133
140 constexpr operator const char*() const { return c_str(); }
141};
142
143#else // SDL3PP_ENABLE_STRING_PARAM
144
145using StringParam = const char*;
146
147#endif // SDL3PP_ENABLE_STRING_PARAM
148
152struct StringResult : OwnArray<char>
153{
154
156 using OwnArray::OwnArray;
157
160 : StringResult(std::string_view(other))
161 {
162 }
163
165 constexpr StringResult(StringResult&& other)
166 : OwnArray(other.release(), other.size())
167 {
168 }
169
171 StringResult(std::string_view other)
172 : OwnArray(other.empty() ? nullptr
173 : SDL_strndup(other.data(), other.size()))
174 {
175 }
176
178 constexpr operator StringParam() const { return std::string_view{*this}; }
179
181 constexpr operator std::string_view() const
182 {
183 return std::string_view{data(), size()};
184 }
185
187 StringResult& operator+=(std::string_view other)
188 {
189 if (empty()) {
190 reset(StringResult(other).release());
191 } else if (!other.empty()) {
192 size_t lhsSz = size();
193 size_t rhsSz = other.size();
194 size_t finalSize = lhsSz + lhsSz + 1;
195 auto newBuf = static_cast<char*>(SDL_realloc(data(), finalSize));
196 newBuf += lhsSz;
197 SDL_memcpy(newBuf, other.data(), rhsSz);
198 newBuf += rhsSz;
199 *newBuf = 0;
200 reset(newBuf, finalSize - 1);
201 }
202 return *this;
203 }
204
207 {
208 return (*this) += std::string_view{&ch, 1};
209 }
210
212 StringResult operator+(std::string_view other) const
213 {
214 StringResult t{*this};
215 t += other;
216 return t;
217 }
218
220 StringResult operator+(char ch) { return (*this) + std::string_view{&ch, 1}; }
221
223 std::string str() const { return std::string{data(), size()}; }
224
226 const char* c_str() const
227 {
228 if (empty()) return "";
229 return data();
230 }
231};
232
239{
240 const void* m_data;
241 size_t m_size_bytes;
242
243public:
245 constexpr SourceBytes() = default;
246
248 constexpr SourceBytes(std::nullptr_t)
249 : SourceBytes()
250 {
251 }
252
259 template<class T, size_t N>
260 constexpr SourceBytes(std::span<T, N> span)
261 : SourceBytes(span.data(), span.size_bytes())
262 {
263 }
264
270 template<class T>
271 constexpr SourceBytes(const T& data)
272 : SourceBytes(std::span{data.data(), data.size()})
273 {
274 }
280 template<class T, size_t N>
281 constexpr SourceBytes(T (&data)[N])
282 : SourceBytes(std::span<T, N>{static_cast<T*>(data), N})
283 {
284 }
285
293 constexpr SourceBytes(const void* data, size_t size_bytes)
294 : m_data(size_bytes > 0 ? data : nullptr)
295 , m_size_bytes(data != nullptr ? size_bytes : 0)
296 {
297 }
298
300 constexpr size_t size() const { return m_size_bytes; }
301
303 constexpr size_t size_bytes() const { return m_size_bytes; }
304
306 constexpr const char* data() const
307 {
308 return static_cast<const char*>(m_data);
309 }
310
312 template<class T>
313 constexpr const T* data_as() const
314 {
315 return static_cast<const T*>(m_data);
316 }
317};
318
325{
326 void* m_data = nullptr;
327 size_t m_size_bytes = 0;
328
329public:
331 constexpr TargetBytes() = default;
332
334 constexpr TargetBytes(std::nullptr_t)
335 : TargetBytes()
336 {
337 }
338
340 constexpr TargetBytes(const TargetBytes& other) = default;
341
343 constexpr TargetBytes(TargetBytes&& other) = default;
344
346 constexpr TargetBytes& operator=(const TargetBytes& other) = default;
347
349 constexpr TargetBytes& operator=(TargetBytes&& other) = default;
350
352 template<class T, size_t N>
353 constexpr TargetBytes(std::span<const T, N> span)
354 {
355 static_assert(false, "Non-const type is required");
356 }
357
364 template<class T, size_t N>
365 constexpr TargetBytes(std::span<T, N> span)
366 : TargetBytes(span.data(), span.size_bytes())
367 {
368 }
369
375 template<class T>
376 constexpr TargetBytes(T& data)
377 : TargetBytes(std::span{data.data(), data.size()})
378 {
379 }
385 template<class T, size_t N>
386 constexpr TargetBytes(T (&data)[N])
387 : TargetBytes(std::span<T, N>{static_cast<T*>(data), N})
388 {
389 }
390
398 constexpr TargetBytes(void* data, size_t size_bytes)
399 : m_data(size_bytes > 0 ? data : nullptr)
400 , m_size_bytes(data != nullptr ? size_bytes : 0)
401 {
402 }
403
405 constexpr size_t size() const { return m_size_bytes; }
406
408 constexpr size_t size_bytes() const { return m_size_bytes; }
409
411 constexpr char* data() const { return static_cast<char*>(m_data); }
412
414 template<class T>
415 constexpr T* data_as() const
416 {
417 return static_cast<T*>(m_data);
418 }
419};
420
422
423} // namespace SDL
424
425#endif /* SDL3PP_STRINGS_H_ */
Base class for SDL memory allocated array wrap.
Definition: SDL3pp_ownPtr.h:44
constexpr bool empty() const
True if size() == 0.
Definition: SDL3pp_ownPtr.h:74
char * release()
Release control on object.
Definition: SDL3pp_ownPtr.h:91
constexpr OwnArray(std::nullptr_t=nullptr)
Constructor.
Definition: SDL3pp_ownPtr.h:50
void reset(char *newValue=nullptr)
Reset object.
Definition: SDL3pp_ownPtr.h:99
constexpr size_t size() const
Size.
Definition: SDL3pp_ownPtr.h:83
constexpr char * data()
Data.
Definition: SDL3pp_ownPtr.h:77
Source byte stream.
Definition: SDL3pp_strings.h:239
constexpr SourceBytes(std::span< T, N > span)
From span.
Definition: SDL3pp_strings.h:260
constexpr SourceBytes(const T &data)
From container-like.
Definition: SDL3pp_strings.h:271
constexpr size_t size_bytes() const
Retrieves contained size in bytes.
Definition: SDL3pp_strings.h:303
constexpr SourceBytes(std::nullptr_t)
Disambiguate between multiple pointer types.
Definition: SDL3pp_strings.h:248
constexpr SourceBytes(const void *data, size_t size_bytes)
From data + size in bytes.
Definition: SDL3pp_strings.h:293
constexpr size_t size() const
Retrieves contained size.
Definition: SDL3pp_strings.h:300
constexpr SourceBytes()=default
Default ctor.
constexpr SourceBytes(T(&data)[N])
From array.
Definition: SDL3pp_strings.h:281
constexpr const char * data() const
Retrieves contained data.
Definition: SDL3pp_strings.h:306
constexpr const T * data_as() const
Retrieves contained data.
Definition: SDL3pp_strings.h:313
Helpers to use C++ strings parameters.
Definition: SDL3pp_strings.h:43
constexpr const char * c_str() const
Converts to a null terminated C string.
Definition: SDL3pp_strings.h:124
StringParam & operator=(StringParam &&)=default
Move assignment.
constexpr StringParam(const char *str)
Constructs from a C string.
Definition: SDL3pp_strings.h:62
StringParam(std::string_view str)
Constructs from std::string_view object.
Definition: SDL3pp_strings.h:104
constexpr StringParam(std::string &&str)
Constructs from std::string object.
Definition: SDL3pp_strings.h:90
constexpr StringParam(const std::string &str)
Constructs from std::string reference.
Definition: SDL3pp_strings.h:77
StringParam(StringParam &&)=default
Move ctor.
constexpr StringParam(std::nullptr_t=nullptr)
Default ctor.
Definition: SDL3pp_strings.h:48
Target byte stream.
Definition: SDL3pp_strings.h:325
constexpr TargetBytes & operator=(TargetBytes &&other)=default
Move assignment.
constexpr TargetBytes(T &data)
From container-like.
Definition: SDL3pp_strings.h:376
constexpr TargetBytes(std::span< T, N > span)
From span.
Definition: SDL3pp_strings.h:365
constexpr TargetBytes(TargetBytes &&other)=default
Move constructor.
constexpr TargetBytes()=default
Default ctor.
constexpr char * data() const
Retrieves contained data.
Definition: SDL3pp_strings.h:411
constexpr TargetBytes(std::nullptr_t)
Disambiguate between multiple pointer types.
Definition: SDL3pp_strings.h:334
constexpr TargetBytes(T(&data)[N])
From array.
Definition: SDL3pp_strings.h:386
constexpr TargetBytes(const TargetBytes &other)=default
Copy constructor.
constexpr T * data_as() const
Retrieves contained data.
Definition: SDL3pp_strings.h:415
constexpr size_t size() const
Retrieves contained size.
Definition: SDL3pp_strings.h:405
constexpr size_t size_bytes() const
Retrieves contained size in bytes.
Definition: SDL3pp_strings.h:408
constexpr TargetBytes(void *data, size_t size_bytes)
From data + size in bytes.
Definition: SDL3pp_strings.h:398
constexpr TargetBytes(std::span< const T, N > span)
Just to have better error message.
Definition: SDL3pp_strings.h:353
constexpr TargetBytes & operator=(const TargetBytes &other)=default
Copy assignment.
Main include header for the SDL3pp library.
A simple std::string-like interface for SDL allocated strings.
Definition: SDL3pp_strings.h:153
StringResult(std::string_view other)
Constructs from string view.
Definition: SDL3pp_strings.h:171
const char * c_str() const
Convert to c-string.
Definition: SDL3pp_strings.h:226
constexpr StringResult(StringResult &&other)
Move ctor.
Definition: SDL3pp_strings.h:165
StringResult & operator+=(std::string_view other)
Append string.
Definition: SDL3pp_strings.h:187
std::string str() const
Convert to string.
Definition: SDL3pp_strings.h:223
StringResult(const StringResult &other)
Copy ctor.
Definition: SDL3pp_strings.h:159
StringResult operator+(std::string_view other) const
Append string.
Definition: SDL3pp_strings.h:212
StringResult & operator+=(char ch)
Append char.
Definition: SDL3pp_strings.h:206
StringResult operator+(char ch)
Append char.
Definition: SDL3pp_strings.h:220
constexpr operator std::string_view() const
Convert to std::string_view.
Definition: SDL3pp_strings.h:181