FreeBSD/Linux Kernel Cross Reference
sys/sys/sbuf.h
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$
29 */
30
31 #ifndef _SYS_SBUF_H_
32 #define _SYS_SBUF_H_
33
34 #include <sys/_types.h>
35
36 struct sbuf;
37 typedef int (sbuf_drain_func)(void *, const char *, int);
38
39 /*
40 * Structure definition
41 */
42 struct sbuf {
43 char *s_buf; /* storage buffer */
44 sbuf_drain_func *s_drain_func; /* drain function */
45 void *s_drain_arg; /* user-supplied drain argument */
46 int s_error; /* current error code */
47 ssize_t s_size; /* size of storage buffer */
48 ssize_t s_len; /* current length of string */
49 #define SBUF_FIXEDLEN 0x00000000 /* fixed length buffer (default) */
50 #define SBUF_AUTOEXTEND 0x00000001 /* automatically extend buffer */
51 #define SBUF_INCLUDENUL 0x00000002 /* nulterm byte is counted in len */
52 #define SBUF_USRFLAGMSK 0x0000ffff /* mask of flags the user may specify */
53 #define SBUF_DYNAMIC 0x00010000 /* s_buf must be freed */
54 #define SBUF_FINISHED 0x00020000 /* set by sbuf_finish() */
55 #define SBUF_DYNSTRUCT 0x00080000 /* sbuf must be freed */
56 #define SBUF_INSECTION 0x00100000 /* set by sbuf_start_section() */
57 int s_flags; /* flags */
58 ssize_t s_sect_len; /* current length of section */
59 };
60
61 #ifndef HD_COLUMN_MASK
62 #define HD_COLUMN_MASK 0xff
63 #define HD_DELIM_MASK 0xff00
64 #define HD_OMIT_COUNT (1 << 16)
65 #define HD_OMIT_HEX (1 << 17)
66 #define HD_OMIT_CHARS (1 << 18)
67 #endif /* HD_COLUMN_MASK */
68
69 __BEGIN_DECLS
70 /*
71 * API functions
72 */
73 struct sbuf *sbuf_new(struct sbuf *, char *, int, int);
74 #define sbuf_new_auto() \
75 sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND)
76 int sbuf_get_flags(struct sbuf *);
77 void sbuf_clear_flags(struct sbuf *, int);
78 void sbuf_set_flags(struct sbuf *, int);
79 void sbuf_clear(struct sbuf *);
80 int sbuf_setpos(struct sbuf *, ssize_t);
81 int sbuf_bcat(struct sbuf *, const void *, size_t);
82 int sbuf_bcpy(struct sbuf *, const void *, size_t);
83 int sbuf_cat(struct sbuf *, const char *);
84 int sbuf_cpy(struct sbuf *, const char *);
85 int sbuf_printf(struct sbuf *, const char *, ...)
86 __printflike(2, 3);
87 int sbuf_vprintf(struct sbuf *, const char *, __va_list)
88 __printflike(2, 0);
89 int sbuf_putc(struct sbuf *, int);
90 void sbuf_set_drain(struct sbuf *, sbuf_drain_func *, void *);
91 int sbuf_drain(struct sbuf *);
92 int sbuf_trim(struct sbuf *);
93 int sbuf_error(const struct sbuf *);
94 int sbuf_finish(struct sbuf *);
95 char *sbuf_data(struct sbuf *);
96 ssize_t sbuf_len(struct sbuf *);
97 int sbuf_done(const struct sbuf *);
98 void sbuf_delete(struct sbuf *);
99 void sbuf_start_section(struct sbuf *, ssize_t *);
100 ssize_t sbuf_end_section(struct sbuf *, ssize_t, size_t, int);
101 void sbuf_hexdump(struct sbuf *, const void *, int, const char *,
102 int);
103 void sbuf_putbuf(struct sbuf *);
104
105 #ifdef _KERNEL
106 struct uio;
107 struct sbuf *sbuf_uionew(struct sbuf *, struct uio *, int *);
108 int sbuf_bcopyin(struct sbuf *, const void *, size_t);
109 int sbuf_copyin(struct sbuf *, const void *, size_t);
110 #endif
111 __END_DECLS
112
113 #endif
Cache object: 12bd9d7f6c6ac12eb7c714f2a2d94ec3
|