OpenShot Audio Library | OpenShotAudio 0.3.2
Loading...
Searching...
No Matches
juce::CharPointer_UTF32 Class Referencefinal

#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
 
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
 
 operator const CharType * () const noexcept
 
bool isEmpty () const noexcept
 
bool isNotEmpty () const noexcept
 
juce_wchar operator* () const noexcept
 
CharPointer_UTF32 operator++ () noexcept
 
CharPointer_UTF32 operator-- () noexcept
 
juce_wchar getAndAdvance () noexcept
 
CharPointer_UTF32 operator++ (int) noexcept
 
void operator+= (int numToSkip) noexcept
 
void operator-= (int numToSkip) noexcept
 
juce_wchar & operator[] (int characterIndex) const noexcept
 
CharPointer_UTF32 operator+ (int numToSkip) const noexcept
 
CharPointer_UTF32 operator- (int numToSkip) const noexcept
 
void write (juce_wchar charToWrite) noexcept
 
void replaceChar (juce_wchar newChar) noexcept
 
void writeNull () const noexcept
 
size_t length () const noexcept
 
size_t lengthUpTo (size_t maxCharsToCount) const noexcept
 
size_t lengthUpTo (CharPointer_UTF32 end) const noexcept
 
size_t sizeInBytes () const noexcept
 
CharPointer_UTF32 findTerminatingNull () const noexcept
 
template<typename CharPointer >
void writeAll (CharPointer src) noexcept
 
void writeAll (CharPointer_UTF32 src) noexcept
 
template<typename CharPointer >
size_t writeWithDestByteLimit (CharPointer src, size_t maxDestBytes) noexcept
 
template<typename CharPointer >
void writeWithCharLimit (CharPointer src, int maxChars) noexcept
 
template<typename CharPointer >
int compare (CharPointer other) const noexcept
 
template<typename CharPointer >
int compareUpTo (CharPointer other, int maxChars) const noexcept
 
template<typename CharPointer >
int compareIgnoreCase (CharPointer other) const
 
template<typename CharPointer >
int compareIgnoreCaseUpTo (CharPointer other, int maxChars) const noexcept
 
template<typename CharPointer >
int indexOf (CharPointer stringToFind) const noexcept
 
int indexOf (juce_wchar charToFind) const noexcept
 
int indexOf (juce_wchar charToFind, bool ignoreCase) const noexcept
 
bool isWhitespace () const
 
bool isDigit () const
 
bool isLetter () const
 
bool isLetterOrDigit () const
 
bool isUpperCase () const
 
bool isLowerCase () const
 
juce_wchar toUpperCase () const noexcept
 
juce_wchar toLowerCase () const noexcept
 
int getIntValue32 () const noexcept
 
int64 getIntValue64 () const noexcept
 
double getDoubleValue () const noexcept
 
CharPointer_UTF32 findEndOfWhitespace () const noexcept
 
CharPointer_UTF32 atomicSwap (CharPointer_UTF32 newValue)
 

Static Public Member Functions

static size_t getBytesRequiredFor (juce_wchar) noexcept
 
template<class CharPointer >
static size_t getBytesRequiredFor (CharPointer text) noexcept
 
static bool canRepresent (juce_wchar character) noexcept
 
static bool isValidString (const CharType *dataToTest, int maxBytesToRead)
 

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 34 of file juce_CharPointer_UTF32.h.

Member Typedef Documentation

◆ CharType

Definition at line 37 of file juce_CharPointer_UTF32.h.

Constructor & Destructor Documentation

◆ CharPointer_UTF32()

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

Definition at line 39 of file juce_CharPointer_UTF32.h.

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.

Definition at line 363 of file juce_CharPointer_UTF32.h.

◆ 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 345 of file juce_CharPointer_UTF32.h.

Referenced by isValidString().

◆ compare()

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

Compares this string with another one.

Definition at line 251 of file juce_CharPointer_UTF32.h.

◆ compareIgnoreCase()

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

Compares this string with another one.

Definition at line 273 of file juce_CharPointer_UTF32.h.

◆ 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 280 of file juce_CharPointer_UTF32.h.

◆ 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 266 of file juce_CharPointer_UTF32.h.

◆ findEndOfWhitespace()

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

Returns the first non-whitespace character in the string.

Definition at line 342 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 205 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 67 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 97 of file juce_CharPointer_UTF32.h.

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

Definition at line 199 of file juce_CharPointer_UTF32.h.

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

Definition at line 189 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 339 of file juce_CharPointer_UTF32.h.

◆ getIntValue32()

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

Parses this string as a 32-bit integer.

Definition at line 334 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 336 of file juce_CharPointer_UTF32.h.

◆ 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 287 of file juce_CharPointer_UTF32.h.

◆ 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 293 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 309 of file juce_CharPointer_UTF32.h.

◆ isDigit()

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

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

Definition at line 318 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 73 of file juce_CharPointer_UTF32.h.

◆ isLetter()

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

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

Definition at line 320 of file juce_CharPointer_UTF32.h.

◆ 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 322 of file juce_CharPointer_UTF32.h.

◆ isLowerCase()

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

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

Definition at line 326 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 76 of file juce_CharPointer_UTF32.h.

◆ isUpperCase()

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

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

Definition at line 324 of file juce_CharPointer_UTF32.h.

◆ 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 351 of file juce_CharPointer_UTF32.h.

◆ isWhitespace()

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

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

Definition at line 316 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 154 of file juce_CharPointer_UTF32.h.

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.

Definition at line 173 of file juce_CharPointer_UTF32.h.

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

Definition at line 167 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 70 of file juce_CharPointer_UTF32.h.

◆ operator!=()

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

Definition at line 60 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 79 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 125 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 82 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 100 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 108 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 131 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 89 of file juce_CharPointer_UTF32.h.

◆ operator-=()

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

Definition at line 113 of file juce_CharPointer_UTF32.h.

◆ operator<()

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

Definition at line 62 of file juce_CharPointer_UTF32.h.

◆ operator<=()

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

Definition at line 61 of file juce_CharPointer_UTF32.h.

◆ operator=() [1/2]

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

Definition at line 46 of file juce_CharPointer_UTF32.h.

◆ operator=() [2/2]

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

Definition at line 52 of file juce_CharPointer_UTF32.h.

◆ 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 59 of file juce_CharPointer_UTF32.h.

◆ operator>()

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

Definition at line 64 of file juce_CharPointer_UTF32.h.

◆ operator>=()

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

Definition at line 63 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 119 of file juce_CharPointer_UTF32.h.

◆ replaceChar()

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

Definition at line 142 of file juce_CharPointer_UTF32.h.

◆ 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 181 of file juce_CharPointer_UTF32.h.

◆ toLowerCase()

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

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

Definition at line 331 of file juce_CharPointer_UTF32.h.

◆ toUpperCase()

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

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

Definition at line 329 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 137 of file juce_CharPointer_UTF32.h.

◆ 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 212 of file juce_CharPointer_UTF32.h.

◆ 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 218 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 148 of file juce_CharPointer_UTF32.h.

◆ 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 244 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 234 of file juce_CharPointer_UTF32.h.


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