arospdf/goo/gmem.h

   1 /*
   2  * gmem.h
   3  *
   4  * Memory routines with out-of-memory checking.
   5  *
   6  * Copyright 1996-2003 Glyph & Cog, LLC
   7  */
   8
   9 #ifndef GMEM_H
  10 #define GMEM_H
  11
  12 #include <stdio.h>
  13 #include <aconf.h>
  14
  15 #if USE_EXCEPTIONS
  16
  17 class GMemException {
  18 public:
  19   GMemException() {}
  20   ~GMemException() {}
  21 };
  22
  23 #define GMEM_EXCEP throw(GMemException)
  24
  25 #else // USE_EXCEPTIONS
  26
  27 #define GMEM_EXCEP
  28
  29 #endif // USE_EXCEPTIONS
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /*
  36  * Same as malloc, but prints error message and exits if malloc()
  37  * returns NULL.
  38  */
  39 extern void *gmalloc(int size) GMEM_EXCEP;
  40
  41 /*
  42  * Same as realloc, but prints error message and exits if realloc()
  43  * returns NULL.  If <p> is NULL, calls malloc instead of realloc().
  44  */
  45 extern void *grealloc(void *p, int size) GMEM_EXCEP;
  46
  47 /*
  48  * These are similar to gmalloc and grealloc, but take an object count
  49  * and size.  The result is similar to allocating nObjs * objSize
  50  * bytes, but there is an additional error check that the total size
  51  * doesn't overflow an int.
  52  */
  53 extern void *gmallocn(int nObjs, int objSize) GMEM_EXCEP;
  54 extern void *greallocn(void *p, int nObjs, int objSize) GMEM_EXCEP;
  55
  56 /*
  57  * Same as free, but checks for and ignores NULL pointers.
  58  */
  59 extern void gfree(void *p);
  60
  61 #ifdef DEBUG_MEM
  62 /*
  63  * Report on unfreed memory.
  64  */
  65 extern void gMemReport(FILE *f);
  66 #else
  67 #define gMemReport(f)
  68 #endif
  69
  70 /*
  71  * Allocate memory and copy a string into it.
  72  */
  73 extern char *copyString(char *s);
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78
  79 #endif