usr.bin/make/buf.h

   1 /*
   2  * Copyright (c) 1988, 1989, 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1988, 1989 by Adam de Boor
   5  * Copyright (c) 1989 by Berkeley Softworks
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Adam de Boor.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      @(#)buf.h       8.2 (Berkeley) 4/28/95
  40  * $FreeBSD$
  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(Buffer, int);
  71 void Buf_AddBytes(Buffer, int, const Byte *);
  72 void Buf_UngetByte(Buffer, int);
  73 void Buf_UngetBytes(Buffer, int, Byte *);
  74 int Buf_GetByte(Buffer);
  75 int Buf_GetBytes(Buffer, int, Byte *);
  76 Byte *Buf_GetAll(Buffer, int *);
  77 void Buf_Discard(Buffer, int);
  78 int Buf_Size(Buffer);
  79 Buffer Buf_Init(int);
  80 void Buf_Destroy(Buffer, Boolean);
  81 void Buf_ReplaceLastByte(Buffer, int);
  82
  83 #endif /* _BUF_H */