OpenShot Library | libopenshot-audio  0.2.0
juce::CharPointer_UTF32 Class Referencefinal

Wraps a pointer to a null-terminated UTF-32 character string, and provides various methods to operate on the data. More...

#include <juce_CharPointer_UTF32.h>

Public Types

using CharType = juce_wchar
 

Public Member Functions

 CharPointer_UTF32 (const CharType *rawPointer) noexcept
 
 CharPointer_UTF32 (const CharPointer_UTF32 &other)=default
 
CharPointer_UTF32 operator= (CharPointer_UTF32 other) noexcept
 
CharPointer_UTF32 operator= (const CharType *text) noexcept
 
bool operator== (CharPointer_UTF32 other) const noexcept
 This is a pointer comparison, it doesn't compare the actual text. More...
 
bool operator!= (CharPointer_UTF32 other) const noexcept
 
bool operator<= (CharPointer_UTF32 other) const noexcept
 
bool operator< (CharPointer_UTF32 other) const noexcept
 
bool operator>= (CharPointer_UTF32 other) const noexcept
 
bool operator> (CharPointer_UTF32 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_UTF32 operator++ () noexcept
 Moves this pointer along to the next character in the string. More...
 
CharPointer_UTF32 operator-- () noexcept
 Moves this pointer 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_UTF32 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
 
juce_wchar & operator[] (int characterIndex) const noexcept
 Returns the character at a given character index from the start of the string. More...
 
CharPointer_UTF32 operator+ (int numToSkip) const noexcept
 Returns a pointer which is moved forwards from this one by the specified number of characters. More...
 
CharPointer_UTF32 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 replaceChar (juce_wchar newChar) noexcept
 
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_UTF32 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_UTF32 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_UTF32 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
 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
 Returns true if the first character of this string is whitespace. More...
 
bool isDigit () const
 Returns true if the first character of this string is a digit. More...
 
bool isLetter () const
 Returns true if the first character of this string is a letter. More...
 
bool isLetterOrDigit () const
 Returns true if the first character of this string is a letter or digit. More...
 
bool isUpperCase () const
 Returns true if the first character of this string is upper-case. More...
 
bool isLowerCase () const
 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_UTF32 findEndOfWhitespace () const noexcept
 Returns the first non-whitespace character in the string. More...
 
CharPointer_UTF32 atomicSwap (CharPointer_UTF32 newValue)
 Atomically swaps this pointer for a new value, returning the previous value. More...
 

Static Public Member Functions

static size_t getBytesRequiredFor (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 (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...
 

Detailed Description

Wraps a pointer to a null-terminated UTF-32 character string, and provides various methods to operate on the data.

See also
CharPointer_UTF8, CharPointer_UTF16

Definition at line 38 of file juce_CharPointer_UTF32.h.

Member Function Documentation

◆ operator==()

bool juce::CharPointer_UTF32::operator== ( CharPointer_UTF32  other) const
inlinenoexcept

This is a pointer comparison, it doesn't compare the actual text.

Definition at line 63 of file juce_CharPointer_UTF32.h.

◆ getAddress()

CharType* juce::CharPointer_UTF32::getAddress ( ) const
inlinenoexcept

Returns the address that this pointer is pointing to.

Definition at line 71 of file juce_CharPointer_UTF32.h.

◆ operator const CharType *()

juce::CharPointer_UTF32::operator const CharType * ( ) const
inlinenoexcept

Returns the address that this pointer is pointing to.

Definition at line 74 of file juce_CharPointer_UTF32.h.

◆ isEmpty()

bool juce::CharPointer_UTF32::isEmpty ( ) const
inlinenoexcept

Returns true if this pointer is pointing to a null character.

Definition at line 77 of file juce_CharPointer_UTF32.h.

◆ isNotEmpty()

bool juce::CharPointer_UTF32::isNotEmpty ( ) const
inlinenoexcept

Returns true if this pointer is not pointing to a null character.

Definition at line 80 of file juce_CharPointer_UTF32.h.

◆ operator*()

juce_wchar juce::CharPointer_UTF32::operator* ( ) const
inlinenoexcept

Returns the unicode character that this pointer is pointing to.

Definition at line 83 of file juce_CharPointer_UTF32.h.

◆ operator++() [1/2]

CharPointer_UTF32 juce::CharPointer_UTF32::operator++ ( )
inlinenoexcept

Moves this pointer along to the next character in the string.

Definition at line 86 of file juce_CharPointer_UTF32.h.

◆ operator--()

CharPointer_UTF32 juce::CharPointer_UTF32::operator-- ( )
inlinenoexcept

Moves this pointer to the previous character in the string.

Definition at line 93 of file juce_CharPointer_UTF32.h.

◆ getAndAdvance()

juce_wchar juce::CharPointer_UTF32::getAndAdvance ( )
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 101 of file juce_CharPointer_UTF32.h.

◆ operator++() [2/2]

CharPointer_UTF32 juce::CharPointer_UTF32::operator++ ( int  )
inlinenoexcept

Moves this pointer along to the next character in the string.

Definition at line 104 of file juce_CharPointer_UTF32.h.

◆ operator+=()

void juce::CharPointer_UTF32::operator+= ( int  numToSkip)
inlinenoexcept

Moves this pointer forwards by the specified number of characters.

Definition at line 112 of file juce_CharPointer_UTF32.h.

◆ operator[]()

juce_wchar& juce::CharPointer_UTF32::operator[] ( int  characterIndex) const
inlinenoexcept

Returns the character at a given character index from the start of the string.

Definition at line 123 of file juce_CharPointer_UTF32.h.

◆ operator+()

CharPointer_UTF32 juce::CharPointer_UTF32::operator+ ( int  numToSkip) const
inlinenoexcept

Returns a pointer which is moved forwards from this one by the specified number of characters.

Definition at line 129 of file juce_CharPointer_UTF32.h.

◆ operator-()

CharPointer_UTF32 juce::CharPointer_UTF32::operator- ( int  numToSkip) const
inlinenoexcept

Returns a pointer which is moved backwards from this one by the specified number of characters.

Definition at line 135 of file juce_CharPointer_UTF32.h.

◆ write()

void juce::CharPointer_UTF32::write ( juce_wchar  charToWrite)
inlinenoexcept

Writes a unicode character to this string, and advances this pointer to point to the next position.

Definition at line 141 of file juce_CharPointer_UTF32.h.

◆ writeNull()

void juce::CharPointer_UTF32::writeNull ( ) const
inlinenoexcept

Writes a null character to this string (leaving the pointer's position unchanged).

Definition at line 152 of file juce_CharPointer_UTF32.h.

◆ length()

size_t juce::CharPointer_UTF32::length ( ) const
inlinenoexcept

Returns the number of characters in this string.

Definition at line 158 of file juce_CharPointer_UTF32.h.

Referenced by findTerminatingNull(), and sizeInBytes().

◆ lengthUpTo() [1/2]

size_t juce::CharPointer_UTF32::lengthUpTo ( size_t  maxCharsToCount) const
inlinenoexcept

Returns the number of characters in this string, or the given value, whichever is lower.

Definition at line 171 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::lengthUpTo().

◆ lengthUpTo() [2/2]

size_t juce::CharPointer_UTF32::lengthUpTo ( CharPointer_UTF32  end) const
inlinenoexcept

Returns the number of characters in this string, or up to the given end pointer, whichever is lower.

Definition at line 177 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::lengthUpTo().

◆ sizeInBytes()

size_t juce::CharPointer_UTF32::sizeInBytes ( ) const
inlinenoexcept

Returns the number of bytes that are used to represent this string.

This includes the terminating null character.

Definition at line 185 of file juce_CharPointer_UTF32.h.

References length().

◆ getBytesRequiredFor()

template<class CharPointer >
static size_t juce::CharPointer_UTF32::getBytesRequiredFor ( CharPointer  text)
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 203 of file juce_CharPointer_UTF32.h.

◆ findTerminatingNull()

CharPointer_UTF32 juce::CharPointer_UTF32::findTerminatingNull ( ) const
inlinenoexcept

Returns a pointer to the null character that terminates this string.

Definition at line 209 of file juce_CharPointer_UTF32.h.

References length().

◆ writeAll() [1/2]

template<typename CharPointer >
void juce::CharPointer_UTF32::writeAll ( CharPointer  src)
inlinenoexcept

Copies a source string to this pointer, advancing this pointer as it goes.

Definition at line 216 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::copyAll().

◆ writeAll() [2/2]

void juce::CharPointer_UTF32::writeAll ( CharPointer_UTF32  src)
inlinenoexcept

Copies a source string to this pointer, advancing this pointer as it goes.

Definition at line 222 of file juce_CharPointer_UTF32.h.

◆ writeWithDestByteLimit()

template<typename CharPointer >
size_t juce::CharPointer_UTF32::writeWithDestByteLimit ( CharPointer  src,
size_t  maxDestBytes 
)
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 238 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::copyWithDestByteLimit().

◆ writeWithCharLimit()

template<typename CharPointer >
void juce::CharPointer_UTF32::writeWithCharLimit ( CharPointer  src,
int  maxChars 
)
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 248 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::copyWithCharLimit().

◆ compare()

template<typename CharPointer >
int juce::CharPointer_UTF32::compare ( CharPointer  other) const
inlinenoexcept

Compares this string with another one.

Definition at line 255 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::compare().

◆ compareUpTo()

template<typename CharPointer >
int juce::CharPointer_UTF32::compareUpTo ( CharPointer  other,
int  maxChars 
) const
inlinenoexcept

Compares this string with another one, up to a specified number of characters.

Definition at line 270 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::compareUpTo().

◆ compareIgnoreCase()

template<typename CharPointer >
int juce::CharPointer_UTF32::compareIgnoreCase ( CharPointer  other) const
inline

Compares this string with another one.

Definition at line 277 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::compareIgnoreCase().

◆ compareIgnoreCaseUpTo()

template<typename CharPointer >
int juce::CharPointer_UTF32::compareIgnoreCaseUpTo ( CharPointer  other,
int  maxChars 
) const
inlinenoexcept

Compares this string with another one, up to a specified number of characters.

Definition at line 284 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::compareIgnoreCaseUpTo().

◆ indexOf() [1/3]

template<typename CharPointer >
int juce::CharPointer_UTF32::indexOf ( CharPointer  stringToFind) const
inlinenoexcept

Returns the character index of a substring, or -1 if it isn't found.

Definition at line 291 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::indexOf().

◆ indexOf() [2/3]

int juce::CharPointer_UTF32::indexOf ( juce_wchar  charToFind) const
inlinenoexcept

Returns the character index of a unicode character, or -1 if it isn't found.

Definition at line 297 of file juce_CharPointer_UTF32.h.

◆ indexOf() [3/3]

int juce::CharPointer_UTF32::indexOf ( juce_wchar  charToFind,
bool  ignoreCase 
) const
inlinenoexcept

Returns the character index of a unicode character, or -1 if it isn't found.

Definition at line 313 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::indexOfChar(), and juce::CharacterFunctions::indexOfCharIgnoreCase().

◆ isWhitespace()

bool juce::CharPointer_UTF32::isWhitespace ( ) const
inline

Returns true if the first character of this string is whitespace.

Definition at line 320 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::isWhitespace().

◆ isDigit()

bool juce::CharPointer_UTF32::isDigit ( ) const
inline

Returns true if the first character of this string is a digit.

Definition at line 322 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::isDigit().

◆ isLetter()

bool juce::CharPointer_UTF32::isLetter ( ) const
inline

Returns true if the first character of this string is a letter.

Definition at line 324 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::isLetter().

◆ isLetterOrDigit()

bool juce::CharPointer_UTF32::isLetterOrDigit ( ) const
inline

Returns true if the first character of this string is a letter or digit.

Definition at line 326 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::isLetterOrDigit().

◆ isUpperCase()

bool juce::CharPointer_UTF32::isUpperCase ( ) const
inline

Returns true if the first character of this string is upper-case.

Definition at line 328 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::isUpperCase().

◆ isLowerCase()

bool juce::CharPointer_UTF32::isLowerCase ( ) const
inline

Returns true if the first character of this string is lower-case.

Definition at line 330 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::isLowerCase().

◆ toUpperCase()

juce_wchar juce::CharPointer_UTF32::toUpperCase ( ) const
inlinenoexcept

Returns an upper-case version of the first character of this string.

Definition at line 333 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::toUpperCase().

◆ toLowerCase()

juce_wchar juce::CharPointer_UTF32::toLowerCase ( ) const
inlinenoexcept

Returns a lower-case version of the first character of this string.

Definition at line 335 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::toLowerCase().

◆ getIntValue32()

int juce::CharPointer_UTF32::getIntValue32 ( ) const
inlinenoexcept

Parses this string as a 32-bit integer.

Definition at line 338 of file juce_CharPointer_UTF32.h.

◆ getIntValue64()

int64 juce::CharPointer_UTF32::getIntValue64 ( ) const
inlinenoexcept

Parses this string as a 64-bit integer.

Definition at line 340 of file juce_CharPointer_UTF32.h.

◆ getDoubleValue()

double juce::CharPointer_UTF32::getDoubleValue ( ) const
inlinenoexcept

Parses this string as a floating point double.

Definition at line 343 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::getDoubleValue().

◆ findEndOfWhitespace()

CharPointer_UTF32 juce::CharPointer_UTF32::findEndOfWhitespace ( ) const
inlinenoexcept

Returns the first non-whitespace character in the string.

Definition at line 346 of file juce_CharPointer_UTF32.h.

References juce::CharacterFunctions::findEndOfWhitespace().

◆ canRepresent()

static bool juce::CharPointer_UTF32::canRepresent ( juce_wchar  character)
inlinestaticnoexcept

Returns true if the given unicode character can be represented in this encoding.

Definition at line 349 of file juce_CharPointer_UTF32.h.

Referenced by isValidString().

◆ isValidString()

static bool juce::CharPointer_UTF32::isValidString ( const CharType *  dataToTest,
int  maxBytesToRead 
)
inlinestatic

Returns true if this data contains a valid string in this encoding.

Definition at line 355 of file juce_CharPointer_UTF32.h.

References canRepresent().

◆ atomicSwap()

CharPointer_UTF32 juce::CharPointer_UTF32::atomicSwap ( CharPointer_UTF32  newValue)
inline

Atomically swaps this pointer for a new value, returning the previous value.

Definition at line 367 of file juce_CharPointer_UTF32.h.


The documentation for this class was generated from the following file: