#include <CharPointer_UTF8.h>

Public Types
enum	{ byteOrderMark1 = 0xef , byteOrderMark2 = 0xbb , byteOrderMark3 = 0xbf }
typedef char	CharType

Public Member Functions
	CharPointer_UTF8 (const CharType *const rawPointer) noexcept
	CharPointer_UTF8 (const CharPointer_UTF8 &other) noexcept
CharPointer_UTF8 &	operator= (CharPointer_UTF8 other) noexcept
CharPointer_UTF8 &	operator= (const CharType *text) noexcept
bool	operator== (CharPointer_UTF8 other) const noexcept
bool	operator!= (CharPointer_UTF8 other) const noexcept
bool	operator<= (CharPointer_UTF8 other) const noexcept
bool	operator< (CharPointer_UTF8 other) const noexcept
bool	operator>= (CharPointer_UTF8 other) const noexcept
bool	operator> (CharPointer_UTF8 other) const noexcept
CharType *	getAddress () const noexcept
	operator const CharType * () const noexcept
bool	isEmpty () const noexcept
water_uchar	operator* () const noexcept
CharPointer_UTF8 &	operator++ () noexcept
CharPointer_UTF8	operator++ (int) noexcept
CharPointer_UTF8 &	operator-- () noexcept
water_uchar	getAndAdvance () noexcept
void	operator+= (int numToSkip) noexcept
void	operator-= (int numToSkip) noexcept
water_uchar	operator[] (int characterIndex) const noexcept
CharPointer_UTF8	operator+ (int numToSkip) const noexcept
CharPointer_UTF8	operator- (int numToSkip) const noexcept
size_t	length () const noexcept
size_t	lengthUpTo (const size_t maxCharsToCount) const noexcept
size_t	lengthUpTo (const CharPointer_UTF8 end) const noexcept
size_t	sizeInBytes () const noexcept
CharPointer_UTF8	findTerminatingNull () const noexcept
void	write (const water_uchar charToWrite) noexcept
void	writeNull () const noexcept
template<typename CharPointer>
void	writeAll (const CharPointer src) noexcept
void	writeAll (const CharPointer_UTF8 src) noexcept
template<typename CharPointer>
size_t	writeWithDestByteLimit (const CharPointer src, const size_t maxDestBytes) noexcept
template<typename CharPointer>
void	writeWithCharLimit (const CharPointer src, const int maxChars) noexcept
template<typename CharPointer>
int	compare (const CharPointer other) const noexcept
template<typename CharPointer>
int	compareUpTo (const CharPointer other, const int maxChars) const noexcept
template<typename CharPointer>
int	compareIgnoreCase (const CharPointer other) const noexcept
int	compareIgnoreCase (const CharPointer_UTF8 other) const noexcept
template<typename CharPointer>
int	compareIgnoreCaseUpTo (const CharPointer other, const int maxChars) const noexcept
template<typename CharPointer>
int	indexOf (const CharPointer stringToFind) const noexcept
int	indexOf (const water_uchar charToFind) const noexcept
int	indexOf (const water_uchar charToFind, const bool ignoreCase) const noexcept
bool	isWhitespace () const noexcept
bool	isDigit () const noexcept
bool	isLetter () const noexcept
bool	isLetterOrDigit () const noexcept
bool	isUpperCase () const noexcept
bool	isLowerCase () const noexcept
water_uchar	toUpperCase () const noexcept
water_uchar	toLowerCase () const noexcept
int	getIntValue32 () const noexcept
int64	getIntValue64 () const noexcept
double	getDoubleValue () const noexcept
CharPointer_UTF8	findEndOfWhitespace () const noexcept

Static Public Member Functions
static size_t	getBytesRequiredFor (const water_uchar charToWrite) noexcept
template<class CharPointer>
static size_t	getBytesRequiredFor (CharPointer text) noexcept
static bool	canRepresent (water_uchar character) noexcept
static bool	isValidString (const CharType *dataToTest, int maxBytesToRead)
static bool	isByteOrderMark (const void *possibleByteOrder) noexcept

Private Attributes
CharType *	data

Friends
class	String

Detailed Description

Wraps a pointer to a null-terminated UTF-8 character string, and provides various methods to operate on the data.

See also: CharPointer_UTF16, CharPointer_UTF32

Member Typedef Documentation

◆ CharType

typedef char water::CharPointer_UTF8::CharType

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

These values are the byte-order mark (BOM) values for a UTF-8 stream.

