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