Non-owning view over a range of characters with UTF Encoding. More...

#include <StringView.h>

Inheritance diagram for SC::StringView:

Public Member Functions
constexpr	StringView (StringSpan ssv)

Span< const uint8_t >	toBytesSpan () const SC_LANGUAGE_LIFETIME_BOUND
	Obtain a `const uint8_t` Span from this StringView.

template<typename Func >
constexpr auto	withIterator (Func &&func) const
	Call given lambda with one of StringIteratorASCII, StringIteratorUTF8, StringIteratorUTF16 depending on encoding.

template<typename StringIterator >
constexpr StringIterator	getIterator () const
	Returns a StringIterator from current StringView.

constexpr bool	operator!= (StringView other) const
	Compare this StringView with another StringView for inequality.

constexpr bool	operator== (StringView other) const
	Compare this StringView with another StringView for equality.

constexpr bool	fullyOverlaps (StringView other, size_t &commonOverlappingPoints) const
	Check if this StringView is equal to other StringView (operates on code points, not on utf graphemes).

constexpr bool	isEmpty () const
	Check if StringView is empty.

constexpr bool	isNullTerminated () const
	Check if StringView is immediately followed by a null termination character.

constexpr size_t	sizeInBytes () const
	Get size of the StringView in bytes.

bool	endsWithAnyOf (Span< const StringCodePoint > codePoints) const
	Check if StringView ends with any utf code point in the given span.

bool	startsWithAnyOf (Span< const StringCodePoint > codePoints) const
	Check if StringView starts with any utf code point in the given span.

bool	startsWith (const StringView str) const
	Check if StringView starts with another StringView.

bool	startsWithIgnoreCaseASCII (const StringView str) const
	Check if StringView starts with another StringView using ASCII-only case-insensitive comparison.

bool	endsWith (const StringView str) const
	Check if StringView ends with another StringView.

bool	containsString (const StringView str) const
	Check if StringView contains another StringView.

bool	containsStringIgnoreCaseASCII (const StringView str) const
	Check if StringView contains another StringView using ASCII-only case-insensitive comparison.

bool	equalsIgnoreCaseASCII (const StringView str) const
	Check if StringView is equal to another StringView using ASCII-only case-insensitive comparison.

bool	splitAfter (const StringView stringToMatch, StringView &remainingAfterSplit) const
	Returns the remaining part of the string after matching stringToMatch.

bool	splitBefore (const StringView stringToMatch, StringView &stringBeforeSplit) const
	Returns the part of the string before matching stringToMatch.

bool	containsCodePoint (StringCodePoint c) const
	Check if StringView contains given utf code point.

constexpr bool	hasCompatibleEncoding (StringView str) const
	Check if current StringView has compatible encoding with str.

StringView	sliceStartEnd (size_t start, size_t end) const
	Get slice `[start, end)` starting at offset `start` and ending at `end` (measured in utf code points)

StringView	sliceStartLength (size_t start, size_t length) const
	Get slice `[start, start+length]` starting at offset `start` and of `length` code points.

StringView	sliceStart (size_t offset) const
	Get slice `[offset, end]` measured in utf code points.

StringView	sliceEnd (size_t offset) const
	Get slice `[end-offset, end]` measured in utf code points.

StringView	trimEndAnyOf (Span< const StringCodePoint > codePoints) const
	Returns a shortened StringView removing ending utf code points matching the `codePoints` span.

StringView	trimStartAnyOf (Span< const StringCodePoint > codePoints) const
	Returns a shortened StringView removing starting utf code points matching the `codePoints` span.

StringView	trimAnyOf (Span< const StringCodePoint > codePoints) const
	Returns a shortened StringView removing starting and ending utf code points inside the `codePoints` span.

StringView	trimWhiteSpaces () const
	Returns a shortened StringView without starting/ending utf code points inside {'\r', '\n', '\t', ' '}.

bool	isIntegerNumber () const
	If the current view is an integer number, returns true.

bool	isFloatingNumber () const
	Check if StringView can be parsed as an floating point number.

bool	parseInt32 (int32_t &value) const
	Try parsing current StringView as a 32 bit integer.

bool	parseFloat (float &value) const
	Try parsing current StringView as a floating point number.

