|
JUCE
|
|
JUCE
|
An array designed for holding objects. More...
Public Types | |
| typedef TypeOfCriticalSectionToUse::ScopedLockType | ScopedLockType |
| Returns the type of scoped lock to use for locking this array. | |
Public Member Functions | |
| OwnedArray () noexcept | |
| Creates an empty array. | |
| ~OwnedArray () | |
| Deletes the array and also deletes any objects inside it. | |
| void | clear (const bool deleteObjects=true) |
| Clears the array, optionally deleting the objects inside it first. | |
| int | size () const noexcept |
| Returns the number of items currently in the array. | |
| ObjectClass * | operator[] (const int index) const noexcept |
| Returns a pointer to the object at this index in the array. | |
| ObjectClass * | getUnchecked (const int index) const noexcept |
| Returns a pointer to the object at this index in the array, without checking whether the index is in-range. | |
| ObjectClass * | getFirst () const noexcept |
| Returns a pointer to the first object in the array. | |
| ObjectClass * | getLast () const noexcept |
| Returns a pointer to the last object in the array. | |
| ObjectClass ** | getRawDataPointer () noexcept |
| Returns a pointer to the actual array data. | |
| ObjectClass ** | begin () const noexcept |
| Returns a pointer to the first element in the array. | |
| ObjectClass ** | end () const noexcept |
| Returns a pointer to the element which follows the last element in the array. | |
| int | indexOf (const ObjectClass *const objectToLookFor) const noexcept |
| Finds the index of an object which might be in the array. | |
| bool | contains (const ObjectClass *const objectToLookFor) const noexcept |
| Returns true if the array contains a specified object. | |
| void | add (const ObjectClass *const newObject) noexcept |
| Appends a new object to the end of the array. | |
| void | insert (int indexToInsertAt, const ObjectClass *const newObject) noexcept |
| Inserts a new object into the array at the given index. | |
| void | addIfNotAlreadyThere (const ObjectClass *const newObject) noexcept |
| Appends a new object at the end of the array as long as the array doesn't already contain it. | |
| void | set (const int indexToChange, const ObjectClass *const newObject, const bool deleteOldElement=true) |
| Replaces an object in the array with a different one. | |
| template<class OtherArrayType > | |
| void | addArray (const OtherArrayType &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) |
| Adds elements from another array to the end of this array. | |
| template<class OtherArrayType > | |
| void | addCopiesOf (const OtherArrayType &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) |
| Adds copies of the elements in another array to the end of this array. | |
| template<class ElementComparator > | |
| int | addSorted (ElementComparator &comparator, ObjectClass *const newObject) noexcept |
| Inserts a new object into the array assuming that the array is sorted. | |
| template<class ElementComparator > | |
| int | indexOfSorted (ElementComparator &comparator, const ObjectClass *const objectToLookFor) const noexcept |
| Finds the index of an object in the array, assuming that the array is sorted. | |
| void | remove (const int indexToRemove, const bool deleteObject=true) |
| Removes an object from the array. | |
| ObjectClass * | removeAndReturn (const int indexToRemove) |
| Removes and returns an object from the array without deleting it. | |
| void | removeObject (const ObjectClass *const objectToRemove, const bool deleteObject=true) |
| Removes a specified object from the array. | |
| void | removeRange (int startIndex, const int numberToRemove, const bool deleteObjects=true) |
| Removes a range of objects from the array. | |
| void | removeLast (int howManyToRemove=1, const bool deleteObjects=true) |
| Removes the last n objects from the array. | |
| void | swap (const int index1, const int index2) noexcept |
| Swaps a pair of objects in the array. | |
| void | move (const int currentIndex, int newIndex) noexcept |
| Moves one of the objects to a different position. | |
| void | swapWithArray (OwnedArray &otherArray) noexcept |
| This swaps the contents of this array with those of another array. | |
| void | minimiseStorageOverheads () noexcept |
| Reduces the amount of storage being used by the array. | |
| void | ensureStorageAllocated (const int minNumElements) noexcept |
| Increases the array's internal storage to hold a minimum number of elements. | |
| template<class ElementComparator > | |
| void | sort (ElementComparator &comparator, const bool retainOrderOfEquivalentItems=false) const noexcept |
| Sorts the elements in the array. | |
| const TypeOfCriticalSectionToUse & | getLock () const noexcept |
| Returns the CriticalSection that locks this array. | |
An array designed for holding objects.
This holds a list of pointers to objects, and will automatically delete the objects when they are removed from the array, or when the array is itself deleted.
Declare it in the form: OwnedArray<MyObjectClass>
..and then add new objects, e.g. myOwnedArray.add (new MyObjectClass());
After adding objects, they are 'owned' by the array and will be deleted when removed or replaced.
To make all the array's methods thread-safe, pass in "CriticalSection" as the templated TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection.
| typedef TypeOfCriticalSectionToUse::ScopedLockType OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::ScopedLockType |
Returns the type of scoped lock to use for locking this array.
| OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::OwnedArray | ( | ) |
Creates an empty array.
| OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::~OwnedArray | ( | ) |
Deletes the array and also deletes any objects inside it.
To get rid of the array without deleting its objects, use its clear (false) method before deleting it.
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::clear | ( | const bool | deleteObjects = true | ) |
Clears the array, optionally deleting the objects inside it first.
Referenced by OwnedArray< MidiBuffer >::removeLast(), and OwnedArray< MidiBuffer >::~OwnedArray().
| int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::size | ( | ) | const |
Returns the number of items currently in the array.
Referenced by StretchableObjectResizer::getNumItems(), and OwnedArray< MidiBuffer >::sort().
| ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator[] | ( | const int | index | ) | const |
Returns a pointer to the object at this index in the array.
If the index is out-of-range, this will return a null pointer, (and it could be null anyway, because it's ok for the array to hold null pointers as well as objects).
| ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::getUnchecked | ( | const int | index | ) | const |
Returns a pointer to the object at this index in the array, without checking whether the index is in-range.
This is a faster and less safe version of operator[] which doesn't check the index passed in, so it can be used when you're sure the index if always going to be legal.
| ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::getFirst | ( | ) | const |
Returns a pointer to the first object in the array.
This will return a null pointer if the array's empty.
| ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::getLast | ( | ) | const |
Returns a pointer to the last object in the array.
This will return a null pointer if the array's empty.
| ObjectClass** OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::getRawDataPointer | ( | ) |
Returns a pointer to the actual array data.
This pointer will only be valid until the next time a non-const method is called on the array.
| ObjectClass** OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::begin | ( | ) | const |
Returns a pointer to the first element in the array.
This method is provided for compatibility with standard C++ iteration mechanisms.
| ObjectClass** OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::end | ( | ) | const |
Returns a pointer to the element which follows the last element in the array.
This method is provided for compatibility with standard C++ iteration mechanisms.
| int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOf | ( | const ObjectClass *const | objectToLookFor | ) | const |
Finds the index of an object which might be in the array.
| objectToLookFor | the object to look for |
| bool OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::contains | ( | const ObjectClass *const | objectToLookFor | ) | const |
Returns true if the array contains a specified object.
| objectToLookFor | the object to look for |
Referenced by OwnedArray< MidiBuffer >::addIfNotAlreadyThere().
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::add | ( | const ObjectClass *const | newObject | ) |
Appends a new object to the end of the array.
Note that the this object will be deleted by the OwnedArray when it is removed, so be careful not to delete it somewhere else.
Also be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.
| newObject | the new object to add to the array |
Referenced by OwnedArray< MidiBuffer >::addIfNotAlreadyThere(), and OwnedArray< MidiBuffer >::insert().
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::insert | ( | int | indexToInsertAt, |
| const ObjectClass *const | newObject | ||
| ) |
Inserts a new object into the array at the given index.
Note that the this object will be deleted by the OwnedArray when it is removed, so be careful not to delete it somewhere else.
If the index is less than 0 or greater than the size of the array, the element will be added to the end of the array. Otherwise, it will be inserted into the array, moving all the later elements along to make room.
Be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.
| indexToInsertAt | the index at which the new element should be inserted |
| newObject | the new object to add to the array |
Referenced by OwnedArray< MidiBuffer >::addSorted().
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere | ( | const ObjectClass *const | newObject | ) |
Appends a new object at the end of the array as long as the array doesn't already contain it.
If the array already contains a matching object, nothing will be done.
| newObject | the new object to add to the array |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::set | ( | const int | indexToChange, |
| const ObjectClass *const | newObject, | ||
| const bool | deleteOldElement = true |
||
| ) |
Replaces an object in the array with a different one.
If the index is less than zero, this method does nothing. If the index is beyond the end of the array, the new object is added to the end of the array.
Be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.
| indexToChange | the index whose value you want to change |
| newObject | the new value to set for this index. |
| deleteOldElement | whether to delete the object that's being replaced with the new one |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addArray | ( | const OtherArrayType & | arrayToAddFrom, |
| int | startIndex = 0, |
||
| int | numElementsToAdd = -1 |
||
| ) |
Adds elements from another array to the end of this array.
| arrayToAddFrom | the array from which to copy the elements |
| startIndex | the first element of the other array to start copying from |
| numElementsToAdd | how many elements to add from the other array. If this value is negative or greater than the number of available elements, all available elements will be copied. |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addCopiesOf | ( | const OtherArrayType & | arrayToAddFrom, |
| int | startIndex = 0, |
||
| int | numElementsToAdd = -1 |
||
| ) |
Adds copies of the elements in another array to the end of this array.
The other array must be either an OwnedArray of a compatible type of object, or an Array containing pointers to the same kind of object. The objects involved must provide a copy constructor, and this will be used to create new copies of each element, and add them to this array.
| arrayToAddFrom | the array from which to copy the elements |
| startIndex | the first element of the other array to start copying from |
| numElementsToAdd | how many elements to add from the other array. If this value is negative or greater than the number of available elements, all available elements will be copied. |
| int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted | ( | ElementComparator & | comparator, |
| ObjectClass *const | newObject | ||
| ) |
Inserts a new object into the array assuming that the array is sorted.
This will use a comparator to find the position at which the new object should go. If the array isn't sorted, the behaviour of this method will be unpredictable.
| comparator | the comparator to use to compare the elements - see the sort method for details about this object's structure |
| newObject | the new object to insert to the array |
| int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOfSorted | ( | ElementComparator & | comparator, |
| const ObjectClass *const | objectToLookFor | ||
| ) | const |
Finds the index of an object in the array, assuming that the array is sorted.
This will use a comparator to do a binary-chop to find the index of the given element, if it exists. If the array isn't sorted, the behaviour of this method will be unpredictable.
| comparator | the comparator to use to compare the elements - see the sort() method for details about the form this object should take |
| objectToLookFor | the object to search for |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::remove | ( | const int | indexToRemove, |
| const bool | deleteObject = true |
||
| ) |
Removes an object from the array.
This will remove the object at a given index (optionally also deleting it) and move back all the subsequent objects to close the gap. If the index passed in is out-of-range, nothing will happen.
| indexToRemove | the index of the element to remove |
| deleteObject | whether to delete the object that is removed |
| ObjectClass* OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeAndReturn | ( | const int | indexToRemove | ) |
Removes and returns an object from the array without deleting it.
This will remove the object at a given index and return it, moving back all the subsequent objects to close the gap. If the index passed in is out-of-range, nothing will happen.
| indexToRemove | the index of the element to remove |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject | ( | const ObjectClass *const | objectToRemove, |
| const bool | deleteObject = true |
||
| ) |
Removes a specified object from the array.
If the item isn't found, no action is taken.
| objectToRemove | the object to try to remove |
| deleteObject | whether to delete the object (if it's found) |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeRange | ( | int | startIndex, |
| const int | numberToRemove, | ||
| const bool | deleteObjects = true |
||
| ) |
Removes a range of objects from the array.
This will remove a set of objects, starting from the given index, and move any 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.
| startIndex | the index of the first object to remove |
| numberToRemove | how many objects should be removed |
| deleteObjects | whether to delete the objects that get removed |
Referenced by OwnedArray< MidiBuffer >::removeLast().
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeLast | ( | int | howManyToRemove = 1, |
| const bool | deleteObjects = true |
||
| ) |
Removes the last n objects from the array.
| howManyToRemove | how many objects to remove from the end of the array |
| deleteObjects | whether to also delete the objects that are removed |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::swap | ( | const int | index1, |
| const int | index2 | ||
| ) |
Swaps a pair of objects in the array.
If either of the indexes passed in is out-of-range, nothing will happen, otherwise the two objects at these positions will be exchanged.
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::move | ( | const int | currentIndex, |
| int | newIndex | ||
| ) |
Moves one of the objects to a different position.
This will move the object 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 }.
| currentIndex | the index of the object to be moved. If this isn't a valid index, then nothing will be done |
| newIndex | the index at which you'd like this object to end up. If this is less than zero, it will be moved to the end of the array |
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::swapWithArray | ( | OwnedArray< ObjectClass, TypeOfCriticalSectionToUse > & | otherArray | ) |
This swaps the contents of this array with those of another array.
If you need to exchange two arrays, this is vastly quicker than using copy-by-value because it just swaps their internal pointers.
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::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.
Referenced by OwnedArray< MidiBuffer >::remove(), OwnedArray< MidiBuffer >::removeAndReturn(), and OwnedArray< MidiBuffer >::removeRange().
| void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::ensureStorageAllocated | ( | const 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 OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::sort | ( | ElementComparator & | comparator, |
| const bool | retainOrderOfEquivalentItems = false |
||
| ) | const |
Sorts the elements in the array.
This will use a comparator object to sort the elements into order. The object passed must have a method of the form:
int compareElements (ElementType first, ElementType second);
..and this method must return:
To improve performance, the compareElements() method can be declared as static or const.
| comparator | the comparator to use for comparing elements. |
| retainOrderOfEquivalentItems | if this is true, then items which the comparator says are equivalent will be kept in the order in which they currently appear in the array. This is slower to perform, but may be important in some cases. If it's false, a faster algorithm is used, but equivalent elements may be rearranged. |
Referenced by ValueTree::sort().
| const TypeOfCriticalSectionToUse& OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::getLock | ( | ) | const |
Returns the CriticalSection that locks this array.
To lock, you can call getLock().enter() and getLock().exit(), or preferably use an object of ScopedLockType as an RAII lock for it.
Referenced by OwnedArray< MidiBuffer >::add(), OwnedArray< MidiBuffer >::addArray(), OwnedArray< MidiBuffer >::addCopiesOf(), OwnedArray< MidiBuffer >::addIfNotAlreadyThere(), OwnedArray< MidiBuffer >::addSorted(), OwnedArray< MidiBuffer >::clear(), OwnedArray< MidiBuffer >::contains(), OwnedArray< MidiBuffer >::ensureStorageAllocated(), OwnedArray< MidiBuffer >::getFirst(), OwnedArray< MidiBuffer >::getLast(), OwnedArray< MidiBuffer >::getUnchecked(), OwnedArray< MidiBuffer >::indexOf(), OwnedArray< MidiBuffer >::indexOfSorted(), OwnedArray< MidiBuffer >::insert(), OwnedArray< MidiBuffer >::minimiseStorageOverheads(), OwnedArray< MidiBuffer >::move(), OwnedArray< MidiBuffer >::operator[](), OwnedArray< MidiBuffer >::remove(), OwnedArray< MidiBuffer >::removeAndReturn(), OwnedArray< MidiBuffer >::removeLast(), OwnedArray< MidiBuffer >::removeObject(), OwnedArray< MidiBuffer >::removeRange(), OwnedArray< MidiBuffer >::set(), OwnedArray< MidiBuffer >::sort(), OwnedArray< MidiBuffer >::swap(), and OwnedArray< MidiBuffer >::swapWithArray().