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

Public Types
enum	{ byteOrderMarkBE1 = 0xfe, byteOrderMarkBE2 = 0xff, byteOrderMarkLE1 = 0xff, byteOrderMarkLE2 = 0xfe }
	These values are the byte-order-mark (BOM) values for a UTF-16 stream. More...

enum	{ byteOrderMarkBE1 = 0xfe, byteOrderMarkBE2 = 0xff, byteOrderMarkLE1 = 0xff, byteOrderMarkLE2 = 0xfe }
	These values are the byte-order-mark (BOM) values for a UTF-16 stream. More...

typedef int16	CharType

typedef int16	CharType

Public Member Functions
	CharPointer_UTF16 (const CharType *const rawPointer) noexcept

	CharPointer_UTF16 (const CharPointer_UTF16 &other) noexcept

CharPointer_UTF16 &	operator= (const CharPointer_UTF16 &other) noexcept

CharPointer_UTF16 &	operator= (const CharType *text) noexcept

bool	operator== (const CharPointer_UTF16 &other) const noexcept
	This is a pointer comparison, it doesn't compare the actual text.

bool	operator!= (const CharPointer_UTF16 &other) const noexcept

bool	operator<= (const CharPointer_UTF16 &other) const noexcept

bool	operator< (const CharPointer_UTF16 &other) const noexcept

bool	operator>= (const CharPointer_UTF16 &other) const noexcept

bool	operator> (const CharPointer_UTF16 &other) const noexcept

CharType *	getAddress () 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_UTF16 &	operator++ () noexcept
	Moves this pointer along to the next character in the string.

CharPointer_UTF16 &	operator-- () noexcept
	Moves this pointer back 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_UTF16	operator++ (int) noexcept
	Moves this pointer along to the next character in the string.

void	operator+= (int numToSkip) noexcept
	Moves this pointer forwards by the specified number of characters.

void	operator-= (int numToSkip) noexcept
	Moves this pointer backwards by the specified number of characters.

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

CharPointer_UTF16	operator+ (const int numToSkip) const noexcept
	Returns a pointer which is moved forwards from this one by the specified number of characters.

CharPointer_UTF16	operator- (const int numToSkip) const noexcept
	Returns a pointer which is moved backwards from this one by the specified number of characters.

void	write (juce_wchar charToWrite) noexcept
	Writes a unicode character to this string, and advances this pointer to point to the next position.

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

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.

template<typename CharPointer >
int	compareIgnoreCase (const CharPointer &other) const noexcept
	Compares this string with another one.

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 noexcept
	Returns true if the first character of this string is whitespace.

bool	isDigit () const noexcept
	Returns true if the first character of this string is a digit.

bool	isLetter () const noexcept
	Returns true if the first character of this string is a letter.

bool	isLetterOrDigit () const noexcept
	Returns true if the first character of this string is a letter or digit.

bool	isUpperCase () const noexcept
	Returns true if the first character of this string is upper-case.

bool	isLowerCase () const noexcept
	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_UTF16	findEndOfWhitespace () const noexcept
	Returns the first non-whitespace character in the string.

CharPointer_UTF16	atomicSwap (const CharPointer_UTF16 &newValue)
	Atomically swaps this pointer for a new value, returning the previous value.

	CharPointer_UTF16 (const CharType *const rawPointer) noexcept

	CharPointer_UTF16 (const CharPointer_UTF16 &other) noexcept

CharPointer_UTF16 &	operator= (const CharPointer_UTF16 &other) noexcept

CharPointer_UTF16 &	operator= (const CharType *text) noexcept

bool	operator== (const CharPointer_UTF16 &other) const noexcept
	This is a pointer comparison, it doesn't compare the actual text.

bool	operator!= (const CharPointer_UTF16 &other) const noexcept

bool	operator<= (const CharPointer_UTF16 &other) const noexcept

bool	operator< (const CharPointer_UTF16 &other) const noexcept

bool	operator>= (const CharPointer_UTF16 &other) const noexcept

bool	operator> (const CharPointer_UTF16 &other) const noexcept

CharType *	getAddress () 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_UTF16 &	operator++ () noexcept
	Moves this pointer along to the next character in the string.

CharPointer_UTF16 &	operator-- () noexcept
	Moves this pointer back 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_UTF16	operator++ (int) noexcept
	Moves this pointer along to the next character in the string.

