Return to buf.h CVS log

Up to [local] / src / usr.bin / make

Annotation of src/usr.bin/make/buf.h, Revision 1.10

1.10    ! espie       1: /*     $OpenBSD: buf.h,v 1.9 1999/12/16 16:41:41 espie Exp $   */
1.4       millert     2: /*     $NetBSD: buf.h,v 1.7 1996/12/31 17:53:22 christos Exp $ */
1.1       deraadt     3:
                      4: /*
                      5:  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
                      6:  * Copyright (c) 1988, 1989 by Adam de Boor
                      7:  * Copyright (c) 1989 by Berkeley Softworks
                      8:  * All rights reserved.
                      9:  *
                     10:  * This code is derived from software contributed to Berkeley by
                     11:  * Adam de Boor.
                     12:  *
                     13:  * Redistribution and use in source and binary forms, with or without
                     14:  * modification, are permitted provided that the following conditions
                     15:  * are met:
                     16:  * 1. Redistributions of source code must retain the above copyright
                     17:  *    notice, this list of conditions and the following disclaimer.
                     18:  * 2. Redistributions in binary form must reproduce the above copyright
                     19:  *    notice, this list of conditions and the following disclaimer in the
                     20:  *    documentation and/or other materials provided with the distribution.
                     21:  * 3. All advertising materials mentioning features or use of this software
                     22:  *    must display the following acknowledgement:
                     23:  *     This product includes software developed by the University of
                     24:  *     California, Berkeley and its contributors.
                     25:  * 4. Neither the name of the University nor the names of its contributors
                     26:  *    may be used to endorse or promote products derived from this software
                     27:  *    without specific prior written permission.
                     28:  *
                     29:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     30:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     31:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     32:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     33:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     34:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     35:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     36:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     37:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     38:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     39:  * SUCH DAMAGE.
                     40:  *
1.3       millert    41:  *     from: @(#)buf.h 8.1 (Berkeley) 6/6/93
1.1       deraadt    42:  */
                     43:
                     44: /*-
                     45:  * buf.h --
                     46:  *     Header for users of the buf library.
                     47:  */
                     48:
                     49: #ifndef _BUF_H
                     50: #define _BUF_H
                     51:
                     52: #include    "sprite.h"
                     53:
                     54: typedef struct Buffer {
1.10    ! espie      55:     char    *buffer;   /* The buffer itself. */
        !            56:     char    *inPtr;    /* Place to write to. */
        !            57:     char    *endPtr;   /* End of allocated space. */
1.1       deraadt    58: } *Buffer;
                     59:
1.8       espie      60: /* Internal support for Buf_AddChar.  */
                     61: void BufOverflow __P((Buffer));
                     62:
1.10    ! espie      63: /* User interface */
        !            64:
        !            65: /* Buf_AddChar -- Add a single char to buffer. */
1.8       espie      66: #define        Buf_AddChar(bp, byte)                   \
                     67: do {                                           \
1.10    ! espie      68:        if ((bp)->endPtr - (bp)->inPtr <= 1)    \
1.8       espie      69:            BufOverflow(bp);                    \
                     70:        *(bp)->inPtr++ = (byte);                \
                     71: } while (0)
1.1       deraadt    72:
                     73: #define BUF_ERROR 256
                     74:
1.7       espie      75: /* Buf_AddChars -- Add a number of chars to the buffer.  */
1.6       espie      76: void Buf_AddChars __P((Buffer, size_t, const char *));
1.10    ! espie      77: /* Buf_Reset -- Remove all chars from a buffer.  */
        !            78: #define Buf_Reset(bp)  ((void)((bp)->inPtr = (bp)->buffer))
1.7       espie      79: /* Buf_AddSpace -- Add a space to buffer.  */
                     80: #define Buf_AddSpace(b)                        Buf_AddChar((b), ' ')
                     81: /* Buf_AddString -- Add the contents of a NULL terminated string to buffer.  */
                     82: #define Buf_AddString(b, s)            Buf_AddChars((b), strlen(s), (s))
                     83: /* Buf_AddInterval -- Add characters between pointers s and e to buffer.  */
                     84: #define Buf_AddInterval(b, s, e)       Buf_AddChars((b), (e) - (s), (s))
                     85:
1.9       espie      86: /* Buf_Retrieve -- Retrieve data from a buffer, as a NULL terminated string.  */
1.10    ! espie      87: #define Buf_Retrieve(bp)       (*(bp)->inPtr = '\0', (bp)->buffer)
1.9       espie      88:
                     89: /* Buf_Size -- Return the number of chars in the given buffer.
                     90:  *     Doesn't include the null-terminating char.  */
1.10    ! espie      91: #define Buf_Size(bp)   ((size_t)((bp)->inPtr - (bp)->buffer))
1.7       espie      92:
1.10    ! espie      93: /* Buf_Init -- Initialize a buffer. If no initial size is given,
        !            94:  *     a reasonable default is used.  */
1.6       espie      95: Buffer Buf_Init __P((size_t));
1.10    ! espie      96: /* Buf_Destroy -- Nuke a buffer and all its resources if Boolean is TRUE. */
1.1       deraadt    97: void Buf_Destroy __P((Buffer, Boolean));
1.10    ! espie      98: /* Buf_ReplaceLastChar -- Replace the last char in a buffer.  */
1.6       espie      99: void Buf_ReplaceLastChar __P((Buffer, char));
1.1       deraadt   100:
                    101: #endif /* _BUF_H */