3 * $Id: dstr.c,v 1.15 2000/07/16 12:29:16 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.15 2000/07/16 12:29:16 mdw
34 * Change to arena `realloc' interface, to fix a design bug.
36 * Revision 1.14 2000/06/17 10:37:39 mdw
37 * Add support for arena management.
39 * Revision 1.13 1999/12/22 15:39:28 mdw
40 * Fix overflow in dstr_putline.
42 * Revision 1.12 1999/12/10 23:42:04 mdw
43 * Change header file guard names.
45 * Revision 1.11 1999/10/28 22:05:29 mdw
46 * Modify and debug allocation routines.
48 * Revision 1.10 1999/10/04 21:44:47 mdw
49 * Move `dstr_putf' and `dstr_vputf' into a separate source file.
51 * Revision 1.9 1999/07/06 19:16:06 mdw
52 * Simplify buffer-growing algorithm. Just double it each time.
54 * Revision 1.8 1999/06/01 09:47:52 mdw
55 * Fix nasty bugs in `dstr_vputf'.
57 * Revision 1.7 1999/05/21 22:14:30 mdw
58 * Take advantage of the new dynamic string macros.
60 * Revision 1.6 1999/05/21 08:38:33 mdw
61 * Implement some more functions in terms of macros.
63 * Revision 1.5 1999/05/13 22:47:57 mdw
64 * Misc documentation fixes. Change `-ise' to `-ize' throughout.
66 * Revision 1.4 1999/05/06 19:51:35 mdw
67 * Reformatted the LGPL notice a little bit.
69 * Revision 1.3 1999/05/05 18:50:31 mdw
70 * Change licensing conditions to LGPL.
72 * Revision 1.2 1998/12/15 23:53:22 mdw
73 * New functions `dstr_putf' and `dstr_vputf' which do `printf'-style
74 * formatting in a safe way.
76 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
77 * Initial version of mLib
81 /*----- Header files ------------------------------------------------------*/
90 /*----- Tunable constants -------------------------------------------------*/
93 * If the buffer is empty, it is set to @DSTR_INITSZ@ bytes in size.
94 * Otherwise, it's set to the next power of two that's large enough. This is
95 * memory-hungry, but efficient.
98 #define DSTR_INITSZ 64 /* Initial buffer size */
100 /*----- Main code ---------------------------------------------------------*/
102 /* --- @dstr_create@ --- *
104 * Arguments: @dstr *d@ = pointer to a dynamic string block
108 * Use: Initializes a dynamic string.
111 void dstr_create(dstr
*d
) { DCREATE(d
); }
113 /* --- @dstr_destroy@ --- *
115 * Arguments: @dstr *d@ = pointer to a dynamic string block
119 * Use: Reclaims the space used by a dynamic string.
122 void dstr_destroy(dstr
*d
) { DDESTROY(d
); }
124 /* --- @dstr_reset@ --- *
126 * Arguments: @dstr *d@ = pointer to a dynamic string block
130 * Use: Resets a string so that new data gets put at the beginning.
133 void dstr_reset(dstr
*d
) { DRESET(d
); }
135 /* --- @dstr_ensure@ --- *
137 * Arguments: @dstr *d@ = pointer to a dynamic string block
138 * @size_t sz@ = amount of free space to ensure
142 * Use: Ensures that at least @sz@ bytes are available in the
146 void dstr_ensure(dstr
*d
, size_t sz
)
148 size_t rq
= d
->len
+ sz
;
151 /* --- If we have enough space, just leave it --- */
156 /* --- Grow the buffer --- */
161 nsz
= (DSTR_INITSZ
>> 1);
162 do nsz
<<= 1; while (nsz
< rq
);
165 d
->buf
= x_realloc(d
->a
, d
->buf
, nsz
, d
->sz
);
167 d
->buf
= x_alloc(d
->a
, nsz
);
171 /* --- @dstr_putc@ --- *
173 * Arguments: @dstr *d@ = pointer to a dynamic string block
174 * @char ch@ = character to append
178 * Use: Appends a character to a string.
181 void dstr_putc(dstr
*d
, char ch
) { DPUTC(d
, ch
); }
183 /* --- @dstr_putz@ --- *
185 * Arguments: @dstr *d@ = pointer to a dynamic string block
189 * Use: Appends a null byte to a string. The null byte does not
190 * contribute to the string's length, and will be overwritten
191 * by subsequent `put' operations.
194 void dstr_putz(dstr
*d
) { DPUTZ(d
); }
196 /* --- @dstr_puts@ --- *
198 * Arguments: @dstr *d@ = pointer to a dynamic string block
199 * @const char *s@ = pointer to string to append
203 * Use: Appends a character string to a string. A trailing null
204 * byte is added, as for @dstr_putz@.
207 void dstr_puts(dstr
*d
, const char *s
) { DPUTS(d
, s
); }
209 /* --- @dstr_putd@ --- *
211 * Arguments: @dstr *d@ = pointer to a dynamic string block
212 * @const dstr *s@ = pointer to a dynamic string to append
216 * Use: Appends a dynamic string to a string. A trailing null
217 * byte is added, as for @dstr_putz@.
220 void dstr_putd(dstr
*d
, const dstr
*s
) { DPUTD(d
, s
); }
222 /* --- @dstr_putm@ --- *
224 * Arguments: @dstr *d@ = pointer to a dynamic string block
225 * @const void *p@ = pointer to a block to append
226 * @size_t sz@ = size of the block
228 * Returns: Appends an arbitrary data block to a string. No trailing
232 void dstr_putm(dstr
*d
, const void *p
, size_t sz
) { DPUTM(d
, p
, sz
); }
234 /* --- @dstr_tidy@ --- *
236 * Arguments: @dstr *d@ = pointer to a dynamic string block
240 * Use: Reduces the amount of memory used by a string. A trailing
241 * null byte is added, as for @dstr_putz@.
244 void dstr_tidy(dstr
*d
)
246 d
->buf
= x_realloc(d
->a
, d
->buf
, d
->len
+ 1, d
->sz
);
251 /* --- @dstr_putline@ --- *
253 * Arguments: @dstr *d@ = pointer to a dynamic string block
254 * @FILE *fp@ = a stream to read from
256 * Returns: The number of characters read into the buffer, or @EOF@ if
257 * end-of-file was reached before any characters were read.
259 * Use: Appends the next line from the given input stream to the
260 * string. A trailing newline is not added; a trailing null
261 * byte is appended, as for @dstr_putz@.
264 int dstr_putline(dstr
*d
, FILE *fp
)
266 size_t left
= d
->sz
- d
->len
;
273 /* --- Read the next byte --- */
277 /* --- End-of-file when no characters read is special --- */
279 if (ch
== EOF
&& !rd
)
282 /* --- Make sure there's some buffer space --- */
290 /* --- End-of-file or newline ends the loop --- */
292 if (ch
== EOF
|| ch
== '\n') {
298 /* --- Append the character and continue --- */
305 /* --- @dstr_write@ --- *
307 * Arguments: @dstr *d@ = pointer to a dynamic string block
308 * @FILE *fp@ = a stream to write on
310 * Returns: The number of bytes written (as for @fwrite@).
312 * Use: Writes a dynamic string to a file.
315 size_t dstr_write(const dstr
*d
, FILE *fp
) { return (DWRITE(d
, fp
)); }
317 /*----- That's all, folks -------------------------------------------------*/