Merge branch 'mh/strbuf-read-file-returns-ssize-t' into maint
[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) {
248 sprintf(prefix1, "%c ", comment_line_char);
249 sprintf(prefix2, "%c", comment_line_char);
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
PH
366 for (;;) {
367 ssize_t cnt;
368
b449f4cf
PH
369 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
370 if (cnt < 0) {
2fc64700
RS
371 if (oldalloc == 0)
372 strbuf_release(sb);
373 else
374 strbuf_setlen(sb, oldlen);
b449f4cf
PH
375 return -1;
376 }
377 if (!cnt)
378 break;
379 sb->len += cnt;
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
c7e4f0d7 438int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
917c9a71 439{
d1df5743 440 int ch;
e6c019d0 441
e6c019d0
PH
442 if (feof(fp))
443 return EOF;
b449f4cf
PH
444
445 strbuf_reset(sb);
d1df5743 446 while ((ch = fgetc(fp)) != EOF) {
b449f4cf
PH
447 strbuf_grow(sb, 1);
448 sb->buf[sb->len++] = ch;
c7e4f0d7
BC
449 if (ch == term)
450 break;
d1df5743 451 }
e6c019d0
PH
452 if (ch == EOF && sb->len == 0)
453 return EOF;
b449f4cf 454
b449f4cf 455 sb->buf[sb->len] = '\0';
e6c019d0 456 return 0;
d1df5743 457}
a9390b9f 458
c7e4f0d7
BC
459int strbuf_getline(struct strbuf *sb, FILE *fp, int term)
460{
461 if (strbuf_getwholeline(sb, fp, term))
462 return EOF;
463 if (sb->buf[sb->len-1] == term)
464 strbuf_setlen(sb, sb->len-1);
465 return 0;
466}
467
5e8617f5
TR
468int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
469{
470 strbuf_reset(sb);
471
472 while (1) {
473 char ch;
474 ssize_t len = xread(fd, &ch, 1);
475 if (len <= 0)
476 return EOF;
477 strbuf_addch(sb, ch);
478 if (ch == term)
479 break;
480 }
481 return 0;
482}
483
6c8afe49 484ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
a9390b9f 485{
6c8afe49
MH
486 int fd;
487 ssize_t len;
a9390b9f
KH
488
489 fd = open(path, O_RDONLY);
490 if (fd < 0)
491 return -1;
387e7e19 492 len = strbuf_read(sb, fd, hint);
a9390b9f
KH
493 close(fd);
494 if (len < 0)
495 return -1;
496
497 return len;
498}
895680f0
JH
499
500void strbuf_add_lines(struct strbuf *out, const char *prefix,
501 const char *buf, size_t size)
502{
eff80a9f 503 add_lines(out, prefix, NULL, buf, size);
895680f0 504}
367d20ec 505
5963c036
MH
506void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
507{
508 while (*s) {
509 size_t len = strcspn(s, "\"<>&");
510 strbuf_add(buf, s, len);
511 s += len;
512 switch (*s) {
513 case '"':
514 strbuf_addstr(buf, "&quot;");
515 break;
516 case '<':
517 strbuf_addstr(buf, "&lt;");
518 break;
519 case '>':
520 strbuf_addstr(buf, "&gt;");
521 break;
522 case '&':
523 strbuf_addstr(buf, "&amp;");
524 break;
525 case 0:
526 return;
527 }
528 s++;
529 }
530}
531
c505116b
JK
532static int is_rfc3986_reserved(char ch)
533{
534 switch (ch) {
535 case '!': case '*': case '\'': case '(': case ')': case ';':
536 case ':': case '@': case '&': case '=': case '+': case '$':
537 case ',': case '/': case '?': case '#': case '[': case ']':
538 return 1;
539 }
540 return 0;
541}
542
543static int is_rfc3986_unreserved(char ch)
544{
545 return isalnum(ch) ||
546 ch == '-' || ch == '_' || ch == '.' || ch == '~';
547}
548
ea03a8e1
JH
549static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
550 int reserved)
c505116b
JK
551{
552 strbuf_grow(sb, len);
553 while (len--) {
554 char ch = *s++;
555 if (is_rfc3986_unreserved(ch) ||
556 (!reserved && is_rfc3986_reserved(ch)))
557 strbuf_addch(sb, ch);
558 else
559 strbuf_addf(sb, "%%%02x", ch);
560 }
561}
562
563void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
564 int reserved)
565{
566 strbuf_add_urlencode(sb, s, strlen(s), reserved);
567}
9a0a30aa 568
079b546a
AP
569void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
570{
571 if (bytes > 1 << 30) {
572 strbuf_addf(buf, "%u.%2.2u GiB",
573 (int)(bytes >> 30),
574 (int)(bytes & ((1 << 30) - 1)) / 10737419);
575 } else if (bytes > 1 << 20) {
576 int x = bytes + 5243; /* for rounding */
577 strbuf_addf(buf, "%u.%2.2u MiB",
578 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
579 } else if (bytes > 1 << 10) {
580 int x = bytes + 5; /* for rounding */
581 strbuf_addf(buf, "%u.%2.2u KiB",
582 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
583 } else {
584 strbuf_addf(buf, "%u bytes", (int)bytes);
585 }
586}
587
679eebe2
RS
588void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
589{
590 if (!*path)
591 die("The empty string is not a valid path");
592 if (!is_absolute_path(path)) {
593 struct stat cwd_stat, pwd_stat;
594 size_t orig_len = sb->len;
595 char *cwd = xgetcwd();
596 char *pwd = getenv("PWD");
597 if (pwd && strcmp(pwd, cwd) &&
598 !stat(cwd, &cwd_stat) &&
599 (cwd_stat.st_dev || cwd_stat.st_ino) &&
600 !stat(pwd, &pwd_stat) &&
601 pwd_stat.st_dev == cwd_stat.st_dev &&
602 pwd_stat.st_ino == cwd_stat.st_ino)
603 strbuf_addstr(sb, pwd);
604 else
605 strbuf_addstr(sb, cwd);
606 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
607 strbuf_addch(sb, '/');
608 free(cwd);
609 }
610 strbuf_addstr(sb, path);
611}
612
9a0a30aa
NTND
613int printf_ln(const char *fmt, ...)
614{
615 int ret;
616 va_list ap;
617 va_start(ap, fmt);
618 ret = vprintf(fmt, ap);
619 va_end(ap);
620 if (ret < 0 || putchar('\n') == EOF)
621 return -1;
622 return ret + 1;
623}
624
625int fprintf_ln(FILE *fp, const char *fmt, ...)
626{
627 int ret;
628 va_list ap;
629 va_start(ap, fmt);
630 ret = vfprintf(fp, fmt, ap);
631 va_end(ap);
632 if (ret < 0 || putc('\n', fp) == EOF)
633 return -1;
634 return ret + 1;
635}
88d5a6f6
JK
636
637char *xstrdup_tolower(const char *string)
638{
639 char *result;
640 size_t len, i;
641
642 len = strlen(string);
643 result = xmalloc(len + 1);
644 for (i = 0; i < len; i++)
645 result[i] = tolower(string[i]);
646 result[i] = '\0';
647 return result;
648}
30a0ddb7
JK
649
650char *xstrvfmt(const char *fmt, va_list ap)
651{
652 struct strbuf buf = STRBUF_INIT;
653 strbuf_vaddf(&buf, fmt, ap);
654 return strbuf_detach(&buf, NULL);
655}
656
657char *xstrfmt(const char *fmt, ...)
658{
659 va_list ap;
660 char *ret;
661
662 va_start(ap, fmt);
663 ret = xstrvfmt(fmt, ap);
664 va_end(ap);
665
666 return ret;
667}