OpenShot Library | OpenShotAudio
0.2.2
|
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 CharType *rawPointer) noexcept | |
CharPointer_UTF8 (const CharPointer_UTF8 &other)=default | |
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 |
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 |
Returns the address that this pointer is pointing to. More... | |
operator const CharType * () const noexcept | |
Returns the address that this pointer is pointing to. More... | |
bool | isEmpty () const noexcept |
Returns true if this pointer is pointing to a null character. More... | |
bool | isNotEmpty () const noexcept |
Returns true if this pointer is not pointing to a null character. More... | |
juce_wchar | operator* () const noexcept |
Returns the unicode character that this pointer is pointing to. More... | |
CharPointer_UTF8 & | operator++ () noexcept |
Moves this pointer along to the next character in the string. More... | |
CharPointer_UTF8 | operator-- () noexcept |
Moves this pointer back to the previous character in the string. 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... | |
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... | |
void | operator-= (int numToSkip) noexcept |
Moves this pointer backwards by the specified number of characters. More... | |
juce_wchar | operator[] (int characterIndex) const noexcept |
Returns the character at a given character index from the start of the string. 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- (int numToSkip) const noexcept |
Returns a pointer which is moved backwards from this one by the specified number of characters. More... | |
size_t | length () const noexcept |
Returns the number of characters in this string. 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... | |
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 | sizeInBytes () const noexcept |
Returns the number of bytes that are used to represent this string. More... | |
CharPointer_UTF8 | findTerminatingNull () const noexcept |
Returns a pointer to the null character that terminates 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... | |
void | writeNull () const noexcept |
Writes a null character to this string (leaving the pointer's position unchanged). 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... | |
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... | |
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 > | |
int | compare (const CharPointer other) const noexcept |
Compares this string with another one. 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... | |
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 | 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 | isWhitespace () const noexcept |
Returns true if the first character of this string is whitespace. More... | |
bool | isDigit () const noexcept |
Returns true if the first character of this string is a digit. 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 | isUpperCase () const noexcept |
Returns true if the first character of this string is upper-case. More... | |
bool | isLowerCase () const noexcept |
Returns true if the first character of this string is lower-case. More... | |
juce_wchar | toUpperCase () const noexcept |
Returns an upper-case version of the first character of this string. More... | |
juce_wchar | toLowerCase () const noexcept |
Returns a lower-case version of the first character of this string. 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... | |
double | getDoubleValue () const noexcept |
Parses this string as a floating point double. More... | |
CharPointer_UTF8 | findEndOfWhitespace () const noexcept |
Returns the first non-whitespace character in the string. More... | |
CharPointer_UTF8 | atomicSwap (const CharPointer_UTF8 newValue) |
Atomically swaps this pointer for a new value, returning the previous value. More... | |
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. More... | |
static bool | canRepresent (juce_wchar character) noexcept |
Returns true if the given unicode character can be represented in this encoding. More... | |
static bool | isValidString (const CharType *dataToTest, int maxBytesToRead) |
Returns true if this data contains a valid string in this encoding. 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... | |
Wraps a pointer to a null-terminated UTF-8 character string, and provides various methods to operate on the data.
Definition at line 38 of file juce_CharPointer_UTF8.h.
anonymous enum |
These values are the byte-order mark (BOM) values for a UTF-8 stream.
Definition at line 544 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
This is a pointer comparison, it doesn't compare the actual text.
Definition at line 63 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Returns the address that this pointer is pointing to.
Definition at line 71 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::appendCharPointer(), juce::StringArray::appendNumbersToDuplicates(), juce::String::length(), juce::String::operator+=(), juce::String::paddedRight(), juce::String::replaceSection(), juce::MidiMessage::textMetaEvent(), and juce::String::toRawUTF8().
|
inlinenoexcept |
Returns the address that this pointer is pointing to.
Definition at line 74 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Returns true if this pointer is pointing to a null character.
Definition at line 77 of file juce_CharPointer_UTF8.h.
Referenced by juce::StringArray::addLines(), juce::String::compareIgnoreCase(), juce::Base64::convertFromBase64(), juce::XmlDocument::getLastParseError(), juce::StringPool::getPooledString(), and juce::String::paddedRight().
|
inlinenoexcept |
Returns true if this pointer is not pointing to a null character.
Definition at line 80 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Returns the unicode character that this pointer is pointing to.
Definition at line 83 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Moves this pointer along to the next character in the string.
Definition at line 119 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Moves this pointer back to the previous character in the string.
Definition at line 139 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Returns the character that this pointer is currently pointing to, and then advances the pointer to point to the next character.
Definition at line 151 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::compareIgnoreCase(), juce::File::createLegalFileName(), juce::Time::fromISO8601(), juce::File::getRelativePathFrom(), juce::MemoryBlock::loadFromHexString(), juce::String::removeCharacters(), juce::String::replaceCharacter(), juce::String::retainCharacters(), juce::LocalisedStrings::translate(), and juce::OutputStream::writeText().
|
inlinenoexcept |
Moves this pointer along to the next character in the string.
Definition at line 188 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Moves this pointer forwards by the specified number of characters.
Definition at line 196 of file juce_CharPointer_UTF8.h.
Referenced by operator-=().
|
inlinenoexcept |
Moves this pointer backwards by the specified number of characters.
Definition at line 211 of file juce_CharPointer_UTF8.h.
References operator+=().
|
inlinenoexcept |
Returns the character at a given character index from the start of the string.
Definition at line 217 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Returns a pointer which is moved forwards from this one by the specified number of characters.
Definition at line 225 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Returns a pointer which is moved backwards from this one by the specified number of characters.
Definition at line 233 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Returns the number of characters in this string.
Definition at line 241 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::length().
|
inlinenoexcept |
Returns the number of characters in this string, or the given value, whichever is lower.
Definition at line 265 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::lengthUpTo().
Referenced by juce::String::operator[]().
|
inlinenoexcept |
Returns the number of characters in this string, or up to the given end pointer, whichever is lower.
Definition at line 271 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::lengthUpTo().
|
inlinenoexcept |
Returns the number of bytes that are used to represent this string.
This includes the terminating null character.
Definition at line 279 of file juce_CharPointer_UTF8.h.
Referenced by juce::StringArray::joinIntoString(), and juce::MidiMessage::textMetaEvent().
|
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.
Definition at line 312 of file juce_CharPointer_UTF8.h.
References getBytesRequiredFor().
|
inlinenoexcept |
Returns a pointer to the null character that terminates this string.
Definition at line 323 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::appendCharPointer(), juce::String::endsWith(), juce::String::endsWithIgnoreCase(), juce::String::length(), and juce::String::trim().
|
inlinenoexcept |
Writes a unicode character to this string, and advances this pointer to point to the next position.
Definition at line 329 of file juce_CharPointer_UTF8.h.
Referenced by juce::MemoryOutputStream::appendUTF8Char(), juce::String::charToString(), juce::String::paddedLeft(), juce::MemoryBlock::toBase64Encoding(), and juce::String::toHexString().
|
inlinenoexcept |
Writes a null character to this string (leaving the pointer's position unchanged).
Definition at line 355 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::appendCharPointer(), juce::String::charToString(), and juce::String::replaceSection().
|
inlinenoexcept |
Copies a source string to this pointer, advancing this pointer as it goes.
Definition at line 362 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::copyAll().
Referenced by juce::String::operator+=(), juce::String::paddedRight(), and juce::String::repeatedString().
|
inlinenoexcept |
Copies a source string to this pointer, advancing this pointer as it goes.
Definition at line 368 of file juce_CharPointer_UTF8.h.
|
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.
Definition at line 384 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::copyWithDestByteLimit().
|
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).
Definition at line 394 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::copyWithCharLimit().
|
inlinenoexcept |
Compares this string with another one.
Definition at line 401 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::compare().
Referenced by juce::String::compare(), and juce::String::hash().
|
inlinenoexcept |
Compares this string with another one, up to a specified number of characters.
Definition at line 408 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::compareUpTo().
|
inlinenoexcept |
Compares this string with another one.
Definition at line 415 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::compareIgnoreCase().
Referenced by juce::String::compareIgnoreCase(), and juce::String::equalsIgnoreCase().
|
inlinenoexcept |
Compares this string with another one.
Definition at line 421 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::compareIgnoreCase().
|
inlinenoexcept |
Compares this string with another one, up to a specified number of characters.
Definition at line 428 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::compareIgnoreCaseUpTo().
|
inlinenoexcept |
Returns the character index of a substring, or -1 if it isn't found.
Definition at line 435 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::indexOf().
Referenced by juce::File::hasFileExtension(), juce::String::initialSectionContainingOnly(), juce::String::initialSectionNotContaining(), juce::String::removeCharacters(), juce::String::replaceCharacters(), juce::String::retainCharacters(), juce::String::trimCharactersAtEnd(), and juce::String::trimCharactersAtStart().
|
inlinenoexcept |
Returns the character index of a unicode character, or -1 if it isn't found.
Definition at line 441 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::indexOfChar().
|
inlinenoexcept |
Returns the character index of a unicode character, or -1 if it isn't found.
Definition at line 447 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::indexOfChar(), and juce::CharacterFunctions::indexOfCharIgnoreCase().
|
inlinenoexcept |
Returns true if the first character of this string is whitespace.
Definition at line 454 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::compareIgnoreCase().
|
inlinenoexcept |
Returns true if the first character of this string is a digit.
Definition at line 456 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::compareIgnoreCase().
|
inlinenoexcept |
Returns true if the first character of this string is a letter.
Definition at line 458 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::isLetter().
|
inlinenoexcept |
Returns true if the first character of this string is a letter or digit.
Definition at line 460 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::isLetterOrDigit().
|
inlinenoexcept |
Returns true if the first character of this string is upper-case.
Definition at line 462 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::isUpperCase().
|
inlinenoexcept |
Returns true if the first character of this string is lower-case.
Definition at line 464 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::isLowerCase().
|
inlinenoexcept |
Returns an upper-case version of the first character of this string.
Definition at line 467 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::toUpperCase().
Referenced by juce::String::toUpperCase().
|
inlinenoexcept |
Returns a lower-case version of the first character of this string.
Definition at line 469 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::toLowerCase().
Referenced by juce::String::toLowerCase().
|
inlinenoexcept |
Parses this string as a 32-bit integer.
Definition at line 472 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Parses this string as a 64-bit integer.
Definition at line 475 of file juce_CharPointer_UTF8.h.
|
inlinenoexcept |
Parses this string as a floating point double.
Definition at line 485 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::getDoubleValue().
|
inlinenoexcept |
Returns the first non-whitespace character in the string.
Definition at line 488 of file juce_CharPointer_UTF8.h.
References juce::CharacterFunctions::findEndOfWhitespace().
Referenced by juce::String::compareIgnoreCase(), and juce::BigInteger::parseString().
|
inlinestaticnoexcept |
Returns true if the given unicode character can be represented in this encoding.
Definition at line 491 of file juce_CharPointer_UTF8.h.
|
inlinestatic |
Returns true if this data contains a valid string in this encoding.
Definition at line 497 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::createStringFromData(), and juce::String::fromUTF8().
|
inline |
Atomically swaps this pointer for a new value, returning the previous value.
Definition at line 538 of file juce_CharPointer_UTF8.h.
|
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.
Definition at line 554 of file juce_CharPointer_UTF8.h.
Referenced by juce::String::createStringFromData(), and juce::XmlDocument::getDocumentElement().