openshot-audio  0.1.4
Public Types | Public Member Functions | Static Public Member Functions | List of all members
CharPointer_UTF16 Class Reference

#include <juce_CharPointer_UTF16.h>

Public Types

enum  { byteOrderMarkBE1 = 0xfe, byteOrderMarkBE2 = 0xff, byteOrderMarkLE1 = 0xff, byteOrderMarkLE2 = 0xfe }
 
typedef int16 CharType
 

Public Member Functions

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

Static Public Member Functions

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

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

◆ CharType

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Enumerator
byteOrderMarkBE1 
byteOrderMarkBE2 
byteOrderMarkLE1 
byteOrderMarkLE2 

Constructor & Destructor Documentation

◆ CharPointer_UTF16() [1/2]

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

◆ CharPointer_UTF16() [2/2]

CharPointer_UTF16::CharPointer_UTF16 ( const CharPointer_UTF16 other)
inlinenoexcept

Member Function Documentation

◆ atomicSwap()

CharPointer_UTF16 CharPointer_UTF16::atomicSwap ( const CharPointer_UTF16  newValue)
inline

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

◆ canRepresent()

static bool CharPointer_UTF16::canRepresent ( juce_wchar  character)
inlinestaticnoexcept

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

◆ compare()

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

Compares this string with another one.

◆ compareIgnoreCase()

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

Compares this string with another one.

◆ compareIgnoreCaseUpTo()

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

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

◆ compareUpTo()

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

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

◆ findEndOfWhitespace()

CharPointer_UTF16 CharPointer_UTF16::findEndOfWhitespace ( ) const
inlinenoexcept

Returns the first non-whitespace character in the string.

◆ findTerminatingNull()

CharPointer_UTF16 CharPointer_UTF16::findTerminatingNull ( ) const
inlinenoexcept

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

◆ getAddress()

CharType* CharPointer_UTF16::getAddress ( ) const
inlinenoexcept

Returns the address that this pointer is pointing to.

◆ getAndAdvance()

juce_wchar CharPointer_UTF16::getAndAdvance ( )
inlinenoexcept

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

◆ getBytesRequiredFor() [1/2]

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

Returns the number of bytes that would be needed to represent the given unicode character in this encoding format.

◆ getBytesRequiredFor() [2/2]

template<class CharPointer >
static size_t CharPointer_UTF16::getBytesRequiredFor ( CharPointer  text)
inlinestaticnoexcept

Returns the number of bytes that would be needed to represent the given string in this encoding format. The value returned does NOT include the terminating null character.

◆ getDoubleValue()

double CharPointer_UTF16::getDoubleValue ( ) const
inlinenoexcept

Parses this string as a floating point double.

◆ getIntValue32()

int CharPointer_UTF16::getIntValue32 ( ) const
inlinenoexcept

Parses this string as a 32-bit integer.

◆ getIntValue64()

int64 CharPointer_UTF16::getIntValue64 ( ) const
inlinenoexcept

Parses this string as a 64-bit integer.

◆ indexOf() [1/3]

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

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

◆ indexOf() [2/3]

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

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

◆ indexOf() [3/3]

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

◆ isByteOrderMarkBigEndian()

static bool CharPointer_UTF16::isByteOrderMarkBigEndian ( const void *  possibleByteOrder)
inlinestaticnoexcept

Returns true if the first pair of bytes in this pointer are the UTF16 byte-order mark (big endian). The pointer must not be null, and must contain at least two valid bytes.

◆ isByteOrderMarkLittleEndian()

static bool CharPointer_UTF16::isByteOrderMarkLittleEndian ( const void *  possibleByteOrder)
inlinestaticnoexcept

Returns true if the first pair of bytes in this pointer are the UTF16 byte-order mark (little endian). The pointer must not be null, and must contain at least two valid bytes.

◆ isDigit()

bool CharPointer_UTF16::isDigit ( ) const
inlinenoexcept

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

◆ isEmpty()

bool CharPointer_UTF16::isEmpty ( ) const
inlinenoexcept

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

◆ isLetter()

