|
JUCE
|
Very simple container class to hold a pointer to some data on the heap. More...
Public Types | |
| typedef ElementType | Type |
| This typedef can be used to get the type of the heapblock's elements. More... | |
Public Member Functions | |
| HeapBlock () noexcept | |
| Creates a HeapBlock which is initially just a null pointer. More... | |
| HeapBlock (const size_t numElements) | |
| Creates a HeapBlock containing a number of elements. More... | |
| HeapBlock (const size_t numElements, const bool initialiseToZero) | |
| Creates a HeapBlock containing a number of elements. More... | |
| ~HeapBlock () | |
| Destructor. More... | |
| HeapBlock (HeapBlock &&other) noexcept | |
| HeapBlock & | operator= (HeapBlock &&other) noexcept |
| operator ElementType * () const noexcept | |
| Returns a raw pointer to the allocated data. More... | |
| ElementType * | getData () const noexcept |
| Returns a raw pointer to the allocated data. More... | |
| operator void * () const noexcept | |
| Returns a void pointer to the allocated data. More... | |
| operator const void * () const noexcept | |
| Returns a void pointer to the allocated data. More... | |
| ElementType * | operator-> () const noexcept |
| Lets you use indirect calls to the first element in the array. More... | |
| template<typename IndexType > | |
| ElementType & | operator[] (IndexType index) const noexcept |
| Returns a reference to one of the data elements. More... | |
| template<typename IndexType > | |
| ElementType * | operator+ (IndexType index) const noexcept |
| Returns a pointer to a data element at an offset from the start of the array. More... | |
| bool | operator== (const ElementType *const otherPointer) const noexcept |
| Compares the pointer with another pointer. More... | |
| bool | operator!= (const ElementType *const otherPointer) const noexcept |
| Compares the pointer with another pointer. More... | |
| void | malloc (const size_t newNumElements, const size_t elementSize=sizeof(ElementType)) |
| Allocates a specified amount of memory. More... | |
| void | calloc (const size_t newNumElements, const size_t elementSize=sizeof(ElementType)) |
| Allocates a specified amount of memory and clears it. More... | |
| void | allocate (const size_t newNumElements, bool initialiseToZero) |
| Allocates a specified amount of memory and optionally clears it. More... | |
| void | realloc (const size_t newNumElements, const size_t elementSize=sizeof(ElementType)) |
| Re-allocates a specified amount of memory. More... | |
| void | free () noexcept |
| Frees any currently-allocated data. More... | |
| template<bool otherBlockThrows> | |
| void | swapWith (HeapBlock< ElementType, otherBlockThrows > &other) noexcept |
| Swaps this object's data with the data of another HeapBlock. More... | |
| void | clear (size_t numElements) noexcept |
| This fills the block with zeros, up to the number of elements specified. More... | |
Very simple container class to hold a pointer to some data on the heap.
When you need to allocate some heap storage for something, always try to use this class instead of allocating the memory directly using malloc/free.
A HeapBlock<char> object can be treated in pretty much exactly the same way as an char*, but as long as you allocate it on the stack or as a class member, it's almost impossible for it to leak memory.
It also makes your code much more concise and readable than doing the same thing using direct allocations,
E.g. instead of this:
..you could just write this:
The class is extremely lightweight, containing only a pointer to the data, and exposes malloc/realloc/calloc/free methods that do the same jobs as their less object-oriented counterparts. Despite adding safety, you probably won't sacrifice any performance by using this in place of normal pointers.
The throwOnFailure template parameter can be set to true if you'd like the class to throw a std::bad_alloc exception when an allocation fails. If this is false, then a failed allocation will just leave the heapblock with a null pointer (assuming that the system's malloc() function doesn't throw).
| typedef ElementType HeapBlock< ElementType, throwOnFailure >::Type |
This typedef can be used to get the type of the heapblock's elements.
| HeapBlock< ElementType, throwOnFailure >::HeapBlock | ( | const size_t | numElements, |
| const bool | initialiseToZero | ||
| ) |
Creates a HeapBlock containing a number of elements.
The initialiseToZero parameter determines whether the new memory should be cleared, or left uninitialised.
| HeapBlock< ElementType, throwOnFailure >::~HeapBlock | ( | ) |
Destructor.
This will free the data, if any has been allocated.
|
noexcept |
|
noexcept |
|
noexcept |
Returns a raw pointer to the allocated data.
This may be a null pointer if the data hasn't yet been allocated, or if it has been freed by calling the free() method.
|
noexcept |
Returns a raw pointer to the allocated data.
This may be a null pointer if the data hasn't yet been allocated, or if it has been freed by calling the free() method.
Referenced by ReferenceCountedArray< AudioProcessorGraph::Node >::addOrReplaceSorted(), ReferenceCountedArray< AudioProcessorGraph::Node >::addSorted(), OwnedArray< MidiBuffer >::addSorted(), OwnedArray< MidiBuffer >::contains(), ReferenceCountedArray< AudioProcessorGraph::Node >::contains(), AudioUnitHelpers::ChannelRemapper::get(), OwnedArray< MidiBuffer >::indexOf(), ReferenceCountedArray< AudioProcessorGraph::Node >::indexOf(), OwnedArray< MidiBuffer >::removeObject(), AudioBuffer< float >::reverse(), AudioBuffer< float >::setSize(), ReferenceCountedArray< AudioProcessorGraph::Node >::sort(), and OwnedArray< MidiBuffer >::sort().
|
noexcept |
Returns a void pointer to the allocated data.
This may be a null pointer if the data hasn't yet been allocated, or if it has been freed by calling the free() method.
|
noexcept |
Returns a void pointer to the allocated data.
This may be a null pointer if the data hasn't yet been allocated, or if it has been freed by calling the free() method.
|
noexcept |
Lets you use indirect calls to the first element in the array.
Obviously this will cause problems if the array hasn't been initialised, because it'll be referencing a null pointer.
|
noexcept |
Returns a reference to one of the data elements.
Obviously there's no bounds-checking here, as this object is just a dumb pointer and has no idea of the size it currently has allocated.
|
noexcept |
Returns a pointer to a data element at an offset from the start of the array.
This is the same as doing pointer arithmetic on the raw pointer itself.
|
noexcept |
Compares the pointer with another pointer.
This can be handy for checking whether this is a null pointer.
|
noexcept |
Compares the pointer with another pointer.
This can be handy for checking whether this is a null pointer.
| void HeapBlock< ElementType, throwOnFailure >::malloc | ( | const size_t | newNumElements, |
| const size_t | elementSize = sizeof (ElementType) |
||
| ) |
Allocates a specified amount of memory.
This uses the normal malloc to allocate an amount of memory for this object. Any previously allocated memory will be freed by this method.
The number of bytes allocated will be (newNumElements * elementSize). Normally you wouldn't need to specify the second parameter, but it can be handy if you need to allocate a size in bytes rather than in terms of the number of elements.
The data that is allocated will be freed when this object is deleted, or when you call free() or any of the allocation methods.
Referenced by AudioBuffer< float >::reverse().
| void HeapBlock< ElementType, throwOnFailure >::calloc | ( | const size_t | newNumElements, |
| const size_t | elementSize = sizeof (ElementType) |
||
| ) |
Allocates a specified amount of memory and clears it.
This does the same job as the malloc() method, but clears the memory that it allocates.
Referenced by AudioUnitHelpers::ChannelRemapper::get().
| void HeapBlock< ElementType, throwOnFailure >::allocate | ( | const size_t | newNumElements, |
| bool | initialiseToZero | ||
| ) |
Allocates a specified amount of memory and optionally clears it.
This does the same job as either malloc() or calloc(), depending on the initialiseToZero parameter.
Referenced by AudioBuffer< float >::setSize().
| void HeapBlock< ElementType, throwOnFailure >::realloc | ( | const size_t | newNumElements, |
| const size_t | elementSize = sizeof (ElementType) |
||
| ) |
Re-allocates a specified amount of memory.
The semantics of this method are the same as malloc() and calloc(), but it uses realloc() to keep as much of the existing data as possible.
Referenced by ArrayAllocationBase< ProgressBar *, DummyCriticalSection >::setAllocatedSize().
|
noexcept |
Frees any currently-allocated data.
This will free the data and reset this object to be a null pointer.
Referenced by ArrayAllocationBase< ProgressBar *, DummyCriticalSection >::setAllocatedSize(), and AudioBuffer< float >::setDataToReferTo().
|
noexcept |
Swaps this object's data with the data of another HeapBlock.
The two objects simply exchange their data pointers.
Referenced by AudioBuffer< float >::setSize(), and ArrayAllocationBase< ProgressBar *, DummyCriticalSection >::swapWith().
|
noexcept |
This fills the block with zeros, up to the number of elements specified.
Since the block has no way of knowing its own size, you must make sure that the number of elements you specify doesn't exceed the allocated size.
Referenced by AudioBuffer< float >::setSize().
