Support strings in buffer formats.

[u/mdw/catacomb] / buf.h

diff --git a/buf.h b/buf.h
index a83985c..84c4121 100644 (file)
--- a/buf.h
+++ b/buf.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: buf.h,v 1.4 2004/04/08 01:36:15 mdw Exp $
+ * $Id$
  *
  * Reading and writing packet buffers
  *
@@ -225,6 +225,107 @@ extern int buf_getu32(buf */*b*/, uint32 */*w*/);
 
 extern int buf_putu32(buf */*b*/, uint32 /*w*/);
 
+/* --- @buf_getmem{8,16,32,z} --- *
+ *
+ * Arguments:  @buf *b@ = pointer to a buffer block
+ *             @size_t *nn@ = where to put the length
+ *
+ * Returns:    Pointer to the buffer data, or null.
+ *
+ * Use:                Gets a chunk of memory from a buffer.  The number, @16@ or
+ *             @32@, is the width of the length; @z@ means null-terminated.
+ */
+
+extern void *buf_getmem8(buf */*b*/, size_t */*nn*/);
+extern void *buf_getmem16(buf */*b*/, size_t */*nn*/);
+extern void *buf_getmem32(buf */*b*/, size_t */*nn*/);
+extern void *buf_getmemz(buf */*b*/, size_t */*nn*/);
+
+/* --- @buf_putmem{8,16,32,z} --- *
+ *
+ * Arguments:  @buf *b@ = pointer to a buffer block
+ *             @const void *p@ = pointer to data to write
+ *             @size_t n@ = length to write
+ *
+ * Returns:    Zero if OK, nonzero if there wasn't enough space.
+ *
+ * Use:                Writes a chunk of data to a buffer.  The number, @16@ or
+ *             @32@, is the width of the length; @z@ means null-terminated.
+ */
+
+extern int buf_putmem8(buf */*b*/, const void */*p*/, size_t /*n*/);
+extern int buf_putmem16(buf */*b*/, const void */*p*/, size_t /*n*/);
+extern int buf_putmem32(buf */*b*/, const void */*p*/, size_t /*n*/);
+extern int buf_putmemz(buf */*b*/, const void */*p*/, size_t /*n*/);
+
+/* --- @buf_getbuf{8,16,32,z}@ --- *
+ *
+ * Arguments:  @buf *b@ = pointer to a buffer block
+ *             @buf *bb@ = where to put the result
+ *
+ * Returns:    Zero if it worked, nonzero if there wasn't enough space.
+ *
+ * Use:                Gets a block of data from a buffer, and writes its bounds to
+ *             another buffer.  The number, @16@ or @32@, is the width of
+ *             the length; @z@ means null-terminated.
+ */
+
+extern int buf_getbuf8(buf */*b*/, buf */*bb*/);
+extern int buf_getbuf16(buf */*b*/, buf */*bb*/);
+extern int buf_getbuf32(buf */*b*/, buf */*bb*/);
+extern int buf_getbufz(buf */*b*/, buf */*bb*/);
+
+/* --- @buf_putbuf{8,16,32,z}@ --- *
+ *
+ * Arguments:  @buf *b@ = pointer to a buffer block
+ *             @buf *bb@ = buffer to write
+ *
+ * Returns:    Zero if it worked, nonzero if there wasn't enough space.
+ *
+ * Use:                Puts the contents of a buffer to a buffer.  The number, @16@
+ *             or @32@, is the width of the length; @z@ means null-
+ *             terminated.
+ */
+
+extern int buf_putbuf8(buf */*b*/, buf */*bb*/);
+extern int buf_putbuf16(buf */*b*/, buf */*bb*/);
+extern int buf_putbuf32(buf */*b*/, buf */*bb*/);
+extern int buf_putbufz(buf */*b*/, buf */*bb*/);
+
+/* --- @buf_getstr{8,16,32,z}@ --- *
+ *
+ * Arguments:  @buf *b@ = pointer to a buffer block
+ *             @dstr *d@ = where to put the result
+ *
+ * Returns:    Zero if it worked, nonzero if there wasn't enough space.
+ *
+ * Use:                Gets a block of data from a buffer, and writes its contents
+ *             to a string.  The number, @16@ or @32@, is the width of the
+ *             length; @z@ means null-terminated.
+ */
+
+extern int buf_getstr8(buf */*b*/, dstr */*d*/);
+extern int buf_getstr16(buf */*b*/, dstr */*d*/);
+extern int buf_getstr32(buf */*b*/, dstr */*d*/);
+extern int buf_getstrz(buf */*b*/, dstr */*d*/);
+
+/* --- @buf_putstr{8,16,32,z}@ --- *
+ *
+ * Arguments:  @buf *b@ = pointer to a buffer block
+ *             @dstr *d@ = string to write
+ *
+ * Returns:    Zero if it worked, nonzero if there wasn't enough space.
+ *
+ * Use:                Puts a string to a buffer, and writes its bounds to
+ *             another buffer.  The number, @16@ or @32@, is the width of
+ *             the length; @z@ means null-terminated.
+ */
+
+extern int buf_putstr8(buf */*b*/, dstr */*d*/);
+extern int buf_putstr16(buf */*b*/, dstr */*d*/);
+extern int buf_putstr32(buf */*b*/, dstr */*d*/);
+extern int buf_putstrz(buf */*b*/, dstr */*d*/);
+
 /* --- @buf_getmp@ --- *
  *
  * Arguments:  @buf *b@ = pointer to a buffer block