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#ifndef buf_h_a61a6812
44#define	buf_h_a61a6812
45
46/*-
47 * buf.h --
48 *	Header for users of the buf library.
49 */
50
51#include <sys/types.h>
52
53#include "util.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
69typedef char Byte;
70
71typedef struct Buffer {
72	size_t	size;	/* Current size of the buffer */
73	Byte	*buf;	/* The buffer itself */
74	Byte	*end;	/* Place to write to */
75} Buffer;
76
77void Buf_AddByte(Buffer *, Byte);
78void Buf_AddBytes(Buffer *, size_t, const Byte *);
79void Buf_Append(Buffer *, const char []);
80void Buf_AppendBuf(Buffer *, const Buffer *);
81void Buf_AppendRange(Buffer *, const char [], const char *);
82void Buf_Clear(Buffer *);
83char *Buf_Data(const Buffer *);
84void Buf_Destroy(Buffer *, Boolean);
85Byte *Buf_GetAll(Buffer *, size_t *);
86Buffer *Buf_Init(size_t);
87char *Buf_Peel(Buffer *);
88void Buf_ReplaceLastByte(Buffer *, Byte);
89size_t Buf_Size(const Buffer *);
90void Buf_StripNewlines(Buffer *);
91
92#endif /* buf_h_a61a6812 */
93