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

A special array for holding a list of strings. More...

Public Member Functions

 StringArray () noexcept
 Creates an empty string array.
 
 StringArray (const StringArray &)
 Creates a copy of another string array.
 
 StringArray (const String &firstValue)
 Creates an array containing a single string.
 
 StringArray (const String *strings, int numberOfStrings)
 Creates an array from a raw array of strings.
 
 StringArray (const char *const *strings, int numberOfStrings)
 Creates a copy of an array of string literals.
 
 StringArray (const char *const *strings)
 Creates a copy of a null-terminated array of string literals.
 
 StringArray (const wchar_t *const *strings)
 Creates a copy of a null-terminated array of string literals.
 
 StringArray (const wchar_t *const *strings, int numberOfStrings)
 Creates a copy of an array of string literals.
 
 ~StringArray ()
 Destructor.
 
StringArrayoperator= (const StringArray &)
 Copies the contents of another string array into this one.
 
void swapWith (StringArray &) noexcept
 Swaps the contents of this and another StringArray.
 
bool operator== (const StringArray &) const noexcept
 Compares two arrays.
 
bool operator!= (const StringArray &) const noexcept
 Compares two arrays.
 
int size () const noexcept
 Returns the number of strings in the array.
 
const Stringoperator[] (int index) const noexcept
 Returns one of the strings from the array.
 
StringgetReference (int index) noexcept
 Returns a reference to one of the strings in the array.
 
Stringbegin () const noexcept
 Returns a pointer to the first String in the array.
 
Stringend () const noexcept
 Returns a pointer to the String which follows the last element in the array.
 
bool contains (StringRef stringToLookFor, bool ignoreCase=false) const
 Searches for a string in the array.
 
int indexOf (StringRef stringToLookFor, bool ignoreCase=false, int startIndex=0) const
 Searches for a string in the array.
 
void add (const String &stringToAdd)
 Appends a string at the end of the array.
 
void insert (int index, const String &stringToAdd)
 Inserts a string into the array.
 
void addIfNotAlreadyThere (const String &stringToAdd, bool ignoreCase=false)
 Adds a string to the array as long as it's not already in there.
 
void set (int index, const String &newString)
 Replaces one of the strings in the array with another one.
 
void addArray (const StringArray &other, int startIndex=0, int numElementsToAdd=-1)
 Appends some strings from another array to the end of this one.
 
int addTokens (StringRef stringToTokenise, bool preserveQuotedStrings)
 Breaks up a string into tokens and adds them to this array.
 
int addTokens (StringRef stringToTokenise, StringRef breakCharacters, StringRef quoteCharacters)
 Breaks up a string into tokens and adds them to this array.
 
int addLines (StringRef stringToBreakUp)
 Breaks up a string into lines and adds them to this array.
 
void clear ()
 Removes all elements from the array.
 
void clearQuick ()
 Removes all elements from the array without freeing the array's allocated storage.
 
void remove (int index)
 Removes a string from the array.
 
void removeString (StringRef stringToRemove, bool ignoreCase=false)
 Finds a string in the array and removes it.
 
void removeRange (int startIndex, int numberToRemove)
 Removes a range of elements from the array.
 
void removeDuplicates (bool ignoreCase)
 Removes any duplicated elements from the array.
 
void removeEmptyStrings (bool removeWhitespaceStrings=true)
 Removes empty strings from the array.
 
void move (int currentIndex, int newIndex) noexcept
 Moves one of the strings to a different position.
 
void trim ()
 Deletes any whitespace characters from the starts and ends of all the strings.
 
void appendNumbersToDuplicates (bool ignoreCaseWhenComparing, bool appendNumberToFirstInstance, CharPointer_UTF8 preNumberString=CharPointer_UTF8(nullptr), CharPointer_UTF8 postNumberString=CharPointer_UTF8(nullptr))
 Adds numbers to the strings in the array, to make each string unique.
 
String joinIntoString (StringRef separatorString, int startIndex=0, int numberOfElements=-1) const
 Joins the strings in the array together into one string.
 
void sort (bool ignoreCase)
 Sorts the array into alphabetical order.
 