Enumerator
byteOrderMark1
byteOrderMark2
byteOrderMark3

Constructor & Destructor Documentation

◆ CharPointer_UTF8() [1/2]

water::CharPointer_UTF8::CharPointer_UTF8 ( const CharType *const rawPointer )

inlineexplicitnoexcept

◆ CharPointer_UTF8() [2/2]

water::CharPointer_UTF8::CharPointer_UTF8 ( const CharPointer_UTF8 & other )

inlinenoexcept

Member Function Documentation

◆ canRepresent()

bool water::CharPointer_UTF8::canRepresent ( water_uchar character )

inlinestaticnoexcept

Returns true if the given unicode character can be represented in this encoding.

◆ compare()

template<typename CharPointer>

int water::CharPointer_UTF8::compare ( const CharPointer other ) const

inlinenoexcept

Compares this string with another one.

◆ compareIgnoreCase() [1/2]

template<typename CharPointer>

int water::CharPointer_UTF8::compareIgnoreCase ( const CharPointer other ) const

inlinenoexcept

Compares this string with another one.

◆ compareIgnoreCase() [2/2]

int water::CharPointer_UTF8::compareIgnoreCase ( const CharPointer_UTF8 other ) const

inlinenoexcept

Compares this string with another one.

◆ compareIgnoreCaseUpTo()

template<typename CharPointer>

int water::CharPointer_UTF8::compareIgnoreCaseUpTo	(	const CharPointer	other,
		const int	maxChars ) const

inlinenoexcept

Compares this string with another one, up to a specified number of characters.

◆ compareUpTo()

template<typename CharPointer>

int water::CharPointer_UTF8::compareUpTo	(	const CharPointer	other,
		const int	maxChars ) const

inlinenoexcept

Compares this string with another one, up to a specified number of characters.

◆ findEndOfWhitespace()

CharPointer_UTF8 water::CharPointer_UTF8::findEndOfWhitespace ( ) const

inlinenoexcept

Returns the first non-whitespace character in the string.

◆ findTerminatingNull()

CharPointer_UTF8 water::CharPointer_UTF8::findTerminatingNull ( ) const

inlinenoexcept

Returns a pointer to the null character that terminates this string.

◆ getAddress()

CharType * water::CharPointer_UTF8::getAddress ( ) const

inlinenoexcept

Returns the address that this pointer is pointing to.

◆ getAndAdvance()

water_uchar water::CharPointer_UTF8::getAndAdvance ( )

inlinenoexcept

Returns the character that this pointer is currently pointing to, and then advances the pointer to point to the next character.

◆ getBytesRequiredFor() [1/2]

template<class CharPointer>

size_t water::CharPointer_UTF8::getBytesRequiredFor ( CharPointer text )

inlinestaticnoexcept

Returns the number of bytes that would be needed to represent the given string in this encoding format. The value returned does NOT include the terminating null character.

◆ getBytesRequiredFor() [2/2]

size_t water::CharPointer_UTF8::getBytesRequiredFor ( const water_uchar charToWrite )

inlinestaticnoexcept

Returns the number of bytes that would be needed to represent the given unicode character in this encoding format.

◆ getDoubleValue()

double water::CharPointer_UTF8::getDoubleValue ( ) const

inlinenoexcept

Parses this string as a floating point double.

◆ getIntValue32()

int water::CharPointer_UTF8::getIntValue32 ( ) const

inlinenoexcept

Parses this string as a 32-bit integer.

◆ getIntValue64()

int64 water::CharPointer_UTF8::getIntValue64 ( ) const

inlinenoexcept

Parses this string as a 64-bit integer.

◆ indexOf() [1/3]

template<typename CharPointer>

int water::CharPointer_UTF8::indexOf ( const CharPointer stringToFind ) const

inlinenoexcept

Returns the character index of a substring, or -1 if it isn't found.

◆ indexOf() [2/3]

int water::CharPointer_UTF8::indexOf ( const water_uchar charToFind ) const

inlinenoexcept

Returns the character index of a unicode character, or -1 if it isn't found.

◆ indexOf() [3/3]

int water::CharPointer_UTF8::indexOf	(	const water_uchar	charToFind,
		const bool	ignoreCase ) const

inlinenoexcept

Returns the character index of a unicode character, or -1 if it isn't found.

◆ isByteOrderMark()

bool water::CharPointer_UTF8::isByteOrderMark ( const void * possibleByteOrder )