bool	parseDouble (double &value) const
	Try parsing current StringView as a double precision floating point number.

template<typename Type >
constexpr SC::StringIteratorASCII	getIterator (identity< Type >) const

template<typename StringIterator >
SC::StringView	fromIterators (StringIterator from, StringIterator to, StringEncoding encoding)

template<typename StringIterator >
SC::StringView	fromIteratorUntilEnd (StringIterator it, StringEncoding encoding)

template<typename StringIterator >
constexpr SC::StringView	fromIteratorFromStart (StringIterator it, StringEncoding encoding)

Static Public Member Functions
static StringView	fromNullTerminated (const char *text, StringEncoding encoding)

template<typename Func >
static constexpr auto	withIterators (StringView s1, StringView s2, Func &&func)
	Call given lambda with one of StringIteratorASCII, StringIteratorUTF8, StringIteratorUTF16 depending on encoding.

template<typename StringIterator >
static StringView	fromIterators (StringIterator from, StringIterator to, StringEncoding encoding=StringIterator::getEncoding())
	Returns a StringView starting at `from` and ending at `to`.

template<typename StringIterator >
static StringView	fromIteratorUntilEnd (StringIterator it, StringEncoding encoding=StringIterator::getEncoding())
	Returns a section of a string, from `it` to end of StringView.

template<typename StringIterator >
static constexpr StringView	fromIteratorFromStart (StringIterator it, StringEncoding encoding=StringIterator::getEncoding())
	Returns a section of a string, from start of StringView to `it`.

Detailed Description

Non-owning view over a range of characters with UTF Encoding.

It additional also holds the SC::StringEncoding information (ASCII, UTF8 or UTF16). During construction the encoding information and the null-termination state must be specified. All methods are const because it's not possible to modify a string with it.
Example (Construct)

StringView s("asd");
SC_STRINGS_ASSERT_RELEASE(s.sizeInBytes() == 3);
SC_STRINGS_ASSERT_RELEASE(s.isNullTerminated());

Example (Construct from null terminated string)

const char* someString = "asdf";
// construct only "asd", not null terminated (as there is 'f' after 'd')
StringView s({someString, strlen(asd) - 1}, false, StringEncoding::Ascii);
SC_STRINGS_ASSERT_RELEASE(s.sizeInBytes() == 3);
SC_STRINGS_ASSERT_RELEASE(not s.isNullTerminated());
//
// ... or
StringView s2 = StringView::fromNullTerminated(s, StringEncoding::Ascii); // s2 == "asdf"

Member Function Documentation

◆ containsCodePoint()

bool SC::StringView::containsCodePoint ( StringCodePoint c ) const

nodiscard

Check if StringView contains given utf code point.

Parameters

c	The utf code point to check against

Returns: Returns true if this StringView contains code point c

◆ containsString()

bool SC::StringView::containsString ( const StringView str ) const

nodiscard

Check if StringView contains another StringView.

Parameters

str	The other StringView to check with current

Returns: Returns true if this StringView contains str

Example:

StringView asd = "123 456";
SC_TRY(asd.containsString("123"));
SC_TRY(asd.containsString("456"));
SC_TRY(not asd.containsString("124"));
SC_TRY(not asd.containsString("4567"));

◆ containsStringIgnoreCaseASCII()

bool SC::StringView::containsStringIgnoreCaseASCII ( const StringView str ) const

nodiscard

Check if StringView contains another StringView using ASCII-only case-insensitive comparison.

Non-ASCII code points are compared without case folding.

◆ endsWith()

bool SC::StringView::endsWith ( const StringView str ) const

nodiscard

Check if StringView ends with another StringView.

Parameters

str	The other StringView to check with current

Returns: Returns true if this StringView ends with str

Example:

SC_TEST_EXPECT("123 456".endsWith("456"));

SC_TEST_EXPECT

#define SC_TEST_EXPECT(e)

Records a test expectation (eventually aborting or breaking o n failed test)

Definition Testing.h:187

SC::StringView::endsWith

bool endsWith(const StringView str) const

Check if StringView ends with another StringView.

◆ endsWithAnyOf()

bool SC::StringView::endsWithAnyOf ( Span< const StringCodePoint > codePoints ) const

