ec01bf219b49022d4fb426663b9c0b02b6ae881d
[dragonfly.git] / usr.bin / make / buf.h
1 /*
2  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
3  * Copyright (c) 1988, 1989 by Adam de Boor
4  * Copyright (c) 1989 by Berkeley Softworks
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Adam de Boor.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      from: @(#)buf.h 8.1 (Berkeley) 6/6/93
39  * $FreeBSD: src/usr.bin/make/buf.h,v 1.9 1999/08/28 01:03:26 peter Exp $
40  * $DragonFly: src/usr.bin/make/buf.h,v 1.2 2003/06/17 04:29:28 dillon Exp $
41  */
42
43 /*-
44  * buf.h --
45  *      Header for users of the buf library.
46  */
47
48 #ifndef _BUF_H
49 #define _BUF_H
50
51 #include    "sprite.h"
52
53 typedef char Byte;
54
55 typedef struct Buffer {
56     int     size;       /* Current size of the buffer */
57     int     left;       /* Space left (== size - (inPtr - buffer)) */
58     Byte    *buffer;    /* The buffer itself */
59     Byte    *inPtr;     /* Place to write to */
60     Byte    *outPtr;    /* Place to read from */
61 } *Buffer;
62
63 /* Buf_AddByte adds a single byte to a buffer. */
64 #define Buf_AddByte(bp, byte) \
65         (void) (--(bp)->left <= 0 ? Buf_OvAddByte(bp, byte), 1 : \
66                 (*(bp)->inPtr++ = (byte), *(bp)->inPtr = 0), 1)
67
68 #define BUF_ERROR 256
69
70 void Buf_OvAddByte __P((Buffer, int));
71 void Buf_AddBytes __P((Buffer, int, const Byte *));
72 void Buf_UngetByte __P((Buffer, int));
73 void Buf_UngetBytes __P((Buffer, int, Byte *));
74 int Buf_GetByte __P((Buffer));
75 int Buf_GetBytes __P((Buffer, int, Byte *));
76 Byte *Buf_GetAll __P((Buffer, int *));
77 void Buf_Discard __P((Buffer, int));
78 int Buf_Size __P((Buffer));
79 Buffer Buf_Init __P((int));
80 void Buf_Destroy __P((Buffer, Boolean));
81 void Buf_ReplaceLastByte __P((Buffer, int));
82
83 #endif /* _BUF_H */