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

   1 /* -*-c-*-
   2  *
   3  * $Id: alloc.h,v 1.3 1999/05/06 19:51:35 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 Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (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 Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with mLib; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: alloc.h,v $
  33  * Revision 1.3  1999/05/06 19:51:35  mdw
  34  * Reformatted the LGPL notice a little bit.
  35  *
  36  * Revision 1.2  1999/05/05 18:50:31  mdw
  37  * Change licensing conditions to LGPL.
  38  *
  39  * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
  40  * Initial version of mLib
  41  *
  42  */
  43
  44 #ifndef ALLOC_H
  45 #define ALLOC_H
  46
  47 #ifdef __cplusplus
  48   extern "C" {
  49 #endif
  50
  51 #include <stddef.h>
  52
  53 /*----- Functions provided ------------------------------------------------*/
  54
  55 /* --- @xmalloc@ --- *
  56  *
  57  * Arguments:   @size_t sz@ = size of block to allocate
  58  *
  59  * Returns:     Pointer to allocated block.
  60  *
  61  * Use:         Allocates memory.  If there's not enough memory, the
  62  *              exception @EXC_NOMEM@ is thrown.
  63  */
  64
  65 extern void *xmalloc(size_t /*sz*/);
  66
  67 /* --- @xstrdup@ --- *
  68  *
  69  * Arguments:   @const char *s@ = pointer to a string
  70  *
  71  * Returns:     Pointer to a copy of the string.
  72  *
  73  * Use:         Copies a string (like @strdup@ would, if it existed).  If
  74  *              there's not enough memory, the exception @EXC_NOMEM@ is
  75  *              thrown.
  76  */
  77
  78 extern char *xstrdup(const char */*s*/);
  79
  80 /* --- @xrealloc@ --- *
  81  *
  82  * Arguments:   @void *p@ = pointer to a block of memory
  83  *              @size_t sz@ = new size desired for the block
  84  *
  85  * Returns:     Pointer to the resized memory block (which is almost
  86  *              certainly not in the same place any more).
  87  *
  88  * Use:         Resizes a memory block.  If there's not enough memory, the
  89  *              exception @EXC_NOMEM@ is thrown.
  90  */
  91
  92 extern void *xrealloc(void */*p*/, size_t /*sz*/);
  93
  94 /*----- That's all, folks -------------------------------------------------*/
  95
  96 #ifdef __cplusplus
  97   }
  98 #endif
  99
 100 #endif