JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
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>

Collaboration diagram for juce::CharPointer_UTF32:

Public Types

using CharType = juce_wchar
 

Public Member Functions

 CharPointer_UTF32 (const CharPointer_UTF32 &other)=default
 
 CharPointer_UTF32 (const CharType *rawPointer) noexcept
 
CharPointer_UTF32 atomicSwap (CharPointer_UTF32 newValue)
 Atomically swaps this pointer for a new value, returning the previous value. More...
 
template<typename CharPointer >
int compare (CharPointer other) const noexcept
 Compares this string with another one. 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 compareUpTo (CharPointer other, int maxChars) const noexcept
 Compares this string with another one, up to a specified number of characters. More...
 
CharPointer_UTF32 findEndOfWhitespace () const noexcept
 Returns the first non-whitespace character in the string. More...
 
CharPointer_UTF32 findTerminatingNull () const noexcept
 Returns a pointer to the null character that terminates this string. More...
 
CharTypegetAddress () 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 (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 isDigit () const
 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
 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 isLowerCase () const
 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
 Returns true if the first character of this string is upper-case. More...
 
bool isWhitespace () const
 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 (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 lengthUpTo (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_UTF32 other) const noexcept
 
juce_wchar operator* () const noexcept
 Returns the unicode character that this pointer is pointing to. 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++ () noexcept
 Moves this pointer along to the next character in the string. 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...
 
CharPointer_UTF32 operator- (int numToSkip) const noexcept
 Returns a pointer which is moved backwards from this one by the specified number of characters. More...
 
CharPointer_UTF32 operator-- () noexcept
 Moves this pointer to the previous character in the string. More...
 
void operator-= (int numToSkip) noexcept
 
bool operator< (CharPointer_UTF32 other) const noexcept
 
bool operator<= (CharPointer_UTF32 other) const noexcept
 
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
 
juce_wcharoperator[] (int characterIndex) const noexcept
 Returns the character at a given character index from the start of the string. More...
 
void replaceChar (juce_wchar newChar) noexcept
 
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 (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 (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...
 
void writeNull () const noexcept
 Writes a null character to this string (leaving the pointer's position unchanged). 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 >
size_t writeWithDestByteLimit (CharPointer src, 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 (juce_wchar) noexcept
 Returns the number of bytes that would be needed to represent the given unicode character in this encoding format. More...
 
static bool isValidString (const CharType *dataToTest, int maxBytesToRead)
 Returns true if this data contains a valid string in this encoding. More...
 

Private Attributes

CharTypedata
 

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

@tags{Core}

Member Typedef Documentation

◆ CharType

Constructor & Destructor Documentation

◆ CharPointer_UTF32() [1/2]

juce::CharPointer_UTF32::CharPointer_UTF32 ( const CharType rawPointer)
inlineexplicitnoexcept

◆ CharPointer_UTF32() [2/2]

juce::CharPointer_UTF32::CharPointer_UTF32 ( const CharPointer_UTF32 other)
inlinedefault

Member Function Documentation

◆ atomicSwap()

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

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

References CharPointer_UTF32(), and data.

◆ canRepresent()

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

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

Referenced by isValidString().

◆ compare()

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

Compares this string with another one.

References juce::CharacterFunctions::compare().

◆ compareIgnoreCase()

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

Compares this string with another one.

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.

References juce::CharacterFunctions::compareIgnoreCaseUpTo().

◆ 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.

References juce::CharacterFunctions::compareUpTo().

◆ findEndOfWhitespace()

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

Returns the first non-whitespace character in the string.

References juce::CharacterFunctions::findEndOfWhitespace().

◆ findTerminatingNull()

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

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

References CharPointer_UTF32(), data, and length().

◆ getAddress()

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

Returns the address that this pointer is pointing to.

References data.

◆ 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.

References data.

◆ getBytesRequiredFor() [1/2]

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.

References juce::String::length(), and juce::UnitTestCategories::text.

◆ getBytesRequiredFor() [2/2]

static size_t juce::CharPointer_UTF32::getBytesRequiredFor ( juce_wchar  )
inlinestaticnoexcept

Returns the number of bytes that would be needed to represent the given unicode character in this encoding format.

◆ getDoubleValue()

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

Parses this string as a floating point double.

References juce::CharacterFunctions::getDoubleValue().

◆ getIntValue32()

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

Parses this string as a 32-bit integer.

◆ getIntValue64()

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

Parses this string as a 64-bit integer.

◆ incrementToEndOfWhitespace()

void juce::CharPointer_UTF32::incrementToEndOfWhitespace ( )
inlinenoexcept

Move this pointer to the first non-whitespace character in the string.

References juce::CharacterFunctions::incrementToEndOfWhitespace().

◆ 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.

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.

References data.

◆ 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.

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

◆ isDigit()

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

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

References data, and juce::CharacterFunctions::isDigit().

◆ isEmpty()

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

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

References data.

◆ isLetter()

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

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

References data, and 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.

References data, and juce::CharacterFunctions::isLetterOrDigit().

◆ isLowerCase()

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

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

References data, and juce::CharacterFunctions::isLowerCase().

◆ isNotEmpty()

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

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

References data.

◆ isUpperCase()

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

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

References data, and juce::CharacterFunctions::isUpperCase().

◆ 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.

References canRepresent(), and int().

◆ isWhitespace()

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

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

References data, and juce::CharacterFunctions::isWhitespace().

◆ length()

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

Returns the number of characters in this string.

References data, and juce::gl::n.

Referenced by findTerminatingNull(), and sizeInBytes().

◆ lengthUpTo() [1/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.

References juce::end(), and juce::CharacterFunctions::lengthUpTo().

◆ lengthUpTo() [2/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.

References juce::CharacterFunctions::lengthUpTo().

◆ operator const CharType *()

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

Returns the address that this pointer is pointing to.

References data.

◆ operator!=()

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

References data.

◆ operator*()

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

Returns the unicode character that this pointer is pointing to.

References data.

◆ 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.

References CharPointer_UTF32(), and data.

◆ operator++() [1/2]

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

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

References data.

◆ operator++() [2/2]

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

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

References data.

◆ operator+=()

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

Moves this pointer forwards by the specified number of characters.

References data.

◆ 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.

References CharPointer_UTF32(), and data.

◆ operator--()

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

Moves this pointer to the previous character in the string.

References data.

◆ operator-=()

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

References data.

◆ operator<()

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

References data.

◆ operator<=()

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

References data.

◆ operator=() [1/2]

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

References data.

◆ operator=() [2/2]

CharPointer_UTF32 juce::CharPointer_UTF32::operator= ( const CharType text)
inlinenoexcept

◆ operator==()

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

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

References data.

◆ operator>()

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

References data.

◆ operator>=()

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

References data.

◆ 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.

References data.

◆ replaceChar()

void juce::CharPointer_UTF32::replaceChar ( juce_wchar  newChar)
inlinenoexcept

References data.

◆ 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.

References length().

◆ toLowerCase()

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

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

References data, and juce::CharacterFunctions::toLowerCase().

◆ toUpperCase()

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

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

References data, and juce::CharacterFunctions::toUpperCase().

◆ 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.

References data.

◆ 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.

References juce::CharacterFunctions::copyAll(), and juce::gl::src.

◆ 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.

References data, juce::gl::s, and juce::gl::src.

◆ writeNull()

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

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

References data.

◆ 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).

References juce::CharacterFunctions::copyWithCharLimit(), and juce::gl::src.

◆ 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.

References juce::CharacterFunctions::copyWithDestByteLimit(), and juce::gl::src.

Member Data Documentation

◆ data


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