Move to here from xallocsa.h.
[gnulib.git] / lib / xmalloca.h
1 /* Safe automatic memory allocation with out of memory checking.
2    Copyright (C) 2003, 2005, 2007 Free Software Foundation, Inc.
3    Written by Bruno Haible <bruno@clisp.org>, 2003.
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, or (at your option)
8    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, write to the Free Software Foundation,
17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
18
19 #ifndef _XMALLOCA_H
20 #define _XMALLOCA_H
21
22 #include "malloca.h"
23
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29
30 /* xmalloca(N) is a checking safe variant of alloca(N).  It allocates N bytes
31    of memory allocated on the stack, that must be freed using freesa() before
32    the function returns.  Upon failure, it exits with an error message.  */
33 #if HAVE_ALLOCA
34 # define xmalloca(N) \
35   ((N) < 4032 - sa_increment                                        \
36    ? (void *) ((char *) alloca ((N) + sa_increment) + sa_increment) \
37    : xmmalloca (N))
38 extern void * xmmalloca (size_t n);
39 #else
40 # define xmalloca(N) \
41   xmalloc (N)
42 #endif
43
44 /* Maybe we should also define a variant
45     xnmalloca (size_t n, size_t s) - behaves like xmalloca (n * s)
46    If this would be useful in your application. please speak up.  */
47
48
49 #ifdef __cplusplus
50 }
51 #endif
52
53
54 #endif /* _XMALLOCA_H */