sbuf.h revision 181462 
1/*-
2 * Copyright (c) 2000-2008 Poul-Henning Kamp
3 * Copyright (c) 2000-2008 Dag-Erling Co��dan Sm��rgrav
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer
11 *    in this position and unchanged.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 *      $FreeBSD: head/sys/sys/sbuf.h 181462 2008-08-09 10:26:21Z des $
29 */
30
31#ifndef _SYS_SBUF_H_
32#define	_SYS_SBUF_H_
33
34#include <sys/_types.h>
35
36/*
37 * Structure definition
38 */
39struct sbuf {
40	char		*s_buf;		/* storage buffer */
41	void		*s_unused;	/* binary compatibility. */
42	int		 s_size;	/* size of storage buffer */
43	int		 s_len;		/* current length of string */
44#define	SBUF_FIXEDLEN	0x00000000	/* fixed length buffer (default) */
45#define	SBUF_AUTOEXTEND	0x00000001	/* automatically extend buffer */
46#define	SBUF_USRFLAGMSK	0x0000ffff	/* mask of flags the user may specify */
47#define	SBUF_DYNAMIC	0x00010000	/* s_buf must be freed */
48#define	SBUF_FINISHED	0x00020000	/* set by sbuf_finish() */
49#define	SBUF_OVERFLOWED	0x00040000	/* sbuf overflowed */
50#define	SBUF_DYNSTRUCT	0x00080000	/* sbuf must be freed */
51	int		 s_flags;	/* flags */
52};
53
54__BEGIN_DECLS
55/*
56 * API functions
57 */
58struct sbuf	*sbuf_new(struct sbuf *, char *, int, int);
59void		 sbuf_clear(struct sbuf *);
60int		 sbuf_setpos(struct sbuf *, int);
61int		 sbuf_bcat(struct sbuf *, const void *, size_t);
62int		 sbuf_bcpy(struct sbuf *, const void *, size_t);
63int		 sbuf_cat(struct sbuf *, const char *);
64int		 sbuf_cpy(struct sbuf *, const char *);
65int		 sbuf_printf(struct sbuf *, const char *, ...)
66	__printflike(2, 3);
67int		 sbuf_vprintf(struct sbuf *, const char *, __va_list)
68	__printflike(2, 0);
69int		 sbuf_putc(struct sbuf *, int);
70int		 sbuf_trim(struct sbuf *);
71int		 sbuf_overflowed(struct sbuf *);
72void		 sbuf_finish(struct sbuf *);
73char		*sbuf_data(struct sbuf *);
74int		 sbuf_len(struct sbuf *);
75int		 sbuf_done(struct sbuf *);
76void		 sbuf_delete(struct sbuf *);
77
78#ifdef _KERNEL
79struct uio;
80struct sbuf	*sbuf_uionew(struct sbuf *, struct uio *, int *);
81int		 sbuf_bcopyin(struct sbuf *, const void *, size_t);
82int		 sbuf_copyin(struct sbuf *, const void *, size_t);
83#endif
84__END_DECLS
85
86#endif
87