void	operator+= (int numToSkip) noexcept
	Moves this pointer forwards by the specified number of characters.

void	operator-= (int numToSkip) noexcept
	Moves this pointer backwards by the specified number of characters.

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

CharPointer_UTF16	operator+ (const int numToSkip) const noexcept
	Returns a pointer which is moved forwards from this one by the specified number of characters.

CharPointer_UTF16	operator- (const int numToSkip) const noexcept
	Returns a pointer which is moved backwards from this one by the specified number of characters.

void	write (juce_wchar charToWrite) noexcept
	Writes a unicode character to this string, and advances this pointer to point to the next position.

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

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.

template<typename CharPointer >
int	compareIgnoreCase (const CharPointer &other) const noexcept
	Compares this string with another one.

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 noexcept
	Returns true if the first character of this string is whitespace.

bool	isDigit () const noexcept
	Returns true if the first character of this string is a digit.

bool	isLetter () const noexcept
	Returns true if the first character of this string is a letter.

bool	isLetterOrDigit () const noexcept
	Returns true if the first character of this string is a letter or digit.

bool	isUpperCase () const noexcept
	Returns true if the first character of this string is upper-case.

bool	isLowerCase () const noexcept
	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_UTF16	findEndOfWhitespace () const noexcept
	Returns the first non-whitespace character in the string.

CharPointer_UTF16	atomicSwap (const CharPointer_UTF16 &newValue)
	Atomically swaps this pointer for a new value, returning the previous value.

