Add comments.
[gnulib.git] / lib / xmalloc.c
1 /* xmalloc.c -- malloc with out of memory checking
2    Copyright (C) 1990-1997, 98 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2, or (at your option)
7    any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software Foundation,
16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
17
18 #if HAVE_CONFIG_H
19 # include <config.h>
20 #endif
21
22 #include <sys/types.h>
23
24 #if STDC_HEADERS
25 # include <stdlib.h>
26 #else
27 void *calloc ();
28 void *malloc ();
29 void *realloc ();
30 void free ();
31 #endif
32
33 #if ENABLE_NLS
34 # include <libintl.h>
35 # define _(Text) gettext (Text)
36 #else
37 # define textdomain(Domain)
38 # define _(Text) Text
39 #endif
40 #define N_(Text) Text
41
42 #include "error.h"
43 #include "xalloc.h"
44
45 #ifndef EXIT_FAILURE
46 # define EXIT_FAILURE 1
47 #endif
48
49 #ifndef HAVE_DONE_WORKING_MALLOC_CHECK
50 you must run the autoconf test for a properly working malloc -- see malloc.m4
51 #endif
52
53 #ifndef HAVE_DONE_WORKING_REALLOC_CHECK
54 you must run the autoconf test for a properly working realloc -- see realloc.m4
55 #endif
56
57 /* Exit value when the requested amount of memory is not available.
58    The caller may set it to some other value.  */
59 int xalloc_exit_failure = EXIT_FAILURE;
60
61 /* If non NULL, call this function when memory is exhausted. */
62 void (*xalloc_fail_func) () = 0;
63
64 /* If XALLOC_FAIL_FUNC is NULL, or does return, display this message
65    before exiting when memory is exhausted.  Goes through gettext. */
66 char *const xalloc_msg_memory_exhausted = N_("Memory exhausted");
67
68 static void
69 xalloc_fail (void)
70 {
71   if (xalloc_fail_func)
72     (*xalloc_fail_func) ();
73   error (xalloc_exit_failure, 0, xalloc_msg_memory_exhausted);
74 }
75
76 /* Allocate N bytes of memory dynamically, with error checking.  */
77
78 void *
79 xmalloc (size_t n)
80 {
81   void *p;
82
83   p = malloc (n);
84   if (p == 0)
85     xalloc_fail ();
86   return p;
87 }
88
89 /* Change the size of an allocated block of memory P to N bytes,
90    with error checking.
91    If P is NULL, run xmalloc.  */
92
93 void *
94 xrealloc (void *p, size_t n)
95 {
96   p = realloc (p, n);
97   if (p == 0)
98     xalloc_fail ();
99   return p;
100 }
101
102 /* Allocate memory for N elements of S bytes, with error checking.  */
103
104 void *
105 xcalloc (size_t n, size_t s)
106 {
107   void *p;
108
109   p = calloc (n, s);
110   if (p == 0)
111     xalloc_fail ();
112   return p;
113 }