/* -*-c-*-
*
- * $Id: dstr.h,v 1.4 1999/05/06 19:51:35 mdw Exp $
+ * $Id: dstr.h,v 1.11 2000/06/17 10:37:39 mdw Exp $
*
* Handle dynamically growing strings
*
/*----- Revision history --------------------------------------------------*
*
* $Log: dstr.h,v $
+ * Revision 1.11 2000/06/17 10:37:39 mdw
+ * Add support for arena management.
+ *
+ * Revision 1.10 1999/12/22 15:39:51 mdw
+ * Fix argument reuse in DPUTS.
+ *
+ * Revision 1.9 1999/12/10 23:42:04 mdw
+ * Change header file guard names.
+ *
+ * Revision 1.8 1999/07/14 19:45:24 mdw
+ * Prevent some macros from re-evaluating their arguments.
+ *
+ * Revision 1.7 1999/05/21 22:12:12 mdw
+ * Fix the bugs in the new macros. (Whoops.)
+ *
+ * Revision 1.6 1999/05/21 08:38:14 mdw
+ * Add some more macros, particularly for creation and destruction.
+ *
+ * Revision 1.5 1999/05/13 22:47:57 mdw
+ * Misc documentation fixes. Change `-ise' to `-ize' throughout.
+ *
* Revision 1.4 1999/05/06 19:51:35 mdw
* Reformatted the LGPL notice a little bit.
*
*
*/
-#ifndef DSTR_H
-#define DSTR_H
+#ifndef MLIB_DSTR_H
+#define MLIB_DSTR_H
#ifdef __cplusplus
extern "C" {
#include <stdarg.h>
#include <stdio.h>
+#include <stdlib.h>
+
+#ifndef MLIB_ALLOC_H
+# include "alloc.h"
+#endif
+
+#ifndef MLIB_ARENA_H
+# include "arena.h"
+#endif
/*----- Data structures ---------------------------------------------------*/
char *buf; /* Pointer to string buffer */
size_t sz; /* Size of the buffer */
size_t len; /* Length of the string */
+ arena *a; /* Pointer to arena */
} dstr;
+#define DSTR_INIT { 0, 0, 0, &arena_stdlib } /* How to initialize one */
+
/*----- Functions provided ------------------------------------------------*/
/* --- @dstr_create@ --- *
*
* Returns: ---
*
- * Use: Initialises a dynamic string.
+ * Use: Initializes a dynamic string.
*/
extern void dstr_create(dstr */*d*/);
+#define DCREATE(d) do { \
+ dstr *_dd = (d); \
+ _dd->buf = 0; \
+ _dd->sz = 0; \
+ _dd->len = 0; \
+ _dd->a = &arena_stdlib; \
+} while (0)
+
/* --- @dstr_destroy@ --- *
*
* Arguments: @dstr *d@ = pointer to a dynamic string block
extern void dstr_destroy(dstr */*d*/);
+#define DDESTROY(d) do { \
+ dstr *_d = (d); \
+ if (_d->buf) \
+ x_free(_d->a, _d->buf); \
+ DCREATE(_d); \
+} while (0)
+
/* --- @dstr_reset@ --- *
*
- * Arguments: @dstr *d@ = pointer to a dynaimc string block
+ * Arguments: @dstr *d@ = pointer to a dynamic string block
*
* Returns: ---
*
extern void dstr_reset(dstr */*d*/);
+#define DRESET(d) ((d)->len = 0)
+
/* --- @dstr_ensure@ --- *
*
* Arguments: @dstr *d@ = pointer to a dynamic string block
extern void dstr_ensure(dstr */*d*/, size_t /*sz*/);
#define DENSURE(d, rq) do { \
- if ((d)->len + (rq) > (d)->sz) dstr_ensure((d), (rq)); \
+ dstr *_dd = (d); \
+ size_t _rq = (rq); \
+ if (_dd->len + _rq > _dd->sz) dstr_ensure(_dd, _rq); \
} while (0)
/* --- @dstr_putc@ --- *
extern void dstr_putc(dstr */*d*/, char /*ch*/);
#define DPUTC(d, ch) do { \
- DENSURE((d), 1); \
- (d)->buf[(d)->len++] = (ch); \
+ dstr *_d = (d); \
+ DENSURE(_d, 1); \
+ _d->buf[_d->len++] = (ch); \
} while (0)
/* --- @dstr_putz@ --- *
extern void dstr_putz(dstr */*d*/);
#define DPUTZ(d) do { \
- DENSURE((d), 1); \
- (d)->buf[(d)->len] = 0; \
+ dstr *_d = (d); \
+ DENSURE(_d, 1); \
+ _d->buf[_d->len] = 0; \
} while (0)
/* --- @dstr_puts@ --- *
extern void dstr_puts(dstr */*d*/, const char */*s*/);
#define DPUTS(d, s) do { \
- size_t sz = strlen(s); \
- DENSURE((d), sz + 1); \
- memcpy((d)->buf + (d)->len, (s), sz + 1); \
- (d)->len += sz; \
+ dstr *_d = (d); \
+ const char *_s = (s); \
+ size_t _sz = strlen(_s); \
+ DENSURE(_d, _sz + 1); \
+ memcpy(_d->buf + _d->len, _s, _sz + 1); \
+ _d->len += _sz; \
} while (0)
/* --- @dstr_vputf@ --- *
* @const char *p@ = pointer to @printf@-style format string
* @va_list ap@ = argument handle
*
- * Returns: ---
+ * Returns: The number of characters written to the string.
*
* Use: As for @dstr_putf@, but may be used as a back-end to user-
* supplied functions with @printf@-style interfaces.
* @const char *p@ = pointer to @printf@-style format string
* @...@ = argument handle
*
- * Returns: ---
+ * Returns: The number of characters written to the string.
*
* Use: Writes a piece of text to a dynamic string, doing @printf@-
* style substitutions as it goes. Intended to be robust if
extern void dstr_putd(dstr */*d*/, const dstr */*s*/);
#define DPUTD(d, s) do { \
- DENSURE((d), (s)->len + 1); \
- memcpy((d)->buf + (d)->len, (s)->buf, (s)->len); \
- (d)->len += (s)->len; \
- (d)->buf[(d)->len] = 0; \
+ dstr *_d = (d); \
+ const dstr *_s = (s); \
+ DENSURE(_d, _s->len + 1); \
+ memcpy(_d->buf + _d->len, _s->buf, _s->len); \
+ _d->len += _s->len; \
+ _d->buf[_d->len] = 0; \
} while (0)
/* --- @dstr_putm@ --- *
extern void dstr_putm(dstr */*d*/, const void */*p*/, size_t /*sz*/);
#define DPUTM(d, p, sz) do { \
- DENSURE((d), (sz)); \
- memcpy((d)->buf + (d)->len, (p), (sz)); \
- (d)->len += (sz); \
+ dstr *_d = (d); \
+ size_t _sz = (sz); \
+ DENSURE(_d, _sz); \
+ memcpy(_d->buf + _d->len, (p), _sz); \
+ _d->len += _sz; \
} while (0)
/* --- @dstr_tidy@ --- *
* Use: Writes a dynamic string to a file.
*/
-extern size_t dstr_write(dstr */*d*/, FILE */*fp*/);
+extern size_t dstr_write(const dstr */*d*/, FILE */*fp*/);
+
+#define DWRITE(d, fp) fwrite((d)->buf, 1, (d)->len, (fp))
/*----- That's all, folks -------------------------------------------------*/