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  *      from: @(#)buf.h 8.1 (Berkeley) 6/6/93
  40  * $FreeBSD: src/usr.bin/make/buf.h,v 1.24 2005/02/07 11:27:47 harti Exp $
  41  * $DragonFly: src/usr.bin/make/buf.h,v 1.36 2005/09/24 07:37:38 okumoto Exp $
  42  */
  43
  44 #ifndef buf_h_a61a6812
  45 #define buf_h_a61a6812
  46
  47 /*-
  48  * buf.h --
  49  *      Header for users of the buf library.
  50  */
  51
  52 #include <sys/types.h>
  53 #include <stdbool.h>
  54
  55 /*
  56  * There are several places where expandable buffers are used (parse.c and
  57  * var.c). This constant is merely the starting point for those buffers. If
  58  * lines tend to be much shorter than this, it would be best to reduce BSIZE.
  59  * If longer, it should be increased. Reducing it will cause more copying to
  60  * be done for longer lines, but will save space for shorter ones. In any
  61  * case, it ought to be a power of two simply because most storage allocation
  62  * schemes allocate in powers of two.
  63  */
  64 #define MAKE_BSIZE      256     /* starting size for expandable buffers */
  65
  66 #define BUF_DEF_SIZE    256     /* Default buffer size */
  67 #define BUF_ADD_INC     256     /* Expansion increment when Adding */
  68
  69 typedef struct Buffer {
  70         size_t  size;   /* Current size of the buffer */
  71         char    *buf;   /* The buffer itself */
  72         char    *end;   /* Place to write to */
  73 } Buffer;
  74
  75 void Buf_AddByte(Buffer *, char);
  76 void Buf_AddBytes(Buffer *, size_t, const char []);
  77 void Buf_Append(Buffer *, const char []);
  78 void Buf_AppendBuf(Buffer *, const Buffer *);
  79 void Buf_AppendRange(Buffer *, const char [], const char []);
  80 void Buf_Clear(Buffer *);
  81 char *Buf_Data(const Buffer *);
  82 void Buf_Destroy(Buffer *, bool);
  83 Buffer *Buf_Init(size_t);
  84 char *Buf_Peel(Buffer *);
  85 void Buf_ReplaceLastByte(Buffer *, char);
  86 size_t Buf_Size(const Buffer *);
  87 void Buf_StripNewlines(Buffer *);
  88
  89 #endif /* buf_h_a61a6812 */