a7404d380d941012714f0e3cf93d448a27db114b
[dragonfly.git] / usr.sbin / installer / libaura / buffer.h
1 /*
2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Chris Pressey <cpressey@catseye.mine.nu>.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35 /*
36  * buffer.h
37  * $Id: buffer.h,v 1.2 2005/02/06 06:57:30 cpressey Exp $
38  */
39
40 #ifndef __AURA_BUFFER_H_
41 #define __AURA_BUFFER_H_
42
43 #include <stdlib.h>
44
45 struct aura_buffer {
46         char    *buf;
47         size_t   len;
48         size_t   size;
49         size_t   pos;
50 };
51
52 struct aura_buffer      *aura_buffer_new(size_t);
53 void                     aura_buffer_free(struct aura_buffer *);
54 char                    *aura_buffer_buf(struct aura_buffer *);
55 size_t                   aura_buffer_len(struct aura_buffer *);
56 size_t                   aura_buffer_size(struct aura_buffer *);
57
58 void                     aura_buffer_ensure_size(struct aura_buffer *, size_t);
59 void                     aura_buffer_set(struct aura_buffer *, const char *, size_t);
60 void                     aura_buffer_append(struct aura_buffer *, const char *, size_t);
61
62 void                     aura_buffer_cpy(struct aura_buffer *, const char *);
63 void                     aura_buffer_cat(struct aura_buffer *, const char *);
64 int                      aura_buffer_cat_file(struct aura_buffer *, const char *, ...);
65 int                      aura_buffer_cat_pipe(struct aura_buffer *, const char *, ...);
66
67 int                      aura_buffer_seek(struct aura_buffer *, size_t);
68 size_t                   aura_buffer_tell(struct aura_buffer *);
69 int                      aura_buffer_eof(struct aura_buffer *);
70 char                     aura_buffer_peek_char(struct aura_buffer *);
71 char                     aura_buffer_scan_char(struct aura_buffer *);
72 int                      aura_buffer_compare(struct aura_buffer *, const char *);
73 int                      aura_buffer_expect(struct aura_buffer *, const char *);
74
75 void                     aura_buffer_push(struct aura_buffer *, const void *, size_t);
76 int                      aura_buffer_pop(struct aura_buffer *, void *, size_t);
77
78 #endif /* !__AURA_BUFFER_H_ */