5278d64e901c32c51a30febca49957412f84ad73
1#ifndef STRBUF_H
2#define STRBUF_H
3
4/* See Documentation/technical/api-strbuf.txt */
5
6#include <assert.h>
7
8extern char strbuf_slopbuf[];
9struct strbuf {
10 size_t alloc;
11 size_t len;
12 char *buf;
13};
14
15#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
16
17/*----- strbuf life cycle -----*/
18extern void strbuf_init(struct strbuf *, size_t);
19extern void strbuf_release(struct strbuf *);
20extern char *strbuf_detach(struct strbuf *, size_t *);
21extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
22static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) {
23 struct strbuf tmp = *a;
24 *a = *b;
25 *b = tmp;
26}
27
28/*----- strbuf size related -----*/
29static inline size_t strbuf_avail(const struct strbuf *sb) {
30 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
31}
32
33extern void strbuf_grow(struct strbuf *, size_t);
34
35static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
36 if (!sb->alloc)
37 strbuf_grow(sb, 0);
38 assert(len < sb->alloc);
39 sb->len = len;
40 sb->buf[len] = '\0';
41}
42#define strbuf_reset(sb) strbuf_setlen(sb, 0)
43
44/*----- content related -----*/
45extern void strbuf_trim(struct strbuf *);
46extern void strbuf_rtrim(struct strbuf *);
47extern void strbuf_ltrim(struct strbuf *);
48extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
49
50extern struct strbuf **strbuf_split_max(const struct strbuf *,
51 int delim, int max);
52static inline struct strbuf **strbuf_split(const struct strbuf *sb, int delim)
53{
54 return strbuf_split_max(sb, delim, 0);
55}
56extern void strbuf_list_free(struct strbuf **);
57
58/*----- add data in your buffer -----*/
59static inline void strbuf_addch(struct strbuf *sb, int c) {
60 strbuf_grow(sb, 1);
61 sb->buf[sb->len++] = c;
62 sb->buf[sb->len] = '\0';
63}
64
65extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
66extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
67
68/* splice pos..pos+len with given data */
69extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
70 const void *, size_t);
71
72extern void strbuf_add(struct strbuf *, const void *, size_t);
73static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
74 strbuf_add(sb, s, strlen(s));
75}
76static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
77 strbuf_grow(sb, sb2->len);
78 strbuf_add(sb, sb2->buf, sb2->len);
79}
80extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
81
82typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
83extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
84struct strbuf_expand_dict_entry {
85 const char *placeholder;
86 const char *value;
87};
88extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
89extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
90
91__attribute__((format (printf,2,3)))
92extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
93__attribute__((format (printf,2,0)))
94extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
95
96extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
97/* XXX: if read fails, any partial read is undone */
98extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
99extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
100extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
101
102extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
103extern int strbuf_getline(struct strbuf *, FILE *, int);
104
105extern void stripspace(struct strbuf *buf, int skip_comments);
106extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
107
108extern int strbuf_branchname(struct strbuf *sb, const char *name);
109extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
110
111#endif /* STRBUF_H */