chiark / gitweb /
Qualify name given to @bres_byname@.
[mLib] / alloc.c
1 /* -*-c-*-
2  *
3  * $Id: alloc.c,v 1.5 2000/07/16 12:29:16 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.c,v $
33  * Revision 1.5  2000/07/16 12:29:16  mdw
34  * Change to arena `realloc' interface, to fix a design bug.
35  *
36  * Revision 1.4  2000/06/17 10:35:51  mdw
37  * Major overhaul for arena support.
38  *
39  * Revision 1.3  1999/05/06 19:51:35  mdw
40  * Reformatted the LGPL notice a little bit.
41  *
42  * Revision 1.2  1999/05/05 18:50:31  mdw
43  * Change licensing conditions to LGPL.
44  *
45  * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
46  * Initial version of mLib
47  *
48  */
49
50 /*----- Header files ------------------------------------------------------*/
51
52 /* --- ANSI headers --- */
53
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57
58 /* --- Local headers --- */
59
60 #include "alloc.h"
61 #include "arena.h"
62 #include "exc.h"
63
64 /*----- Functions and macros ----------------------------------------------*/
65
66 /* --- @x_alloc@ --- *
67  *
68  * Arguments:   @arena *a@ = pointer to underlying arena
69  *              @size_t sz@ = size of block to allocate
70  *
71  * Returns:     Pointer to allocated block.
72  *
73  * Use:         Allocates memory.  If there's not enough memory, the
74  *              exception @EXC_NOMEM@ is thrown.
75  */
76
77 void *x_alloc(arena *a, size_t sz)
78 {
79   void *p = A_ALLOC(a, sz);
80   if (!p)
81     THROW(EXC_NOMEM);
82   return (p);
83 }
84
85 /* --- @x_strdup@ --- *
86  *
87  * Arguments:   @arena *a@ = pointer to underlying arena
88  *              @const char *s@ = pointer to a string
89  *
90  * Returns:     Pointer to a copy of the string.
91  *
92  * Use:         Copies a string (like @strdup@ would, if it existed).  If
93  *              there's not enough memory, the exception @EXC_NOMEM@ is
94  *              thrown.
95  */
96
97 char *x_strdup(arena *a, const char *s)
98 {
99   size_t sz = strlen(s) + 1;
100   char *p = x_alloc(a, sz);
101   memcpy(p, s, sz);
102   return (p);
103 }
104
105 /* --- @x_realloc@ --- *
106  *
107  * Arguments:   @arena *a@ = pointer to underlying arena
108  *              @void *p@ = pointer to a block of memory
109  *              @size_t sz@ = new size desired for the block
110  *              @size_t osz@ = size of the old block
111  *
112  * Returns:     Pointer to the resized memory block (which is almost
113  *              certainly not in the same place any more).
114  *
115  * Use:         Resizes a memory block.  If there's not enough memory, the
116  *              exception @EXC_NOMEM@ is thrown.
117  */
118
119 void *x_realloc(arena *a, void *p, size_t sz, size_t osz)
120 {
121   p = A_REALLOC(a, p, sz, osz);
122   if (!p)
123     THROW(EXC_NOMEM);
124   return (p);
125 }
126
127 /* --- @x_free@ --- *
128  *
129  * Arguments:   @arena *a@ = pointer to underlying arena
130  *              @void *p@ = pointer to a block of memory.
131  *
132  * Returns:     ---
133  *
134  * Use:         Frees a block of memory.
135  */
136
137 void (x_free)(arena *a, void *p) { x_free(a, p); }
138
139 /*----- Old functions for the standard arena ------------------------------*/
140
141 /* --- @xmalloc@ --- *
142  *
143  * Arguments:   @size_t sz@ = size of block to allocate
144  *
145  * Returns:     Pointer to allocated block.
146  *
147  * Use:         Allocates memory.  If there's not enough memory, the
148  *              exception @EXC_NOMEM@ is thrown.
149  */
150
151 void *(xmalloc)(size_t sz) { return xmalloc(sz); }
152
153 /* --- @xstrdup@ --- *
154  *
155  * Arguments:   @const char *s@ = pointer to a string
156  *
157  * Returns:     Pointer to a copy of the string.
158  *
159  * Use:         Copies a string (like @strdup@ would, if it existed).  If
160  *              there's not enough memory, the exception @EXC_NOMEM@ is
161  *              thrown.
162  */
163
164 char *(xstrdup)(const char *s) { return xstrdup(s); }
165
166 /* --- @xrealloc@ --- *
167  *
168  * Arguments:   @void *p@ = pointer to a block of memory
169  *              @size_t sz@ = new size desired for the block
170  *              @size_t osz@ = size of the old block
171  *
172  * Returns:     Pointer to the resized memory block (which is almost
173  *              certainly not in the same place any more).
174  *
175  * Use:         Resizes a memory block.  If there's not enough memory, the
176  *              exception @EXC_NOMEM@ is thrown.
177  */
178
179 void *(xrealloc)(void *p, size_t sz, size_t osz)
180 { return xrealloc(p, sz, osz); }
181
182 /* --- @xfree@ --- *
183  *
184  * Arguments:   @void *p@ = pointer to a block of memory.
185  *
186  * Returns:     ---
187  *
188  * Use:         Frees a block of memory.
189  */
190
191 void (xfree)(void *p) { xfree(p); }
192
193 /*----- That's all, folks -------------------------------------------------*/