HeapBlock.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2016 ROLI Ltd.
   Copyright (C) 2017-2022 Filipe Coelho <falktx@falktx.com>
 
   Permission is granted to use this software under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license/
 
   Permission to use, copy, modify, and/or distribute this software for any
   purpose with or without fee is hereby granted, provided that the above
   copyright notice and this permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
   OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
   OF THIS SOFTWARE.
 
  ==============================================================================
*/
 
#ifndef WATER_HEAPBLOCK_H_INCLUDED
#define WATER_HEAPBLOCK_H_INCLUDED
 
#include "Memory.h"
#include "../maths/MathsFunctions.h"
 
namespace water {
 
//==============================================================================
template <class ElementType>
class HeapBlock
{
public:
    //==============================================================================
    HeapBlock() noexcept  : data (nullptr)
    {
    }

    ~HeapBlock() noexcept
    {
        std::free (data);
    }
 
    //==============================================================================
    inline operator ElementType*() const noexcept                           { return data; }

    inline ElementType* getData() const noexcept                            { return data; }

    inline const ElementType* getConstData() const noexcept                 { return data; }

    inline operator void*() const noexcept                                  { return static_cast<void*> (data); }

    inline operator const void*() const noexcept                            { return static_cast<const void*> (data); }

    inline ElementType* operator->() const  noexcept                        { return data; }

    template <typename IndexType>
    inline ElementType& operator[] (IndexType index) const noexcept         { return data [index]; }

    template <typename IndexType>
    inline ElementType* operator+ (IndexType index) const noexcept          { return data + index; }
 
    //==============================================================================
    inline bool operator== (const ElementType* const otherPointer) const noexcept   { return otherPointer == data; }

    inline bool operator!= (const ElementType* const otherPointer) const noexcept   { return otherPointer != data; }
 
    //==============================================================================
    bool malloc (const size_t newNumElements, const size_t elementSize = sizeof (ElementType)) noexcept
    {
        std::free (data);
        data = static_cast<ElementType*> (std::malloc (newNumElements * elementSize));
 
        return data != nullptr;
    }

    bool calloc (const size_t newNumElements, const size_t elementSize = sizeof (ElementType)) noexcept
    {
        std::free (data);
        data = static_cast<ElementType*> (std::calloc (newNumElements, elementSize));
 
        return data != nullptr;
    }

    bool allocate (const size_t newNumElements, bool initialiseToZero) noexcept
    {
        std::free (data);
        data = static_cast<ElementType*> (initialiseToZero
                                             ? std::calloc (newNumElements, sizeof (ElementType))
                                             : std::malloc (newNumElements * sizeof (ElementType)));
 
        return data != nullptr;
    }

    bool realloc (const size_t newNumElements, const size_t elementSize = sizeof (ElementType)) noexcept
    {
        data = static_cast<ElementType*> (data == nullptr ? std::malloc (newNumElements * elementSize)
                                                          : std::realloc (data, newNumElements * elementSize));
        return data != nullptr;
    }

    void free() noexcept
    {
        std::free (data);
        data = nullptr;
    }

    void swapWith (HeapBlock<ElementType>& other) noexcept
    {
        std::swap (data, other.data);
    }

    void clear (size_t numElements) noexcept
    {
        zeromem (data, sizeof (ElementType) * numElements);
    }

    ElementType* release() noexcept
    {
        ElementType* const r = data;
        data = nullptr;
        return r;
    }

    typedef ElementType Type;
 
private:
    //==============================================================================
    ElementType* data;
 
    CARLA_DECLARE_NON_COPYABLE(HeapBlock)
};
 
}
 
#endif // WATER_HEAPBLOCK_H_INCLUDED