nodiscard

Check if StringView ends with any utf code point in the given span.

Parameters

codePoints The utf code points to check against

Returns: Returns true if this StringView ends with any code point inside codePoints

Example:

SC_TEST_EXPECT("123 456".endsWithAnyOf({'a', '6'})); // '6' will match

SC::StringView::endsWithAnyOf

bool endsWithAnyOf(Span< const StringCodePoint > codePoints) const

Check if StringView ends with any utf code point in the given span.

◆ equalsIgnoreCaseASCII()

bool SC::StringView::equalsIgnoreCaseASCII ( const StringView str ) const

nodiscard

Check if StringView is equal to another StringView using ASCII-only case-insensitive comparison.

Non-ASCII code points are compared without case folding.

◆ fromIteratorFromStart()

template<typename StringIterator >

static constexpr StringView SC::StringView::fromIteratorFromStart	(	StringIterator	it,
		StringEncoding	encoding = StringIterator::getEncoding() )

staticconstexpr

Returns a section of a string, from start of StringView to it.

Template Parameters

StringIterator One among StringIteratorASCII, StringIteratorUTF8 and StringIteratorUTF16

Parameters

it	The iterator pointing at the start of the specified portion of StringView.
encoding	What encoding should be assigned to the resulting StringView

Returns: Another StringView pointing at characters from start of StringView until it

◆ fromIterators()

template<typename StringIterator >

static StringView SC::StringView::fromIterators	(	StringIterator	from,
		StringIterator	to,
		StringEncoding	encoding = StringIterator::getEncoding() )

static

Returns a StringView starting at from and ending at to.

Template Parameters

StringIterator One among StringIteratorASCII, StringIteratorUTF8 and StringIteratorUTF16

Parameters

from	Indicates where the StringView will start. The from iterator will be shortened until the start of to.
to	Indicates where the StringView will end.
encoding	What encoding should be assigned to the resulting StringView

Returns: A StringView starting at from and ending at to.

Note: If from is > to an empty StringView will be returned

◆ fromIteratorUntilEnd()

template<typename StringIterator >

static StringView SC::StringView::fromIteratorUntilEnd	(	StringIterator	it,
		StringEncoding	encoding = StringIterator::getEncoding() )

static

Returns a section of a string, from it to end of StringView.

Template Parameters

StringIterator One among StringIteratorASCII, StringIteratorUTF8 and StringIteratorUTF16

Parameters

it	The iterator pointing at the start of the specified portion of StringView.
encoding	What encoding should be assigned to the resulting StringView

Returns: Another StringView pointing at characters from it up to StringView end

◆ fullyOverlaps()

bool SC::StringView::fullyOverlaps	(	StringView	other,
		size_t &	commonOverlappingPoints ) const

nodiscardconstexpr

Check if this StringView is equal to other StringView (operates on code points, not on utf graphemes).

Returns the number of code points that are the same in both StringView-s.

Parameters

other	The StringView to be compared to
commonOverlappingPoints	number of equal code points in both StringView

Returns: true if the two StringViews are equal

Example:

StringView asd = "123 456"_a8;
size_t overlapPoints = 0;
SC_TEST_EXPECT(not asd.fullyOverlaps("123___", overlapPoints) and overlapPoints == 3);

◆ getIterator()

template<typename StringIterator >

StringIterator SC::StringView::getIterator ( ) const

constexpr

Returns a StringIterator from current StringView.

Template Parameters

StringIterator can be StringIteratorASCII, StringIteratorUTF8 or StringIteratorUTF16

Returns: StringIterator representing the StringView

◆ hasCompatibleEncoding()

bool SC::StringView::hasCompatibleEncoding ( StringView str ) const

nodiscardconstexpr

Check if current StringView has compatible encoding with str.

This means checking if two encodings have the same utf unit size.

Parameters

str	The other StringView to check with current

Returns: true if this StringView has compatible encoding with str

◆ isEmpty()

bool SC::StringView::isEmpty ( ) const

inlinenodiscardconstexpr

Check if StringView is empty.

Returns: true if string is empty

◆ isFloatingNumber()

bool SC::StringView::isFloatingNumber ( ) const

nodiscard

