lib/xalloc.h

   1 /* xalloc.h -- malloc with out-of-memory checking
   2    Copyright (C) 1990-1998, 1999 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 #ifndef XALLOC_H_
  19 # define XALLOC_H_
  20
  21 # ifndef PARAMS
  22 #  if defined PROTOTYPES || (defined __STDC__ && __STDC__)
  23 #   define PARAMS(Args) Args
  24 #  else
  25 #   define PARAMS(Args) ()
  26 #  endif
  27 # endif
  28
  29 /* Exit value when the requested amount of memory is not available.
  30    It is initialized to EXIT_FAILURE, but the caller may set it to
  31    some other value.  */
  32 extern int xalloc_exit_failure;
  33
  34 /* If this pointer is non-zero, run the specified function upon each
  35    allocation failure.  It is initialized to zero. */
  36 extern void (*xalloc_fail_func) ();
  37
  38 /* If XALLOC_FAIL_FUNC is undefined or a function that returns, this
  39    message must be non-NULL.  It is translated via gettext.
  40    The default value is "Memory exhausted".  */
  41 extern char *const xalloc_msg_memory_exhausted;
  42
  43 void *xmalloc PARAMS ((size_t n));
  44 void *xcalloc PARAMS ((size_t n, size_t s));
  45 void *xrealloc PARAMS ((void *p, size_t n));
  46
  47 # define XMALLOC(Type, N_bytes) ((Type *) xmalloc (sizeof (Type) * (N_bytes)))
  48 # define XCALLOC(Type, N_bytes) ((Type *) xcalloc (sizeof (Type), (N_bytes)))
  49 # define XREALLOC(Ptr, Type, N_bytes) \
  50   ((Type *) xrealloc ((void *) (Ptr), sizeof (Type) * (N_bytes)))
  51
  52 #endif /* !XALLOC_H_ */