xref: /netbsd-src/usr.bin/make/buf.h (revision 5f7096188587a2c7c95fa3c69b78e1ec9c7923d0)
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	5.4 (Berkeley) 12/28/90
39  *	$Id: buf.h,v 1.2 1993/08/01 18:12:06 mycroft Exp $
40  */
41 
42 /*-
43  * buf.h --
44  *	Header for users of the buf library.
45  */
46 
47 #ifndef _BUF_H
48 #define _BUF_H
49 
50 #include    "sprite.h"
51 
52 typedef unsigned char Byte;
53 
54 typedef struct Buffer {
55     int	    size; 	/* Current size of the buffer */
56     int     left;	/* Space left (== size - (inPtr - buffer)) */
57     Byte    *buffer;	/* The buffer itself */
58     Byte    *inPtr;	/* Place to write to */
59     Byte    *outPtr;	/* Place to read from */
60 } *Buffer;
61 
62 Buffer	    	  Buf_Init();	    /* Initialize a buffer */
63 void	    	  Buf_Destroy();    /* Destroy a buffer */
64 void	    	  Buf_AddBytes();   /* Add a range of bytes to a buffer */
65 int	    	  Buf_GetByte();    /* Get a byte from a buffer */
66 int	    	  Buf_GetBytes();   /* Get multiple bytes */
67 void		  Buf_UngetByte();  /* Push a byte back into the buffer */
68 void		  Buf_UngetBytes(); /* Push many bytes back into the buf */
69 Byte	    	  *Buf_GetAll();    /* Get them all */
70 void	    	  Buf_Discard();    /* Throw away some of the bytes */
71 int	    	  Buf_Size();	    /* See how many are there */
72 
73 /* Buf_AddByte adds a single byte to a buffer. */
74 #define	Buf_AddByte(bp, byte) \
75 	(--(bp)->left <= 0 ? Buf_OvAddByte(bp, byte) : \
76 		(void)(*(bp)->inPtr++ = (byte), *(bp)->inPtr = 0))
77 
78 void	Buf_OvAddByte();		/* adds a byte when buffer overflows */
79 
80 #define BUF_ERROR 256
81 
82 #endif _BUF_H
83