ab1529f70bc11f4293a3b3236ca2198e469bd8cf
[disorder] / lib / mem.h
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2005, 2006 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 2 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, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18 * USA
19 */
20
21 #ifndef MEM_H
22 #define MEM_H
23
24 #ifdef NO_MEMORY_ALLOCATION
25 # error including source file not allowed to perform memory allocation
26 #endif
27
28 #include <stdarg.h>
29
30 void mem_init(int gc);
31 /* initialize memory management. Set GC to 1 if garbage collection is
32 * desired. */
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 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 char *xstrdup(const char *);
46 char *xstrndup(const char *, size_t);
47 /* As malloc/realloc/strdup, but
48 * 1) succeed or call fatal
49 * 2) are garbage-collected
50 * 3) allocated space must not contain any pointers
51 *
52 * {xmalloc,xrealloc}_noptr don't promise to clear the new space
53 */
54
55 void xfree(void *ptr);
56 /* As free, but calls GC_free instead if gc is enabled */
57
58 #endif /* MEM_H */
59
60 /*
61 Local Variables:
62 c-basic-offset:2
63 comment-column:40
64 End:
65 */
66 /* arch-tag:333db053cab9e5ef91a151040d3256fb */