JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | Static Public Member Functions | List of all members
CharPointer_ASCII Class Reference

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

Public Types

typedef char CharType
 

Public Member Functions

 CharPointer_ASCII (const CharType *const rawPointer) noexcept
 
 CharPointer_ASCII (const CharPointer_ASCII &other) noexcept
 
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.
 
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
 
CharTypegetAddress () const noexcept
 Returns the address that this pointer is pointing to.
 
 operator const CharType * () const noexcept
 Returns the address that this pointer is pointing to.
 
bool isEmpty () const noexcept
 Returns true if this pointer is pointing to a null character.
 
juce_wchar operator* () const noexcept
 Returns the unicode character that this pointer is pointing to.
 
CharPointer_ASCII operator++ () noexcept
 Moves this pointer along to the next character in the string.
 
CharPointer_ASCII operator-- () noexcept
 Moves this pointer to the previous character in the string.
 
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.
 
CharPointer_ASCII operator++ (int) noexcept
 Moves this pointer along to the next character in the string.
 
void operator+= (const int numToSkip) noexcept
 Moves this pointer forwards by the specified number of characters.
 
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.
 
CharPointer_ASCII operator+ (const int numToSkip) const noexcept
 Returns a pointer which is moved forwards from this one by the specified number of characters.
 
CharPointer_ASCII operator- (const int numToSkip) const noexcept
 Returns a pointer which is moved backwards from this one by the specified number of characters.
 
void write (const juce_wchar charToWrite) noexcept
 Writes a unicode character to this string, and advances this pointer to point to the next position.
 
void replaceChar (const juce_wchar newChar) noexcept
 
