chiark / gitweb /
Doxygen-clean
[disorder] / lib / mem.h
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
5aff007d 3 * Copyright (C) 2004-2008 Richard Kettlewell
460b9539 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
460b9539 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
460b9539 8 * (at your option) any later version.
e7eb3a27
RK
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 *
460b9539 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 17 */
18
19#ifndef MEM_H
20#define MEM_H
21
22#ifdef NO_MEMORY_ALLOCATION
23# error including source file not allowed to perform memory allocation
24#endif
25
26#include <stdarg.h>
27
320598d4
RK
28void mem_init(void);
29/* initialize memory management. */
460b9539 30
31void *xmalloc(size_t);
32void *xrealloc(void *, size_t);
33void *xcalloc(size_t count, size_t size);
34/* As malloc/realloc/calloc, but
35 * 1) succeed or call fatal
36 * 2) always clear (the unused part of) the new allocation
37 * 3) are garbage-collected
38 */
39
40void *xmalloc_noptr(size_t);
41void *xrealloc_noptr(void *, size_t);
42char *xstrdup(const char *);
43char *xstrndup(const char *, size_t);
44/* As malloc/realloc/strdup, but
45 * 1) succeed or call fatal
46 * 2) are garbage-collected
47 * 3) allocated space must not contain any pointers
48 *
49 * {xmalloc,xrealloc}_noptr don't promise to clear the new space
50 */
51
52void xfree(void *ptr);
53/* As free, but calls GC_free instead if gc is enabled */
54
55#endif /* MEM_H */
56
57/*
58Local Variables:
59c-basic-offset:2
60comment-column:40
61End:
62*/