JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
String Class Reference

The JUCE String class! More...

Public Member Functions

 String () noexcept
 Creates an empty string.
 
 String (const String &other) noexcept
 Creates a copy of another string.
 
 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 whcar_t character string.
 
 String (const wchar_t *text, size_t maxChars)
 Creates a string from a whcar_t character string.
 
 String (const CharPointer_UTF8 text)
 Creates a string from a UTF-8 character string.
 
 String (const CharPointer_UTF8 text, size_t maxChars)
 Creates a string from a UTF-8 character string.
 
 String (const CharPointer_UTF8 start, const CharPointer_UTF8 end)
 Creates a string from a UTF-8 character string.
 
 String (const CharPointer_UTF16 text)
 Creates a string from a UTF-16 character string.
 
 String (const CharPointer_UTF16 text, size_t maxChars)
 Creates a string from a UTF-16 character string.
 
 String (const CharPointer_UTF16 start, const CharPointer_UTF16 end)
 Creates a string from a UTF-16 character string.
 
 String (const CharPointer_UTF32 text)
 Creates a string from a UTF-32 character string.
 
 String (const CharPointer_UTF32 text, size_t maxChars)
 Creates a string from a UTF-32 character string.
 
 String (const CharPointer_UTF32 start, const CharPointer_UTF32 end)
 Creates a string from a UTF-32 character string.
 
 String (const 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 () noexcept
 Destructor.
 
int hashCode () const noexcept
 This is the character encoding type used internally to store the string.
 
int64 hashCode64 () const noexcept
 Generates a probably-unique 64-bit hashcode from this string.
 
std::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.
 
Stringoperator= (const String &other) noexcept
 Replaces this string's contents with another string.
 
Stringoperator+= (const String &stringToAppend)
 Appends another string at the end of this one.
 
Stringoperator+= (const char *textToAppend)
 Appends another string at the end of this one.
 
Stringoperator+= (const wchar_t *textToAppend)
 Appends another string at the end of this one.
 
Stringoperator+= (int numberToAppend)
 Appends a decimal number at the end of this string.
 
Stringoperator+= (int64 numberToAppend)
 Appends a decimal number at the end of this string.
 
Stringoperator+= (char characterToAppend)
 Appends a character at the end of this string.
 
Stringoperator+= (wchar_t characterToAppend)
 Appends a character at the end of this string.
 
Stringoperator+= (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 (const CharPointerType startOfTextToAppend, const CharPointerType endOfTextToAppend)
 Appends a string to the end of this one.
 
template<class CharPointer >
void appendCharPointer (const CharPointer startOfTextToAppend, const CharPointer endOfTextToAppend)
 Appends a string to the end of this one.
 
void appendCharPointer (const CharPointerType textToAppend)
 Appends a string to the end of this one.
 
template<class CharPointer >
void appendCharPointer (const CharPointer textToAppend, size_t maxCharsToTake)
 Appends a string to the end of this one.
 
template<class CharPointer >
void appendCharPointer (const 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 compareLexicographically (const String &other) const noexcept
 Lexicographic comparison with another string.
 
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 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 (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)
 Creates a string representing this floating-point number.
 
 String (double doubleValue, int numberOfDecimalPlaces)
 Creates a string representing this floating-point number.
 
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
 MAC ONLY - Converts this string to a CFString.
 
String convertToPrecomposedUnicode () const
 MAC ONLY - Returns a copy of this string in which any decomposed unicode characters have been converted to their precomposed equivalents.
 

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.
 
static String formatted (const String formatString,...)
 Creates a String from a printf-style parameter list.
 
static String toHexString (int number)
 Creates a string representing this 32-bit value in hexadecimal.
 
static String toHexString (int64 number)
 Creates a string representing this 64-bit value in hexadecimal.
 
static String toHexString (short number)
 Creates a string representing this 16-bit value in hexadecimal.
 
static String toHexString (const void *data, int size, int groupSize=1)
 Creates a string containing a hex dump of a block of binary data.
 
static String fromUTF8 (const char *utf8buffer, int bufferSizeBytes=-1)
 Creates a String from a UTF-8 encoded buffer.
 
static String fromCFString (CFStringRef cfString)
 MAC ONLY - Creates a String from an OSX CFString.
 

Static Public Attributes

static const String empty
 This is an empty string that can be used whenever one is needed.
 

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

Constructor & Destructor Documentation

String::String ( )
noexcept

Creates an empty string.

See Also
empty
String::String ( const String other)
noexcept

Creates a copy of another string.

String::String ( const char *  text)

Creates a string from a zero-terminated ascii text string.

The string passed-in must not contain any characters with a value above 127, because these can't be converted to unicode without knowing the original encoding that was used to create the string. If you attempt to pass-in values above 127, you'll get an assertion.

To create strings with extended characters from UTF-8, you should explicitly call String (CharPointer_UTF8 ("my utf8 string..")). It's *highly* recommended that you use UTF-8 with escape characters in your source code to represent extended characters, because there's no other way to represent unicode strings in a way that isn't dependent on the compiler, source code editor and platform.

String::String ( const char *  text,
size_t  maxChars 
)

Creates a string from a string of 8-bit ascii characters.

The string passed-in must not contain any characters with a value above 127, because these can't be converted to unicode without knowing the original encoding that was used to create the string. If you attempt to pass-in values above 127, you'll get an assertion.

To create strings with extended characters from UTF-8, you should explicitly call String (CharPointer_UTF8 ("my utf8 string..")). It's *highly* recommended that you use UTF-8 with escape characters in your source code to represent extended characters, because there's no other way to represent unicode strings in a way that isn't dependent on the compiler, source code editor and platform.

This will use up to the first maxChars characters of the string (or less if the string is actually shorter).

String::String ( const wchar_t *  text)

Creates a string from a whcar_t character string.

Depending on the platform, this may be treated as either UTF-32 or UTF-16.

String::String ( const wchar_t *  text,
size_t  maxChars 
)

Creates a string from a whcar_t character string.

Depending on the platform, this may be treated as either UTF-32 or UTF-16.

String::String ( const CharPointer_UTF8  text)

Creates a string from a UTF-8 character string.

String::String ( const CharPointer_UTF8  text,
size_t  maxChars 
)

Creates a string from a UTF-8 character string.

String::String ( const CharPointer_UTF8  start,
const CharPointer_UTF8  end 
)

Creates a string from a UTF-8 character string.

String::String ( const CharPointer_UTF16  text)

Creates a string from a UTF-16 character string.

String::String ( const CharPointer_UTF16  text,
size_t  maxChars 
)

Creates a string from a UTF-16 character string.

String::String ( const CharPointer_UTF16  start,
const CharPointer_UTF16  end 
)

Creates a string from a UTF-16 character string.

String::String ( const CharPointer_UTF32  text)

Creates a string from a UTF-32 character string.

String::String ( const CharPointer_UTF32  text,
size_t  maxChars 
)

Creates a string from a UTF-32 character string.

String::String ( const CharPointer_UTF32  start,
const CharPointer_UTF32  end 
)

Creates a string from a UTF-32 character string.

String::String ( const CharPointer_ASCII  text)

Creates a string from an ASCII character string.

String::String ( const std::string &  )

Creates a string from a UTF-8 encoded std::string.

String::~String ( )
noexcept

Destructor.

String::String ( int  decimalInteger)
explicit

Creates a string containing this signed 32-bit integer as a decimal number.

See Also
getIntValue, getFloatValue, getDoubleValue, toHexString
String::String ( unsigned int  decimalInteger)
explicit

Creates a string containing this unsigned 32-bit integer as a decimal number.

See Also
getIntValue, getFloatValue, getDoubleValue, toHexString
String::String ( short  decimalInteger)
explicit

Creates a string containing this signed 16-bit integer as a decimal number.

See Also
getIntValue, getFloatValue, getDoubleValue, toHexString
String::String ( unsigned short  decimalInteger)
explicit

Creates a string containing this unsigned 16-bit integer as a decimal number.

See Also
getIntValue, getFloatValue, getDoubleValue, toHexString
String::String ( int64  largeIntegerValue)
explicit

Creates a string containing this signed 64-bit integer as a decimal number.

See Also
getLargeIntValue, getFloatValue, getDoubleValue, toHexString
String::String ( uint64  largeIntegerValue)
explicit

Creates a string containing this unsigned 64-bit integer as a decimal number.

See Also
getLargeIntValue, getFloatValue, getDoubleValue, toHexString
String::String ( float  floatValue)
explicit

Creates a string representing this floating-point number.

Parameters
floatValuethe value to convert to a string
See Also
getDoubleValue, getIntValue
String::String ( double  doubleValue)
explicit

Creates a string representing this floating-point number.

Parameters
doubleValuethe value to convert to a string
See Also
getFloatValue, getIntValue
String::String ( float  floatValue,
int  numberOfDecimalPlaces 
)

Creates a string representing this floating-point number.

Parameters
floatValuethe value to convert to a string
numberOfDecimalPlacesif this is > 0, it will format the number using that many decimal places, and will not use exponent notation. If 0 or less, it will use exponent notation if necessary.
See Also
getDoubleValue, getIntValue
String::String ( double  doubleValue,
int  numberOfDecimalPlaces 
)

Creates a string representing this floating-point number.

Parameters
doubleValuethe value to convert to a string
numberOfDecimalPlacesif this is > 0, it will format the number using that many decimal places, and will not use exponent notation. If 0 or less, it will use exponent notation if necessary.
See Also
getFloatValue, getIntValue

Member Function Documentation

static String String::charToString ( juce_wchar  character)
static

Creates a string from a single character.

int String::hashCode ( ) const
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.

int64 String::hashCode64 ( ) const
noexcept

Generates a probably-unique 64-bit hashcode from this string.

std::size_t String::hash ( ) const
noexcept

Generates a probably-unique hashcode from this string.

int String::length ( ) const
noexcept

Returns the number of characters in the string.

String& String::operator= ( const String other)
noexcept

Replaces this string's contents with another string.

String& String::operator+= ( const String stringToAppend)

Appends another string at the end of this one.

String& String::operator+= ( const char *  textToAppend)

Appends another string at the end of this one.

String& String::operator+= ( const wchar_t *  textToAppend)

Appends another string at the end of this one.

String& String::operator+= ( int  numberToAppend)

Appends a decimal number at the end of this string.

String& String::operator+= ( int64  numberToAppend)

Appends a decimal number at the end of this string.

String& String::operator+= ( char  characterToAppend)

Appends a character at the end of this string.

String& String::operator+= ( wchar_t  characterToAppend)

Appends a character at the end of this string.

String& String::operator+= ( juce_wchar  characterToAppend)

Appends a character at the end of this string.

void String::append ( const String textToAppend,
size_t  maxCharsToTake 
)

Appends a string to the end of this one.

Parameters
textToAppendthe string to add
maxCharsToTakethe maximum number of characters to take from the string passed in
void String::appendCharPointer ( const CharPointerType  startOfTextToAppend,
const CharPointerType  endOfTextToAppend 
)

Appends a string to the end of this one.

Parameters
startOfTextToAppendthe start of the string to add. This must not be a nullptr
endOfTextToAppendthe end of the string to add. This must not be a nullptr
template<class CharPointer >
void String::appendCharPointer ( const CharPointer  startOfTextToAppend,
const CharPointer  endOfTextToAppend 
)

Appends a string to the end of this one.

Parameters
startOfTextToAppendthe start of the string to add. This must not be a nullptr
endOfTextToAppendthe end of the string to add. This must not be a nullptr

References addBytesToPointer(), CharPointer_ASCII::getAddress(), and jassert.

void String::appendCharPointer ( const CharPointerType  textToAppend)

Appends a string to the end of this one.

template<class CharPointer >
void String::appendCharPointer ( const CharPointer  textToAppend,
size_t  maxCharsToTake 
)

Appends a string to the end of this one.

Parameters
textToAppendthe string to add
maxCharsToTakethe maximum number of characters to take from the string passed in

References addBytesToPointer(), and CharPointer_ASCII::getAddress().

template<class CharPointer >
void String::appendCharPointer ( const CharPointer  textToAppend)

Appends a string to the end of this one.

bool String::isEmpty ( ) const
noexcept

Returns true if the string contains no characters.

Note that there's also an isNotEmpty() method to help write readable code.

See Also
containsNonWhitespaceChars()

Referenced by ComponentPeer::DragInfo::isEmpty().

bool String::isNotEmpty ( ) const
noexcept

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()
void String::clear ( )
noexcept

Resets this string to be empty.

Referenced by ComponentPeer::DragInfo::clear().

bool String::equalsIgnoreCase ( const String other) const
noexcept

Case-insensitive comparison with another string.

bool String::equalsIgnoreCase ( StringRef  other) const
noexcept

Case-insensitive comparison with another string.

bool String::equalsIgnoreCase ( const wchar_t *  other) const
noexcept

Case-insensitive comparison with another string.

bool String::equalsIgnoreCase ( const char *  other) const
noexcept

Case-insensitive comparison with another string.

int String::compare ( const String other) const
noexcept

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.

Referenced by Identifier::operator!=(), and Identifier::operator==().

int String::compare ( const char *  other) const
noexcept

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.
int String::compare ( const wchar_t *  other) const
noexcept

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.
int String::compareIgnoreCase ( const String other) const
noexcept

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.
int String::compareLexicographically ( const String other) const
noexcept

Lexicographic comparison with another string.

The comparison used here is case-insensitive and ignores leading non-alphanumeric characters, making it good for sorting human-readable strings.

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.
bool String::startsWith ( StringRef  text) const
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.

bool String::startsWithChar ( juce_wchar  character) const
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.

bool String::startsWithIgnoreCase ( StringRef  text) const
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.

bool String::endsWith ( StringRef  text) const
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.

bool String::endsWithChar ( juce_wchar  character) const
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.

bool String::endsWithIgnoreCase ( StringRef  text) const
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.

bool String::contains ( StringRef  text) const
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.

bool String::containsChar ( juce_wchar  character) const
noexcept

Tests whether the string contains a particular character.

Uses a case-sensitive comparison.

bool String::containsIgnoreCase ( StringRef  text) const
noexcept

Tests whether the string contains another substring.

Uses a case-insensitive comparison.

bool String::containsWholeWord ( StringRef  wordToLookFor) const
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
bool String::containsWholeWordIgnoreCase ( StringRef  wordToLookFor) const
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
int String::indexOfWholeWord ( StringRef  wordToLookFor) const
noexcept

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
int String::indexOfWholeWordIgnoreCase ( StringRef  wordToLookFor) const
noexcept

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
bool String::containsAnyOf ( StringRef  charactersItMightContain) const
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.
bool String::containsOnly ( StringRef  charactersItMightContain) const
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.
bool String::containsNonWhitespaceChars ( ) const
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()".

bool String::matchesWildcard ( StringRef  wildcard,
bool  ignoreCase 
) const
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.

int String::indexOfChar ( juce_wchar  characterToLookFor) const
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.
int String::indexOfChar ( int  startIndex,
juce_wchar  characterToLookFor 
) const
noexcept

Searches for a character inside this string.

Uses a case-sensitive comparison.

Parameters
startIndexthe index from which the search should proceed
characterToLookForthe character to look for
Returns
the index of the first occurrence of the character in this string, or -1 if it's not found.
int String::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.

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
int String::indexOf ( StringRef  textToLookFor) const
noexcept

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.
int String::indexOf ( int  startIndex,
StringRef  textToLookFor 
) const
noexcept

Searches for a substring within this string.

Uses a case-sensitive comparison.

Parameters
startIndexthe index from which the search should proceed
textToLookForthe 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.
int String::indexOfIgnoreCase ( StringRef  textToLookFor) const
noexcept

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.
int String::indexOfIgnoreCase ( int  startIndex,
StringRef  textToLookFor 
) const
noexcept

Searches for a substring within this string.

Uses a case-insensitive comparison.

Parameters
startIndexthe index from which the search should proceed
textToLookForthe 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.
int String::lastIndexOfChar ( juce_wchar  character) const
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.
int String::lastIndexOf ( StringRef  textToLookFor) const
noexcept

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.
int String::lastIndexOfIgnoreCase ( StringRef  textToLookFor) const
noexcept

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

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
juce_wchar String::operator[] ( int  index) const
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
juce_wchar String::getLastCharacter ( ) const
noexcept

Returns the final character of the string.

If the string is empty this will return 0.

String String::substring ( int  startIndex,
int  endIndex 
) const

Returns a subsection of the string.

If the range specified is beyond the limits of the string, as much as possible is returned.

Parameters
startIndexthe index of the start of the substring needed
endIndexall characters from startIndex up to (but not including) this index are returned
See Also
fromFirstOccurrenceOf, dropLastCharacters, getLastCharacters, upToFirstOccurrenceOf
String String::substring ( int  startIndex) const

Returns a section of the string, starting from a given position.

Parameters
startIndexthe 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
String String::dropLastCharacters ( int  numberToDrop) const

Returns a version of this string with a number of characters removed from the end.

Parameters
numberToDropthe 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
String String::getLastCharacters ( int  numCharacters) const

Returns a number of characters from the end of the string.

This returns the last numCharacters characters from the end of the string. If the string is shorter than numCharacters, the whole string is returned.

See Also
substring, dropLastCharacters, getLastCharacter
String String::fromFirstOccurrenceOf ( StringRef  substringToStartFrom,
bool  includeSubStringInResult,
bool  ignoreCase 
) const

Returns a section of the string starting from a given substring.

This will search for the first occurrence of the given substring, and return the section of the string starting from the point where this is found (optionally not including the substring itself).

e.g. for the string "123456", fromFirstOccurrenceOf ("34", true) would return "3456", and fromFirstOccurrenceOf ("34", false) would return "56".

If the substring isn't found, the method will return an empty string.

If ignoreCase is true, the comparison will be case-insensitive.

See Also
upToFirstOccurrenceOf, fromLastOccurrenceOf
String String::fromLastOccurrenceOf ( StringRef  substringToFind,
bool  includeSubStringInResult,
bool  ignoreCase 
) const

Returns a section of the string starting from the last occurrence of a given substring.

Similar to fromFirstOccurrenceOf(), but using the last occurrence of the substring, and unlike fromFirstOccurrenceOf(), if the substring isn't found, this method will return the whole of the original string.

See Also
fromFirstOccurrenceOf, upToLastOccurrenceOf
String String::upToFirstOccurrenceOf ( StringRef  substringToEndWith,
bool  includeSubStringInResult,
bool  ignoreCase 
) const

Returns the start of this string, up to the first occurrence of a substring.

This will search for the first occurrence of a given substring, and then return a copy of the string, up to the position of this substring, optionally including or excluding the substring itself in the result.

e.g. for the string "123456", upTo ("34", false) would return "12", and upTo ("34", true) would return "1234".

If the substring isn't found, this will return the whole of the original string.

See Also
upToLastOccurrenceOf, fromFirstOccurrenceOf
String String::upToLastOccurrenceOf ( StringRef  substringToFind,
bool  includeSubStringInResult,
bool  ignoreCase 
) const

Returns the start of this string, up to the last occurrence of a substring.

Similar to upToFirstOccurrenceOf(), but this finds the last occurrence rather than the first. If the substring isn't found, this will return the whole of the original string.

See Also
upToFirstOccurrenceOf, fromFirstOccurrenceOf
String String::trim ( ) const

Returns a copy of this string with any whitespace characters removed from the start and end.

String String::trimStart ( ) const

Returns a copy of this string with any whitespace characters removed from the start.

String String::trimEnd ( ) const

Returns a copy of this string with any whitespace characters removed from the end.

String String::trimCharactersAtStart ( StringRef  charactersToTrim) const

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
charactersToTrimthe set of characters to remove.
See Also
trim, trimStart, trimCharactersAtEnd
String String::trimCharactersAtEnd ( StringRef  charactersToTrim) const

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
charactersToTrimthe set of characters to remove.
See Also
trim, trimEnd, trimCharactersAtStart
String String::toUpperCase ( ) const

Returns an upper-case version of this string.

String String::toLowerCase ( ) const

Returns an lower-case version of this string.

String String::replaceSection ( int  startIndex,
int  numCharactersToReplace,
StringRef  stringToInsert 
) const

Replaces a sub-section of the string with another string.

This will return a copy of this string, with a set of characters from startIndex to startIndex + numCharsToReplace removed, and with a new string inserted in their place.

Note that this is a const method, and won't alter the string itself.

Parameters
startIndexthe first character to remove. If this is beyond the bounds of the string, it will be constrained to a valid range.
numCharactersToReplacethe number of characters to remove. If zero or less, no characters will be taken out.
stringToInsertthe new string to insert at startIndex after the characters have been removed.
String String::replace ( StringRef  stringToReplace,
StringRef  stringToInsertInstead,
bool  ignoreCase = false 
) const

Replaces all occurrences of a substring with another string.

Returns a copy of this string, with any occurrences of stringToReplace swapped for stringToInsertInstead.

Note that this is a const method, and won't alter the string itself.

String String::replaceCharacter ( juce_wchar  characterToReplace,
juce_wchar  characterToInsertInstead 
) const

Returns a string with all occurrences of a character replaced with a different one.

String String::replaceCharacters ( StringRef  charactersToReplace,
StringRef  charactersToInsertInstead 
) const

Replaces a set of characters with another set.

Returns a string in which each character from charactersToReplace has been replaced by the character at the equivalent position in newCharacters (so the two strings passed in must be the same length).

e.g. replaceCharacters ("abc", "def") replaces 'a' with 'd', 'b' with 'e', etc.

Note that this is a const method, and won't affect the string itself.

String String::retainCharacters ( StringRef  charactersToRetain) const

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.

String String::removeCharacters ( StringRef  charactersToRemove) const

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.

String String::initialSectionContainingOnly ( StringRef  permittedCharacters) const

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.

String String::initialSectionNotContaining ( StringRef  charactersToStopAt) const

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).

bool 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
String String::unquoted ( ) const

Removes quotation marks from around the string, (if there are any).

Returns a copy of this string with any quotes removed from its ends. Quotes that aren't at the ends of the string are not affected. If there aren't any quotes, the original string is returned.

Note that this is a const method, and won't alter the string itself.

See Also
isQuotedString, quoted
String String::quoted ( juce_wchar  quoteCharacter = '"') const

Adds quotation marks around a string.

This will return a copy of the string with a quote at the start and end, (but won't add the quote if there's already one there, so it's safe to call this on strings that may already have quotes around them).

Note that this is a const method, and won't alter the string itself.

Parameters
quoteCharacterthe character to add at the start and end
See Also
isQuotedString, unquoted
static String String::repeatedString ( StringRef  stringToRepeat,
int  numberOfTimesToRepeat 
)
static

Creates a string which is a version of a string repeated and joined together.

Parameters
stringToRepeatthe string to repeat
numberOfTimesToRepeathow many times to repeat it
String String::paddedLeft ( juce_wchar  padCharacter,
int  minimumLength 
) const

Returns a copy of this string with the specified character repeatedly added to its beginning until the total length is at least the minimum length specified.

String String::paddedRight ( juce_wchar  padCharacter,
int  minimumLength 
) const

Returns a copy of this string with the specified character repeatedly added to its end until the total length is at least the minimum length specified.

static String String::createStringFromData ( const void *  data,
int  size 
)
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.

static String String::formatted ( const String  formatString,
  ... 
)
static

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.

int String::getIntValue ( ) const
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
int64 String::getLargeIntValue ( ) const
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.
int String::getTrailingIntValue ( ) const
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.

See Also
getIntValue
float String::getFloatValue ( ) const
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
double String::getDoubleValue ( ) const
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
int String::getHexValue32 ( ) const
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.
int64 String::getHexValue64 ( ) const
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.
static String String::toHexString ( int  number)
static

Creates a string representing this 32-bit value in hexadecimal.

static String String::toHexString ( int64  number)
static

Creates a string representing this 64-bit value in hexadecimal.

static String String::toHexString ( short  number)
static

Creates a string representing this 16-bit value in hexadecimal.

static String String::toHexString ( const void *  data,
int  size,
int  groupSize = 1 
)
static

Creates a string containing a hex dump of a block of binary data.

Parameters
datathe binary data to use as input
sizehow many bytes of data to use
groupSizehow 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".
CharPointerType String::getCharPointer ( ) const
noexcept

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.

CharPointer_UTF8 String::toUTF8 ( ) const

Returns a pointer to a UTF-8 version of this string.

Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.

To find out how many bytes you need to store this string as UTF-8, you can call CharPointer_UTF8::getBytesRequiredFor (myString.getCharPointer())

See Also
toRawUTF8, getCharPointer, toUTF16, toUTF32
const char* String::toRawUTF8 ( ) const

Returns a pointer to a UTF-8 version of this string.

Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.

To find out how many bytes you need to store this string as UTF-8, you can call CharPointer_UTF8::getBytesRequiredFor (myString.getCharPointer())

See Also
getCharPointer, toUTF8, toUTF16, toUTF32
CharPointer_UTF16 String::toUTF16 ( ) const

Returns a pointer to a UTF-16 version of this string.

Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.

To find out how many bytes you need to store this string as UTF-16, you can call CharPointer_UTF16::getBytesRequiredFor (myString.getCharPointer())

See Also
getCharPointer, toUTF8, toUTF32
CharPointer_UTF32 String::toUTF32 ( ) const

Returns a pointer to a UTF-32 version of this string.

Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.

See Also
getCharPointer, toUTF8, toUTF16
const wchar_t* String::toWideCharPointer ( ) const

Returns a pointer to a wchar_t version of this string.

Because it returns a reference to the string's internal data, the pointer that is returned must not be stored anywhere, as it can be deleted whenever the string changes.

Bear in mind that the wchar_t type is different on different platforms, so on Windows, this will be equivalent to calling toUTF16(), on unix it'll be the same as calling toUTF32(), etc.

See Also
getCharPointer, toUTF8, toUTF16, toUTF32
std::string String::toStdString ( ) const
static String String::fromUTF8 ( const char *  utf8buffer,
int  bufferSizeBytes = -1 
)
static

Creates a String from a UTF-8 encoded buffer.

If the size is < 0, it'll keep reading until it hits a zero.

size_t String::getNumBytesAsUTF8 ( ) const
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
size_t String::copyToUTF8 ( CharPointer_UTF8::CharType destBuffer,
size_t  maxBufferSizeBytes 
) const
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
destBufferthe 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).
maxBufferSizeBytesthe 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_UTF8::writeWithDestByteLimit
size_t String::copyToUTF16 ( CharPointer_UTF16::CharType destBuffer,
size_t  maxBufferSizeBytes 
) const
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
destBufferthe 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).
maxBufferSizeBytesthe 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
size_t String::copyToUTF32 ( CharPointer_UTF32::CharType destBuffer,
size_t  maxBufferSizeBytes 
) const
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
destBufferthe 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).
maxBufferSizeBytesthe 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
void String::preallocateBytes ( size_t  numBytesNeeded)

