1#ifndef STRBUF_H
2#define STRBUF_H
3
4/* See Documentation/technical/api-strbuf.txt */
5
6extern char strbuf_slopbuf[];
7struct strbuf {
8 size_t alloc;
9 size_t len;
10 char *buf;
11};
12
13#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
14
15/*----- strbuf life cycle -----*/
16extern void strbuf_init(struct strbuf *, size_t);
17extern void strbuf_release(struct strbuf *);
18extern char *strbuf_detach(struct strbuf *, size_t *);
19extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
20static inline void strbuf_swap(struct strbuf *a, struct strbuf *b)
21{
22 struct strbuf tmp = *a;
23 *a = *b;
24 *b = tmp;
25}
26
27/*----- strbuf size related -----*/
28static inline size_t strbuf_avail(const struct strbuf *sb)
29{
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{
37 if (len > (sb->alloc ? sb->alloc - 1 : 0))
38 die("BUG: strbuf_setlen() beyond buffer");
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 void strbuf_tolower(struct strbuf *sb);
49extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
50
51/*
52 * Split str (of length slen) at the specified terminator character.
53 * Return a null-terminated array of pointers to strbuf objects
54 * holding the substrings. The substrings include the terminator,
55 * except for the last substring, which might be unterminated if the
56 * original string did not end with a terminator. If max is positive,
57 * then split the string into at most max substrings (with the last
58 * substring containing everything following the (max-1)th terminator
59 * character).
60 *
61 * For lighter-weight alternatives, see string_list_split() and
62 * string_list_split_in_place().
63 */
64extern struct strbuf **strbuf_split_buf(const char *, size_t,
65 int terminator, int max);
66
67/*
68 * Split a NUL-terminated string at the specified terminator
69 * character. See strbuf_split_buf() for more information.
70 */
71static inline struct strbuf **strbuf_split_str(const char *str,
72 int terminator, int max)
73{
74 return strbuf_split_buf(str, strlen(str), terminator, max);
75}
76
77/*
78 * Split a strbuf at the specified terminator character. See
79 * strbuf_split_buf() for more information.
80 */
81static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
82 int terminator, int max)
83{
84 return strbuf_split_buf(sb->buf, sb->len, terminator, max);
85}
86
87/*
88 * Split a strbuf at the specified terminator character. See
89 * strbuf_split_buf() for more information.
90 */
91static inline struct strbuf **strbuf_split(const struct strbuf *sb,
92 int terminator)
93{
94 return strbuf_split_max(sb, terminator, 0);
95}
96
97/*
98 * Free a NULL-terminated list of strbufs (for example, the return
99 * values of the strbuf_split*() functions).
100 */
101extern void strbuf_list_free(struct strbuf **);
102
103/*----- add data in your buffer -----*/
104static inline void strbuf_addch(struct strbuf *sb, int c)
105{
106 strbuf_grow(sb, 1);
107 sb->buf[sb->len++] = c;
108 sb->buf[sb->len] = '\0';
109}
110
111extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
112extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
113
114/* splice pos..pos+len with given data */
115extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
116 const void *, size_t);
117
118extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
119
120extern void strbuf_add(struct strbuf *, const void *, size_t);
121static inline void strbuf_addstr(struct strbuf *sb, const char *s)
122{
123 strbuf_add(sb, s, strlen(s));
124}
125static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
126{
127 strbuf_grow(sb, sb2->len);
128 strbuf_add(sb, sb2->buf, sb2->len);
129}
130extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
131
132typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
133extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
134struct strbuf_expand_dict_entry {
135 const char *placeholder;
136 const char *value;
137};
138extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
139extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
140
141__attribute__((format (printf,2,3)))
142extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
143__attribute__((format (printf, 2, 3)))
144extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
145__attribute__((format (printf,2,0)))
146extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
147
148extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
149
150/*
151 * Append s to sb, with the characters '<', '>', '&' and '"' converted
152 * into XML entities.
153 */
154extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
155
156static inline void strbuf_complete_line(struct strbuf *sb)
157{
158 if (sb->len && sb->buf[sb->len - 1] != '\n')
159 strbuf_addch(sb, '\n');
160}
161
162extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
163/* XXX: if read fails, any partial read is undone */
164extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
165extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
166extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
167
168extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
169extern int strbuf_getline(struct strbuf *, FILE *, int);
170extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
171
172extern void stripspace(struct strbuf *buf, int skip_comments);
173extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
174
175extern int strbuf_branchname(struct strbuf *sb, const char *name);
176extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
177
178extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
179 int reserved);
180extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
181
182__attribute__((format (printf,1,2)))
183extern int printf_ln(const char *fmt, ...);
184__attribute__((format (printf,2,3)))
185extern int fprintf_ln(FILE *fp, const char *fmt, ...);
186
187char *xstrdup_tolower(const char *);
188
189#endif /* STRBUF_H */