OpenShot Library | OpenShotAudio  0.2.2
juce::CharPointer_ASCII Class Referencefinal

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

#include <juce_CharPointer_ASCII.h>

Public Types

using CharType = char
 

Public Member Functions

 CharPointer_ASCII (const CharType *rawPointer) noexcept
 
 CharPointer_ASCII (const CharPointer_ASCII &other)=default
 
CharPointer_ASCII operator= (const CharPointer_ASCII other) noexcept
 
CharPointer_ASCII operator= (const CharType *text) noexcept
 
bool operator== (CharPointer_ASCII other) const noexcept
 This is a pointer comparison, it doesn't compare the actual text. More...
 
bool operator!= (CharPointer_ASCII other) const noexcept
 
bool operator<= (CharPointer_ASCII other) const noexcept
 
bool operator< (CharPointer_ASCII other) const noexcept
 
bool operator>= (CharPointer_ASCII other) const noexcept
 
bool operator> (CharPointer_ASCII 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_ASCII operator++ () noexcept
 Moves this pointer along to the next character in the string. More...
 
CharPointer_ASCII 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_ASCII operator++ (int) noexcept
 Moves this pointer along to the next character in the string. More...
 
void operator+= (const int numToSkip) noexcept
 Moves this pointer forwards by the specified number of characters. More...
 
void operator-= (const int numToSkip) noexcept
 
juce_wchar operator[] (const int characterIndex) const noexcept
 Returns the character at a given character index from the start of the string. More...
 
CharPointer_ASCII operator+ (const int numToSkip) const noexcept
 Returns a pointer which is moved forwards from this one by the specified number of characters. More...
 
CharPointer_ASCII operator- (const int numToSkip) const noexcept
 Returns a pointer which is moved backwards from this one by the specified number of characters. 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 replaceChar (const 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 (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_ASCII 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_ASCII findTerminatingNull () const noexcept
 Returns a pointer to the null character that terminates this string. More...
 
template<typename CharPointer >
void writeAll (const CharPointer 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...
 
int compare (const CharPointer_ASCII 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...
 
int compareUpTo (const CharPointer_ASCII 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
 Compares this string with another one. More...
 
int compareIgnoreCase (const CharPointer_ASCII other) const
 
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
 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_ASCII findEndOfWhitespace () const noexcept
 Returns the first non-whitespace character in the string. More...
 

Static Public Member Functions

static size_t getBytesRequiredFor (const 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 (const 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 ASCII character string, and provides various methods to operate on the data.

A valid ASCII string is assumed to not contain any characters above 127.

See also
CharPointer_UTF8, CharPointer_UTF16, CharPointer_UTF32

Definition at line 41 of file juce_CharPointer_ASCII.h.

Member Function Documentation

◆ operator==()

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

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

Definition at line 66 of file juce_CharPointer_ASCII.h.

◆ getAddress()

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

Returns the address that this pointer is pointing to.

Definition at line 74 of file juce_CharPointer_ASCII.h.

Referenced by juce::String::appendCharPointer().

◆ operator const CharType *()

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

Returns the address that this pointer is pointing to.

Definition at line 77 of file juce_CharPointer_ASCII.h.

◆ isEmpty()

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

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

Definition at line 80 of file juce_CharPointer_ASCII.h.

Referenced by juce::String::isEmpty(), and juce::String::isNotEmpty().

◆ isNotEmpty()

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

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

Definition at line 83 of file juce_CharPointer_ASCII.h.

◆ operator*()

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

Returns the unicode character that this pointer is pointing to.

Definition at line 86 of file juce_CharPointer_ASCII.h.

◆ operator++() [1/2]

CharPointer_ASCII juce::CharPointer_ASCII::operator++ ( )
inlinenoexcept

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

Definition at line 89 of file juce_CharPointer_ASCII.h.

◆ operator--()

CharPointer_ASCII juce::CharPointer_ASCII::operator-- ( )
inlinenoexcept

Moves this pointer to the previous character in the string.

Definition at line 96 of file juce_CharPointer_ASCII.h.

◆ getAndAdvance()

juce_wchar juce::CharPointer_ASCII::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 104 of file juce_CharPointer_ASCII.h.

◆ operator++() [2/2]

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

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

Definition at line 107 of file juce_CharPointer_ASCII.h.

◆ operator+=()

void juce::CharPointer_ASCII::operator+= ( const int  numToSkip)
inlinenoexcept

Moves this pointer forwards by the specified number of characters.

Definition at line 115 of file juce_CharPointer_ASCII.h.

◆ operator[]()

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

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

Definition at line 126 of file juce_CharPointer_ASCII.h.

◆ operator+()

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

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

Definition at line 132 of file juce_CharPointer_ASCII.h.

◆ operator-()

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

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

Definition at line 138 of file juce_CharPointer_ASCII.h.

◆ write()

void juce::CharPointer_ASCII::write ( const juce_wchar  charToWrite)
inlinenoexcept

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

Definition at line 144 of file juce_CharPointer_ASCII.h.

◆ writeNull()

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

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

Definition at line 155 of file juce_CharPointer_ASCII.h.

◆ length()

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

Returns the number of characters in this string.

Definition at line 161 of file juce_CharPointer_ASCII.h.

Referenced by findTerminatingNull(), and sizeInBytes().

◆ lengthUpTo() [1/2]

size_t juce::CharPointer_ASCII::lengthUpTo ( const 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_ASCII.h.

References juce::CharacterFunctions::lengthUpTo().

◆ lengthUpTo() [2/2]

size_t juce::CharPointer_ASCII::lengthUpTo ( const CharPointer_ASCII  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_ASCII.h.

References juce::CharacterFunctions::lengthUpTo().

◆ sizeInBytes()

size_t juce::CharPointer_ASCII::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_ASCII.h.

References length().

◆ getBytesRequiredFor()

template<class CharPointer >
static size_t juce::CharPointer_ASCII::getBytesRequiredFor ( const 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_ASCII.h.

◆ findTerminatingNull()

CharPointer_ASCII juce::CharPointer_ASCII::findTerminatingNull ( ) const
inlinenoexcept

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

Definition at line 205 of file juce_CharPointer_ASCII.h.

References length().

◆ writeAll()

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

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

Definition at line 212 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::copyAll().

◆ writeWithDestByteLimit()

template<typename CharPointer >
size_t juce::CharPointer_ASCII::writeWithDestByteLimit ( const CharPointer  src,
const 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 222 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::copyWithDestByteLimit().

◆ writeWithCharLimit()

template<typename CharPointer >
void juce::CharPointer_ASCII::writeWithCharLimit ( const CharPointer  src,
const 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 232 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::copyWithCharLimit().

◆ compare() [1/2]

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

Compares this string with another one.

Definition at line 239 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::compare().

◆ compare() [2/2]

int juce::CharPointer_ASCII::compare ( const CharPointer_ASCII  other) const
inlinenoexcept

Compares this string with another one.

Definition at line 245 of file juce_CharPointer_ASCII.h.

◆ compareUpTo() [1/2]

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

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

Definition at line 252 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::compareUpTo().

◆ compareUpTo() [2/2]

int juce::CharPointer_ASCII::compareUpTo ( const CharPointer_ASCII  other,
const int  maxChars 
) const
inlinenoexcept

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

Definition at line 258 of file juce_CharPointer_ASCII.h.

◆ compareIgnoreCase()

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

Compares this string with another one.

Definition at line 265 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::compareIgnoreCase().

◆ compareIgnoreCaseUpTo()

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

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

Definition at line 283 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::compareIgnoreCaseUpTo().

◆ indexOf() [1/3]

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

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

Definition at line 290 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::indexOf().

◆ indexOf() [2/3]

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

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

Definition at line 296 of file juce_CharPointer_ASCII.h.

◆ indexOf() [3/3]

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

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

Definition at line 312 of file juce_CharPointer_ASCII.h.

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

◆ isWhitespace()

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

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

Definition at line 319 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::isWhitespace().

◆ isDigit()

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

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

Definition at line 321 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::isDigit().

◆ isLetter()

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

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

Definition at line 323 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::isLetter().

◆ isLetterOrDigit()

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

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

Definition at line 325 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::isLetterOrDigit().

◆ isUpperCase()

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

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

Definition at line 327 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::isUpperCase().

◆ isLowerCase()

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

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

Definition at line 329 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::isLowerCase().

◆ toUpperCase()

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

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

Definition at line 332 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::toUpperCase().

◆ toLowerCase()

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

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

Definition at line 334 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::toLowerCase().

◆ getIntValue32()

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

Parses this string as a 32-bit integer.

Definition at line 337 of file juce_CharPointer_ASCII.h.

◆ getIntValue64()

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

Parses this string as a 64-bit integer.

Definition at line 340 of file juce_CharPointer_ASCII.h.

◆ getDoubleValue()

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

Parses this string as a floating point double.

Definition at line 352 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::getDoubleValue().

◆ findEndOfWhitespace()

CharPointer_ASCII juce::CharPointer_ASCII::findEndOfWhitespace ( ) const
inlinenoexcept

Returns the first non-whitespace character in the string.

Definition at line 355 of file juce_CharPointer_ASCII.h.

References juce::CharacterFunctions::findEndOfWhitespace().

◆ canRepresent()

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

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

Definition at line 358 of file juce_CharPointer_ASCII.h.

◆ isValidString()

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

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

Definition at line 364 of file juce_CharPointer_ASCII.h.

Referenced by juce::String::String(), and juce::StringRef::StringRef().


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