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