MemoryBlock.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2016 ROLI Ltd.
   Copyright (C) 2017 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_MEMORYBLOCK_H_INCLUDED
#define WATER_MEMORYBLOCK_H_INCLUDED
 
#include "HeapBlock.h"
 
namespace water {
 
//==============================================================================
class MemoryBlock
{
public:
    //==============================================================================
    MemoryBlock() noexcept;

    MemoryBlock (const size_t initialSize,
                 bool initialiseToZero = false);

    MemoryBlock (const MemoryBlock&);

    MemoryBlock (const void* dataToInitialiseFrom, size_t sizeInBytes);

    ~MemoryBlock() noexcept;

    MemoryBlock& operator= (const MemoryBlock&);
 
    //==============================================================================
    bool operator== (const MemoryBlock& other) const noexcept;

    bool operator!= (const MemoryBlock& other) const noexcept;

    bool matches (const void* data, size_t dataSize) const noexcept;
 
    //==============================================================================
    void* getData() const noexcept                                  { return data; }

    template <typename Type>
    char& operator[] (const Type offset) const noexcept             { return data [offset]; }
 
 
    //==============================================================================
    size_t getSize() const noexcept                                 { return size; }

    void setSize (const size_t newSize,
                  bool initialiseNewSpaceToZero = false);

    void ensureSize (const size_t minimumSize,
                     bool initialiseNewSpaceToZero = false);

    void reset();
 
    //==============================================================================
    void fillWith (uint8 valueToUse) noexcept;

    void append (const void* data, size_t numBytes);

    void replaceWith (const void* data, size_t numBytes);

    void insert (const void* dataToInsert, size_t numBytesToInsert, size_t insertPosition);

    void removeSection (size_t startByte, size_t numBytesToRemove);
 
    //==============================================================================
    void copyFrom (const void* srcData,
                   int destinationOffset,
                   size_t numBytes) noexcept;

    void copyTo (void* destData,
                 int sourceOffset,
                 size_t numBytes) const noexcept;
 
    //==============================================================================
    void swapWith (MemoryBlock& other) noexcept;
 
    //==============================================================================
    void* release () noexcept;
 
    //==============================================================================
    String toString() const;
 
    //==============================================================================
    void loadFromHexString (StringRef sourceHexString);
 
    //==============================================================================
    void setBitRange (size_t bitRangeStart,
                      size_t numBits,
                      int binaryNumberToApply) noexcept;

    int getBitRange (size_t bitRangeStart,
                     size_t numBitsToRead) const noexcept;
 
private:
    //==============================================================================
    HeapBlock<char> data;
    size_t size;
};
 
}
 
#endif // WATER_MEMORYBLOCK_H_INCLUDED