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