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