X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib/blobdiff_plain/00c7638bc6791b810069381b8aaebfeac67cdfee..c255a2eecd7ff3c4c1453ff9b426ea30ffd0dec1:/dstr.h

diff --git a/dstr.h b/dstr.h
index 73b1ceb..13e7d4d 100644
--- a/dstr.h
+++ b/dstr.h
@@ -1,34 +1,50 @@
 /* -*-c-*-
  *
- * $Id: dstr.h,v 1.2 1998/12/15 23:53:23 mdw Exp $
+ * $Id: dstr.h,v 1.7 1999/05/21 22:12:12 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.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.
+ *
+ * Revision 1.3  1999/05/05 18:50:31  mdw
+ * Change licensing conditions to LGPL.
+ *
  * 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.
@@ -59,6 +75,7 @@
 
 #include <stdarg.h>
 #include <stdio.h>
+#include <stdlib.h>
 
 /*----- Data structures ---------------------------------------------------*/
 
@@ -68,6 +85,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@ --- *
@@ -76,11 +95,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
@@ -92,6 +117,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
@@ -103,6 +133,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
@@ -181,7 +213,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.
@@ -195,7 +227,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
@@ -280,7 +312,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 -------------------------------------------------*/