🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.52.0-rc1 / . / strbuf.h
blob: a580ac6084b7f105614815c790ba23dd3a8ff49a [file] [log] [blame]
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]1#ifndef STRBUF_H
2#define STRBUF_H
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]3
Calvin Wan45577792023-06-06 19:48:37[diff] [blame]4/*
5 * NOTE FOR STRBUF DEVELOPERS
6 *
7 * strbuf is a low-level primitive; as such it should interact only
8 * with other low-level primitives. Do not introduce new functions
9 * which interact with higher-level APIs.
10 */
11
Elijah Newrenf6f77552018-04-19 17:58:08[diff] [blame]12struct string_list;
13
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]14/**
Štěpán Němec97509a32023-10-05 09:00:51[diff] [blame]15 * strbufs are meant to be used with all the usual C string and memory
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]16 * APIs. Given that the length of the buffer is known, it's often better to
Štěpán Němec97509a32023-10-05 09:00:51[diff] [blame]17 * use the mem* functions than a str* one (e.g., memchr vs. strchr).
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]18 * Though, one has to be careful about the fact that str* functions often
19 * stop on NULs and that strbufs may have embedded NULs.
20 *
21 * A strbuf is NUL terminated for convenience, but no function in the
22 * strbuf API actually relies on the string being free of NULs.
23 *
24 * strbufs have some invariants that are very important to keep in mind:
25 *
Jeff Kingaa07cac2015-01-16 09:05:10[diff] [blame]26 * - The `buf` member is never NULL, so it can be used in any usual C
Štěpán Němec97509a32023-10-05 09:00:51[diff] [blame]27 * string operations safely. strbufs _have_ to be initialized either by
Jeff Kingaa07cac2015-01-16 09:05:10[diff] [blame]28 * `strbuf_init()` or by `= STRBUF_INIT` before the invariants, though.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]29 *
Jeff Kingaa07cac2015-01-16 09:05:10[diff] [blame]30 * Do *not* assume anything on what `buf` really is (e.g. if it is
31 * allocated memory or not), use `strbuf_detach()` to unwrap a memory
32 * buffer from its strbuf shell in a safe way. That is the sole supported
33 * way. This will give you a malloced buffer that you can later `free()`.
34 *
35 * However, it is totally safe to modify anything in the string pointed by
36 * the `buf` member, between the indices `0` and `len-1` (inclusive).
37 *
38 * - The `buf` member is a byte array that has at least `len + 1` bytes
39 * allocated. The extra byte is used to store a `'\0'`, allowing the
Štěpán Němec97509a32023-10-05 09:00:51[diff] [blame]40 * `buf` member to be a valid C-string. All strbuf functions ensure this
Jeff Kingaa07cac2015-01-16 09:05:10[diff] [blame]41 * invariant is preserved.
42 *
43 * NOTE: It is OK to "play" with the buffer directly if you work it this
44 * way:
45 *
Jeff King088c9a82015-01-16 09:05:16[diff] [blame]46 * strbuf_grow(sb, SOME_SIZE); <1>
47 * strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
48 *
Jeff Kingaa07cac2015-01-16 09:05:10[diff] [blame]49 * <1> Here, the memory array starting at `sb->buf`, and of length
50 * `strbuf_avail(sb)` is all yours, and you can be sure that
51 * `strbuf_avail(sb)` is at least `SOME_SIZE`.
52 *
53 * NOTE: `SOME_OTHER_SIZE` must be smaller or equal to `strbuf_avail(sb)`.
54 *
55 * Doing so is safe, though if it has to be done in many places, adding the
56 * missing API to the strbuf module is the way to go.
57 *
58 * WARNING: Do _not_ assume that the area that is yours is of size `alloc
59 * - 1` even if it's true in the current implementation. Alloc is somehow a
60 * "private" member that should not be messed with. Use `strbuf_avail()`
61 * instead.
62*/
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]63
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]64/**
65 * Data Structures
66 * ---------------
67 */
68
69/**
70 * This is the string buffer structure. The `len` member can be used to
71 * determine the current length of the string, and `buf` member provides
72 * access to the string itself.
73 */
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]74struct strbuf {
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]75 size_t alloc;
76 size_t len;
Brian Gerstbf0f9102005-05-18 12:14:09[diff] [blame]77 char *buf;
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]78};
79
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]80extern char strbuf_slopbuf[];
Ævar Arnfjörð Bjarmason608cfd32021-09-27 12:54:26[diff] [blame]81#define STRBUF_INIT { .buf = strbuf_slopbuf }
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]82
brian m. carlson30e677e2018-03-12 02:27:28[diff] [blame]83struct object_id;
84
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]85/**
Jeff King14e21772015-01-16 09:05:28[diff] [blame]86 * Life Cycle Functions
87 * --------------------
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]88 */
89
90/**
91 * Initialize the structure. The second parameter can be zero or a bigger
92 * number to allocate memory, in case you want to prevent further reallocs.
93 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]94void strbuf_init(struct strbuf *sb, size_t alloc);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]95
96/**
Jonathan Niedere0222152017-10-04 02:39:54[diff] [blame]97 * Release a string buffer and the memory it used. After this call, the
98 * strbuf points to an empty string that does not need to be free()ed, as
99 * if it had been set to `STRBUF_INIT` and never modified.
100 *
101 * To clear a strbuf in preparation for further use without the overhead
102 * of free()ing and malloc()ing again, use strbuf_reset() instead.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]103 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]104void strbuf_release(struct strbuf *sb);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]105
106/**
107 * Detach the string from the strbuf and returns it; you now own the
108 * storage the string occupies and it is your responsibility from then on
109 * to release it with `free(3)` when you are done with it.
Jonathan Niedere0222152017-10-04 02:39:54[diff] [blame]110 *
111 * The strbuf that previously held the string is reset to `STRBUF_INIT` so
112 * it can be reused after calling this function.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]113 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]114char *strbuf_detach(struct strbuf *sb, size_t *sz);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]115
116/**
117 * Attach a string to a buffer. You should specify the string to attach,
118 * the current length of the string and the amount of allocated memory.
119 * The amount must be larger than the string length, because the string you
120 * pass is supposed to be a NUL-terminated string. This string _must_ be
121 * malloc()ed, and after attaching, the pointer cannot be relied upon
122 * anymore, and neither be free()d directly.
123 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]124void strbuf_attach(struct strbuf *sb, void *str, size_t len, size_t mem);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]125
126/**
127 * Swap the contents of two string buffers.
128 */
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]129static inline void strbuf_swap(struct strbuf *a, struct strbuf *b)
130{
René Scharfe35d803b2017-01-28 21:40:58[diff] [blame]131 SWAP(*a, *b);
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]132}
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]133
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]134
135/**
Jeff King14e21772015-01-16 09:05:28[diff] [blame]136 * Functions related to the size of the buffer
137 * -------------------------------------------
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]138 */
139
140/**
141 * Determine the amount of allocated but unused memory.
142 */
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]143static inline size_t strbuf_avail(const struct strbuf *sb)
144{
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]145 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]146}
Junio C Hamanoa8f3e222007-09-26 09:26:06[diff] [blame]147
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]148/**
149 * Ensure that at least this amount of unused memory is available after
150 * `len`. This is used when you know a typical size for what you will add
151 * and want to avoid repetitive automatic resizing of the underlying buffer.
152 * This is never a needed operation, but can be critical for performance in
153 * some cases.
154 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]155void strbuf_grow(struct strbuf *sb, size_t amount);
Junio C Hamanoa8f3e222007-09-26 09:26:06[diff] [blame]156
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]157/**
158 * Set the length of the buffer to a given value. This function does *not*
159 * allocate new memory, so you should not perform a `strbuf_setlen()` to a
160 * length that is larger than `len + strbuf_avail()`. `strbuf_setlen()` is
161 * just meant as a 'please fix invariants from this strbuf I just messed
162 * with'.
163 */
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]164static inline void strbuf_setlen(struct strbuf *sb, size_t len)
165{
René Scharfe7141efa2011-04-27 17:24:50[diff] [blame]166 if (len > (sb->alloc ? sb->alloc - 1 : 0))
Ævar Arnfjörð Bjarmason46d699f2021-12-07 11:05:52[diff] [blame]167 BUG("strbuf_setlen() beyond buffer");
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]168 sb->len = len;
Martin Ågren65961d52017-08-21 17:43:47[diff] [blame]169 if (sb->buf != strbuf_slopbuf)
170 sb->buf[len] = '\0';
171 else
172 assert(!strbuf_slopbuf[0]);
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]173}
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]174
175/**
176 * Empty the buffer by setting the size of it to zero.
177 */
Pierre Habouzitb315c5c2007-09-27 10:58:23[diff] [blame]178#define strbuf_reset(sb) strbuf_setlen(sb, 0)
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]179
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]180
181/**
Jeff King14e21772015-01-16 09:05:28[diff] [blame]182 * Functions related to the contents of the buffer
183 * -----------------------------------------------
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]184 */
185
186/**
Jeff Kingd468fa22015-01-16 09:06:04[diff] [blame]187 * Strip whitespace from the beginning (`ltrim`), end (`rtrim`), or both side
188 * (`trim`) of a string.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]189 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]190void strbuf_trim(struct strbuf *sb);
191void strbuf_rtrim(struct strbuf *sb);
192void strbuf_ltrim(struct strbuf *sb);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]193
Nguyễn Thái Ngọc Duyc64a8d22018-02-12 09:49:37[diff] [blame]194/* Strip trailing directory separators */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]195void strbuf_trim_trailing_dir_sep(struct strbuf *sb);
Nguyễn Thái Ngọc Duyc64a8d22018-02-12 09:49:37[diff] [blame]196
Pratik Karkif9573622018-08-08 15:06:16[diff] [blame]197/* Strip trailing LF or CR/LF */
Junio C Hamano39f73312018-11-02 02:04:54[diff] [blame]198void strbuf_trim_trailing_newline(struct strbuf *sb);
Pratik Karkif9573622018-08-08 15:06:16[diff] [blame]199
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]200/**
201 * Replace the contents of the strbuf with a reencoded form. Returns -1
202 * on error, 0 on success.
203 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]204int strbuf_reencode(struct strbuf *sb, const char *from, const char *to);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]205
206/**
207 * Lowercase each character in the buffer using `tolower`.
208 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]209void strbuf_tolower(struct strbuf *sb);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]210
211/**
212 * Compare two buffers. Returns an integer less than, equal to, or greater
213 * than zero if the first buffer is found, respectively, to be less than,
214 * to match, or be greater than the second buffer.
215 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]216int strbuf_cmp(const struct strbuf *first, const struct strbuf *second);
Lukas Sandströmeacd6dc2008-07-13 18:29:18[diff] [blame]217
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]218
219/**
Jeff King14e21772015-01-16 09:05:28[diff] [blame]220 * Adding data to the buffer
221 * -------------------------
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]222 *
223 * NOTE: All of the functions in this section will grow the buffer as
224 * necessary. If they fail for some reason other than memory shortage and the
225 * buffer hadn't been allocated before (i.e. the `struct strbuf` was set to
226 * `STRBUF_INIT`), then they will free() it.
227 */
228
229/**
230 * Add a single character to the buffer.
231 */
232static inline void strbuf_addch(struct strbuf *sb, int c)
233{
Jeff Kingfec501d2015-04-16 08:53:56[diff] [blame]234 if (!strbuf_avail(sb))
235 strbuf_grow(sb, 1);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]236 sb->buf[sb->len++] = c;
237 sb->buf[sb->len] = '\0';
238}
239
240/**
241 * Add a character the specified number of times to the buffer.
242 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]243void strbuf_addchars(struct strbuf *sb, int c, size_t n);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]244
245/**
246 * Insert data to the given position of the buffer. The remaining contents
247 * will be shifted, not overwritten.
248 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]249void strbuf_insert(struct strbuf *sb, size_t pos, const void *, size_t);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]250
251/**
René Scharfea91cc7f2020-02-09 13:44:23[diff] [blame]252 * Insert a NUL-terminated string to the given position of the buffer.
253 * The remaining contents will be shifted, not overwritten. It's an
254 * inline function to allow the compiler to resolve strlen() calls on
255 * constants at compile time.
256 */
257static inline void strbuf_insertstr(struct strbuf *sb, size_t pos,
258 const char *s)
259{
260 strbuf_insert(sb, pos, s, strlen(s));
261}
262
263/**
Paul-Sebastian Ungureanu5ef264d2019-02-25 23:16:07[diff] [blame]264 * Insert data to the given position of the buffer giving a printf format
265 * string. The contents will be shifted, not overwritten.
266 */
267void strbuf_vinsertf(struct strbuf *sb, size_t pos, const char *fmt,
268 va_list ap);
269
Ævar Arnfjörð Bjarmason75d31ce2021-07-13 08:05:19[diff] [blame]270__attribute__((format (printf, 3, 4)))
Paul-Sebastian Ungureanu5ef264d2019-02-25 23:16:07[diff] [blame]271void strbuf_insertf(struct strbuf *sb, size_t pos, const char *fmt, ...);
272
273/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]274 * Remove given amount of data from a given position of the buffer.
275 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]276void strbuf_remove(struct strbuf *sb, size_t pos, size_t len);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]277
278/**
279 * Remove the bytes between `pos..pos+len` and replace it with the given
280 * data.
281 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]282void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
283 const void *data, size_t data_len);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]284
285/**
286 * Add a NUL-terminated string to the buffer. Each line will be prepended
287 * by a comment character and a blank.
288 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]289void strbuf_add_commented_lines(struct strbuf *out,
Calvin Wan787cb8a2023-06-06 19:48:43[diff] [blame]290 const char *buf, size_t size,
Jeff Kinga1bb1462024-03-12 09:17:32[diff] [blame]291 const char *comment_prefix);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]292
293
294/**
295 * Add data of given length to the buffer.
296 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]297void strbuf_add(struct strbuf *sb, const void *data, size_t len);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]298
299/**
300 * Add a NUL-terminated string to the buffer.
301 *
302 * NOTE: This function will *always* be implemented as an inline or a macro
303 * using strlen, meaning that this is efficient to write things like:
304 *
Jeff King088c9a82015-01-16 09:05:16[diff] [blame]305 * strbuf_addstr(sb, "immediate string");
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]306 *
307 */
308static inline void strbuf_addstr(struct strbuf *sb, const char *s)
309{
310 strbuf_add(sb, s, strlen(s));
311}
312
313/**
Ghanshyam Thakkara70f8f12024-05-29 08:00:29[diff] [blame]314 * Add a NUL-terminated string the specified number of times to the buffer.
315 */
316void strbuf_addstrings(struct strbuf *sb, const char *s, size_t n);
317
318/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]319 * Copy the contents of another buffer at the end of the current one.
320 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]321void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]322
323/**
Paul-Sebastian Ungureanue71c4a82019-02-25 23:16:06[diff] [blame]324 * Join the arguments into a buffer. `delim` is put between every
325 * two arguments.
326 */
327const char *strbuf_join_argv(struct strbuf *buf, int argc,
328 const char **argv, char delim);
329
330/**
René Scharfe6f1e2d52023-06-17 20:43:17[diff] [blame]331 * Used with `strbuf_expand_step` to expand the literals %n and %x
332 * followed by two hexadecimal digits. Returns the number of recognized
René Scharfe4416b862023-06-17 20:44:00[diff] [blame]333 * characters.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]334 */
René Scharfe4416b862023-06-17 20:44:00[diff] [blame]335size_t strbuf_expand_literal(struct strbuf *sb, const char *placeholder);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]336
337/**
René Scharfe44ccb332023-06-17 20:41:44[diff] [blame]338 * If the string pointed to by `formatp` contains a percent sign ("%"),
339 * advance it to point to the character following the next one and
340 * return 1, otherwise return 0. Append the substring before that
341 * percent sign to `sb`, or the whole string if there is none.
Anders Waldenborgfd2015b2019-01-28 21:33:36[diff] [blame]342 */
René Scharfe44ccb332023-06-17 20:41:44[diff] [blame]343int strbuf_expand_step(struct strbuf *sb, const char **formatp);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]344
345/**
René Scharfee36091a2024-03-24 11:19:40[diff] [blame]346 * Used with `strbuf_expand_step` to report unknown placeholders.
347 */
348void strbuf_expand_bad_format(const char *format, const char *command);
349
350/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]351 * Append the contents of one strbuf to another, quoting any
352 * percent signs ("%") into double-percents ("%%") in the
353 * destination. This is useful for literal data to be fed to either
354 * strbuf_expand or to the *printf family of functions.
355 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]356void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]357
brian m. carlsonb44d0112020-04-27 01:18:08[diff] [blame]358#define STRBUF_ENCODE_SLASH 1
Johannes Schindelinc9039852024-11-07 07:57:52[diff] [blame]359#define STRBUF_ENCODE_HOST_AND_PORT 2
brian m. carlsonb44d0112020-04-27 01:18:08[diff] [blame]360
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]361/**
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]362 * Append the contents of a string to a strbuf, percent-encoding any characters
363 * that are needed to be encoded for a URL.
brian m. carlsonb44d0112020-04-27 01:18:08[diff] [blame]364 *
365 * If STRBUF_ENCODE_SLASH is set in flags, percent-encode slashes. Otherwise,
366 * slashes are not percent-encoded.
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]367 */
brian m. carlsonb44d0112020-04-27 01:18:08[diff] [blame]368void strbuf_add_percentencode(struct strbuf *dst, const char *src, int flags);
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]369
370/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]371 * Append the given byte size as a human-readable string (i.e. 12.23 KiB,
372 * 3.50 MiB).
373 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]374void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]375
376/**
Dimitriy Ryazantcev8f354a12019-07-02 18:22:48[diff] [blame]377 * Append the given byte rate as a human-readable string (i.e. 12.23 KiB/s,
378 * 3.50 MiB/s).
379 */
380void strbuf_humanise_rate(struct strbuf *buf, off_t bytes);
381
382/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]383 * Add a formatted string to the buffer.
384 */
385__attribute__((format (printf,2,3)))
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]386void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]387
388/**
389 * Add a formatted string prepended by a comment character and a
390 * blank to the buffer.
391 */
Calvin Wan787cb8a2023-06-06 19:48:43[diff] [blame]392__attribute__((format (printf, 3, 4)))
Jeff King3a35d962024-03-12 09:17:29[diff] [blame]393void strbuf_commented_addf(struct strbuf *sb, const char *comment_prefix, const char *fmt, ...);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]394
395__attribute__((format (printf,2,0)))
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]396void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]397
398/**
Jeff Kingaa1462c2015-06-25 16:55:45[diff] [blame]399 * Add the time specified by `tm`, as formatted by `strftime`.
René Scharfec3fbf812017-06-15 12:29:53[diff] [blame]400 * `tz_offset` is in decimal hhmm format, e.g. -600 means six hours west
401 * of Greenwich, and it's used to expand %z internally. However, tokens
402 * with modifiers (e.g. %Ez) are passed to `strftime`.
Ævar Arnfjörð Bjarmason3b702232017-07-01 13:15:47[diff] [blame]403 * `suppress_tz_name`, when set, expands %Z internally to the empty
404 * string rather than passing it to `strftime`.
Jeff Kingaa1462c2015-06-25 16:55:45[diff] [blame]405 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]406void strbuf_addftime(struct strbuf *sb, const char *fmt,
407 const struct tm *tm, int tz_offset,
408 int suppress_tz_name);
Jeff Kingaa1462c2015-06-25 16:55:45[diff] [blame]409
410/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]411 * Read a given size of data from a FILE* pointer to the buffer.
412 *
413 * NOTE: The buffer is rewound if the read fails. If -1 is returned,
414 * `errno` must be consulted, like you would do for `read(3)`.
Junio C Hamano1a0c8df2016-01-14 02:32:23[diff] [blame]415 * `strbuf_read()`, `strbuf_read_file()` and `strbuf_getline_*()`
416 * family of functions have the same behaviour as well.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]417 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]418size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *file);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]419
420/**
421 * Read the contents of a given file descriptor. The third argument can be
422 * used to give a hint about the file size, to avoid reallocs. If read fails,
423 * any partial read is undone.
424 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]425ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]426
427/**
Stefan Bellerb4e04fb2015-12-16 00:04:08[diff] [blame]428 * Read the contents of a given file descriptor partially by using only one
429 * attempt of xread. The third argument can be used to give a hint about the
430 * file size, to avoid reallocs. Returns the number of new bytes appended to
431 * the sb.
432 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]433ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint);
Stefan Bellerb4e04fb2015-12-16 00:04:08[diff] [blame]434
435/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]436 * Read the contents of a file, specified by its path. The third argument
437 * can be used to give a hint about the file size, to avoid reallocs.
Pranit Bauvaed008d72016-06-14 06:14:11[diff] [blame]438 * Return the number of bytes read or a negative value if some error
439 * occurred while opening or reading the file.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]440 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]441ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]442
443/**
444 * Read the target of a symbolic link, specified by its path. The third
445 * argument can be used to give a hint about the size, to avoid reallocs.
446 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]447int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]448
449/**
Stefan Beller2dac9b52016-03-01 02:07:15[diff] [blame]450 * Write the whole content of the strbuf to the stream not stopping at
451 * NUL bytes.
452 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]453ssize_t strbuf_write(struct strbuf *sb, FILE *stream);
Stefan Beller2dac9b52016-03-01 02:07:15[diff] [blame]454
455/**
Patrick Steinhardtaf35e562023-06-06 05:19:37[diff] [blame]456 * Read from a FILE * until the specified terminator is encountered,
457 * overwriting the existing contents of the strbuf.
458 *
459 * Reading stops after the terminator or at EOF. The terminator is
460 * removed from the buffer before returning. If the terminator is LF
461 * and if it is preceded by a CR, then the whole CRLF is stripped.
462 * Returns 0 unless there was nothing left before EOF, in which case
463 * it returns `EOF`.
464 */
465int strbuf_getdelim_strip_crlf(struct strbuf *sb, FILE *fp, int term);
466
467/**
Junio C Hamano1a0c8df2016-01-14 02:32:23[diff] [blame]468 * Read a line from a FILE *, overwriting the existing contents of
469 * the strbuf. The strbuf_getline*() family of functions share
470 * this signature, but have different line termination conventions.
471 *
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]472 * Reading stops after the terminator or at EOF. The terminator
473 * is removed from the buffer before returning. Returns 0 unless
474 * there was nothing left before EOF, in which case it returns `EOF`.
475 */
Junio C Hamano8f309ae2016-01-13 23:31:17[diff] [blame]476typedef int (*strbuf_getline_fn)(struct strbuf *, FILE *);
477
478/* Uses LF as the line terminator */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]479int strbuf_getline_lf(struct strbuf *sb, FILE *fp);
Junio C Hamano8f309ae2016-01-13 23:31:17[diff] [blame]480
481/* Uses NUL as the line terminator */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]482int strbuf_getline_nul(struct strbuf *sb, FILE *fp);
Junio C Hamano8f309ae2016-01-13 23:31:17[diff] [blame]483
Junio C Hamanoc8aa9fd2015-10-28 20:17:29[diff] [blame]484/*
Junio C Hamano8f309ae2016-01-13 23:31:17[diff] [blame]485 * Similar to strbuf_getline_lf(), but additionally treats a CR that
486 * comes immediately before the LF as part of the terminator.
Junio C Hamano1a0c8df2016-01-14 02:32:23[diff] [blame]487 * This is the most friendly version to be used to read "text" files
488 * that can come from platforms whose native text format is CRLF
489 * terminated.
Junio C Hamanoc8aa9fd2015-10-28 20:17:29[diff] [blame]490 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]491int strbuf_getline(struct strbuf *sb, FILE *file);
Junio C Hamanoc8aa9fd2015-10-28 20:17:29[diff] [blame]492
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]493
494/**
495 * Like `strbuf_getline`, but keeps the trailing terminator (if
496 * any) in the buffer.
497 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]498int strbuf_getwholeline(struct strbuf *sb, FILE *file, int term);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]499
500/**
Patrick Steinhardtbd021f32020-03-30 13:46:27[diff] [blame]501 * Like `strbuf_getwholeline`, but appends the line instead of
502 * resetting the buffer first.
503 */
504int strbuf_appendwholeline(struct strbuf *sb, FILE *file, int term);
505
506/**
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]507 * Like `strbuf_getwholeline`, but operates on a file descriptor.
508 * It reads one character at a time, so it is very slow. Do not
509 * use it unless you need the correct position in the file
510 * descriptor.
511 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]512int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]513
514/**
515 * Set the buffer to the path of the current working directory.
516 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]517int strbuf_getcwd(struct strbuf *sb);
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]518
519/**
Jeff King670c3592016-10-03 20:34:17[diff] [blame]520 * Normalize in-place the path contained in the strbuf. See
521 * normalize_path_copy() for details. If an error occurs, the contents of "sb"
522 * are left untouched, and -1 is returned.
523 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]524int strbuf_normalize_path(struct strbuf *sb);
Jeff King670c3592016-10-03 20:34:17[diff] [blame]525
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]526/**
Jeff King2982b652024-03-12 09:17:27[diff] [blame]527 * Strip whitespace from a buffer. If comment_prefix is non-NULL,
Calvin Wan787cb8a2023-06-06 19:48:43[diff] [blame]528 * then lines beginning with that character are considered comments,
529 * thus removed.
Jeff Kingbdfdaa42015-01-16 09:04:04[diff] [blame]530 */
Jeff King2982b652024-03-12 09:17:27[diff] [blame]531void strbuf_stripspace(struct strbuf *buf, const char *comment_prefix);
Tobias Klauser63af4a82015-10-16 15:16:42[diff] [blame]532
Jeff King6dda4e62014-06-30 17:01:51[diff] [blame]533static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
534{
535 if (strip_suffix_mem(sb->buf, &sb->len, suffix)) {
536 strbuf_setlen(sb, sb->len);
537 return 1;
538 } else
539 return 0;
540}
541
Stefan Beller6afbbdd2015-01-16 09:04:51[diff] [blame]542/**
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]543 * Split str (of length slen) at the specified terminator character.
544 * Return a null-terminated array of pointers to strbuf objects
545 * holding the substrings. The substrings include the terminator,
546 * except for the last substring, which might be unterminated if the
547 * original string did not end with a terminator. If max is positive,
548 * then split the string into at most max substrings (with the last
549 * substring containing everything following the (max-1)th terminator
550 * character).
551 *
Jeff Kingf20e56e2015-01-16 09:05:57[diff] [blame]552 * The most generic form is `strbuf_split_buf`, which takes an arbitrary
553 * pointer/len buffer. The `_str` variant takes a NUL-terminated string,
554 * the `_max` variant takes a strbuf, and just `strbuf_split` is a convenience
555 * wrapper to drop the `max` parameter.
556 *
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]557 * For lighter-weight alternatives, see string_list_split() and
558 * string_list_split_in_place().
559 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]560struct strbuf **strbuf_split_buf(const char *str, size_t len,
561 int terminator, int max);
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]562
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]563static inline struct strbuf **strbuf_split_str(const char *str,
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]564 int terminator, int max)
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]565{
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]566 return strbuf_split_buf(str, strlen(str), terminator, max);
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]567}
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]568
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]569static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]570 int terminator, int max)
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]571{
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]572 return strbuf_split_buf(sb->buf, sb->len, terminator, max);
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]573}
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]574
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]575static inline struct strbuf **strbuf_split(const struct strbuf *sb,
576 int terminator)
Jeff King28fc3a62011-06-09 15:51:22[diff] [blame]577{
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]578 return strbuf_split_max(sb, terminator, 0);
Jeff King28fc3a62011-06-09 15:51:22[diff] [blame]579}
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]580
Elijah Newrenf6f77552018-04-19 17:58:08[diff] [blame]581/*
582 * Adds all strings of a string list to the strbuf, separated by the given
583 * separator. For example, if sep is
584 * ', '
585 * and slist contains
586 * ['element1', 'element2', ..., 'elementN'],
587 * then write:
588 * 'element1, element2, ..., elementN'
589 * to str. If only one element, just write "element1" to str.
590 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]591void strbuf_add_separated_string_list(struct strbuf *str,
592 const char *sep,
593 struct string_list *slist);
Elijah Newrenf6f77552018-04-19 17:58:08[diff] [blame]594
Stefan Beller6afbbdd2015-01-16 09:04:51[diff] [blame]595/**
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]596 * Free a NULL-terminated list of strbufs (for example, the return
597 * values of the strbuf_split*() functions).
598 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]599void strbuf_list_free(struct strbuf **list);
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]600
Derrick Stolee9ea57962022-12-22 15:14:14[diff] [blame]601/*
602 * Remove the filename from the provided path string. If the path
603 * contains a trailing separator, then the path is considered a directory
604 * and nothing is modified.
605 *
606 * Examples:
607 * - "/path/to/file" -> "/path/to/"
608 * - "/path/to/dir/" -> "/path/to/dir/"
609 */
610void strbuf_strip_file_from_path(struct strbuf *sb);
611
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]612void strbuf_add_lines(struct strbuf *sb,
613 const char *prefix,
614 const char *buf,
615 size_t size);
Junio C Hamano895680f2011-11-05 04:06:30[diff] [blame]616
Stefan Beller6afbbdd2015-01-16 09:04:51[diff] [blame]617/**
Michael Haggerty5963c032012-11-25 11:08:34[diff] [blame]618 * Append s to sb, with the characters '<', '>', '&' and '"' converted
619 * into XML entities.
620 */
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]621void strbuf_addstr_xml_quoted(struct strbuf *sb,
622 const char *s);
Michael Haggerty5963c032012-11-25 11:08:34[diff] [blame]623
Jeff King399ad552015-09-24 21:05:43[diff] [blame]624/**
625 * "Complete" the contents of `sb` by ensuring that either it ends with the
626 * character `term`, or it is empty. This can be used, for example,
627 * to ensure that text ends with a newline, but without creating an empty
628 * blank line if there is no content in the first place.
629 */
630static inline void strbuf_complete(struct strbuf *sb, char term)
631{
632 if (sb->len && sb->buf[sb->len - 1] != term)
633 strbuf_addch(sb, term);
634}
635
Junio C Hamano895680f2011-11-05 04:06:30[diff] [blame]636static inline void strbuf_complete_line(struct strbuf *sb)
637{
Jeff King399ad552015-09-24 21:05:43[diff] [blame]638 strbuf_complete(sb, '\n');
Junio C Hamano895680f2011-11-05 04:06:30[diff] [blame]639}
640
Matthew DeVorec2694952019-06-27 22:54:11[diff] [blame]641typedef int (*char_predicate)(char ch);
642
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]643void strbuf_addstr_urlencode(struct strbuf *sb, const char *name,
Matthew DeVorec2694952019-06-27 22:54:11[diff] [blame]644 char_predicate allow_unencoded_fn);
René Scharfe679eebe2014-07-28 18:33:55[diff] [blame]645
Nguyễn Thái Ngọc Duy9a0a30a2012-04-23 12:30:22[diff] [blame]646__attribute__((format (printf,1,2)))
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]647int printf_ln(const char *fmt, ...);
Nguyễn Thái Ngọc Duy9a0a30a2012-04-23 12:30:22[diff] [blame]648__attribute__((format (printf,2,3)))
Stefan Bellerc7e5fe72018-09-28 17:30:33[diff] [blame]649int fprintf_ln(FILE *fp, const char *fmt, ...);
Nguyễn Thái Ngọc Duy9a0a30a2012-04-23 12:30:22[diff] [blame]650
Jeff King88d5a6f2014-05-22 09:44:09[diff] [blame]651char *xstrdup_tolower(const char *);
Lars Schneider13ecb4632018-02-15 15:27:06[diff] [blame]652char *xstrdup_toupper(const char *);
Jeff King88d5a6f2014-05-22 09:44:09[diff] [blame]653
Stefan Beller6afbbdd2015-01-16 09:04:51[diff] [blame]654/**
Jeff King30a0ddb2014-06-18 20:01:34[diff] [blame]655 * Create a newly allocated string using printf format. You can do this easily
656 * with a strbuf, but this provides a shortcut to save a few lines.
657 */
658__attribute__((format (printf, 1, 0)))
659char *xstrvfmt(const char *fmt, va_list ap);
660__attribute__((format (printf, 1, 2)))
661char *xstrfmt(const char *fmt, ...);
662
Phillip Woodf006e032025-07-16 09:38:30[diff] [blame]663bool starts_with(const char *str, const char *prefix);
664bool istarts_with(const char *str, const char *prefix);
665bool starts_with_mem(const char *str, size_t len, const char *prefix);
Calvin Wanfda5d952023-07-05 17:09:19[diff] [blame]666
667/*
668 * If the string "str" is the same as the string in "prefix", then the "arg"
669 * parameter is set to the "def" parameter and 1 is returned.
670 * If the string "str" begins with the string found in "prefix" and then a
671 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
672 * (i.e., to the point in the string right after the prefix and the "=" sign),
673 * and 1 is returned.
674 *
675 * Otherwise, return 0 and leave "arg" untouched.
676 *
677 * When we accept both a "--key" and a "--key=<val>" option, this function
678 * can be used instead of !strcmp(arg, "--key") and then
679 * skip_prefix(arg, "--key=", &arg) to parse such an option.
680 */
Phillip Woodf006e032025-07-16 09:38:30[diff] [blame]681bool skip_to_optional_arg_default(const char *str, const char *prefix,
Calvin Wanfda5d952023-07-05 17:09:19[diff] [blame]682 const char **arg, const char *def);
683
Phillip Woodf006e032025-07-16 09:38:30[diff] [blame]684static inline bool skip_to_optional_arg(const char *str, const char *prefix,
Calvin Wanfda5d952023-07-05 17:09:19[diff] [blame]685 const char **arg)
686{
687 return skip_to_optional_arg_default(str, prefix, arg, "");
688}
689
Phillip Woodf006e032025-07-16 09:38:30[diff] [blame]690static inline bool ends_with(const char *str, const char *suffix)
Calvin Wanfda5d952023-07-05 17:09:19[diff] [blame]691{
692 size_t len;
693 return strip_suffix(str, suffix, &len);
694}
695
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]696#endif /* STRBUF_H */