void sortNatural ()
 Sorts the array using extra language-aware rules to do a better job of comparing words containing spaces and numbers.
 
void ensureStorageAllocated (int minNumElements)
 Increases the array's internal storage to hold a minimum number of elements.
 
void minimiseStorageOverheads ()
 Reduces the amount of storage being used by the array.
 

Static Public Member Functions

static StringArray fromTokens (StringRef stringToTokenise, bool preserveQuotedStrings)
 Returns an array containing the tokens in a given string.
 
static StringArray fromTokens (StringRef stringToTokenise, StringRef breakCharacters, StringRef quoteCharacters)
 Returns an array containing the tokens in a given string.
 
static StringArray fromLines (StringRef stringToBreakUp)
 Returns an array containing the lines in a given string.
 

Public Attributes

Array< Stringstrings
 This is the array holding the actual strings.
 

Detailed Description

A special array for holding a list of strings.

See Also
String, StringPairArray

Constructor & Destructor Documentation

StringArray::StringArray ( )
noexcept

Creates an empty string array.

StringArray::StringArray ( const StringArray )

Creates a copy of another string array.

StringArray::StringArray ( const String firstValue)
explicit

Creates an array containing a single string.

StringArray::StringArray ( const String strings,
int  numberOfStrings 
)

Creates an array from a raw array of strings.

Parameters
stringsan array of strings to add
numberOfStringshow many items there are in the array
StringArray::StringArray ( const char *const *  strings,
int  numberOfStrings 
)

Creates a copy of an array of string literals.

Parameters
stringsan array of strings to add. Null pointers in the array will be treated as empty strings
numberOfStringshow many items there are in the array
StringArray::StringArray ( const char *const *  strings)
explicit

Creates a copy of a null-terminated array of string literals.

Each item from the array passed-in is added, until it encounters a null pointer, at which point it stops.

StringArray::StringArray ( const wchar_t *const *  strings)
explicit

Creates a copy of a null-terminated array of string literals.

Each item from the array passed-in is added, until it encounters a null pointer, at which point it stops.

StringArray::StringArray ( const wchar_t *const *  strings,
int  numberOfStrings 
)

Creates a copy of an array of string literals.

Parameters
stringsan array of strings to add. Null pointers in the array will be treated as empty strings
numberOfStringshow many items there are in the array
StringArray::~StringArray ( )

Destructor.

Member Function Documentation

StringArray& StringArray::operator= ( const StringArray )

Copies the contents of another string array into this one.

void StringArray::swapWith ( StringArray )
noexcept

Swaps the contents of this and another StringArray.

bool StringArray::operator== ( const StringArray ) const
noexcept

Compares two arrays.

Comparisons are case-sensitive.

Returns
true only if the other array contains exactly the same strings in the same order
bool StringArray::operator!= ( const StringArray ) const
noexcept

Compares two arrays.

Comparisons are case-sensitive.

Returns
false if the other array contains exactly the same strings in the same order
int StringArray::size ( ) const
noexcept

Returns the number of strings in the array.

Referenced by ComponentPeer::DragInfo::isEmpty(), and TracktionMarketplaceKeyGeneration::keyGenerationAppMain().

const String& StringArray::operator[] ( int  index) const
noexcept

Returns one of the strings from the array.

If the index is out-of-range, an empty string is returned.

Obviously the reference returned shouldn't be stored for later use, as the string it refers to may disappear when the array changes.

String& StringArray::getReference ( int  index)
noexcept

Returns a reference to one of the strings in the array.

This lets you modify a string in-place in the array, but you must be sure that the index is in-range.

String* StringArray::begin ( ) const
noexcept

Returns a pointer to the first String in the array.

This method is provided for compatibility with standard C++ iteration mechanisms.

String* StringArray::end ( ) const
noexcept

Returns a pointer to the String which follows the last element in the array.

This method is provided for compatibility with standard C++ iteration mechanisms.

bool StringArray::contains ( StringRef  stringToLookFor,
bool  ignoreCase = false 
) const

Searches for a string in the array.

The comparison will be case-insensitive if the ignoreCase parameter is true.

