Annotation of src/usr.bin/rcs/buf.h, Revision 1.7
1.7 ! ray 1: /* $OpenBSD: buf.h,v 1.6 2007/02/02 04:24:09 ray Exp $ */
1.1 joris 2: /*
3: * Copyright (c) 2003 Jean-Francois Brousseau <jfb@openbsd.org>
4: * All rights reserved.
5: *
6: * Redistribution and use in source and binary forms, with or without
7: * modification, are permitted provided that the following conditions
8: * are met:
9: *
10: * 1. Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * 2. The name of the author may not be used to endorse or promote products
13: * derived from this software without specific prior written permission.
14: *
15: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
16: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
17: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
18: * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25: *
26: * Buffer management
27: * -----------------
28: *
29: * This code provides an API to generic memory buffer management. All
30: * operations are performed on a rcs_buf structure, which is kept opaque to the
31: * API user in order to avoid corruption of the fields and make sure that only
32: * the internals can modify the fields.
33: *
1.7 ! ray 34: * The first step is to allocate a new buffer using the rcs_buf_alloc()
1.1 joris 35: * function, which returns a pointer to a new buffer.
36: */
37:
38: #ifndef BUF_H
39: #define BUF_H
40:
41: /* flags */
42: #define BUF_AUTOEXT 1 /* autoextend on append */
43:
44: typedef struct rcs_buf BUF;
45:
46: BUF *rcs_buf_alloc(size_t, u_int);
47: BUF *rcs_buf_load(const char *, u_int);
48: void rcs_buf_free(BUF *);
49: void *rcs_buf_release(BUF *);
50: u_char rcs_buf_getc(BUF *, size_t);
51: void rcs_buf_empty(BUF *);
1.5 ray 52: size_t rcs_buf_append(BUF *, const void *, size_t);
53: size_t rcs_buf_fappend(BUF *, const char *, ...)
1.1 joris 54: __attribute__((format(printf, 2, 3)));
55: void rcs_buf_putc(BUF *, int);
56: size_t rcs_buf_len(BUF *);
57: int rcs_buf_write_fd(BUF *, int);
58: int rcs_buf_write(BUF *, const char *, mode_t);
1.4 ray 59: void rcs_buf_write_stmp(BUF *, char *);
1.3 niallo 60: void *rcs_buf_get(BUF *b);
1.1 joris 61: #endif /* BUF_H */