/*

 * gmem.h

 *

 * Memory routines with out-of-memory checking.

 *

 * Copyright 1996-2003 Glyph & Cog, LLC

 */

#ifndef GMEM_H

#define GMEM_H

#include <stdio.h>

#include <aconf.h>

#if USE_EXCEPTIONS

class GMemException {

public:

  GMemException() {}

  ~GMemException() {}

};

// This used to be:

//   #define GMEM_EXCEP throw(GMemException)

// but the throw decl was never really very useful, and is deprecated

// as of C++11 and illegal as of C++17.

#define GMEM_EXCEP

#else // USE_EXCEPTIONS

#define GMEM_EXCEP

#endif // USE_EXCEPTIONS

/*

 * Same as malloc, but prints error message and exits if malloc()

 * returns NULL.

 */

#ifdef DEBUG_MEM

extern void *gmalloc(int size, int ignore = 0) GMEM_EXCEP;

#else

extern void *gmalloc(int size) GMEM_EXCEP;

#endif

/*

 * Same as realloc, but prints error message and exits if realloc()

 * returns NULL.  If <p> is NULL, calls malloc instead of realloc().

 */

extern void *grealloc(void *p, int size) GMEM_EXCEP;

/*

 * These are similar to gmalloc and grealloc, but take an object count

 * and size.  The result is similar to allocating nObjs * objSize

 * bytes, but there is an additional error check that the total size

 * doesn't overflow an int.

 */

extern void *gmallocn(int nObjs, int objSize) GMEM_EXCEP;

extern void *greallocn(void *p, int nObjs, int objSize) GMEM_EXCEP;

/*

 * Same as gmalloc and gmallocn, but allow a 64-bit size on 64-bit

 * systems.

 */

#ifdef DEBUG_MEM

extern void *gmalloc64(size_t size, int ignore = 0) GMEM_EXCEP;

#else

extern void *gmalloc64(size_t size) GMEM_EXCEP;

#endif

extern void *gmallocn64(int nObjs, size_t objSize) GMEM_EXCEP;

/*

 * Same as free, but checks for and ignores NULL pointers.

 */

extern void gfree(void *p);

/*

 * Report a memory error.

 */

extern void gMemError(const char *msg) GMEM_EXCEP;

#ifdef DEBUG_MEM

/*

 * Report on unfreed memory.

 */

extern void gMemReport(FILE *f);

#else

#define gMemReport(f)

#endif

/*

 * Allocate memory and copy a string into it.

 */

extern char *copyString(const char *s);

#endif