Returns
true if the string is found inside the array
int StringArray::indexOf ( StringRef  stringToLookFor,
bool  ignoreCase = false,
int  startIndex = 0 
) const

Searches for a string in the array.

The comparison will be case-insensitive if the ignoreCase parameter is true.

Parameters
stringToLookForthe string to try to find
ignoreCasewhether the comparison should be case-insensitive
startIndexthe first index to start searching from
Returns
the index of the first occurrence of the string in this array, or -1 if it isn't found.
void StringArray::add ( const String stringToAdd)

Appends a string at the end of the array.

Referenced by TracktionMarketplaceKeyGeneration::keyGenerationAppMain().

void StringArray::insert ( int  index,
const String stringToAdd 
)

Inserts a string into the array.

This will insert a string into the array at the given index, moving up the other elements to make room for it. If the index is less than zero or greater than the size of the array, the new string will be added to the end of the array.

void StringArray::addIfNotAlreadyThere ( const String stringToAdd,
bool  ignoreCase = false 
)

Adds a string to the array as long as it's not already in there.

The search can optionally be case-insensitive.

void StringArray::set ( int  index,
const String newString 
)

Replaces one of the strings in the array with another one.

If the index is higher than the array's size, the new string will be added to the end of the array; if it's less than zero nothing happens.

void StringArray::addArray ( const StringArray other,
int  startIndex = 0,
int  numElementsToAdd = -1 
)

Appends some strings from another array to the end of this one.

Parameters
otherthe array to add
startIndexthe first element of the other array to add
numElementsToAddthe maximum number of elements to add (if this is less than zero, they are all added)
int StringArray::addTokens ( StringRef  stringToTokenise,
bool  preserveQuotedStrings 
)

Breaks up a string into tokens and adds them to this array.

This will tokenise the given string using whitespace characters as the token delimiters, and will add these tokens to the end of the array.

Returns
the number of tokens added
See Also
fromTokens

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

int StringArray::addTokens ( StringRef  stringToTokenise,
StringRef  breakCharacters,
StringRef  quoteCharacters 
)

Breaks up a string into tokens and adds them to this array.

This will tokenise the given string (using the string passed in to define the token delimiters), and will add these tokens to the end of the array.

Parameters
stringToTokenisethe string to tokenise
breakCharactersa string of characters, any of which will be considered to be a token delimiter.
quoteCharactersif this string isn't empty, it defines a set of characters which are treated as quotes. Any text occurring between quotes is not broken up into tokens.
Returns
the number of tokens added
See Also
fromTokens
int StringArray::addLines ( StringRef  stringToBreakUp)

Breaks up a string into lines and adds them to this array.

This breaks a string down into lines separated by \n or \r\n, and adds each line to the array. Line-break characters are omitted from the strings that are added to the array.

static StringArray StringArray::fromTokens ( StringRef  stringToTokenise,
bool  preserveQuotedStrings 
)
static

Returns an array containing the tokens in a given string.

This will tokenise the given string using whitespace characters as the token delimiters, and return these tokens as an array.

See Also
addTokens
static StringArray StringArray::fromTokens ( StringRef  stringToTokenise,
StringRef  breakCharacters,
StringRef  quoteCharacters 
)
static

Returns an array containing the tokens in a given string.

This will tokenise the given string using whitespace characters as the token delimiters, and return these tokens as an array.

Parameters
stringToTokenisethe string to tokenise
breakCharactersa string of characters, any of which will be considered to be a token delimiter.
quoteCharactersif this string isn't empty, it defines a set of characters which are treated as quotes. Any text occurring between quotes is not broken up into tokens.
See Also
addTokens
static StringArray StringArray::fromLines ( StringRef  stringToBreakUp)
static

Returns an array containing the lines in a given string.

This breaks a string down into lines separated by \n or \r\n, and returns an array containing these lines. Line-break characters are omitted from the strings that are added to the array.

void StringArray::clear ( )

Removes all elements from the array.

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

void StringArray::clearQuick ( )

Removes all elements from the array without freeing the array's allocated storage.

See Also
clear
void StringArray::remove ( int  index)

Removes a string from the array.

If the index is out-of-range, no action will be taken.

