OpenShot Library | OpenShotAudio
0.2.2
|
Wraps a pointer to a null-terminated UTF-16 character string, and provides various methods to operate on the data. More...
#include <juce_CharPointer_UTF16.h>
Public Types | |
enum | { byteOrderMarkBE1 = 0xfe, byteOrderMarkBE2 = 0xff, byteOrderMarkLE1 = 0xff, byteOrderMarkLE2 = 0xfe } |
These values are the byte-order-mark (BOM) values for a UTF-16 stream. More... | |
using | CharType = int16 |
Public Member Functions | |
CharPointer_UTF16 (const CharType *rawPointer) noexcept | |
CharPointer_UTF16 (const CharPointer_UTF16 &other)=default | |
CharPointer_UTF16 | operator= (CharPointer_UTF16 other) noexcept |
CharPointer_UTF16 | operator= (const CharType *text) noexcept |
bool | operator== (CharPointer_UTF16 other) const noexcept |
This is a pointer comparison, it doesn't compare the actual text. More... | |
bool | operator!= (CharPointer_UTF16 other) const noexcept |
bool | operator<= (CharPointer_UTF16 other) const noexcept |
bool | operator< (CharPointer_UTF16 other) const noexcept |
bool | operator>= (CharPointer_UTF16 other) const noexcept |
bool | operator> (CharPointer_UTF16 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_UTF16 | operator++ () noexcept |
Moves this pointer along to the next character in the string. More... | |
CharPointer_UTF16 | 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_UTF16 | 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_UTF16 | operator+ (int numToSkip) const noexcept |
Returns a pointer which is moved forwards from this one by the specified number of characters. More... | |
CharPointer_UTF16 | operator- (int numToSkip) const noexcept |
Returns a pointer which is moved backwards from this one by the specified number of characters. More... | |
void | write (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... | |
size_t | length () const noexcept |
Returns the number of characters in this string. More... | |
size_t | lengthUpTo (size_t maxCharsToCount) const noexcept |
Returns the number of characters in this string, or the given value, whichever is lower. More... | |
size_t | lengthUpTo (CharPointer_UTF16 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_UTF16 | findTerminatingNull () const noexcept |
Returns a pointer to the null character that terminates this string. More... | |
template<typename CharPointer > | |
void | writeAll (CharPointer src) noexcept |
Copies a source string to this pointer, advancing this pointer as it goes. More... | |
void | writeAll (CharPointer_UTF16 src) noexcept |
Copies a source string to this pointer, advancing this pointer as it goes. More... | |
template<typename CharPointer > | |
size_t | writeWithDestByteLimit (CharPointer src, size_t maxDestBytes) noexcept |
Copies a source string to this pointer, advancing this pointer as it goes. More... | |
template<typename CharPointer > | |
void | writeWithCharLimit (CharPointer src, int maxChars) noexcept |
Copies a source string to this pointer, advancing this pointer as it goes. More... | |
template<typename CharPointer > | |
int | compare (CharPointer other) const noexcept |
Compares this string with another one. More... | |
template<typename CharPointer > | |
int | compareUpTo (CharPointer other, int maxChars) const noexcept |
Compares this string with another one, up to a specified number of characters. More... | |
template<typename CharPointer > | |
int | compareIgnoreCase (CharPointer other) const noexcept |
Compares this string with another one. More... | |
template<typename CharPointer > | |
int | compareIgnoreCaseUpTo (CharPointer other, int maxChars) const noexcept |
Compares this string with another one, up to a specified number of characters. More... | |
template<typename CharPointer > | |
int | indexOf (CharPointer stringToFind) const noexcept |
Returns the character index of a substring, or -1 if it isn't found. More... | |
int | indexOf (juce_wchar charToFind) const noexcept |
Returns the character index of a unicode character, or -1 if it isn't found. More... | |
int | indexOf (juce_wchar charToFind, 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_UTF16 | findEndOfWhitespace () const noexcept |
Returns the first non-whitespace character in the string. More... | |
CharPointer_UTF16 | atomicSwap (CharPointer_UTF16 newValue) |
Atomically swaps this pointer for a new value, returning the previous value. More... | |
Static Public Member Functions | |
static size_t | getBytesRequiredFor (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 | isByteOrderMarkBigEndian (const void *possibleByteOrder) noexcept |
Returns true if the first pair of bytes in this pointer are the UTF16 byte-order mark (big endian). More... | |
static bool | isByteOrderMarkLittleEndian (const void *possibleByteOrder) noexcept |
Returns true if the first pair of bytes in this pointer are the UTF16 byte-order mark (little endian). More... | |
Wraps a pointer to a null-terminated UTF-16 character string, and provides various methods to operate on the data.
Definition at line 38 of file juce_CharPointer_UTF16.h.
anonymous enum |
These values are the byte-order-mark (BOM) values for a UTF-16 stream.
Definition at line 477 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
This is a pointer comparison, it doesn't compare the actual text.
Definition at line 67 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns the address that this pointer is pointing to.
Definition at line 75 of file juce_CharPointer_UTF16.h.
Referenced by compareIgnoreCaseUpTo().
|
inlinenoexcept |
Returns the address that this pointer is pointing to.
Definition at line 78 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns true if this pointer is pointing to a null character.
Definition at line 81 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns true if this pointer is not pointing to a null character.
Definition at line 84 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns the unicode character that this pointer is pointing to.
Definition at line 87 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Moves this pointer along to the next character in the string.
Definition at line 98 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Moves this pointer back to the previous character in the string.
Definition at line 109 of file juce_CharPointer_UTF16.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 121 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Moves this pointer along to the next character in the string.
Definition at line 132 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Moves this pointer forwards by the specified number of characters.
Definition at line 140 of file juce_CharPointer_UTF16.h.
Referenced by operator-=().
|
inlinenoexcept |
Moves this pointer backwards by the specified number of characters.
Definition at line 155 of file juce_CharPointer_UTF16.h.
References operator+=().
|
inlinenoexcept |
Returns the character at a given character index from the start of the string.
Definition at line 161 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns a pointer which is moved forwards from this one by the specified number of characters.
Definition at line 169 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns a pointer which is moved backwards from this one by the specified number of characters.
Definition at line 177 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Writes a unicode character to this string, and advances this pointer to point to the next position.
Definition at line 185 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Writes a null character to this string (leaving the pointer's position unchanged).
Definition at line 200 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns the number of characters in this string.
Definition at line 206 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Returns the number of characters in this string, or the given value, whichever is lower.
Definition at line 230 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::lengthUpTo().
|
inlinenoexcept |
Returns the number of characters in this string, or up to the given end pointer, whichever is lower.
Definition at line 236 of file juce_CharPointer_UTF16.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 244 of file juce_CharPointer_UTF16.h.
|
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 262 of file juce_CharPointer_UTF16.h.
References getBytesRequiredFor().
|
inlinenoexcept |
Returns a pointer to the null character that terminates this string.
Definition at line 274 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Copies a source string to this pointer, advancing this pointer as it goes.
Definition at line 286 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::copyAll().
|
inlinenoexcept |
Copies a source string to this pointer, advancing this pointer as it goes.
Definition at line 292 of file juce_CharPointer_UTF16.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 308 of file juce_CharPointer_UTF16.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 318 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::copyWithCharLimit().
|
inlinenoexcept |
Compares this string with another one.
Definition at line 325 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::compare().
|
inlinenoexcept |
Compares this string with another one, up to a specified number of characters.
Definition at line 332 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::compareUpTo().
|
inlinenoexcept |
Compares this string with another one.
Definition at line 339 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::compareIgnoreCase().
Referenced by compareIgnoreCaseUpTo().
|
inlinenoexcept |
Compares this string with another one, up to a specified number of characters.
Definition at line 346 of file juce_CharPointer_UTF16.h.
References compareIgnoreCase(), juce::CharacterFunctions::compareIgnoreCaseUpTo(), getAddress(), and indexOf().
|
inlinenoexcept |
Returns the character index of a substring, or -1 if it isn't found.
Definition at line 371 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::indexOf().
Referenced by compareIgnoreCaseUpTo().
|
inlinenoexcept |
Returns the character index of a unicode character, or -1 if it isn't found.
Definition at line 377 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::indexOfChar().
|
inlinenoexcept |
Returns the character index of a unicode character, or -1 if it isn't found.
Definition at line 383 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::indexOfChar(), and juce::CharacterFunctions::indexOfCharIgnoreCase().
|
inlinenoexcept |
Returns true if the first character of this string is whitespace.
Definition at line 390 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::isWhitespace().
|
inlinenoexcept |
Returns true if the first character of this string is a digit.
Definition at line 392 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::isDigit().
|
inlinenoexcept |
Returns true if the first character of this string is a letter.
Definition at line 394 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::isLetter().
|
inlinenoexcept |
Returns true if the first character of this string is a letter or digit.
Definition at line 396 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::isLetterOrDigit().
|
inlinenoexcept |
Returns true if the first character of this string is upper-case.
Definition at line 398 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::isUpperCase().
|
inlinenoexcept |
Returns true if the first character of this string is lower-case.
Definition at line 400 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::isLowerCase().
|
inlinenoexcept |
Returns an upper-case version of the first character of this string.
Definition at line 403 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::toUpperCase().
|
inlinenoexcept |
Returns a lower-case version of the first character of this string.
Definition at line 405 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::toLowerCase().
|
inlinenoexcept |
Parses this string as a 32-bit integer.
Definition at line 408 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Parses this string as a 64-bit integer.
Definition at line 418 of file juce_CharPointer_UTF16.h.
|
inlinenoexcept |
Parses this string as a floating point double.
Definition at line 428 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::getDoubleValue().
|
inlinenoexcept |
Returns the first non-whitespace character in the string.
Definition at line 431 of file juce_CharPointer_UTF16.h.
References juce::CharacterFunctions::findEndOfWhitespace().
|
inlinestaticnoexcept |
Returns true if the given unicode character can be represented in this encoding.
Definition at line 434 of file juce_CharPointer_UTF16.h.
Referenced by juce::TextDiff::Change::appliedTo(), juce::JSON::parseQuotedString(), juce::MemoryInputStream::skipNextBytes(), juce::StringRef::StringRef(), and juce::ValueTree::Listener::valueTreeRedirected().
|
inlinestatic |
Returns true if this data contains a valid string in this encoding.
Definition at line 441 of file juce_CharPointer_UTF16.h.
|
inline |
Atomically swaps this pointer for a new value, returning the previous value.
Definition at line 471 of file juce_CharPointer_UTF16.h.
|
inlinestaticnoexcept |
Returns true if the first pair of bytes in this pointer are the UTF16 byte-order mark (big endian).
The pointer must not be null, and must contain at least two valid bytes.
Definition at line 488 of file juce_CharPointer_UTF16.h.
Referenced by juce::String::createStringFromData(), and juce::XmlDocument::getDocumentElement().
|
inlinestaticnoexcept |
Returns true if the first pair of bytes in this pointer are the UTF16 byte-order mark (little endian).
The pointer must not be null, and must contain at least two valid bytes.
Definition at line 500 of file juce_CharPointer_UTF16.h.
Referenced by juce::String::createStringFromData(), and juce::XmlDocument::getDocumentElement().