Merge branch 'ma/asciidoctor-more-fixes'
[git/git.git] / strbuf.h
CommitLineData
d1df5743
JH
1#ifndef STRBUF_H
2#define STRBUF_H
b449f4cf 3
f6f77559
EN
4struct 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 66struct strbuf {
b449f4cf
PH
67 size_t alloc;
68 size_t len;
bf0f910d 69 char *buf;
d1df5743
JH
70};
71
bdfdaa49 72extern char strbuf_slopbuf[];
cbc0f81d 73#define STRBUF_INIT { .alloc = 0, .len = 0, .buf = strbuf_slopbuf }
b449f4cf 74
30e677e0 75/*
76 * Predeclare this here, since cache.h includes this file before it defines the
77 * struct.
78 */
79struct 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 90void 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 100void 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 110char *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 120void 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
125static 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
139static 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 151void 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
160static inline void strbuf_setlen(struct strbuf *sb, size_t len)
161{
7141efab
RS
162 if (len > (sb->alloc ? sb->alloc - 1 : 0))
163 die("BUG: strbuf_setlen() beyond buffer");
c76689df 164 sb->len = len;
65961d5a
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
186void strbuf_trim(struct strbuf *sb);
187void strbuf_rtrim(struct strbuf *sb);
188void strbuf_ltrim(struct strbuf *sb);
bdfdaa49 189
c64a8d20 190/* Strip trailing directory separators */
c7e5fe79 191void strbuf_trim_trailing_dir_sep(struct strbuf *sb);
c64a8d20 192
f9573628 193/* Strip trailing LF or CR/LF */
39f73315 194void 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 200int 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 205void 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 212int 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 */
228static 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 239void 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 245void strbuf_insert(struct strbuf *sb, size_t pos, const void *, size_t);
bdfdaa49 246
5ef264db
PSU
247/**
248 * Insert data to the given position of the buffer giving a printf format
249 * string. The contents will be shifted, not overwritten.
250 */
251void strbuf_vinsertf(struct strbuf *sb, size_t pos, const char *fmt,
252 va_list ap);
253
254void strbuf_insertf(struct strbuf *sb, size_t pos, const char *fmt, ...);
255
bdfdaa49
JK
256/**
257 * Remove given amount of data from a given position of the buffer.
258 */
c7e5fe79 259void strbuf_remove(struct strbuf *sb, size_t pos, size_t len);
bdfdaa49
JK
260
261/**
262 * Remove the bytes between `pos..pos+len` and replace it with the given
263 * data.
264 */
c7e5fe79
SB
265void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
266 const void *data, size_t data_len);
bdfdaa49
JK
267
268/**
269 * Add a NUL-terminated string to the buffer. Each line will be prepended
270 * by a comment character and a blank.
271 */
c7e5fe79
SB
272void strbuf_add_commented_lines(struct strbuf *out,
273 const char *buf, size_t size);
bdfdaa49
JK
274
275
276/**
277 * Add data of given length to the buffer.
278 */
c7e5fe79 279void strbuf_add(struct strbuf *sb, const void *data, size_t len);
bdfdaa49
JK
280
281/**
282 * Add a NUL-terminated string to the buffer.
283 *
284 * NOTE: This function will *always* be implemented as an inline or a macro
285 * using strlen, meaning that this is efficient to write things like:
286 *
088c9a86 287 * strbuf_addstr(sb, "immediate string");
bdfdaa49
JK
288 *
289 */
290static inline void strbuf_addstr(struct strbuf *sb, const char *s)
291{
292 strbuf_add(sb, s, strlen(s));
293}
294
295/**
296 * Copy the contents of another buffer at the end of the current one.
297 */
c7e5fe79 298void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2);
bdfdaa49 299
e71c4a88
PSU
300/**
301 * Join the arguments into a buffer. `delim` is put between every
302 * two arguments.
303 */
304const char *strbuf_join_argv(struct strbuf *buf, int argc,
305 const char **argv, char delim);
306
bdfdaa49
JK
307/**
308 * This function can be used to expand a format string containing
309 * placeholders. To that end, it parses the string and calls the specified
310 * function for every percent sign found.
311 *
312 * The callback function is given a pointer to the character after the `%`
313 * and a pointer to the struct strbuf. It is expected to add the expanded
314 * version of the placeholder to the strbuf, e.g. to add a newline
315 * character if the letter `n` appears after a `%`. The function returns
316 * the length of the placeholder recognized and `strbuf_expand()` skips
317 * over it.
318 *
319 * The format `%%` is automatically expanded to a single `%` as a quoting
320 * mechanism; callers do not need to handle the `%` placeholder themselves,
321 * and the callback function will not be invoked for this placeholder.
322 *
323 * All other characters (non-percent and not skipped ones) are copied
324 * verbatim to the strbuf. If the callback returned zero, meaning that the
325 * placeholder is unknown, then the percent sign is copied, too.
326 *
327 * In order to facilitate caching and to make it possible to give
328 * parameters to the callback, `strbuf_expand()` passes a context pointer,
329 * which can be used by the programmer of the callback as she sees fit.
330 */
c7e5fe79
SB
331typedef size_t (*expand_fn_t) (struct strbuf *sb,
332 const char *placeholder,
333 void *context);
334void strbuf_expand(struct strbuf *sb,
335 const char *format,
336 expand_fn_t fn,
337 void *context);
bdfdaa49 338
fd2015b3
AW
339/**
340 * Used as callback for `strbuf_expand` to only expand literals
341 * (i.e. %n and %xNN). The context argument is ignored.
342 */
343size_t strbuf_expand_literal_cb(struct strbuf *sb,
344 const char *placeholder,
345 void *context);
346
bdfdaa49
JK
347/**
348 * Used as callback for `strbuf_expand()`, expects an array of
349 * struct strbuf_expand_dict_entry as context, i.e. pairs of
350 * placeholder and replacement string. The array needs to be
351 * terminated by an entry with placeholder set to NULL.
352 */
353struct strbuf_expand_dict_entry {
354 const char *placeholder;
355 const char *value;
356};
c7e5fe79
SB
357size_t strbuf_expand_dict_cb(struct strbuf *sb,
358 const char *placeholder,
359 void *context);
bdfdaa49
JK
360
361/**
362 * Append the contents of one strbuf to another, quoting any
363 * percent signs ("%") into double-percents ("%%") in the
364 * destination. This is useful for literal data to be fed to either
365 * strbuf_expand or to the *printf family of functions.
366 */
c7e5fe79 367void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
bdfdaa49
JK
368
369/**
370 * Append the given byte size as a human-readable string (i.e. 12.23 KiB,
371 * 3.50 MiB).
372 */
c7e5fe79 373void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
bdfdaa49 374
8f354a1f
DR
375/**
376 * Append the given byte rate as a human-readable string (i.e. 12.23 KiB/s,
377 * 3.50 MiB/s).
378 */
379void strbuf_humanise_rate(struct strbuf *buf, off_t bytes);
380
bdfdaa49
JK
381/**
382 * Add a formatted string to the buffer.
383 */
384__attribute__((format (printf,2,3)))
c7e5fe79 385void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
bdfdaa49
JK
386
387/**
388 * Add a formatted string prepended by a comment character and a
389 * blank to the buffer.
390 */
391__attribute__((format (printf, 2, 3)))
c7e5fe79 392void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
bdfdaa49
JK
393
394__attribute__((format (printf,2,0)))
c7e5fe79 395void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
bdfdaa49 396
aa1462cc
JK
397/**
398 * Add the time specified by `tm`, as formatted by `strftime`.
c3fbf81a
RS
399 * `tz_offset` is in decimal hhmm format, e.g. -600 means six hours west
400 * of Greenwich, and it's used to expand %z internally. However, tokens
401 * with modifiers (e.g. %Ez) are passed to `strftime`.
3b702239
ÆAB
402 * `suppress_tz_name`, when set, expands %Z internally to the empty
403 * string rather than passing it to `strftime`.
c3fbf81a 404 */
c7e5fe79
SB
405void strbuf_addftime(struct strbuf *sb, const char *fmt,
406 const struct tm *tm, int tz_offset,
407 int suppress_tz_name);
aa1462cc 408
bdfdaa49
JK
409/**
410 * Read a given size of data from a FILE* pointer to the buffer.
411 *
412 * NOTE: The buffer is rewound if the read fails. If -1 is returned,
413 * `errno` must be consulted, like you would do for `read(3)`.
1a0c8dfd
JH
414 * `strbuf_read()`, `strbuf_read_file()` and `strbuf_getline_*()`
415 * family of functions have the same behaviour as well.
bdfdaa49 416 */
c7e5fe79 417size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *file);
bdfdaa49
JK
418
419/**
420 * Read the contents of a given file descriptor. The third argument can be
421 * used to give a hint about the file size, to avoid reallocs. If read fails,
422 * any partial read is undone.
423 */
c7e5fe79 424ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint);
bdfdaa49 425
b4e04fb6
SB
426/**
427 * Read the contents of a given file descriptor partially by using only one
428 * attempt of xread. The third argument can be used to give a hint about the
429 * file size, to avoid reallocs. Returns the number of new bytes appended to
430 * the sb.
431 */
c7e5fe79 432ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint);
b4e04fb6 433
bdfdaa49
JK
434/**
435 * Read the contents of a file, specified by its path. The third argument
436 * can be used to give a hint about the file size, to avoid reallocs.
ed008d7b
PB
437 * Return the number of bytes read or a negative value if some error
438 * occurred while opening or reading the file.
bdfdaa49 439 */
c7e5fe79 440ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
bdfdaa49
JK
441
442/**
443 * Read the target of a symbolic link, specified by its path. The third
444 * argument can be used to give a hint about the size, to avoid reallocs.
445 */
c7e5fe79 446int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
bdfdaa49 447
2dac9b56
SB
448/**
449 * Write the whole content of the strbuf to the stream not stopping at
450 * NUL bytes.
451 */
c7e5fe79 452ssize_t strbuf_write(struct strbuf *sb, FILE *stream);
2dac9b56 453
bdfdaa49 454/**
1a0c8dfd
JH
455 * Read a line from a FILE *, overwriting the existing contents of
456 * the strbuf. The strbuf_getline*() family of functions share
457 * this signature, but have different line termination conventions.
458 *
bdfdaa49
JK
459 * Reading stops after the terminator or at EOF. The terminator
460 * is removed from the buffer before returning. Returns 0 unless
461 * there was nothing left before EOF, in which case it returns `EOF`.
462 */
8f309aeb
JH
463typedef int (*strbuf_getline_fn)(struct strbuf *, FILE *);
464
465/* Uses LF as the line terminator */
c7e5fe79 466int strbuf_getline_lf(struct strbuf *sb, FILE *fp);
8f309aeb
JH
467
468/* Uses NUL as the line terminator */
c7e5fe79 469int strbuf_getline_nul(struct strbuf *sb, FILE *fp);
8f309aeb 470
c8aa9fdf 471/*
8f309aeb
JH
472 * Similar to strbuf_getline_lf(), but additionally treats a CR that
473 * comes immediately before the LF as part of the terminator.
1a0c8dfd
JH
474 * This is the most friendly version to be used to read "text" files
475 * that can come from platforms whose native text format is CRLF
476 * terminated.
c8aa9fdf 477 */
c7e5fe79 478int strbuf_getline(struct strbuf *sb, FILE *file);
c8aa9fdf 479
bdfdaa49
JK
480
481/**
482 * Like `strbuf_getline`, but keeps the trailing terminator (if
483 * any) in the buffer.
484 */
c7e5fe79 485int strbuf_getwholeline(struct strbuf *sb, FILE *file, int term);
bdfdaa49
JK
486
487/**
488 * Like `strbuf_getwholeline`, but operates on a file descriptor.
489 * It reads one character at a time, so it is very slow. Do not
490 * use it unless you need the correct position in the file
491 * descriptor.
492 */
c7e5fe79 493int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term);
bdfdaa49
JK
494
495/**
496 * Set the buffer to the path of the current working directory.
497 */
c7e5fe79 498int strbuf_getcwd(struct strbuf *sb);
bdfdaa49
JK
499
500/**
501 * Add a path to a buffer, converting a relative path to an
502 * absolute one in the process. Symbolic links are not
503 * resolved.
504 */
c7e5fe79 505void strbuf_add_absolute_path(struct strbuf *sb, const char *path);
bdfdaa49 506
33ad9ddd
RS
507/**
508 * Canonize `path` (make it absolute, resolve symlinks, remove extra
509 * slashes) and append it to `sb`. Die with an informative error
510 * message if there is a problem.
511 *
512 * The directory part of `path` (i.e., everything up to the last
513 * dir_sep) must denote a valid, existing directory, but the last
514 * component need not exist.
515 *
516 * Callers that don't mind links should use the more lightweight
517 * strbuf_add_absolute_path() instead.
518 */
c7e5fe79 519void strbuf_add_real_path(struct strbuf *sb, const char *path);
33ad9ddd 520
670c359d
JK
521
522/**
523 * Normalize in-place the path contained in the strbuf. See
524 * normalize_path_copy() for details. If an error occurs, the contents of "sb"
525 * are left untouched, and -1 is returned.
526 */
c7e5fe79 527int strbuf_normalize_path(struct strbuf *sb);
670c359d 528
bdfdaa49
JK
529/**
530 * Strip whitespace from a buffer. The second parameter controls if
531 * comments are considered contents to be removed or not.
532 */
c7e5fe79 533void strbuf_stripspace(struct strbuf *buf, int skip_comments);
63af4a84 534
6dda4e60
JK
535static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
536{
537 if (strip_suffix_mem(sb->buf, &sb->len, suffix)) {
538 strbuf_setlen(sb, sb->len);
539 return 1;
540 } else
541 return 0;
542}
543
6afbbdda 544/**
06379a65
MH
545 * Split str (of length slen) at the specified terminator character.
546 * Return a null-terminated array of pointers to strbuf objects
547 * holding the substrings. The substrings include the terminator,
548 * except for the last substring, which might be unterminated if the
549 * original string did not end with a terminator. If max is positive,
550 * then split the string into at most max substrings (with the last
551 * substring containing everything following the (max-1)th terminator
552 * character).
553 *
f20e56e2
JK
554 * The most generic form is `strbuf_split_buf`, which takes an arbitrary
555 * pointer/len buffer. The `_str` variant takes a NUL-terminated string,
556 * the `_max` variant takes a strbuf, and just `strbuf_split` is a convenience
557 * wrapper to drop the `max` parameter.
558 *
06379a65
MH
559 * For lighter-weight alternatives, see string_list_split() and
560 * string_list_split_in_place().
561 */
c7e5fe79
SB
562struct strbuf **strbuf_split_buf(const char *str, size_t len,
563 int terminator, int max);
06379a65 564
2f1d9e2b 565static inline struct strbuf **strbuf_split_str(const char *str,
17b73dc6 566 int terminator, int max)
2f1d9e2b 567{
17b73dc6 568 return strbuf_split_buf(str, strlen(str), terminator, max);
2f1d9e2b 569}
06379a65 570
2f1d9e2b 571static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
c7e5fe79 572 int terminator, int max)
2f1d9e2b 573{
17b73dc6 574 return strbuf_split_buf(sb->buf, sb->len, terminator, max);
2f1d9e2b 575}
06379a65 576
17b73dc6
MH
577static inline struct strbuf **strbuf_split(const struct strbuf *sb,
578 int terminator)
28fc3a68 579{
17b73dc6 580 return strbuf_split_max(sb, terminator, 0);
28fc3a68 581}
06379a65 582
f6f77559
EN
583/*
584 * Adds all strings of a string list to the strbuf, separated by the given
585 * separator. For example, if sep is
586 * ', '
587 * and slist contains
588 * ['element1', 'element2', ..., 'elementN'],
589 * then write:
590 * 'element1, element2, ..., elementN'
591 * to str. If only one element, just write "element1" to str.
592 */
c7e5fe79
SB
593void strbuf_add_separated_string_list(struct strbuf *str,
594 const char *sep,
595 struct string_list *slist);
f6f77559 596
6afbbdda 597/**
06379a65
MH
598 * Free a NULL-terminated list of strbufs (for example, the return
599 * values of the strbuf_split*() functions).
600 */
c7e5fe79 601void strbuf_list_free(struct strbuf **list);
f1696ee3 602
af49c6d0
JK
603/**
604 * Add the abbreviation, as generated by find_unique_abbrev, of `sha1` to
605 * the strbuf `sb`.
606 */
c7e5fe79
SB
607void strbuf_add_unique_abbrev(struct strbuf *sb,
608 const struct object_id *oid,
609 int abbrev_len);
af49c6d0 610
bdfdaa49
JK
611/**
612 * Launch the user preferred editor to edit a file and fill the buffer
613 * with the file's contents upon the user completing their editing. The
614 * third argument can be used to set the environment which the editor is
615 * run in. If the buffer is NULL the editor is launched as usual but the
616 * file's contents are not read into the buffer upon completion.
617 */
b49ef560 618int launch_editor(const char *path, struct strbuf *buffer,
c7e5fe79 619 const char *const *env);
b449f4cf 620
b49ef560
JH
621int launch_sequence_editor(const char *path, struct strbuf *buffer,
622 const char *const *env);
b449f4cf 623
c7e5fe79
SB
624void strbuf_add_lines(struct strbuf *sb,
625 const char *prefix,
626 const char *buf,
627 size_t size);
895680f0 628
6afbbdda 629/**
5963c036
MH
630 * Append s to sb, with the characters '<', '>', '&' and '"' converted
631 * into XML entities.
632 */
c7e5fe79
SB
633void strbuf_addstr_xml_quoted(struct strbuf *sb,
634 const char *s);
5963c036 635
399ad553
JK
636/**
637 * "Complete" the contents of `sb` by ensuring that either it ends with the
638 * character `term`, or it is empty. This can be used, for example,
639 * to ensure that text ends with a newline, but without creating an empty
640 * blank line if there is no content in the first place.
641 */
642static inline void strbuf_complete(struct strbuf *sb, char term)
643{
644 if (sb->len && sb->buf[sb->len - 1] != term)
645 strbuf_addch(sb, term);
646}
647
895680f0
JH
648static inline void strbuf_complete_line(struct strbuf *sb)
649{
399ad553 650 strbuf_complete(sb, '\n');
895680f0
JH
651}
652
0705fe20
JK
653/*
654 * Copy "name" to "sb", expanding any special @-marks as handled by
655 * interpret_branch_name(). The result is a non-qualified branch name
656 * (so "foo" or "origin/master" instead of "refs/heads/foo" or
657 * "refs/remotes/origin/master").
658 *
659 * Note that the resulting name may not be a syntactically valid refname.
0e9f62da
JK
660 *
661 * If "allowed" is non-zero, restrict the set of allowed expansions. See
662 * interpret_branch_name() for details.
0705fe20 663 */
c7e5fe79
SB
664void strbuf_branchname(struct strbuf *sb, const char *name,
665 unsigned allowed);
0705fe20
JK
666
667/*
668 * Like strbuf_branchname() above, but confirm that the result is
669 * syntactically valid to be used as a local branch name in refs/heads/.
670 *
671 * The return value is "0" if the result is valid, and "-1" otherwise.
672 */
c7e5fe79 673int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
a552de75 674
c2694952
MD
675typedef int (*char_predicate)(char ch);
676
677int is_rfc3986_unreserved(char ch);
678int is_rfc3986_reserved_or_unreserved(char ch);
679
c7e5fe79 680void strbuf_addstr_urlencode(struct strbuf *sb, const char *name,
c2694952 681 char_predicate allow_unencoded_fn);
679eebe2 682
9a0a30aa 683__attribute__((format (printf,1,2)))
c7e5fe79 684int printf_ln(const char *fmt, ...);
9a0a30aa 685__attribute__((format (printf,2,3)))
c7e5fe79 686int fprintf_ln(FILE *fp, const char *fmt, ...);
9a0a30aa 687
88d5a6f6 688char *xstrdup_tolower(const char *);
13ecb463 689char *xstrdup_toupper(const char *);
88d5a6f6 690
6afbbdda 691/**
30a0ddb7
JK
692 * Create a newly allocated string using printf format. You can do this easily
693 * with a strbuf, but this provides a shortcut to save a few lines.
694 */
695__attribute__((format (printf, 1, 0)))
696char *xstrvfmt(const char *fmt, va_list ap);
697__attribute__((format (printf, 1, 2)))
698char *xstrfmt(const char *fmt, ...);
699
d1df5743 700#endif /* STRBUF_H */