inlinestaticnoexcept

Returns true if the first three bytes in this pointer are the UTF8 byte-order mark (BOM). The pointer must not be null, and must point to at least 3 valid bytes.

◆ isDigit()

bool water::CharPointer_UTF8::isDigit ( ) const

inlinenoexcept

Returns true if the first character of this string is a digit.

◆ isEmpty()

bool water::CharPointer_UTF8::isEmpty ( ) const

inlinenoexcept

Returns true if this pointer is pointing to a null character.

◆ isLetter()

bool water::CharPointer_UTF8::isLetter ( ) const

inlinenoexcept

Returns true if the first character of this string is a letter.

◆ isLetterOrDigit()

bool water::CharPointer_UTF8::isLetterOrDigit ( ) const

inlinenoexcept

Returns true if the first character of this string is a letter or digit.

◆ isLowerCase()

bool water::CharPointer_UTF8::isLowerCase ( ) const

inlinenoexcept

Returns true if the first character of this string is lower-case.

◆ isUpperCase()

bool water::CharPointer_UTF8::isUpperCase ( ) const

inlinenoexcept

Returns true if the first character of this string is upper-case.

◆ isValidString()

bool water::CharPointer_UTF8::isValidString	(	const CharType *	dataToTest,
		int	maxBytesToRead )

inlinestatic

Returns true if this data contains a valid string in this encoding.

◆ isWhitespace()

bool water::CharPointer_UTF8::isWhitespace ( ) const

inlinenoexcept

Returns true if the first character of this string is whitespace.

◆ length()

size_t water::CharPointer_UTF8::length ( ) const

inlinenoexcept

Returns the number of characters in this string.

◆ lengthUpTo() [1/2]

size_t water::CharPointer_UTF8::lengthUpTo ( const CharPointer_UTF8 end ) const

inlinenoexcept

Returns the number of characters in this string, or up to the given end pointer, whichever is lower.

◆ lengthUpTo() [2/2]

size_t water::CharPointer_UTF8::lengthUpTo ( const size_t maxCharsToCount ) const

inlinenoexcept

Returns the number of characters in this string, or the given value, whichever is lower.

◆ operator const CharType *()

water::CharPointer_UTF8::operator const CharType * ( ) const

inlinenoexcept

Returns the address that this pointer is pointing to.

◆ operator!=()

bool water::CharPointer_UTF8::operator!= ( CharPointer_UTF8 other ) const

inlinenoexcept

◆ operator*()

water_uchar water::CharPointer_UTF8::operator* ( ) const

inlinenoexcept

Returns the unicode character that this pointer is pointing to.

◆ operator+()

CharPointer_UTF8 water::CharPointer_UTF8::operator+ ( int numToSkip ) const

inlinenoexcept

Returns a pointer which is moved forwards from this one by the specified number of characters.

◆ operator++() [1/2]

CharPointer_UTF8 & water::CharPointer_UTF8::operator++ ( )

inlinenoexcept

Moves this pointer along to the next character in the string.

◆ operator++() [2/2]

CharPointer_UTF8 water::CharPointer_UTF8::operator++ ( int )

inlinenoexcept

Moves this pointer along to the next character in the string.

◆ operator+=()

void water::CharPointer_UTF8::operator+= ( int numToSkip )

inlinenoexcept

Moves this pointer forwards by the specified number of characters.

◆ operator-()

CharPointer_UTF8 water::CharPointer_UTF8::operator- ( int numToSkip ) const

inlinenoexcept

Returns a pointer which is moved backwards from this one by the specified number of characters.

◆ operator--()

CharPointer_UTF8 & water::CharPointer_UTF8::operator-- ( )

inlinenoexcept

Moves this pointer back to the previous character in the string.

◆ operator-=()

void water::CharPointer_UTF8::operator-= ( int numToSkip )

inlinenoexcept

Moves this pointer backwards by the specified number of characters.

◆ operator<()

bool water::CharPointer_UTF8::operator< ( CharPointer_UTF8 other ) const

inlinenoexcept

◆ operator<=()

bool water::CharPointer_UTF8::operator<= ( CharPointer_UTF8 other ) const

inlinenoexcept

◆ operator=() [1/2]

CharPointer_UTF8 & water::CharPointer_UTF8::operator= ( CharPointer_UTF8 other )

inlinenoexcept

◆ operator=() [2/2]

CharPointer_UTF8 & water::CharPointer_UTF8::operator= ( const CharType * text )

