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