1#ifndef CONVERSION_UTILITIES_STRINGCONVERSION_H
2#define CONVERSION_UTILITIES_STRINGCONVERSION_H
7#include "../misc/traits.h"
11#include <initializer_list>
18#include <system_error>
21#if __cplusplus >= 201709 && !defined(REFLECTIVE_RAPIDJSON_GENERATOR)
22#ifndef CPP_UTILITIES_USE_RANGES
23#define CPP_UTILITIES_USE_RANGES
40 std::free(stringData);
47using StringData = std::pair<std::unique_ptr<char[], StringDataDeleter>, std::size_t>;
51 const char *fromCharset,
const char *toCharset,
const char *inputBuffer, std::size_t inputBufferSize,
float outputBufferSizeFactor = 1.0f);
59#ifdef PLATFORM_WINDOWS
60using WideStringData = std::pair<std::unique_ptr<wchar_t[]>,
int>;
61CPP_UTILITIES_EXPORT std::wstring convertMultiByteToWide(std::error_code &ec, std::string_view inputBuffer);
62CPP_UTILITIES_EXPORT WideStringData convertMultiByteToWide(std::error_code &ec,
const char *inputBuffer,
int inputBufferSize = -1);
63CPP_UTILITIES_EXPORT WideStringData convertMultiByteToWide(std::error_code &ec,
const std::string &inputBuffer);
64CPP_UTILITIES_EXPORT WideStringData convertMultiByteToWide(
const char *inputBuffer,
int inputBufferSize = -1);
72#ifdef CPP_UTILITIES_USE_RANGES
73template <
class Container>
74using ContainerValueType =
typename std::conditional_t<std::ranges::range<Container>,
75 std::iterator_traits<std::remove_cvref_t<std::ranges::iterator_t<Container>>>, Container>::value_type;
77template <
class Container>
using ContainerValueType =
typename Container::value_type;
79template <
class Container>
using DefaultReturnTypeForContainer = ContainerValueType<Container>;
80template <
class Container>
using StringParamForContainer = std::basic_string_view<typename ContainerValueType<Container>::value_type>;
98template <
class Container = std::initializer_list<std::
string>,
class ReturnType = Detail::DefaultReturnTypeForContainer<Container>>
99ReturnType
joinStrings(
const Container &strings, Detail::StringParamForContainer<Container> delimiter = Detail::StringParamForContainer<Container>(),
100 bool omitEmpty =
false, Detail::StringParamForContainer<Container> leftClosure = Detail::StringParamForContainer<Container>(),
101 Detail::StringParamForContainer<Container> rightClosure = Detail::StringParamForContainer<Container>())
104 if (!strings.size()) {
107 std::size_t entries = 0, size = 0;
108 for (
const auto &str : strings) {
109 if (omitEmpty && str.empty()) {
118 size += (entries * leftClosure.size()) + (entries * rightClosure.size()) + ((entries - 1) * delimiter.size());
120 for (
const auto &str : strings) {
121 if (omitEmpty && str.empty()) {
125 res.append(delimiter);
127 res.append(leftClosure);
129 res.append(rightClosure);
137template <
class Container = std::initializer_list<std::
string>>
inline auto toMultiline(
const Container &arrayOfLines)
160template <
class Container = std::list<std::
string>>
161Container
splitString(Detail::StringParamForContainer<Container>
string, Detail::StringParamForContainer<Container> delimiter,
166 typename Container::value_type *last =
nullptr;
168 typename Container::value_type::size_type
i = 0, end =
string.size();
169 for (
typename Container::value_type::size_type delimPos;
i < end;
i = delimPos + delimiter.size()) {
170 delimPos =
string.find(delimiter,
i);
171 if (!merge && maxParts >= 0 && res.size() ==
static_cast<typename Container::value_type::size_type
>(maxParts)) {
178 delimPos = Container::value_type::npos;
180 if (delimPos == Container::value_type::npos) {
181 delimPos =
string.size();
185 last->append(delimiter);
186 last->append(
string,
i, delimPos -
i);
189 last = &res.emplace_back(
string,
i, delimPos -
i);
212template <
class Container = std::list<std::
string>>
214 Detail::StringParamForContainer<Container>
string, Detail::StringParamForContainer<Container> delimiter,
int maxParts = -1)
218 typename Container::value_type::size_type
i = 0, end =
string.size();
219 for (
typename Container::value_type::size_type delimPos;
i < end;
i = delimPos + delimiter.size()) {
220 delimPos =
string.find(delimiter,
i);
221 if (maxParts >= 0 && res.size() ==
static_cast<typename Container::value_type::size_type
>(maxParts)) {
222 delimPos = Container::value_type::npos;
224 if (delimPos == Container::value_type::npos) {
225 delimPos =
string.size();
227#if __cplusplus >= 201709
228 if constexpr (
requires { res.emplace_back(
string); }) {
230 res.emplace_back(
string.data() +
i, delimPos -
i);
231#if __cplusplus >= 201709
233 res.emplace(
string.data() +
i, delimPos -
i);
238#if __cplusplus >= 201709
239 if constexpr (
requires { res.emplace_back(); }) {
242#if __cplusplus >= 201709
254template <
class Container = std::vector<std::
string>>
inline auto toArrayOfLines(
const std::string &multilineString)
262template <
typename StringType>
bool startsWith(
const StringType &str,
const StringType &phrase)
264 if (str.size() < phrase.size()) {
267 for (
auto stri = str.cbegin(), strend = str.cend(), phrasei = phrase.cbegin(), phraseend = phrase.cend();; ++stri, ++phrasei) {
268 if (phrasei == phraseend) {
270 }
else if (stri == strend) {
272 }
else if (*stri != *phrasei) {
282template <
typename StringType>
bool startsWith(
const StringType &str,
const typename StringType::value_type *phrase)
284 for (
auto stri = str.cbegin(), strend = str.cend();; ++stri, ++phrase) {
287 }
else if (stri == strend) {
289 }
else if (*stri != *phrase) {
299template <
typename StringType>
bool endsWith(
const StringType &str,
const StringType &phrase)
301 if (str.size() < phrase.size()) {
304 for (
auto stri = str.cend() -
static_cast<typename StringType::difference_type
>(phrase.size()), strend = str.cend(), phrasei = phrase.cbegin();
305 stri != strend; ++stri, ++phrasei) {
306 if (*stri != *phrasei) {
316template <
typename StringType>
bool endsWith(
const StringType &str,
const typename StringType::value_type *phrase)
318 const auto phraseSize = std::strlen(phrase);
319 if (str.size() < phraseSize) {
322 for (
auto stri = str.cend() -
static_cast<typename StringType::difference_type
>(phraseSize), strend = str.cend(); stri != strend;
324 if (*stri != *phrase) {
335template <
typename StringType>
bool containsSubstrings(
const StringType &str, std::initializer_list<StringType> substrings)
337 typename StringType::size_type currentPos = 0;
338 for (
const auto &substr : substrings) {
339 if ((currentPos = str.find(substr, currentPos)) == StringType::npos) {
342 currentPos += substr.size();
351template <
typename StringType>
352bool containsSubstrings(
const StringType &str, std::initializer_list<const typename StringType::value_type *> substrings)
354 typename StringType::size_type currentPos = 0;
355 for (
const auto *substr : substrings) {
356 if ((currentPos = str.find(substr, currentPos)) == StringType::npos) {
359 currentPos += std::strlen(substr);
367template <
typename StringType1,
typename StringType2,
typename StringType3>
368void findAndReplace(StringType1 &str,
const StringType2 &find,
const StringType3 &replace)
370 for (
typename StringType1::size_type
i = 0; (
i = str.find(find,
i)) != StringType1::npos;
i += replace.size()) {
371 str.replace(
i, find.size(), replace);
378template <
typename StringType>
379inline void findAndReplace(StringType &str,
const typename StringType::value_type *find,
const typename StringType::value_type *replace)
382 str, std::basic_string_view<typename StringType::value_type>(find), std::basic_string_view<typename StringType::value_type>(replace));
388template <
typename StringType1,
typename StringType2>
389inline void findAndReplace(StringType1 &str,
const StringType2 &find,
const typename StringType1::value_type *replace)
391 findAndReplace(str, find, std::basic_string_view<typename StringType1::value_type>(replace));
397template <
typename StringType1,
typename StringType2>
398inline void findAndReplace(StringType1 &str,
const typename StringType1::value_type *find,
const StringType2 &replace)
400 findAndReplace(str, std::basic_string_view<typename StringType1::value_type>(find), replace);
409template <
typename CharType>
constexpr CharType
digitToChar(CharType digit)
411 return digit <= 9 ? (digit +
'0') : (digit +
'A' - 10);
420template <
typename IntegralType,
class StringType = std::string,
typename BaseType = IntegralType,
424 std::size_t resSize = 0;
425 for (
auto n = number; n; n /=
static_cast<IntegralType
>(base), ++resSize)
428 res.reserve(resSize);
430 res.insert(res.begin(), digitToChar<typename StringType::value_type>(
static_cast<typename StringType::value_type
>(number % base)));
431 number /=
static_cast<IntegralType
>(base);
442template <
typename IntegralType,
class StringType = std::string,
typename BaseType = IntegralType,
443 Traits::EnableIf<std::is_integral<IntegralType>, std::is_signed<IntegralType>> * =
nullptr>
446 const bool negative = number < 0;
449 number = -number, resSize = 1;
453 for (
auto n = number; n; n /=
static_cast<IntegralType
>(base), ++resSize)
456 res.reserve(resSize);
458 res.insert(res.begin(),
459 digitToChar<typename StringType::value_type>(
static_cast<typename StringType::value_type
>(number %
static_cast<IntegralType
>(base))));
460 number /=
static_cast<IntegralType
>(base);
463 res.insert(res.begin(),
'-');
476template <
typename FloatingType,
class StringType = std::
string, Traits::EnableIf<std::is_
floating_po
int<FloatingType>> * =
nullptr>
479 std::basic_stringstream<typename StringType::value_type> ss;
480 ss << std::setbase(base) << number;
488template <
typename CharType> CharType
charToDigit(CharType character, CharType base)
491 if (character >=
'0' && character <=
'9') {
492 res = character -
'0';
493 }
else if (character >=
'a' && character <=
'z') {
494 res = character -
'a' + 10;
495 }
else if (character >=
'A' && character <=
'Z') {
496 res = character -
'A' + 10;
501 std::string errorMsg;
502 errorMsg.reserve(36);
503 errorMsg +=
"The character \"";
504 errorMsg += character >=
' ' && character <= '~' ? static_cast<std::string::value_type>(character) :
'?';
505 errorMsg +=
"\" is no valid digit.";
511template <
typename IntegralType,
typename CharType,
typename BaseType = IntegralType>
512void raiseAndAdd(IntegralType &result, BaseType base, CharType character)
514 if (character ==
' ') {
518 if (__builtin_mul_overflow(result, base, &result)
519 || __builtin_add_overflow(result,
charToDigit(character,
static_cast<CharType
>(base)), &result)) {
520 throw ConversionException(
"Number exceeds limit.");
523 result *=
static_cast<IntegralType
>(base);
524 result +=
static_cast<IntegralType
>(charToDigit<CharType>(character,
static_cast<CharType
>(base)));
537template <
typename IntegralType,
class CharType,
typename BaseType = IntegralType,
538 Traits::EnableIf<std::is_integral<IntegralType>, std::is_unsigned<IntegralType>> * =
nullptr>
539IntegralType
bufferToNumber(
const CharType *
string, std::size_t size, BaseType base = 10)
541 IntegralType result = 0;
542 for (
const CharType *end =
string + size;
string != end; ++string) {
543 Detail::raiseAndAdd(result, base, *
string);
555template <
typename IntegralType,
typename CharType,
typename BaseType = IntegralType,
556 Traits::EnableIf<std::is_integral<IntegralType>, std::is_signed<IntegralType>> * =
nullptr>
557IntegralType
bufferToNumber(
const CharType *
string, std::size_t size, BaseType base = 10)
562 const CharType *end =
string + size;
563 for (;
string != end && *
string ==
' '; ++string)
568 const bool negative = (*
string ==
'-');
572 IntegralType result = 0;
573 for (;
string != end; ++string) {
574 Detail::raiseAndAdd(result, base, *
string);
576 return negative ? -result : result;
586template <
typename IntegralType,
class StringType,
typename BaseType = IntegralType,
587 Traits::EnableIf<std::is_integral<IntegralType>, Traits::Not<std::is_scalar<std::decay_t<StringType>>>> * =
nullptr>
590 return bufferToNumber<IntegralType, typename StringType::value_type, BaseType>(
string.data(),
string.size(), base);
602template <
typename FloatingType,
class StringViewType,
603 Traits::EnableIf<std::is_floating_point<FloatingType>, Traits::IsSpecializationOf<StringViewType, std::basic_string_view>> * =
nullptr>
606 std::basic_stringstream<typename StringViewType::value_type> ss;
607 ss << std::setbase(base) << stringView;
609 if ((ss >> result) && ss.eof()) {
612 std::string errorMsg;
613 errorMsg.reserve(48 + stringView.size());
614 errorMsg +=
"The string \"";
615 errorMsg += stringView;
616 errorMsg +=
"\" is no valid floating point number.";
629template <
typename FloatingType,
class StringType,
630 Traits::EnableIf<std::is_floating_point<FloatingType>, Traits::Not<std::is_scalar<std::decay_t<StringType>>>,
631 Traits::Not<Traits::IsSpecializationOf<StringType, std::basic_string_view>>> * =
nullptr>
634 using StringViewType = std::basic_string_view<typename StringType::value_type>;
635 return stringToNumber<FloatingType, StringViewType>(StringViewType(
string.data(),
string.size()), base);
645template <
typename IntegralType,
typename CharType,
typename BaseType = IntegralType,
646 Traits::EnableIf<std::is_integral<IntegralType>, std::is_unsigned<IntegralType>> * =
nullptr>
649 IntegralType result = 0;
650 for (; *string; ++string) {
651 Detail::raiseAndAdd(result, base, *
string);
665template <
typename FloatingType,
class CharType, Traits::EnableIf<std::is_
floating_po
int<FloatingType>> * =
nullptr>
668 return stringToNumber<FloatingType, std::basic_string_view<CharType>>(string, base);
678template <
typename IntegralType,
typename CharType,
typename BaseType = IntegralType,
679 Traits::EnableIf<std::is_integral<IntegralType>, std::is_signed<IntegralType>> * =
nullptr>
685 for (; *
string && *
string ==
' '; ++string)
690 const bool negative = (*
string ==
'-');
694 IntegralType result = 0;
695 for (; *string; ++string) {
696 Detail::raiseAndAdd(result, base, *
string);
698 return negative ? -result : result;
712 char buffer[
sizeof(T)];
713 BE::getBytes(integer, buffer);
714 return std::string(buffer + startOffset,
sizeof(T) -
static_cast<std::size_t
>(startOffset));
The ConversionException class is thrown by the various conversion functions of this library when a co...
#define CPP_UTILITIES_EXPORT
Marks the symbol to be exported by the c++utilities library.
typename std::enable_if< All< Condition... >::value, Detail::Enabler >::type EnableIf
Shortcut for std::enable_if to omit ::value and ::type.
Contains all utilities provides by the c++utilities library.
void findAndReplace(StringType1 &str, const StringType2 &find, const StringType3 &replace)
Replaces all occurrences of find with relpace in the specified str.
CPP_UTILITIES_EXPORT StringData convertUtf8ToUtf16BE(const char *inputBuffer, std::size_t inputBufferSize)
Converts the specified UTF-8 string to UTF-16 (big-endian).
CPP_UTILITIES_EXPORT StringData convertString(const char *fromCharset, const char *toCharset, const char *inputBuffer, std::size_t inputBufferSize, float outputBufferSizeFactor=1.0f)
Converts the specified string from one character set to another.
StringType numberToString(IntegralType number, BaseType base=10)
Converts the given number to its equivalent string representation using the specified base.
CPP_UTILITIES_EXPORT StringData convertLatin1ToUtf8(const char *inputBuffer, std::size_t inputBufferSize)
Converts the specified Latin-1 string to UTF-8.
CPP_UTILITIES_EXPORT StringData convertUtf16LEToUtf8(const char *inputBuffer, std::size_t inputBufferSize)
Converts the specified UTF-16 (little-endian) string to UTF-8.
EmptyPartsTreat
Specifies the role of empty parts when splitting strings.
CPP_UTILITIES_EXPORT std::pair< std::unique_ptr< std::uint8_t[]>, std::uint32_t > decodeBase64(const char *encodedStr, const std::uint32_t strSize)
Decodes the specified Base64 encoded string.
ReturnType joinStrings(const Container &strings, Detail::StringParamForContainer< Container > delimiter=Detail::StringParamForContainer< Container >(), bool omitEmpty=false, Detail::StringParamForContainer< Container > leftClosure=Detail::StringParamForContainer< Container >(), Detail::StringParamForContainer< Container > rightClosure=Detail::StringParamForContainer< Container >())
Joins the given strings using the specified delimiter.
bool startsWith(const StringType &str, const StringType &phrase)
Returns whether str starts with phrase.
IntegralType stringToNumber(const StringType &string, BaseType base=10)
Converts the given string to an unsigned/signed number assuming string uses the specified base.
CPP_UTILITIES_EXPORT void truncateString(std::string &str, char terminationChar='\0')
Truncates all characters after the first occurrence of the specified terminationChar and the terminat...
std::pair< std::unique_ptr< char[], StringDataDeleter >, std::size_t > StringData
Type used to return string encoding conversion result.
CPP_UTILITIES_EXPORT StringData convertUtf16BEToUtf8(const char *inputBuffer, std::size_t inputBufferSize)
Converts the specified UTF-16 (big-endian) string to UTF-8.
constexpr CharType digitToChar(CharType digit)
Returns the character representation of the specified digit.
Container splitStringSimple(Detail::StringParamForContainer< Container > string, Detail::StringParamForContainer< Container > delimiter, int maxParts=-1)
Splits the given string (which might also be a string view) at the specified delimiter.
auto toArrayOfLines(const std::string &multilineString)
Converts the specified multilineString to an array of lines.
bool containsSubstrings(const StringType &str, std::initializer_list< StringType > substrings)
Returns whether str contains the specified substrings.
CPP_UTILITIES_EXPORT StringData convertUtf8ToLatin1(const char *inputBuffer, std::size_t inputBufferSize)
Converts the specified UTF-8 string to Latin-1.
std::string interpretIntegerAsString(T integer, int startOffset=0)
Interprets the given integer at the specified position as std::string using the specified byte order.
bool endsWith(const StringType &str, const StringType &phrase)
Returns whether str ends with phrase.
auto toMultiline(const Container &arrayOfLines)
Converts the specified arrayOfLines to a multiline string.
CPP_UTILITIES_EXPORT StringData convertUtf8ToUtf16LE(const char *inputBuffer, std::size_t inputBufferSize)
Converts the specified UTF-8 string to UTF-16 (little-endian).
CPP_UTILITIES_EXPORT std::string bitrateToString(double speedInKbitsPerSecond, bool useByteInsteadOfBits=false)
Converts the specified bitrate in kbit/s to its equivalent std::string representation.
CharType charToDigit(CharType character, CharType base)
Returns number/digit of the specified character representation using the specified base.
CPP_UTILITIES_EXPORT std::string encodeBase64(const std::uint8_t *data, std::uint32_t dataSize)
Encodes the specified data to Base64.
CPP_UTILITIES_EXPORT std::string dataSizeToString(std::uint64_t sizeInByte, bool includeByte=false)
Converts the specified data size in byte to its equivalent std::string representation.
IntegralType bufferToNumber(const CharType *string, std::size_t size, BaseType base=10)
Converts the given string of size characters to an unsigned numeric value using the specified base.
Container splitString(Detail::StringParamForContainer< Container > string, Detail::StringParamForContainer< Container > delimiter, EmptyPartsTreat emptyPartsRole=EmptyPartsTreat::Keep, int maxParts=-1)
Splits the given string at the specified delimiter.
The StringDataDeleter struct deletes the data of a StringData instance.
void operator()(char *stringData)
Deletes the specified stringData with std::free(), because the memory has been allocated using std::m...