]>
Commit | Line | Data |
---|---|---|
d1df5743 JH |
1 | #ifndef STRBUF_H |
2 | #define STRBUF_H | |
b449f4cf | 3 | |
f6f77559 EN |
4 | struct string_list; |
5 | ||
bdfdaa49 JK |
6 | /** |
7 | * strbuf's are meant to be used with all the usual C string and memory | |
8 | * APIs. Given that the length of the buffer is known, it's often better to | |
9 | * use the mem* functions than a str* one (memchr vs. strchr e.g.). | |
10 | * Though, one has to be careful about the fact that str* functions often | |
11 | * stop on NULs and that strbufs may have embedded NULs. | |
12 | * | |
13 | * A strbuf is NUL terminated for convenience, but no function in the | |
14 | * strbuf API actually relies on the string being free of NULs. | |
15 | * | |
16 | * strbufs have some invariants that are very important to keep in mind: | |
17 | * | |
aa07cac4 JK |
18 | * - The `buf` member is never NULL, so it can be used in any usual C |
19 | * string operations safely. strbuf's _have_ to be initialized either by | |
20 | * `strbuf_init()` or by `= STRBUF_INIT` before the invariants, though. | |
bdfdaa49 | 21 | * |
aa07cac4 JK |
22 | * Do *not* assume anything on what `buf` really is (e.g. if it is |
23 | * allocated memory or not), use `strbuf_detach()` to unwrap a memory | |
24 | * buffer from its strbuf shell in a safe way. That is the sole supported | |
25 | * way. This will give you a malloced buffer that you can later `free()`. | |
26 | * | |
27 | * However, it is totally safe to modify anything in the string pointed by | |
28 | * the `buf` member, between the indices `0` and `len-1` (inclusive). | |
29 | * | |
30 | * - The `buf` member is a byte array that has at least `len + 1` bytes | |
31 | * allocated. The extra byte is used to store a `'\0'`, allowing the | |
32 | * `buf` member to be a valid C-string. Every strbuf function ensure this | |
33 | * invariant is preserved. | |
34 | * | |
35 | * NOTE: It is OK to "play" with the buffer directly if you work it this | |
36 | * way: | |
37 | * | |
088c9a86 JK |
38 | * strbuf_grow(sb, SOME_SIZE); <1> |
39 | * strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE); | |
40 | * | |
aa07cac4 JK |
41 | * <1> Here, the memory array starting at `sb->buf`, and of length |
42 | * `strbuf_avail(sb)` is all yours, and you can be sure that | |
43 | * `strbuf_avail(sb)` is at least `SOME_SIZE`. | |
44 | * | |
45 | * NOTE: `SOME_OTHER_SIZE` must be smaller or equal to `strbuf_avail(sb)`. | |
46 | * | |
47 | * Doing so is safe, though if it has to be done in many places, adding the | |
48 | * missing API to the strbuf module is the way to go. | |
49 | * | |
50 | * WARNING: Do _not_ assume that the area that is yours is of size `alloc | |
51 | * - 1` even if it's true in the current implementation. Alloc is somehow a | |
52 | * "private" member that should not be messed with. Use `strbuf_avail()` | |
53 | * instead. | |
54 | */ | |
b449f4cf | 55 | |
bdfdaa49 JK |
56 | /** |
57 | * Data Structures | |
58 | * --------------- | |
59 | */ | |
60 | ||
61 | /** | |
62 | * This is the string buffer structure. The `len` member can be used to | |
63 | * determine the current length of the string, and `buf` member provides | |
64 | * access to the string itself. | |
65 | */ | |
d1df5743 | 66 | struct strbuf { |
b449f4cf PH |
67 | size_t alloc; |
68 | size_t len; | |
bf0f910d | 69 | char *buf; |
d1df5743 JH |
70 | }; |
71 | ||
bdfdaa49 | 72 | extern char strbuf_slopbuf[]; |
608cfd31 | 73 | #define STRBUF_INIT { .buf = strbuf_slopbuf } |
b449f4cf | 74 | |
30e677e0 | 75 | /* |
76 | * Predeclare this here, since cache.h includes this file before it defines the | |
77 | * struct. | |
78 | */ | |
79 | struct object_id; | |
80 | ||
bdfdaa49 | 81 | /** |
14e2177a JK |
82 | * Life Cycle Functions |
83 | * -------------------- | |
bdfdaa49 JK |
84 | */ |
85 | ||
86 | /** | |
87 | * Initialize the structure. The second parameter can be zero or a bigger | |
88 | * number to allocate memory, in case you want to prevent further reallocs. | |
89 | */ | |
c7e5fe79 | 90 | void strbuf_init(struct strbuf *sb, size_t alloc); |
bdfdaa49 JK |
91 | |
92 | /** | |
e0222159 JN |
93 | * Release a string buffer and the memory it used. After this call, the |
94 | * strbuf points to an empty string that does not need to be free()ed, as | |
95 | * if it had been set to `STRBUF_INIT` and never modified. | |
96 | * | |
97 | * To clear a strbuf in preparation for further use without the overhead | |
98 | * of free()ing and malloc()ing again, use strbuf_reset() instead. | |
bdfdaa49 | 99 | */ |
c7e5fe79 | 100 | void strbuf_release(struct strbuf *sb); |
bdfdaa49 JK |
101 | |
102 | /** | |
103 | * Detach the string from the strbuf and returns it; you now own the | |
104 | * storage the string occupies and it is your responsibility from then on | |
105 | * to release it with `free(3)` when you are done with it. | |
e0222159 JN |
106 | * |
107 | * The strbuf that previously held the string is reset to `STRBUF_INIT` so | |
108 | * it can be reused after calling this function. | |
bdfdaa49 | 109 | */ |
c7e5fe79 | 110 | char *strbuf_detach(struct strbuf *sb, size_t *sz); |
bdfdaa49 JK |
111 | |
112 | /** | |
113 | * Attach a string to a buffer. You should specify the string to attach, | |
114 | * the current length of the string and the amount of allocated memory. | |
115 | * The amount must be larger than the string length, because the string you | |
116 | * pass is supposed to be a NUL-terminated string. This string _must_ be | |
117 | * malloc()ed, and after attaching, the pointer cannot be relied upon | |
118 | * anymore, and neither be free()d directly. | |
119 | */ | |
c7e5fe79 | 120 | void strbuf_attach(struct strbuf *sb, void *str, size_t len, size_t mem); |
bdfdaa49 JK |
121 | |
122 | /** | |
123 | * Swap the contents of two string buffers. | |
124 | */ | |
187e290a NTND |
125 | static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) |
126 | { | |
35d803bc | 127 | SWAP(*a, *b); |
c76689df | 128 | } |
b449f4cf | 129 | |
bdfdaa49 JK |
130 | |
131 | /** | |
14e2177a JK |
132 | * Functions related to the size of the buffer |
133 | * ------------------------------------------- | |
bdfdaa49 JK |
134 | */ |
135 | ||
136 | /** | |
137 | * Determine the amount of allocated but unused memory. | |
138 | */ | |
187e290a NTND |
139 | static inline size_t strbuf_avail(const struct strbuf *sb) |
140 | { | |
c76689df | 141 | return sb->alloc ? sb->alloc - sb->len - 1 : 0; |
b449f4cf | 142 | } |
a8f3e221 | 143 | |
bdfdaa49 JK |
144 | /** |
145 | * Ensure that at least this amount of unused memory is available after | |
146 | * `len`. This is used when you know a typical size for what you will add | |
147 | * and want to avoid repetitive automatic resizing of the underlying buffer. | |
148 | * This is never a needed operation, but can be critical for performance in | |
149 | * some cases. | |
150 | */ | |
c7e5fe79 | 151 | void strbuf_grow(struct strbuf *sb, size_t amount); |
a8f3e221 | 152 | |
bdfdaa49 JK |
153 | /** |
154 | * Set the length of the buffer to a given value. This function does *not* | |
155 | * allocate new memory, so you should not perform a `strbuf_setlen()` to a | |
156 | * length that is larger than `len + strbuf_avail()`. `strbuf_setlen()` is | |
157 | * just meant as a 'please fix invariants from this strbuf I just messed | |
158 | * with'. | |
159 | */ | |
187e290a NTND |
160 | static inline void strbuf_setlen(struct strbuf *sb, size_t len) |
161 | { | |
7141efab | 162 | if (len > (sb->alloc ? sb->alloc - 1 : 0)) |
46d699f4 | 163 | BUG("strbuf_setlen() beyond buffer"); |
c76689df | 164 | sb->len = len; |
65961d5a MÅ |
165 | if (sb->buf != strbuf_slopbuf) |
166 | sb->buf[len] = '\0'; | |
167 | else | |
168 | assert(!strbuf_slopbuf[0]); | |
b449f4cf | 169 | } |
bdfdaa49 JK |
170 | |
171 | /** | |
172 | * Empty the buffer by setting the size of it to zero. | |
173 | */ | |
b315c5c0 | 174 | #define strbuf_reset(sb) strbuf_setlen(sb, 0) |
b449f4cf | 175 | |
bdfdaa49 JK |
176 | |
177 | /** | |
14e2177a JK |
178 | * Functions related to the contents of the buffer |
179 | * ----------------------------------------------- | |
bdfdaa49 JK |
180 | */ |
181 | ||
182 | /** | |
d468fa27 JK |
183 | * Strip whitespace from the beginning (`ltrim`), end (`rtrim`), or both side |
184 | * (`trim`) of a string. | |
bdfdaa49 | 185 | */ |
c7e5fe79 SB |
186 | void strbuf_trim(struct strbuf *sb); |
187 | void strbuf_rtrim(struct strbuf *sb); | |
188 | void strbuf_ltrim(struct strbuf *sb); | |
bdfdaa49 | 189 | |
c64a8d20 | 190 | /* Strip trailing directory separators */ |
c7e5fe79 | 191 | void strbuf_trim_trailing_dir_sep(struct strbuf *sb); |
c64a8d20 | 192 | |
f9573628 | 193 | /* Strip trailing LF or CR/LF */ |
39f73315 | 194 | void strbuf_trim_trailing_newline(struct strbuf *sb); |
f9573628 | 195 | |
bdfdaa49 JK |
196 | /** |
197 | * Replace the contents of the strbuf with a reencoded form. Returns -1 | |
198 | * on error, 0 on success. | |
199 | */ | |
c7e5fe79 | 200 | int strbuf_reencode(struct strbuf *sb, const char *from, const char *to); |
bdfdaa49 JK |
201 | |
202 | /** | |
203 | * Lowercase each character in the buffer using `tolower`. | |
204 | */ | |
c7e5fe79 | 205 | void strbuf_tolower(struct strbuf *sb); |
bdfdaa49 JK |
206 | |
207 | /** | |
208 | * Compare two buffers. Returns an integer less than, equal to, or greater | |
209 | * than zero if the first buffer is found, respectively, to be less than, | |
210 | * to match, or be greater than the second buffer. | |
211 | */ | |
c7e5fe79 | 212 | int strbuf_cmp(const struct strbuf *first, const struct strbuf *second); |
eacd6dc5 | 213 | |
bdfdaa49 JK |
214 | |
215 | /** | |
14e2177a JK |
216 | * Adding data to the buffer |
217 | * ------------------------- | |
bdfdaa49 JK |
218 | * |
219 | * NOTE: All of the functions in this section will grow the buffer as | |
220 | * necessary. If they fail for some reason other than memory shortage and the | |
221 | * buffer hadn't been allocated before (i.e. the `struct strbuf` was set to | |
222 | * `STRBUF_INIT`), then they will free() it. | |
223 | */ | |
224 | ||
225 | /** | |
226 | * Add a single character to the buffer. | |
227 | */ | |
228 | static inline void strbuf_addch(struct strbuf *sb, int c) | |
229 | { | |
fec501da JK |
230 | if (!strbuf_avail(sb)) |
231 | strbuf_grow(sb, 1); | |
bdfdaa49 JK |
232 | sb->buf[sb->len++] = c; |
233 | sb->buf[sb->len] = '\0'; | |
234 | } | |
235 | ||
236 | /** | |
237 | * Add a character the specified number of times to the buffer. | |
238 | */ | |
c7e5fe79 | 239 | void strbuf_addchars(struct strbuf *sb, int c, size_t n); |
bdfdaa49 JK |
240 | |
241 | /** | |
242 | * Insert data to the given position of the buffer. The remaining contents | |
243 | * will be shifted, not overwritten. | |
244 | */ | |
c7e5fe79 | 245 | void strbuf_insert(struct strbuf *sb, size_t pos, const void *, size_t); |
bdfdaa49 | 246 | |
a91cc7fa RS |
247 | /** |
248 | * Insert a NUL-terminated string to the given position of the buffer. | |
249 | * The remaining contents will be shifted, not overwritten. It's an | |
250 | * inline function to allow the compiler to resolve strlen() calls on | |
251 | * constants at compile time. | |
252 | */ | |
253 | static inline void strbuf_insertstr(struct strbuf *sb, size_t pos, | |
254 | const char *s) | |
255 | { | |
256 | strbuf_insert(sb, pos, s, strlen(s)); | |
257 | } | |
258 | ||
5ef264db PSU |
259 | /** |
260 | * Insert data to the given position of the buffer giving a printf format | |
261 | * string. The contents will be shifted, not overwritten. | |
262 | */ | |
263 | void strbuf_vinsertf(struct strbuf *sb, size_t pos, const char *fmt, | |
264 | va_list ap); | |
265 | ||
75d31cee | 266 | __attribute__((format (printf, 3, 4))) |
5ef264db PSU |
267 | void strbuf_insertf(struct strbuf *sb, size_t pos, const char *fmt, ...); |
268 | ||
bdfdaa49 JK |
269 | /** |
270 | * Remove given amount of data from a given position of the buffer. | |
271 | */ | |
c7e5fe79 | 272 | void strbuf_remove(struct strbuf *sb, size_t pos, size_t len); |
bdfdaa49 JK |
273 | |
274 | /** | |
275 | * Remove the bytes between `pos..pos+len` and replace it with the given | |
276 | * data. | |
277 | */ | |
c7e5fe79 SB |
278 | void strbuf_splice(struct strbuf *sb, size_t pos, size_t len, |
279 | const void *data, size_t data_len); | |
bdfdaa49 JK |
280 | |
281 | /** | |
282 | * Add a NUL-terminated string to the buffer. Each line will be prepended | |
283 | * by a comment character and a blank. | |
284 | */ | |
c7e5fe79 SB |
285 | void strbuf_add_commented_lines(struct strbuf *out, |
286 | const char *buf, size_t size); | |
bdfdaa49 JK |
287 | |
288 | ||
289 | /** | |
290 | * Add data of given length to the buffer. | |
291 | */ | |
c7e5fe79 | 292 | void strbuf_add(struct strbuf *sb, const void *data, size_t len); |
bdfdaa49 JK |
293 | |
294 | /** | |
295 | * Add a NUL-terminated string to the buffer. | |
296 | * | |
297 | * NOTE: This function will *always* be implemented as an inline or a macro | |
298 | * using strlen, meaning that this is efficient to write things like: | |
299 | * | |
088c9a86 | 300 | * strbuf_addstr(sb, "immediate string"); |
bdfdaa49 JK |
301 | * |
302 | */ | |
303 | static inline void strbuf_addstr(struct strbuf *sb, const char *s) | |
304 | { | |
305 | strbuf_add(sb, s, strlen(s)); | |
306 | } | |
307 | ||
308 | /** | |
309 | * Copy the contents of another buffer at the end of the current one. | |
310 | */ | |
c7e5fe79 | 311 | void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2); |
bdfdaa49 | 312 | |
e71c4a88 PSU |
313 | /** |
314 | * Join the arguments into a buffer. `delim` is put between every | |
315 | * two arguments. | |
316 | */ | |
317 | const char *strbuf_join_argv(struct strbuf *buf, int argc, | |
318 | const char **argv, char delim); | |
319 | ||
bdfdaa49 JK |
320 | /** |
321 | * This function can be used to expand a format string containing | |
322 | * placeholders. To that end, it parses the string and calls the specified | |
323 | * function for every percent sign found. | |
324 | * | |
325 | * The callback function is given a pointer to the character after the `%` | |
326 | * and a pointer to the struct strbuf. It is expected to add the expanded | |
327 | * version of the placeholder to the strbuf, e.g. to add a newline | |
328 | * character if the letter `n` appears after a `%`. The function returns | |
329 | * the length of the placeholder recognized and `strbuf_expand()` skips | |
330 | * over it. | |
331 | * | |
332 | * The format `%%` is automatically expanded to a single `%` as a quoting | |
333 | * mechanism; callers do not need to handle the `%` placeholder themselves, | |
334 | * and the callback function will not be invoked for this placeholder. | |
335 | * | |
336 | * All other characters (non-percent and not skipped ones) are copied | |
337 | * verbatim to the strbuf. If the callback returned zero, meaning that the | |
338 | * placeholder is unknown, then the percent sign is copied, too. | |
339 | * | |
340 | * In order to facilitate caching and to make it possible to give | |
0e20b229 FC |
341 | * parameters to the callback, `strbuf_expand()` passes a context |
342 | * pointer with any kind of data. | |
bdfdaa49 | 343 | */ |
c7e5fe79 SB |
344 | typedef size_t (*expand_fn_t) (struct strbuf *sb, |
345 | const char *placeholder, | |
346 | void *context); | |
347 | void strbuf_expand(struct strbuf *sb, | |
348 | const char *format, | |
349 | expand_fn_t fn, | |
350 | void *context); | |
bdfdaa49 | 351 | |
fd2015b3 AW |
352 | /** |
353 | * Used as callback for `strbuf_expand` to only expand literals | |
354 | * (i.e. %n and %xNN). The context argument is ignored. | |
355 | */ | |
356 | size_t strbuf_expand_literal_cb(struct strbuf *sb, | |
357 | const char *placeholder, | |
358 | void *context); | |
359 | ||
bdfdaa49 JK |
360 | /** |
361 | * Used as callback for `strbuf_expand()`, expects an array of | |
362 | * struct strbuf_expand_dict_entry as context, i.e. pairs of | |
363 | * placeholder and replacement string. The array needs to be | |
364 | * terminated by an entry with placeholder set to NULL. | |
365 | */ | |
366 | struct strbuf_expand_dict_entry { | |
367 | const char *placeholder; | |
368 | const char *value; | |
369 | }; | |
c7e5fe79 SB |
370 | size_t strbuf_expand_dict_cb(struct strbuf *sb, |
371 | const char *placeholder, | |
372 | void *context); | |
bdfdaa49 JK |
373 | |
374 | /** | |
375 | * Append the contents of one strbuf to another, quoting any | |
376 | * percent signs ("%") into double-percents ("%%") in the | |
377 | * destination. This is useful for literal data to be fed to either | |
378 | * strbuf_expand or to the *printf family of functions. | |
379 | */ | |
c7e5fe79 | 380 | void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src); |
bdfdaa49 | 381 | |
b44d0118 | 382 | #define STRBUF_ENCODE_SLASH 1 |
383 | ||
46fd7b39 | 384 | /** |
385 | * Append the contents of a string to a strbuf, percent-encoding any characters | |
386 | * that are needed to be encoded for a URL. | |
b44d0118 | 387 | * |
388 | * If STRBUF_ENCODE_SLASH is set in flags, percent-encode slashes. Otherwise, | |
389 | * slashes are not percent-encoded. | |
46fd7b39 | 390 | */ |
b44d0118 | 391 | void strbuf_add_percentencode(struct strbuf *dst, const char *src, int flags); |
46fd7b39 | 392 | |
bdfdaa49 JK |
393 | /** |
394 | * Append the given byte size as a human-readable string (i.e. 12.23 KiB, | |
395 | * 3.50 MiB). | |
396 | */ | |
c7e5fe79 | 397 | void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes); |
bdfdaa49 | 398 | |
8f354a1f DR |
399 | /** |
400 | * Append the given byte rate as a human-readable string (i.e. 12.23 KiB/s, | |
401 | * 3.50 MiB/s). | |
402 | */ | |
403 | void strbuf_humanise_rate(struct strbuf *buf, off_t bytes); | |
404 | ||
bdfdaa49 JK |
405 | /** |
406 | * Add a formatted string to the buffer. | |
407 | */ | |
408 | __attribute__((format (printf,2,3))) | |
c7e5fe79 | 409 | void strbuf_addf(struct strbuf *sb, const char *fmt, ...); |
bdfdaa49 JK |
410 | |
411 | /** | |
412 | * Add a formatted string prepended by a comment character and a | |
413 | * blank to the buffer. | |
414 | */ | |
415 | __attribute__((format (printf, 2, 3))) | |
c7e5fe79 | 416 | void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...); |
bdfdaa49 JK |
417 | |
418 | __attribute__((format (printf,2,0))) | |
c7e5fe79 | 419 | void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap); |
bdfdaa49 | 420 | |
aa1462cc JK |
421 | /** |
422 | * Add the time specified by `tm`, as formatted by `strftime`. | |
c3fbf81a RS |
423 | * `tz_offset` is in decimal hhmm format, e.g. -600 means six hours west |
424 | * of Greenwich, and it's used to expand %z internally. However, tokens | |
425 | * with modifiers (e.g. %Ez) are passed to `strftime`. | |
3b702239 ÆAB |
426 | * `suppress_tz_name`, when set, expands %Z internally to the empty |
427 | * string rather than passing it to `strftime`. | |
c3fbf81a | 428 | */ |
c7e5fe79 SB |
429 | void strbuf_addftime(struct strbuf *sb, const char *fmt, |
430 | const struct tm *tm, int tz_offset, | |
431 | int suppress_tz_name); | |
aa1462cc | 432 | |
bdfdaa49 JK |
433 | /** |
434 | * Read a given size of data from a FILE* pointer to the buffer. | |
435 | * | |
436 | * NOTE: The buffer is rewound if the read fails. If -1 is returned, | |
437 | * `errno` must be consulted, like you would do for `read(3)`. | |
1a0c8dfd JH |
438 | * `strbuf_read()`, `strbuf_read_file()` and `strbuf_getline_*()` |
439 | * family of functions have the same behaviour as well. | |
bdfdaa49 | 440 | */ |
c7e5fe79 | 441 | size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *file); |
bdfdaa49 JK |
442 | |
443 | /** | |
444 | * Read the contents of a given file descriptor. The third argument can be | |
445 | * used to give a hint about the file size, to avoid reallocs. If read fails, | |
446 | * any partial read is undone. | |
447 | */ | |
c7e5fe79 | 448 | ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint); |
bdfdaa49 | 449 | |
b4e04fb6 SB |
450 | /** |
451 | * Read the contents of a given file descriptor partially by using only one | |
452 | * attempt of xread. The third argument can be used to give a hint about the | |
453 | * file size, to avoid reallocs. Returns the number of new bytes appended to | |
454 | * the sb. | |
455 | */ | |
c7e5fe79 | 456 | ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint); |
b4e04fb6 | 457 | |
bdfdaa49 JK |
458 | /** |
459 | * Read the contents of a file, specified by its path. The third argument | |
460 | * can be used to give a hint about the file size, to avoid reallocs. | |
ed008d7b PB |
461 | * Return the number of bytes read or a negative value if some error |
462 | * occurred while opening or reading the file. | |
bdfdaa49 | 463 | */ |
c7e5fe79 | 464 | ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint); |
bdfdaa49 JK |
465 | |
466 | /** | |
467 | * Read the target of a symbolic link, specified by its path. The third | |
468 | * argument can be used to give a hint about the size, to avoid reallocs. | |
469 | */ | |
c7e5fe79 | 470 | int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint); |
bdfdaa49 | 471 | |
2dac9b56 SB |
472 | /** |
473 | * Write the whole content of the strbuf to the stream not stopping at | |
474 | * NUL bytes. | |
475 | */ | |
c7e5fe79 | 476 | ssize_t strbuf_write(struct strbuf *sb, FILE *stream); |
2dac9b56 | 477 | |
bdfdaa49 | 478 | /** |
1a0c8dfd JH |
479 | * Read a line from a FILE *, overwriting the existing contents of |
480 | * the strbuf. The strbuf_getline*() family of functions share | |
481 | * this signature, but have different line termination conventions. | |
482 | * | |
bdfdaa49 JK |
483 | * Reading stops after the terminator or at EOF. The terminator |
484 | * is removed from the buffer before returning. Returns 0 unless | |
485 | * there was nothing left before EOF, in which case it returns `EOF`. | |
486 | */ | |
8f309aeb JH |
487 | typedef int (*strbuf_getline_fn)(struct strbuf *, FILE *); |
488 | ||
489 | /* Uses LF as the line terminator */ | |
c7e5fe79 | 490 | int strbuf_getline_lf(struct strbuf *sb, FILE *fp); |
8f309aeb JH |
491 | |
492 | /* Uses NUL as the line terminator */ | |
c7e5fe79 | 493 | int strbuf_getline_nul(struct strbuf *sb, FILE *fp); |
8f309aeb | 494 | |
c8aa9fdf | 495 | /* |
8f309aeb JH |
496 | * Similar to strbuf_getline_lf(), but additionally treats a CR that |
497 | * comes immediately before the LF as part of the terminator. | |
1a0c8dfd JH |
498 | * This is the most friendly version to be used to read "text" files |
499 | * that can come from platforms whose native text format is CRLF | |
500 | * terminated. | |
c8aa9fdf | 501 | */ |
c7e5fe79 | 502 | int strbuf_getline(struct strbuf *sb, FILE *file); |
c8aa9fdf | 503 | |
bdfdaa49 JK |
504 | |
505 | /** | |
506 | * Like `strbuf_getline`, but keeps the trailing terminator (if | |
507 | * any) in the buffer. | |
508 | */ | |
c7e5fe79 | 509 | int strbuf_getwholeline(struct strbuf *sb, FILE *file, int term); |
bdfdaa49 | 510 | |
bd021f39 PS |
511 | /** |
512 | * Like `strbuf_getwholeline`, but appends the line instead of | |
513 | * resetting the buffer first. | |
514 | */ | |
515 | int strbuf_appendwholeline(struct strbuf *sb, FILE *file, int term); | |
516 | ||
bdfdaa49 JK |
517 | /** |
518 | * Like `strbuf_getwholeline`, but operates on a file descriptor. | |
519 | * It reads one character at a time, so it is very slow. Do not | |
520 | * use it unless you need the correct position in the file | |
521 | * descriptor. | |
522 | */ | |
c7e5fe79 | 523 | int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term); |
bdfdaa49 JK |
524 | |
525 | /** | |
526 | * Set the buffer to the path of the current working directory. | |
527 | */ | |
c7e5fe79 | 528 | int strbuf_getcwd(struct strbuf *sb); |
bdfdaa49 JK |
529 | |
530 | /** | |
531 | * Add a path to a buffer, converting a relative path to an | |
532 | * absolute one in the process. Symbolic links are not | |
533 | * resolved. | |
534 | */ | |
c7e5fe79 | 535 | void strbuf_add_absolute_path(struct strbuf *sb, const char *path); |
bdfdaa49 | 536 | |
33ad9ddd RS |
537 | /** |
538 | * Canonize `path` (make it absolute, resolve symlinks, remove extra | |
539 | * slashes) and append it to `sb`. Die with an informative error | |
540 | * message if there is a problem. | |
541 | * | |
542 | * The directory part of `path` (i.e., everything up to the last | |
543 | * dir_sep) must denote a valid, existing directory, but the last | |
544 | * component need not exist. | |
545 | * | |
546 | * Callers that don't mind links should use the more lightweight | |
547 | * strbuf_add_absolute_path() instead. | |
548 | */ | |
c7e5fe79 | 549 | void strbuf_add_real_path(struct strbuf *sb, const char *path); |
33ad9ddd | 550 | |
670c359d JK |
551 | |
552 | /** | |
553 | * Normalize in-place the path contained in the strbuf. See | |
554 | * normalize_path_copy() for details. If an error occurs, the contents of "sb" | |
555 | * are left untouched, and -1 is returned. | |
556 | */ | |
c7e5fe79 | 557 | int strbuf_normalize_path(struct strbuf *sb); |
670c359d | 558 | |
bdfdaa49 JK |
559 | /** |
560 | * Strip whitespace from a buffer. The second parameter controls if | |
561 | * comments are considered contents to be removed or not. | |
562 | */ | |
c7e5fe79 | 563 | void strbuf_stripspace(struct strbuf *buf, int skip_comments); |
63af4a84 | 564 | |
6dda4e60 JK |
565 | static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix) |
566 | { | |
567 | if (strip_suffix_mem(sb->buf, &sb->len, suffix)) { | |
568 | strbuf_setlen(sb, sb->len); | |
569 | return 1; | |
570 | } else | |
571 | return 0; | |
572 | } | |
573 | ||
6afbbdda | 574 | /** |
06379a65 MH |
575 | * Split str (of length slen) at the specified terminator character. |
576 | * Return a null-terminated array of pointers to strbuf objects | |
577 | * holding the substrings. The substrings include the terminator, | |
578 | * except for the last substring, which might be unterminated if the | |
579 | * original string did not end with a terminator. If max is positive, | |
580 | * then split the string into at most max substrings (with the last | |
581 | * substring containing everything following the (max-1)th terminator | |
582 | * character). | |
583 | * | |
f20e56e2 JK |
584 | * The most generic form is `strbuf_split_buf`, which takes an arbitrary |
585 | * pointer/len buffer. The `_str` variant takes a NUL-terminated string, | |
586 | * the `_max` variant takes a strbuf, and just `strbuf_split` is a convenience | |
587 | * wrapper to drop the `max` parameter. | |
588 | * | |
06379a65 MH |
589 | * For lighter-weight alternatives, see string_list_split() and |
590 | * string_list_split_in_place(). | |
591 | */ | |
c7e5fe79 SB |
592 | struct strbuf **strbuf_split_buf(const char *str, size_t len, |
593 | int terminator, int max); | |
06379a65 | 594 | |
2f1d9e2b | 595 | static inline struct strbuf **strbuf_split_str(const char *str, |
17b73dc6 | 596 | int terminator, int max) |
2f1d9e2b | 597 | { |
17b73dc6 | 598 | return strbuf_split_buf(str, strlen(str), terminator, max); |
2f1d9e2b | 599 | } |
06379a65 | 600 | |
2f1d9e2b | 601 | static inline struct strbuf **strbuf_split_max(const struct strbuf *sb, |
c7e5fe79 | 602 | int terminator, int max) |
2f1d9e2b | 603 | { |
17b73dc6 | 604 | return strbuf_split_buf(sb->buf, sb->len, terminator, max); |
2f1d9e2b | 605 | } |
06379a65 | 606 | |
17b73dc6 MH |
607 | static inline struct strbuf **strbuf_split(const struct strbuf *sb, |
608 | int terminator) | |
28fc3a68 | 609 | { |
17b73dc6 | 610 | return strbuf_split_max(sb, terminator, 0); |
28fc3a68 | 611 | } |
06379a65 | 612 | |
f6f77559 EN |
613 | /* |
614 | * Adds all strings of a string list to the strbuf, separated by the given | |
615 | * separator. For example, if sep is | |
616 | * ', ' | |
617 | * and slist contains | |
618 | * ['element1', 'element2', ..., 'elementN'], | |
619 | * then write: | |
620 | * 'element1, element2, ..., elementN' | |
621 | * to str. If only one element, just write "element1" to str. | |
622 | */ | |
c7e5fe79 SB |
623 | void strbuf_add_separated_string_list(struct strbuf *str, |
624 | const char *sep, | |
625 | struct string_list *slist); | |
f6f77559 | 626 | |
6afbbdda | 627 | /** |
06379a65 MH |
628 | * Free a NULL-terminated list of strbufs (for example, the return |
629 | * values of the strbuf_split*() functions). | |
630 | */ | |
c7e5fe79 | 631 | void strbuf_list_free(struct strbuf **list); |
f1696ee3 | 632 | |
af49c6d0 JK |
633 | /** |
634 | * Add the abbreviation, as generated by find_unique_abbrev, of `sha1` to | |
635 | * the strbuf `sb`. | |
636 | */ | |
155b517d JT |
637 | struct repository; |
638 | void strbuf_repo_add_unique_abbrev(struct strbuf *sb, struct repository *repo, | |
639 | const struct object_id *oid, int abbrev_len); | |
640 | void strbuf_add_unique_abbrev(struct strbuf *sb, const struct object_id *oid, | |
c7e5fe79 | 641 | int abbrev_len); |
af49c6d0 | 642 | |
bdfdaa49 JK |
643 | /** |
644 | * Launch the user preferred editor to edit a file and fill the buffer | |
645 | * with the file's contents upon the user completing their editing. The | |
646 | * third argument can be used to set the environment which the editor is | |
647 | * run in. If the buffer is NULL the editor is launched as usual but the | |
648 | * file's contents are not read into the buffer upon completion. | |
649 | */ | |
b49ef560 | 650 | int launch_editor(const char *path, struct strbuf *buffer, |
c7e5fe79 | 651 | const char *const *env); |
b449f4cf | 652 | |
b49ef560 JH |
653 | int launch_sequence_editor(const char *path, struct strbuf *buffer, |
654 | const char *const *env); | |
b449f4cf | 655 | |
b38dd9e7 JS |
656 | /* |
657 | * In contrast to `launch_editor()`, this function writes out the contents | |
658 | * of the specified file first, then clears the `buffer`, then launches | |
659 | * the editor and reads back in the file contents into the `buffer`. | |
660 | * Finally, it deletes the temporary file. | |
661 | * | |
662 | * If `path` is relative, it refers to a file in the `.git` directory. | |
663 | */ | |
664 | int strbuf_edit_interactively(struct strbuf *buffer, const char *path, | |
665 | const char *const *env); | |
666 | ||
c7e5fe79 SB |
667 | void strbuf_add_lines(struct strbuf *sb, |
668 | const char *prefix, | |
669 | const char *buf, | |
670 | size_t size); | |
895680f0 | 671 | |
6afbbdda | 672 | /** |
5963c036 MH |
673 | * Append s to sb, with the characters '<', '>', '&' and '"' converted |
674 | * into XML entities. | |
675 | */ | |
c7e5fe79 SB |
676 | void strbuf_addstr_xml_quoted(struct strbuf *sb, |
677 | const char *s); | |
5963c036 | 678 | |
399ad553 JK |
679 | /** |
680 | * "Complete" the contents of `sb` by ensuring that either it ends with the | |
681 | * character `term`, or it is empty. This can be used, for example, | |
682 | * to ensure that text ends with a newline, but without creating an empty | |
683 | * blank line if there is no content in the first place. | |
684 | */ | |
685 | static inline void strbuf_complete(struct strbuf *sb, char term) | |
686 | { | |
687 | if (sb->len && sb->buf[sb->len - 1] != term) | |
688 | strbuf_addch(sb, term); | |
689 | } | |
690 | ||
895680f0 JH |
691 | static inline void strbuf_complete_line(struct strbuf *sb) |
692 | { | |
399ad553 | 693 | strbuf_complete(sb, '\n'); |
895680f0 JH |
694 | } |
695 | ||
0705fe20 JK |
696 | /* |
697 | * Copy "name" to "sb", expanding any special @-marks as handled by | |
698 | * interpret_branch_name(). The result is a non-qualified branch name | |
699 | * (so "foo" or "origin/master" instead of "refs/heads/foo" or | |
700 | * "refs/remotes/origin/master"). | |
701 | * | |
702 | * Note that the resulting name may not be a syntactically valid refname. | |
0e9f62da JK |
703 | * |
704 | * If "allowed" is non-zero, restrict the set of allowed expansions. See | |
705 | * interpret_branch_name() for details. | |
0705fe20 | 706 | */ |
c7e5fe79 SB |
707 | void strbuf_branchname(struct strbuf *sb, const char *name, |
708 | unsigned allowed); | |
0705fe20 JK |
709 | |
710 | /* | |
711 | * Like strbuf_branchname() above, but confirm that the result is | |
712 | * syntactically valid to be used as a local branch name in refs/heads/. | |
713 | * | |
714 | * The return value is "0" if the result is valid, and "-1" otherwise. | |
715 | */ | |
c7e5fe79 | 716 | int strbuf_check_branch_ref(struct strbuf *sb, const char *name); |
a552de75 | 717 | |
c2694952 MD |
718 | typedef int (*char_predicate)(char ch); |
719 | ||
720 | int is_rfc3986_unreserved(char ch); | |
721 | int is_rfc3986_reserved_or_unreserved(char ch); | |
722 | ||
c7e5fe79 | 723 | void strbuf_addstr_urlencode(struct strbuf *sb, const char *name, |
c2694952 | 724 | char_predicate allow_unencoded_fn); |
679eebe2 | 725 | |
9a0a30aa | 726 | __attribute__((format (printf,1,2))) |
c7e5fe79 | 727 | int printf_ln(const char *fmt, ...); |
9a0a30aa | 728 | __attribute__((format (printf,2,3))) |
c7e5fe79 | 729 | int fprintf_ln(FILE *fp, const char *fmt, ...); |
9a0a30aa | 730 | |
88d5a6f6 | 731 | char *xstrdup_tolower(const char *); |
13ecb463 | 732 | char *xstrdup_toupper(const char *); |
88d5a6f6 | 733 | |
6afbbdda | 734 | /** |
30a0ddb7 JK |
735 | * Create a newly allocated string using printf format. You can do this easily |
736 | * with a strbuf, but this provides a shortcut to save a few lines. | |
737 | */ | |
738 | __attribute__((format (printf, 1, 0))) | |
739 | char *xstrvfmt(const char *fmt, va_list ap); | |
740 | __attribute__((format (printf, 1, 2))) | |
741 | char *xstrfmt(const char *fmt, ...); | |
742 | ||
d1df5743 | 743 | #endif /* STRBUF_H */ |