|
JUCE
|
|
JUCE
|
Wraps a pointer to a null-terminated UTF-8 character string, and provides various methods to operate on the data. More...
Public Types | |
| enum | { byteOrderMark1 = 0xef, byteOrderMark2 = 0xbb, byteOrderMark3 = 0xbf } |
| These values are the byte-order-mark (BOM) values for a UTF-8 stream. More... | |
| typedef char | CharType |
Public Member Functions | |
| CharPointer_UTF8 (const CharType *const rawPointer) noexcept | |
| CharPointer_UTF8 (const CharPointer_UTF8 &other) noexcept | |
| CharPointer_UTF8 & | operator= (const CharPointer_UTF8 &other) noexcept |
| CharPointer_UTF8 & | operator= (const CharType *text) noexcept |
| bool | operator== (const CharPointer_UTF8 &other) const noexcept |
| This is a pointer comparison, it doesn't compare the actual text. | |
| bool | operator!= (const CharPointer_UTF8 &other) const noexcept |
| bool | operator<= (const CharPointer_UTF8 &other) const noexcept |
| bool | operator< (const CharPointer_UTF8 &other) const noexcept |
| bool | operator>= (const CharPointer_UTF8 &other) const noexcept |
| bool | operator> (const CharPointer_UTF8 &other) const noexcept |
| CharType * | getAddress () const noexcept |
| Returns the address that this pointer is pointing to. | |
| operator const CharType * () const noexcept | |
| Returns the address that this pointer is pointing to. | |
| bool | isEmpty () const noexcept |
| Returns true if this pointer is pointing to a null character. | |
| juce_wchar | operator* () const noexcept |
| Returns the unicode character that this pointer is pointing to. | |
| CharPointer_UTF8 & | operator++ () noexcept |
| Moves this pointer along to the next character in the string. | |
| CharPointer_UTF8 & | operator-- () noexcept |
| Moves this pointer back to the previous character in the string. | |
| juce_wchar | getAndAdvance () noexcept |
| Returns the character that this pointer is currently pointing to, and then advances the pointer to point to the next character. | |
| CharPointer_UTF8 | operator++ (int) noexcept |
| Moves this pointer along to the next character in the string. | |
| void | operator+= (int numToSkip) noexcept |
| Moves this pointer forwards by the specified number of characters. | |
| void | operator-= (int numToSkip) noexcept |
| Moves this pointer backwards by the specified number of characters. | |
| juce_wchar | operator[] (int characterIndex) const noexcept |
| Returns the character at a given character index from the start of the string. | |
| CharPointer_UTF8 | operator+ (int numToSkip) const noexcept |
| Returns a pointer which is moved forwards from this one by the specified number of characters. | |
| CharPointer_UTF8 | operator- (int numToSkip) const noexcept |
| Returns a pointer which is moved backwards from this one by the specified number of characters. | |
| size_t | length () const noexcept |
| Returns the number of characters in this string. | |
| size_t | lengthUpTo (const size_t maxCharsToCount) const noexcept |
| Returns the number of characters in this string, or the given value, whichever is lower. | |
| size_t | lengthUpTo (const CharPointer_UTF8 &end) const noexcept |
| Returns the number of characters in this string, or up to the given end pointer, whichever is lower. | |
| size_t | sizeInBytes () const noexcept |
| Returns the number of bytes that are used to represent this string. | |
| CharPointer_UTF8 | findTerminatingNull () const noexcept |
| Returns a pointer to the null character that terminates this string. | |
| void | write (const juce_wchar charToWrite) noexcept |
| Writes a unicode character to this string, and advances this pointer to point to the next position. | |
| void | writeNull () const noexcept |
| Writes a null character to this string (leaving the pointer's position unchanged). | |
| template<typename CharPointer > | |
| void | writeAll (const CharPointer &src) noexcept |
| Copies a source string to this pointer, advancing this pointer as it goes. | |
| void | writeAll (const CharPointer_UTF8 &src) noexcept |
| Copies a source string to this pointer, advancing this pointer as it goes. | |
| template<typename CharPointer > | |
| int | writeWithDestByteLimit (const CharPointer &src, const int maxDestBytes) noexcept |
| Copies a source string to this pointer, advancing this pointer as it goes. | |
| template<typename CharPointer > | |
| void | writeWithCharLimit (const CharPointer &src, const int maxChars) noexcept |
| Copies a source string to this pointer, advancing this pointer as it goes. | |
| template<typename CharPointer > | |
| int | compare (const CharPointer &other) const noexcept |
| Compares this string with another one. | |
| template<typename CharPointer > | |
| int | compareUpTo (const CharPointer &other, const int maxChars) const noexcept |
| Compares this string with another one, up to a specified number of characters. | |
| template<typename CharPointer > | |
| int | compareIgnoreCase (const CharPointer &other) const noexcept |
| Compares this string with another one. | |
| int | compareIgnoreCase (const CharPointer_UTF8 &other) const noexcept |
| Compares this string with another one. | |
| template<typename CharPointer > | |
| int | compareIgnoreCaseUpTo (const CharPointer &other, const int maxChars) const noexcept |
| Compares this string with another one, up to a specified number of characters. | |
| template<typename CharPointer > | |
| int | indexOf (const CharPointer &stringToFind) const noexcept |
| Returns the character index of a substring, or -1 if it isn't found. | |
| int | indexOf (const juce_wchar charToFind) const noexcept |
| Returns the character index of a unicode character, or -1 if it isn't found. | |
| int | indexOf (const juce_wchar charToFind, const bool ignoreCase) const noexcept |
| Returns the character index of a unicode character, or -1 if it isn't found. | |
| bool | isWhitespace () const noexcept |
| Returns true if the first character of this string is whitespace. | |
| bool | isDigit () const noexcept |
| Returns true if the first character of this string is a digit. | |
| bool | isLetter () const noexcept |
| Returns true if the first character of this string is a letter. | |
| bool | isLetterOrDigit () const noexcept |
| Returns true if the first character of this string is a letter or digit. | |
| bool | isUpperCase () const noexcept |
| Returns true if the first character of this string is upper-case. | |
| bool | isLowerCase () const noexcept |
| Returns true if the first character of this string is lower-case. | |
| juce_wchar | toUpperCase () const noexcept |
| Returns an upper-case version of the first character of this string. | |
| juce_wchar | toLowerCase () const noexcept |
| Returns a lower-case version of the first character of this string. | |
| int | getIntValue32 () const noexcept |
| Parses this string as a 32-bit integer. | |
| int64 | getIntValue64 () const noexcept |
| Parses this string as a 64-bit integer. | |
| double | getDoubleValue () const noexcept |
| Parses this string as a floating point double. | |
| CharPointer_UTF8 | findEndOfWhitespace () const noexcept |
| Returns the first non-whitespace character in the string. | |
| CharPointer_UTF8 | atomicSwap (const CharPointer_UTF8 &newValue) |
| Atomically swaps this pointer for a new value, returning the previous value. | |
Static Public Member Functions | |
| static size_t | getBytesRequiredFor (const juce_wchar charToWrite) noexcept |
| Returns the number of bytes that would be needed to represent the given unicode character in this encoding format. | |
| template<class CharPointer > | |
| static size_t | getBytesRequiredFor (CharPointer text) noexcept |
| Returns the number of bytes that would be needed to represent the given string in this encoding format. | |
| static bool | canRepresent (juce_wchar character) noexcept |
| Returns true if the given unicode character can be represented in this encoding. | |
| static bool | isValidString (const CharType *dataToTest, int maxBytesToRead) |
| Returns true if this data contains a valid string in this encoding. | |
Wraps a pointer to a null-terminated UTF-8 character string, and provides various methods to operate on the data.
| typedef char CharPointer_UTF8::CharType |
| anonymous enum |
| CharPointer_UTF8::CharPointer_UTF8 | ( | const CharType *const | rawPointer | ) | [explicit] |
Referenced by atomicSwap(), and findTerminatingNull().
| CharPointer_UTF8::CharPointer_UTF8 | ( | const CharPointer_UTF8 & | other | ) |
| CharPointer_UTF8& CharPointer_UTF8::operator= | ( | const CharPointer_UTF8 & | other | ) |
| CharPointer_UTF8& CharPointer_UTF8::operator= | ( | const CharType * | text | ) |
| bool CharPointer_UTF8::operator== | ( | const CharPointer_UTF8 & | other | ) | const |
This is a pointer comparison, it doesn't compare the actual text.
| bool CharPointer_UTF8::operator!= | ( | const CharPointer_UTF8 & | other | ) | const |
| bool CharPointer_UTF8::operator<= | ( | const CharPointer_UTF8 & | other | ) | const |
| bool CharPointer_UTF8::operator< | ( | const CharPointer_UTF8 & | other | ) | const |
| bool CharPointer_UTF8::operator>= | ( | const CharPointer_UTF8 & | other | ) | const |
| bool CharPointer_UTF8::operator> | ( | const CharPointer_UTF8 & | other | ) | const |
| CharType* CharPointer_UTF8::getAddress | ( | ) | const |
Returns the address that this pointer is pointing to.
Referenced by operator<<().
| CharPointer_UTF8::operator const CharType * | ( | ) | const |
Returns the address that this pointer is pointing to.
| bool CharPointer_UTF8::isEmpty | ( | ) | const |
Returns true if this pointer is pointing to a null character.
| juce_wchar CharPointer_UTF8::operator* | ( | ) | const |
Returns the unicode character that this pointer is pointing to.
| CharPointer_UTF8& CharPointer_UTF8::operator++ | ( | ) |
Moves this pointer along to the next character in the string.
| CharPointer_UTF8& CharPointer_UTF8::operator-- | ( | ) |
Moves this pointer back to the previous character in the string.
Returns the character that this pointer is currently pointing to, and then advances the pointer to point to the next character.
| CharPointer_UTF8 CharPointer_UTF8::operator++ | ( | int | ) |
Moves this pointer along to the next character in the string.
| void CharPointer_UTF8::operator+= | ( | int | numToSkip | ) |
Moves this pointer forwards by the specified number of characters.
Referenced by operator-=().
| void CharPointer_UTF8::operator-= | ( | int | numToSkip | ) |
Moves this pointer backwards by the specified number of characters.
References operator+=().
| juce_wchar CharPointer_UTF8::operator[] | ( | int | characterIndex | ) | const |
Returns the character at a given character index from the start of the string.
| CharPointer_UTF8 CharPointer_UTF8::operator+ | ( | int | numToSkip | ) | const |
Returns a pointer which is moved forwards from this one by the specified number of characters.
| CharPointer_UTF8 CharPointer_UTF8::operator- | ( | int | numToSkip | ) | const |
Returns a pointer which is moved backwards from this one by the specified number of characters.
| size_t CharPointer_UTF8::length | ( | ) | const |
Returns the number of characters in this string.
| size_t CharPointer_UTF8::lengthUpTo | ( | const size_t | maxCharsToCount | ) | const |
Returns the number of characters in this string, or the given value, whichever is lower.
Referenced by lengthUpTo().
| size_t CharPointer_UTF8::lengthUpTo | ( | const CharPointer_UTF8 & | end | ) | const |
Returns the number of characters in this string, or up to the given end pointer, whichever is lower.
References lengthUpTo().
| size_t CharPointer_UTF8::sizeInBytes | ( | ) | const |
Returns the number of bytes that are used to represent this string.
This includes the terminating null character.
References jassert.
| static size_t CharPointer_UTF8::getBytesRequiredFor | ( | const juce_wchar | charToWrite | ) | [static] |
Returns the number of bytes that would be needed to represent the given unicode character in this encoding format.
Referenced by getBytesRequiredFor().
| static size_t CharPointer_UTF8::getBytesRequiredFor | ( | CharPointer | text | ) | [static] |
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.
References getBytesRequiredFor().
Returns a pointer to the null character that terminates this string.
References CharPointer_UTF8().
| void CharPointer_UTF8::write | ( | const juce_wchar | charToWrite | ) |
Writes a unicode character to this string, and advances this pointer to point to the next position.
| void CharPointer_UTF8::writeNull | ( | ) | const |
Writes a null character to this string (leaving the pointer's position unchanged).
| void CharPointer_UTF8::writeAll | ( | const CharPointer & | src | ) |
Copies a source string to this pointer, advancing this pointer as it goes.
References CharacterFunctions::copyAll().
| void CharPointer_UTF8::writeAll | ( | const CharPointer_UTF8 & | src | ) |
Copies a source string to this pointer, advancing this pointer as it goes.
| int CharPointer_UTF8::writeWithDestByteLimit | ( | const CharPointer & | src, |
| const int | maxDestBytes | ||
| ) |
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.
References CharacterFunctions::copyWithDestByteLimit().
| void CharPointer_UTF8::writeWithCharLimit | ( | const CharPointer & | src, |
| const int | maxChars | ||
| ) |
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).
References CharacterFunctions::copyWithCharLimit().
| int CharPointer_UTF8::compare | ( | const CharPointer & | other | ) | const |
Compares this string with another one.
| int CharPointer_UTF8::compareUpTo | ( | const CharPointer & | other, |
| const int | maxChars | ||
| ) | const |
Compares this string with another one, up to a specified number of characters.
| int CharPointer_UTF8::compareIgnoreCase | ( | const CharPointer & | other | ) | const |
Compares this string with another one.
| int CharPointer_UTF8::compareIgnoreCase | ( | const CharPointer_UTF8 & | other | ) | const |
Compares this string with another one.
| int CharPointer_UTF8::compareIgnoreCaseUpTo | ( | const CharPointer & | other, |
| const int | maxChars | ||
| ) | const |
Compares this string with another one, up to a specified number of characters.
| int CharPointer_UTF8::indexOf | ( | const CharPointer & | stringToFind | ) | const |
Returns the character index of a substring, or -1 if it isn't found.
| int CharPointer_UTF8::indexOf | ( | const juce_wchar | charToFind | ) | const |
Returns the character index of a unicode character, or -1 if it isn't found.
References CharacterFunctions::indexOfChar().
| int CharPointer_UTF8::indexOf | ( | const juce_wchar | charToFind, |
| const bool | ignoreCase | ||
| ) | const |
Returns the character index of a unicode character, or -1 if it isn't found.
References CharacterFunctions::indexOfChar(), and CharacterFunctions::indexOfCharIgnoreCase().
| bool CharPointer_UTF8::isWhitespace | ( | ) | const |
Returns true if the first character of this string is whitespace.
| bool CharPointer_UTF8::isDigit | ( | ) | const |
Returns true if the first character of this string is a digit.
| bool CharPointer_UTF8::isLetter | ( | ) | const |
Returns true if the first character of this string is a letter.
| bool CharPointer_UTF8::isLetterOrDigit | ( | ) | const |
Returns true if the first character of this string is a letter or digit.
| bool CharPointer_UTF8::isUpperCase | ( | ) | const |
Returns true if the first character of this string is upper-case.
| bool CharPointer_UTF8::isLowerCase | ( | ) | const |
Returns true if the first character of this string is lower-case.
| juce_wchar CharPointer_UTF8::toUpperCase | ( | ) | const |
Returns an upper-case version of the first character of this string.
| juce_wchar CharPointer_UTF8::toLowerCase | ( | ) | const |
Returns a lower-case version of the first character of this string.
| int CharPointer_UTF8::getIntValue32 | ( | ) | const |
Parses this string as a 32-bit integer.
| int64 CharPointer_UTF8::getIntValue64 | ( | ) | const |
Parses this string as a 64-bit integer.
| double CharPointer_UTF8::getDoubleValue | ( | ) | const |
Parses this string as a floating point double.
Returns the first non-whitespace character in the string.
| static bool CharPointer_UTF8::canRepresent | ( | juce_wchar | character | ) | [static] |
Returns true if the given unicode character can be represented in this encoding.
| static bool CharPointer_UTF8::isValidString | ( | const CharType * | dataToTest, |
| int | maxBytesToRead | ||
| ) | [static] |
Returns true if this data contains a valid string in this encoding.
| CharPointer_UTF8 CharPointer_UTF8::atomicSwap | ( | const CharPointer_UTF8 & | newValue | ) |
Atomically swaps this pointer for a new value, returning the previous value.
References CharPointer_UTF8().
