StaticAllocator.h

Go to the documentation of this file.

/*
 * StaticAllocator.h
 *
 * An allocator (see Allocator.h) that "allocates" memory based on a
 * pre-allocated static memory pool/buffer. Useful to manage memory on
 * architectures that don't support well dynamic allocation (such as
 * AVR-based systems). On such systems, it is usually recommended NOT
 * to use dynamic allocation to avoid problems.
 *
 * This file is part of Qualia https://github.com/sofian/qualia
 *
 * (c) 2011 Sofian Audry | info(@)sofianaudry(.)com
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef STATICALLOCATOR_H_
#define STATICALLOCATOR_H_

#include "Allocator.h"

class StaticAllocator: public Allocator {
public:
  unsigned char* buffer;
  size_t bufferSize;
  unsigned int bufferIdx;
  unsigned char* lastPtr;

  // Keeps track of leaks, for debugging.
  unsigned int nLeaks;
  unsigned char* lastLeak;

public:
  StaticAllocator(unsigned char* buffer, size_t size);

protected:
  virtual void* malloc(size_t size);

  virtual void* calloc(size_t num, size_t size);

  // WARNING: You should not use that method for static allocators unless you know what you are doing.
  virtual void* realloc(void* ptr, size_t size);

  // WARNING: Calling StaticAllocator::free() does NOT free the pointer at all. See note above.
  virtual void free(void* ptr);

  // Frees all pointers.
  virtual void freeAll();
};

#endif /* STATICALLOCATOR_H_ */