strbuf: introduce strbuf_getline_{lf,nul}()
[git/git.git] / strbuf.c
CommitLineData
812666c8 1#include "cache.h"
a2fab531 2#include "refs.h"
d4241f52 3#include "utf8.h"
d1df5743 4
95662315
CC
5int starts_with(const char *str, const char *prefix)
6{
7 for (; ; str++, prefix++)
8 if (!*prefix)
9 return 1;
10 else if (*str != *prefix)
11 return 0;
12}
13
b315c5c0
PH
14/*
15 * Used as the default ->buf value, so that people can always assume
16 * buf is non NULL and ->buf is NUL terminated even for a freshly
17 * initialized strbuf.
18 */
19char strbuf_slopbuf[1];
20
917c9a71
PH
21void strbuf_init(struct strbuf *sb, size_t hint)
22{
b315c5c0
PH
23 sb->alloc = sb->len = 0;
24 sb->buf = strbuf_slopbuf;
8c74ef1e 25 if (hint)
f1696ee3 26 strbuf_grow(sb, hint);
d1df5743
JH
27}
28
917c9a71
PH
29void strbuf_release(struct strbuf *sb)
30{
b315c5c0
PH
31 if (sb->alloc) {
32 free(sb->buf);
33 strbuf_init(sb, 0);
34 }
b449f4cf
PH
35}
36
b315c5c0 37char *strbuf_detach(struct strbuf *sb, size_t *sz)
917c9a71 38{
08ad56f3
JK
39 char *res;
40 strbuf_grow(sb, 0);
41 res = sb->buf;
b315c5c0
PH
42 if (sz)
43 *sz = sb->len;
f1696ee3 44 strbuf_init(sb, 0);
b449f4cf
PH
45 return res;
46}
47
917c9a71
PH
48void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
49{
50 strbuf_release(sb);
51 sb->buf = buf;
52 sb->len = len;
53 sb->alloc = alloc;
54 strbuf_grow(sb, 0);
55 sb->buf[sb->len] = '\0';
56}
57
58void strbuf_grow(struct strbuf *sb, size_t extra)
59{
8c74ef1e 60 int new_buf = !sb->alloc;
1368f650
JN
61 if (unsigned_add_overflows(extra, 1) ||
62 unsigned_add_overflows(sb->len, extra + 1))
b449f4cf 63 die("you want to use way too much memory");
8c74ef1e 64 if (new_buf)
b315c5c0 65 sb->buf = NULL;
b449f4cf 66 ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
8c74ef1e
TR
67 if (new_buf)
68 sb->buf[0] = '\0';
b449f4cf
PH
69}
70
eacd6dc5
LS
71void strbuf_trim(struct strbuf *sb)
72{
3bb55e8a
BG
73 strbuf_rtrim(sb);
74 strbuf_ltrim(sb);
eacd6dc5 75}
f1696ee3
PH
76void strbuf_rtrim(struct strbuf *sb)
77{
78 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
79 sb->len--;
80 sb->buf[sb->len] = '\0';
81}
82
eacd6dc5
LS
83void strbuf_ltrim(struct strbuf *sb)
84{
85 char *b = sb->buf;
86 while (sb->len > 0 && isspace(*b)) {
87 b++;
88 sb->len--;
89 }
90 memmove(sb->buf, b, sb->len);
91 sb->buf[sb->len] = '\0';
92}
93
d4241f52
JK
94int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
95{
96 char *out;
97 int len;
98
99 if (same_encoding(from, to))
100 return 0;
101
102 out = reencode_string_len(sb->buf, sb->len, to, from, &len);
103 if (!out)
104 return -1;
105
106 strbuf_attach(sb, out, len, len);
107 return 0;
108}
109
ffb20ce1
JK
110void strbuf_tolower(struct strbuf *sb)
111{
112 char *p = sb->buf, *end = sb->buf + sb->len;
113 for (; p < end; p++)
114 *p = tolower(*p);
115}
116
17b73dc6
MH
117struct strbuf **strbuf_split_buf(const char *str, size_t slen,
118 int terminator, int max)
eacd6dc5 119{
b8c2c1fa
MH
120 struct strbuf **ret = NULL;
121 size_t nr = 0, alloc = 0;
eacd6dc5
LS
122 struct strbuf *t;
123
1173bb33
MH
124 while (slen) {
125 int len = slen;
126 if (max <= 0 || nr + 1 < max) {
17b73dc6 127 const char *end = memchr(str, terminator, slen);
1173bb33
MH
128 if (end)
129 len = end - str + 1;
130 }
eacd6dc5
LS
131 t = xmalloc(sizeof(struct strbuf));
132 strbuf_init(t, len);
1173bb33 133 strbuf_add(t, str, len);
b8c2c1fa
MH
134 ALLOC_GROW(ret, nr + 2, alloc);
135 ret[nr++] = t;
1173bb33
MH
136 str += len;
137 slen -= len;
eacd6dc5 138 }
b8c2c1fa
MH
139 ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
140 ret[nr] = NULL;
eacd6dc5
LS
141 return ret;
142}
143
144void strbuf_list_free(struct strbuf **sbs)
145{
146 struct strbuf **s = sbs;
147
148 while (*s) {
149 strbuf_release(*s);
150 free(*s++);
151 }
152 free(sbs);
153}
154
9b200fd6 155int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
45f66f64 156{
8f024655
AR
157 int len = a->len < b->len ? a->len: b->len;
158 int cmp = memcmp(a->buf, b->buf, len);
159 if (cmp)
160 return cmp;
161 return a->len < b->len ? -1: a->len != b->len;
45f66f64
PH
162}
163
917c9a71
PH
164void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
165 const void *data, size_t dlen)
166{
1368f650 167 if (unsigned_add_overflows(pos, len))
917c9a71
PH
168 die("you want to use way too much memory");
169 if (pos > sb->len)
170 die("`pos' is too far after the end of the buffer");
171 if (pos + len > sb->len)
172 die("`pos + len' is too far after the end of the buffer");
173
174 if (dlen >= len)
175 strbuf_grow(sb, dlen - len);
176 memmove(sb->buf + pos + dlen,
177 sb->buf + pos + len,
178 sb->len - pos - len);
179 memcpy(sb->buf + pos, data, dlen);
180 strbuf_setlen(sb, sb->len + dlen - len);
181}
182
c76689df
PH
183void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
184{
185 strbuf_splice(sb, pos, 0, data, len);
186}
187
188void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
189{
190 strbuf_splice(sb, pos, len, NULL, 0);
191}
192
917c9a71
PH
193void strbuf_add(struct strbuf *sb, const void *data, size_t len)
194{
b449f4cf
PH
195 strbuf_grow(sb, len);
196 memcpy(sb->buf + sb->len, data, len);
197 strbuf_setlen(sb, sb->len + len);
198}
199
91db267e
RS
200void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len)
201{
202 strbuf_grow(sb, len);
203 memcpy(sb->buf + sb->len, sb->buf + pos, len);
204 strbuf_setlen(sb, sb->len + len);
205}
206
d07235a0
RS
207void strbuf_addchars(struct strbuf *sb, int c, size_t n)
208{
209 strbuf_grow(sb, n);
210 memset(sb->buf + sb->len, c, n);
211 strbuf_setlen(sb, sb->len + n);
212}
213
917c9a71
PH
214void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
215{
b449f4cf 216 va_list ap;
ebeb6090
JK
217 va_start(ap, fmt);
218 strbuf_vaddf(sb, fmt, ap);
219 va_end(ap);
220}
221
eff80a9f
JH
222static void add_lines(struct strbuf *out,
223 const char *prefix1,
224 const char *prefix2,
225 const char *buf, size_t size)
226{
227 while (size) {
228 const char *prefix;
229 const char *next = memchr(buf, '\n', size);
230 next = next ? (next + 1) : (buf + size);
231
d55aeb76
JH
232 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
233 ? prefix2 : prefix1);
eff80a9f
JH
234 strbuf_addstr(out, prefix);
235 strbuf_add(out, buf, next - buf);
236 size -= next - buf;
237 buf = next;
238 }
239 strbuf_complete_line(out);
240}
241
242void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
243{
244 static char prefix1[3];
245 static char prefix2[2];
246
247 if (prefix1[0] != comment_line_char) {
5096d490
JK
248 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
249 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
eff80a9f
JH
250 }
251 add_lines(out, prefix1, prefix2, buf, size);
252}
253
254void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
255{
256 va_list params;
257 struct strbuf buf = STRBUF_INIT;
258 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
259
260 va_start(params, fmt);
261 strbuf_vaddf(&buf, fmt, params);
262 va_end(params);
263
264 strbuf_add_commented_lines(sb, buf.buf, buf.len);
265 if (incomplete_line)
266 sb->buf[--sb->len] = '\0';
267
268 strbuf_release(&buf);
269}
270
ebeb6090
JK
271void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
272{
273 int len;
274 va_list cp;
b449f4cf 275
f141bd80
SP
276 if (!strbuf_avail(sb))
277 strbuf_grow(sb, 64);
ebeb6090
JK
278 va_copy(cp, ap);
279 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
280 va_end(cp);
f141bd80 281 if (len < 0)
ebeb6090 282 die("BUG: your vsnprintf is broken (returned %d)", len);
f1696ee3 283 if (len > strbuf_avail(sb)) {
b449f4cf 284 strbuf_grow(sb, len);
b449f4cf 285 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
ebeb6090
JK
286 if (len > strbuf_avail(sb))
287 die("BUG: your vsnprintf is broken (insatiable)");
b449f4cf
PH
288 }
289 strbuf_setlen(sb, sb->len + len);
d1df5743
JH
290}
291
c3a670de
MC
292void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
293 void *context)
cde75e59
RS
294{
295 for (;;) {
c3a670de
MC
296 const char *percent;
297 size_t consumed;
cde75e59
RS
298
299 percent = strchrnul(format, '%');
300 strbuf_add(sb, format, percent - format);
301 if (!*percent)
302 break;
303 format = percent + 1;
304
0a0416a3
JK
305 if (*format == '%') {
306 strbuf_addch(sb, '%');
307 format++;
308 continue;
309 }
310
c3a670de
MC
311 consumed = fn(sb, format, context);
312 if (consumed)
313 format += consumed;
314 else
cde75e59
RS
315 strbuf_addch(sb, '%');
316 }
317}
318
9b864e73
RS
319size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
320 void *context)
321{
322 struct strbuf_expand_dict_entry *e = context;
323 size_t len;
324
325 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
326 if (!strncmp(placeholder, e->placeholder, len)) {
327 if (e->value)
328 strbuf_addstr(sb, e->value);
329 return len;
330 }
331 }
332 return 0;
333}
334
361df5df
JK
335void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
336{
337 int i, len = src->len;
338
339 for (i = 0; i < len; i++) {
340 if (src->buf[i] == '%')
341 strbuf_addch(dst, '%');
342 strbuf_addch(dst, src->buf[i]);
343 }
344}
345
917c9a71
PH
346size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
347{
b449f4cf 348 size_t res;
2fc64700 349 size_t oldalloc = sb->alloc;
b449f4cf
PH
350
351 strbuf_grow(sb, size);
352 res = fread(sb->buf + sb->len, 1, size, f);
2fc64700 353 if (res > 0)
b449f4cf 354 strbuf_setlen(sb, sb->len + res);
6651c3f7 355 else if (oldalloc == 0)
2fc64700 356 strbuf_release(sb);
b449f4cf 357 return res;
d1df5743
JH
358}
359
f1696ee3 360ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
b449f4cf
PH
361{
362 size_t oldlen = sb->len;
2fc64700 363 size_t oldalloc = sb->alloc;
b449f4cf 364
f1696ee3 365 strbuf_grow(sb, hint ? hint : 8192);
b449f4cf 366 for (;;) {
3ebbd00c
JH
367 ssize_t want = sb->alloc - sb->len - 1;
368 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
b449f4cf 369
3ebbd00c 370 if (got < 0) {
2fc64700
RS
371 if (oldalloc == 0)
372 strbuf_release(sb);
373 else
374 strbuf_setlen(sb, oldlen);
b449f4cf
PH
375 return -1;
376 }
3ebbd00c
JH
377 sb->len += got;
378 if (got < want)
b449f4cf 379 break;
f1696ee3 380 strbuf_grow(sb, 8192);
b449f4cf
PH
381 }
382
383 sb->buf[sb->len] = '\0';
384 return sb->len - oldlen;
d1df5743
JH
385}
386
b11b7e13
LT
387#define STRBUF_MAXLINK (2*PATH_MAX)
388
389int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
390{
2fc64700
RS
391 size_t oldalloc = sb->alloc;
392
b11b7e13
LT
393 if (hint < 32)
394 hint = 32;
395
396 while (hint < STRBUF_MAXLINK) {
397 int len;
398
399 strbuf_grow(sb, hint);
400 len = readlink(path, sb->buf, hint);
401 if (len < 0) {
402 if (errno != ERANGE)
403 break;
404 } else if (len < hint) {
405 strbuf_setlen(sb, len);
406 return 0;
407 }
408
409 /* .. the buffer was too small - try again */
410 hint *= 2;
411 }
2fc64700
RS
412 if (oldalloc == 0)
413 strbuf_release(sb);
b11b7e13
LT
414 return -1;
415}
416
f22a76e9
RS
417int strbuf_getcwd(struct strbuf *sb)
418{
419 size_t oldalloc = sb->alloc;
420 size_t guessed_len = 128;
421
422 for (;; guessed_len *= 2) {
423 strbuf_grow(sb, guessed_len);
424 if (getcwd(sb->buf, sb->alloc)) {
425 strbuf_setlen(sb, strlen(sb->buf));
426 return 0;
427 }
428 if (errno != ERANGE)
429 break;
430 }
431 if (oldalloc == 0)
432 strbuf_release(sb);
433 else
434 strbuf_reset(sb);
435 return -1;
436}
437
0cc30e0e
JK
438#ifdef HAVE_GETDELIM
439int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
440{
441 ssize_t r;
442
443 if (feof(fp))
444 return EOF;
445
446 strbuf_reset(sb);
447
448 /* Translate slopbuf to NULL, as we cannot call realloc on it */
449 if (!sb->alloc)
450 sb->buf = NULL;
451 r = getdelim(&sb->buf, &sb->alloc, term, fp);
452
453 if (r > 0) {
454 sb->len = r;
455 return 0;
456 }
457 assert(r == -1);
458
459 /*
460 * Normally we would have called xrealloc, which will try to free
461 * memory and recover. But we have no way to tell getdelim() to do so.
462 * Worse, we cannot try to recover ENOMEM ourselves, because we have
463 * no idea how many bytes were read by getdelim.
464 *
465 * Dying here is reasonable. It mirrors what xrealloc would do on
466 * catastrophic memory failure. We skip the opportunity to free pack
467 * memory and retry, but that's unlikely to help for a malloc small
468 * enough to hold a single line of input, anyway.
469 */
470 if (errno == ENOMEM)
471 die("Out of memory, getdelim failed");
472
473 /* Restore slopbuf that we moved out of the way before */
474 if (!sb->buf)
475 strbuf_init(sb, 0);
476 return EOF;
477}
478#else
c7e4f0d7 479int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
917c9a71 480{
d1df5743 481 int ch;
e6c019d0 482
e6c019d0
PH
483 if (feof(fp))
484 return EOF;
b449f4cf
PH
485
486 strbuf_reset(sb);
82912d1d
JK
487 flockfile(fp);
488 while ((ch = getc_unlocked(fp)) != EOF) {
f80c153b
JK
489 if (!strbuf_avail(sb))
490 strbuf_grow(sb, 1);
b449f4cf 491 sb->buf[sb->len++] = ch;
c7e4f0d7
BC
492 if (ch == term)
493 break;
d1df5743 494 }
82912d1d 495 funlockfile(fp);
e6c019d0
PH
496 if (ch == EOF && sb->len == 0)
497 return EOF;
b449f4cf 498
b449f4cf 499 sb->buf[sb->len] = '\0';
e6c019d0 500 return 0;
d1df5743 501}
0cc30e0e 502#endif
a9390b9f 503
c7e4f0d7
BC
504int strbuf_getline(struct strbuf *sb, FILE *fp, int term)
505{
506 if (strbuf_getwholeline(sb, fp, term))
507 return EOF;
dce80bd1
JH
508 if (sb->buf[sb->len - 1] == term)
509 strbuf_setlen(sb, sb->len - 1);
c7e4f0d7
BC
510 return 0;
511}
512
c8aa9fdf
JH
513int strbuf_getline_crlf(struct strbuf *sb, FILE *fp)
514{
515 if (strbuf_getwholeline(sb, fp, '\n'))
516 return EOF;
517 if (sb->buf[sb->len - 1] == '\n') {
518 strbuf_setlen(sb, sb->len - 1);
519 if (sb->len && sb->buf[sb->len - 1] == '\r')
520 strbuf_setlen(sb, sb->len - 1);
521 }
522 return 0;
523}
524
8f309aeb
JH
525int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
526{
527 return strbuf_getline(sb, fp, '\n');
528}
529
530int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
531{
532 return strbuf_getline(sb, fp, '\0');
533}
534
5e8617f5
TR
535int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
536{
537 strbuf_reset(sb);
538
539 while (1) {
540 char ch;
541 ssize_t len = xread(fd, &ch, 1);
542 if (len <= 0)
543 return EOF;
544 strbuf_addch(sb, ch);
545 if (ch == term)
546 break;
547 }
548 return 0;
549}
550
6c8afe49 551ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
a9390b9f 552{
6c8afe49
MH
553 int fd;
554 ssize_t len;
a9390b9f
KH
555
556 fd = open(path, O_RDONLY);
557 if (fd < 0)
558 return -1;
387e7e19 559 len = strbuf_read(sb, fd, hint);
a9390b9f
KH
560 close(fd);
561 if (len < 0)
562 return -1;
563
564 return len;
565}
895680f0
JH
566
567void strbuf_add_lines(struct strbuf *out, const char *prefix,
568 const char *buf, size_t size)
569{
eff80a9f 570 add_lines(out, prefix, NULL, buf, size);
895680f0 571}
367d20ec 572
5963c036
MH
573void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
574{
575 while (*s) {
576 size_t len = strcspn(s, "\"<>&");
577 strbuf_add(buf, s, len);
578 s += len;
579 switch (*s) {
580 case '"':
581 strbuf_addstr(buf, "&quot;");
582 break;
583 case '<':
584 strbuf_addstr(buf, "&lt;");
585 break;
586 case '>':
587 strbuf_addstr(buf, "&gt;");
588 break;
589 case '&':
590 strbuf_addstr(buf, "&amp;");
591 break;
592 case 0:
593 return;
594 }
595 s++;
596 }
597}
598
c505116b
JK
599static int is_rfc3986_reserved(char ch)
600{
601 switch (ch) {
602 case '!': case '*': case '\'': case '(': case ')': case ';':
603 case ':': case '@': case '&': case '=': case '+': case '$':
604 case ',': case '/': case '?': case '#': case '[': case ']':
605 return 1;
606 }
607 return 0;
608}
609
610static int is_rfc3986_unreserved(char ch)
611{
612 return isalnum(ch) ||
613 ch == '-' || ch == '_' || ch == '.' || ch == '~';
614}
615
ea03a8e1
JH
616static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
617 int reserved)
c505116b
JK
618{
619 strbuf_grow(sb, len);
620 while (len--) {
621 char ch = *s++;
622 if (is_rfc3986_unreserved(ch) ||
623 (!reserved && is_rfc3986_reserved(ch)))
624 strbuf_addch(sb, ch);
625 else
626 strbuf_addf(sb, "%%%02x", ch);
627 }
628}
629
630void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
631 int reserved)
632{
633 strbuf_add_urlencode(sb, s, strlen(s), reserved);
634}
9a0a30aa 635
079b546a
AP
636void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
637{
638 if (bytes > 1 << 30) {
639 strbuf_addf(buf, "%u.%2.2u GiB",
640 (int)(bytes >> 30),
641 (int)(bytes & ((1 << 30) - 1)) / 10737419);
642 } else if (bytes > 1 << 20) {
643 int x = bytes + 5243; /* for rounding */
644 strbuf_addf(buf, "%u.%2.2u MiB",
645 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
646 } else if (bytes > 1 << 10) {
647 int x = bytes + 5; /* for rounding */
648 strbuf_addf(buf, "%u.%2.2u KiB",
649 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
650 } else {
651 strbuf_addf(buf, "%u bytes", (int)bytes);
652 }
653}
654
679eebe2
RS
655void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
656{
657 if (!*path)
658 die("The empty string is not a valid path");
659 if (!is_absolute_path(path)) {
660 struct stat cwd_stat, pwd_stat;
661 size_t orig_len = sb->len;
662 char *cwd = xgetcwd();
663 char *pwd = getenv("PWD");
664 if (pwd && strcmp(pwd, cwd) &&
665 !stat(cwd, &cwd_stat) &&
666 (cwd_stat.st_dev || cwd_stat.st_ino) &&
667 !stat(pwd, &pwd_stat) &&
668 pwd_stat.st_dev == cwd_stat.st_dev &&
669 pwd_stat.st_ino == cwd_stat.st_ino)
670 strbuf_addstr(sb, pwd);
671 else
672 strbuf_addstr(sb, cwd);
673 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
674 strbuf_addch(sb, '/');
675 free(cwd);
676 }
677 strbuf_addstr(sb, path);
678}
679
9a0a30aa
NTND
680int printf_ln(const char *fmt, ...)
681{
682 int ret;
683 va_list ap;
684 va_start(ap, fmt);
685 ret = vprintf(fmt, ap);
686 va_end(ap);
687 if (ret < 0 || putchar('\n') == EOF)
688 return -1;
689 return ret + 1;
690}
691
692int fprintf_ln(FILE *fp, const char *fmt, ...)
693{
694 int ret;
695 va_list ap;
696 va_start(ap, fmt);
697 ret = vfprintf(fp, fmt, ap);
698 va_end(ap);
699 if (ret < 0 || putc('\n', fp) == EOF)
700 return -1;
701 return ret + 1;
702}
88d5a6f6
JK
703
704char *xstrdup_tolower(const char *string)
705{
706 char *result;
707 size_t len, i;
708
709 len = strlen(string);
710 result = xmalloc(len + 1);
711 for (i = 0; i < len; i++)
712 result[i] = tolower(string[i]);
713 result[i] = '\0';
714 return result;
715}
30a0ddb7
JK
716
717char *xstrvfmt(const char *fmt, va_list ap)
718{
719 struct strbuf buf = STRBUF_INIT;
720 strbuf_vaddf(&buf, fmt, ap);
721 return strbuf_detach(&buf, NULL);
722}
723
724char *xstrfmt(const char *fmt, ...)
725{
726 va_list ap;
727 char *ret;
728
729 va_start(ap, fmt);
730 ret = xstrvfmt(fmt, ap);
731 va_end(ap);
732
733 return ret;
734}
aa1462cc
JK
735
736void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm)
737{
e4f031e3 738 size_t hint = 128;
aa1462cc
JK
739 size_t len;
740
e4f031e3
JK
741 if (!*fmt)
742 return;
743
744 strbuf_grow(sb, hint);
aa1462cc
JK
745 len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
746
747 if (!len) {
748 /*
e4f031e3
JK
749 * strftime reports "0" if it could not fit the result in the buffer.
750 * Unfortunately, it also reports "0" if the requested time string
751 * takes 0 bytes. So our strategy is to munge the format so that the
752 * output contains at least one character, and then drop the extra
753 * character before returning.
aa1462cc 754 */
e4f031e3
JK
755 struct strbuf munged_fmt = STRBUF_INIT;
756 strbuf_addf(&munged_fmt, "%s ", fmt);
757 while (!len) {
758 hint *= 2;
759 strbuf_grow(sb, hint);
760 len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
761 munged_fmt.buf, tm);
762 }
763 strbuf_release(&munged_fmt);
764 len--; /* drop munged space */
aa1462cc 765 }
e4f031e3 766 strbuf_setlen(sb, sb->len + len);
aa1462cc 767}
af49c6d0
JK
768
769void strbuf_add_unique_abbrev(struct strbuf *sb, const unsigned char *sha1,
770 int abbrev_len)
771{
772 int r;
773 strbuf_grow(sb, GIT_SHA1_HEXSZ + 1);
774 r = find_unique_abbrev_r(sb->buf + sb->len, sha1, abbrev_len);
775 strbuf_setlen(sb, sb->len + r);
776}
1ad7c0f6 777
63af4a84
TK
778/*
779 * Returns the length of a line, without trailing spaces.
780 *
781 * If the line ends with newline, it will be removed too.
782 */
783static size_t cleanup(char *line, size_t len)
784{
785 while (len) {
786 unsigned char c = line[len - 1];
787 if (!isspace(c))
788 break;
789 len--;
790 }
791
792 return len;
793}
794
795/*
796 * Remove empty lines from the beginning and end
797 * and also trailing spaces from every line.
798 *
799 * Turn multiple consecutive empty lines between paragraphs
800 * into just one empty line.
801 *
802 * If the input has only empty lines and spaces,
803 * no output will be produced.
804 *
805 * If last line does not have a newline at the end, one is added.
806 *
807 * Enable skip_comments to skip every line starting with comment
808 * character.
809 */
810void strbuf_stripspace(struct strbuf *sb, int skip_comments)
811{
812 int empties = 0;
813 size_t i, j, len, newlen;
814 char *eol;
815
816 /* We may have to add a newline. */
817 strbuf_grow(sb, 1);
818
819 for (i = j = 0; i < sb->len; i += len, j += newlen) {
820 eol = memchr(sb->buf + i, '\n', sb->len - i);
821 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
822
823 if (skip_comments && len && sb->buf[i] == comment_line_char) {
824 newlen = 0;
825 continue;
826 }
827 newlen = cleanup(sb->buf + i, len);
828
829 /* Not just an empty line? */
830 if (newlen) {
831 if (empties > 0 && j > 0)
832 sb->buf[j++] = '\n';
833 empties = 0;
834 memmove(sb->buf + j, sb->buf + i, newlen);
835 sb->buf[newlen + j++] = '\n';
836 } else {
837 empties++;
838 }
839 }
840
841 strbuf_setlen(sb, j);
842}