Check if StringView can be parsed as an floating point number.

Returns: true if StringView is a floating point number.

Example:

SC_TEST_EXPECT("-34."_a8.isFloatingNumber());
SC_TEST_EXPECT("-34.0"_a8.isFloatingNumber());
SC_TEST_EXPECT("0.34"_a8.isFloatingNumber());
SC_TEST_EXPECT(not "+12$"_a8.isFloatingNumber());
SC_TEST_EXPECT(not "$+12"_a8.isFloatingNumber());
SC_TEST_EXPECT(not "+$12"_a8.isFloatingNumber());

◆ isIntegerNumber()

bool SC::StringView::isIntegerNumber ( ) const

nodiscard

If the current view is an integer number, returns true.

Check if StringView can be parsed as an integer number.

Returns: true if StringView is an integer number.

Example:

SC_TEST_EXPECT("-34"_a8.isIntegerNumber());
SC_TEST_EXPECT("+12"_a8.isIntegerNumber());
SC_TEST_EXPECT(not "+12$"_a8.isIntegerNumber());

◆ isNullTerminated()

bool SC::StringView::isNullTerminated ( ) const

inlinenodiscardconstexpr

Check if StringView is immediately followed by a null termination character.

Returns: true if StringView is immediately followed by a null termination character

◆ operator!=()

bool SC::StringView::operator!= ( StringView other ) const

inlinenodiscardconstexpr

Compare this StringView with another StringView for inequality.

Parameters

other StringView to be compared with current one

Returns: 'true' if the two StringView are different

◆ operator==()

bool SC::StringView::operator== ( StringView other ) const

nodiscardconstexpr

Compare this StringView with another StringView for equality.

Parameters

other StringView to be compared with current one

Returns: 'true' if the two StringView are the same

◆ parseDouble()

bool SC::StringView::parseDouble ( double & value ) const

nodiscard

Try parsing current StringView as a double precision floating point number.

Parameters

value Will receive the parsed double precision floating point number, if function returns true.

Returns: true if the StringView has been successfully parsed as a double precision floating point number.

Example:

StringView other("12.342321");
double    value;
if(other.parseDouble(value))
{
    // ... do something with value
}

◆ parseFloat()

bool SC::StringView::parseFloat ( float & value ) const

nodiscard

Try parsing current StringView as a floating point number.

Parameters

value Will receive the parsed floating point number, if function returns true.

Returns: true if the StringView has been successfully parsed as a floating point number.

Example:

StringView other("12.34");
float    value;
if(other.parseFloat(value))
{
    // ... do something with value
}

◆ parseInt32()

bool SC::StringView::parseInt32 ( int32_t & value ) const

nodiscard

Try parsing current StringView as a 32 bit integer.

Parameters

value Will receive the parsed 32 bit integer, if function returns true.

Returns: true if the StringView has been successfully parsed as a 32 bit integer.

Example:

StringView other("123");
int32_t    value;
if(other.parseInt32(value))
{
    // ... do something with value
}

◆ sizeInBytes()

size_t SC::StringView::sizeInBytes ( ) const

inlinenodiscardconstexpr

Get size of the StringView in bytes.

Returns: Size in bytes of StringView

◆ sliceEnd()

StringView SC::StringView::sliceEnd ( size_t offset ) const

nodiscard

Get slice [end-offset, end] measured in utf code points.

Parameters

offset The initial code point where the slice starts

Returns: The sliced StringView [end-offset, end]

Example:

StringView str = "123_567";

SC_TEST_EXPECT(str.sliceEnd(4) == "123");

SC::StringView::sliceEnd

StringView sliceEnd(size_t offset) const

Get slice [end-offset, end] measured in utf code points.

◆ sliceStart()

StringView SC::StringView::sliceStart ( size_t offset ) const

nodiscard

Get slice [offset, end] measured in utf code points.

Parameters

offset The initial code point where the slice starts

Returns: The sliced StringView [offset, end]

Example:

StringView str = "123_567";

SC_TEST_EXPECT(str.sliceStart(4) == "567");

SC::StringView::sliceStart

StringView sliceStart(size_t offset) const

Get slice [offset, end] measured in utf code points.

◆ sliceStartEnd()

