chiark / gitweb /
buf: Fix two embarassing bugs found while writing Lisp bindings.
[mLib] / dstr.h
diff --git a/dstr.h b/dstr.h
index 73b1ceb..d30a4f9 100644 (file)
--- a/dstr.h
+++ b/dstr.h
@@ -1,45 +1,34 @@
 /* -*-c-*-
  *
- * $Id: dstr.h,v 1.2 1998/12/15 23:53:23 mdw Exp $
+ * $Id: dstr.h,v 1.13 2004/04/08 01:36:11 mdw Exp $
  *
  * Handle dynamically growing strings
  *
  * (c) 1998 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------*
+/*----- Licensing notice --------------------------------------------------* 
  *
  * This file is part of the mLib utilities library.
  *
  * mLib is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
+ * it under the terms of the GNU Library General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ * 
  * mLib is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with mLib; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * GNU Library General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Library General Public
+ * License along with mLib; if not, write to the Free
+ * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------*
- *
- * $Log: dstr.h,v $
- * Revision 1.2  1998/12/15 23:53:23  mdw
- * New functions `dstr_putf' and `dstr_vputf' which do `printf'-style
- * formatting in a safe way.
- *
- * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
- * Initial version of mLib
- *
- */
-
-#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 ---------------------------------------------------*/
 
@@ -66,8 +64,11 @@ typedef struct dstr {
   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@ --- *
@@ -76,11 +77,19 @@ 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;                                                                \
+  _dd->a = &arena_stdlib;                                              \
+} while (0)
+
 /* --- @dstr_destroy@ --- *
  *
  * Arguments:  @dstr *d@ = pointer to a dynamic string block
@@ -92,9 +101,16 @@ extern void dstr_create(dstr */*d*/);
 
 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:    ---
  *
@@ -103,6 +119,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
@@ -117,7 +135,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@ --- *
@@ -133,8 +153,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@ --- *
@@ -151,8 +172,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@ --- *
@@ -169,25 +191,27 @@ 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@ --- *
  *
  * Arguments:  @dstr *d@ = pointer to a dynamic string block
  *             @const char *p@ = pointer to @printf@-style format string
- *             @va_list ap@ = argument handle
+ *             @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.
  */
 
-extern int dstr_vputf(dstr */*d*/, const char */*p*/, va_list /*ap*/);
+extern int dstr_vputf(dstr */*d*/, const char */*p*/, va_list */*ap*/);
 
 /* --- @dstr_putf@ --- *
  *
@@ -195,7 +219,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
@@ -219,10 +243,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@ --- *
@@ -238,9 +264,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@ --- *
@@ -280,7 +308,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 -------------------------------------------------*/