1 /* $NetBSD: buf.h,v 1.50 2024/04/28 15:10:19 rillig Exp $ */
2
3 /*
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5 *
6 * This code is derived from software contributed to Berkeley by
7 * Adam de Boor.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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 * 3. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * from: @(#)buf.h 8.1 (Berkeley) 6/6/93
34 */
35
36 /*
37 * Copyright (c) 1988, 1989 by Adam de Boor
38 * Copyright (c) 1989 by Berkeley Softworks
39 * All rights reserved.
40 *
41 * This code is derived from software contributed to Berkeley by
42 * Adam de Boor.
43 *
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
46 * are met:
47 * 1. Redistributions of source code must retain the above copyright
48 * notice, this list of conditions and the following disclaimer.
49 * 2. Redistributions in binary form must reproduce the above copyright
50 * notice, this list of conditions and the following disclaimer in the
51 * documentation and/or other materials provided with the distribution.
52 * 3. All advertising materials mentioning features or use of this software
53 * must display the following acknowledgement:
54 * This product includes software developed by the University of
55 * California, Berkeley and its contributors.
56 * 4. Neither the name of the University nor the names of its contributors
57 * may be used to endorse or promote products derived from this software
58 * without specific prior written permission.
59 *
60 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
61 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
64 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
65 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
66 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
68 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
69 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
70 * SUCH DAMAGE.
71 *
72 * from: @(#)buf.h 8.1 (Berkeley) 6/6/93
73 */
74
75 /* Automatically growing null-terminated buffers of characters. */
76
77 #ifndef MAKE_BUF_H
78 #define MAKE_BUF_H
79
80 #include <stddef.h>
81
82 /* An automatically growing null-terminated buffer of characters. */
83 typedef struct Buffer {
84 size_t cap; /* Allocated size of the buffer, including the '\0' */
85 size_t len; /* Number of bytes in buffer, excluding the '\0' */
86 char *data; /* The buffer itself (always null-terminated) */
87 } Buffer;
88
89 void Buf_Expand(Buffer *);
90
91 /* Mark the buffer as empty, so it can be filled with data again. */
92 MAKE_INLINE void
Buf_Clear(Buffer * buf)93 Buf_Clear(Buffer *buf)
94 {
95 buf->len = 0;
96 buf->data[0] = '\0';
97 }
98
99 /* Adds a single byte to a buffer. */
100 MAKE_INLINE void
Buf_AddByte(Buffer * buf,char byte)101 Buf_AddByte(Buffer *buf, char byte)
102 {
103 size_t old_len = buf->len++;
104 char *end;
105 if (old_len + 1 >= buf->cap)
106 Buf_Expand(buf);
107 end = buf->data + old_len;
108 end[0] = byte;
109 end[1] = '\0';
110 }
111
112 MAKE_INLINE bool MAKE_ATTR_USE
Buf_EndsWith(const Buffer * buf,char ch)113 Buf_EndsWith(const Buffer *buf, char ch)
114 {
115 return buf->len > 0 && buf->data[buf->len - 1] == ch;
116 }
117
118 void Buf_AddBytes(Buffer *, const char *, size_t);
119 void Buf_AddRange(Buffer *, const char *, const char *);
120 void Buf_AddStr(Buffer *, const char *);
121 void Buf_AddInt(Buffer *, int);
122 void Buf_AddFlag(Buffer *, bool, const char *);
123 void Buf_Init(Buffer *);
124 void Buf_InitSize(Buffer *, size_t);
125 void Buf_Done(Buffer *);
126 char *Buf_DoneData(Buffer *) MAKE_ATTR_USE;
127
128 #endif
129