OpenShot Library | libopenshot-audio 0.2.0
|
The JUCE String class! More...
#include <juce_String.h>
Public Types | |
using | CharPointerType = CharPointer_UTF8 |
This is the character encoding type used internally to store the string. | |
Public Member Functions | |
String () noexcept | |
Creates an empty string. | |
String (const String &) noexcept | |
Creates a copy of another string. | |
String (String &&) noexcept | |
Move constructor. | |
String (const char *text) | |
Creates a string from a zero-terminated ascii text string. | |
String (const char *text, size_t maxChars) | |
Creates a string from a string of 8-bit ascii characters. | |
String (const wchar_t *text) | |
Creates a string from a wchar_t character string. | |
String (const wchar_t *text, size_t maxChars) | |
Creates a string from a wchar_t character string. | |
String (CharPointer_UTF8 text) | |
Creates a string from a UTF-8 character string. | |
String (CharPointer_UTF8 text, size_t maxChars) | |
Creates a string from a UTF-8 character string. | |
String (CharPointer_UTF8 start, CharPointer_UTF8 end) | |
Creates a string from a UTF-8 character string. | |
String (CharPointer_UTF16 text) | |
Creates a string from a UTF-16 character string. | |
String (CharPointer_UTF16 text, size_t maxChars) | |
Creates a string from a UTF-16 character string. | |
String (CharPointer_UTF16 start, CharPointer_UTF16 end) | |
Creates a string from a UTF-16 character string. | |
String (CharPointer_UTF32 text) | |
Creates a string from a UTF-32 character string. | |
String (CharPointer_UTF32 text, size_t maxChars) | |
Creates a string from a UTF-32 character string. | |
String (CharPointer_UTF32 start, CharPointer_UTF32 end) | |
Creates a string from a UTF-32 character string. | |
String (CharPointer_ASCII text) | |
Creates a string from an ASCII character string. | |
String (const std::string &) | |
Creates a string from a UTF-8 encoded std::string. | |
String (StringRef) | |
Creates a string from a StringRef. | |
~String () noexcept | |
Destructor. | |
int | hashCode () const noexcept |
Generates a probably-unique 32-bit hashcode from this string. | |
int64 | hashCode64 () const noexcept |
Generates a probably-unique 64-bit hashcode from this string. | |
size_t | hash () const noexcept |
Generates a probably-unique hashcode from this string. | |
int | length () const noexcept |
Returns the number of characters in the string. | |
String & | operator= (const String &other) noexcept |
Replaces this string's contents with another string. | |
String & | operator= (String &&other) noexcept |
Moves the contents of another string to the receiver. | |
String & | operator+= (const String &stringToAppend) |
Appends another string at the end of this one. | |
String & | operator+= (const char *textToAppend) |
Appends another string at the end of this one. | |
String & | operator+= (const wchar_t *textToAppend) |
Appends another string at the end of this one. | |
String & | operator+= (StringRef textToAppend) |
Appends another string at the end of this one. | |
String & | operator+= (int numberToAppend) |
Appends a decimal number at the end of this string. | |
String & | operator+= (long numberToAppend) |
Appends a decimal number at the end of this string. | |
String & | operator+= (int64 numberToAppend) |
Appends a decimal number at the end of this string. | |
String & | operator+= (uint64 numberToAppend) |
Appends a decimal number at the end of this string. | |
String & | operator+= (char characterToAppend) |
Appends a character at the end of this string. | |
String & | operator+= (wchar_t characterToAppend) |
Appends a character at the end of this string. | |
String & | operator+= (juce_wchar characterToAppend) |
Appends a character at the end of this string. | |
void | append (const String &textToAppend, size_t maxCharsToTake) |
Appends a string to the end of this one. | |
void | appendCharPointer (CharPointerType startOfTextToAppend, CharPointerType endOfTextToAppend) |
Appends a string to the end of this one. | |
template<class CharPointer > | |
void | appendCharPointer (CharPointer startOfTextToAppend, CharPointer endOfTextToAppend) |
Appends a string to the end of this one. | |
void | appendCharPointer (CharPointerType textToAppend) |
Appends a string to the end of this one. | |
template<class CharPointer > | |
void | appendCharPointer (CharPointer textToAppend, size_t maxCharsToTake) |
Appends a string to the end of this one. | |
template<class CharPointer > | |
void | appendCharPointer (CharPointer textToAppend) |
Appends a string to the end of this one. | |
bool | isEmpty () const noexcept |
Returns true if the string contains no characters. | |
bool | isNotEmpty () const noexcept |
Returns true if the string contains at least one character. | |
void | clear () noexcept |
Resets this string to be empty. | |
bool | equalsIgnoreCase (const String &other) const noexcept |
Case-insensitive comparison with another string. | |
bool | equalsIgnoreCase (StringRef other) const noexcept |
Case-insensitive comparison with another string. | |
bool | equalsIgnoreCase (const wchar_t *other) const noexcept |
Case-insensitive comparison with another string. | |
bool | equalsIgnoreCase (const char *other) const noexcept |
Case-insensitive comparison with another string. | |
int | compare (const String &other) const noexcept |
Case-sensitive comparison with another string. | |
int | compare (const char *other) const noexcept |
Case-sensitive comparison with another string. | |
int | compare (const wchar_t *other) const noexcept |
Case-sensitive comparison with another string. | |
int | compareIgnoreCase (const String &other) const noexcept |
Case-insensitive comparison with another string. | |
int | compareNatural (StringRef other, bool isCaseSensitive=false) const noexcept |
Compares two strings, taking into account textual characteristics like numbers and spaces. | |
bool | startsWith (StringRef text) const noexcept |
Tests whether the string begins with another string. | |
bool | startsWithChar (juce_wchar character) const noexcept |
Tests whether the string begins with a particular character. | |
bool | startsWithIgnoreCase (StringRef text) const noexcept |
Tests whether the string begins with another string. | |
bool | endsWith (StringRef text) const noexcept |
Tests whether the string ends with another string. | |
bool | endsWithChar (juce_wchar character) const noexcept |
Tests whether the string ends with a particular character. | |
bool | endsWithIgnoreCase (StringRef text) const noexcept |
Tests whether the string ends with another string. | |
bool | contains (StringRef text) const noexcept |
Tests whether the string contains another substring. | |
bool | containsChar (juce_wchar character) const noexcept |
Tests whether the string contains a particular character. | |
bool | containsIgnoreCase (StringRef text) const noexcept |
Tests whether the string contains another substring. | |
bool | containsWholeWord (StringRef wordToLookFor) const noexcept |
Tests whether the string contains another substring as a distinct word. | |
bool | containsWholeWordIgnoreCase (StringRef wordToLookFor) const noexcept |
Tests whether the string contains another substring as a distinct word. | |
int | indexOfWholeWord (StringRef wordToLookFor) const noexcept |
Finds an instance of another substring if it exists as a distinct word. | |
int | indexOfWholeWordIgnoreCase (StringRef wordToLookFor) const noexcept |
Finds an instance of another substring if it exists as a distinct word. | |
bool | containsAnyOf (StringRef charactersItMightContain) const noexcept |
Looks for any of a set of characters in the string. | |
bool | containsOnly (StringRef charactersItMightContain) const noexcept |
Looks for a set of characters in the string. | |
bool | containsNonWhitespaceChars () const noexcept |
Returns true if this string contains any non-whitespace characters. | |
bool | matchesWildcard (StringRef wildcard, bool ignoreCase) const noexcept |
Returns true if the string matches this simple wildcard expression. | |
int | indexOfChar (juce_wchar characterToLookFor) const noexcept |
Searches for a character inside this string. | |
int | indexOfChar (int startIndex, juce_wchar characterToLookFor) const noexcept |
Searches for a character inside this string. | |
int | indexOfAnyOf (StringRef charactersToLookFor, int startIndex=0, bool ignoreCase=false) const noexcept |
Returns the index of the first character that matches one of the characters passed-in to this method. | |
int | indexOf (StringRef textToLookFor) const noexcept |
Searches for a substring within this string. | |
int | indexOf (int startIndex, StringRef textToLookFor) const noexcept |
Searches for a substring within this string. | |
int | indexOfIgnoreCase (StringRef textToLookFor) const noexcept |
Searches for a substring within this string. | |
int | indexOfIgnoreCase (int startIndex, StringRef textToLookFor) const noexcept |
Searches for a substring within this string. | |
int | lastIndexOfChar (juce_wchar character) const noexcept |
Searches for a character inside this string (working backwards from the end of the string). | |
int | lastIndexOf (StringRef textToLookFor) const noexcept |
Searches for a substring inside this string (working backwards from the end of the string). | |
int | lastIndexOfIgnoreCase (StringRef textToLookFor) const noexcept |
Searches for a substring inside this string (working backwards from the end of the string). | |
int | lastIndexOfAnyOf (StringRef charactersToLookFor, bool ignoreCase=false) const noexcept |
Returns the index of the last character in this string that matches one of the characters passed-in to this method. | |
juce_wchar | operator[] (int index) const noexcept |
Returns the character at this index in the string. | |
juce_wchar | getLastCharacter () const noexcept |
Returns the final character of the string. | |
String | substring (int startIndex, int endIndex) const |
Returns a subsection of the string. | |
String | substring (int startIndex) const |
Returns a section of the string, starting from a given position. | |
String | dropLastCharacters (int numberToDrop) const |
Returns a version of this string with a number of characters removed from the end. | |
String | getLastCharacters (int numCharacters) const |
Returns a number of characters from the end of the string. | |
String | fromFirstOccurrenceOf (StringRef substringToStartFrom, bool includeSubStringInResult, bool ignoreCase) const |
Returns a section of the string starting from a given substring. | |
String | fromLastOccurrenceOf (StringRef substringToFind, bool includeSubStringInResult, bool ignoreCase) const |
Returns a section of the string starting from the last occurrence of a given substring. | |
String | upToFirstOccurrenceOf (StringRef substringToEndWith, bool includeSubStringInResult, bool ignoreCase) const |
Returns the start of this string, up to the first occurrence of a substring. | |
String | upToLastOccurrenceOf (StringRef substringToFind, bool includeSubStringInResult, bool ignoreCase) const |
Returns the start of this string, up to the last occurrence of a substring. | |
String | trim () const |
Returns a copy of this string with any whitespace characters removed from the start and end. | |
String | trimStart () const |
Returns a copy of this string with any whitespace characters removed from the start. | |
String | trimEnd () const |
Returns a copy of this string with any whitespace characters removed from the end. | |
String | trimCharactersAtStart (StringRef charactersToTrim) const |
Returns a copy of this string, having removed a specified set of characters from its start. | |
String | trimCharactersAtEnd (StringRef charactersToTrim) const |
Returns a copy of this string, having removed a specified set of characters from its end. | |
String | toUpperCase () const |
Returns an upper-case version of this string. | |
String | toLowerCase () const |
Returns an lower-case version of this string. | |
String | replaceSection (int startIndex, int numCharactersToReplace, StringRef stringToInsert) const |
Replaces a sub-section of the string with another string. | |
String | replace (StringRef stringToReplace, StringRef stringToInsertInstead, bool ignoreCase=false) const |
Replaces all occurrences of a substring with another string. | |
String | replaceFirstOccurrenceOf (StringRef stringToReplace, StringRef stringToInsertInstead, bool ignoreCase=false) const |
Replaces the first occurrence of a substring with another 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 | replaceCharacters (StringRef charactersToReplace, StringRef charactersToInsertInstead) const |
Replaces a set of characters with another set. | |
String | retainCharacters (StringRef charactersToRetain) const |
Returns a version of this string that only retains a fixed set of characters. | |
String | removeCharacters (StringRef charactersToRemove) const |
Returns a version of this string with a set of characters removed. | |
String | initialSectionContainingOnly (StringRef permittedCharacters) const |
Returns a section from the start of the string that only contains a certain set of characters. | |
String | initialSectionNotContaining (StringRef charactersToStopAt) const |
Returns a section from the start of the string that only contains a certain set of characters. | |
bool | isQuotedString () const |
Checks whether the string might be in quotation marks. | |
String | unquoted () const |
Removes quotation marks from around the string, (if there are any). | |
String | quoted (juce_wchar quoteCharacter='"') const |
Adds quotation marks around a 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 | 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. | |
String (int decimalInteger) | |
Creates a string containing this signed 32-bit integer as a decimal number. | |
String (unsigned int decimalInteger) | |
Creates a string containing this unsigned 32-bit integer as a decimal number. | |
String (short decimalInteger) | |
Creates a string containing this signed 16-bit integer as a decimal number. | |
String (unsigned short decimalInteger) | |
Creates a string containing this unsigned 16-bit integer as a decimal number. | |
String (int64 largeIntegerValue) | |
Creates a string containing this signed 64-bit integer as a decimal number. | |
String (uint64 largeIntegerValue) | |
Creates a string containing this unsigned 64-bit integer as a decimal number. | |
String (long decimalInteger) | |
Creates a string containing this signed long integer as a decimal number. | |
String (unsigned long decimalInteger) | |
Creates a string containing this unsigned long integer as a decimal number. | |
String (float floatValue) | |
Creates a string representing this floating-point number. | |
String (double doubleValue) | |
Creates a string representing this floating-point number. | |
String (float floatValue, int numberOfDecimalPlaces, bool useScientificNotation=false) | |
Creates a string representing this floating-point number. | |
String (double doubleValue, int numberOfDecimalPlaces, bool useScientificNotation=false) | |
Creates a string representing this floating-point number. | |
String (bool)=delete | |
int | getIntValue () const noexcept |
Reads the value of the string as a decimal number (up to 32 bits in size). | |
int64 | getLargeIntValue () const noexcept |
Reads the value of the string as a decimal number (up to 64 bits in size). | |
int | getTrailingIntValue () const noexcept |
Parses a decimal number from the end of the string. | |
float | getFloatValue () const noexcept |
Parses this string as a floating point number. | |
double | getDoubleValue () const noexcept |
Parses this string as a floating point number. | |
int | getHexValue32 () const noexcept |
Parses the string as a hexadecimal number. | |
int64 | getHexValue64 () const noexcept |
Parses the string as a hexadecimal number. | |
CharPointerType | getCharPointer () const noexcept |
Returns the character pointer currently being used to store this string. | |
CharPointer_UTF8 | toUTF8 () const |
Returns a pointer to a UTF-8 version of this string. | |
const char * | toRawUTF8 () const |
Returns a pointer to a UTF-8 version of this string. | |
CharPointer_UTF16 | toUTF16 () const |
Returns a pointer to a UTF-16 version of this string. | |
CharPointer_UTF32 | toUTF32 () const |
Returns a pointer to a UTF-32 version of this string. | |
const wchar_t * | toWideCharPointer () const |
Returns a pointer to a wchar_t version of this string. | |
std::string | toStdString () const |
size_t | getNumBytesAsUTF8 () const noexcept |
Returns the number of bytes required to represent this string as UTF8. | |
size_t | copyToUTF8 (CharPointer_UTF8::CharType *destBuffer, size_t maxBufferSizeBytes) const noexcept |
Copies the string to a buffer as UTF-8 characters. | |
size_t | copyToUTF16 (CharPointer_UTF16::CharType *destBuffer, size_t maxBufferSizeBytes) const noexcept |
Copies the string to a buffer as UTF-16 characters. | |
size_t | copyToUTF32 (CharPointer_UTF32::CharType *destBuffer, size_t maxBufferSizeBytes) const noexcept |
Copies the string to a buffer as UTF-32 characters. | |
void | preallocateBytes (size_t numBytesNeeded) |
Increases the string's internally allocated storage. | |
void | swapWith (String &other) noexcept |
Swaps the contents of this string with another one. | |
CFStringRef | toCFString () const |
OSX ONLY - Converts this string to a CFString. | |
String | convertToPrecomposedUnicode () const |
OSX ONLY - Returns a copy of this string in which any decomposed unicode characters have been converted to their precomposed equivalents. | |
int | getReferenceCount () const noexcept |
Returns the number of String objects which are currently sharing the same internal data as this one. | |
Static Public Member Functions | |
static String | charToString (juce_wchar character) |
Creates a string from a single character. | |
static String | repeatedString (StringRef stringToRepeat, int numberOfTimesToRepeat) |
Creates a string which is a version of a string repeated and joined together. | |
static String | createStringFromData (const void *data, int size) |
Creates a string from data in an unknown format. | |
template<typename... Args> | |
static String | formatted (const String &formatStr, Args... args) |
Creates a String from a printf-style parameter list. | |
template<typename IntegerType > | |
static String | toHexString (IntegerType number) |
Returns a string representing this numeric value in hexadecimal. | |
static String | toHexString (const void *data, int size, int groupSize=1) |
Returns a string containing a hex dump of a block of binary data. | |
template<typename DecimalType > | |
static String | toDecimalStringWithSignificantFigures (DecimalType number, int numberOfSignificantFigures) |
Returns a string containing a decimal with a set number of significant figures. | |
static String | fromUTF8 (const char *utf8buffer, int bufferSizeBytes=-1) |
Creates a String from a UTF-8 encoded buffer. | |
static String | fromCFString (CFStringRef cfString) |
OSX ONLY - Creates a String from an OSX CFString. | |
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.
Definition at line 42 of file juce_String.h.
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.
Definition at line 164 of file juce_String.h.
|
noexcept |
Creates an empty string.
Definition at line 241 of file juce_String.cpp.
Referenced by dropLastCharacters(), fromUTF8(), getLastCharacters(), initialSectionContainingOnly(), initialSectionNotContaining(), substring(), substring(), trim(), trimCharactersAtEnd(), trimCharactersAtStart(), trimEnd(), and trimStart().
|
noexcept |
Creates a copy of another string.
Definition at line 250 of file juce_String.cpp.
|
noexcept |
Move constructor.
Definition at line 273 of file juce_String.cpp.
juce::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.
Definition at line 302 of file juce_String.cpp.
References juce::CharPointer_ASCII::isValidString().
juce::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).
Definition at line 325 of file juce_String.cpp.
References juce::CharPointer_ASCII::isValidString().
juce::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.
Definition at line 348 of file juce_String.cpp.
juce::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.
Definition at line 357 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF8 | text | ) |
Creates a string from a UTF-8 character string.
Definition at line 349 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF8 | text, |
size_t | maxChars | ||
) |
Creates a string from a UTF-8 character string.
Definition at line 354 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF8 | start, |
CharPointer_UTF8 | end | ||
) |
Creates a string from a UTF-8 character string.
Definition at line 359 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF16 | text | ) |
Creates a string from a UTF-16 character string.
Definition at line 350 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF16 | text, |
size_t | maxChars | ||
) |
Creates a string from a UTF-16 character string.
Definition at line 355 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF16 | start, |
CharPointer_UTF16 | end | ||
) |
Creates a string from a UTF-16 character string.
Definition at line 360 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF32 | text | ) |
Creates a string from a UTF-32 character string.
Definition at line 351 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF32 | text, |
size_t | maxChars | ||
) |
Creates a string from a UTF-32 character string.
Definition at line 356 of file juce_String.cpp.
juce::String::String | ( | CharPointer_UTF32 | start, |
CharPointer_UTF32 | end | ||
) |
Creates a string from a UTF-32 character string.
Definition at line 361 of file juce_String.cpp.
juce::String::String | ( | CharPointer_ASCII | text | ) |
Creates a string from an ASCII character string.
Definition at line 352 of file juce_String.cpp.
juce::String::String | ( | const std::string & | s | ) |
Creates a string from a UTF-8 encoded std::string.
Definition at line 363 of file juce_String.cpp.
juce::String::String | ( | StringRef | s | ) |
Creates a string from a StringRef.
Definition at line 364 of file juce_String.cpp.
|
noexcept |
Destructor.
Definition at line 245 of file juce_String.cpp.
|
explicit |
Creates a string containing this signed 32-bit integer as a decimal number.
Definition at line 503 of file juce_String.cpp.
|
explicit |
Creates a string containing this unsigned 32-bit integer as a decimal number.
Definition at line 504 of file juce_String.cpp.
|
explicit |
Creates a string containing this signed 16-bit integer as a decimal number.
Definition at line 505 of file juce_String.cpp.
|
explicit |
Creates a string containing this unsigned 16-bit integer as a decimal number.
Definition at line 506 of file juce_String.cpp.
|
explicit |
Creates a string containing this signed 64-bit integer as a decimal number.
Definition at line 507 of file juce_String.cpp.
|
explicit |
Creates a string containing this unsigned 64-bit integer as a decimal number.
Definition at line 508 of file juce_String.cpp.
|
explicit |
Creates a string containing this signed long integer as a decimal number.
Definition at line 509 of file juce_String.cpp.
|
explicit |
Creates a string containing this unsigned long integer as a decimal number.
Definition at line 510 of file juce_String.cpp.
|
explicit |
Creates a string representing this floating-point number.
floatValue | the value to convert to a string |
Definition at line 512 of file juce_String.cpp.
|
explicit |
Creates a string representing this floating-point number.
doubleValue | the value to convert to a string |
Definition at line 513 of file juce_String.cpp.
juce::String::String | ( | float | floatValue, |
int | numberOfDecimalPlaces, | ||
bool | useScientificNotation = false |
||
) |
Creates a string representing this floating-point number.
floatValue | the value to convert to a string |
numberOfDecimalPlaces | if this is > 0 the number will be formatted using that many decimal places, adding trailing zeros as required. If 0 or less the number will be formatted using the C++ standard library default format, which uses scientific notation for large and small numbers. |
useScientificNotation | if the number should be formatted using scientific notation |
Definition at line 514 of file juce_String.cpp.
juce::String::String | ( | double | doubleValue, |
int | numberOfDecimalPlaces, | ||
bool | useScientificNotation = false |
||
) |
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, adding trailing zeros as required, and will not use exponent notation. If 0 or less, it will use exponent notation if necessary. |
useScientificNotation | if the number should be formatted using scientific notation |
Definition at line 515 of file juce_String.cpp.
|
static |
Creates a string from a single character.
Definition at line 366 of file juce_String.cpp.
References juce::CharPointer_UTF8::getBytesRequiredFor(), juce::CharPointer_UTF8::write(), and juce::CharPointer_UTF8::writeNull().
Referenced by createStringFromData(), quoted(), and juce::BigInteger::toString().
|
noexcept |
Generates a probably-unique 32-bit hashcode from this string.
Definition at line 556 of file juce_String.cpp.
Referenced by juce::File::hashCode().
|
noexcept |
Generates a probably-unique 64-bit hashcode from this string.
Definition at line 557 of file juce_String.cpp.
Referenced by juce::URLInputSource::hashCode(), and juce::File::hashCode64().
|
noexcept |
Generates a probably-unique hashcode from this string.
Definition at line 558 of file juce_String.cpp.
|
noexcept |
Returns the number of characters in the string.
Definition at line 518 of file juce_String.cpp.
References juce::CharPointer_UTF8::length().
Referenced by juce::File::createLegalFileName(), dropLastCharacters(), juce::AudioChannelSet::getChannelTypeFromAbbreviation(), getLastCharacter(), getLastCharacters(), juce::File::hasFileExtension(), juce::File::isAChildOf(), juce::URL::isProbablyAWebsiteURL(), juce::MemoryBlock::toBase64Encoding(), and unquoted().
Replaces this string's contents with another string.
Definition at line 266 of file juce_String.cpp.
Referenced by operator+=().
Moves the contents of another string to the receiver.
Definition at line 278 of file juce_String.cpp.
Appends another string at the end of this one.
Definition at line 756 of file juce_String.cpp.
References appendCharPointer(), isEmpty(), operator+=(), and operator=().
Referenced by operator+=(), operator+=(), operator+=(), and operator+=().
String & juce::String::operator+= | ( | const char * | textToAppend | ) |
Appends another string at the end of this one.
Definition at line 750 of file juce_String.cpp.
References appendCharPointer().
String & juce::String::operator+= | ( | const wchar_t * | textToAppend | ) |
Appends another string at the end of this one.
Definition at line 744 of file juce_String.cpp.
References appendCharPointer().
Appends another string at the end of this one.
Definition at line 768 of file juce_String.cpp.
References operator+=().
String & juce::String::operator+= | ( | int | numberToAppend | ) |
Appends a decimal number at the end of this string.
Definition at line 813 of file juce_String.cpp.
String & juce::String::operator+= | ( | int64 | numberToAppend | ) |
Appends a decimal number at the end of this string.
Definition at line 814 of file juce_String.cpp.
String & juce::String::operator+= | ( | uint64 | numberToAppend | ) |
Appends a decimal number at the end of this string.
Definition at line 815 of file juce_String.cpp.
String & juce::String::operator+= | ( | char | characterToAppend | ) |
Appends a character at the end of this string.
Definition at line 773 of file juce_String.cpp.
References operator+=().
String & juce::String::operator+= | ( | wchar_t | characterToAppend | ) |
Appends a character at the end of this string.
Definition at line 779 of file juce_String.cpp.
References operator+=().
void juce::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 |
Definition at line 713 of file juce_String.cpp.
References appendCharPointer().
void juce::String::appendCharPointer | ( | CharPointerType | startOfTextToAppend, |
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 |
Definition at line 724 of file juce_String.cpp.
References juce::CharPointer_UTF8::getAddress(), preallocateBytes(), and juce::CharPointer_UTF8::writeNull().
Referenced by append(), appendCharPointer(), operator+=(), operator+=(), and operator+=().
|
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 |
Definition at line 237 of file juce_String.h.
References juce::CharPointer_UTF8::writeWithCharLimit().
void juce::String::appendCharPointer | ( | CharPointerType | textToAppend | ) |
Appends a string to the end of this one.
Definition at line 719 of file juce_String.cpp.
References appendCharPointer(), and juce::CharPointer_UTF8::findTerminatingNull().
|
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 |
Definition at line 266 of file juce_String.h.
References juce::CharPointer_UTF8::writeWithCharLimit().
|
inline |
Appends a string to the end of this one.
Definition at line 288 of file juce_String.h.
|
inlinenoexcept |
Returns true if the string contains no characters.
Note that there's also an isNotEmpty() method to help write readable code.
Definition at line 300 of file juce_String.h.
Referenced by juce::ZipFile::Builder::addFile(), juce::AudioDeviceManager::addMidiInputCallback(), juce::MidiMessage::getDescription(), juce::XmlDocument::getDocumentElement(), getLastCharacter(), juce::StringPool::getPooledString(), juce::UnitTest::getTestsInCategory(), juce::File::isAChildOf(), juce::TextDiff::Change::isDeletion(), operator+=(), quoted(), removeCharacters(), juce::AudioDeviceManager::restartLastAudioDevice(), retainCharacters(), juce::AudioDeviceManager::setAudioDeviceSetup(), juce::Result::wasOk(), and juce::File::withFileExtension().
|
inlinenoexcept |
Returns true if the string contains at least one character.
Note that there's also an isEmpty() method to help write readable code.
Definition at line 306 of file juce_String.h.
Referenced by juce::ZipFile::Builder::addEntry(), juce::URL::createInputStream(), juce::ValueWithDefault::get(), juce::Identifier::Identifier(), juce::URL::isProbablyAWebsiteURL(), juce::File::isRoot(), juce::UndoManager::perform(), juce::AudioDeviceManager::setAudioDeviceSetup(), juce::AudioDeviceManager::setDefaultMidiOutput(), juce::ValueTree::setPropertyExcludingListener(), juce::PropertySet::setValue(), trim(), trimCharactersAtEnd(), trimEnd(), trimStart(), and juce::ValueTree::ValueTree().
|
noexcept |
Resets this string to be empty.
Definition at line 260 of file juce_String.cpp.
|
noexcept |
Case-insensitive comparison with another string.
Definition at line 597 of file juce_String.cpp.
|
noexcept |
Case-insensitive comparison with another string.
Definition at line 592 of file juce_String.cpp.
|
noexcept |
Case-insensitive comparison with another string.
Definition at line 580 of file juce_String.cpp.
|
noexcept |
Case-insensitive comparison with another string.
Definition at line 586 of file juce_String.cpp.
|
noexcept |
Case-sensitive comparison with another string.
Definition at line 603 of file juce_String.cpp.
|
noexcept |
Case-sensitive comparison with another string.
Definition at line 604 of file juce_String.cpp.
|
noexcept |
Case-sensitive comparison with another string.
Definition at line 605 of file juce_String.cpp.
|
noexcept |
Case-insensitive comparison with another string.
Definition at line 606 of file juce_String.cpp.
|
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.
Definition at line 707 of file juce_String.cpp.
|
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.
Definition at line 1399 of file juce_String.cpp.
Referenced by juce::ChildProcessSlave::initialiseFromCommandLine(), and juce::URL::URL().
|
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.
Definition at line 1409 of file juce_String.cpp.
Referenced by juce::AudioFormatManager::findFormatForFileExtension(), quoted(), and juce::URL::URL().
|
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.
Definition at line 1404 of file juce_String.cpp.
Referenced by juce::URL::isProbablyAWebsiteURL().
|
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.
Definition at line 1427 of file juce_String.cpp.
|
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.
Definition at line 1416 of file juce_String.cpp.
Referenced by juce::File::addTrailingSeparator(), juce::URL::isProbablyAnEmailAddress(), and quoted().
|
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.
Definition at line 1444 of file juce_String.cpp.
Referenced by juce::File::hasFileExtension().
|
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.
Definition at line 1041 of file juce_String.cpp.
Referenced by juce::IPAddress::getFormattedAddress(), and juce::Time::getTimeZone().
|
noexcept |
Tests whether the string contains a particular character.
Uses a case-sensitive comparison.
Definition at line 1046 of file juce_String.cpp.
Referenced by juce::URL::addEscapeChars(), juce::URLInputSource::createInputStreamFor(), juce::URL::isProbablyAWebsiteURL(), and replaceCharacter().
|
noexcept |
Tests whether the string contains another substring.
Uses a case-insensitive comparison.
Definition at line 1051 of file juce_String.cpp.
Referenced by juce::Time::getTimeZone().
|
noexcept |
Tests whether the string contains another substring as a distinct word.
Definition at line 1100 of file juce_String.cpp.
|
noexcept |
Tests whether the string contains another substring as a distinct word.
Definition at line 1105 of file juce_String.cpp.
|
noexcept |
Finds an instance of another substring if it exists as a distinct word.
Definition at line 1056 of file juce_String.cpp.
|
noexcept |
Finds an instance of another substring if it exists as a distinct word.
Definition at line 1078 of file juce_String.cpp.
|
noexcept |
Looks for any of a set of characters in the string.
Uses a case-sensitive comparison.
Definition at line 1811 of file juce_String.cpp.
|
noexcept |
Looks for a set of characters in the string.
Uses a case-sensitive comparison.
Definition at line 1802 of file juce_String.cpp.
Referenced by juce::DirectoryIterator::next(), and juce::Expression::withRenamedSymbol().
|
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()".
Definition at line 1820 of file juce_String.cpp.
|
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.
Definition at line 1147 of file juce_String.cpp.
|
noexcept |
Searches for a character inside this string.
Uses a case-sensitive comparison.
Definition at line 880 of file juce_String.cpp.
Referenced by juce::URL::isProbablyAnEmailAddress().
|
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 |
Definition at line 885 of file juce_String.cpp.
|
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.
Definition at line 917 of file juce_String.cpp.
|
noexcept |
Searches for a substring within this string.
Uses a case-sensitive comparison.
Definition at line 937 of file juce_String.cpp.
Referenced by fromFirstOccurrenceOf(), replace(), replaceFirstOccurrenceOf(), and upToFirstOccurrenceOf().
|
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 |
Definition at line 947 of file juce_String.cpp.
|
noexcept |
Searches for a substring within this string.
Uses a case-insensitive comparison.
Definition at line 942 of file juce_String.cpp.
References juce::CharacterFunctions::indexOfIgnoreCase().
Referenced by fromFirstOccurrenceOf(), replace(), replaceFirstOccurrenceOf(), and upToFirstOccurrenceOf().
|
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 |
Definition at line 966 of file juce_String.cpp.
References juce::CharacterFunctions::indexOfIgnoreCase().
|
noexcept |
Searches for a character inside this string (working backwards from the end of the string).
Uses a case-sensitive comparison.
Definition at line 905 of file juce_String.cpp.
Referenced by juce::File::getFileExtension(), juce::File::getFileName(), juce::File::getFileNameWithoutExtension(), juce::File::getNonexistentChildFile(), juce::File::hasFileExtension(), and juce::URL::isProbablyAnEmailAddress().
|
noexcept |
Searches for a substring inside this string (working backwards from the end of the string).
Uses a case-sensitive comparison.
Definition at line 985 of file juce_String.cpp.
Referenced by fromLastOccurrenceOf(), and upToLastOccurrenceOf().
|
noexcept |
Searches for a substring inside this string (working backwards from the end of the string).
Uses a case-insensitive comparison.
Definition at line 1007 of file juce_String.cpp.
Referenced by fromLastOccurrenceOf(), and upToLastOccurrenceOf().
|
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.
Definition at line 1029 of file juce_String.cpp.
|
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.
Definition at line 533 of file juce_String.cpp.
|
noexcept |
Returns the final character of the string.
If the string is empty this will return 0.
Definition at line 1499 of file juce_String.cpp.
String juce::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 |
Definition at line 1504 of file juce_String.cpp.
References String().
Referenced by juce::File::createLegalPathName(), fromFirstOccurrenceOf(), fromLastOccurrenceOf(), juce::File::getFileExtension(), juce::File::getFileName(), juce::File::getFileNameWithoutExtension(), juce::ArgumentList::Argument::getLongOptionValue(), juce::URL::getScheme(), juce::Time::getTimeZone(), juce::File::hasFileExtension(), unquoted(), upToFirstOccurrenceOf(), upToLastOccurrenceOf(), and juce::URL::withNewSubPath().
String juce::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. |
Definition at line 1543 of file juce_String.cpp.
References String().
String juce::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. |
Definition at line 1561 of file juce_String.cpp.
References length(), and String().
Referenced by juce::IPAddress::getFormattedAddress(), and juce::File::getRelativePathFrom().
String juce::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.
Definition at line 1566 of file juce_String.cpp.
String juce::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.
Definition at line 1571 of file juce_String.cpp.
References indexOf(), indexOfIgnoreCase(), juce::StringRef::length(), and substring().
Referenced by juce::IPAddress::getFormattedAddress(), juce::ChildProcessSlave::initialiseFromCommandLine(), and juce::URL::URL().
String juce::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.
Definition at line 1581 of file juce_String.cpp.
References lastIndexOf(), lastIndexOfIgnoreCase(), juce::StringRef::length(), and substring().
Referenced by juce::XmlElement::getTagNameWithoutNamespace(), juce::URL::isProbablyAWebsiteURL(), and juce::ConsoleApplication::printCommandList().
String juce::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.
Definition at line 1591 of file juce_String.cpp.
References indexOf(), indexOfIgnoreCase(), juce::StringRef::length(), and substring().
Referenced by juce::XmlElement::getNamespace(), juce::ChildProcessSlave::initialiseFromCommandLine(), and juce::URL::isProbablyAWebsiteURL().
String juce::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.
Definition at line 1601 of file juce_String.cpp.
References lastIndexOf(), lastIndexOfIgnoreCase(), juce::StringRef::length(), and substring().
String juce::String::trim | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the start and end.
Definition at line 1662 of file juce_String.cpp.
References juce::CharPointer_UTF8::findEndOfWhitespace(), juce::CharPointer_UTF8::findTerminatingNull(), isNotEmpty(), and String().
Referenced by juce::ChildProcessSlave::initialiseFromCommandLine().
String juce::String::trimStart | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the start.
Definition at line 1680 of file juce_String.cpp.
References isNotEmpty(), and String().
String juce::String::trimEnd | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the end.
Definition at line 1693 of file juce_String.cpp.
References juce::CharPointer_UTF8::findTerminatingNull(), isNotEmpty(), and String().
Referenced by juce::ChannelRemappingAudioSource::createXml(), juce::RelativeTime::getDescription(), juce::File::hasFileExtension(), and juce::Time::toString().
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. |
Definition at line 1707 of file juce_String.cpp.
References juce::CharPointer_UTF8::indexOf(), String(), and juce::StringRef::text.
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. |
Definition at line 1717 of file juce_String.cpp.
References juce::CharPointer_UTF8::findTerminatingNull(), juce::CharPointer_UTF8::indexOf(), isNotEmpty(), String(), and juce::StringRef::text.
Referenced by juce::File::createDirectory().
String juce::String::toUpperCase | ( | ) | const |
Returns an upper-case version of this string.
Definition at line 1462 of file juce_String.cpp.
References juce::CharPointer_UTF8::toUpperCase().
String juce::String::toLowerCase | ( | ) | const |
Returns an lower-case version of this string.
Definition at line 1480 of file juce_String.cpp.
References juce::CharPointer_UTF8::toLowerCase().
Referenced by juce::Expression::withRenamedSymbol().
String juce::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. |
Definition at line 1224 of file juce_String.cpp.
References juce::CharPointer_UTF8::getAddress(), juce::StringRef::text, and juce::CharPointer_UTF8::writeNull().
Referenced by replace(), and replaceFirstOccurrenceOf().
String juce::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.
Definition at line 1285 of file juce_String.cpp.
References indexOf(), indexOfIgnoreCase(), juce::StringRef::length(), and replaceSection().
Referenced by juce::IPAddress::getFormattedAddress().
String juce::String::replaceFirstOccurrenceOf | ( | StringRef | stringToReplace, |
StringRef | stringToInsertInstead, | ||
bool | ignoreCase = false |
||
) | const |
Replaces the first occurrence of a substring with another string.
Returns a copy of this string, with the first occurrence of stringToReplace swapped for stringToInsertInstead.
Note that this is a const method, and won't alter the string itself.
Definition at line 1303 of file juce_String.cpp.
References indexOf(), indexOfIgnoreCase(), juce::StringRef::length(), and replaceSection().
String juce::String::replaceCharacter | ( | juce_wchar | characterToReplace, |
juce_wchar | characterToInsertInstead | ||
) | const |
Returns a string with all occurrences of a character replaced with a different one.
Definition at line 1350 of file juce_String.cpp.
References containsChar(), and juce::CharPointer_UTF8::getAndAdvance().
Referenced by juce::URL::removeEscapeChars().
String juce::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.
Definition at line 1373 of file juce_String.cpp.
References juce::CharPointer_UTF8::getAndAdvance(), juce::CharPointer_UTF8::indexOf(), juce::StringRef::length(), and juce::StringRef::text.
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.
Definition at line 1741 of file juce_String.cpp.
References juce::CharPointer_UTF8::getAndAdvance(), juce::CharPointer_UTF8::indexOf(), isEmpty(), and juce::StringRef::text.
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.
Definition at line 1763 of file juce_String.cpp.
References juce::CharPointer_UTF8::getAndAdvance(), juce::CharPointer_UTF8::indexOf(), isEmpty(), and juce::StringRef::text.
Referenced by juce::File::createLegalFileName(), juce::File::createLegalPathName(), and juce::IPAddress::getFormattedAddress().
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.
Definition at line 1784 of file juce_String.cpp.
References juce::CharPointer_UTF8::indexOf(), String(), and juce::StringRef::text.
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).
Definition at line 1793 of file juce_String.cpp.
References juce::CharPointer_UTF8::indexOf(), String(), and juce::StringRef::text.
bool juce::String::isQuotedString | ( | ) | const |
Checks whether the string might be in quotation marks.
Definition at line 1616 of file juce_String.cpp.
String juce::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.
Definition at line 1621 of file juce_String.cpp.
References length(), and substring().
String juce::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 |
Definition at line 1630 of file juce_String.cpp.
References charToString(), endsWithChar(), isEmpty(), and startsWithChar().
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 |
Definition at line 1153 of file juce_String.cpp.
References juce::StringRef::text, and juce::CharPointer_UTF8::writeAll().
Referenced by juce::IPAddress::getFormattedAddress(), juce::File::getRelativePathFrom(), and juce::ConsoleApplication::printCommandList().
String juce::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.
Definition at line 1167 of file juce_String.cpp.
References juce::CharPointer_UTF8::getBytesRequiredFor(), and juce::CharPointer_UTF8::write().
Referenced by juce::BigInteger::toString(), and juce::MACAddress::toString().
String juce::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.
Definition at line 1194 of file juce_String.cpp.
References juce::CharPointer_UTF8::getAddress(), juce::CharPointer_UTF8::getBytesRequiredFor(), juce::CharPointer_UTF8::isEmpty(), and juce::CharPointer_UTF8::writeAll().
Referenced by juce::ConsoleApplication::printCommandList().
|
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.
Definition at line 1966 of file juce_String.cpp.
References charToString(), juce::CharPointer_UTF8::isByteOrderMark(), juce::CharPointer_UTF16::isByteOrderMarkBigEndian(), juce::CharPointer_UTF16::isByteOrderMarkLittleEndian(), juce::CharPointer_UTF8::isValidString(), juce::ByteOrder::swapIfBigEndian(), and juce::ByteOrder::swapIfLittleEndian().
Referenced by juce::MemoryOutputStream::toString().
|
inlinestatic |
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.
Definition at line 910 of file juce_String.h.
Referenced by juce::Time::getUTCOffsetString(), and juce::Time::toISO8601().
|
noexcept |
Reads the value of the string as a decimal number (up to 32 bits in size).
Definition at line 1869 of file juce_String.cpp.
Referenced by juce::MemoryBlock::fromBase64Encoding(), and juce::AudioChannelSet::getChannelTypeFromAbbreviation().
|
noexcept |
Reads the value of the string as a decimal number (up to 64 bits in size).
Definition at line 1870 of file juce_String.cpp.
|
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.
Definition at line 1874 of file juce_String.cpp.
|
noexcept |
Parses this string as a floating point number.
Definition at line 1871 of file juce_String.cpp.
References getDoubleValue().
|
noexcept |
Parses this string as a floating point number.
Definition at line 1872 of file juce_String.cpp.
Referenced by getFloatValue().
|
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.
Definition at line 1951 of file juce_String.cpp.
|
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.
Definition at line 1952 of file juce_String.cpp.
|
inlinestatic |
Returns a string representing this numeric value in hexadecimal.
Definition at line 1055 of file juce_String.h.
Referenced by juce::File::createTempFile(), juce::MidiMessage::getDescription(), juce::SystemStats::getDeviceIdentifiers(), juce::SystemStats::getStackBacktrace(), juce::ChildProcessMaster::launchSlaveProcess(), juce::UnitTestRunner::runTests(), juce::IPAddress::toString(), and juce::MACAddress::toString().
|
static |
Returns 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". |
Definition at line 1923 of file juce_String.cpp.
References juce::CharPointer_UTF8::write().
|
inlinestatic |
Returns a string containing a decimal with a set number of significant figures.
number | the intput number |
numberOfSignificantFigures | the number of significant figures to use |
Definition at line 1074 of file juce_String.h.
|
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.
Definition at line 1200 of file juce_String.h.
Referenced by juce::Expression::Expression(), juce::XmlDocument::getDocumentElement(), juce::File::getRelativePathFrom(), juce::StringArray::joinIntoString(), juce::Identifier::operator!=(), juce::Identifier::operator==(), juce::JSON::parse(), juce::MemoryBlock::toBase64Encoding(), and juce::OutputStream::writeText().
CharPointer_UTF8 juce::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())
Definition at line 2068 of file juce_String.cpp.
Referenced by toRawUTF8().
const char * juce::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())
Definition at line 2072 of file juce_String.cpp.
References juce::CharPointer_UTF8::getAddress(), and toUTF8().
Referenced by juce::URL::addEscapeChars(), juce::File::createSymbolicLink(), juce::Base64::toBase64(), juce::URL::withPOSTData(), juce::OutputStream::writeString(), and juce::OutputStream::writeText().
CharPointer_UTF16 juce::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())
Definition at line 2069 of file juce_String.cpp.
CharPointer_UTF32 juce::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.
Definition at line 2070 of file juce_String.cpp.
const wchar_t * juce::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.
Definition at line 2077 of file juce_String.cpp.
Referenced by juce::File::createSymbolicLink().
std::string juce::String::toStdString | ( | ) | const |
Definition at line 2082 of file juce_String.cpp.
|
static |
Creates a String from a UTF-8 encoded buffer.
If the size is < 0, it'll keep reading until it hits a zero.
Definition at line 2123 of file juce_String.cpp.
References juce::CharPointer_UTF8::isValidString(), and String().
Referenced by juce::URL::addEscapeChars(), juce::BufferedInputStream::readString(), juce::URL::removeEscapeChars(), and juce::MemoryBlock::toString().
|
noexcept |
Returns the number of bytes required to represent this string as UTF8.
The number returned does NOT include the trailing zero.
Definition at line 2118 of file juce_String.cpp.
References juce::CharPointer_UTF8::getBytesRequiredFor().
Referenced by juce::URL::addEscapeChars(), juce::URL::withPOSTData(), juce::OutputStream::writeString(), and juce::OutputStream::writeText().
|
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. |
Definition at line 2102 of file juce_String.cpp.
Referenced by juce::OutputStream::writeString().
|
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. |
Definition at line 2107 of file juce_String.cpp.
|
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. |
Definition at line 2112 of file juce_String.cpp.
void juce::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. |
Definition at line 291 of file juce_String.cpp.
Referenced by appendCharPointer(), juce::RelativeTime::getDescription(), juce::StringArray::joinIntoString(), and juce::MemoryBlock::toBase64Encoding().
|
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.
Definition at line 255 of file juce_String.cpp.
CFStringRef juce::String::toCFString | ( | ) | const |
OSX ONLY - Converts this string to a CFString.
Remember that you must use CFRelease() to free the returned string when you're finished with it.
|
noexcept |
Returns the number of String objects which are currently sharing the same internal data as this one.
Definition at line 296 of file juce_String.cpp.