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: /repoman/r/ncvs/src/sys/sys/sbuf.h,v 1.14 2004/07/09 11:35:30 des Exp $
29 */
30
31#ifndef _SYS_SBUF_H_
32#define _SYS_SBUF_H_
33
34#include <sys/_types.h>
35#include <stdarg.h>
36#include <stddef.h>
37
38/*
39 * Structure definition
40 */
41struct sbuf {
42 char *s_buf; /* storage buffer */
43 void *s_unused; /* binary compatibility. */
44 int s_size; /* size of storage buffer */
45 int s_len; /* current length of string */
46#define SBUF_FIXEDLEN 0x00000000 /* fixed length buffer (default) */
47#define SBUF_AUTOEXTEND 0x00000001 /* automatically extend buffer */
48#define SBUF_USRFLAGMSK 0x0000ffff /* mask of flags the user may specify */
49#define SBUF_DYNAMIC 0x00010000 /* s_buf must be freed */
50#define SBUF_FINISHED 0x00020000 /* set by sbuf_finish() */
51#define SBUF_OVERFLOWED 0x00040000 /* sbuf overflowed */
52#define SBUF_DYNSTRUCT 0x00080000 /* sbuf must be freed */
53 int s_flags; /* flags */
54};
55
56__BEGIN_DECLS
57#ifdef KERNEL_PRIVATE
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 *, ...) __printflike(2, 3);
66int sbuf_vprintf(struct sbuf *, const char *, va_list) __printflike(2, 0);
67int sbuf_putc(struct sbuf *, int);
68int sbuf_trim(struct sbuf *);
69int sbuf_overflowed(struct sbuf *);
70void sbuf_finish(struct sbuf *);
71char *sbuf_data(struct sbuf *);
72int sbuf_len(struct sbuf *);
73int sbuf_done(struct sbuf *);
74void sbuf_delete(struct sbuf *);
75#endif
76
77__END_DECLS
78
79#endif
80