annotate buffer.h @ 81:f42bcb9e7b4a

Add const and little security fix with *nb pointer
author David Demelier <markand@malikania.fr>
date Wed, 16 Nov 2011 20:41:36 +0100
parents 580d76781c9e
children b1a084c030c8
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
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
22 #include <stdarg.h>
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
24 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
25 extern "C" {
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
26 #endif
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
28 #define BUFFER_DEFAULT_BSIZE 512
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
29
47
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
30 enum buffer_type {
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
31 BUFFER_FIXED = 0,
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
32 BUFFER_AUTO = 1
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 };
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
47
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
35 struct buffer {
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
36 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
37 char *text; /* string buffer */
47
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
38 size_t length; /* string's real length */
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
39 size_t size; /* current allocated size */
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
40 int bsize; /* initial length */
fea13579acbe Some change in buffer
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
41 };
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
70
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
43 struct buffer *buffer_new(enum buffer_type, int);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
44 int buffer_strcat(struct buffer *, const char *);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
45 int buffer_putc(struct buffer *buf, char);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
46 int buffer_bcat(struct buffer *, const void *, size_t);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
47 int buffer_vprintf(struct buffer *, const char *, va_list);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
48 int buffer_printf(struct buffer *, const char *, ...);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
49 int buffer_shrink(struct buffer *);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
50 char *buffer_end(struct buffer *);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
51 void buffer_clear(struct buffer *);
580d76781c9e Remove attributes for buffer too
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
52 void buffer_free(struct buffer *);
0
a20beb164de8 Added buffer.c and buffer.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
54 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
55 }
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
56 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 55
diff changeset
57
2
86c845f86868 Switch to more internal define
David Demelier <markand@malikania.fr>
parents: 1
diff changeset
58 #endif /* _BUFFER_H_ */