MercuryMemory.h

Go to the documentation of this file.

#ifndef _MERCURY_MEMORY_H
#define _MERCURY_MEMORY_H

/*
    MercuryMemory is a very strange collection of yucky code.
    It's extremely dirty and is really only designed to work on
    Visual Studio under DEBUG mode.  It's extremely dirty and
    breaks virtually every coding standard.
*/

//We have to do this so C++ doesn't define a couple of functions
//  in stdlib.h.
#define _INC_MALLOC

//We have to do this in VC.NET 2003 so it doesn't try doing xdebug.
#define _XDEBUG_

#define _NEW_CRT                new
#define _DELETE_CRT(_P)     delete (_P)
#define _DELETE_CRT_VEC(_P) delete[] (_P)
#define _STRING_CRT         string

//Get the main libary that has malloc and such, but won't have that compiled
#include <stdlib.h>

//These functions are internal and should not get called.
//Each represents their normal functions.
void * MercuryMalloc( size_t x, const char * file, const int );
void * MercuryCalloc( size_t x, size_t y, const char * file, const int );
void * MercuryRealloc( void * ptr, size_t x, const char * file, const int );
//This will not actually malloc anyting, only put in a notice that something was already malloc'd
void MercuryAMalloc( void * ptr, const char * file, const int );

//Actually free ram
void MercuryFree( void * ptr );
//Put in a notice that the ram was free'd
void MercuryAFree( void * ptr );

//Include the C++ memory here, before we macro out new.
#include <memory>

class MercuryMemoryThrough
{
public:
    MercuryMemoryThrough() {}
    MercuryMemoryThrough( const char * fn, int ln ) { FILENAME=fn; LINENUMBER=ln; }
    //<< notifies a malloc
    template< class G >
    G * operator << ( G * t ) { MercuryAMalloc( (void*)t, FILENAME, LINENUMBER ); return t; }
    //>> notifies a free
    template< class G >
    G * operator >> ( G * t ) { MercuryAFree( (void*)t ); return t; }
    //File Name and Line Number of where the malloc started.
    int LINENUMBER;
    const char * FILENAME;
};

//This is a singleton, used in deletion.  We don't need another one since we don't care about
//line numbers or filenames.
extern MercuryMemoryThrough OVERALLFREE;

static class MercuryMemoryThroughMaker
{
public:
    MercuryMemoryThrough Make( const char * s, int l ) { return MercuryMemoryThrough( s, l ); }
} MTHRM;

//macro out new.  This way we call the normal new, and send the address, filename and line number
//into a temporarly made memory though class.
#define new MTHRM.Make(__FILE__,__LINE__)<<new

//override a notification for normal deletion
inline void operator delete(void* memblock)
{
    MercuryAFree( memblock );
    free( memblock );
}

//override a notification for [] deletion
inline void operator delete[](void* memblock)
{
    MercuryAFree( memblock );
    free( memblock );
}

//macro overrides for malloc, realloc, calloc and free
#define malloc( x ) MercuryMalloc( x, __FILE__, __LINE__ )
#define realloc( x, y ) MercuryRealloc( x, y, __FILE__, __LINE__ )
#define calloc( x, y ) MercuryCalloc( x, y, __FILE__, __LINE__ )
#define free( x ) MercuryFree( x )

//user accessable functions
void ResetAllLeakInfo();
void PrintAllLeakInfo();

//If you call this with "true" MercuryMemory will print all leaks
// after main.
void SetPrintOnEnd( bool POD );

#endif

/* 
 * Copyright (c) 2006 Charles Lohr
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *  -   Redistributions of source code must retain the above
 *      copyright notice, this list of conditions and the following disclaimer.
 *  -   Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *  -   Neither the name of the Mercury Engine nor the names of its
 *      contributors may be used to endorse or promote products derived from
 *      this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

---

Hosted by