Some better parse-options documentation.
[git/git.git] / strbuf.h
CommitLineData
d1df5743
JH
1#ifndef STRBUF_H
2#define STRBUF_H
b449f4cf
PH
3
4/*
5 * Strbuf's can be use in many ways: as a byte array, or to store arbitrary
6 * long, overflow safe strings.
7 *
8 * Strbufs has some invariants that are very important to keep in mind:
9 *
10 * 1. the ->buf member is always malloc-ed, hence strbuf's can be used to
11 * build complex strings/buffers whose final size isn't easily known.
12 *
b315c5c0 13 * It is NOT legal to copy the ->buf pointer away.
b449f4cf
PH
14 * `strbuf_detach' is the operation that detachs a buffer from its shell
15 * while keeping the shell valid wrt its invariants.
16 *
17 * 2. the ->buf member is a byte array that has at least ->len + 1 bytes
18 * allocated. The extra byte is used to store a '\0', allowing the ->buf
19 * member to be a valid C-string. Every strbuf function ensure this
20 * invariant is preserved.
21 *
22 * Note that it is OK to "play" with the buffer directly if you work it
23 * that way:
24 *
25 * strbuf_grow(sb, SOME_SIZE);
26 * // ... here the memory areay starting at sb->buf, and of length
27 * // sb_avail(sb) is all yours, and you are sure that sb_avail(sb) is at
28 * // least SOME_SIZE
29 * strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
30 *
31 * Of course, SOME_OTHER_SIZE must be smaller or equal to sb_avail(sb).
32 *
33 * Doing so is safe, though if it has to be done in many places, adding the
34 * missing API to the strbuf module is the way to go.
35 *
36 * XXX: do _not_ assume that the area that is yours is of size ->alloc - 1
37 * even if it's true in the current implementation. Alloc is somehow a
38 * "private" member that should not be messed with.
39 */
40
41#include <assert.h>
42
b315c5c0 43extern char strbuf_slopbuf[];
d1df5743 44struct strbuf {
b449f4cf
PH
45 size_t alloc;
46 size_t len;
bf0f910d 47 char *buf;
d1df5743
JH
48};
49
b315c5c0 50#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
b449f4cf
PH
51
52/*----- strbuf life cycle -----*/
f1696ee3 53extern void strbuf_init(struct strbuf *, size_t);
b449f4cf 54extern void strbuf_release(struct strbuf *);
b315c5c0 55extern char *strbuf_detach(struct strbuf *, size_t *);
917c9a71 56extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
c76689df
PH
57static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) {
58 struct strbuf tmp = *a;
59 *a = *b;
60 *b = tmp;
61}
b449f4cf
PH
62
63/*----- strbuf size related -----*/
64static inline size_t strbuf_avail(struct strbuf *sb) {
c76689df 65 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
b449f4cf 66}
a8f3e221
JH
67
68extern void strbuf_grow(struct strbuf *, size_t);
69
b449f4cf 70static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
a8f3e221
JH
71 if (!sb->alloc)
72 strbuf_grow(sb, 0);
73 assert(len < sb->alloc);
c76689df
PH
74 sb->len = len;
75 sb->buf[len] = '\0';
b449f4cf 76}
b315c5c0 77#define strbuf_reset(sb) strbuf_setlen(sb, 0)
b449f4cf 78
f1696ee3
PH
79/*----- content related -----*/
80extern void strbuf_rtrim(struct strbuf *);
45f66f64 81extern int strbuf_cmp(struct strbuf *, struct strbuf *);
f1696ee3 82
b449f4cf
PH
83/*----- add data in your buffer -----*/
84static inline void strbuf_addch(struct strbuf *sb, int c) {
85 strbuf_grow(sb, 1);
86 sb->buf[sb->len++] = c;
87 sb->buf[sb->len] = '\0';
88}
89
f1696ee3 90extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
c76689df 91extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
f1696ee3 92
917c9a71
PH
93/* splice pos..pos+len with given data */
94extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
c76689df 95 const void *, size_t);
917c9a71 96
b449f4cf
PH
97extern void strbuf_add(struct strbuf *, const void *, size_t);
98static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
99 strbuf_add(sb, s, strlen(s));
100}
101static inline void strbuf_addbuf(struct strbuf *sb, struct strbuf *sb2) {
102 strbuf_add(sb, sb2->buf, sb2->len);
103}
104
105__attribute__((format(printf,2,3)))
106extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
107
108extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
109/* XXX: if read fails, any partial read is undone */
f1696ee3 110extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
387e7e19 111extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
b449f4cf 112
e6c019d0 113extern int strbuf_getline(struct strbuf *, FILE *, int);
d1df5743 114
6d69b6f6
KH
115extern void stripspace(struct strbuf *buf, int skip_comments);
116
d1df5743 117#endif /* STRBUF_H */