Increases the string's internally allocated storage.

Although the string's contents won't be affected by this call, it will increase the amount of memory allocated internally for the string to grow into.

If you're about to make a large number of calls to methods such as += or <<, it's more efficient to preallocate enough extra space beforehand, so that these methods won't have to keep resizing the string to append the extra characters.

Parameters
numBytesNeededthe number of bytes to allocate storage for. If this value is less than the currently allocated size, it will have no effect.

Referenced by Rectangle< int >::toString().

void String::swapWith ( String other)
noexcept

Swaps the contents of this string with another one.

This is a very fast operation, as no allocation or copying needs to be done.

static String String::fromCFString ( CFStringRef  cfString)
static

MAC ONLY - Creates a String from an OSX CFString.

CFStringRef String::toCFString ( ) const

MAC ONLY - Converts this string to a CFString.

Remember that you must use CFRelease() to free the returned string when you're finished with it.

String String::convertToPrecomposedUnicode ( ) const

MAC ONLY - Returns a copy of this string in which any decomposed unicode characters have been converted to their precomposed equivalents.

Member Data Documentation

const String String::empty
static

This is an empty string that can be used whenever one is needed.

It's better to use this than String() because it explains what's going on and is more efficient.

Referenced by StandaloneFilterWindow::StandaloneFilterWindow(), and StandaloneFilterWindow::~StandaloneFilterWindow().


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