String buffer API

1 files changed, 76 insertions, 0 deletions

diff --git a/sys/sys/sbuf.h b/sys/sys/sbuf.h
new file mode 100644
index 0000000..5995ec1
--- /dev/null
+++ b/sys/sys/sbuf.h
@@ -0,0 +1,76 @@
+/*-
+ * Copyright (c) 2000 Poul-Henning Kamp and Dag-Erling Coïdan Smørgrav
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer
+ *    in this position and unchanged.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *      $FreeBSD$
+ */
+
+#ifndef _SYS_SBUF_H_
+#define _SYS_SBUF_H_
+
+/*
+ * Structure definition
+ */
+struct sbuf {
+	char		*s_buf;		/* storage buffer */
+	struct sbuf	*s_next;        /* next in chain */
+	size_t		 s_size;	/* size of storage buffer */
+	size_t		 s_len;		/* current length of string */
+#define SBUF_AUTOEXTEND	0x00000001	/* automatically extend buffer */
+#define SBUF_DYNAMIC	0x00010000	/* s_buf must be freed */
+#define SBUF_FINISHED	0x00020000	/* set by sbuf_finish() */
+#define SBUF_OVERFLOWED	0x00040000	/* sbuf overflowed */
+	int		 s_flags;	/* flags */
+};
+
+/*
+ * Predicates
+ */
+#define SBUF_ISDYNAMIC(s)	((s)->s_flags & SBUF_DYNAMIC)
+#define SBUF_ISFINISHED(s)	((s)->s_flags & SBUF_FINISHED)
+#define SBUF_HASOVERFLOWED(s)	((s)->s_flags & SBUF_OVERFLOWED)
+#define SBUF_HASROOM(s)		((s)->s_len < (s)->s_size - 1)
+
+/*
+ * Other macros
+ */
+#define SBUF_SETFLAG(s, f)	do { (s)->s_flags |= (f); } while (0)
+
+/*
+ * API functions
+ */
+int	 sbuf_new(struct sbuf *s, char *buf, size_t length, int flags);
+int	 sbuf_setpos(struct sbuf *s, size_t pos);
+int	 sbuf_cat(struct sbuf *s, char *str);
+int	 sbuf_cpy(struct sbuf *s, char *str);
+int	 sbuf_printf(struct sbuf *s, char *fmt, ...);
+int	 sbuf_putc(struct sbuf *s, int c);
+int	 sbuf_finish(struct sbuf *s);
+char    *sbuf_data(struct sbuf *s);
+size_t	 sbuf_len(struct sbuf *s);
+void	 sbuf_delete(struct sbuf *s);
+
+#endif