void StringArray::removeString ( StringRef  stringToRemove,
bool  ignoreCase = false 
)

Finds a string in the array and removes it.

This will remove the first occurrence of the given string from the array. The comparison may be case-insensitive depending on the ignoreCase parameter.

void StringArray::removeRange ( int  startIndex,
int  numberToRemove 
)

Removes a range of elements from the array.

This will remove a set of elements, starting from the given index, and move subsequent elements down to close the gap.

If the range extends beyond the bounds of the array, it will be safely clipped to the size of the array.

Parameters
startIndexthe index of the first element to remove
numberToRemovehow many elements should be removed
void StringArray::removeDuplicates ( bool  ignoreCase)

Removes any duplicated elements from the array.

If any string appears in the array more than once, only the first occurrence of it will be retained.

Parameters
ignoreCasewhether to use a case-insensitive comparison
void StringArray::removeEmptyStrings ( bool  removeWhitespaceStrings = true)

Removes empty strings from the array.

Parameters
removeWhitespaceStringsif true, strings that only contain whitespace characters will also be removed
void StringArray::move ( int  currentIndex,
int  newIndex 
)
noexcept

Moves one of the strings to a different position.

This will move the string to a specified index, shuffling along any intervening elements as required.

So for example, if you have the array { 0, 1, 2, 3, 4, 5 } then calling move (2, 4) would result in { 0, 1, 3, 4, 2, 5 }.

Parameters
currentIndexthe index of the value to be moved. If this isn't a valid index, then nothing will be done
newIndexthe index at which you'd like this value to end up. If this is less than zero, the value will be moved to the end of the array
void StringArray::trim ( )

Deletes any whitespace characters from the starts and ends of all the strings.

void StringArray::appendNumbersToDuplicates ( bool  ignoreCaseWhenComparing,
bool  appendNumberToFirstInstance,
CharPointer_UTF8  preNumberString = CharPointer_UTF8(nullptr),
CharPointer_UTF8  postNumberString = CharPointer_UTF8(nullptr) 
)

Adds numbers to the strings in the array, to make each string unique.

This will add numbers to the ends of groups of similar strings. e.g. if there are two "moose" strings, they will become "moose (1)" and "moose (2)"

Parameters
ignoreCaseWhenComparingwhether the comparison used is case-insensitive
appendNumberToFirstInstancewhether the first of a group of similar strings also has a number appended to it.
preNumberStringwhen adding a number, this string is added before the number. If you pass 0, a default string will be used, which adds brackets around the number.
postNumberStringthis string is appended after any numbers that are added. If you pass 0, a default string will be used, which adds brackets around the number.
String StringArray::joinIntoString ( StringRef  separatorString,
int  startIndex = 0,
int  numberOfElements = -1 
) const

Joins the strings in the array together into one string.

This will join a range of elements from the array into a string, separating them with a given string.

e.g. joinIntoString (",") will turn an array of "a" "b" and "c" into "a,b,c".

Parameters
separatorStringthe string to insert between all the strings
startIndexthe first element to join
numberOfElementshow many elements to join together. If this is less than zero, all available elements will be used.
void StringArray::sort ( bool  ignoreCase)

Sorts the array into alphabetical order.

Parameters
ignoreCaseif true, the comparisons used will be case-sensitive.
void StringArray::sortNatural ( )

Sorts the array using extra language-aware rules to do a better job of comparing words containing spaces and numbers.

See Also
String::compareNatural()
void StringArray::ensureStorageAllocated ( int  minNumElements)

Increases the array's internal storage to hold a minimum number of elements.

Calling this before adding a large known number of elements means that the array won't have to keep dynamically resizing itself as the elements are added, and it'll therefore be more efficient.

void StringArray::minimiseStorageOverheads ( )

Reduces the amount of storage being used by the array.

Arrays typically allocate slightly more storage than they need, and after removing elements, they may have quite a lot of unused space allocated. This method will reduce the amount of allocated storage to a minimum.

Member Data Documentation

Array<String> StringArray::strings

This is the array holding the actual strings.

This is public to allow direct access to array methods that may not already be provided by the StringArray class.


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