/* -*-c-*-
*
- * $Id: dstr.h,v 1.4 1999/05/06 19:51:35 mdw Exp $
+ * $Id: dstr.h,v 1.7 1999/05/21 22:12:12 mdw Exp $
*
* Handle dynamically growing strings
*
/*----- 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.
*
#include <stdarg.h>
#include <stdio.h>
+#include <stdlib.h>
/*----- Data structures ---------------------------------------------------*/
size_t len; /* Length of the string */
} dstr;
+#define DSTR_INIT { 0, 0, 0 } /* 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 { \
+ (d)->buf = 0; \
+ (d)->sz = 0; \
+ (d)->len = 0; \
+} while (0)
+
/* --- @dstr_destroy@ --- *
*
* Arguments: @dstr *d@ = pointer to a dynamic string block
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
extern void dstr_reset(dstr */*d*/);
+#define DRESET(d) ((d)->len = 0)
+
/* --- @dstr_ensure@ --- *
*
* Arguments: @dstr *d@ = pointer to a dynamic string block
* @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
* 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 -------------------------------------------------*/