sbuf.h revision 69990 
1/*-
2 * Copyright (c) 2000 Poul-Henning Kamp and Dag-Erling Co�dan Sm�rgrav
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer
10 *    in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 *    derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 *      $FreeBSD: head/sys/sys/sbuf.h 69990 2000-12-13 19:51:07Z des $
29 */
30
31#ifndef _SYS_SBUF_H_
32#define _SYS_SBUF_H_
33
34/*
35 * Structure definition
36 */
37struct sbuf {
38	char		*s_buf;		/* storage buffer */
39	struct sbuf	*s_next;        /* next in chain */
40	size_t		 s_size;	/* size of storage buffer */
41	size_t		 s_len;		/* current length of string */
42#define SBUF_AUTOEXTEND	0x00000001	/* automatically extend buffer */
43#define SBUF_DYNAMIC	0x00010000	/* s_buf must be freed */
44#define SBUF_FINISHED	0x00020000	/* set by sbuf_finish() */
45#define SBUF_OVERFLOWED	0x00040000	/* sbuf overflowed */
46	int		 s_flags;	/* flags */
47};
48
49/*
50 * Predicates
51 */
52#define SBUF_ISDYNAMIC(s)	((s)->s_flags & SBUF_DYNAMIC)
53#define SBUF_ISFINISHED(s)	((s)->s_flags & SBUF_FINISHED)
54#define SBUF_HASOVERFLOWED(s)	((s)->s_flags & SBUF_OVERFLOWED)
55#define SBUF_HASROOM(s)		((s)->s_len < (s)->s_size - 1)
56
57/*
58 * Other macros
59 */
60#define SBUF_SETFLAG(s, f)	do { (s)->s_flags |= (f); } while (0)
61
62/*
63 * API functions
64 */
65int	 sbuf_new(struct sbuf *s, char *buf, size_t length, int flags);
66int	 sbuf_setpos(struct sbuf *s, size_t pos);
67int	 sbuf_cat(struct sbuf *s, char *str);
68int	 sbuf_cpy(struct sbuf *s, char *str);
69int	 sbuf_printf(struct sbuf *s, char *fmt, ...);
70int	 sbuf_putc(struct sbuf *s, int c);
71int	 sbuf_finish(struct sbuf *s);
72char    *sbuf_data(struct sbuf *s);
73size_t	 sbuf_len(struct sbuf *s);
74void	 sbuf_delete(struct sbuf *s);
75
76#endif
77