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