annotate buffer.h @ 1:22d7bb03e569

for buffer: o added a new function buffer_putc(struct buffer *, char) that append the character to the end of the buffer o fix buffer_printf on BUFFER_AUTO
author David Demelier <markand@malikania.fr>
date Tue, 06 Sep 2011 17:43:59 +0200
parents a20beb164de8
children 86c845f86868
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * buffer.h -- safe unlimited size string
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2011, David Demelier <markand@malikania.fr>
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef HAVE_BUFFER_H
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define HAVE_BUFFER_H
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #define BUFFER_DEFAULT_BSIZE 512
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include <stdarg.h>
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 struct buffer {
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 char *data; /* string buffer */
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 size_t length; /* string's length */
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 #define BUFFER_AUTO 0x00000001
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 #define BUFFER_FIXED 0x00000010
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 int flags; /* buffer's flags (default AUTO) */
1
22d7bb03e569 for buffer:
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
33
22d7bb03e569 for buffer:
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
34 /* Private should not be modified by user */
22d7bb03e569 for buffer:
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
35 size_t size; /* current size */
22d7bb03e569 for buffer:
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
36 size_t bsize; /* block size */
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 };
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 struct buffer *buffer_new(const char *, size_t, int);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 #define buffer_new_auto(size) buffer_new(NULL, size, BUFFER_AUTO)
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 #define buffer_new_fixed(max) buffer_new(NULL, max, BUFFER_FIXED)
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 int buffer_strcat(struct buffer *, const char *);
1
22d7bb03e569 for buffer:
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
44 int buffer_putc(struct buffer *buf, char);
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 int buffer_bcat(struct buffer *, const void *, size_t);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 int buffer_vprintf(struct buffer *, const char *, va_list);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 int buffer_printf(struct buffer *, const char *, ...);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 int buffer_shrink(struct buffer *);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 char *buffer_end(struct buffer *);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 void buffer_clear(struct buffer *);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 void buffer_free(struct buffer *);
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 #endif /* HAVE_BUFFER_H */