chiark - git - mdw - disorder/blob - lib/mem.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004-2009 Richard Kettlewell
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/mem.h
  19  * @brief Memory management
  20  */
  21
  22 #ifndef MEM_H
  23 #define MEM_H
  24
  25 #ifdef NO_MEMORY_ALLOCATION
  26 # error including source file not allowed to perform memory allocation
  27 #endif
  28
  29 #include <stdarg.h>
  30
  31 void mem_init(void);
  32 /* initialize memory management. */
  33
  34 void *xmalloc(size_t);
  35 void *xrealloc(void *, size_t);
  36 void *xcalloc(size_t count, size_t size);
  37 /* As malloc/realloc/calloc, but
  38  * 1) succeed or call disorder_fatal
  39  * 2) always clear (the unused part of) the new allocation
  40  * 3) are garbage-collected
  41  */
  42
  43 void *xmalloc_noptr(size_t);
  44 void *xrealloc_noptr(void *, size_t);
  45 void *xcalloc_noptr(size_t count, size_t size);
  46 char *xstrdup(const char *);
  47 char *xstrndup(const char *, size_t);
  48 /* As malloc/realloc/strdup, but
  49  * 1) succeed or call disorder_fatal
  50  * 2) are garbage-collected
  51  * 3) allocated space must not contain any pointers
  52  *
  53  * {xmalloc,xrealloc}_noptr don't promise to clear the new space
  54  */
  55
  56 void xfree(void *ptr);
  57 /* As free, but calls GC_free instead if gc is enabled */
  58
  59 #endif /* MEM_H */
  60
  61 /*
  62 Local Variables:
  63 c-basic-offset:2
  64 comment-column:40
  65 End:
  66 */