annotate buf.h @ 34:5493466d6e56

misc: update copyright years
author David Demelier <markand@malikania.fr>
date Wed, 01 Feb 2023 13:00:51 +0100
parents dbdc17e11648
children ab071d485d38
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * buf.h -- simple string buffer for C
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
34
5493466d6e56 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
4 * Copyright (c) 2019-2023 David Demelier <markand@malikania.fr>
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef BUF_H
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define BUF_H
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <stdarg.h>
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include <stddef.h>
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 #if !defined(BUF_MALLOC)
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 # define BUF_MALLOC malloc
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 #endif
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #if !defined(BUF_REALLOC)
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 # define BUF_REALLOC realloc
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 #endif
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 #if !defined(BUF_FREE)
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 # define BUF_FREE free
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 #endif
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
3
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
37 #if defined(__cplusplus)
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
38 extern "C" {
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
39 #endif
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
40
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 struct buf {
15
9f4f7a266c0b misc: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 3
diff changeset
42 char *data;
9f4f7a266c0b misc: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 3
diff changeset
43 size_t length;
9f4f7a266c0b misc: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 3
diff changeset
44 size_t capacity;
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 };
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 void
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
48 buf_init(struct buf *);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
50 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
51 buf_reserve(struct buf *, size_t);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
53 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
54 buf_resize(struct buf *, size_t, char);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
56 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
57 buf_shrink(struct buf *);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 void
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
60 buf_erase(struct buf *, size_t, size_t);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
62 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
63 buf_putc(struct buf *, char);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
65 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
66 buf_puts(struct buf *, const char *);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
68 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
69 buf_printf(struct buf *, const char *, ...);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
71 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
72 buf_vprintf(struct buf *, const char *, va_list);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
74 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
75 buf_sub(struct buf *, const struct buf *, size_t, size_t);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
21
939fe74cd80a buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
77 int
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
78 buf_dup(struct buf *, const struct buf *);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
79
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 void
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
81 buf_clear(struct buf *);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 void
23
b7690784cd17 misc: update before 0.3.0
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
84 buf_finish(struct buf *);
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
85
3
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
86 #if defined(__cplusplus)
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
87 }
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
88 #endif
9c6b686f797d misc: add extern C for C++ friends
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
89
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 #endif /* !BUF_H */