xref: /freebsd/contrib/bmake/buf.h (revision 732a02b4e77866604a120a275c082bb6221bd2ff)
1 /*	$NetBSD: buf.h,v 1.19 2017/05/31 22:02:06 maya 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 /*-
76  * buf.h --
77  *	Header for users of the buf library.
78  */
79 
80 #ifndef MAKE_BUF_H
81 #define MAKE_BUF_H
82 
83 typedef char Byte;
84 
85 typedef struct Buffer {
86     int	    size; 	/* Current size of the buffer */
87     int     count;	/* Number of bytes in buffer */
88     Byte    *buffer;	/* The buffer itself (zero terminated) */
89 } Buffer;
90 
91 /* If we aren't on netbsd, __predict_false() might not be defined. */
92 #ifndef __predict_false
93 #define __predict_false(x) (x)
94 #endif
95 
96 /* Buf_AddByte adds a single byte to a buffer. */
97 #define	Buf_AddByte(bp, byte) do { \
98 	int _count = ++(bp)->count; \
99 	char *_ptr; \
100 	if (__predict_false(_count >= (bp)->size)) \
101 		Buf_Expand_1(bp); \
102 	_ptr = (bp)->buffer + _count; \
103 	_ptr[-1] = (byte); \
104 	_ptr[0] = 0; \
105     } while (0)
106 
107 #define BUF_ERROR 256
108 
109 #define Buf_Size(bp) ((bp)->count)
110 
111 void Buf_Expand_1(Buffer *);
112 void Buf_AddBytes(Buffer *, int, const Byte *);
113 Byte *Buf_GetAll(Buffer *, int *);
114 void Buf_Empty(Buffer *);
115 void Buf_Init(Buffer *, int);
116 Byte *Buf_Destroy(Buffer *, Boolean);
117 Byte *Buf_DestroyCompact(Buffer *);
118 
119 #endif /* MAKE_BUF_H */
120