Static Public Member Functions
static size_t	getBytesRequiredFor (const juce_wchar charToWrite) 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 (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.

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

See Also: CharPointer_UTF8, CharPointer_UTF32

Member Typedef Documentation

typedef int16 juce::CharPointer_UTF16::CharType

Member Enumeration Documentation

anonymous enum

These values are the byte-order-mark (BOM) values for a UTF-16 stream.

Enumerator:

byteOrderMarkBE1
byteOrderMarkBE2
byteOrderMarkLE1
byteOrderMarkLE2

anonymous enum

These values are the byte-order-mark (BOM) values for a UTF-16 stream.

Enumerator:

byteOrderMarkBE1
byteOrderMarkBE2
byteOrderMarkLE1
byteOrderMarkLE2

Constructor & Destructor Documentation

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

explicitnoexcept

juce::CharPointer_UTF16::CharPointer_UTF16 ( const CharPointer_UTF16 & other )

noexcept

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

explicitnoexcept

juce::CharPointer_UTF16::CharPointer_UTF16 ( const CharPointer_UTF16 & other )

noexcept

Member Function Documentation

CharPointer_UTF16& juce::CharPointer_UTF16::operator= ( const CharPointer_UTF16 & other )

noexcept

CharPointer_UTF16& juce::CharPointer_UTF16::operator= ( const CharType * text )

noexcept

bool juce::CharPointer_UTF16::operator== ( const CharPointer_UTF16 & other ) const

noexcept

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

bool juce::CharPointer_UTF16::operator!= ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator<= ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator< ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator>= ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator> ( const CharPointer_UTF16 & other ) const

noexcept

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

noexcept

Returns the address that this pointer is pointing to.

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

noexcept

Returns the address that this pointer is pointing to.

bool juce::CharPointer_UTF16::isEmpty ( ) const

noexcept

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

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

noexcept

Returns the unicode character that this pointer is pointing to.

CharPointer_UTF16& juce::CharPointer_UTF16::operator++ ( )

noexcept

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

CharPointer_UTF16& juce::CharPointer_UTF16::operator-- ( )

noexcept

Moves this pointer back to the previous character in the string.

juce_wchar juce::CharPointer_UTF16::getAndAdvance ( )

noexcept

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

CharPointer_UTF16 juce::CharPointer_UTF16::operator++ ( int )

noexcept

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

void juce::CharPointer_UTF16::operator+= ( int numToSkip )

noexcept

Moves this pointer forwards by the specified number of characters.

void juce::CharPointer_UTF16::operator-= ( int numToSkip )

noexcept

Moves this pointer backwards by the specified number of characters.

juce_wchar juce::CharPointer_UTF16::operator[] ( const int characterIndex ) const

noexcept

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

CharPointer_UTF16 juce::CharPointer_UTF16::operator+ ( const int numToSkip ) const

noexcept

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

CharPointer_UTF16 juce::CharPointer_UTF16::operator- ( const int numToSkip ) const

noexcept

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

void juce::CharPointer_UTF16::write ( juce_wchar charToWrite )

noexcept

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

void juce::CharPointer_UTF16::writeNull ( ) const

noexcept

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

size_t juce::CharPointer_UTF16::length ( ) const

noexcept

Returns the number of characters in this string.

size_t juce::CharPointer_UTF16::lengthUpTo ( const size_t maxCharsToCount ) const

noexcept

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

size_t juce::CharPointer_UTF16::lengthUpTo ( const CharPointer_UTF16 & end ) const

noexcept

Returns the number of characters in this string, or up to the given end pointer, whichever is lower.

size_t juce::CharPointer_UTF16::sizeInBytes ( ) const

noexcept

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

This includes the terminating null character.

static size_t juce::CharPointer_UTF16::getBytesRequiredFor ( const juce_wchar charToWrite )

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 juce::CharPointer_UTF16::getBytesRequiredFor ( 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_UTF16 juce::CharPointer_UTF16::findTerminatingNull ( ) const

noexcept

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

template<typename CharPointer >

void juce::CharPointer_UTF16::writeAll ( const CharPointer & src )

noexcept

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

void juce::CharPointer_UTF16::writeAll ( const CharPointer_UTF16 & src )

noexcept

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

template<typename CharPointer >

size_t juce::CharPointer_UTF16::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.

template<typename CharPointer >

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

template<typename CharPointer >

int juce::CharPointer_UTF16::compare ( const CharPointer & other ) const

noexcept

Compares this string with another one.

template<typename CharPointer >

int juce::CharPointer_UTF16::compareUpTo	(	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 juce::CharPointer_UTF16::compareIgnoreCase ( const CharPointer & other ) const

noexcept

Compares this string with another one.

template<typename CharPointer >

int juce::CharPointer_UTF16::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 juce::CharPointer_UTF16::indexOf ( const CharPointer & stringToFind ) const

noexcept

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

int juce::CharPointer_UTF16::indexOf ( const juce_wchar charToFind ) const

noexcept

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

int juce::CharPointer_UTF16::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 juce::CharPointer_UTF16::isWhitespace ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isDigit ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isLetter ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isLetterOrDigit ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isUpperCase ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isLowerCase ( ) const

noexcept

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

juce_wchar juce::CharPointer_UTF16::toUpperCase ( ) const

noexcept

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

juce_wchar juce::CharPointer_UTF16::toLowerCase ( ) const

noexcept

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

int juce::CharPointer_UTF16::getIntValue32 ( ) const

noexcept

Parses this string as a 32-bit integer.

int64 juce::CharPointer_UTF16::getIntValue64 ( ) const

noexcept

Parses this string as a 64-bit integer.

double juce::CharPointer_UTF16::getDoubleValue ( ) const

noexcept

Parses this string as a floating point double.

CharPointer_UTF16 juce::CharPointer_UTF16::findEndOfWhitespace ( ) const

noexcept

Returns the first non-whitespace character in the string.

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

staticnoexcept

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

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

static

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

CharPointer_UTF16 juce::CharPointer_UTF16::atomicSwap ( const CharPointer_UTF16 & newValue )

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

CharPointer_UTF16& juce::CharPointer_UTF16::operator= ( const CharPointer_UTF16 & other )

noexcept

CharPointer_UTF16& juce::CharPointer_UTF16::operator= ( const CharType * text )

noexcept

bool juce::CharPointer_UTF16::operator== ( const CharPointer_UTF16 & other ) const

noexcept

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

bool juce::CharPointer_UTF16::operator!= ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator<= ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator< ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator>= ( const CharPointer_UTF16 & other ) const

noexcept

bool juce::CharPointer_UTF16::operator> ( const CharPointer_UTF16 & other ) const

noexcept

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

noexcept

Returns the address that this pointer is pointing to.

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

noexcept

Returns the address that this pointer is pointing to.

bool juce::CharPointer_UTF16::isEmpty ( ) const

noexcept

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

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

noexcept

Returns the unicode character that this pointer is pointing to.

CharPointer_UTF16& juce::CharPointer_UTF16::operator++ ( )

noexcept

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

CharPointer_UTF16& juce::CharPointer_UTF16::operator-- ( )

noexcept

Moves this pointer back to the previous character in the string.

juce_wchar juce::CharPointer_UTF16::getAndAdvance ( )

noexcept

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

CharPointer_UTF16 juce::CharPointer_UTF16::operator++ ( int )

noexcept

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

void juce::CharPointer_UTF16::operator+= ( int numToSkip )

noexcept

Moves this pointer forwards by the specified number of characters.

void juce::CharPointer_UTF16::operator-= ( int numToSkip )

noexcept

Moves this pointer backwards by the specified number of characters.

juce_wchar juce::CharPointer_UTF16::operator[] ( const int characterIndex ) const

noexcept

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

CharPointer_UTF16 juce::CharPointer_UTF16::operator+ ( const int numToSkip ) const

noexcept

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

CharPointer_UTF16 juce::CharPointer_UTF16::operator- ( const int numToSkip ) const

noexcept

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

void juce::CharPointer_UTF16::write ( juce_wchar charToWrite )

noexcept

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

void juce::CharPointer_UTF16::writeNull ( ) const

noexcept

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

size_t juce::CharPointer_UTF16::length ( ) const

noexcept

Returns the number of characters in this string.

size_t juce::CharPointer_UTF16::lengthUpTo ( const size_t maxCharsToCount ) const

noexcept

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

size_t juce::CharPointer_UTF16::lengthUpTo ( const CharPointer_UTF16 & end ) const

noexcept

Returns the number of characters in this string, or up to the given end pointer, whichever is lower.

size_t juce::CharPointer_UTF16::sizeInBytes ( ) const

noexcept

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

This includes the terminating null character.

static size_t juce::CharPointer_UTF16::getBytesRequiredFor ( const juce_wchar charToWrite )

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 juce::CharPointer_UTF16::getBytesRequiredFor ( 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_UTF16 juce::CharPointer_UTF16::findTerminatingNull ( ) const

noexcept

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

template<typename CharPointer >

void juce::CharPointer_UTF16::writeAll ( const CharPointer & src )

noexcept

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

void juce::CharPointer_UTF16::writeAll ( const CharPointer_UTF16 & src )

noexcept

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

template<typename CharPointer >

size_t juce::CharPointer_UTF16::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.

template<typename CharPointer >

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

template<typename CharPointer >

int juce::CharPointer_UTF16::compare ( const CharPointer & other ) const

noexcept

Compares this string with another one.

template<typename CharPointer >

int juce::CharPointer_UTF16::compareUpTo	(	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 juce::CharPointer_UTF16::compareIgnoreCase ( const CharPointer & other ) const

noexcept

Compares this string with another one.

template<typename CharPointer >

int juce::CharPointer_UTF16::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 juce::CharPointer_UTF16::indexOf ( const CharPointer & stringToFind ) const

noexcept

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

int juce::CharPointer_UTF16::indexOf ( const juce_wchar charToFind ) const

noexcept

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

int juce::CharPointer_UTF16::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 juce::CharPointer_UTF16::isWhitespace ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isDigit ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isLetter ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isLetterOrDigit ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isUpperCase ( ) const

noexcept

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

bool juce::CharPointer_UTF16::isLowerCase ( ) const

noexcept

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

juce_wchar juce::CharPointer_UTF16::toUpperCase ( ) const

noexcept

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

juce_wchar juce::CharPointer_UTF16::toLowerCase ( ) const

noexcept

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

int juce::CharPointer_UTF16::getIntValue32 ( ) const

noexcept

Parses this string as a 32-bit integer.

int64 juce::CharPointer_UTF16::getIntValue64 ( ) const

noexcept

Parses this string as a 64-bit integer.

double juce::CharPointer_UTF16::getDoubleValue ( ) const

noexcept

Parses this string as a floating point double.

CharPointer_UTF16 juce::CharPointer_UTF16::findEndOfWhitespace ( ) const

noexcept

Returns the first non-whitespace character in the string.

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

staticnoexcept

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

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

static

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

CharPointer_UTF16 juce::CharPointer_UTF16::atomicSwap ( const CharPointer_UTF16 & newValue )

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

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

juce_CharPointer_UTF16.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation