merge: use refresh_and_write_cache
[git/git.git] / strbuf.c
CommitLineData
812666c8 1#include "cache.h"
a2fab531 2#include "refs.h"
f6f77559 3#include "string-list.h"
d4241f52 4#include "utf8.h"
d1df5743 5
95662315
CC
6int starts_with(const char *str, const char *prefix)
7{
8 for (; ; str++, prefix++)
9 if (!*prefix)
10 return 1;
11 else if (*str != *prefix)
12 return 0;
13}
14
66b8af3e
LS
15int istarts_with(const char *str, const char *prefix)
16{
17 for (; ; str++, prefix++)
18 if (!*prefix)
19 return 1;
20 else if (tolower(*str) != tolower(*prefix))
21 return 0;
22}
23
afaef55e
CC
24int skip_to_optional_arg_default(const char *str, const char *prefix,
25 const char **arg, const char *def)
26{
27 const char *p;
28
29 if (!skip_prefix(str, prefix, &p))
30 return 0;
31
32 if (!*p) {
33 if (arg)
34 *arg = def;
35 return 1;
36 }
37
38 if (*p != '=')
39 return 0;
40
41 if (arg)
42 *arg = p + 1;
43 return 1;
44}
45
b315c5c0
PH
46/*
47 * Used as the default ->buf value, so that people can always assume
48 * buf is non NULL and ->buf is NUL terminated even for a freshly
49 * initialized strbuf.
50 */
51char strbuf_slopbuf[1];
52
917c9a71
PH
53void strbuf_init(struct strbuf *sb, size_t hint)
54{
b315c5c0
PH
55 sb->alloc = sb->len = 0;
56 sb->buf = strbuf_slopbuf;
8c74ef1e 57 if (hint)
f1696ee3 58 strbuf_grow(sb, hint);
d1df5743
JH
59}
60
917c9a71
PH
61void strbuf_release(struct strbuf *sb)
62{
b315c5c0
PH
63 if (sb->alloc) {
64 free(sb->buf);
65 strbuf_init(sb, 0);
66 }
b449f4cf
PH
67}
68
b315c5c0 69char *strbuf_detach(struct strbuf *sb, size_t *sz)
917c9a71 70{
08ad56f3
JK
71 char *res;
72 strbuf_grow(sb, 0);
73 res = sb->buf;
b315c5c0
PH
74 if (sz)
75 *sz = sb->len;
f1696ee3 76 strbuf_init(sb, 0);
b449f4cf
PH
77 return res;
78}
79
917c9a71
PH
80void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
81{
82 strbuf_release(sb);
83 sb->buf = buf;
84 sb->len = len;
85 sb->alloc = alloc;
86 strbuf_grow(sb, 0);
87 sb->buf[sb->len] = '\0';
88}
89
90void strbuf_grow(struct strbuf *sb, size_t extra)
91{
8c74ef1e 92 int new_buf = !sb->alloc;
1368f650
JN
93 if (unsigned_add_overflows(extra, 1) ||
94 unsigned_add_overflows(sb->len, extra + 1))
b449f4cf 95 die("you want to use way too much memory");
8c74ef1e 96 if (new_buf)
b315c5c0 97 sb->buf = NULL;
b449f4cf 98 ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
8c74ef1e
TR
99 if (new_buf)
100 sb->buf[0] = '\0';
b449f4cf
PH
101}
102
eacd6dc5
LS
103void strbuf_trim(struct strbuf *sb)
104{
3bb55e8a
BG
105 strbuf_rtrim(sb);
106 strbuf_ltrim(sb);
eacd6dc5 107}
c64a8d20 108
f1696ee3
PH
109void strbuf_rtrim(struct strbuf *sb)
110{
111 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
112 sb->len--;
113 sb->buf[sb->len] = '\0';
114}
115
c64a8d20
NTND
116void strbuf_trim_trailing_dir_sep(struct strbuf *sb)
117{
118 while (sb->len > 0 && is_dir_sep((unsigned char)sb->buf[sb->len - 1]))
119 sb->len--;
120 sb->buf[sb->len] = '\0';
121}
122
f9573628
PK
123void strbuf_trim_trailing_newline(struct strbuf *sb)
124{
125 if (sb->len > 0 && sb->buf[sb->len - 1] == '\n') {
126 if (--sb->len > 0 && sb->buf[sb->len - 1] == '\r')
127 --sb->len;
128 sb->buf[sb->len] = '\0';
129 }
130}
131
eacd6dc5
LS
132void strbuf_ltrim(struct strbuf *sb)
133{
134 char *b = sb->buf;
135 while (sb->len > 0 && isspace(*b)) {
136 b++;
137 sb->len--;
138 }
139 memmove(sb->buf, b, sb->len);
140 sb->buf[sb->len] = '\0';
141}
142
d4241f52
JK
143int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
144{
145 char *out;
c7d017d7 146 size_t len;
d4241f52
JK
147
148 if (same_encoding(from, to))
149 return 0;
150
151 out = reencode_string_len(sb->buf, sb->len, to, from, &len);
152 if (!out)
153 return -1;
154
155 strbuf_attach(sb, out, len, len);
156 return 0;
157}
158
ffb20ce1
JK
159void strbuf_tolower(struct strbuf *sb)
160{
161 char *p = sb->buf, *end = sb->buf + sb->len;
162 for (; p < end; p++)
163 *p = tolower(*p);
164}
165
17b73dc6
MH
166struct strbuf **strbuf_split_buf(const char *str, size_t slen,
167 int terminator, int max)
eacd6dc5 168{
b8c2c1fa
MH
169 struct strbuf **ret = NULL;
170 size_t nr = 0, alloc = 0;
eacd6dc5
LS
171 struct strbuf *t;
172
1173bb33
MH
173 while (slen) {
174 int len = slen;
175 if (max <= 0 || nr + 1 < max) {
17b73dc6 176 const char *end = memchr(str, terminator, slen);
1173bb33
MH
177 if (end)
178 len = end - str + 1;
179 }
eacd6dc5
LS
180 t = xmalloc(sizeof(struct strbuf));
181 strbuf_init(t, len);
1173bb33 182 strbuf_add(t, str, len);
b8c2c1fa
MH
183 ALLOC_GROW(ret, nr + 2, alloc);
184 ret[nr++] = t;
1173bb33
MH
185 str += len;
186 slen -= len;
eacd6dc5 187 }
b8c2c1fa
MH
188 ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
189 ret[nr] = NULL;
eacd6dc5
LS
190 return ret;
191}
192
f6f77559
EN
193void strbuf_add_separated_string_list(struct strbuf *str,
194 const char *sep,
195 struct string_list *slist)
196{
197 struct string_list_item *item;
198 int sep_needed = 0;
199
200 for_each_string_list_item(item, slist) {
201 if (sep_needed)
202 strbuf_addstr(str, sep);
203 strbuf_addstr(str, item->string);
204 sep_needed = 1;
205 }
206}
207
eacd6dc5
LS
208void strbuf_list_free(struct strbuf **sbs)
209{
210 struct strbuf **s = sbs;
211
212 while (*s) {
213 strbuf_release(*s);
214 free(*s++);
215 }
216 free(sbs);
217}
218
9b200fd6 219int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
45f66f64 220{
26114c00 221 size_t len = a->len < b->len ? a->len: b->len;
8f024655
AR
222 int cmp = memcmp(a->buf, b->buf, len);
223 if (cmp)
224 return cmp;
225 return a->len < b->len ? -1: a->len != b->len;
45f66f64
PH
226}
227
917c9a71
PH
228void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
229 const void *data, size_t dlen)
230{
1368f650 231 if (unsigned_add_overflows(pos, len))
917c9a71
PH
232 die("you want to use way too much memory");
233 if (pos > sb->len)
234 die("`pos' is too far after the end of the buffer");
235 if (pos + len > sb->len)
236 die("`pos + len' is too far after the end of the buffer");
237
238 if (dlen >= len)
239 strbuf_grow(sb, dlen - len);
240 memmove(sb->buf + pos + dlen,
241 sb->buf + pos + len,
242 sb->len - pos - len);
243 memcpy(sb->buf + pos, data, dlen);
244 strbuf_setlen(sb, sb->len + dlen - len);
245}
246
c76689df
PH
247void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
248{
249 strbuf_splice(sb, pos, 0, data, len);
250}
251
5ef264db
PSU
252void strbuf_vinsertf(struct strbuf *sb, size_t pos, const char *fmt, va_list ap)
253{
254 int len, len2;
255 char save;
256 va_list cp;
257
258 if (pos > sb->len)
259 die("`pos' is too far after the end of the buffer");
260 va_copy(cp, ap);
261 len = vsnprintf(sb->buf + sb->len, 0, fmt, cp);
262 va_end(cp);
263 if (len < 0)
264 BUG("your vsnprintf is broken (returned %d)", len);
265 if (!len)
266 return; /* nothing to do */
267 if (unsigned_add_overflows(sb->len, len))
268 die("you want to use way too much memory");
269 strbuf_grow(sb, len);
270 memmove(sb->buf + pos + len, sb->buf + pos, sb->len - pos);
271 /* vsnprintf() will append a NUL, overwriting one of our characters */
272 save = sb->buf[pos + len];
273 len2 = vsnprintf(sb->buf + pos, len + 1, fmt, ap);
274 sb->buf[pos + len] = save;
275 if (len2 != len)
276 BUG("your vsnprintf is broken (returns inconsistent lengths)");
277 strbuf_setlen(sb, sb->len + len);
278}
279
280void strbuf_insertf(struct strbuf *sb, size_t pos, const char *fmt, ...)
281{
282 va_list ap;
283 va_start(ap, fmt);
284 strbuf_vinsertf(sb, pos, fmt, ap);
285 va_end(ap);
286}
287
c76689df
PH
288void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
289{
a8342a41 290 strbuf_splice(sb, pos, len, "", 0);
c76689df
PH
291}
292
917c9a71
PH
293void strbuf_add(struct strbuf *sb, const void *data, size_t len)
294{
b449f4cf
PH
295 strbuf_grow(sb, len);
296 memcpy(sb->buf + sb->len, data, len);
297 strbuf_setlen(sb, sb->len + len);
298}
299
31471ba2
RS
300void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
301{
302 strbuf_grow(sb, sb2->len);
303 memcpy(sb->buf + sb->len, sb2->buf, sb2->len);
304 strbuf_setlen(sb, sb->len + sb2->len);
305}
306
e71c4a88
PSU
307const char *strbuf_join_argv(struct strbuf *buf,
308 int argc, const char **argv, char delim)
309{
310 if (!argc)
311 return buf->buf;
312
313 strbuf_addstr(buf, *argv);
314 while (--argc) {
315 strbuf_addch(buf, delim);
316 strbuf_addstr(buf, *(++argv));
317 }
318
319 return buf->buf;
320}
321
d07235a0
RS
322void strbuf_addchars(struct strbuf *sb, int c, size_t n)
323{
324 strbuf_grow(sb, n);
325 memset(sb->buf + sb->len, c, n);
326 strbuf_setlen(sb, sb->len + n);
327}
328
917c9a71
PH
329void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
330{
b449f4cf 331 va_list ap;
ebeb6090
JK
332 va_start(ap, fmt);
333 strbuf_vaddf(sb, fmt, ap);
334 va_end(ap);
335}
336
eff80a9f
JH
337static void add_lines(struct strbuf *out,
338 const char *prefix1,
339 const char *prefix2,
340 const char *buf, size_t size)
341{
342 while (size) {
343 const char *prefix;
344 const char *next = memchr(buf, '\n', size);
345 next = next ? (next + 1) : (buf + size);
346
d55aeb76
JH
347 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
348 ? prefix2 : prefix1);
eff80a9f
JH
349 strbuf_addstr(out, prefix);
350 strbuf_add(out, buf, next - buf);
351 size -= next - buf;
352 buf = next;
353 }
354 strbuf_complete_line(out);
355}
356
357void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
358{
359 static char prefix1[3];
360 static char prefix2[2];
361
362 if (prefix1[0] != comment_line_char) {
5096d490
JK
363 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
364 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
eff80a9f
JH
365 }
366 add_lines(out, prefix1, prefix2, buf, size);
367}
368
369void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
370{
371 va_list params;
372 struct strbuf buf = STRBUF_INIT;
373 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
374
375 va_start(params, fmt);
376 strbuf_vaddf(&buf, fmt, params);
377 va_end(params);
378
379 strbuf_add_commented_lines(sb, buf.buf, buf.len);
380 if (incomplete_line)
381 sb->buf[--sb->len] = '\0';
382
383 strbuf_release(&buf);
384}
385
ebeb6090
JK
386void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
387{
388 int len;
389 va_list cp;
b449f4cf 390
f141bd80
SP
391 if (!strbuf_avail(sb))
392 strbuf_grow(sb, 64);
ebeb6090
JK
393 va_copy(cp, ap);
394 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
395 va_end(cp);
f141bd80 396 if (len < 0)
033abf97 397 BUG("your vsnprintf is broken (returned %d)", len);
f1696ee3 398 if (len > strbuf_avail(sb)) {
b449f4cf 399 strbuf_grow(sb, len);
b449f4cf 400 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
ebeb6090 401 if (len > strbuf_avail(sb))
033abf97 402 BUG("your vsnprintf is broken (insatiable)");
b449f4cf
PH
403 }
404 strbuf_setlen(sb, sb->len + len);
d1df5743
JH
405}
406
c3a670de
MC
407void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
408 void *context)
cde75e59
RS
409{
410 for (;;) {
c3a670de
MC
411 const char *percent;
412 size_t consumed;
cde75e59
RS
413
414 percent = strchrnul(format, '%');
415 strbuf_add(sb, format, percent - format);
416 if (!*percent)
417 break;
418 format = percent + 1;
419
0a0416a3
JK
420 if (*format == '%') {
421 strbuf_addch(sb, '%');
422 format++;
423 continue;
424 }
425
c3a670de
MC
426 consumed = fn(sb, format, context);
427 if (consumed)
428 format += consumed;
429 else
cde75e59
RS
430 strbuf_addch(sb, '%');
431 }
432}
433
fd2015b3
AW
434size_t strbuf_expand_literal_cb(struct strbuf *sb,
435 const char *placeholder,
436 void *context)
437{
438 int ch;
439
440 switch (placeholder[0]) {
441 case 'n': /* newline */
442 strbuf_addch(sb, '\n');
443 return 1;
444 case 'x':
445 /* %x00 == NUL, %x0a == LF, etc. */
446 ch = hex2chr(placeholder + 1);
447 if (ch < 0)
448 return 0;
449 strbuf_addch(sb, ch);
450 return 3;
451 }
452 return 0;
453}
454
9b864e73
RS
455size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
456 void *context)
457{
458 struct strbuf_expand_dict_entry *e = context;
459 size_t len;
460
461 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
462 if (!strncmp(placeholder, e->placeholder, len)) {
463 if (e->value)
464 strbuf_addstr(sb, e->value);
465 return len;
466 }
467 }
468 return 0;
469}
470
361df5df
JK
471void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
472{
26114c00 473 size_t i, len = src->len;
361df5df
JK
474
475 for (i = 0; i < len; i++) {
476 if (src->buf[i] == '%')
477 strbuf_addch(dst, '%');
478 strbuf_addch(dst, src->buf[i]);
479 }
480}
481
917c9a71
PH
482size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
483{
b449f4cf 484 size_t res;
2fc64700 485 size_t oldalloc = sb->alloc;
b449f4cf
PH
486
487 strbuf_grow(sb, size);
488 res = fread(sb->buf + sb->len, 1, size, f);
2fc64700 489 if (res > 0)
b449f4cf 490 strbuf_setlen(sb, sb->len + res);
6651c3f7 491 else if (oldalloc == 0)
2fc64700 492 strbuf_release(sb);
b449f4cf 493 return res;
d1df5743
JH
494}
495
f1696ee3 496ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
b449f4cf
PH
497{
498 size_t oldlen = sb->len;
2fc64700 499 size_t oldalloc = sb->alloc;
b449f4cf 500
f1696ee3 501 strbuf_grow(sb, hint ? hint : 8192);
b449f4cf 502 for (;;) {
3ebbd00c
JH
503 ssize_t want = sb->alloc - sb->len - 1;
504 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
b449f4cf 505
3ebbd00c 506 if (got < 0) {
2fc64700
RS
507 if (oldalloc == 0)
508 strbuf_release(sb);
509 else
510 strbuf_setlen(sb, oldlen);
b449f4cf
PH
511 return -1;
512 }
3ebbd00c
JH
513 sb->len += got;
514 if (got < want)
b449f4cf 515 break;
f1696ee3 516 strbuf_grow(sb, 8192);
b449f4cf
PH
517 }
518
519 sb->buf[sb->len] = '\0';
520 return sb->len - oldlen;
d1df5743
JH
521}
522
b4e04fb6
SB
523ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint)
524{
c3ff8f6c 525 size_t oldalloc = sb->alloc;
b4e04fb6
SB
526 ssize_t cnt;
527
528 strbuf_grow(sb, hint ? hint : 8192);
529 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
530 if (cnt > 0)
531 strbuf_setlen(sb, sb->len + cnt);
c3ff8f6c
RS
532 else if (oldalloc == 0)
533 strbuf_release(sb);
b4e04fb6
SB
534 return cnt;
535}
536
2dac9b56
SB
537ssize_t strbuf_write(struct strbuf *sb, FILE *f)
538{
539 return sb->len ? fwrite(sb->buf, 1, sb->len, f) : 0;
540}
541
542
b11b7e13
LT
543#define STRBUF_MAXLINK (2*PATH_MAX)
544
545int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
546{
2fc64700
RS
547 size_t oldalloc = sb->alloc;
548
b11b7e13
LT
549 if (hint < 32)
550 hint = 32;
551
552 while (hint < STRBUF_MAXLINK) {
f3e76ed2 553 ssize_t len;
b11b7e13
LT
554
555 strbuf_grow(sb, hint);
556 len = readlink(path, sb->buf, hint);
557 if (len < 0) {
558 if (errno != ERANGE)
559 break;
560 } else if (len < hint) {
561 strbuf_setlen(sb, len);
562 return 0;
563 }
564
565 /* .. the buffer was too small - try again */
566 hint *= 2;
567 }
2fc64700
RS
568 if (oldalloc == 0)
569 strbuf_release(sb);
b11b7e13
LT
570 return -1;
571}
572
f22a76e9
RS
573int strbuf_getcwd(struct strbuf *sb)
574{
575 size_t oldalloc = sb->alloc;
576 size_t guessed_len = 128;
577
578 for (;; guessed_len *= 2) {
579 strbuf_grow(sb, guessed_len);
580 if (getcwd(sb->buf, sb->alloc)) {
581 strbuf_setlen(sb, strlen(sb->buf));
582 return 0;
583 }
a54e938e
RS
584
585 /*
586 * If getcwd(3) is implemented as a syscall that falls
587 * back to a regular lookup using readdir(3) etc. then
588 * we may be able to avoid EACCES by providing enough
589 * space to the syscall as it's not necessarily bound
590 * to the same restrictions as the fallback.
591 */
592 if (errno == EACCES && guessed_len < PATH_MAX)
593 continue;
594
f22a76e9
RS
595 if (errno != ERANGE)
596 break;
597 }
598 if (oldalloc == 0)
599 strbuf_release(sb);
600 else
601 strbuf_reset(sb);
602 return -1;
603}
604
0cc30e0e
JK
605#ifdef HAVE_GETDELIM
606int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
607{
608 ssize_t r;
609
610 if (feof(fp))
611 return EOF;
612
613 strbuf_reset(sb);
614
615 /* Translate slopbuf to NULL, as we cannot call realloc on it */
616 if (!sb->alloc)
617 sb->buf = NULL;
642956cf 618 errno = 0;
0cc30e0e
JK
619 r = getdelim(&sb->buf, &sb->alloc, term, fp);
620
621 if (r > 0) {
622 sb->len = r;
623 return 0;
624 }
625 assert(r == -1);
626
627 /*
628 * Normally we would have called xrealloc, which will try to free
629 * memory and recover. But we have no way to tell getdelim() to do so.
630 * Worse, we cannot try to recover ENOMEM ourselves, because we have
631 * no idea how many bytes were read by getdelim.
632 *
633 * Dying here is reasonable. It mirrors what xrealloc would do on
634 * catastrophic memory failure. We skip the opportunity to free pack
635 * memory and retry, but that's unlikely to help for a malloc small
636 * enough to hold a single line of input, anyway.
637 */
638 if (errno == ENOMEM)
639 die("Out of memory, getdelim failed");
640
b7090430
JK
641 /*
642 * Restore strbuf invariants; if getdelim left us with a NULL pointer,
643 * we can just re-init, but otherwise we should make sure that our
644 * length is empty, and that the result is NUL-terminated.
645 */
0cc30e0e
JK
646 if (!sb->buf)
647 strbuf_init(sb, 0);
b7090430
JK
648 else
649 strbuf_reset(sb);
0cc30e0e
JK
650 return EOF;
651}
652#else
c7e4f0d7 653int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
917c9a71 654{
d1df5743 655 int ch;
e6c019d0 656
e6c019d0
PH
657 if (feof(fp))
658 return EOF;
b449f4cf
PH
659
660 strbuf_reset(sb);
82912d1d
JK
661 flockfile(fp);
662 while ((ch = getc_unlocked(fp)) != EOF) {
f80c153b
JK
663 if (!strbuf_avail(sb))
664 strbuf_grow(sb, 1);
b449f4cf 665 sb->buf[sb->len++] = ch;
c7e4f0d7
BC
666 if (ch == term)
667 break;
d1df5743 668 }
82912d1d 669 funlockfile(fp);
e6c019d0
PH
670 if (ch == EOF && sb->len == 0)
671 return EOF;
b449f4cf 672
b449f4cf 673 sb->buf[sb->len] = '\0';
e6c019d0 674 return 0;
d1df5743 675}
0cc30e0e 676#endif
a9390b9f 677
1a0c8dfd 678static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
c7e4f0d7
BC
679{
680 if (strbuf_getwholeline(sb, fp, term))
681 return EOF;
dce80bd1
JH
682 if (sb->buf[sb->len - 1] == term)
683 strbuf_setlen(sb, sb->len - 1);
c7e4f0d7
BC
684 return 0;
685}
686
1a0c8dfd 687int strbuf_getline(struct strbuf *sb, FILE *fp)
c8aa9fdf
JH
688{
689 if (strbuf_getwholeline(sb, fp, '\n'))
690 return EOF;
691 if (sb->buf[sb->len - 1] == '\n') {
692 strbuf_setlen(sb, sb->len - 1);
693 if (sb->len && sb->buf[sb->len - 1] == '\r')
694 strbuf_setlen(sb, sb->len - 1);
695 }
696 return 0;
697}
698
8f309aeb
JH
699int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
700{
1a0c8dfd 701 return strbuf_getdelim(sb, fp, '\n');
8f309aeb
JH
702}
703
704int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
705{
1a0c8dfd 706 return strbuf_getdelim(sb, fp, '\0');
8f309aeb
JH
707}
708
5e8617f5
TR
709int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
710{
711 strbuf_reset(sb);
712
713 while (1) {
714 char ch;
715 ssize_t len = xread(fd, &ch, 1);
716 if (len <= 0)
717 return EOF;
718 strbuf_addch(sb, ch);
719 if (ch == term)
720 break;
721 }
722 return 0;
723}
724
6c8afe49 725ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
a9390b9f 726{
6c8afe49
MH
727 int fd;
728 ssize_t len;
79f0ba15 729 int saved_errno;
a9390b9f
KH
730
731 fd = open(path, O_RDONLY);
732 if (fd < 0)
733 return -1;
387e7e19 734 len = strbuf_read(sb, fd, hint);
79f0ba15 735 saved_errno = errno;
a9390b9f 736 close(fd);
79f0ba15
JK
737 if (len < 0) {
738 errno = saved_errno;
a9390b9f 739 return -1;
79f0ba15 740 }
a9390b9f
KH
741
742 return len;
743}
895680f0
JH
744
745void strbuf_add_lines(struct strbuf *out, const char *prefix,
746 const char *buf, size_t size)
747{
eff80a9f 748 add_lines(out, prefix, NULL, buf, size);
895680f0 749}
367d20ec 750
5963c036
MH
751void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
752{
753 while (*s) {
754 size_t len = strcspn(s, "\"<>&");
755 strbuf_add(buf, s, len);
756 s += len;
757 switch (*s) {
758 case '"':
759 strbuf_addstr(buf, "&quot;");
760 break;
761 case '<':
762 strbuf_addstr(buf, "&lt;");
763 break;
764 case '>':
765 strbuf_addstr(buf, "&gt;");
766 break;
767 case '&':
768 strbuf_addstr(buf, "&amp;");
769 break;
770 case 0:
771 return;
772 }
773 s++;
774 }
775}
776
c505116b
JK
777static int is_rfc3986_reserved(char ch)
778{
779 switch (ch) {
780 case '!': case '*': case '\'': case '(': case ')': case ';':
781 case ':': case '@': case '&': case '=': case '+': case '$':
782 case ',': case '/': case '?': case '#': case '[': case ']':
783 return 1;
784 }
785 return 0;
786}
787
788static int is_rfc3986_unreserved(char ch)
789{
790 return isalnum(ch) ||
791 ch == '-' || ch == '_' || ch == '.' || ch == '~';
792}
793
ea03a8e1
JH
794static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
795 int reserved)
c505116b
JK
796{
797 strbuf_grow(sb, len);
798 while (len--) {
799 char ch = *s++;
800 if (is_rfc3986_unreserved(ch) ||
801 (!reserved && is_rfc3986_reserved(ch)))
802 strbuf_addch(sb, ch);
803 else
4c267f2a 804 strbuf_addf(sb, "%%%02x", (unsigned char)ch);
c505116b
JK
805 }
806}
807
808void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
809 int reserved)
810{
811 strbuf_add_urlencode(sb, s, strlen(s), reserved);
812}
9a0a30aa 813
8f354a1f
DR
814static void strbuf_humanise(struct strbuf *buf, off_t bytes,
815 int humanise_rate)
079b546a
AP
816{
817 if (bytes > 1 << 30) {
8f354a1f
DR
818 strbuf_addf(buf,
819 humanise_rate == 0 ?
820 /* TRANSLATORS: IEC 80000-13:2008 gibibyte */
821 _("%u.%2.2u GiB") :
822 /* TRANSLATORS: IEC 80000-13:2008 gibibyte/second */
823 _("%u.%2.2u GiB/s"),
7726d360
JK
824 (unsigned)(bytes >> 30),
825 (unsigned)(bytes & ((1 << 30) - 1)) / 10737419);
079b546a 826 } else if (bytes > 1 << 20) {
7726d360 827 unsigned x = bytes + 5243; /* for rounding */
8f354a1f
DR
828 strbuf_addf(buf,
829 humanise_rate == 0 ?
830 /* TRANSLATORS: IEC 80000-13:2008 mebibyte */
831 _("%u.%2.2u MiB") :
832 /* TRANSLATORS: IEC 80000-13:2008 mebibyte/second */
833 _("%u.%2.2u MiB/s"),
079b546a
AP
834 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
835 } else if (bytes > 1 << 10) {
7726d360 836 unsigned x = bytes + 5; /* for rounding */
8f354a1f
DR
837 strbuf_addf(buf,
838 humanise_rate == 0 ?
839 /* TRANSLATORS: IEC 80000-13:2008 kibibyte */
840 _("%u.%2.2u KiB") :
841 /* TRANSLATORS: IEC 80000-13:2008 kibibyte/second */
842 _("%u.%2.2u KiB/s"),
079b546a
AP
843 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
844 } else {
8f354a1f
DR
845 strbuf_addf(buf,
846 humanise_rate == 0 ?
847 /* TRANSLATORS: IEC 80000-13:2008 byte */
848 Q_("%u byte", "%u bytes", (unsigned)bytes) :
849 /* TRANSLATORS: IEC 80000-13:2008 byte/second */
850 Q_("%u byte/s", "%u bytes/s", (unsigned)bytes),
851 (unsigned)bytes);
079b546a
AP
852 }
853}
854
8f354a1f
DR
855void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
856{
857 strbuf_humanise(buf, bytes, 0);
858}
859
860void strbuf_humanise_rate(struct strbuf *buf, off_t bytes)
861{
862 strbuf_humanise(buf, bytes, 1);
863}
864
679eebe2
RS
865void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
866{
867 if (!*path)
868 die("The empty string is not a valid path");
869 if (!is_absolute_path(path)) {
870 struct stat cwd_stat, pwd_stat;
871 size_t orig_len = sb->len;
872 char *cwd = xgetcwd();
873 char *pwd = getenv("PWD");
874 if (pwd && strcmp(pwd, cwd) &&
875 !stat(cwd, &cwd_stat) &&
876 (cwd_stat.st_dev || cwd_stat.st_ino) &&
877 !stat(pwd, &pwd_stat) &&
878 pwd_stat.st_dev == cwd_stat.st_dev &&
879 pwd_stat.st_ino == cwd_stat.st_ino)
880 strbuf_addstr(sb, pwd);
881 else
882 strbuf_addstr(sb, cwd);
883 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
884 strbuf_addch(sb, '/');
885 free(cwd);
886 }
887 strbuf_addstr(sb, path);
888}
889
33ad9ddd
RS
890void strbuf_add_real_path(struct strbuf *sb, const char *path)
891{
892 if (sb->len) {
893 struct strbuf resolved = STRBUF_INIT;
894 strbuf_realpath(&resolved, path, 1);
895 strbuf_addbuf(sb, &resolved);
896 strbuf_release(&resolved);
897 } else
898 strbuf_realpath(sb, path, 1);
899}
900
9a0a30aa
NTND
901int printf_ln(const char *fmt, ...)
902{
903 int ret;
904 va_list ap;
905 va_start(ap, fmt);
906 ret = vprintf(fmt, ap);
907 va_end(ap);
908 if (ret < 0 || putchar('\n') == EOF)
909 return -1;
910 return ret + 1;
911}
912
913int fprintf_ln(FILE *fp, const char *fmt, ...)
914{
915 int ret;
916 va_list ap;
917 va_start(ap, fmt);
918 ret = vfprintf(fp, fmt, ap);
919 va_end(ap);
920 if (ret < 0 || putc('\n', fp) == EOF)
921 return -1;
922 return ret + 1;
923}
88d5a6f6
JK
924
925char *xstrdup_tolower(const char *string)
926{
927 char *result;
928 size_t len, i;
929
930 len = strlen(string);
3733e694 931 result = xmallocz(len);
88d5a6f6
JK
932 for (i = 0; i < len; i++)
933 result[i] = tolower(string[i]);
88d5a6f6
JK
934 return result;
935}
30a0ddb7 936
13ecb463
LS
937char *xstrdup_toupper(const char *string)
938{
939 char *result;
940 size_t len, i;
941
942 len = strlen(string);
943 result = xmallocz(len);
944 for (i = 0; i < len; i++)
945 result[i] = toupper(string[i]);
88d5a6f6
JK
946 return result;
947}
30a0ddb7
JK
948
949char *xstrvfmt(const char *fmt, va_list ap)
950{
951 struct strbuf buf = STRBUF_INIT;
952 strbuf_vaddf(&buf, fmt, ap);
953 return strbuf_detach(&buf, NULL);
954}
955
956char *xstrfmt(const char *fmt, ...)
957{
958 va_list ap;
959 char *ret;
960
961 va_start(ap, fmt);
962 ret = xstrvfmt(fmt, ap);
963 va_end(ap);
964
965 return ret;
966}
aa1462cc 967
c3fbf81a 968void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm,
3b702239 969 int tz_offset, int suppress_tz_name)
aa1462cc 970{
c3fbf81a 971 struct strbuf munged_fmt = STRBUF_INIT;
e4f031e3 972 size_t hint = 128;
aa1462cc
JK
973 size_t len;
974
e4f031e3
JK
975 if (!*fmt)
976 return;
977
c3fbf81a
RS
978 /*
979 * There is no portable way to pass timezone information to
980 * strftime, so we handle %z and %Z here.
981 */
982 for (;;) {
983 const char *percent = strchrnul(fmt, '%');
984 strbuf_add(&munged_fmt, fmt, percent - fmt);
985 if (!*percent)
986 break;
987 fmt = percent + 1;
988 switch (*fmt) {
989 case '%':
990 strbuf_addstr(&munged_fmt, "%%");
991 fmt++;
992 break;
993 case 'z':
994 strbuf_addf(&munged_fmt, "%+05d", tz_offset);
995 fmt++;
996 break;
997 case 'Z':
3b702239 998 if (suppress_tz_name) {
c3fbf81a
RS
999 fmt++;
1000 break;
1001 }
1002 /* FALLTHROUGH */
1003 default:
1004 strbuf_addch(&munged_fmt, '%');
1005 }
1006 }
1007 fmt = munged_fmt.buf;
1008
e4f031e3 1009 strbuf_grow(sb, hint);
aa1462cc
JK
1010 len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
1011
1012 if (!len) {
1013 /*
e4f031e3
JK
1014 * strftime reports "0" if it could not fit the result in the buffer.
1015 * Unfortunately, it also reports "0" if the requested time string
1016 * takes 0 bytes. So our strategy is to munge the format so that the
1017 * output contains at least one character, and then drop the extra
1018 * character before returning.
aa1462cc 1019 */
c3fbf81a 1020 strbuf_addch(&munged_fmt, ' ');
e4f031e3
JK
1021 while (!len) {
1022 hint *= 2;
1023 strbuf_grow(sb, hint);
1024 len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
1025 munged_fmt.buf, tm);
1026 }
e4f031e3 1027 len--; /* drop munged space */
aa1462cc 1028 }
c3fbf81a 1029 strbuf_release(&munged_fmt);
e4f031e3 1030 strbuf_setlen(sb, sb->len + len);
aa1462cc 1031}
af49c6d0 1032
30e677e0 1033void strbuf_add_unique_abbrev(struct strbuf *sb, const struct object_id *oid,
af49c6d0
JK
1034 int abbrev_len)
1035{
1036 int r;
4b048c91 1037 strbuf_grow(sb, GIT_MAX_HEXSZ + 1);
aab9583f 1038 r = find_unique_abbrev_r(sb->buf + sb->len, oid, abbrev_len);
af49c6d0
JK
1039 strbuf_setlen(sb, sb->len + r);
1040}
1ad7c0f6 1041
63af4a84
TK
1042/*
1043 * Returns the length of a line, without trailing spaces.
1044 *
1045 * If the line ends with newline, it will be removed too.
1046 */
1047static size_t cleanup(char *line, size_t len)
1048{
1049 while (len) {
1050 unsigned char c = line[len - 1];
1051 if (!isspace(c))
1052 break;
1053 len--;
1054 }
1055
1056 return len;
1057}
1058
1059/*
1060 * Remove empty lines from the beginning and end
1061 * and also trailing spaces from every line.
1062 *
1063 * Turn multiple consecutive empty lines between paragraphs
1064 * into just one empty line.
1065 *
1066 * If the input has only empty lines and spaces,
1067 * no output will be produced.
1068 *
1069 * If last line does not have a newline at the end, one is added.
1070 *
1071 * Enable skip_comments to skip every line starting with comment
1072 * character.
1073 */
1074void strbuf_stripspace(struct strbuf *sb, int skip_comments)
1075{
26114c00 1076 size_t empties = 0;
63af4a84
TK
1077 size_t i, j, len, newlen;
1078 char *eol;
1079
1080 /* We may have to add a newline. */
1081 strbuf_grow(sb, 1);
1082
1083 for (i = j = 0; i < sb->len; i += len, j += newlen) {
1084 eol = memchr(sb->buf + i, '\n', sb->len - i);
1085 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
1086
1087 if (skip_comments && len && sb->buf[i] == comment_line_char) {
1088 newlen = 0;
1089 continue;
1090 }
1091 newlen = cleanup(sb->buf + i, len);
1092
1093 /* Not just an empty line? */
1094 if (newlen) {
1095 if (empties > 0 && j > 0)
1096 sb->buf[j++] = '\n';
1097 empties = 0;
1098 memmove(sb->buf + j, sb->buf + i, newlen);
1099 sb->buf[newlen + j++] = '\n';
1100 } else {
1101 empties++;
1102 }
1103 }
1104
1105 strbuf_setlen(sb, j);
1106}
670c359d
JK
1107
1108int strbuf_normalize_path(struct strbuf *src)
1109{
1110 struct strbuf dst = STRBUF_INIT;
1111
1112 strbuf_grow(&dst, src->len);
1113 if (normalize_path_copy(dst.buf, src->buf) < 0) {
1114 strbuf_release(&dst);
1115 return -1;
1116 }
1117
1118 /*
1119 * normalize_path does not tell us the new length, so we have to
1120 * compute it by looking for the new NUL it placed
1121 */
1122 strbuf_setlen(&dst, strlen(dst.buf));
1123 strbuf_swap(src, &dst);
1124 strbuf_release(&dst);
1125 return 0;
1126}