xref: /freebsd/contrib/bmake/buf.h (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
1 /*	$NetBSD: buf.h,v 1.38 2020/12/28 15:42:53 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 null */
85 	size_t len;	/* Number of bytes in buffer, excluding the null */
86 	char *data;	/* The buffer itself (always null-terminated) */
87 } Buffer;
88 
89 /* If we aren't on NetBSD, __predict_false() might not be defined. */
90 #ifndef __predict_false
91 #define __predict_false(x) (x)
92 #endif
93 
94 void Buf_Expand(Buffer *);
95 
96 /* Buf_AddByte adds a single byte to a buffer. */
97 MAKE_INLINE void
98 Buf_AddByte(Buffer *buf, char byte)
99 {
100 	size_t old_len = buf->len++;
101 	char *end;
102 	if (__predict_false(old_len + 1 >= buf->cap))
103 		Buf_Expand(buf);
104 	end = buf->data + old_len;
105 	end[0] = byte;
106 	end[1] = '\0';
107 }
108 
109 MAKE_INLINE size_t
110 Buf_Len(const Buffer *buf)
111 {
112 	return buf->len;
113 }
114 
115 MAKE_INLINE Boolean
116 Buf_EndsWith(const Buffer *buf, char ch)
117 {
118 	return buf->len > 0 && buf->data[buf->len - 1] == ch;
119 }
120 
121 void Buf_AddBytes(Buffer *, const char *, size_t);
122 void Buf_AddBytesBetween(Buffer *, const char *, const char *);
123 void Buf_AddStr(Buffer *, const char *);
124 void Buf_AddInt(Buffer *, int);
125 char *Buf_GetAll(Buffer *, size_t *);
126 void Buf_Empty(Buffer *);
127 void Buf_Init(Buffer *);
128 void Buf_InitSize(Buffer *, size_t);
129 char *Buf_Destroy(Buffer *, Boolean);
130 char *Buf_DestroyCompact(Buffer *);
131 
132 #endif /* MAKE_BUF_H */
133