1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2000-2011 Poul-Henning Kamp <phk@FreeBSD.org>
* Copyright (c) 2000-2008 Dag-Erling Coïdan Smørgrav
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer
* in this position and unchanged.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD: head/sys/sys/vsb.h 221993 2011-05-16 16:18:40Z phk $
*/
#ifndef VSB_H_INCLUDED
#define VSB_H_INCLUDED
/*
* Structure definition
*/
struct vsb {
unsigned magic;
#define VSB_MAGIC 0x4a82dd8a
int s_error; /* current error code */
char *s_buf; /* storage buffer */
ssize_t s_size; /* size of storage buffer */
ssize_t s_len; /* current length of string */
#define VSB_FIXEDLEN 0x00000000 /* fixed length buffer (default) */
#define VSB_AUTOEXTEND 0x00000001 /* automatically extend buffer */
#define VSB_USRFLAGMSK 0x0000ffff /* mask of flags the user may specify */
#define VSB_DYNAMIC 0x00010000 /* s_buf must be freed */
#define VSB_FINISHED 0x00020000 /* set by VSB_finish() */
#define VSB_DYNSTRUCT 0x00080000 /* vsb must be freed */
int s_flags; /* flags */
int s_indent; /* Ident level */
};
#ifdef __cplusplus
extern "C" {
#endif
/*
* API functions
*/
struct vsb *VSB_init(struct vsb *, void *, ssize_t);
struct vsb *VSB_new_auto(void);
void VSB_clear(struct vsb *);
int VSB_bcat(struct vsb *, const void *, ssize_t);
int VSB_cat(struct vsb *, const char *);
int VSB_printf(struct vsb *, const char *, ...)
v_printflike_(2, 3);
#ifdef va_start
int VSB_vprintf(struct vsb *, const char *, va_list)
v_printflike_(2, 0);
#endif
int VSB_putc(struct vsb *, int);
int VSB_error(const struct vsb *);
int VSB_finish(struct vsb *);
char *VSB_data(const struct vsb *);
ssize_t VSB_len(const struct vsb *);
void VSB_fini(struct vsb *);
void VSB_destroy(struct vsb **);
/*
* VSB_quote[_pfx] has four major modes, and two modifiers
*/
#define VSB_QUOTE_PLAIN 0
/*
* Basic "show me the string" mode
* All output is a single line
*/
#define VSB_QUOTE_JSON 2
/*
* JSON-like output suitable for inclusion between "..."
* Quotes <0x20 as \u%04x
* Keeps >0x7e unquoted
*/
#define VSB_QUOTE_HEX 4
/*
* Hex dump, single line.
* All zero data is compressed to "0x0...0"
*/
#define VSB_QUOTE_CSTR 8
/*
* C language source code literal string(s)
* Breaks strings at \n (expecting string concatenation)
*/
#define VSB_QUOTE_UNSAFE 16
/*
* For general display applications
* " and \ are not quoted
* Splits output to new line at '\n'
* Implies VSB_QUOTE_NONL
*/
#define VSB_QUOTE_NONL 1
/*
* If the output does not end in \n, append \n
* Can be combined with all other modes.
*/
#define VSB_QUOTE_ESCHEX 32
/*
* Use \x%02x instead of \%03o
* Not valid with VSB_QUOTE_JSON and VSB_QUOTE_HEX
*/
void VSB_quote_pfx(struct vsb *, const char*, const void *,
int len, int how);
void VSB_quote(struct vsb *, const void *, int len, int how);
void VSB_indent(struct vsb *, int);
int VSB_tofile(const struct vsb *, int fd);
#ifdef __cplusplus
};
#endif
#endif
|
