X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib/blobdiff_plain/0bd984429304da7c1c5509103e3dc04149028a95..c44b6bdec0e9889fc05ae247271630ef81984bbe:/dstr.h

diff --git a/dstr.h b/dstr.h
index 8ee012a..938378a 100644
--- 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.6 1999/05/21 08:38:14 mdw Exp $
  *
  * Handle dynamically growing strings
  *
@@ -30,6 +30,12 @@
 /*----- Revision history --------------------------------------------------*
  *
  * $Log: dstr.h,v $
+ * 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 +72,7 @@
 
 #include <stdarg.h>
 #include <stdio.h>
+#include <stdlib.h>
 
 /*----- Data structures ---------------------------------------------------*/
 
@@ -75,6 +82,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 +92,17 @@ typedef struct dstr {
  *
  * Returns:	---
  *
- * Use:		Initialises a dynamic string.
+ * Use:		Initializes a dynamic string.
  */
 
 extern void dstr_create(dstr */*d*/);
 
+#define DCREATE(d) do {							\
+  (d)->buf = 0;								\
+  (d)->sz = 0;								\
+  (d)->len = 0;								\
+} while (0)
+
 /* --- @dstr_destroy@ --- *
  *
  * Arguments:	@dstr *d@ = pointer to a dynamic string block
@@ -99,6 +114,11 @@ extern void dstr_create(dstr */*d*/);
 
 extern void dstr_destroy(dstr */*d*/);
 
+#define DDESTROY(d) do {						\
+  if ((d)->buf) free((d)->buf);						\
+  DCREATE(d);								\
+} while (0)
+
 /* --- @dstr_reset@ --- *
  *
  * Arguments:	@dstr *d@ = pointer to a dynaimc string block
@@ -110,6 +130,8 @@ extern void dstr_destroy(dstr */*d*/);
 
 extern void dstr_reset(dstr */*d*/);
 
+#define DRESET(d) do (d)->len = 0; while (0)
+
 /* --- @dstr_ensure@ --- *
  *
  * Arguments:	@dstr *d@ = pointer to a dynamic string block
@@ -188,7 +210,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 +224,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
@@ -287,7 +309,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 -------------------------------------------------*/