lib/allocator.h

   1 /* Memory allocators such as malloc+free.
   2
   3    Copyright (C) 2011 Free Software Foundation, Inc.
   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 3 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,
  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, see <http://www.gnu.org/licenses/>.  */
  17
  18 /* Written by Paul Eggert.  */
  19
  20 #ifndef _GL_ALLOCATOR_H
  21
  22 #include <stddef.h>
  23
  24 struct allocator
  25 {
  26   /* Call MALLOC to allocate memory, like 'malloc'.  On failure MALLOC
  27      should return NULL, though not necessarily set errno.  When given
  28      a zero size it may return NULL even if successful.  */
  29   void *(*malloc) (size_t);
  30
  31   /* If nonnull, call REALLOC to reallocate memory, like 'realloc'.
  32      On failure REALLOC should return NULL, though not necessarily set
  33      errno.  When given a zero size it may return NULL even if
  34      successful.  */
  35   void *(*realloc) (void *, size_t);
  36
  37   /* Call FREE to free memory, like 'free'.  */
  38   void (*free) (void *);
  39
  40   /* If nonnull, call DIE if MALLOC or REALLOC fails.  DIE should
  41      not return.  */
  42   void (*die) (void);
  43 };
  44
  45 #endif