annotate buffer.h @ 63:d78c4d9fad13

Move to port/ code that I didn't write
author David Demelier <markand@malikania.fr>
date Wed, 09 Nov 2011 19:30:33 +0100
parents cda80ba48029
children f773c76b1f3c
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
2
86c845f86868 Switch to more internal define
David Demelier <markand@malikania.fr>
parents: 1
diff changeset
19 #ifndef _BUFFER_H_
86c845f86868 Switch to more internal define
David Demelier <markand@malikania.fr>
parents: 1
diff changeset
20 #define _BUFFER_H_
0
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
55
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
26 /*
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
27 * Some useful attributes with gcc or clang.
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
28 */
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
29
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
30 #if defined(__GNUC__)
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
31 # pragma GCC diagnostic warning "-Wnonnull"
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
32 # pragma GCC diagnostic warning "-Wformat"
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
33 # define __at_malloc __attribute__ ((malloc))
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
34 # define __at_nonnull __attribute__ ((nonnull(1)))
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
35 # define __at_printf(...) __attribute__ ((format(printf, __VA_ARGS__)))
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
36 #else
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
37 # define __at_malloc
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
38 # define __at_nonnull
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
39 # define __at_printf(...)
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
40 #endif
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
41
47
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
42 enum buffer_type {
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
43 BUFFER_FIXED = 0,
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
44 BUFFER_AUTO = 1
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 };
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
47
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
47 struct buffer {
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
48 enum buffer_type type; /* buffer type (default AUTO) */
53
bbe0713e8e2a Rename member to text, more useful
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
49 char *text; /* string buffer */
47
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
50 size_t length; /* string's real length */
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
51 size_t size; /* current allocated size */
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
52 int bsize; /* initial length */
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
53 };
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
55
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
55 struct buffer *buffer_new(enum buffer_type, int) __at_malloc;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
56 int buffer_strcat(struct buffer *, const char *) __at_nonnull;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
57 int buffer_putc(struct buffer *buf, char) __at_nonnull;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
58 int buffer_bcat(struct buffer *, const void *, size_t) __at_nonnull;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
59 int buffer_vprintf(struct buffer *, const char *, va_list) __at_nonnull;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
60 int buffer_printf(struct buffer *, const char *, ...) __at_printf(2, 3);
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
61 int buffer_shrink(struct buffer *) __at_nonnull;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
62 char *buffer_end(struct buffer *) __at_nonnull;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
63 void buffer_clear(struct buffer *) __at_nonnull;
cda80ba48029 Add beautiful gcc attribute to buffer
David Demelier <markand@malikania.fr>
parents: 53
diff changeset
64 void buffer_free(struct buffer *) __at_nonnull;
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
65
2
86c845f86868 Switch to more internal define
David Demelier <markand@malikania.fr>
parents: 1
diff changeset
66 #endif /* _BUFFER_H_ */