3 * $Id: dspool.h,v 1.3 2004/04/08 01:36:11 mdw Exp $
5 * Provide pools of strings
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
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.
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.
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.
36 /*----- Header files ------------------------------------------------------*/
41 /*----- Data structures ---------------------------------------------------*/
43 typedef struct dspoolstr {
45 struct dspoolstr *next;
48 typedef struct dspool {
53 /*----- Functions provided ------------------------------------------------*/
55 /* --- @dspool_create@ --- *
57 * Arguments: @dspool *p@ = address of pool to create
58 * @size_t isz@ = initial size of new strings
62 * Use: Initializes a dynamic string pool.
65 extern void dspool_create(dspool */*p*/, size_t /*isz*/);
67 /* --- @dspool_destroy@ --- *
69 * Arguments: @dspool *p@ = pool to destroy
73 * Use: Releases all of the strings left in the pool. Any strings
74 * not put back into the pool aren't freed. However, the pool
75 * is still valid, and the active strings can be put back and
79 extern void dspool_destroy(dspool */*p*/);
81 /* --- @dspool_get@ --- *
83 * Arguments: @dspool *p@ = pointer to a string pool
85 * Returns: Pointer to a dynamic string.
87 * Use: Fetches a string from the pool. The string has space for at
88 * least @isz@ characters (where @isz@ is the size passed to
89 * @dspool_create@ for the pool).
92 extern dstr *dspool_get(dspool */*p*/);
94 #define DSGET(p, d) do { \
99 _p->free = _s->next; \
101 _s = CREATE(dspoolstr); \
104 DENSURE(&_s->ds, _p->isz); \
109 /* --- @dspool_put@ --- *
111 * Arguments: @dspool *p@ = pointer to a string pool
112 * @dstr *d@ = pointer to a dynamic string from a string pool
116 * Use: Releases a dynamic string back into a string pool. It
117 * doesn't have to be the same pool the string actually came
118 * from, although it does have to have come from some string
122 extern void dspool_put(dspool */*p*/, dstr */*d*/);
124 #define DSPUT(p, d) do { \
126 dspoolstr *_s = (dspoolstr *)(d); \
128 _s->next = _p->free; \
132 /*----- That's all, folks -------------------------------------------------*/