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