#include <juce_String.h>
Classes | |
| struct | PreallocationBytes |
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) |
| template<typename... Args> | |
| static String | formatted (const String &formatStr, Args... args) |
| template<typename IntegerType> | |
| static String | toHexString (IntegerType number) |
| static String | toHexString (const void *data, int size, int groupSize=1) |
| template<typename DecimalType> | |
| static String | toDecimalStringWithSignificantFigures (DecimalType number, int numberOfSignificantFigures) |
| static String | fromUTF8 (const char *utf8buffer, int bufferSizeBytes=-1) |
Private Member Functions | |
| String (const PreallocationBytes &) | |
| size_t | getByteOffsetOfEnd () const noexcept |
| operator bool () const noexcept | |
Static Private Member Functions | |
| static String | formattedRaw (const char *,...) |
| static String | createHex (uint8) |
| static String | createHex (uint16) |
| static String | createHex (uint32) |
| static String | createHex (uint64) |
| template<typename Type> | |
| static String | createHex (Type n) |
Private Attributes | |
| CharPointerType | text |
Detailed Description
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.
- See also
- StringArray, StringPairArray
@tags{Core}
Constructor & Destructor Documentation
◆ String() [1/33]
|
noexcept |
Creates an empty string.
- See also
- empty
◆ String() [2/33]
◆ String() [3/33]
|
noexcept |
Move constructor
◆ String() [4/33]
| 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.
◆ String() [5/33]
| 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).
◆ String() [6/33]
| 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.
◆ String() [7/33]
| 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.
◆ String() [8/33]
| juce::String::String | ( | CharPointer_UTF8 | text | ) |
Creates a string from a UTF-8 character string
◆ String() [9/33]
| juce::String::String | ( | CharPointer_UTF8 | text, |
| size_t | maxChars ) |
Creates a string from a UTF-8 character string
◆ String() [10/33]
| juce::String::String | ( | CharPointer_UTF8 | start, |
| CharPointer_UTF8 | end ) |
Creates a string from a UTF-8 character string
◆ String() [11/33]
| juce::String::String | ( | CharPointer_UTF16 | text | ) |
Creates a string from a UTF-16 character string
◆ String() [12/33]
| juce::String::String | ( | CharPointer_UTF16 | text, |
| size_t | maxChars ) |
Creates a string from a UTF-16 character string
◆ String() [13/33]
| juce::String::String | ( | CharPointer_UTF16 | start, |
| CharPointer_UTF16 | end ) |
Creates a string from a UTF-16 character string
◆ String() [14/33]
| juce::String::String | ( | CharPointer_UTF32 | text | ) |
Creates a string from a UTF-32 character string
◆ String() [15/33]
| juce::String::String | ( | CharPointer_UTF32 | text, |
| size_t | maxChars ) |
Creates a string from a UTF-32 character string
◆ String() [16/33]
| juce::String::String | ( | CharPointer_UTF32 | start, |
| CharPointer_UTF32 | end ) |
Creates a string from a UTF-32 character string
◆ String() [17/33]
| juce::String::String | ( | CharPointer_ASCII | text | ) |
Creates a string from an ASCII character string
◆ String() [18/33]
| juce::String::String | ( | const std::string & | s | ) |
Creates a string from a UTF-8 encoded std::string.
◆ String() [19/33]
◆ ~String()
|
noexcept |
Destructor.
◆ String() [20/33]
|
explicit |
Creates a string containing this signed 32-bit integer as a decimal number.
- See also
- getIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [21/33]
|
explicit |
Creates a string containing this unsigned 32-bit integer as a decimal number.
- See also
- getIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [22/33]
|
explicit |
Creates a string containing this signed 16-bit integer as a decimal number.
- See also
- getIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [23/33]
|
explicit |
Creates a string containing this unsigned 16-bit integer as a decimal number.
- See also
- getIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [24/33]
|
explicit |
Creates a string containing this signed 64-bit integer as a decimal number.
- See also
- getLargeIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [25/33]
|
explicit |
Creates a string containing this unsigned 64-bit integer as a decimal number.
- See also
- getLargeIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [26/33]
|
explicit |
Creates a string containing this signed long integer as a decimal number.
- See also
- getIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [27/33]
|
explicit |
Creates a string containing this unsigned long integer as a decimal number.
- See also
- getIntValue, getFloatValue, getDoubleValue, toHexString
◆ String() [28/33]
|
explicit |
Creates a string representing this floating-point number.
- Parameters
-
floatValue the value to convert to a string
- See also
- getDoubleValue, getIntValue
◆ String() [29/33]
|
explicit |
Creates a string representing this floating-point number.
- Parameters
-
doubleValue the value to convert to a string
- See also
- getFloatValue, getIntValue
◆ String() [30/33]
| juce::String::String | ( | float | floatValue, |
| int | numberOfDecimalPlaces, | ||
| bool | useScientificNotation = false ) |
Creates a string representing this floating-point number.
- Parameters
-
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
- See also
- getDoubleValue, getIntValue
◆ String() [31/33]
| juce::String::String | ( | double | doubleValue, |
| int | numberOfDecimalPlaces, | ||
| bool | useScientificNotation = false ) |
Creates a string representing this floating-point number.
- Parameters
-
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
- See also
- getFloatValue, getIntValue
◆ String() [32/33]
|
explicitdelete |
◆ String() [33/33]
|
explicitprivate |
Member Function Documentation
◆ append()
Appends a string to the end of this one.
- Parameters
-
textToAppend the string to add maxCharsToTake the maximum number of characters to take from the string passed in
◆ appendCharPointer() [1/5]
|
inline |
Appends a string to the end of this one.
- Parameters
-
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
◆ appendCharPointer() [2/5]
|
inline |
Appends a string to the end of this one.
◆ appendCharPointer() [3/5]
|
inline |
Appends a string to the end of this one.
- Parameters
-
textToAppend the string to add maxCharsToTake the maximum number of characters to take from the string passed in
◆ appendCharPointer() [4/5]
| void juce::String::appendCharPointer | ( | CharPointerType | startOfTextToAppend, |
| CharPointerType | endOfTextToAppend ) |
Appends a string to the end of this one.
- Parameters
-
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
◆ appendCharPointer() [5/5]
| void juce::String::appendCharPointer | ( | CharPointerType | textToAppend | ) |
Appends a string to the end of this one.
◆ begin()
|
inline |
Returns an iterator pointing at the beginning of the string.
◆ charToString()
|
static |
Creates a string from a single character.
◆ clear()
|
noexcept |
Resets this string to be empty.
◆ compare() [1/3]
Case-sensitive comparison with another string.
- Returns
- 0 if the two strings are identical; negative if this string comes before the other one alphabetically, or positive if it comes after it.
◆ compare() [2/3]
Case-sensitive comparison with another string.
- Returns
- 0 if the two strings are identical; negative if this string comes before the other one alphabetically, or positive if it comes after it.
◆ compare() [3/3]
Case-sensitive comparison with another string.
- Returns
- 0 if the two strings are identical; negative if this string comes before the other one alphabetically, or positive if it comes after it.
◆ compareIgnoreCase()
Case-insensitive comparison with another string.
- Returns
- 0 if the two strings are identical; negative if this string comes before the other one alphabetically, or positive if it comes after it.
◆ compareNatural()
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.
- Returns
- 0 if the two strings are identical; negative if this string comes before the other one alphabetically, or positive if it comes after it.
◆ contains()
|
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.
◆ containsAnyOf()
|
noexcept |
Looks for any of a set of characters in the string. Uses a case-sensitive comparison.
- Returns
- true if the string contains any of the characters from the string that is passed in.
◆ containsChar()
|
noexcept |
Tests whether the string contains a particular character. Uses a case-sensitive comparison.
◆ containsIgnoreCase()
|
noexcept |
Tests whether the string contains another substring. Uses a case-insensitive comparison.
◆ containsNonWhitespaceChars()
|
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()".
◆ containsOnly()
|
noexcept |
Looks for a set of characters in the string. Uses a case-sensitive comparison.
- Returns
- Returns false if any of the characters in this string do not occur in the parameter string. If this string is empty, the return value will always be true.
◆ containsWholeWord()
|
noexcept |
Tests whether the string contains another substring as a distinct word.
- Returns
- true if the string contains this word, surrounded by non-alphanumeric characters
- See also
- indexOfWholeWord, containsWholeWordIgnoreCase
◆ containsWholeWordIgnoreCase()
|
noexcept |
Tests whether the string contains another substring as a distinct word.
- Returns
- true if the string contains this word, surrounded by non-alphanumeric characters
- See also
- indexOfWholeWordIgnoreCase, containsWholeWord
◆ copyToUTF16()
|
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())
- Parameters
-
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.
- See also
- CharPointer_UTF16::writeWithDestByteLimit
◆ copyToUTF32()
|
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())
- Parameters
-
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.
- See also
- CharPointer_UTF32::writeWithDestByteLimit
◆ copyToUTF8()
|
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())
- Parameters
-
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.
◆ createHex() [1/5]
|
inlinestaticprivate |
◆ createHex() [2/5]
◆ createHex() [3/5]
◆ createHex() [4/5]
◆ createHex() [5/5]
◆ createStringFromData()
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.
◆ dropLastCharacters()
Returns a version of this string with a number of characters removed from the end.
- Parameters
-
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.
- See also
- substring, fromFirstOccurrenceOf, upToFirstOccurrenceOf, fromLastOccurrenceOf, getLastCharacter
◆ end()
|
inline |
Returns an iterator pointing at the terminating null of the string.
Note that this has to find the terminating null before returning it, so prefer to call this once before looping and then reuse the result, rather than calling 'end()' each time through the loop.
◆ endsWith()
|
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.
◆ endsWithChar()
|
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.
◆ endsWithIgnoreCase()
|
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.
◆ equalsIgnoreCase() [1/4]
|
noexcept |
Case-insensitive comparison with another string.
◆ equalsIgnoreCase() [2/4]
Case-insensitive comparison with another string.
◆ equalsIgnoreCase() [3/4]
|
noexcept |
Case-insensitive comparison with another string.
◆ equalsIgnoreCase() [4/4]
|
noexcept |
Case-insensitive comparison with another string.
◆ formatted()
|
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.
◆ formattedRaw()
◆ fromFirstOccurrenceOf()
| 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.
- See also
- upToFirstOccurrenceOf, fromLastOccurrenceOf
◆ fromLastOccurrenceOf()
| 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.
- See also
- fromFirstOccurrenceOf, upToLastOccurrenceOf
◆ fromUTF8()
Creates a String from a UTF-8 encoded buffer. If the size is < 0, it'll keep reading until it hits a zero.
◆ getByteOffsetOfEnd()
|
privatenoexcept |
◆ getCharPointer()
|
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.
◆ getDoubleValue()
|
noexcept |
Parses this string as a floating point number.
- Returns
- the value of the string as a 64-bit floating point value.
- See also
- getFloatValue
◆ getFloatValue()
|
noexcept |
Parses this string as a floating point number.
- Returns
- the value of the string as a 32-bit floating point value.
- See also
- getDoubleValue
◆ getHexValue32()
|
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.
- Returns
- a 32-bit number which is the value of the string in hex.
◆ getHexValue64()
|
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.
- Returns
- a 64-bit number which is the value of the string in hex.
◆ getIntValue()
|
noexcept |
Reads the value of the string as a decimal number (up to 32 bits in size).
- Returns
- the value of the string as a 32 bit signed base-10 integer.
- See also
- getTrailingIntValue, getHexValue32, getHexValue64
◆ getLargeIntValue()
|
noexcept |
Reads the value of the string as a decimal number (up to 64 bits in size).
- Returns
- the value of the string as a 64 bit signed base-10 integer.
◆ getLastCharacter()
|
noexcept |
Returns the final character of the string. If the string is empty this will return 0.
◆ getLastCharacters()
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.
- See also
- substring, dropLastCharacters, getLastCharacter
◆ getNumBytesAsUTF8()
|
noexcept |
Returns the number of bytes required to represent this string as UTF8. The number returned does NOT include the trailing zero.
- See also
- toUTF8, copyToUTF8
◆ getReferenceCount()
|
noexcept |
Returns the number of String objects which are currently sharing the same internal data as this one.
◆ getTrailingIntValue()
|
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.
If the string ends with a hyphen followed by numeric characters, the return value will be negative.
- See also
- getIntValue
◆ hash()
|
noexcept |
Generates a probably-unique hashcode from this string.
◆ hashCode()
|
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.
◆ hashCode64()
|
noexcept |
Generates a probably-unique 64-bit hashcode from this string.
◆ indexOf() [1/2]
Searches for a substring within this string. Uses a case-sensitive comparison.
- Parameters
-
startIndex the index from which the search should proceed textToLookFor the string to search for
- Returns
- the index of the first occurrence of this substring, or -1 if it's not found. If textToLookFor is an empty string, this will always return -1.
◆ indexOf() [2/2]
Searches for a substring within this string. Uses a case-sensitive comparison.
- Returns
- the index of the first occurrence of this substring, or -1 if it's not found. If textToLookFor is an empty string, this will always return 0.
◆ indexOfAnyOf()
|
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.
- See also
- indexOfChar, lastIndexOfAnyOf
◆ indexOfChar() [1/2]
|
noexcept |
Searches for a character inside this string. Uses a case-sensitive comparison.
- Parameters
-
startIndex the index from which the search should proceed characterToLookFor the character to look for
- Returns
- the index of the first occurrence of the character in this string, or -1 if it's not found.
◆ indexOfChar() [2/2]
|
noexcept |
Searches for a character inside this string. Uses a case-sensitive comparison.
- Returns
- the index of the first occurrence of the character in this string, or -1 if it's not found.
◆ indexOfIgnoreCase() [1/2]
Searches for a substring within this string. Uses a case-insensitive comparison.
- Parameters
-
startIndex the index from which the search should proceed textToLookFor the string to search for
- Returns
- the index of the first occurrence of this substring, or -1 if it's not found. If textToLookFor is an empty string, this will always return -1.
◆ indexOfIgnoreCase() [2/2]
Searches for a substring within this string. Uses a case-insensitive comparison.
- Returns
- the index of the first occurrence of this substring, or -1 if it's not found. If textToLookFor is an empty string, this will always return 0.
◆ indexOfWholeWord()
Finds an instance of another substring if it exists as a distinct word.
- Returns
- if the string contains this word, surrounded by non-alphanumeric characters, then this will return the index of the start of the substring. If it isn't found, then it will return -1
- See also
- indexOfWholeWordIgnoreCase, containsWholeWord
◆ indexOfWholeWordIgnoreCase()
Finds an instance of another substring if it exists as a distinct word.
- Returns
- if the string contains this word, surrounded by non-alphanumeric characters, then this will return the index of the start of the substring. If it isn't found, then it will return -1
- See also
- indexOfWholeWord, containsWholeWordIgnoreCase
◆ initialSectionContainingOnly()
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.
◆ initialSectionNotContaining()
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).
◆ isEmpty()
|
inlinenoexcept |
Returns true if the string contains no characters. Note that there's also an isNotEmpty() method to help write readable code.
- See also
- containsNonWhitespaceChars()
◆ isNotEmpty()
|
inlinenoexcept |
Returns true if the string contains at least one character. Note that there's also an isEmpty() method to help write readable code.
- See also
- containsNonWhitespaceChars()
◆ isQuotedString()
| bool juce::String::isQuotedString | ( | ) | const |
Checks whether the string might be in quotation marks.
- Returns
- true if the string begins with a quote character (either a double or single quote). It is also true if there is whitespace before the quote, but it doesn't check the end of the string.
- See also
- unquoted, quoted
◆ lastIndexOf()
Searches for a substring inside this string (working backwards from the end of the string). Uses a case-sensitive comparison.
- Returns
- the index of the start of the last occurrence of the substring within this string, or -1 if it's not found. If textToLookFor is an empty string, this will always return -1.
◆ lastIndexOfAnyOf()
|
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.
- See also
- lastIndexOf, indexOfAnyOf
◆ lastIndexOfChar()
|
noexcept |
Searches for a character inside this string (working backwards from the end of the string). Uses a case-sensitive comparison.
- Returns
- the index of the last occurrence of the character in this string, or -1 if it's not found.
◆ lastIndexOfIgnoreCase()
Searches for a substring inside this string (working backwards from the end of the string). Uses a case-insensitive comparison.
- Returns
- the index of the start of the last occurrence of the substring within this string, or -1 if it's not found. If textToLookFor is an empty string, this will always return -1.
◆ length()
|
noexcept |
Returns the number of characters in the string.
◆ matchesWildcard()
|
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.
◆ operator bool()
|
inlineprivatenoexcept |
◆ operator+=() [1/11]
| String & juce::String::operator+= | ( | char | characterToAppend | ) |
Appends a character at the end of this string.
◆ operator+=() [2/11]
Appends another string at the end of this one.
◆ operator+=() [3/11]
Appends another string at the end of this one.
◆ operator+=() [4/11]
Appends another string at the end of this one.
◆ operator+=() [5/11]
Appends a decimal number at the end of this string.
◆ operator+=() [6/11]
Appends a decimal number at the end of this string.
◆ operator+=() [7/11]
| String & juce::String::operator+= | ( | juce_wchar | characterToAppend | ) |
Appends a character at the end of this string.
◆ operator+=() [8/11]
| String & juce::String::operator+= | ( | long | numberToAppend | ) |
Appends a decimal number at the end of this string.
◆ operator+=() [9/11]
Appends another string at the end of this one.
◆ operator+=() [10/11]
Appends a decimal number at the end of this string.
◆ operator+=() [11/11]
| String & juce::String::operator+= | ( | wchar_t | characterToAppend | ) |
Appends a character at the end of this string.
◆ operator=() [1/2]
Replaces this string's contents with another string.
◆ operator=() [2/2]
Moves the contents of another string to the receiver
◆ operator[]()
|
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.
- See also
- getCharPointer
◆ paddedLeft()
| 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.
◆ paddedRight()
| 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.
◆ preallocateBytes()
| 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.
- Parameters
-
numBytesNeeded the number of bytes to allocate storage for. If this value is less than the currently allocated size, it will have no effect.
◆ quoted()
| 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.
- Parameters
-
quoteCharacter the character to add at the start and end
- See also
- isQuotedString, unquoted
◆ removeCharacters()
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.
◆ repeatedString()
Creates a string which is a version of a string repeated and joined together.
- Parameters
-
stringToRepeat the string to repeat numberOfTimesToRepeat how many times to repeat it
◆ replace()
| 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.
◆ replaceCharacter()
| 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.
◆ replaceCharacters()
| 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.
◆ replaceFirstOccurrenceOf()
| 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.
◆ replaceSection()
| 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.
- Parameters
-
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.
◆ retainCharacters()
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.
◆ startsWith()
|
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.
◆ startsWithChar()
|
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.
◆ startsWithIgnoreCase()
|
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.
◆ substring() [1/2]
Returns a section of the string, starting from a given position.
- Parameters
-
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.
- Returns
- the substring from startIndex up to the end of the string
- See also
- dropLastCharacters, getLastCharacters, fromFirstOccurrenceOf, upToFirstOccurrenceOf, fromLastOccurrenceOf
◆ substring() [2/2]
Returns a subsection of the string.
If the range specified is beyond the limits of the string, as much as possible is returned.
- Parameters
-
startIndex the index of the start of the substring needed endIndex all characters from startIndex up to (but not including) this index are returned
- See also
- fromFirstOccurrenceOf, dropLastCharacters, getLastCharacters, upToFirstOccurrenceOf
◆ swapWith()
Swaps the contents of this string with another one. This is a very fast operation, as no allocation or copying needs to be done.
◆ toDecimalStringWithSignificantFigures()
|
inlinestatic |
Returns a string containing a decimal with a set number of significant figures.
- Parameters
-
number the input number numberOfSignificantFigures the number of significant figures to use
◆ toHexString() [1/2]
Returns a string containing a hex dump of a block of binary data.
◆ toHexString() [2/2]
|
inlinestatic |
Returns a string representing this numeric value in hexadecimal.
◆ toLowerCase()
| String juce::String::toLowerCase | ( | ) | const |
Returns an lower-case version of this string.
◆ 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())
- See also
- getCharPointer, toUTF8, toUTF16, toUTF32
◆ toStdString()
| std::string juce::String::toStdString | ( | ) | const |
◆ toUpperCase()
| String juce::String::toUpperCase | ( | ) | const |
Returns an upper-case version of this string.
◆ toUTF16()
| 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())
- See also
- getCharPointer, toUTF8, toUTF32
◆ toUTF32()
| 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.
- See also
- getCharPointer, toUTF8, toUTF16
◆ toUTF8()
| 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())
- See also
- toRawUTF8, getCharPointer, toUTF16, toUTF32
◆ toWideCharPointer()
| 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.
- See also
- getCharPointer, toUTF8, toUTF16, toUTF32
◆ trim()
| String juce::String::trim | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the start and end.
◆ trimCharactersAtEnd()
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.
- Parameters
-
charactersToTrim the set of characters to remove.
- See also
- trim, trimEnd, trimCharactersAtStart
◆ trimCharactersAtStart()
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.
- Parameters
-
charactersToTrim the set of characters to remove.
- See also
- trim, trimStart, trimCharactersAtEnd
◆ trimEnd()
| String juce::String::trimEnd | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the end.
◆ trimStart()
| String juce::String::trimStart | ( | ) | const |
Returns a copy of this string with any whitespace characters removed from the start.
◆ unquoted()
| 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.
- See also
- isQuotedString, quoted
◆ upToFirstOccurrenceOf()
| 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.
- See also
- upToLastOccurrenceOf, fromFirstOccurrenceOf
◆ upToLastOccurrenceOf()
| 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.
- See also
- upToFirstOccurrenceOf, fromFirstOccurrenceOf
Member Data Documentation
◆ text
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/text/juce_String.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/text/juce_String.cpp
Generated on for LMMS by
1.16.1