inlinenoexcept

◆ operator==()

bool water::CharPointer_UTF8::operator== ( CharPointer_UTF8 other ) const

inlinenoexcept

This is a pointer comparison, it doesn't compare the actual text.

◆ operator>()

bool water::CharPointer_UTF8::operator> ( CharPointer_UTF8 other ) const

inlinenoexcept

◆ operator>=()

bool water::CharPointer_UTF8::operator>= ( CharPointer_UTF8 other ) const

inlinenoexcept

◆ operator[]()

water_uchar water::CharPointer_UTF8::operator[] ( int characterIndex ) const

inlinenoexcept

Returns the character at a given character index from the start of the string.

◆ sizeInBytes()

size_t water::CharPointer_UTF8::sizeInBytes ( ) const

inlinenoexcept

Returns the number of bytes that are used to represent this string. This includes the terminating null character.

◆ toLowerCase()

water_uchar water::CharPointer_UTF8::toLowerCase ( ) const

inlinenoexcept

Returns a lower-case version of the first character of this string.

◆ toUpperCase()

water_uchar water::CharPointer_UTF8::toUpperCase ( ) const

inlinenoexcept

Returns an upper-case version of the first character of this string.

◆ write()

void water::CharPointer_UTF8::write ( const water_uchar charToWrite )

inlinenoexcept

Writes a unicode character to this string, and advances this pointer to point to the next position.

◆ writeAll() [1/2]

template<typename CharPointer>

void water::CharPointer_UTF8::writeAll ( const CharPointer src )

inlinenoexcept

Copies a source string to this pointer, advancing this pointer as it goes.

◆ writeAll() [2/2]

void water::CharPointer_UTF8::writeAll ( const CharPointer_UTF8 src )

inlinenoexcept

Copies a source string to this pointer, advancing this pointer as it goes.

◆ writeNull()

void water::CharPointer_UTF8::writeNull ( ) const

inlinenoexcept

Writes a null character to this string (leaving the pointer's position unchanged).

◆ writeWithCharLimit()

template<typename CharPointer>

void water::CharPointer_UTF8::writeWithCharLimit	(	const CharPointer	src,
		const int	maxChars )

inlinenoexcept

Copies a source string to this pointer, advancing this pointer as it goes. The maxChars parameter specifies the maximum number of characters that can be written to the destination buffer before stopping (including the terminating null).

◆ writeWithDestByteLimit()

template<typename CharPointer>

size_t water::CharPointer_UTF8::writeWithDestByteLimit	(	const CharPointer	src,
		const size_t	maxDestBytes )

inlinenoexcept

Copies a source string to this pointer, advancing this pointer as it goes. The maxDestBytes parameter specifies the maximum number of bytes that can be written to the destination buffer before stopping.

◆ String

friend class String

friend

Member Data Documentation

◆ data

CharType* water::CharPointer_UTF8::data

private

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/text/CharPointer_UTF8.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ CharType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ CharPointer_UTF8() [1/2]

◆ CharPointer_UTF8() [2/2]

Member Function Documentation

◆ canRepresent()

◆ compare()

◆ compareIgnoreCase() [1/2]

◆ compareIgnoreCase() [2/2]

◆ compareIgnoreCaseUpTo()

◆ compareUpTo()

◆ findEndOfWhitespace()

◆ findTerminatingNull()

◆ getAddress()

◆ getAndAdvance()

◆ getBytesRequiredFor() [1/2]

◆ getBytesRequiredFor() [2/2]

◆ getDoubleValue()

◆ getIntValue32()

◆ getIntValue64()

◆ indexOf() [1/3]

◆ indexOf() [2/3]

◆ indexOf() [3/3]

◆ isByteOrderMark()

◆ isDigit()

◆ isEmpty()

◆ isLetter()

◆ isLetterOrDigit()

◆ isLowerCase()

◆ isUpperCase()

◆ isValidString()

◆ isWhitespace()

◆ length()

◆ lengthUpTo() [1/2]

◆ lengthUpTo() [2/2]

◆ operator const CharType *()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--()

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]()

◆ sizeInBytes()

◆ toLowerCase()

◆ toUpperCase()

◆ write()

◆ writeAll() [1/2]

◆ writeAll() [2/2]

◆ writeNull()

◆ writeWithCharLimit()

◆ writeWithDestByteLimit()

Friends And Related Symbol Documentation

◆ String

Member Data Documentation

◆ data