chiark - git - mdw - mLib/blob - alloc.h

   1 /* -*-c-*-
   2  *
   3  * $Id: alloc.h,v 1.1 1998/06/17 23:44:42 mdw Exp $
   4  *
   5  * Memory allocation functions
   6  *
   7  * (c) 1998 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the mLib utilities library.
  13  *
  14  * mLib is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * mLib is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with mLib; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 /*----- Revision history --------------------------------------------------*
  30  *
  31  * $Log: alloc.h,v $
  32  * Revision 1.1  1998/06/17 23:44:42  mdw
  33  * Initial revision
  34  *
  35  */
  36
  37 #ifndef ALLOC_H
  38 #define ALLOC_H
  39
  40 #ifdef __cplusplus
  41   extern "C" {
  42 #endif
  43
  44 #include <stddef.h>
  45
  46 /*----- Functions provided ------------------------------------------------*/
  47
  48 /* --- @xmalloc@ --- *
  49  *
  50  * Arguments:   @size_t sz@ = size of block to allocate
  51  *
  52  * Returns:     Pointer to allocated block.
  53  *
  54  * Use:         Allocates memory.  If there's not enough memory, the
  55  *              exception @EXC_NOMEM@ is thrown.
  56  */
  57
  58 extern void *xmalloc(size_t /*sz*/);
  59
  60 /* --- @xstrdup@ --- *
  61  *
  62  * Arguments:   @const char *s@ = pointer to a string
  63  *
  64  * Returns:     Pointer to a copy of the string.
  65  *
  66  * Use:         Copies a string (like @strdup@ would, if it existed).  If
  67  *              there's not enough memory, the exception @EXC_NOMEM@ is
  68  *              thrown.
  69  */
  70
  71 extern char *xstrdup(const char */*s*/);
  72
  73 /* --- @xrealloc@ --- *
  74  *
  75  * Arguments:   @void *p@ = pointer to a block of memory
  76  *              @size_t sz@ = new size desired for the block
  77  *
  78  * Returns:     Pointer to the resized memory block (which is almost
  79  *              certainly not in the same place any more).
  80  *
  81  * Use:         Resizes a memory block.  If there's not enough memory, the
  82  *              exception @EXC_NOMEM@ is thrown.
  83  */
  84
  85 extern void *xrealloc(void */*p*/, size_t /*sz*/);
  86
  87 /*----- That's all, folks -------------------------------------------------*/
  88
  89 #ifdef __cplusplus
  90   }
  91 #endif
  92
  93 #endif