Allow custom "comment char"
[git/git.git] / strbuf.c
CommitLineData
812666c8 1#include "cache.h"
a2fab531 2#include "refs.h"
d1df5743 3
698a68be
JH
4int prefixcmp(const char *str, const char *prefix)
5{
6 for (; ; str++, prefix++)
7 if (!*prefix)
8 return 0;
9 else if (*str != *prefix)
10 return (unsigned char)*prefix - (unsigned char)*str;
11}
12
8cc5b290
AP
13int suffixcmp(const char *str, const char *suffix)
14{
15 int len = strlen(str), suflen = strlen(suffix);
16 if (len < suflen)
17 return -1;
18 else
19 return strcmp(str + len - suflen, suffix);
20}
21
b315c5c0
PH
22/*
23 * Used as the default ->buf value, so that people can always assume
24 * buf is non NULL and ->buf is NUL terminated even for a freshly
25 * initialized strbuf.
26 */
27char strbuf_slopbuf[1];
28
917c9a71
PH
29void strbuf_init(struct strbuf *sb, size_t hint)
30{
b315c5c0
PH
31 sb->alloc = sb->len = 0;
32 sb->buf = strbuf_slopbuf;
8c74ef1e 33 if (hint)
f1696ee3 34 strbuf_grow(sb, hint);
d1df5743
JH
35}
36
917c9a71
PH
37void strbuf_release(struct strbuf *sb)
38{
b315c5c0
PH
39 if (sb->alloc) {
40 free(sb->buf);
41 strbuf_init(sb, 0);
42 }
b449f4cf
PH
43}
44
b315c5c0 45char *strbuf_detach(struct strbuf *sb, size_t *sz)
917c9a71 46{
08ad56f3
JK
47 char *res;
48 strbuf_grow(sb, 0);
49 res = sb->buf;
b315c5c0
PH
50 if (sz)
51 *sz = sb->len;
f1696ee3 52 strbuf_init(sb, 0);
b449f4cf
PH
53 return res;
54}
55
917c9a71
PH
56void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
57{
58 strbuf_release(sb);
59 sb->buf = buf;
60 sb->len = len;
61 sb->alloc = alloc;
62 strbuf_grow(sb, 0);
63 sb->buf[sb->len] = '\0';
64}
65
66void strbuf_grow(struct strbuf *sb, size_t extra)
67{
8c74ef1e 68 int new_buf = !sb->alloc;
1368f650
JN
69 if (unsigned_add_overflows(extra, 1) ||
70 unsigned_add_overflows(sb->len, extra + 1))
b449f4cf 71 die("you want to use way too much memory");
8c74ef1e 72 if (new_buf)
b315c5c0 73 sb->buf = NULL;
b449f4cf 74 ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
8c74ef1e
TR
75 if (new_buf)
76 sb->buf[0] = '\0';
b449f4cf
PH
77}
78
eacd6dc5
LS
79void strbuf_trim(struct strbuf *sb)
80{
81 char *b = sb->buf;
82 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
83 sb->len--;
84 while (sb->len > 0 && isspace(*b)) {
85 b++;
86 sb->len--;
87 }
88 memmove(sb->buf, b, sb->len);
89 sb->buf[sb->len] = '\0';
90}
f1696ee3
PH
91void strbuf_rtrim(struct strbuf *sb)
92{
93 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
94 sb->len--;
95 sb->buf[sb->len] = '\0';
96}
97
eacd6dc5
LS
98void strbuf_ltrim(struct strbuf *sb)
99{
100 char *b = sb->buf;
101 while (sb->len > 0 && isspace(*b)) {
102 b++;
103 sb->len--;
104 }
105 memmove(sb->buf, b, sb->len);
106 sb->buf[sb->len] = '\0';
107}
108
17b73dc6
MH
109struct strbuf **strbuf_split_buf(const char *str, size_t slen,
110 int terminator, int max)
eacd6dc5 111{
b8c2c1fa
MH
112 struct strbuf **ret = NULL;
113 size_t nr = 0, alloc = 0;
eacd6dc5
LS
114 struct strbuf *t;
115
1173bb33
MH
116 while (slen) {
117 int len = slen;
118 if (max <= 0 || nr + 1 < max) {
17b73dc6 119 const char *end = memchr(str, terminator, slen);
1173bb33
MH
120 if (end)
121 len = end - str + 1;
122 }
eacd6dc5
LS
123 t = xmalloc(sizeof(struct strbuf));
124 strbuf_init(t, len);
1173bb33 125 strbuf_add(t, str, len);
b8c2c1fa
MH
126 ALLOC_GROW(ret, nr + 2, alloc);
127 ret[nr++] = t;
1173bb33
MH
128 str += len;
129 slen -= len;
eacd6dc5 130 }
b8c2c1fa
MH
131 ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
132 ret[nr] = NULL;
eacd6dc5
LS
133 return ret;
134}
135
136void strbuf_list_free(struct strbuf **sbs)
137{
138 struct strbuf **s = sbs;
139
140 while (*s) {
141 strbuf_release(*s);
142 free(*s++);
143 }
144 free(sbs);
145}
146
9b200fd6 147int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
45f66f64 148{
8f024655
AR
149 int len = a->len < b->len ? a->len: b->len;
150 int cmp = memcmp(a->buf, b->buf, len);
151 if (cmp)
152 return cmp;
153 return a->len < b->len ? -1: a->len != b->len;
45f66f64
PH
154}
155
917c9a71
PH
156void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
157 const void *data, size_t dlen)
158{
1368f650 159 if (unsigned_add_overflows(pos, len))
917c9a71
PH
160 die("you want to use way too much memory");
161 if (pos > sb->len)
162 die("`pos' is too far after the end of the buffer");
163 if (pos + len > sb->len)
164 die("`pos + len' is too far after the end of the buffer");
165
166 if (dlen >= len)
167 strbuf_grow(sb, dlen - len);
168 memmove(sb->buf + pos + dlen,
169 sb->buf + pos + len,
170 sb->len - pos - len);
171 memcpy(sb->buf + pos, data, dlen);
172 strbuf_setlen(sb, sb->len + dlen - len);
173}
174
c76689df
PH
175void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
176{
177 strbuf_splice(sb, pos, 0, data, len);
178}
179
180void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
181{
182 strbuf_splice(sb, pos, len, NULL, 0);
183}
184
917c9a71
PH
185void strbuf_add(struct strbuf *sb, const void *data, size_t len)
186{
b449f4cf
PH
187 strbuf_grow(sb, len);
188 memcpy(sb->buf + sb->len, data, len);
189 strbuf_setlen(sb, sb->len + len);
190}
191
91db267e
RS
192void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len)
193{
194 strbuf_grow(sb, len);
195 memcpy(sb->buf + sb->len, sb->buf + pos, len);
196 strbuf_setlen(sb, sb->len + len);
197}
198
917c9a71
PH
199void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
200{
b449f4cf 201 va_list ap;
ebeb6090
JK
202 va_start(ap, fmt);
203 strbuf_vaddf(sb, fmt, ap);
204 va_end(ap);
205}
206
eff80a9f
JH
207static void add_lines(struct strbuf *out,
208 const char *prefix1,
209 const char *prefix2,
210 const char *buf, size_t size)
211{
212 while (size) {
213 const char *prefix;
214 const char *next = memchr(buf, '\n', size);
215 next = next ? (next + 1) : (buf + size);
216
217 prefix = (prefix2 && buf[0] == '\n') ? prefix2 : prefix1;
218 strbuf_addstr(out, prefix);
219 strbuf_add(out, buf, next - buf);
220 size -= next - buf;
221 buf = next;
222 }
223 strbuf_complete_line(out);
224}
225
226void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
227{
228 static char prefix1[3];
229 static char prefix2[2];
230
231 if (prefix1[0] != comment_line_char) {
232 sprintf(prefix1, "%c ", comment_line_char);
233 sprintf(prefix2, "%c", comment_line_char);
234 }
235 add_lines(out, prefix1, prefix2, buf, size);
236}
237
238void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
239{
240 va_list params;
241 struct strbuf buf = STRBUF_INIT;
242 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
243
244 va_start(params, fmt);
245 strbuf_vaddf(&buf, fmt, params);
246 va_end(params);
247
248 strbuf_add_commented_lines(sb, buf.buf, buf.len);
249 if (incomplete_line)
250 sb->buf[--sb->len] = '\0';
251
252 strbuf_release(&buf);
253}
254
ebeb6090
JK
255void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
256{
257 int len;
258 va_list cp;
b449f4cf 259
f141bd80
SP
260 if (!strbuf_avail(sb))
261 strbuf_grow(sb, 64);
ebeb6090
JK
262 va_copy(cp, ap);
263 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
264 va_end(cp);
f141bd80 265 if (len < 0)
ebeb6090 266 die("BUG: your vsnprintf is broken (returned %d)", len);
f1696ee3 267 if (len > strbuf_avail(sb)) {
b449f4cf 268 strbuf_grow(sb, len);
b449f4cf 269 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
ebeb6090
JK
270 if (len > strbuf_avail(sb))
271 die("BUG: your vsnprintf is broken (insatiable)");
b449f4cf
PH
272 }
273 strbuf_setlen(sb, sb->len + len);
d1df5743
JH
274}
275
c3a670de
MC
276void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
277 void *context)
cde75e59
RS
278{
279 for (;;) {
c3a670de
MC
280 const char *percent;
281 size_t consumed;
cde75e59
RS
282
283 percent = strchrnul(format, '%');
284 strbuf_add(sb, format, percent - format);
285 if (!*percent)
286 break;
287 format = percent + 1;
288
0a0416a3
JK
289 if (*format == '%') {
290 strbuf_addch(sb, '%');
291 format++;
292 continue;
293 }
294
c3a670de
MC
295 consumed = fn(sb, format, context);
296 if (consumed)
297 format += consumed;
298 else
cde75e59
RS
299 strbuf_addch(sb, '%');
300 }
301}
302
9b864e73
RS
303size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
304 void *context)
305{
306 struct strbuf_expand_dict_entry *e = context;
307 size_t len;
308
309 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
310 if (!strncmp(placeholder, e->placeholder, len)) {
311 if (e->value)
312 strbuf_addstr(sb, e->value);
313 return len;
314 }
315 }
316 return 0;
317}
318
361df5df
JK
319void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
320{
321 int i, len = src->len;
322
323 for (i = 0; i < len; i++) {
324 if (src->buf[i] == '%')
325 strbuf_addch(dst, '%');
326 strbuf_addch(dst, src->buf[i]);
327 }
328}
329
917c9a71
PH
330size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
331{
b449f4cf 332 size_t res;
2fc64700 333 size_t oldalloc = sb->alloc;
b449f4cf
PH
334
335 strbuf_grow(sb, size);
336 res = fread(sb->buf + sb->len, 1, size, f);
2fc64700 337 if (res > 0)
b449f4cf 338 strbuf_setlen(sb, sb->len + res);
6651c3f7 339 else if (oldalloc == 0)
2fc64700 340 strbuf_release(sb);
b449f4cf 341 return res;
d1df5743
JH
342}
343
f1696ee3 344ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
b449f4cf
PH
345{
346 size_t oldlen = sb->len;
2fc64700 347 size_t oldalloc = sb->alloc;
b449f4cf 348
f1696ee3 349 strbuf_grow(sb, hint ? hint : 8192);
b449f4cf
PH
350 for (;;) {
351 ssize_t cnt;
352
b449f4cf
PH
353 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
354 if (cnt < 0) {
2fc64700
RS
355 if (oldalloc == 0)
356 strbuf_release(sb);
357 else
358 strbuf_setlen(sb, oldlen);
b449f4cf
PH
359 return -1;
360 }
361 if (!cnt)
362 break;
363 sb->len += cnt;
f1696ee3 364 strbuf_grow(sb, 8192);
b449f4cf
PH
365 }
366
367 sb->buf[sb->len] = '\0';
368 return sb->len - oldlen;
d1df5743
JH
369}
370
b11b7e13
LT
371#define STRBUF_MAXLINK (2*PATH_MAX)
372
373int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
374{
2fc64700
RS
375 size_t oldalloc = sb->alloc;
376
b11b7e13
LT
377 if (hint < 32)
378 hint = 32;
379
380 while (hint < STRBUF_MAXLINK) {
381 int len;
382
383 strbuf_grow(sb, hint);
384 len = readlink(path, sb->buf, hint);
385 if (len < 0) {
386 if (errno != ERANGE)
387 break;
388 } else if (len < hint) {
389 strbuf_setlen(sb, len);
390 return 0;
391 }
392
393 /* .. the buffer was too small - try again */
394 hint *= 2;
395 }
2fc64700
RS
396 if (oldalloc == 0)
397 strbuf_release(sb);
b11b7e13
LT
398 return -1;
399}
400
c7e4f0d7 401int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
917c9a71 402{
d1df5743 403 int ch;
e6c019d0 404
e6c019d0
PH
405 if (feof(fp))
406 return EOF;
b449f4cf
PH
407
408 strbuf_reset(sb);
d1df5743 409 while ((ch = fgetc(fp)) != EOF) {
b449f4cf
PH
410 strbuf_grow(sb, 1);
411 sb->buf[sb->len++] = ch;
c7e4f0d7
BC
412 if (ch == term)
413 break;
d1df5743 414 }
e6c019d0
PH
415 if (ch == EOF && sb->len == 0)
416 return EOF;
b449f4cf 417
b449f4cf 418 sb->buf[sb->len] = '\0';
e6c019d0 419 return 0;
d1df5743 420}
a9390b9f 421
c7e4f0d7
BC
422int strbuf_getline(struct strbuf *sb, FILE *fp, int term)
423{
424 if (strbuf_getwholeline(sb, fp, term))
425 return EOF;
426 if (sb->buf[sb->len-1] == term)
427 strbuf_setlen(sb, sb->len-1);
428 return 0;
429}
430
5e8617f5
TR
431int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
432{
433 strbuf_reset(sb);
434
435 while (1) {
436 char ch;
437 ssize_t len = xread(fd, &ch, 1);
438 if (len <= 0)
439 return EOF;
440 strbuf_addch(sb, ch);
441 if (ch == term)
442 break;
443 }
444 return 0;
445}
446
387e7e19 447int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
a9390b9f
KH
448{
449 int fd, len;
450
451 fd = open(path, O_RDONLY);
452 if (fd < 0)
453 return -1;
387e7e19 454 len = strbuf_read(sb, fd, hint);
a9390b9f
KH
455 close(fd);
456 if (len < 0)
457 return -1;
458
459 return len;
460}
895680f0
JH
461
462void strbuf_add_lines(struct strbuf *out, const char *prefix,
463 const char *buf, size_t size)
464{
eff80a9f 465 add_lines(out, prefix, NULL, buf, size);
895680f0 466}
367d20ec 467
5963c036
MH
468void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
469{
470 while (*s) {
471 size_t len = strcspn(s, "\"<>&");
472 strbuf_add(buf, s, len);
473 s += len;
474 switch (*s) {
475 case '"':
476 strbuf_addstr(buf, "&quot;");
477 break;
478 case '<':
479 strbuf_addstr(buf, "&lt;");
480 break;
481 case '>':
482 strbuf_addstr(buf, "&gt;");
483 break;
484 case '&':
485 strbuf_addstr(buf, "&amp;");
486 break;
487 case 0:
488 return;
489 }
490 s++;
491 }
492}
493
c505116b
JK
494static int is_rfc3986_reserved(char ch)
495{
496 switch (ch) {
497 case '!': case '*': case '\'': case '(': case ')': case ';':
498 case ':': case '@': case '&': case '=': case '+': case '$':
499 case ',': case '/': case '?': case '#': case '[': case ']':
500 return 1;
501 }
502 return 0;
503}
504
505static int is_rfc3986_unreserved(char ch)
506{
507 return isalnum(ch) ||
508 ch == '-' || ch == '_' || ch == '.' || ch == '~';
509}
510
ea03a8e1
JH
511static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
512 int reserved)
c505116b
JK
513{
514 strbuf_grow(sb, len);
515 while (len--) {
516 char ch = *s++;
517 if (is_rfc3986_unreserved(ch) ||
518 (!reserved && is_rfc3986_reserved(ch)))
519 strbuf_addch(sb, ch);
520 else
521 strbuf_addf(sb, "%%%02x", ch);
522 }
523}
524
525void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
526 int reserved)
527{
528 strbuf_add_urlencode(sb, s, strlen(s), reserved);
529}
9a0a30aa 530
9a0a30aa
NTND
531int printf_ln(const char *fmt, ...)
532{
533 int ret;
534 va_list ap;
535 va_start(ap, fmt);
536 ret = vprintf(fmt, ap);
537 va_end(ap);
538 if (ret < 0 || putchar('\n') == EOF)
539 return -1;
540 return ret + 1;
541}
542
543int fprintf_ln(FILE *fp, const char *fmt, ...)
544{
545 int ret;
546 va_list ap;
547 va_start(ap, fmt);
548 ret = vfprintf(fp, fmt, ap);
549 va_end(ap);
550 if (ret < 0 || putc('\n', fp) == EOF)
551 return -1;
552 return ret + 1;
553}