OpenShot Audio Library | OpenShotAudio 0.3.2
|
#include <juce_ReferenceCountedArray.h>
Public Types | |
using | ObjectClassPtr = ReferenceCountedObjectPtr< ObjectClass > |
using | ScopedLockType = typename TypeOfCriticalSectionToUse::ScopedLockType |
Static Public Member Functions | |
static void | releaseObject (ObjectClass *o) |
Public Attributes | |
JUCE_DEPRECATED_WITH_BODY(void swapWithArray(ReferenceCountedArray &other) noexcept, { swapWith(other);}) private void | releaseAllObjects () |
Holds a list of objects derived from ReferenceCountedObject, or which implement basic reference-count handling methods.
The template parameter specifies the class of the object you want to point to - the easiest way to make a class reference-countable is to simply make it inherit from ReferenceCountedObject or SingleThreadedReferenceCountedObject, but if you need to, you can roll your own reference-countable class by implementing a set of methods called incReferenceCount(), decReferenceCount(), and decReferenceCountWithoutDeleting(). See ReferenceCountedObject for examples of how these methods should behave.
A ReferenceCountedArray holds objects derived from ReferenceCountedObject, and takes care of incrementing and decrementing their ref counts when they are added and removed from the array.
To make all the array's methods thread-safe, pass in "CriticalSection" as the templated TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection.
Definition at line 50 of file juce_ReferenceCountedArray.h.
using juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ObjectClassPtr = ReferenceCountedObjectPtr<ObjectClass> |
Definition at line 53 of file juce_ReferenceCountedArray.h.
using juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ScopedLockType = typename TypeOfCriticalSectionToUse::ScopedLockType |
Returns the type of scoped lock to use for locking this array
Definition at line 875 of file juce_ReferenceCountedArray.h.
|
default |
Creates an empty array.
|
inlinenoexcept |
Creates a copy of another array
Definition at line 62 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Moves from another array
Definition at line 73 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Creates a copy of another array
Definition at line 80 of file juce_ReferenceCountedArray.h.
|
inline |
Destructor. Any objects in the array will be released, and may be deleted if not referenced from elsewhere.
Definition at line 123 of file juce_ReferenceCountedArray.h.
|
inline |
Appends a new object to the end of the array.
This will increase the new object's reference count.
newObject | the new object to add to the array |
Definition at line 372 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::add().
|
inline |
Appends a new object to the end of the array.
This will increase the new object's reference count.
newObject | the new object to add to the array |
Definition at line 354 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere().
|
inlinenoexcept |
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. |
Definition at line 498 of file juce_ReferenceCountedArray.h.
|
inline |
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 |
Definition at line 439 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere().
|
inline |
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 |
Definition at line 420 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Inserts or replaces an object in the array, assuming it is sorted.
This is similar to addSorted, but if a matching element already exists, then it will be replaced by the new one, rather than the new one being added as well.
Definition at line 542 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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 object to use to compare the elements - see the sort() method for details about this object's form |
newObject | the new object to insert to the array |
Definition at line 528 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Returns a pointer to the first element in the array. This method is provided for compatibility with standard C++ iteration mechanisms.
Definition at line 251 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Returns a pointer to the first element in the array. This method is provided for compatibility with standard C++ iteration mechanisms.
Definition at line 243 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::data(), and juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::data().
|
inline |
Removes all objects from the array. Any objects in the array whose reference counts drop to zero will be deleted.
Definition at line 132 of file juce_ReferenceCountedArray.h.
|
inline |
Removes all objects from the array without freeing the array's allocated storage. Any objects in the array that whose reference counts drop to zero will be deleted.
Definition at line 143 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::clear().
|
inlinenoexcept |
Returns true if the array contains a specified object.
objectToLookFor | the object to look for |
Definition at line 323 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere().
|
inlinenoexcept |
Returns true if the array contains a specified object.
objectToLookFor | the object to look for |
Definition at line 345 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::contains().
|
inlinenoexcept |
Returns a pointer to the first element in the array. This method is provided for compatibility with the standard C++ containers.
Definition at line 283 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Returns a pointer to the first element in the array. This method is provided for compatibility with the standard C++ containers.
Definition at line 275 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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.
Definition at line 267 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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.
Definition at line 259 of file juce_ReferenceCountedArray.h.
|
inline |
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.
Definition at line 861 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Returns a pointer to the first object in the array.
This will return a null pointer if the array's empty.
Definition at line 213 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Returns a pointer to the last object in the array.
This will return a null pointer if the array's empty.
Definition at line 224 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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.
Definition at line 872 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::add(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addArray(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addOrReplaceSorted(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::clear(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::clearQuick(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::contains(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ensureStorageAllocated(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getFirst(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getLast(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getObjectPointer(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getObjectPointerUnchecked(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOf(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOfSorted(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::minimiseStorageOverheads(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::move(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator==(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::remove(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeAndReturn(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeLast(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeRange(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::set(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::sort(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::swap(), and juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::swapWith().
|
inlinenoexcept |
Returns a raw 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).
Definition at line 193 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator[]().
|
inlinenoexcept |
Returns a raw pointer to the object at this index in the array, without checking whether the index is in-range.
Definition at line 202 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getUnchecked().
|
inlinenoexcept |
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.
Definition at line 234 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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 is always going to be legal.
Definition at line 180 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Finds the index of the first occurrence of an object in the array.
objectToLookFor | the object to look for |
Definition at line 294 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject().
|
inlinenoexcept |
Finds the index of the first occurrence of an object in the array.
objectToLookFor | the object to look for |
Definition at line 316 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOf().
|
inlinenoexcept |
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 |
Definition at line 566 of file juce_ReferenceCountedArray.h.
|
inline |
Inserts a new object into the array at the given index.
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.
This will increase the new object's reference count.
indexToInsertAt | the index at which the new element should be inserted |
newObject | the new object to add to the array |
Definition at line 410 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::insert().
|
inline |
Inserts a new object into the array at the given index.
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.
This will increase the new object's reference count.
indexToInsertAt | the index at which the new element should be inserted |
newObject | the new object to add to the array |
Definition at line 387 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addOrReplaceSorted(), and juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted().
|
inlinenoexcept |
Returns true if the array is empty, false otherwise.
Definition at line 156 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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.
Definition at line 849 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::remove(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeAndReturn(), and juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeRange().
|
inlinenoexcept |
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 |
Definition at line 759 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Compares this array to another one.
Definition at line 798 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Copies another array into this one. Any existing objects in this array will first be released.
Definition at line 93 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Copies another array into this one. Any existing objects in this array will first be released.
Definition at line 105 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Moves from another array
Definition at line 113 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
Compares this array to another one.
Definition at line 787 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator!=().
|
inlinenoexcept |
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).
Definition at line 169 of file juce_ReferenceCountedArray.h.
|
inlinestatic |
Definition at line 900 of file juce_ReferenceCountedArray.h.
|
inline |
Removes an object from the array.
This will remove the object at a given index and move back all the subsequent objects to close the gap.
If the index passed in is out-of-range, nothing will happen.
The object that is removed will have its reference count decreased, and may be deleted if not referenced from elsewhere.
indexToRemove | the index of the element to remove |
Definition at line 606 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeLast(), and juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject().
|
inline |
Removes and returns an object from the array.
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 and a null pointer will be returned.
indexToRemove | the index of the element to remove |
Definition at line 630 of file juce_ReferenceCountedArray.h.
|
inline |
Removes the last n objects from the array.
The objects that are removed will have their reference counts decreased, and may be deleted if not referenced from elsewhere.
howManyToRemove | how many objects to remove from the end of the array |
Definition at line 719 of file juce_ReferenceCountedArray.h.
|
inline |
Removes the first occurrence of a specified object from the array.
If the item isn't found, no action is taken. If it is found, it is removed and has its reference count decreased.
objectToRemove | the object to try to remove |
Definition at line 671 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject().
|
inline |
Removes the first occurrence of a specified object from the array.
If the item isn't found, no action is taken. If it is found, it is removed and has its reference count decreased.
objectToRemove | the object to try to remove |
Definition at line 657 of file juce_ReferenceCountedArray.h.
|
inline |
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.
The objects that are removed will have their reference counts decreased, and may be deleted if not referenced from elsewhere.
startIndex | the index of the first object to remove |
numberToRemove | how many objects should be removed |
Definition at line 688 of file juce_ReferenceCountedArray.h.
|
inline |
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.
The object being added has its reference count increased, and if it's replacing another object, then that one has its reference count decreased, and may be deleted.
indexToChange | the index whose value you want to change |
newObject | the new value to set for this index. |
Definition at line 487 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::set().
|
inline |
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.
The object being added has its reference count increased, and if it's replacing another object, then that one has its reference count decreased, and may be deleted.
indexToChange | the index whose value you want to change |
newObject | the new value to set for this index. |
Definition at line 453 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addOrReplaceSorted().
|
inlinenoexcept |
Returns the current number of objects in the array.
Definition at line 150 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::isEmpty().
|
inlinenoexcept |
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:
..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. |
Definition at line 831 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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.
Definition at line 735 of file juce_ReferenceCountedArray.h.
|
inlinenoexcept |
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.
Definition at line 775 of file juce_ReferenceCountedArray.h.
Referenced by juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator=(), and juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator=().
|
inline |
Definition at line 888 of file juce_ReferenceCountedArray.h.