| 1 | /* -*-c-*- |
| 2 | * |
| 3 | * $Id: sub.h,v 1.2 1999/05/05 18:50:31 mdw Exp $ |
| 4 | * |
| 5 | * Allocation of known-size blocks |
| 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 Software |
| 26 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 27 | */ |
| 28 | |
| 29 | /*----- Revision history --------------------------------------------------* |
| 30 | * |
| 31 | * $Log: sub.h,v $ |
| 32 | * Revision 1.2 1999/05/05 18:50:31 mdw |
| 33 | * Change licensing conditions to LGPL. |
| 34 | * |
| 35 | * Revision 1.1.1.1 1998/06/17 23:44:42 mdw |
| 36 | * Initial version of mLib |
| 37 | * |
| 38 | */ |
| 39 | |
| 40 | #ifndef SUB_H |
| 41 | #define SUB_H |
| 42 | |
| 43 | #ifdef __cplusplus |
| 44 | extern "C" { |
| 45 | #endif |
| 46 | |
| 47 | /*----- Required header files ---------------------------------------------*/ |
| 48 | |
| 49 | #include <stdlib.h> |
| 50 | |
| 51 | #ifndef ALLOC_H |
| 52 | # include "alloc.h" |
| 53 | #endif |
| 54 | |
| 55 | /*----- Functions provided ------------------------------------------------*/ |
| 56 | |
| 57 | /* --- @sub_alloc@ --- * |
| 58 | * |
| 59 | * Arguments: @size_t s@ = size of chunk wanted |
| 60 | * |
| 61 | * Returns: Pointer to a block at least as large as the one wanted. |
| 62 | * |
| 63 | * Use: Allocates a small block of memory. If there is no more |
| 64 | * memory left, the exception @EXC_NOMEM@ is raised. |
| 65 | */ |
| 66 | |
| 67 | #ifdef TRACK_ENABLE |
| 68 | # define sub_alloc(s) xmalloc(s) |
| 69 | #else |
| 70 | void *sub_alloc(size_t s); |
| 71 | #endif |
| 72 | |
| 73 | /* --- @sub_free@ --- * |
| 74 | * |
| 75 | * Arguments: @void *p@ = address of block to free |
| 76 | * @size_t s@ = size of block |
| 77 | * |
| 78 | * Returns: --- |
| 79 | * |
| 80 | * Use: Frees a block allocated by @sub_alloc@. |
| 81 | */ |
| 82 | |
| 83 | #ifdef TRACK_ENABLE |
| 84 | # define sub_free(p, s) free(p) |
| 85 | #else |
| 86 | void sub_free(void *p, size_t s); |
| 87 | #endif |
| 88 | |
| 89 | /* --- @CREATE@ --- * |
| 90 | * |
| 91 | * Arguments: @type@ = type of object required; must be passable to |
| 92 | * @sizeof@ |
| 93 | * |
| 94 | * Returns: Pointer to a block sufficiently big to hold an object of the |
| 95 | * named type. |
| 96 | * |
| 97 | * Use: Allocates a block of the required type. |
| 98 | */ |
| 99 | |
| 100 | #define CREATE(type) sub_alloc(sizeof(type)) |
| 101 | |
| 102 | /* --- @DESTROY@ --- * |
| 103 | * |
| 104 | * Arguments: @void *p@ = pointer to an object |
| 105 | * |
| 106 | * Returns: --- |
| 107 | * |
| 108 | * Use: Frees the thing pointed to by @p@. |
| 109 | */ |
| 110 | |
| 111 | #define DESTROY(p) sub_free(p, sizeof(*p)) |
| 112 | |
| 113 | /* --- @sub_init@ --- * |
| 114 | * |
| 115 | * Arguments: --- |
| 116 | * |
| 117 | * Returns: --- |
| 118 | * |
| 119 | * Use: Initialises the magic allocator. |
| 120 | */ |
| 121 | |
| 122 | void sub_init(void); |
| 123 | |
| 124 | /*----- That's all, folks -------------------------------------------------*/ |
| 125 | |
| 126 | #ifdef __cplusplus |
| 127 | } |
| 128 | #endif |
| 129 | |
| 130 | #endif |