2 * Copyright (c) 2000-2008 Poul-Henning Kamp
3 * Copyright (c) 2000-2008 Dag-Erling Coïdan Smørgrav
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
28 * $FreeBSD: head/sys/sys/sbuf.h 249377 2013-04-11 19:49:18Z trociny $
34 #include <sys/cdefs.h>
35 #include <sys/types.h>
37 #include <machine/stdarg.h>
40 typedef int (sbuf_drain_func
)(void *, const char *, int);
43 * Structure definition
46 char *s_buf
; /* storage buffer */
47 sbuf_drain_func
*s_drain_func
; /* drain function */
48 void *s_drain_arg
; /* user-supplied drain argument */
49 int s_error
; /* current error code */
50 ssize_t s_size
; /* size of storage buffer */
51 ssize_t s_len
; /* current length of string */
52 #define SBUF_FIXEDLEN 0x00000000 /* fixed length buffer (default) */
53 #define SBUF_AUTOEXTEND 0x00000001 /* automatically extend buffer */
54 #define SBUF_USRFLAGMSK 0x0000ffff /* mask of flags the user may specify */
55 #define SBUF_DYNAMIC 0x00010000 /* s_buf must be freed */
56 #define SBUF_FINISHED 0x00020000 /* set by sbuf_finish() */
57 #define SBUF_DYNSTRUCT 0x00080000 /* sbuf must be freed */
58 #define SBUF_INSECTION 0x00100000 /* set by sbuf_start_section() */
59 int s_flags
; /* flags */
60 ssize_t s_sect_len
; /* current length of section */
67 struct sbuf
*sbuf_new(struct sbuf
*, char *, int, int);
68 #define sbuf_new_auto() \
69 sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND)
70 void sbuf_clear(struct sbuf
*);
71 int sbuf_setpos(struct sbuf
*, ssize_t
);
72 int sbuf_bcat(struct sbuf
*, const void *, size_t);
73 int sbuf_bcpy(struct sbuf
*, const void *, size_t);
74 int sbuf_cat(struct sbuf
*, const char *);
75 int sbuf_cpy(struct sbuf
*, const char *);
76 int sbuf_printf(struct sbuf
*, const char *, ...)
78 int sbuf_vprintf(struct sbuf
*, const char *, __va_list
)
80 int sbuf_putc(struct sbuf
*, int);
81 void sbuf_set_drain(struct sbuf
*, sbuf_drain_func
*, void *);
82 int sbuf_trim(struct sbuf
*);
83 int sbuf_error(const struct sbuf
*);
84 int sbuf_finish(struct sbuf
*);
85 char *sbuf_data(struct sbuf
*);
86 ssize_t
sbuf_len(struct sbuf
*);
87 int sbuf_done(const struct sbuf
*);
88 void sbuf_delete(struct sbuf
*);
89 void sbuf_start_section(struct sbuf
*, ssize_t
*);
90 ssize_t
sbuf_end_section(struct sbuf
*, ssize_t
, size_t, int);
94 struct sbuf
*sbuf_uionew(struct sbuf
*, struct uio
*, int *);
95 int sbuf_bcopyin(struct sbuf
*, const void *, size_t);
96 int sbuf_copyin(struct sbuf
*, const void *, size_t);