StringView SC::StringView::sliceStartEnd	(	size_t	start,
		size_t	end ) const

nodiscard

Get slice [start, end) starting at offset start and ending at end (measured in utf code points)

Parameters

start	The initial code point where the slice starts
end	One after the final code point where the slice ends

Returns: The [start, end) StringView slice

Example:

StringView str = "123_567";
SC_TEST_EXPECT(str.sliceStartEnd(0, 3) == "123");
SC_TEST_EXPECT(str.sliceStartEnd(4, 7) == "567");

◆ sliceStartLength()

StringView SC::StringView::sliceStartLength	(	size_t	start,
		size_t	length ) const

nodiscard

Get slice [start, start+length] starting at offset start and of length code points.

Parameters

start	The initial code point where the slice starts
length	One after the final code point where the slice ends

Returns: The [start, start+length] StringView slice

Example:

StringView str = "123_567";
SC_TEST_EXPECT(str.sliceStartLength(7, 0) == "");
SC_TEST_EXPECT(str.sliceStartLength(0, 3) == "123");

◆ splitAfter()

bool SC::StringView::splitAfter	(	const StringView	stringToMatch,
		StringView &	remainingAfterSplit ) const

nodiscard

Returns the remaining part of the string after matching stringToMatch.

Parameters

stringToMatch	String to match inside the source string
remainingAfterSplit	Portion of this StringView AFTER first match of stringToMatch (excluding the match)

Returns: Returns true if stringToMatch has been found and split has been written to remainingAfterSplit

Example:

StringView str("KEY = VALUE");
StringView split;
SC_TEST_EXPECT(str.splitAfter(" = ", split));
SC_TEST_EXPECT(split == "VALUE");

◆ splitBefore()

bool SC::StringView::splitBefore	(	const StringView	stringToMatch,
		StringView &	stringBeforeSplit ) const

nodiscard

Returns the part of the string before matching stringToMatch.

Parameters

stringToMatch	String to match inside the source string
stringBeforeSplit	Portion of this StringView BEFORE first match of stringToMatch (excluding the match)

Returns: Returns true if stringToMatch has been found and split has been written to remainingAfterSplit

Example:

StringView str("KEY = VALUE");
StringView split;
SC_TEST_EXPECT(str.splitBefore(" = ", split));
SC_TEST_EXPECT(split == "KEY");

◆ startsWith()

bool SC::StringView::startsWith ( const StringView str ) const

nodiscard

Check if StringView starts with another StringView.

Parameters

str	The other StringView to check with current

Returns: Returns true if this StringView starts with str

Example:

SC_TEST_EXPECT("123 456".startsWith("123"));

SC::StringView::startsWith

bool startsWith(const StringView str) const

Check if StringView starts with another StringView.

◆ startsWithAnyOf()

bool SC::StringView::startsWithAnyOf ( Span< const StringCodePoint > codePoints ) const

nodiscard

Check if StringView starts with any utf code point in the given span.

Parameters

codePoints The utf code points to check against

Returns: Returns true if this StringView starts with any code point inside codePoints

Example:

SC_TEST_EXPECT("123 456".startsWithAnyOf({'1', '8'})); // '1' will match

SC::StringView::startsWithAnyOf

bool startsWithAnyOf(Span< const StringCodePoint > codePoints) const

Check if StringView starts with any utf code point in the given span.

◆ startsWithIgnoreCaseASCII()

bool SC::StringView::startsWithIgnoreCaseASCII ( const StringView str ) const

nodiscard

Check if StringView starts with another StringView using ASCII-only case-insensitive comparison.

Non-ASCII code points are compared without case folding.

◆ toBytesSpan()

Span< const uint8_t > SC::StringView::toBytesSpan ( ) const

inline

Obtain a const uint8_t Span from this StringView.

Returns: Span representing this StringView

◆ trimAnyOf()

StringView SC::StringView::trimAnyOf ( Span< const StringCodePoint > codePoints ) const

nodiscard

Returns a shortened StringView removing starting and ending utf code points inside the codePoints span.

Parameters

codePoints The span of utf code points to look for

Returns: The trimmed StringView

Example:

SC_TEST_EXPECT("__\n_myTest__\n"_a8.trimAnyOf({'_', '\n'}) == "myTest");