bool CharPointer_UTF16::isLetter ( ) const
inlinenoexcept

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

◆ isLetterOrDigit()

bool CharPointer_UTF16::isLetterOrDigit ( ) const
inlinenoexcept

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

◆ isLowerCase()

bool CharPointer_UTF16::isLowerCase ( ) const
inlinenoexcept

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

◆ isUpperCase()

bool CharPointer_UTF16::isUpperCase ( ) const
inlinenoexcept

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

◆ isValidString()

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

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

◆ isWhitespace()

bool CharPointer_UTF16::isWhitespace ( ) const
inlinenoexcept

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

◆ length()

size_t CharPointer_UTF16::length ( ) const
inlinenoexcept

Returns the number of characters in this string.

◆ lengthUpTo() [1/2]

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

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

◆ lengthUpTo() [2/2]

size_t CharPointer_UTF16::lengthUpTo ( const CharPointer_UTF16  end) const
inlinenoexcept

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

◆ operator const CharType *()

CharPointer_UTF16::operator const CharType * ( ) const
inlinenoexcept

Returns the address that this pointer is pointing to.

◆ operator!=()

bool CharPointer_UTF16::operator!= ( CharPointer_UTF16  other) const
inlinenoexcept

◆ operator*()

juce_wchar CharPointer_UTF16::operator* ( ) const
inlinenoexcept

Returns the unicode character that this pointer is pointing to.

◆ operator+()

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

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

◆ operator++() [1/2]

CharPointer_UTF16 CharPointer_UTF16::operator++ ( )
inlinenoexcept

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

◆ operator++() [2/2]

CharPointer_UTF16 CharPointer_UTF16::operator++ ( int  )
inlinenoexcept

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

◆ operator+=()

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

Moves this pointer forwards by the specified number of characters.

◆ operator-()

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

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

◆ operator--()

CharPointer_UTF16 CharPointer_UTF16::operator-- ( )
inlinenoexcept

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

◆ operator-=()

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

Moves this pointer backwards by the specified number of characters.

◆ operator<()

bool CharPointer_UTF16::operator< ( CharPointer_UTF16  other) const
inlinenoexcept

◆ operator<=()

bool CharPointer_UTF16::operator<= ( CharPointer_UTF16  other) const
inlinenoexcept

◆ operator=() [1/2]

CharPointer_UTF16 CharPointer_UTF16::operator= ( CharPointer_UTF16  other)
inlinenoexcept

◆ operator=() [2/2]

CharPointer_UTF16 CharPointer_UTF16::operator= ( const CharType text)
inlinenoexcept

◆ operator==()

bool CharPointer_UTF16::operator== ( CharPointer_UTF16  other) const
inlinenoexcept

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

◆ operator>()

bool CharPointer_UTF16::operator> ( CharPointer_UTF16  other) const
inlinenoexcept

◆ operator>=()

bool CharPointer_UTF16::operator>= ( CharPointer_UTF16  other) const
inlinenoexcept

◆ operator[]()

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

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

◆ sizeInBytes()

size_t CharPointer_UTF16::sizeInBytes ( ) const
inlinenoexcept

Returns the number of bytes that are used to represent this string. This includes the terminating null character.

◆ toLowerCase()

juce_wchar CharPointer_UTF16::toLowerCase ( ) const
inlinenoexcept

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

◆ toUpperCase()

juce_wchar CharPointer_UTF16::toUpperCase ( ) const
inlinenoexcept

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

◆ write()

void CharPointer_UTF16::write ( juce_wchar  charToWrite)
inlinenoexcept

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

◆ writeAll() [1/2]

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

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

◆ writeAll() [2/2]

void CharPointer_UTF16::writeAll ( const CharPointer_UTF16  src)
inlinenoexcept

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

◆ writeNull()

void CharPointer_UTF16::writeNull ( ) const
inlinenoexcept

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

◆ writeWithCharLimit()

template<typename CharPointer >
void CharPointer_UTF16::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).

◆ writeWithDestByteLimit()

template<typename CharPointer >
size_t CharPointer_UTF16::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.


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