3 * $Id: dstr.c,v 1.11 1999/10/28 22:05:29 mdw Exp $
5 * Handle dynamically growing strings
7 * (c) 1998 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
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.11 1999/10/28 22:05:29 mdw
34 * Modify and debug allocation routines.
36 * Revision 1.10 1999/10/04 21:44:47 mdw
37 * Move `dstr_putf' and `dstr_vputf' into a separate source file.
39 * Revision 1.9 1999/07/06 19:16:06 mdw
40 * Simplify buffer-growing algorithm. Just double it each time.
42 * Revision 1.8 1999/06/01 09:47:52 mdw
43 * Fix nasty bugs in `dstr_vputf'.
45 * Revision 1.7 1999/05/21 22:14:30 mdw
46 * Take advantage of the new dynamic string macros.
48 * Revision 1.6 1999/05/21 08:38:33 mdw
49 * Implement some more functions in terms of macros.
51 * Revision 1.5 1999/05/13 22:47:57 mdw
52 * Misc documentation fixes. Change `-ise' to `-ize' throughout.
54 * Revision 1.4 1999/05/06 19:51:35 mdw
55 * Reformatted the LGPL notice a little bit.
57 * Revision 1.3 1999/05/05 18:50:31 mdw
58 * Change licensing conditions to LGPL.
60 * Revision 1.2 1998/12/15 23:53:22 mdw
61 * New functions `dstr_putf' and `dstr_vputf' which do `printf'-style
62 * formatting in a safe way.
64 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
65 * Initial version of mLib
69 /*----- Header files ------------------------------------------------------*/
78 /*----- Tunable constants -------------------------------------------------*/
81 * If the buffer is empty, it is set to @DSTR_INITSZ@ bytes in size.
82 * Otherwise, it's set to the next power of two that's large enough. This is
83 * memory-hungry, but efficient.
86 #define DSTR_INITSZ 64 /* Initial buffer size */
88 /*----- Main code ---------------------------------------------------------*/
90 /* --- @dstr_create@ --- *
92 * Arguments: @dstr *d@ = pointer to a dynamic string block
96 * Use: Initializes a dynamic string.
99 void dstr_create(dstr *d) { DCREATE(d); }
101 /* --- @dstr_destroy@ --- *
103 * Arguments: @dstr *d@ = pointer to a dynamic string block
107 * Use: Reclaims the space used by a dynamic string.
110 void dstr_destroy(dstr *d) { DDESTROY(d); }
112 /* --- @dstr_reset@ --- *
114 * Arguments: @dstr *d@ = pointer to a dynaimc string block
118 * Use: Resets a string so that new data gets put at the beginning.
121 void dstr_reset(dstr *d) { DRESET(d); }
123 /* --- @dstr_ensure@ --- *
125 * Arguments: @dstr *d@ = pointer to a dynamic string block
126 * @size_t sz@ = amount of free space to ensure
130 * Use: Ensures that at least @sz@ bytes are available in the
134 void dstr_ensure(dstr *d, size_t sz)
136 size_t rq = d->len + sz;
139 /* --- If we have enough space, just leave it --- */
144 /* --- Grow the buffer --- */
149 nsz = (DSTR_INITSZ >> 1);
150 do nsz <<= 1; while (nsz < rq);
153 d->buf = xrealloc(d->buf, nsz);
155 d->buf = xmalloc(nsz);
159 /* --- @dstr_putc@ --- *
161 * Arguments: @dstr *d@ = pointer to a dynamic string block
162 * @char ch@ = character to append
166 * Use: Appends a character to a string.
169 void dstr_putc(dstr *d, char ch) { DPUTC(d, ch); }
171 /* --- @dstr_putz@ --- *
173 * Arguments: @dstr *d@ = pointer to a dynamic string block
177 * Use: Appends a null byte to a string. The null byte does not
178 * contribute to the string's length, and will be overwritten
179 * by subsequent `put' operations.
182 void dstr_putz(dstr *d) { DPUTZ(d); }
184 /* --- @dstr_puts@ --- *
186 * Arguments: @dstr *d@ = pointer to a dynamic string block
187 * @const char *s@ = pointer to string to append
191 * Use: Appends a character string to a string. A trailing null
192 * byte is added, as for @dstr_putz@.
195 void dstr_puts(dstr *d, const char *s) { DPUTS(d, s); }
197 /* --- @dstr_putd@ --- *
199 * Arguments: @dstr *d@ = pointer to a dynamic string block
200 * @const dstr *s@ = pointer to a dynamic string to append
204 * Use: Appends a dynamic string to a string. A trailing null
205 * byte is added, as for @dstr_putz@.
208 void dstr_putd(dstr *d, const dstr *s) { DPUTD(d, s); }
210 /* --- @dstr_putm@ --- *
212 * Arguments: @dstr *d@ = pointer to a dynamic string block
213 * @const void *p@ = pointer to a block to append
214 * @size_t sz@ = size of the block
216 * Returns: Appends an arbitrary data block to a string. No trailing
220 void dstr_putm(dstr *d, const void *p, size_t sz) { DPUTM(d, p, sz); }
222 /* --- @dstr_tidy@ --- *
224 * Arguments: @dstr *d@ = pointer to a dynamic string block
228 * Use: Reduces the amount of memory used by a string. A trailing
229 * null byte is added, as for @dstr_putz@.
232 void dstr_tidy(dstr *d)
234 d->buf = xrealloc(d->buf, d->len + 1);
239 /* --- @dstr_putline@ --- *
241 * Arguments: @dstr *d@ = pointer to a dynamic string block
242 * @FILE *fp@ = a stream to read from
244 * Returns: The number of characters read into the buffer, or @EOF@ if
245 * end-of-file was reached before any characters were read.
247 * Use: Appends the next line from the given input stream to the
248 * string. A trailing newline is not added; a trailing null
249 * byte is appended, as for @dstr_putz@.
252 int dstr_putline(dstr *d, FILE *fp)
254 size_t left = d->sz - d->len;
261 /* --- Read the next byte --- */
265 /* --- End-of-file when no characters read is special --- */
267 if (ch == EOF && !rd)
270 /* --- Make sure there's some buffer space --- */
277 /* --- End-of-file or newline ends the loop --- */
279 if (ch == EOF || ch == '\n') {
285 /* --- Append the character and continue --- */
292 /* --- @dstr_write@ --- *
294 * Arguments: @dstr *d@ = pointer to a dynamic string block
295 * @FILE *fp@ = a stream to write on
297 * Returns: The number of bytes written (as for @fwrite@).
299 * Use: Writes a dynamic string to a file.
302 size_t dstr_write(const dstr *d, FILE *fp) { return (DWRITE(d, fp)); }
304 /*----- That's all, folks -------------------------------------------------*/