void writeNull () const noexcept
 Writes a null character to this string (leaving the pointer's position unchanged).
 
size_t length () const noexcept
 Returns the number of characters in this string.
 
size_t lengthUpTo (const size_t maxCharsToCount) const noexcept
 Returns the number of characters in this string, or the given value, whichever is lower.
 
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.
 
size_t sizeInBytes () const noexcept
 Returns the number of bytes that are used to represent this string.
 
CharPointer_ASCII findTerminatingNull () const noexcept
 Returns a pointer to the null character that terminates this string.
 
template<typename CharPointer >
void writeAll (const CharPointer src) noexcept
 Copies a source string to this pointer, advancing this pointer as it goes.
 
void writeAll (const CharPointer_ASCII src) noexcept
 Copies a source string to this pointer, advancing this pointer as it goes.
 
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.
 
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.
 
template<typename CharPointer >
int compare (const CharPointer other) const noexcept
 Compares this string with another one.
 
int compare (const CharPointer_ASCII other) const noexcept
 Compares this string with another one.
 
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.
 
int compareUpTo (const CharPointer_ASCII other, const int maxChars) const noexcept
 Compares this string with another one, up to a specified number of characters.
 
template<typename CharPointer >
int compareIgnoreCase (const CharPointer other) const
 Compares this string with another one.
 
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.
 
template<typename CharPointer >
int indexOf (const CharPointer stringToFind) const noexcept
 Returns the character index of a substring, or -1 if it isn't found.
 
int indexOf (const juce_wchar charToFind) const noexcept
 Returns the character index of a unicode character, or -1 if it isn't found.
 
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.
 
bool isWhitespace () const
 Returns true if the first character of this string is whitespace.
 
bool isDigit () const
 Returns true if the first character of this string is a digit.
 
bool isLetter () const
 Returns true if the first character of this string is a letter.
 
bool isLetterOrDigit () const
 Returns true if the first character of this string is a letter or digit.
 
bool isUpperCase () const
 Returns true if the first character of this string is upper-case.
 
bool isLowerCase () const
 Returns true if the first character of this string is lower-case.
 
juce_wchar toUpperCase () const noexcept
 Returns an upper-case version of the first character of this string.
 
juce_wchar toLowerCase () const noexcept
 Returns a lower-case version of the first character of this string.
 
int getIntValue32 () const noexcept
 Parses this string as a 32-bit integer.
 
int64 getIntValue64 () const noexcept
 Parses this string as a 64-bit integer.
 
double getDoubleValue () const noexcept
 Parses this string as a floating point double.
 
CharPointer_ASCII findEndOfWhitespace () const noexcept
 Returns the first non-whitespace character in the string.
 

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.
 
static bool canRepresent (juce_wchar character) noexcept
 Returns true if the given unicode character can be represented in this encoding.
 
static bool isValidString (const CharType *dataToTest, int maxBytesToRead)
 Returns true if this data contains a valid string in this encoding.
 

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

Member Typedef Documentation

Constructor & Destructor Documentation

CharPointer_ASCII::CharPointer_ASCII ( const CharType *const  rawPointer)
explicitnoexcept
CharPointer_ASCII::CharPointer_ASCII ( const CharPointer_ASCII other)
noexcept

Member Function Documentation

CharPointer_ASCII CharPointer_ASCII::operator= ( const CharPointer_ASCII  other)
noexcept
CharPointer_ASCII CharPointer_ASCII::operator= ( const CharType text)
noexcept
bool CharPointer_ASCII::operator== ( CharPointer_ASCII  other) const
noexcept

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

bool CharPointer_ASCII::operator!= ( CharPointer_ASCII  other) const
noexcept
bool CharPointer_ASCII::operator<= ( CharPointer_ASCII  other) const
noexcept
bool CharPointer_ASCII::operator< ( CharPointer_ASCII  other) const
noexcept
bool CharPointer_ASCII::operator>= ( CharPointer_ASCII  other) const
noexcept
bool CharPointer_ASCII::operator> ( CharPointer_ASCII  other) const
noexcept
CharType* CharPointer_ASCII::getAddress ( ) const
noexcept

Returns the address that this pointer is pointing to.

Referenced by String::appendCharPointer().

CharPointer_ASCII::operator const CharType * ( ) const
noexcept

Returns the address that this pointer is pointing to.

bool CharPointer_ASCII::isEmpty ( ) const
noexcept

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

juce_wchar CharPointer_ASCII::operator* ( ) const
noexcept

Returns the unicode character that this pointer is pointing to.

CharPointer_ASCII CharPointer_ASCII::operator++ ( )
noexcept

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

CharPointer_ASCII CharPointer_ASCII::operator-- ( )
noexcept

Moves this pointer to the previous character in the string.

juce_wchar CharPointer_ASCII::getAndAdvance ( )
noexcept

Returns the character that this pointer is currently pointing to, and then advances the pointer to point to the next character.

CharPointer_ASCII CharPointer_ASCII::operator++ ( int  )
noexcept

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

void CharPointer_ASCII::operator+= ( const int  numToSkip)
noexcept

Moves this pointer forwards by the specified number of characters.

void CharPointer_ASCII::operator-= ( const int  numToSkip)
noexcept
juce_wchar CharPointer_ASCII::operator[] ( const int  characterIndex) const
noexcept

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

CharPointer_ASCII CharPointer_ASCII::operator+ ( const int  numToSkip) const
noexcept

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

References CharPointer_ASCII().

CharPointer_ASCII CharPointer_ASCII::operator- ( const int  numToSkip) const
noexcept

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

References CharPointer_ASCII().

void CharPointer_ASCII::write ( const juce_wchar  charToWrite)
noexcept

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

void CharPointer_ASCII::replaceChar ( const juce_wchar  newChar)
noexcept
void CharPointer_ASCII::writeNull ( ) const
noexcept

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

size_t CharPointer_ASCII::length ( ) const
noexcept

Returns the number of characters in this string.

Referenced by findTerminatingNull(), and sizeInBytes().

size_t CharPointer_ASCII::lengthUpTo ( const size_t  maxCharsToCount) const
noexcept

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

References CharacterFunctions::lengthUpTo().

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

References CharacterFunctions::lengthUpTo().

size_t CharPointer_ASCII::sizeInBytes ( ) const
noexcept

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

This includes the terminating null character.

References length().

static size_t CharPointer_ASCII::getBytesRequiredFor ( const juce_wchar  )
staticnoexcept

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 CharPointer_ASCII::getBytesRequiredFor ( const CharPointer  text)
staticnoexcept

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.

CharPointer_ASCII CharPointer_ASCII::findTerminatingNull ( ) const
noexcept

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

References CharPointer_ASCII(), and length().

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

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

References CharacterFunctions::copyAll().

void CharPointer_ASCII::writeAll ( const CharPointer_ASCII  src)
noexcept

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

template<typename CharPointer >
size_t CharPointer_ASCII::writeWithDestByteLimit ( const CharPointer  src,
const size_t  maxDestBytes 
)
noexcept

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 CharacterFunctions::copyWithDestByteLimit().

template<typename CharPointer >
void CharPointer_ASCII::writeWithCharLimit ( const CharPointer  src,
const int  maxChars 
)
noexcept

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 CharacterFunctions::copyWithCharLimit().

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

Compares this string with another one.

References CharacterFunctions::compare().

int CharPointer_ASCII::compare ( const CharPointer_ASCII  other) const
noexcept

Compares this string with another one.

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

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

References CharacterFunctions::compareUpTo().

int CharPointer_ASCII::compareUpTo ( const CharPointer_ASCII  other,
const int  maxChars 
) const
noexcept

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

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

Compares this string with another one.

References CharacterFunctions::compareIgnoreCase().

int CharPointer_ASCII::compareIgnoreCase ( const CharPointer_ASCII  other) const
template<typename CharPointer >
int CharPointer_ASCII::compareIgnoreCaseUpTo ( const CharPointer  other,
const int  maxChars 
) const
noexcept

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

References CharacterFunctions::compareIgnoreCaseUpTo().

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

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

References CharacterFunctions::indexOf().

int CharPointer_ASCII::indexOf ( const juce_wchar  charToFind) const
noexcept

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

int CharPointer_ASCII::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.

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

bool CharPointer_ASCII::isWhitespace ( ) const

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

References CharacterFunctions::isWhitespace().

bool CharPointer_ASCII::isDigit ( ) const

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

References CharacterFunctions::isDigit().

bool CharPointer_ASCII::isLetter ( ) const

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

References CharacterFunctions::isLetter().

bool CharPointer_ASCII::isLetterOrDigit ( ) const

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

References CharacterFunctions::isLetterOrDigit().

bool CharPointer_ASCII::isUpperCase ( ) const

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

References CharacterFunctions::isUpperCase().

bool CharPointer_ASCII::isLowerCase ( ) const

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

References CharacterFunctions::isLowerCase().

juce_wchar CharPointer_ASCII::toUpperCase ( ) const
noexcept

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

References CharacterFunctions::toUpperCase().

juce_wchar CharPointer_ASCII::toLowerCase ( ) const
noexcept

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

References CharacterFunctions::toLowerCase().

int CharPointer_ASCII::getIntValue32 ( ) const
noexcept

Parses this string as a 32-bit integer.

int64 CharPointer_ASCII::getIntValue64 ( ) const
noexcept

Parses this string as a 64-bit integer.

double CharPointer_ASCII::getDoubleValue ( ) const
noexcept

Parses this string as a floating point double.

References CharacterFunctions::getDoubleValue().

CharPointer_ASCII CharPointer_ASCII::findEndOfWhitespace ( ) const
noexcept

Returns the first non-whitespace character in the string.

References CharacterFunctions::findEndOfWhitespace().

static bool CharPointer_ASCII::canRepresent ( juce_wchar  character)
staticnoexcept

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

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

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


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