Make the selector type symbols an enumeration rather than a bunch of

[mLib] / dstr.h

diff --git a/dstr.h b/dstr.h
index b7240fe62bc9287de733d811a80583534b2c427a..3cbabc1daa6114dd384040610b0d4864691856b9 100644 (file)
--- a/dstr.h
+++ b/dstr.h
@@ -1,36 +1,50 @@
 /* -*-c-*-
  *
- * $Id: dstr.h,v 1.1 1998/06/17 23:44:42 mdw Exp $
+ * $Id: dstr.h,v 1.5 1999/05/13 22:47:57 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.1  1998/06/17 23:44:42  mdw
- * Initial revision
+ * 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.
+ *
+ * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
+ * Initial version of mLib
  *
  */
 
@@ -53,6 +67,7 @@
 
 /*----- Header files ------------------------------------------------------*/
 
+#include <stdarg.h>
 #include <stdio.h>
 
 /*----- Data structures ---------------------------------------------------*/
@@ -71,7 +86,7 @@ typedef struct dstr {
  *
  * Returns:    ---
  *
- * Use:                Initialises a dynamic string.
+ * Use:                Initializes a dynamic string.
  */
 
 extern void dstr_create(dstr */*d*/);
@@ -170,6 +185,36 @@ extern void dstr_puts(dstr */*d*/, const char */*s*/);
   (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
+ *
+ * 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*/);
+
+/* --- @dstr_putf@ --- *
+ *
+ * Arguments:  @dstr *d@ = pointer to a dynamic string block
+ *             @const char *p@ = pointer to @printf@-style format string
+ *             @...@ = argument handle
+ *
+ * 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
+ *             faced with malicious arguments, but not if the format string
+ *             itself is malicious.
+ */
+
+extern int dstr_putf(dstr */*d*/, const char */*p*/, ...);
+
 /* --- @dstr_putd@ --- *
  *
  * Arguments:  @dstr *d@ = pointer to a dynamic string block
@@ -245,7 +290,7 @@ 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*/);
 
 /*----- That's all, folks -------------------------------------------------*/