SC_TEST_EXPECT("_myTest"_a8.trimAnyOf({'_'}) == "myTest");

◆ trimEndAnyOf()

StringView SC::StringView::trimEndAnyOf ( Span< const StringCodePoint > codePoints ) const

nodiscard

Returns a shortened StringView removing ending utf code points matching the codePoints span.

Parameters

codePoints The span of utf code points to look for

Returns: The trimmed StringView

Example:

SC_TEST_EXPECT("myTest_\n__"_a8.trimEndAnyOf({'_', '\n'}) == "myTest");

SC_TEST_EXPECT("myTest"_a8.trimEndAnyOf({'_'}) == "myTest");

◆ trimStartAnyOf()

StringView SC::StringView::trimStartAnyOf ( Span< const StringCodePoint > codePoints ) const

nodiscard

Returns a shortened StringView removing starting utf code points matching the codePoints span.

Parameters

codePoints The span of utf code points to look for

Returns: The trimmed StringView

Example:

SC_TEST_EXPECT("__\n_myTest"_a8.trimStartAnyOf({'_', '\n'}) == "myTest");

SC_TEST_EXPECT("_myTest"_a8.trimStartAnyOf({'_'}) == "myTest");

◆ trimWhiteSpaces()

StringView SC::StringView::trimWhiteSpaces ( ) const

nodiscard

Returns a shortened StringView without starting/ending utf code points inside {'\r', '\n', '\t', ' '}.

Returns: The trimmed StringView

Example:

SC_TEST_EXPECT(" \n_myTest__\n\t"_a8.trimWhiteSpaces() == "_myTest__");

SC_TEST_EXPECT("\nmyTest \r"_a8.trimWhiteSpaces() == "myTest");

◆ withIterator()

template<typename Func >

auto SC::StringView::withIterator ( Func && func ) const

nodiscardconstexpr

Call given lambda with one of StringIteratorASCII, StringIteratorUTF8, StringIteratorUTF16 depending on encoding.

Template Parameters

Func	A function/lambda with `auto operator()({StringIteratorASCII \| StringIteratorUTF8 \| / StringIteratorUTF16})`

Parameters

func	lambda / functor to be called

Returns: whatever value is returned by invoking func

◆ withIterators()

template<typename Func >

auto SC::StringView::withIterators	(	StringView	s1,
		StringView	s2,
		Func &&	func )

staticnodiscardconstexpr

Call given lambda with one of StringIteratorASCII, StringIteratorUTF8, StringIteratorUTF16 depending on encoding.

Template Parameters

Func	Func A function/lambda with `auto operator()({StringIteratorASCII \| StringIteratorUTF8 \| / StringIteratorUTF16}, {StringIteratorASCII \| StringIteratorUTF8 \| StringIteratorUTF16})`

Parameters

s1	StringView that will be passed as first iterator
s2	StringView that will be passed as second iterator
func	the lambda / to be invoked

Returns: whatever value is returned by invoking func

The documentation for this struct was generated from the following file:

StringView.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ containsCodePoint()

◆ containsString()

◆ containsStringIgnoreCaseASCII()

◆ endsWith()

◆ endsWithAnyOf()

◆ equalsIgnoreCaseASCII()

◆ fromIteratorFromStart()

◆ fromIterators()

◆ fromIteratorUntilEnd()

◆ fullyOverlaps()

◆ getIterator()

◆ hasCompatibleEncoding()

◆ isEmpty()

◆ isFloatingNumber()

◆ isIntegerNumber()

◆ isNullTerminated()

◆ operator!=()

◆ operator==()

◆ parseDouble()

◆ parseFloat()

◆ parseInt32()

◆ sizeInBytes()

◆ sliceEnd()

◆ sliceStart()

◆ sliceStartEnd()

◆ sliceStartLength()

◆ splitAfter()

◆ splitBefore()

◆ startsWith()

◆ startsWithAnyOf()

◆ startsWithIgnoreCaseASCII()

◆ toBytesSpan()

◆ trimAnyOf()

◆ trimEndAnyOf()

◆ trimStartAnyOf()

◆ trimWhiteSpaces()

◆ withIterator()

◆ withIterators()