1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2000-2008 Poul-Henning Kamp
5 * Copyright (c) 2000-2008 Dag-Erling Smørgrav
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer
13 * in this position and unchanged.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31#ifndef _SYS_SBUF_H_
32#define _SYS_SBUF_H_
33
34#include <sys/_types.h>
35
36struct sbuf;
37typedef int (sbuf_drain_func)(void *, const char *, int);
38
39/*
40 * Structure definition
41 */
42struct 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_DRAINTOEOR 0x00000004 /* use section 0 as drain EOR marker */
53#define SBUF_NOWAIT 0x00000008 /* Extend with non-blocking malloc */
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#define SBUF_DRAINATEOL 0x00200000 /* drained contents ended in \n */
60 int s_flags; /* flags */
61 ssize_t s_sect_len; /* current length of section */
62 ssize_t s_rec_off; /* current record start offset */
63};
64
65#ifndef HD_COLUMN_MASK
66#define HD_COLUMN_MASK 0xff
67#define HD_DELIM_MASK 0xff00
68#define HD_OMIT_COUNT (1 << 16)
69#define HD_OMIT_HEX (1 << 17)
70#define HD_OMIT_CHARS (1 << 18)
71#endif /* HD_COLUMN_MASK */
72
73__BEGIN_DECLS
74/*
75 * API functions
76 */
77struct sbuf *sbuf_new(struct sbuf *, char *, int, int);
78#define sbuf_new_auto() \
79 sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND)
80int sbuf_get_flags(struct sbuf *);
81void sbuf_clear_flags(struct sbuf *, int);
82void sbuf_set_flags(struct sbuf *, int);
83void sbuf_clear(struct sbuf *);
84int sbuf_setpos(struct sbuf *, ssize_t);
85int sbuf_bcat(struct sbuf *, const void *, size_t);
86int sbuf_bcpy(struct sbuf *, const void *, size_t);
87int sbuf_cat(struct sbuf *, const char *);
88int sbuf_cpy(struct sbuf *, const char *);
89int sbuf_printf(struct sbuf *, const char *, ...)
90 __printflike(2, 3);
91int sbuf_vprintf(struct sbuf *, const char *, __va_list)
92 __printflike(2, 0);
93int sbuf_nl_terminate(struct sbuf *);
94int sbuf_putc(struct sbuf *, int);
95void sbuf_set_drain(struct sbuf *, sbuf_drain_func *, void *);
96int sbuf_drain(struct sbuf *);
97int sbuf_trim(struct sbuf *);
98int sbuf_error(const struct sbuf *);
99int sbuf_finish(struct sbuf *);
100char *sbuf_data(struct sbuf *);
101ssize_t sbuf_len(struct sbuf *);
102int sbuf_done(const struct sbuf *);
103void sbuf_delete(struct sbuf *);
104void sbuf_start_section(struct sbuf *, ssize_t *);
105ssize_t sbuf_end_section(struct sbuf *, ssize_t, size_t, int);
106void sbuf_hexdump(struct sbuf *, const void *, int, const char *,
107 int);
108int sbuf_count_drain(void *arg, const char *data, int len);
109int sbuf_printf_drain(void *arg, const char *data, int len);
110void sbuf_putbuf(struct sbuf *);
111
112#ifdef _KERNEL
113struct uio;
114struct sbuf *sbuf_uionew(struct sbuf *, struct uio *, int *);
115int sbuf_bcopyin(struct sbuf *, const void *, size_t);
116int sbuf_copyin(struct sbuf *, const void *, size_t);
117#endif
118__END_DECLS
119
120#endif