openshot-audio
0.1.2
|
#include <juce_String.h>
Public Member Functions | |
String () noexcept | |
String (const String &other) noexcept | |
String (const char *text) | |
String (const char *text, size_t maxChars) | |
String (const wchar_t *text) | |
String (const wchar_t *text, size_t maxChars) | |
String (const CharPointer_UTF8 text) | |
String (const CharPointer_UTF8 text, size_t maxChars) | |
String (const CharPointer_UTF8 start, const CharPointer_UTF8 end) | |
String (const CharPointer_UTF16 text) | |
String (const CharPointer_UTF16 text, size_t maxChars) | |
String (const CharPointer_UTF16 start, const CharPointer_UTF16 end) | |
String (const CharPointer_UTF32 text) | |
String (const CharPointer_UTF32 text, size_t maxChars) | |
String (const CharPointer_UTF32 start, const CharPointer_UTF32 end) | |
String (const CharPointer_ASCII text) | |
String (const std::string &) | |
~String () noexcept | |
int | hashCode () const noexcept |
int64 | hashCode64 () const noexcept |
size_t | hash () const noexcept |
int | length () const noexcept |
String & | operator= (const String &other) noexcept |
String & | operator+= (const String &stringToAppend) |
String & | operator+= (const char *textToAppend) |
String & | operator+= (const wchar_t *textToAppend) |
String & | operator+= (int numberToAppend) |
String & | operator+= (int64 numberToAppend) |
String & | operator+= (char characterToAppend) |
String & | operator+= (wchar_t characterToAppend) |
String & | operator+= (juce_wchar characterToAppend) |
void | append (const String &textToAppend, size_t maxCharsToTake) |
void | appendCharPointer (const CharPointerType startOfTextToAppend, const CharPointerType endOfTextToAppend) |
template<class CharPointer > | |
void | appendCharPointer (const CharPointer startOfTextToAppend, const CharPointer endOfTextToAppend) |
void | appendCharPointer (const CharPointerType textToAppend) |
template<class CharPointer > | |
void | appendCharPointer (const CharPointer textToAppend, size_t maxCharsToTake) |
template<class CharPointer > | |
void | appendCharPointer (const CharPointer textToAppend) |
bool | isEmpty () const noexcept |
bool | isNotEmpty () const noexcept |
void | clear () noexcept |
bool | equalsIgnoreCase (const String &other) const noexcept |
bool | equalsIgnoreCase (StringRef other) const noexcept |
bool | equalsIgnoreCase (const wchar_t *other) const noexcept |
bool | equalsIgnoreCase (const char *other) const noexcept |
int | compare (const String &other) const noexcept |
int | compare (const char *other) const noexcept |
int | compare (const wchar_t *other) const noexcept |
int | compareIgnoreCase (const String &other) const noexcept |
int | compareNatural (StringRef other) const noexcept |
bool | startsWith (StringRef text) const noexcept |
bool | startsWithChar (juce_wchar character) const noexcept |
bool | startsWithIgnoreCase (StringRef text) const noexcept |
bool | endsWith (StringRef text) const noexcept |
bool | endsWithChar (juce_wchar character) const noexcept |
bool | endsWithIgnoreCase (StringRef text) const noexcept |
bool | contains (StringRef text) const noexcept |
bool | containsChar (juce_wchar character) const noexcept |
bool | containsIgnoreCase (StringRef text) const noexcept |
bool | containsWholeWord (StringRef wordToLookFor) const noexcept |
bool | containsWholeWordIgnoreCase (StringRef wordToLookFor) const noexcept |
int | indexOfWholeWord (StringRef wordToLookFor) const noexcept |
int | indexOfWholeWordIgnoreCase (StringRef wordToLookFor) const noexcept |
bool | containsAnyOf (StringRef charactersItMightContain) const noexcept |
bool | containsOnly (StringRef charactersItMightContain) const noexcept |
bool | containsNonWhitespaceChars () const noexcept |
bool | matchesWildcard (StringRef wildcard, bool ignoreCase) const noexcept |
int | indexOfChar (juce_wchar characterToLookFor) const noexcept |
int | indexOfChar (int startIndex, juce_wchar characterToLookFor) const noexcept |
int | indexOfAnyOf (StringRef charactersToLookFor, int startIndex=0, bool ignoreCase=false) const noexcept |
int | indexOf (StringRef textToLookFor) const noexcept |
int | indexOf (int startIndex, StringRef textToLookFor) const noexcept |
int | indexOfIgnoreCase (StringRef textToLookFor) const noexcept |
int | indexOfIgnoreCase (int startIndex, StringRef textToLookFor) const noexcept |
int | lastIndexOfChar (juce_wchar character) const noexcept |
int | lastIndexOf (StringRef textToLookFor) const noexcept |
int | lastIndexOfIgnoreCase (StringRef textToLookFor) const noexcept |
int | lastIndexOfAnyOf (StringRef charactersToLookFor, bool ignoreCase=false) const noexcept |
juce_wchar | operator[] (int index) const noexcept |
juce_wchar | getLastCharacter () const noexcept |
String | substring (int startIndex, int endIndex) const |
String | substring (int startIndex) const |
String | dropLastCharacters (int numberToDrop) const |
String | getLastCharacters (int numCharacters) const |
String | fromFirstOccurrenceOf (StringRef substringToStartFrom, bool includeSubStringInResult, bool ignoreCase) const |
String | fromLastOccurrenceOf (StringRef substringToFind, bool includeSubStringInResult, bool ignoreCase) const |
String | upToFirstOccurrenceOf (StringRef substringToEndWith, bool includeSubStringInResult, bool ignoreCase) const |
String | upToLastOccurrenceOf (StringRef substringToFind, bool includeSubStringInResult, bool ignoreCase) const |
String | trim () const |
String | trimStart () const |
String | trimEnd () const |
String | trimCharactersAtStart (StringRef charactersToTrim) const |
String | trimCharactersAtEnd (StringRef charactersToTrim) const |
String | toUpperCase () const |
String | toLowerCase () const |
String | replaceSection (int startIndex, int numCharactersToReplace, StringRef stringToInsert) const |
String | replace (StringRef stringToReplace, StringRef stringToInsertInstead, bool ignoreCase=false) const |
String | replaceCharacter (juce_wchar characterToReplace, juce_wchar characterToInsertInstead) const |
String | replaceCharacters (StringRef charactersToReplace, StringRef charactersToInsertInstead) const |
String | retainCharacters (StringRef charactersToRetain) const |
String | removeCharacters (StringRef charactersToRemove) const |
String | initialSectionContainingOnly (StringRef permittedCharacters) const |
String | initialSectionNotContaining (StringRef charactersToStopAt) const |
bool | isQuotedString () const |
String | unquoted () const |
String | quoted (juce_wchar quoteCharacter='"') const |
String | paddedLeft (juce_wchar padCharacter, int minimumLength) const |
String | paddedRight (juce_wchar padCharacter, int minimumLength) const |
String (int decimalInteger) | |
String (unsigned int decimalInteger) | |
String (short decimalInteger) | |
String (unsigned short decimalInteger) | |
String (int64 largeIntegerValue) | |
String (uint64 largeIntegerValue) | |
String (float floatValue) | |
String (double doubleValue) | |
String (float floatValue, int numberOfDecimalPlaces) | |
String (double doubleValue, int numberOfDecimalPlaces) | |
int | getIntValue () const noexcept |
int64 | getLargeIntValue () const noexcept |
int | getTrailingIntValue () const noexcept |
float | getFloatValue () const noexcept |
double | getDoubleValue () const noexcept |
int | getHexValue32 () const noexcept |
int64 | getHexValue64 () const noexcept |
CharPointerType | getCharPointer () const noexcept |
CharPointer_UTF8 | toUTF8 () const |
const char * | toRawUTF8 () const |
CharPointer_UTF16 | toUTF16 () const |
CharPointer_UTF32 | toUTF32 () const |
const wchar_t * | toWideCharPointer () const |
std::string | toStdString () const |
size_t | getNumBytesAsUTF8 () const noexcept |
size_t | copyToUTF8 (CharPointer_UTF8::CharType *destBuffer, size_t maxBufferSizeBytes) const noexcept |
size_t | copyToUTF16 (CharPointer_UTF16::CharType *destBuffer, size_t maxBufferSizeBytes) const noexcept |
size_t | copyToUTF32 (CharPointer_UTF32::CharType *destBuffer, size_t maxBufferSizeBytes) const noexcept |
void | preallocateBytes (size_t numBytesNeeded) |
void | swapWith (String &other) noexcept |
int | getReferenceCount () const noexcept |
Static Public Member Functions | |
static String | charToString (juce_wchar character) |
static String | repeatedString (StringRef stringToRepeat, int numberOfTimesToRepeat) |
static String | createStringFromData (const void *data, int size) |
static String | formatted (const String formatString,...) |
static String | toHexString (int number) |
static String | toHexString (int64 number) |
static String | toHexString (short number) |
static String | toHexString (const void *data, int size, int groupSize=1) |
static String | fromUTF8 (const char *utf8buffer, int bufferSizeBytes=-1) |
Static Public Attributes | |
static const String | empty |
The JUCE String class!
Using a reference-counted internal representation, these strings are fast and efficient, and there are methods to do just about any operation you'll ever dream of.
|
noexcept |
Creates an empty string.
|
noexcept |
Creates a copy of another string.
String::String | ( | const char * | text | ) |
Creates a string from a zero-terminated ascii text string.
The string passed-in must not contain any characters with a value above 127, because these can't be converted to unicode without knowing the original encoding that was used to create the string. If you attempt to pass-in values above 127, you'll get an assertion.
To create strings with extended characters from UTF-8, you should explicitly call String (CharPointer_UTF8 ("my utf8 string..")). It's highly recommended that you use UTF-8 with escape characters in your source code to represent extended characters, because there's no other way to represent unicode strings in a way that isn't dependent on the compiler, source code editor and platform.
String::String | ( | const char * | text, |
size_t | maxChars | ||
) |
Creates a string from a string of 8-bit ascii characters.
The string passed-in must not contain any characters with a value above 127, because these can't be converted to unicode without knowing the original encoding that was used to create the string. If you attempt to pass-in values above 127, you'll get an assertion.
To create strings with extended characters from UTF-8, you should explicitly call String (CharPointer_UTF8 ("my utf8 string..")). It's highly recommended that you use UTF-8 with escape characters in your source code to represent extended characters, because there's no other way to represent unicode strings in a way that isn't dependent on the compiler, source code editor and platform.
This will use up to the first maxChars characters of the string (or less if the string is actually shorter).
String::String | ( | const wchar_t * | text | ) |
Creates a string from a wchar_t character string. Depending on the platform, this may be treated as either UTF-32 or UTF-16.
String::String | ( | const wchar_t * | text, |
size_t | maxChars | ||
) |
Creates a string from a wchar_t character string. Depending on the platform, this may be treated as either UTF-32 or UTF-16.
String::String | ( | const CharPointer_UTF8 | text | ) |
Creates a string from a UTF-8 character string
String::String | ( | const CharPointer_UTF8 | text, |
size_t | maxChars | ||
) |
Creates a string from a UTF-8 character string
String::String | ( | const CharPointer_UTF8 | start, |
const CharPointer_UTF8 | end | ||
) |
Creates a string from a UTF-8 character string
String::String | ( | const CharPointer_UTF16 | text | ) |
Creates a string from a UTF-16 character string
String::String | ( | const CharPointer_UTF16 | text, |
size_t | maxChars | ||
) |
Creates a string from a UTF-16 character string
String::String | ( | const CharPointer_UTF16 | start, |
const CharPointer_UTF16 | end | ||
) |
Creates a string from a UTF-16 character string
String::String | ( | const CharPointer_UTF32 | text | ) |
Creates a string from a UTF-32 character string
String::String | ( | const CharPointer_UTF32 | text, |
size_t | maxChars | ||
) |
Creates a string from a UTF-32 character string
String::String | ( | const CharPointer_UTF32 | start, |
const CharPointer_UTF32 | end | ||
) |
Creates a string from a UTF-32 character string
String::String | ( | const CharPointer_ASCII | text | ) |
Creates a string from an ASCII character string
String::String | ( | const std::string & | s | ) |
Creates a string from a UTF-8 encoded std::string.
|
noexcept |
Destructor.
|
explicit |
Creates a string containing this signed 32-bit integer as a decimal number.
|
explicit |
Creates a string containing this unsigned 32-bit integer as a decimal number.
|
explicit |
Creates a string containing this signed 16-bit integer as a decimal number.
|
explicit |
Creates a string containing this unsigned 16-bit integer as a decimal number.
|
explicit |
Creates a string containing this signed 64-bit integer as a decimal number.
|
explicit |
Creates a string containing this unsigned 64-bit integer as a decimal number.
|
explicit |
Creates a string representing this floating-point number.
floatValue | the value to convert to a string |
|
explicit |
Creates a string representing this floating-point number.
doubleValue | the value to convert to a string |
String::String | ( | float | floatValue, |
int | numberOfDecimalPlaces | ||
) |
Creates a string representing this floating-point number.
floatValue | the value to convert to a string |
numberOfDecimalPlaces | if this is > 0, it will format the number using that many decimal places, and will not use exponent notation. If 0 or less, it will use exponent notation if necessary. |
String::String | ( | double | doubleValue, |
int | numberOfDecimalPlaces | ||
) |
Creates a string representing this floating-point number.
doubleValue | the value to convert to a string |
numberOfDecimalPlaces | if this is > 0, it will format the number using that many decimal places, and will not use exponent notation. If 0 or less, it will use exponent notation if necessary. |
void String::append | ( | const String & | textToAppend, |
size_t | maxCharsToTake | ||
) |
Appends a string to the end of this one.
textToAppend | the string to add |
maxCharsToTake | the maximum number of characters to take from the string passed in |
void String::appendCharPointer | ( | const CharPointerType | startOfTextToAppend, |
const CharPointerType | endOfTextToAppend | ||
) |
Appends a string to the end of this one.
startOfTextToAppend | the start of the string to add. This must not be a nullptr |
endOfTextToAppend | the end of the string to add. This must not be a nullptr |
|
inline |
Appends a string to the end of this one.
startOfTextToAppend | the start of the string to add. This must not be a nullptr |
endOfTextToAppend | the end of the string to add. This must not be a nullptr |
void String::appendCharPointer | ( | const CharPointerType | textToAppend | ) |
Appends a string to the end of this one.
|
inline |
Appends a string to the end of this one.
textToAppend | the string to add |
maxCharsToTake | the maximum number of characters to take from the string passed in |
|
inline |
Appends a string to the end of this one.
|
static |
Creates a string from a single character.
|
noexcept |
Resets this string to be empty.
|
noexcept |
Case-sensitive comparison with another string.
|
noexcept |
Case-sensitive comparison with another string.
|
noexcept |
Case-sensitive comparison with another string.
|
noexcept |
Case-insensitive comparison with another string.
|
noexcept |
Compares two strings, taking into account textual characteristics like numbers and spaces.
This comparison is case-insensitive and can detect words and embedded numbers in the strings, making it good for sorting human-readable lists of things like filenames.
|
noexcept |
Tests whether the string contains another substring. If the parameter is an empty string, this will always return true. Uses a case-sensitive comparison.
|
noexcept |
Looks for any of a set of characters in the string. Uses a case-sensitive comparison.
|
noexcept |
Tests whether the string contains a particular character. Uses a case-sensitive comparison.
|
noexcept |
Tests whether the string contains another substring. Uses a case-insensitive comparison.
|
noexcept |
Returns true if this string contains any non-whitespace characters.
This will return false if the string contains only whitespace characters, or if it's empty.
It is equivalent to calling "myString.trim().isNotEmpty()".
|
noexcept |
Looks for a set of characters in the string. Uses a case-sensitive comparison.
|
noexcept |
Tests whether the string contains another substring as a distinct word.
|
noexcept |
Tests whether the string contains another substring as a distinct word.
|
noexcept |
Copies the string to a buffer as UTF-16 characters.
Returns the number of bytes copied to the buffer, including the terminating null character.
To find out how many bytes you need to store this string as UTF-16, you can call CharPointer_UTF16::getBytesRequiredFor (myString.getCharPointer())
destBuffer | the place to copy it to; if this is a null pointer, the method just returns the number of bytes required (including the terminating null character). |
maxBufferSizeBytes | the size of the destination buffer, in bytes. If the string won't fit, it'll put in as many as it can while still allowing for a terminating null char at the end, and will return the number of bytes that were actually used. |
|
noexcept |
Copies the string to a buffer as UTF-32 characters.
Returns the number of bytes copied to the buffer, including the terminating null character.
To find out how many bytes you need to store this string as UTF-32, you can call CharPointer_UTF32::getBytesRequiredFor (myString.getCharPointer())
destBuffer | the place to copy it to; if this is a null pointer, the method just returns the number of bytes required (including the terminating null character). |
maxBufferSizeBytes | the size of the destination buffer, in bytes. If the string won't fit, it'll put in as many as it can while still allowing for a terminating null char at the end, and will return the number of bytes that were actually used. |
|
noexcept |
Copies the string to a buffer as UTF-8 characters.
Returns the number of bytes copied to the buffer, including the terminating null character.
To find out how many bytes you need to store this string as UTF-8, you can call CharPointer_UTF8::getBytesRequiredFor (myString.getCharPointer())
destBuffer | the place to copy it to; if this is a null pointer, the method just returns the number of bytes required (including the terminating null character). |
maxBufferSizeBytes | the size of the destination buffer, in bytes. If the string won't fit, it'll put in as many as it can while still allowing for a terminating null char at the end, and will return the number of bytes that were actually used. |
|
static |
Creates a string from data in an unknown format.
This looks at some binary data and tries to guess whether it's Unicode or 8-bit characters, then returns a string that represents it correctly.
Should be able to handle Unicode endianness correctly, by looking at the first two bytes.
String String::dropLastCharacters | ( | int | numberToDrop | ) | const |
Returns a version of this string with a number of characters removed from the end.
numberToDrop | the number of characters to drop from the end of the string. If this is greater than the length of the string, an empty string will be returned. If zero or less, the original string will be returned. |
|
noexcept |
Tests whether the string ends with another string. If the parameter is an empty string, this will always return true. Uses a case-sensitive comparison.
|
noexcept |
Tests whether the string ends with a particular character. If the character is 0, this will always return false. Uses a case-sensitive comparison.
|
noexcept |
Tests whether the string ends with another string. If the parameter is an empty string, this will always return true. Uses a case-insensitive comparison.
|
noexcept |
Case-insensitive comparison with another string.
|
noexcept |
Case-insensitive comparison with another string.
|
noexcept |
Case-insensitive comparison with another string.
|
noexcept |
Case-insensitive comparison with another string.
Creates a String from a printf-style parameter list.
I don't like this method. I don't use it myself, and I recommend avoiding it and using the operator<< methods or pretty much anything else instead. It's only provided here because of the popular unrest that was stirred-up when I tried to remove it...
If you're really determined to use it, at least make sure that you never, ever, pass any String objects to it as parameters. And bear in mind that internally, depending on the platform, it may be using wchar_t or char character types, so that even string literals can't be safely used as parameters if you're writing portable code.
String String::fromFirstOccurrenceOf | ( | StringRef | substringToStartFrom, |
bool | includeSubStringInResult, | ||
bool | ignoreCase | ||
) | const |
Returns a section of the string starting from a given substring.
This will search for the first occurrence of the given substring, and return the section of the string starting from the point where this is found (optionally not including the substring itself).
e.g. for the string "123456", fromFirstOccurrenceOf ("34", true) would return "3456", and fromFirstOccurrenceOf ("34", false) would return "56".
If the substring isn't found, the method will return an empty string.
If ignoreCase is true, the comparison will be case-insensitive.
String String::fromLastOccurrenceOf | ( | StringRef | substringToFind, |
bool | includeSubStringInResult, | ||
bool | ignoreCase | ||
) | const |
Returns a section of the string starting from the last occurrence of a given substring.
Similar to fromFirstOccurrenceOf(), but using the last occurrence of the substring, and unlike fromFirstOccurrenceOf(), if the substring isn't found, this method will return the whole of the original string.
|
static |
Creates a String from a UTF-8 encoded buffer. If the size is < 0, it'll keep reading until it hits a zero.
|
inlinenoexcept |
Returns the character pointer currently being used to store this string.
Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.
|
noexcept |
Parses this string as a floating point number.
|
noexcept |
Parses this string as a floating point number.
|
noexcept |
Parses the string as a hexadecimal number.
Non-hexadecimal characters in the string are ignored.
If the string contains too many characters, then the lowest significant digits are returned, e.g. "ffff12345678" would produce 0x12345678.
|
noexcept |
Parses the string as a hexadecimal number.
Non-hexadecimal characters in the string are ignored.
If the string contains too many characters, then the lowest significant digits are returned, e.g. "ffff1234567812345678" would produce 0x1234567812345678.
|
noexcept |
Reads the value of the string as a decimal number (up to 32 bits in size).
|
noexcept |
Reads the value of the string as a decimal number (up to 64 bits in size).
|
noexcept |
Returns the final character of the string. If the string is empty this will return 0.
String String::getLastCharacters | ( | int | numCharacters | ) | const |
Returns a number of characters from the end of the string.
This returns the last numCharacters characters from the end of the string. If the string is shorter than numCharacters, the whole string is returned.
|
noexcept |
Returns the number of bytes required to represent this string as UTF8. The number returned does NOT include the trailing zero.
|
noexcept |
Returns the number of String objects which are currently sharing the same internal data as this one.
|
noexcept |
Parses a decimal number from the end of the string.
This will look for a value at the end of the string. e.g. for "321 xyz654" it will return 654; for "2 3 4" it'll return 4.
Negative numbers are not handled, so "xyz-5" returns 5.
|
noexcept |
Generates a probably-unique hashcode from this string.
|
noexcept |
This is the character encoding type used internally to store the string.
By setting the value of JUCE_STRING_UTF_TYPE to 8, 16, or 32, you can change the internal storage format of the String class. UTF-8 uses the least space (if your strings contain few extended characters), but call operator[] involves iterating the string to find the required index. UTF-32 provides instant random access to its characters, but uses 4 bytes per character to store them. UTF-16 uses more space than UTF-8 and is also slow to index, but is the native wchar_t format used in Windows.
It doesn't matter too much which format you pick, because the toUTF8(), toUTF16() and toUTF32() methods let you access the string's content in any of the other formats.Generates a probably-unique 32-bit hashcode from this string.
|
noexcept |
Generates a probably-unique 64-bit hashcode from this string.
|
noexcept |
Searches for a substring within this string. Uses a case-sensitive comparison.
|
noexcept |
Searches for a substring within this string. Uses a case-sensitive comparison.
startIndex | the index from which the search should proceed |
textToLookFor | the string to search for |
|
noexcept |
Returns the index of the first character that matches one of the characters passed-in to this method.
This scans the string, beginning from the startIndex supplied, and if it finds a character that appears in the string charactersToLookFor, it returns its index.
If none of these characters are found, it returns -1.
If ignoreCase is true, the comparison will be case-insensitive.
|
noexcept |
Searches for a character inside this string. Uses a case-sensitive comparison.
|
noexcept |
Searches for a character inside this string. Uses a case-sensitive comparison.
startIndex | the index from which the search should proceed |
characterToLookFor | the character to look for |
|
noexcept |
Searches for a substring within this string. Uses a case-insensitive comparison.
|
noexcept |
Searches for a substring within this string. Uses a case-insensitive comparison.
startIndex | the index from which the search should proceed |
textToLookFor | the string to search for |
|
noexcept |
Finds an instance of another substring if it exists as a distinct word.
|
noexcept |
Finds an instance of another substring if it exists as a distinct word.
Returns a section from the start of the string that only contains a certain set of characters.
This returns the leftmost section of the string, up to (and not including) the first character that doesn't appear in the string passed in.
Returns a section from the start of the string that only contains a certain set of characters.
This returns the leftmost section of the string, up to (and not including) the first character that occurs in the string passed in. (If none of the specified characters are found in the string, the return value will just be the original string).
|
inlinenoexcept |
Returns true if the string contains no characters. Note that there's also an isNotEmpty() method to help write readable code.
|
inlinenoexcept |
Returns true if the string contains at least one character. Note that there's also an isEmpty() method to help write readable code.
bool String::isQuotedString | ( | ) | const |
|
noexcept |
Searches for a substring inside this string (working backwards from the end of the string). Uses a case-sensitive comparison.
|
noexcept |
Returns the index of the last character in this string that matches one of the characters passed-in to this method.
This scans the string backwards, starting from its end, and if it finds a character that appears in the string charactersToLookFor, it returns its index.
If none of these characters are found, it returns -1.
If ignoreCase is true, the comparison will be case-insensitive.
|
noexcept |
Searches for a character inside this string (working backwards from the end of the string). Uses a case-sensitive comparison.
|
noexcept |
Searches for a substring inside this string (working backwards from the end of the string). Uses a case-insensitive comparison.
|
noexcept |
Returns the number of characters in the string.
|
noexcept |
Returns true if the string matches this simple wildcard expression.
So for example String ("abcdef").matchesWildcard ("*DEF", true) would return true.
This isn't a full-blown regex though! The only wildcard characters supported are "*" and "?". It's mainly intended for filename pattern matching.
Appends another string at the end of this one.
String & String::operator+= | ( | const char * | textToAppend | ) |
Appends another string at the end of this one.
String & String::operator+= | ( | const wchar_t * | textToAppend | ) |
Appends another string at the end of this one.
String & String::operator+= | ( | int | numberToAppend | ) |
Appends a decimal number at the end of this string.
Appends a decimal number at the end of this string.
String & String::operator+= | ( | char | characterToAppend | ) |
Appends a character at the end of this string.
String & String::operator+= | ( | wchar_t | characterToAppend | ) |
Appends a character at the end of this string.
String& String::operator+= | ( | juce_wchar | characterToAppend | ) |
Appends a character at the end of this string.
Replaces this string's contents with another string.
|
noexcept |
Returns the character at this index in the string. In a release build, no checks are made to see if the index is within a valid range, so be careful! In a debug build, the index is checked and an assertion fires if it's out-of-range.
Also beware that depending on the encoding format that the string is using internally, this method may execute in either O(1) or O(n) time, so be careful when using it in your algorithms. If you're scanning through a string to inspect its characters, you should never use this operator for random access, it's far more efficient to call getCharPointer() to return a pointer, and then to use that to iterate the string.
String String::paddedLeft | ( | juce_wchar | padCharacter, |
int | minimumLength | ||
) | const |
Returns a copy of this string with the specified character repeatedly added to its beginning until the total length is at least the minimum length specified.
String String::paddedRight | ( | juce_wchar | padCharacter, |
int | minimumLength | ||
) | const |
Returns a copy of this string with the specified character repeatedly added to its end until the total length is at least the minimum length specified.
void String::preallocateBytes | ( | size_t | numBytesNeeded | ) |
Increases the string's internally allocated storage.
Although the string's contents won't be affected by this call, it will increase the amount of memory allocated internally for the string to grow into.
If you're about to make a large number of calls to methods such as += or <<, it's more efficient to preallocate enough extra space beforehand, so that these methods won't have to keep resizing the string to append the extra characters.
numBytesNeeded | the number of bytes to allocate storage for. If this value is less than the currently allocated size, it will have no effect. |
String String::quoted | ( | juce_wchar | quoteCharacter = '"' | ) | const |
Adds quotation marks around a string.
This will return a copy of the string with a quote at the start and end, (but won't add the quote if there's already one there, so it's safe to call this on strings that may already have quotes around them).
Note that this is a const method, and won't alter the string itself.
quoteCharacter | the character to add at the start and end |
Returns a version of this string with a set of characters removed.
This will return a copy of this string, omitting any characters which are found in the string passed-in.
e.g. for "1122334455", removeCharacters ("432") would return "1155"
Note that this is a const method, and won't alter the string itself.
Creates a string which is a version of a string repeated and joined together.
stringToRepeat | the string to repeat |
numberOfTimesToRepeat | how many times to repeat it |
String String::replace | ( | StringRef | stringToReplace, |
StringRef | stringToInsertInstead, | ||
bool | ignoreCase = false |
||
) | const |
Replaces all occurrences of a substring with another string.
Returns a copy of this string, with any occurrences of stringToReplace swapped for stringToInsertInstead.
Note that this is a const method, and won't alter the string itself.
String String::replaceCharacter | ( | juce_wchar | characterToReplace, |
juce_wchar | characterToInsertInstead | ||
) | const |
Returns a string with all occurrences of a character replaced with a different one.
String String::replaceCharacters | ( | StringRef | charactersToReplace, |
StringRef | charactersToInsertInstead | ||
) | const |
Replaces a set of characters with another set.
Returns a string in which each character from charactersToReplace has been replaced by the character at the equivalent position in newCharacters (so the two strings passed in must be the same length).
e.g. replaceCharacters ("abc", "def") replaces 'a' with 'd', 'b' with 'e', etc.
Note that this is a const method, and won't affect the string itself.
String String::replaceSection | ( | int | startIndex, |
int | numCharactersToReplace, | ||
StringRef | stringToInsert | ||
) | const |
Replaces a sub-section of the string with another string.
This will return a copy of this string, with a set of characters from startIndex to startIndex + numCharsToReplace removed, and with a new string inserted in their place.
Note that this is a const method, and won't alter the string itself.
startIndex | the first character to remove. If this is beyond the bounds of the string, it will be constrained to a valid range. |
numCharactersToReplace | the number of characters to remove. If zero or less, no characters will be taken out. |
stringToInsert | the new string to insert at startIndex after the characters have been removed. |
Returns a version of this string that only retains a fixed set of characters.
This will return a copy of this string, omitting any characters which are not found in the string passed-in.
e.g. for "1122334455", retainCharacters ("432") would return "223344"
Note that this is a const method, and won't alter the string itself.
|
noexcept |
Tests whether the string begins with another string. If the parameter is an empty string, this will always return true. Uses a case-sensitive comparison.
|
noexcept |
Tests whether the string begins with a particular character. If the character is 0, this will always return false. Uses a case-sensitive comparison.
|
noexcept |
Tests whether the string begins with another string. If the parameter is an empty string, this will always return true. Uses a case-insensitive comparison.
String String::substring | ( | int | startIndex, |
int | endIndex | ||
) | const |
Returns a subsection of the string.
If the range specified is beyond the limits of the string, as much as possible is returned.
startIndex | the index of the start of the substring needed |
endIndex | all characters from startIndex up to (but not including) this index are returned |
String String::substring | ( | int | startIndex | ) | const |
Returns a section of the string, starting from a given position.
startIndex | the first character to include. If this is beyond the end of the string, an empty string is returned. If it is zero or less, the whole string is returned. |
|
noexcept |
Swaps the contents of this string with another one. This is a very fast operation, as no allocation or copying needs to be done.
|
static |
Creates a string representing this 32-bit value in hexadecimal.
Creates a string representing this 64-bit value in hexadecimal.
|
static |
Creates a string representing this 16-bit value in hexadecimal.
|
static |
Creates a string containing a hex dump of a block of binary data.
data | the binary data to use as input |
size | how many bytes of data to use |
groupSize | how many bytes are grouped together before inserting a space into the output. e.g. group size 0 has no spaces, group size 1 looks like: "be a1 c2 ff", group size 2 looks like "bea1 c2ff". |
String String::toLowerCase | ( | ) | const |
Returns an lower-case version of this string.
const char * String::toRawUTF8 | ( | ) | const |
Returns a pointer to a UTF-8 version of this string.
Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.
To find out how many bytes you need to store this string as UTF-8, you can call CharPointer_UTF8::getBytesRequiredFor (myString.getCharPointer())
std::string String::toStdString | ( | ) | const |
String String::toUpperCase | ( | ) | const |
Returns an upper-case version of this string.
CharPointer_UTF16 String::toUTF16 | ( | ) | const |
Returns a pointer to a UTF-16 version of this string.
Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.
To find out how many bytes you need to store this string as UTF-16, you can call CharPointer_UTF16::getBytesRequiredFor (myString.getCharPointer())
CharPointer_UTF32 String::toUTF32 | ( | ) | const |
Returns a pointer to a UTF-32 version of this string.
Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.
CharPointer_UTF8 String::toUTF8 | ( | ) | const |
Returns a pointer to a UTF-8 version of this string.
Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.
To find out how many bytes you need to store this string as UTF-8, you can call CharPointer_UTF8::getBytesRequiredFor (myString.getCharPointer())
const wchar_t * String::toWideCharPointer | ( | ) | const |
Returns a pointer to a wchar_t version of this string.
Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.
Bear in mind that the wchar_t type is different on different platforms, so on Windows, this will be equivalent to calling toUTF16(), on unix it'll be the same as calling toUTF32(), etc.
String String::trim | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the start and end.
Returns a copy of this string, having removed a specified set of characters from its end. Characters are removed from the end of the string until it finds one that is not in the specified set, and then it stops.
charactersToTrim | the set of characters to remove. |
Returns a copy of this string, having removed a specified set of characters from its start. Characters are removed from the start of the string until it finds one that is not in the specified set, and then it stops.
charactersToTrim | the set of characters to remove. |
String String::trimEnd | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the end.
String String::trimStart | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the start.
String String::unquoted | ( | ) | const |
Removes quotation marks from around the string, (if there are any).
Returns a copy of this string with any quotes removed from its ends. Quotes that aren't at the ends of the string are not affected. If there aren't any quotes, the original string is returned.
Note that this is a const method, and won't alter the string itself.
String String::upToFirstOccurrenceOf | ( | StringRef | substringToEndWith, |
bool | includeSubStringInResult, | ||
bool | ignoreCase | ||
) | const |
Returns the start of this string, up to the first occurrence of a substring.
This will search for the first occurrence of a given substring, and then return a copy of the string, up to the position of this substring, optionally including or excluding the substring itself in the result.
e.g. for the string "123456", upTo ("34", false) would return "12", and upTo ("34", true) would return "1234".
If the substring isn't found, this will return the whole of the original string.
String String::upToLastOccurrenceOf | ( | StringRef | substringToFind, |
bool | includeSubStringInResult, | ||
bool | ignoreCase | ||
) | const |
Returns the start of this string, up to the last occurrence of a substring.
Similar to upToFirstOccurrenceOf(), but this finds the last occurrence rather than the first. If the substring isn't found, this will return the whole of the original string.
|
static |
This is an empty string that can be used whenever one is needed.
It's better to use this than String() because it explains what's going on and is more efficient.