Fixed typo in `NAME' section.

[mLib] / dstr.h

diff --git a/dstr.h b/dstr.h
index 8ee012aa07c5313d11ab0439ddfdb4283666e4ee..3ef27ea01df2de0de709f4f99c678b89a0d4f1d1 100644 (file)
--- a/dstr.h
+++ b/dstr.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: dstr.h,v 1.4 1999/05/06 19:51:35 mdw Exp $
+ * $Id: dstr.h,v 1.8 1999/07/14 19:45:24 mdw Exp $
  *
  * Handle dynamically growing strings
  *
@@ -30,6 +30,18 @@
 /*----- Revision history --------------------------------------------------*
  *
  * $Log: dstr.h,v $
+ * 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.
  *
@@ -66,6 +78,7 @@
 
 #include <stdarg.h>
 #include <stdio.h>
+#include <stdlib.h>
 
 /*----- Data structures ---------------------------------------------------*/
 
@@ -75,6 +88,8 @@ typedef struct dstr {
   size_t len;                          /* Length of the string */
 } dstr;
 
+#define DSTR_INIT { 0, 0, 0 }          /* How to initialize one */
+
 /*----- Functions provided ------------------------------------------------*/
 
 /* --- @dstr_create@ --- *
@@ -83,11 +98,18 @@ typedef struct dstr {
  *
  * 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;                                                                \
+} while (0)
+
 /* --- @dstr_destroy@ --- *
  *
  * Arguments:  @dstr *d@ = pointer to a dynamic string block
@@ -99,6 +121,13 @@ extern void dstr_create(dstr */*d*/);
 
 extern void dstr_destroy(dstr */*d*/);
 
+#define DDESTROY(d) do {                                               \
+  dstr *_d = (d);                                                      \
+  if (_d->buf)                                                         \
+    free(_d->buf);                                                     \
+  DCREATE(_d);                                                         \
+} while (0)
+
 /* --- @dstr_reset@ --- *
  *
  * Arguments:  @dstr *d@ = pointer to a dynaimc string block
@@ -110,6 +139,8 @@ extern void dstr_destroy(dstr */*d*/);
 
 extern void dstr_reset(dstr */*d*/);
 
+#define DRESET(d) ((d)->len = 0)
+
 /* --- @dstr_ensure@ --- *
  *
  * Arguments:  @dstr *d@ = pointer to a dynamic string block
@@ -124,7 +155,9 @@ extern void dstr_reset(dstr */*d*/);
 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@ --- *
@@ -140,8 +173,9 @@ extern void dstr_ensure(dstr */*d*/, size_t /*sz*/);
 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@ --- *
@@ -158,8 +192,9 @@ extern void dstr_putc(dstr */*d*/, char /*ch*/);
 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@ --- *
@@ -176,10 +211,12 @@ extern void dstr_putz(dstr */*d*/);
 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@ --- *
@@ -188,7 +225,7 @@ extern void dstr_puts(dstr */*d*/, const char */*s*/);
  *             @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.
@@ -202,7 +239,7 @@ extern int dstr_vputf(dstr */*d*/, const char */*p*/, va_list /*ap*/);
  *             @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
@@ -226,10 +263,12 @@ extern int dstr_putf(dstr */*d*/, const char */*p*/, ...);
 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@ --- *
@@ -245,9 +284,11 @@ extern void dstr_putd(dstr */*d*/, const dstr */*s*/);
 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@ --- *
@@ -287,7 +328,9 @@ extern int dstr_putline(dstr */*d*/, FILE */*fp*/);
  * 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 -------------------------------------------------*/