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