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>

Collaboration diagram for juce::CharPointer_ASCII:

[legend]

Public Types
using	CharType = char

Public Member Functions
	CharPointer_ASCII (const CharPointer_ASCII &other)=default

	CharPointer_ASCII (const CharType *rawPointer) noexcept

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

CharPointer_ASCII	findEndOfWhitespace () const noexcept
	Returns the first non-whitespace character in the string. More...

CharPointer_ASCII	findTerminatingNull () const noexcept
	Returns a pointer to the null character that terminates this string. More...

CharType *	getAddress () 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 (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	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 (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	lengthUpTo (const 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_ASCII other) const noexcept

juce_wchar	operator* () const noexcept
	Returns the unicode character that this pointer is pointing to. 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++ () noexcept
	Moves this pointer along to the next character in the string. 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...

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

CharPointer_ASCII	operator-- () noexcept
	Moves this pointer to the previous character in the string. More...

void	operator-= (const int numToSkip) noexcept

bool	operator< (CharPointer_ASCII other) const noexcept

bool	operator<= (CharPointer_ASCII other) const 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. More...

bool	operator> (CharPointer_ASCII other) const noexcept

bool	operator>= (CharPointer_ASCII other) const noexcept

juce_wchar	operator[] (const int characterIndex) const noexcept
	Returns the character at a given character index from the start of the string. More...

void	replaceChar (const 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 (const 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 (const CharPointer 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 (const CharPointer src, const int maxChars) 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...

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 (const 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 (const 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
CharType *	data

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

@tags{Core}

Member Typedef Documentation

◆ CharType

using juce::CharPointer_ASCII::CharType = char

Constructor & Destructor Documentation

◆ CharPointer_ASCII() [1/2]

juce::CharPointer_ASCII::CharPointer_ASCII ( const CharType * rawPointer )

inlineexplicitnoexcept

Referenced by findTerminatingNull(), operator+(), and operator-().

◆ CharPointer_ASCII() [2/2]

juce::CharPointer_ASCII::CharPointer_ASCII ( const CharPointer_ASCII & other )

inlinedefault

Member Function Documentation

◆ canRepresent()

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

inlinestaticnoexcept

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

References int().

◆ compare() [1/2]

template<typename CharPointer >

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

inlinenoexcept

Compares this string with another one.

References juce::CharacterFunctions::compare().

◆ compare() [2/2]

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

inlinenoexcept

Compares this string with another one.

References data.

◆ compareIgnoreCase() [1/2]

template<typename CharPointer >

int juce::CharPointer_ASCII::compareIgnoreCase ( const CharPointer other ) const

inline

Compares this string with another one.

References juce::CharacterFunctions::compareIgnoreCase().

◆ compareIgnoreCase() [2/2]

int juce::CharPointer_ASCII::compareIgnoreCase ( const CharPointer_ASCII other ) const

inline

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

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

References juce::CharacterFunctions::compareIgnoreCaseUpTo().

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

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.

References data.

◆ findEndOfWhitespace()

CharPointer_ASCII juce::CharPointer_ASCII::findEndOfWhitespace ( ) const

inlinenoexcept

Returns the first non-whitespace character in the string.

References juce::CharacterFunctions::findEndOfWhitespace().

◆ findTerminatingNull()

CharPointer_ASCII juce::CharPointer_ASCII::findTerminatingNull ( ) const

inlinenoexcept

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

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

◆ getAddress()

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

inlinenoexcept

Returns the address that this pointer is pointing to.

References data.

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

References data.

◆ getBytesRequiredFor() [1/2]

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.

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

◆ getBytesRequiredFor() [2/2]

static size_t juce::CharPointer_ASCII::getBytesRequiredFor ( const 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_ASCII::getDoubleValue ( ) const

inlinenoexcept

Parses this string as a floating point double.

References juce::CharacterFunctions::getDoubleValue().

◆ getIntValue32()

int juce::CharPointer_ASCII::getIntValue32 ( ) const

inlinenoexcept

Parses this string as a 32-bit integer.

References data.

◆ getIntValue64()

int64 juce::CharPointer_ASCII::getIntValue64 ( ) const

inlinenoexcept

Parses this string as a 64-bit integer.

References data.

◆ incrementToEndOfWhitespace()

void juce::CharPointer_ASCII::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_ASCII::indexOf ( const 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_ASCII::indexOf ( const 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_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.

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

◆ isDigit()

bool juce::CharPointer_ASCII::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_ASCII::isEmpty ( ) const

inlinenoexcept

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

References data.

◆ isLetter()

bool juce::CharPointer_ASCII::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_ASCII::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_ASCII::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_ASCII::isNotEmpty ( ) const

inlinenoexcept

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

References data.

◆ isUpperCase()

bool juce::CharPointer_ASCII::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_ASCII::isValidString	(	const CharType *	dataToTest,
		int	maxBytesToRead
	)

inlinestatic

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

◆ isWhitespace()

bool juce::CharPointer_ASCII::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_ASCII::length ( ) const

inlinenoexcept

Returns the number of characters in this string.

References data.

Referenced by findTerminatingNull(), and sizeInBytes().

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

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

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

References juce::CharacterFunctions::lengthUpTo().

◆ operator const CharType *()

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

inlinenoexcept

Returns the address that this pointer is pointing to.

References data.

◆ operator!=()

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

inlinenoexcept

References data.

◆ operator*()

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

inlinenoexcept

Returns the unicode character that this pointer is pointing to.

References data.

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

References CharPointer_ASCII(), and data.

◆ operator++() [1/2]

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

inlinenoexcept

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

References data.

◆ operator++() [2/2]

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

inlinenoexcept

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

References data.

◆ operator+=()

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

inlinenoexcept

Moves this pointer forwards by the specified number of characters.

References data.

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

References CharPointer_ASCII(), and data.

◆ operator--()

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

inlinenoexcept

Moves this pointer to the previous character in the string.

References data.

◆ operator-=()

void juce::CharPointer_ASCII::operator-= ( const int numToSkip )

inlinenoexcept

References data.

◆ operator<()

bool juce::CharPointer_ASCII::operator< ( CharPointer_ASCII other ) const

inlinenoexcept

References data.

◆ operator<=()

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

inlinenoexcept

References data.

◆ operator=() [1/2]

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

inlinenoexcept

References data.

◆ operator=() [2/2]

CharPointer_ASCII juce::CharPointer_ASCII::operator= ( const CharType * text )

inlinenoexcept

References data, and juce::UnitTestCategories::text.

◆ operator==()

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

inlinenoexcept

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

References data.

◆ operator>()

bool juce::CharPointer_ASCII::operator> ( CharPointer_ASCII other ) const

inlinenoexcept

References data.

◆ operator>=()

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

inlinenoexcept

References data.

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

References data.

◆ replaceChar()

void juce::CharPointer_ASCII::replaceChar ( const juce_wchar newChar )

inlinenoexcept

References data.

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

References length().

◆ toLowerCase()

juce_wchar juce::CharPointer_ASCII::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_ASCII::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_ASCII::write ( const juce_wchar charToWrite )

inlinenoexcept

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

References data.

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

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

◆ writeNull()

void juce::CharPointer_ASCII::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_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).

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

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

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

Member Data Documentation

◆ data

CharType* juce::CharPointer_ASCII::data

private

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

juce_CharPointer_ASCII.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CharType

Constructor & Destructor Documentation

◆ CharPointer_ASCII() [1/2]

◆ CharPointer_ASCII() [2/2]

Member Function Documentation

◆ canRepresent()

◆ compare() [1/2]

◆ compare() [2/2]

◆ compareIgnoreCase() [1/2]

◆ compareIgnoreCase() [2/2]

◆ compareIgnoreCaseUpTo()

◆ compareUpTo() [1/2]

◆ compareUpTo() [2/2]

◆ findEndOfWhitespace()

◆ findTerminatingNull()

◆ getAddress()

◆ getAndAdvance()

◆ getBytesRequiredFor() [1/2]

◆ getBytesRequiredFor() [2/2]

◆ getDoubleValue()

◆ getIntValue32()

◆ getIntValue64()

◆ incrementToEndOfWhitespace()

◆ indexOf() [1/3]

◆ indexOf() [2/3]

◆ indexOf() [3/3]

◆ isDigit()

◆ isEmpty()

◆ isLetter()

◆ isLetterOrDigit()

◆ isLowerCase()

◆ isNotEmpty()

◆ isUpperCase()

◆ isValidString()

◆ isWhitespace()

◆ length()

◆ lengthUpTo() [1/2]

◆ lengthUpTo() [2/2]

◆ operator const CharType *()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--()

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]()

◆ replaceChar()

◆ sizeInBytes()

◆ toLowerCase()

◆ toUpperCase()

◆ write()

◆ writeAll()

◆ writeNull()

◆ writeWithCharLimit()

◆ writeWithDestByteLimit()

Member Data Documentation

◆ data