memory_checker.h

Go to the documentation of this file.

#ifndef MEMORY_CHECKER_CLASS
#define MEMORY_CHECKER_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : memory_checker                                                    *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1998-$now By Author.  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 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "definitions.h"

#ifdef ENABLE_MEMORY_HOOK

#include "build_configuration.h"

// forward.
class allocation_memories;
class memory_checker;


memory_checker BASIS_EXTERN &program_wide_memories();




class memory_checker
{
public:
  void construct();  

  void destruct();  

  void disable() { _enabled = false; }
  void enable() { _enabled = true; }
  bool enabled() const { return _enabled; }

  void *provide_memory(size_t size, char *file, int line);

  int release_memory(void *ptr);

  char *text_form(bool show_outstanding);

private:
  allocation_memories *_mems;  
  bool _unusable;  
  bool _enabled;  
};

#else // enable memory hook.
  // this section disables the memory checker entirely.
  #define program_wide_memories()
    // define a do nothing macro for the global memory tracker.
#endif // enable memory hook.

#endif // outer guard.

---