THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

701 lines
23KB

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