3 * $Id: dspool.c,v 1.2 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.
29 /*----- Header files ------------------------------------------------------*/
37 /*----- Main code ---------------------------------------------------------*/
39 /* --- @dspool_create@ --- *
41 * Arguments: @dspool *p@ = address of pool to create
42 * @size_t isz@ = initial size of new strings
46 * Use: Initializes a dynamic string pool.
49 void dspool_create(dspool *p, size_t isz)
55 /* --- @dspool_destroy@ --- *
57 * Arguments: @dspool *p@ = pool to destroy
61 * Use: Releases all of the strings left in the pool. Any strings
62 * not put back into the pool aren't freed. However, the pool
63 * is still valid, and the active strings can be put back and
67 void dspool_destroy(dspool *p)
69 dspoolstr *s = p->free;
71 dspoolstr *n = s->next;
79 /* --- @dspool_get@ --- *
81 * Arguments: @dspool *p@ = pointer to a string pool
83 * Returns: Pointer to a dynamic string.
85 * Use: Fetches a string from the pool. The string has space for at
86 * least @isz@ characters (where @isz@ is the size passed to
87 * @dspool_create@ for the pool).
90 dstr *dspool_get(dspool *p) { dstr *d; DSGET(p, d); return (d); }
92 /* --- @dspool_put@ --- *
94 * Arguments: @dspool *p@ = pointer to a string pool
95 * @dstr *d@ = pointer to a dynamic string from a string pool
99 * Use: Releases a dynamic string back into a string pool. It
100 * doesn't have to be the same pool the string actually came
101 * from, although it does have to have come from some string
105 void dspool_put(dspool *p, dstr *d) { DSPUT(p, d); }
107 /*----- That's all, folks -------------------------------------------------*/