3 * $Id: dspool.h,v 1.2 1999/12/10 23:42:04 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.
29 /*----- Revision history --------------------------------------------------*
32 * Revision 1.2 1999/12/10 23:42:04 mdw
33 * Change header file guard names.
35 * Revision 1.1 1999/05/21 22:15:26 mdw
36 * Dynamic string pool system, based on an idea from the `sw-tools'
37 * project. Could do with more work to make it really good.
48 /*----- Header files ------------------------------------------------------*/
53 /*----- Data structures ---------------------------------------------------*/
55 typedef struct dspoolstr {
57 struct dspoolstr *next;
60 typedef struct dspool {
65 /*----- Functions provided ------------------------------------------------*/
67 /* --- @dspool_create@ --- *
69 * Arguments: @dspool *p@ = address of pool to create
70 * @size_t isz@ = initial size of new strings
74 * Use: Initializes a dynamic string pool.
77 extern void dspool_create(dspool */*p*/, size_t /*isz*/);
79 /* --- @dspool_destroy@ --- *
81 * Arguments: @dspool *p@ = pool to destroy
85 * Use: Releases all of the strings left in the pool. Any strings
86 * not put back into the pool aren't freed. However, the pool
87 * is still valid, and the active strings can be put back and
91 extern void dspool_destroy(dspool */*p*/);
93 /* --- @dspool_get@ --- *
95 * Arguments: @dspool *p@ = pointer to a string pool
97 * Returns: Pointer to a dynamic string.
99 * Use: Fetches a string from the pool. The string has space for at
100 * least @isz@ characters (where @isz@ is the size passed to
101 * @dspool_create@ for the pool).
104 extern dstr *dspool_get(dspool */*p*/);
106 #define DSGET(p, d) do { \
111 _p->free = _s->next; \
113 _s = CREATE(dspoolstr); \
116 DENSURE(&_s->ds, _p->isz); \
121 /* --- @dspool_put@ --- *
123 * Arguments: @dspool *p@ = pointer to a string pool
124 * @dstr *d@ = pointer to a dynamic string from a string pool
128 * Use: Releases a dynamic string back into a string pool. It
129 * doesn't have to be the same pool the string actually came
130 * from, although it does have to have come from some string
134 extern void dspool_put(dspool */*p*/, dstr */*d*/);
136 #define DSPUT(p, d) do { \
138 dspoolstr *_s = (dspoolstr *)(d); \
140 _s->next = _p->free; \
144 /*----- That's all, folks -------------------------------------------------*/