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