OpenShot Library | libopenshot-audio 0.2.0
|
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. | |
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. | |
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. | |
bool | isNotEmpty () const noexcept |
Returns true if this pointer is not 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. | |
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. | |
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.
Definition at line 41 of file juce_CharPointer_ASCII.h.
Definition at line 44 of file juce_CharPointer_ASCII.h.
|
inlineexplicitnoexcept |
Definition at line 46 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Definition at line 53 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Definition at line 59 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
This is a pointer comparison, it doesn't compare the actual text.
Definition at line 66 of file juce_CharPointer_ASCII.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::data().
|
inlinenoexcept |
Definition at line 67 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Definition at line 68 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Definition at line 69 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Definition at line 70 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Definition at line 71 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Returns the address that this pointer is pointing to.
Definition at line 74 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Returns the address that this pointer is pointing to.
Definition at line 77 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Returns true if this pointer is pointing to a null character.
Definition at line 80 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Returns true if this pointer is not pointing to a null character.
Definition at line 83 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Returns the unicode character that this pointer is pointing to.
Definition at line 86 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Moves this pointer along to the next character in the string.
Definition at line 89 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Moves this pointer to the previous character in the string.
Definition at line 96 of file juce_CharPointer_ASCII.h.
|
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.
|
inlinenoexcept |
Moves this pointer along to the next character in the string.
Definition at line 107 of file juce_CharPointer_ASCII.h.
Moves this pointer forwards by the specified number of characters.
Definition at line 115 of file juce_CharPointer_ASCII.h.
Definition at line 120 of file juce_CharPointer_ASCII.h.
|
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.
|
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.
|
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.
|
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.
|
inlinenoexcept |
Definition at line 149 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Writes a null character to this string (leaving the pointer's position unchanged).
Definition at line 155 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Returns the number of characters in this string.
Definition at line 161 of file juce_CharPointer_ASCII.h.
Referenced by findTerminatingNull(), and sizeInBytes().
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().
|
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().
|
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().
|
inlinestaticnoexcept |
Returns the number of bytes that would be needed to represent the given unicode character in this encoding format.
Definition at line 189 of file juce_CharPointer_ASCII.h.
|
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.
|
inlinenoexcept |
Returns a pointer to the null character that terminates this string.
Definition at line 205 of file juce_CharPointer_ASCII.h.
References length().
|
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().
|
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().
|
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().
|
inlinenoexcept |
Compares this string with another one.
Definition at line 239 of file juce_CharPointer_ASCII.h.
References juce::CharacterFunctions::compare().
|
inlinenoexcept |
Compares this string with another one.
Definition at line 245 of file juce_CharPointer_ASCII.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::data().
|
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().
|
inlinenoexcept |
Compares this string with another one, up to a specified number of characters.
Definition at line 258 of file juce_CharPointer_ASCII.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::data().
|
inline |
Compares this string with another one.
Definition at line 265 of file juce_CharPointer_ASCII.h.
References juce::CharacterFunctions::compareIgnoreCase().
|
inline |
Definition at line 270 of file juce_CharPointer_ASCII.h.
|
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().
|
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().
|
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.
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
inlinenoexcept |
Parses this string as a 32-bit integer.
Definition at line 337 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Parses this string as a 64-bit integer.
Definition at line 340 of file juce_CharPointer_ASCII.h.
|
inlinenoexcept |
Parses this string as a floating point double.
Definition at line 352 of file juce_CharPointer_ASCII.h.
References juce::CharacterFunctions::getDoubleValue().
|
inlinenoexcept |
Returns the first non-whitespace character in the string.
Definition at line 355 of file juce_CharPointer_ASCII.h.
References juce::CharacterFunctions::findEndOfWhitespace().
|
inlinestaticnoexcept |
Returns true if the given unicode character can be represented in this encoding.
Definition at line 358 of file juce_CharPointer_ASCII.h.
|
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(), juce::String::String(), and juce::StringRef::StringRef().