pretty: add support for "valueonly" option in %(trailers)
[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
252void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
253{
a8342a41 254 strbuf_splice(sb, pos, len, "", 0);
c76689df
PH
255}
256
917c9a71
PH
257void strbuf_add(struct strbuf *sb, const void *data, size_t len)
258{
b449f4cf
PH
259 strbuf_grow(sb, len);
260 memcpy(sb->buf + sb->len, data, len);
261 strbuf_setlen(sb, sb->len + len);
262}
263
31471ba2
RS
264void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
265{
266 strbuf_grow(sb, sb2->len);
267 memcpy(sb->buf + sb->len, sb2->buf, sb2->len);
268 strbuf_setlen(sb, sb->len + sb2->len);
269}
270
d07235a0
RS
271void strbuf_addchars(struct strbuf *sb, int c, size_t n)
272{
273 strbuf_grow(sb, n);
274 memset(sb->buf + sb->len, c, n);
275 strbuf_setlen(sb, sb->len + n);
276}
277
917c9a71
PH
278void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
279{
b449f4cf 280 va_list ap;
ebeb6090
JK
281 va_start(ap, fmt);
282 strbuf_vaddf(sb, fmt, ap);
283 va_end(ap);
284}
285
eff80a9f
JH
286static void add_lines(struct strbuf *out,
287 const char *prefix1,
288 const char *prefix2,
289 const char *buf, size_t size)
290{
291 while (size) {
292 const char *prefix;
293 const char *next = memchr(buf, '\n', size);
294 next = next ? (next + 1) : (buf + size);
295
d55aeb76
JH
296 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
297 ? prefix2 : prefix1);
eff80a9f
JH
298 strbuf_addstr(out, prefix);
299 strbuf_add(out, buf, next - buf);
300 size -= next - buf;
301 buf = next;
302 }
303 strbuf_complete_line(out);
304}
305
306void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
307{
308 static char prefix1[3];
309 static char prefix2[2];
310
311 if (prefix1[0] != comment_line_char) {
5096d490
JK
312 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
313 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
eff80a9f
JH
314 }
315 add_lines(out, prefix1, prefix2, buf, size);
316}
317
318void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
319{
320 va_list params;
321 struct strbuf buf = STRBUF_INIT;
322 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
323
324 va_start(params, fmt);
325 strbuf_vaddf(&buf, fmt, params);
326 va_end(params);
327
328 strbuf_add_commented_lines(sb, buf.buf, buf.len);
329 if (incomplete_line)
330 sb->buf[--sb->len] = '\0';
331
332 strbuf_release(&buf);
333}
334
ebeb6090
JK
335void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
336{
337 int len;
338 va_list cp;
b449f4cf 339
f141bd80
SP
340 if (!strbuf_avail(sb))
341 strbuf_grow(sb, 64);
ebeb6090
JK
342 va_copy(cp, ap);
343 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
344 va_end(cp);
f141bd80 345 if (len < 0)
033abf97 346 BUG("your vsnprintf is broken (returned %d)", len);
f1696ee3 347 if (len > strbuf_avail(sb)) {
b449f4cf 348 strbuf_grow(sb, len);
b449f4cf 349 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
ebeb6090 350 if (len > strbuf_avail(sb))
033abf97 351 BUG("your vsnprintf is broken (insatiable)");
b449f4cf
PH
352 }
353 strbuf_setlen(sb, sb->len + len);
d1df5743
JH
354}
355
c3a670de
MC
356void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
357 void *context)
cde75e59
RS
358{
359 for (;;) {
c3a670de
MC
360 const char *percent;
361 size_t consumed;
cde75e59
RS
362
363 percent = strchrnul(format, '%');
364 strbuf_add(sb, format, percent - format);
365 if (!*percent)
366 break;
367 format = percent + 1;
368
0a0416a3
JK
369 if (*format == '%') {
370 strbuf_addch(sb, '%');
371 format++;
372 continue;
373 }
374
c3a670de
MC
375 consumed = fn(sb, format, context);
376 if (consumed)
377 format += consumed;
378 else
cde75e59
RS
379 strbuf_addch(sb, '%');
380 }
381}
382
9b864e73
RS
383size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
384 void *context)
385{
386 struct strbuf_expand_dict_entry *e = context;
387 size_t len;
388
389 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
390 if (!strncmp(placeholder, e->placeholder, len)) {
391 if (e->value)
392 strbuf_addstr(sb, e->value);
393 return len;
394 }
395 }
396 return 0;
397}
398
361df5df
JK
399void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
400{
26114c00 401 size_t i, len = src->len;
361df5df
JK
402
403 for (i = 0; i < len; i++) {
404 if (src->buf[i] == '%')
405 strbuf_addch(dst, '%');
406 strbuf_addch(dst, src->buf[i]);
407 }
408}
409
917c9a71
PH
410size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
411{
b449f4cf 412 size_t res;
2fc64700 413 size_t oldalloc = sb->alloc;
b449f4cf
PH
414
415 strbuf_grow(sb, size);
416 res = fread(sb->buf + sb->len, 1, size, f);
2fc64700 417 if (res > 0)
b449f4cf 418 strbuf_setlen(sb, sb->len + res);
6651c3f7 419 else if (oldalloc == 0)
2fc64700 420 strbuf_release(sb);
b449f4cf 421 return res;
d1df5743
JH
422}
423
f1696ee3 424ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
b449f4cf
PH
425{
426 size_t oldlen = sb->len;
2fc64700 427 size_t oldalloc = sb->alloc;
b449f4cf 428
f1696ee3 429 strbuf_grow(sb, hint ? hint : 8192);
b449f4cf 430 for (;;) {
3ebbd00c
JH
431 ssize_t want = sb->alloc - sb->len - 1;
432 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
b449f4cf 433
3ebbd00c 434 if (got < 0) {
2fc64700
RS
435 if (oldalloc == 0)
436 strbuf_release(sb);
437 else
438 strbuf_setlen(sb, oldlen);
b449f4cf
PH
439 return -1;
440 }
3ebbd00c
JH
441 sb->len += got;
442 if (got < want)
b449f4cf 443 break;
f1696ee3 444 strbuf_grow(sb, 8192);
b449f4cf
PH
445 }
446
447 sb->buf[sb->len] = '\0';
448 return sb->len - oldlen;
d1df5743
JH
449}
450
b4e04fb6
SB
451ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint)
452{
c3ff8f6c 453 size_t oldalloc = sb->alloc;
b4e04fb6
SB
454 ssize_t cnt;
455
456 strbuf_grow(sb, hint ? hint : 8192);
457 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
458 if (cnt > 0)
459 strbuf_setlen(sb, sb->len + cnt);
c3ff8f6c
RS
460 else if (oldalloc == 0)
461 strbuf_release(sb);
b4e04fb6
SB
462 return cnt;
463}
464
2dac9b56
SB
465ssize_t strbuf_write(struct strbuf *sb, FILE *f)
466{
467 return sb->len ? fwrite(sb->buf, 1, sb->len, f) : 0;
468}
469
470
b11b7e13
LT
471#define STRBUF_MAXLINK (2*PATH_MAX)
472
473int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
474{
2fc64700
RS
475 size_t oldalloc = sb->alloc;
476
b11b7e13
LT
477 if (hint < 32)
478 hint = 32;
479
480 while (hint < STRBUF_MAXLINK) {
f3e76ed2 481 ssize_t len;
b11b7e13
LT
482
483 strbuf_grow(sb, hint);
484 len = readlink(path, sb->buf, hint);
485 if (len < 0) {
486 if (errno != ERANGE)
487 break;
488 } else if (len < hint) {
489 strbuf_setlen(sb, len);
490 return 0;
491 }
492
493 /* .. the buffer was too small - try again */
494 hint *= 2;
495 }
2fc64700
RS
496 if (oldalloc == 0)
497 strbuf_release(sb);
b11b7e13
LT
498 return -1;
499}
500
f22a76e9
RS
501int strbuf_getcwd(struct strbuf *sb)
502{
503 size_t oldalloc = sb->alloc;
504 size_t guessed_len = 128;
505
506 for (;; guessed_len *= 2) {
507 strbuf_grow(sb, guessed_len);
508 if (getcwd(sb->buf, sb->alloc)) {
509 strbuf_setlen(sb, strlen(sb->buf));
510 return 0;
511 }
a54e938e
RS
512
513 /*
514 * If getcwd(3) is implemented as a syscall that falls
515 * back to a regular lookup using readdir(3) etc. then
516 * we may be able to avoid EACCES by providing enough
517 * space to the syscall as it's not necessarily bound
518 * to the same restrictions as the fallback.
519 */
520 if (errno == EACCES && guessed_len < PATH_MAX)
521 continue;
522
f22a76e9
RS
523 if (errno != ERANGE)
524 break;
525 }
526 if (oldalloc == 0)
527 strbuf_release(sb);
528 else
529 strbuf_reset(sb);
530 return -1;
531}
532
0cc30e0e
JK
533#ifdef HAVE_GETDELIM
534int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
535{
536 ssize_t r;
537
538 if (feof(fp))
539 return EOF;
540
541 strbuf_reset(sb);
542
543 /* Translate slopbuf to NULL, as we cannot call realloc on it */
544 if (!sb->alloc)
545 sb->buf = NULL;
642956cf 546 errno = 0;
0cc30e0e
JK
547 r = getdelim(&sb->buf, &sb->alloc, term, fp);
548
549 if (r > 0) {
550 sb->len = r;
551 return 0;
552 }
553 assert(r == -1);
554
555 /*
556 * Normally we would have called xrealloc, which will try to free
557 * memory and recover. But we have no way to tell getdelim() to do so.
558 * Worse, we cannot try to recover ENOMEM ourselves, because we have
559 * no idea how many bytes were read by getdelim.
560 *
561 * Dying here is reasonable. It mirrors what xrealloc would do on
562 * catastrophic memory failure. We skip the opportunity to free pack
563 * memory and retry, but that's unlikely to help for a malloc small
564 * enough to hold a single line of input, anyway.
565 */
566 if (errno == ENOMEM)
567 die("Out of memory, getdelim failed");
568
b7090430
JK
569 /*
570 * Restore strbuf invariants; if getdelim left us with a NULL pointer,
571 * we can just re-init, but otherwise we should make sure that our
572 * length is empty, and that the result is NUL-terminated.
573 */
0cc30e0e
JK
574 if (!sb->buf)
575 strbuf_init(sb, 0);
b7090430
JK
576 else
577 strbuf_reset(sb);
0cc30e0e
JK
578 return EOF;
579}
580#else
c7e4f0d7 581int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
917c9a71 582{
d1df5743 583 int ch;
e6c019d0 584
e6c019d0
PH
585 if (feof(fp))
586 return EOF;
b449f4cf
PH
587
588 strbuf_reset(sb);
82912d1d
JK
589 flockfile(fp);
590 while ((ch = getc_unlocked(fp)) != EOF) {
f80c153b
JK
591 if (!strbuf_avail(sb))
592 strbuf_grow(sb, 1);
b449f4cf 593 sb->buf[sb->len++] = ch;
c7e4f0d7
BC
594 if (ch == term)
595 break;
d1df5743 596 }
82912d1d 597 funlockfile(fp);
e6c019d0
PH
598 if (ch == EOF && sb->len == 0)
599 return EOF;
b449f4cf 600
b449f4cf 601 sb->buf[sb->len] = '\0';
e6c019d0 602 return 0;
d1df5743 603}
0cc30e0e 604#endif
a9390b9f 605
1a0c8dfd 606static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
c7e4f0d7
BC
607{
608 if (strbuf_getwholeline(sb, fp, term))
609 return EOF;
dce80bd1
JH
610 if (sb->buf[sb->len - 1] == term)
611 strbuf_setlen(sb, sb->len - 1);
c7e4f0d7
BC
612 return 0;
613}
614
1a0c8dfd 615int strbuf_getline(struct strbuf *sb, FILE *fp)
c8aa9fdf
JH
616{
617 if (strbuf_getwholeline(sb, fp, '\n'))
618 return EOF;
619 if (sb->buf[sb->len - 1] == '\n') {
620 strbuf_setlen(sb, sb->len - 1);
621 if (sb->len && sb->buf[sb->len - 1] == '\r')
622 strbuf_setlen(sb, sb->len - 1);
623 }
624 return 0;
625}
626
8f309aeb
JH
627int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
628{
1a0c8dfd 629 return strbuf_getdelim(sb, fp, '\n');
8f309aeb
JH
630}
631
632int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
633{
1a0c8dfd 634 return strbuf_getdelim(sb, fp, '\0');
8f309aeb
JH
635}
636
5e8617f5
TR
637int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
638{
639 strbuf_reset(sb);
640
641 while (1) {
642 char ch;
643 ssize_t len = xread(fd, &ch, 1);
644 if (len <= 0)
645 return EOF;
646 strbuf_addch(sb, ch);
647 if (ch == term)
648 break;
649 }
650 return 0;
651}
652
6c8afe49 653ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
a9390b9f 654{
6c8afe49
MH
655 int fd;
656 ssize_t len;
79f0ba15 657 int saved_errno;
a9390b9f
KH
658
659 fd = open(path, O_RDONLY);
660 if (fd < 0)
661 return -1;
387e7e19 662 len = strbuf_read(sb, fd, hint);
79f0ba15 663 saved_errno = errno;
a9390b9f 664 close(fd);
79f0ba15
JK
665 if (len < 0) {
666 errno = saved_errno;
a9390b9f 667 return -1;
79f0ba15 668 }
a9390b9f
KH
669
670 return len;
671}
895680f0
JH
672
673void strbuf_add_lines(struct strbuf *out, const char *prefix,
674 const char *buf, size_t size)
675{
eff80a9f 676 add_lines(out, prefix, NULL, buf, size);
895680f0 677}
367d20ec 678
5963c036
MH
679void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
680{
681 while (*s) {
682 size_t len = strcspn(s, "\"<>&");
683 strbuf_add(buf, s, len);
684 s += len;
685 switch (*s) {
686 case '"':
687 strbuf_addstr(buf, "&quot;");
688 break;
689 case '<':
690 strbuf_addstr(buf, "&lt;");
691 break;
692 case '>':
693 strbuf_addstr(buf, "&gt;");
694 break;
695 case '&':
696 strbuf_addstr(buf, "&amp;");
697 break;
698 case 0:
699 return;
700 }
701 s++;
702 }
703}
704
c505116b
JK
705static int is_rfc3986_reserved(char ch)
706{
707 switch (ch) {
708 case '!': case '*': case '\'': case '(': case ')': case ';':
709 case ':': case '@': case '&': case '=': case '+': case '$':
710 case ',': case '/': case '?': case '#': case '[': case ']':
711 return 1;
712 }
713 return 0;
714}
715
716static int is_rfc3986_unreserved(char ch)
717{
718 return isalnum(ch) ||
719 ch == '-' || ch == '_' || ch == '.' || ch == '~';
720}
721
ea03a8e1
JH
722static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
723 int reserved)
c505116b
JK
724{
725 strbuf_grow(sb, len);
726 while (len--) {
727 char ch = *s++;
728 if (is_rfc3986_unreserved(ch) ||
729 (!reserved && is_rfc3986_reserved(ch)))
730 strbuf_addch(sb, ch);
731 else
4c267f2a 732 strbuf_addf(sb, "%%%02x", (unsigned char)ch);
c505116b
JK
733 }
734}
735
736void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
737 int reserved)
738{
739 strbuf_add_urlencode(sb, s, strlen(s), reserved);
740}
9a0a30aa 741
079b546a
AP
742void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
743{
744 if (bytes > 1 << 30) {
745 strbuf_addf(buf, "%u.%2.2u GiB",
7726d360
JK
746 (unsigned)(bytes >> 30),
747 (unsigned)(bytes & ((1 << 30) - 1)) / 10737419);
079b546a 748 } else if (bytes > 1 << 20) {
7726d360 749 unsigned x = bytes + 5243; /* for rounding */
079b546a
AP
750 strbuf_addf(buf, "%u.%2.2u MiB",
751 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
752 } else if (bytes > 1 << 10) {
7726d360 753 unsigned x = bytes + 5; /* for rounding */
079b546a
AP
754 strbuf_addf(buf, "%u.%2.2u KiB",
755 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
756 } else {
7726d360 757 strbuf_addf(buf, "%u bytes", (unsigned)bytes);
079b546a
AP
758 }
759}
760
679eebe2
RS
761void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
762{
763 if (!*path)
764 die("The empty string is not a valid path");
765 if (!is_absolute_path(path)) {
766 struct stat cwd_stat, pwd_stat;
767 size_t orig_len = sb->len;
768 char *cwd = xgetcwd();
769 char *pwd = getenv("PWD");
770 if (pwd && strcmp(pwd, cwd) &&
771 !stat(cwd, &cwd_stat) &&
772 (cwd_stat.st_dev || cwd_stat.st_ino) &&
773 !stat(pwd, &pwd_stat) &&
774 pwd_stat.st_dev == cwd_stat.st_dev &&
775 pwd_stat.st_ino == cwd_stat.st_ino)
776 strbuf_addstr(sb, pwd);
777 else
778 strbuf_addstr(sb, cwd);
779 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
780 strbuf_addch(sb, '/');
781 free(cwd);
782 }
783 strbuf_addstr(sb, path);
784}
785
33ad9ddd
RS
786void strbuf_add_real_path(struct strbuf *sb, const char *path)
787{
788 if (sb->len) {
789 struct strbuf resolved = STRBUF_INIT;
790 strbuf_realpath(&resolved, path, 1);
791 strbuf_addbuf(sb, &resolved);
792 strbuf_release(&resolved);
793 } else
794 strbuf_realpath(sb, path, 1);
795}
796
9a0a30aa
NTND
797int printf_ln(const char *fmt, ...)
798{
799 int ret;
800 va_list ap;
801 va_start(ap, fmt);
802 ret = vprintf(fmt, ap);
803 va_end(ap);
804 if (ret < 0 || putchar('\n') == EOF)
805 return -1;
806 return ret + 1;
807}
808
809int fprintf_ln(FILE *fp, const char *fmt, ...)
810{
811 int ret;
812 va_list ap;
813 va_start(ap, fmt);
814 ret = vfprintf(fp, fmt, ap);
815 va_end(ap);
816 if (ret < 0 || putc('\n', fp) == EOF)
817 return -1;
818 return ret + 1;
819}
88d5a6f6
JK
820
821char *xstrdup_tolower(const char *string)
822{
823 char *result;
824 size_t len, i;
825
826 len = strlen(string);
3733e694 827 result = xmallocz(len);
88d5a6f6
JK
828 for (i = 0; i < len; i++)
829 result[i] = tolower(string[i]);
88d5a6f6
JK
830 return result;
831}
30a0ddb7 832
13ecb463
LS
833char *xstrdup_toupper(const char *string)
834{
835 char *result;
836 size_t len, i;
837
838 len = strlen(string);
839 result = xmallocz(len);
840 for (i = 0; i < len; i++)
841 result[i] = toupper(string[i]);
88d5a6f6
JK
842 return result;
843}
30a0ddb7
JK
844
845char *xstrvfmt(const char *fmt, va_list ap)
846{
847 struct strbuf buf = STRBUF_INIT;
848 strbuf_vaddf(&buf, fmt, ap);
849 return strbuf_detach(&buf, NULL);
850}
851
852char *xstrfmt(const char *fmt, ...)
853{
854 va_list ap;
855 char *ret;
856
857 va_start(ap, fmt);
858 ret = xstrvfmt(fmt, ap);
859 va_end(ap);
860
861 return ret;
862}
aa1462cc 863
c3fbf81a 864void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm,
3b702239 865 int tz_offset, int suppress_tz_name)
aa1462cc 866{
c3fbf81a 867 struct strbuf munged_fmt = STRBUF_INIT;
e4f031e3 868 size_t hint = 128;
aa1462cc
JK
869 size_t len;
870
e4f031e3
JK
871 if (!*fmt)
872 return;
873
c3fbf81a
RS
874 /*
875 * There is no portable way to pass timezone information to
876 * strftime, so we handle %z and %Z here.
877 */
878 for (;;) {
879 const char *percent = strchrnul(fmt, '%');
880 strbuf_add(&munged_fmt, fmt, percent - fmt);
881 if (!*percent)
882 break;
883 fmt = percent + 1;
884 switch (*fmt) {
885 case '%':
886 strbuf_addstr(&munged_fmt, "%%");
887 fmt++;
888 break;
889 case 'z':
890 strbuf_addf(&munged_fmt, "%+05d", tz_offset);
891 fmt++;
892 break;
893 case 'Z':
3b702239 894 if (suppress_tz_name) {
c3fbf81a
RS
895 fmt++;
896 break;
897 }
898 /* FALLTHROUGH */
899 default:
900 strbuf_addch(&munged_fmt, '%');
901 }
902 }
903 fmt = munged_fmt.buf;
904
e4f031e3 905 strbuf_grow(sb, hint);
aa1462cc
JK
906 len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
907
908 if (!len) {
909 /*
e4f031e3
JK
910 * strftime reports "0" if it could not fit the result in the buffer.
911 * Unfortunately, it also reports "0" if the requested time string
912 * takes 0 bytes. So our strategy is to munge the format so that the
913 * output contains at least one character, and then drop the extra
914 * character before returning.
aa1462cc 915 */
c3fbf81a 916 strbuf_addch(&munged_fmt, ' ');
e4f031e3
JK
917 while (!len) {
918 hint *= 2;
919 strbuf_grow(sb, hint);
920 len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
921 munged_fmt.buf, tm);
922 }
e4f031e3 923 len--; /* drop munged space */
aa1462cc 924 }
c3fbf81a 925 strbuf_release(&munged_fmt);
e4f031e3 926 strbuf_setlen(sb, sb->len + len);
aa1462cc 927}
af49c6d0 928
30e677e0 929void strbuf_add_unique_abbrev(struct strbuf *sb, const struct object_id *oid,
af49c6d0
JK
930 int abbrev_len)
931{
932 int r;
4b048c91 933 strbuf_grow(sb, GIT_MAX_HEXSZ + 1);
aab9583f 934 r = find_unique_abbrev_r(sb->buf + sb->len, oid, abbrev_len);
af49c6d0
JK
935 strbuf_setlen(sb, sb->len + r);
936}
1ad7c0f6 937
63af4a84
TK
938/*
939 * Returns the length of a line, without trailing spaces.
940 *
941 * If the line ends with newline, it will be removed too.
942 */
943static size_t cleanup(char *line, size_t len)
944{
945 while (len) {
946 unsigned char c = line[len - 1];
947 if (!isspace(c))
948 break;
949 len--;
950 }
951
952 return len;
953}
954
955/*
956 * Remove empty lines from the beginning and end
957 * and also trailing spaces from every line.
958 *
959 * Turn multiple consecutive empty lines between paragraphs
960 * into just one empty line.
961 *
962 * If the input has only empty lines and spaces,
963 * no output will be produced.
964 *
965 * If last line does not have a newline at the end, one is added.
966 *
967 * Enable skip_comments to skip every line starting with comment
968 * character.
969 */
970void strbuf_stripspace(struct strbuf *sb, int skip_comments)
971{
26114c00 972 size_t empties = 0;
63af4a84
TK
973 size_t i, j, len, newlen;
974 char *eol;
975
976 /* We may have to add a newline. */
977 strbuf_grow(sb, 1);
978
979 for (i = j = 0; i < sb->len; i += len, j += newlen) {
980 eol = memchr(sb->buf + i, '\n', sb->len - i);
981 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
982
983 if (skip_comments && len && sb->buf[i] == comment_line_char) {
984 newlen = 0;
985 continue;
986 }
987 newlen = cleanup(sb->buf + i, len);
988
989 /* Not just an empty line? */
990 if (newlen) {
991 if (empties > 0 && j > 0)
992 sb->buf[j++] = '\n';
993 empties = 0;
994 memmove(sb->buf + j, sb->buf + i, newlen);
995 sb->buf[newlen + j++] = '\n';
996 } else {
997 empties++;
998 }
999 }
1000
1001 strbuf_setlen(sb, j);
1002}
670c359d
JK
1003
1004int strbuf_normalize_path(struct strbuf *src)
1005{
1006 struct strbuf dst = STRBUF_INIT;
1007
1008 strbuf_grow(&dst, src->len);
1009 if (normalize_path_copy(dst.buf, src->buf) < 0) {
1010 strbuf_release(&dst);
1011 return -1;
1012 }
1013
1014 /*
1015 * normalize_path does not tell us the new length, so we have to
1016 * compute it by looking for the new NUL it placed
1017 */
1018 strbuf_setlen(&dst, strlen(dst.buf));
1019 strbuf_swap(src, &dst);
1020 strbuf_release(&dst);
1021 return 0;
1022}