strbuf_add_commented_lines(): avoid SP-HT sequence in commented lines
[git] / strbuf.c
1 #include "cache.h"
2 #include "refs.h"
3 #include "utf8.h"
4
5 int 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
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  */
19 char strbuf_slopbuf[1];
20
21 void strbuf_init(struct strbuf *sb, size_t hint)
22 {
23         sb->alloc = sb->len = 0;
24         sb->buf = strbuf_slopbuf;
25         if (hint)
26                 strbuf_grow(sb, hint);
27 }
28
29 void strbuf_release(struct strbuf *sb)
30 {
31         if (sb->alloc) {
32                 free(sb->buf);
33                 strbuf_init(sb, 0);
34         }
35 }
36
37 char *strbuf_detach(struct strbuf *sb, size_t *sz)
38 {
39         char *res;
40         strbuf_grow(sb, 0);
41         res = sb->buf;
42         if (sz)
43                 *sz = sb->len;
44         strbuf_init(sb, 0);
45         return res;
46 }
47
48 void 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
58 void strbuf_grow(struct strbuf *sb, size_t extra)
59 {
60         int new_buf = !sb->alloc;
61         if (unsigned_add_overflows(extra, 1) ||
62             unsigned_add_overflows(sb->len, extra + 1))
63                 die("you want to use way too much memory");
64         if (new_buf)
65                 sb->buf = NULL;
66         ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
67         if (new_buf)
68                 sb->buf[0] = '\0';
69 }
70
71 void strbuf_trim(struct strbuf *sb)
72 {
73         strbuf_rtrim(sb);
74         strbuf_ltrim(sb);
75 }
76 void 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
83 void 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
94 int 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
110 void 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
117 struct strbuf **strbuf_split_buf(const char *str, size_t slen,
118                                  int terminator, int max)
119 {
120         struct strbuf **ret = NULL;
121         size_t nr = 0, alloc = 0;
122         struct strbuf *t;
123
124         while (slen) {
125                 int len = slen;
126                 if (max <= 0 || nr + 1 < max) {
127                         const char *end = memchr(str, terminator, slen);
128                         if (end)
129                                 len = end - str + 1;
130                 }
131                 t = xmalloc(sizeof(struct strbuf));
132                 strbuf_init(t, len);
133                 strbuf_add(t, str, len);
134                 ALLOC_GROW(ret, nr + 2, alloc);
135                 ret[nr++] = t;
136                 str += len;
137                 slen -= len;
138         }
139         ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
140         ret[nr] = NULL;
141         return ret;
142 }
143
144 void 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
155 int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
156 {
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;
162 }
163
164 void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
165                                    const void *data, size_t dlen)
166 {
167         if (unsigned_add_overflows(pos, len))
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
183 void 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
188 void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
189 {
190         strbuf_splice(sb, pos, len, NULL, 0);
191 }
192
193 void strbuf_add(struct strbuf *sb, const void *data, size_t len)
194 {
195         strbuf_grow(sb, len);
196         memcpy(sb->buf + sb->len, data, len);
197         strbuf_setlen(sb, sb->len + len);
198 }
199
200 void 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
207 void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
208 {
209         va_list ap;
210         va_start(ap, fmt);
211         strbuf_vaddf(sb, fmt, ap);
212         va_end(ap);
213 }
214
215 static void add_lines(struct strbuf *out,
216                         const char *prefix1,
217                         const char *prefix2,
218                         const char *buf, size_t size)
219 {
220         while (size) {
221                 const char *prefix;
222                 const char *next = memchr(buf, '\n', size);
223                 next = next ? (next + 1) : (buf + size);
224
225                 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
226                           ? prefix2 : prefix1);
227                 strbuf_addstr(out, prefix);
228                 strbuf_add(out, buf, next - buf);
229                 size -= next - buf;
230                 buf = next;
231         }
232         strbuf_complete_line(out);
233 }
234
235 void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
236 {
237         static char prefix1[3];
238         static char prefix2[2];
239
240         if (prefix1[0] != comment_line_char) {
241                 sprintf(prefix1, "%c ", comment_line_char);
242                 sprintf(prefix2, "%c", comment_line_char);
243         }
244         add_lines(out, prefix1, prefix2, buf, size);
245 }
246
247 void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
248 {
249         va_list params;
250         struct strbuf buf = STRBUF_INIT;
251         int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
252
253         va_start(params, fmt);
254         strbuf_vaddf(&buf, fmt, params);
255         va_end(params);
256
257         strbuf_add_commented_lines(sb, buf.buf, buf.len);
258         if (incomplete_line)
259                 sb->buf[--sb->len] = '\0';
260
261         strbuf_release(&buf);
262 }
263
264 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
265 {
266         int len;
267         va_list cp;
268
269         if (!strbuf_avail(sb))
270                 strbuf_grow(sb, 64);
271         va_copy(cp, ap);
272         len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
273         va_end(cp);
274         if (len < 0)
275                 die("BUG: your vsnprintf is broken (returned %d)", len);
276         if (len > strbuf_avail(sb)) {
277                 strbuf_grow(sb, len);
278                 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
279                 if (len > strbuf_avail(sb))
280                         die("BUG: your vsnprintf is broken (insatiable)");
281         }
282         strbuf_setlen(sb, sb->len + len);
283 }
284
285 void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
286                    void *context)
287 {
288         for (;;) {
289                 const char *percent;
290                 size_t consumed;
291
292                 percent = strchrnul(format, '%');
293                 strbuf_add(sb, format, percent - format);
294                 if (!*percent)
295                         break;
296                 format = percent + 1;
297
298                 if (*format == '%') {
299                         strbuf_addch(sb, '%');
300                         format++;
301                         continue;
302                 }
303
304                 consumed = fn(sb, format, context);
305                 if (consumed)
306                         format += consumed;
307                 else
308                         strbuf_addch(sb, '%');
309         }
310 }
311
312 size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
313                 void *context)
314 {
315         struct strbuf_expand_dict_entry *e = context;
316         size_t len;
317
318         for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
319                 if (!strncmp(placeholder, e->placeholder, len)) {
320                         if (e->value)
321                                 strbuf_addstr(sb, e->value);
322                         return len;
323                 }
324         }
325         return 0;
326 }
327
328 void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
329 {
330         int i, len = src->len;
331
332         for (i = 0; i < len; i++) {
333                 if (src->buf[i] == '%')
334                         strbuf_addch(dst, '%');
335                 strbuf_addch(dst, src->buf[i]);
336         }
337 }
338
339 size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
340 {
341         size_t res;
342         size_t oldalloc = sb->alloc;
343
344         strbuf_grow(sb, size);
345         res = fread(sb->buf + sb->len, 1, size, f);
346         if (res > 0)
347                 strbuf_setlen(sb, sb->len + res);
348         else if (oldalloc == 0)
349                 strbuf_release(sb);
350         return res;
351 }
352
353 ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
354 {
355         size_t oldlen = sb->len;
356         size_t oldalloc = sb->alloc;
357
358         strbuf_grow(sb, hint ? hint : 8192);
359         for (;;) {
360                 ssize_t cnt;
361
362                 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
363                 if (cnt < 0) {
364                         if (oldalloc == 0)
365                                 strbuf_release(sb);
366                         else
367                                 strbuf_setlen(sb, oldlen);
368                         return -1;
369                 }
370                 if (!cnt)
371                         break;
372                 sb->len += cnt;
373                 strbuf_grow(sb, 8192);
374         }
375
376         sb->buf[sb->len] = '\0';
377         return sb->len - oldlen;
378 }
379
380 #define STRBUF_MAXLINK (2*PATH_MAX)
381
382 int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
383 {
384         size_t oldalloc = sb->alloc;
385
386         if (hint < 32)
387                 hint = 32;
388
389         while (hint < STRBUF_MAXLINK) {
390                 int len;
391
392                 strbuf_grow(sb, hint);
393                 len = readlink(path, sb->buf, hint);
394                 if (len < 0) {
395                         if (errno != ERANGE)
396                                 break;
397                 } else if (len < hint) {
398                         strbuf_setlen(sb, len);
399                         return 0;
400                 }
401
402                 /* .. the buffer was too small - try again */
403                 hint *= 2;
404         }
405         if (oldalloc == 0)
406                 strbuf_release(sb);
407         return -1;
408 }
409
410 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
411 {
412         int ch;
413
414         if (feof(fp))
415                 return EOF;
416
417         strbuf_reset(sb);
418         while ((ch = fgetc(fp)) != EOF) {
419                 strbuf_grow(sb, 1);
420                 sb->buf[sb->len++] = ch;
421                 if (ch == term)
422                         break;
423         }
424         if (ch == EOF && sb->len == 0)
425                 return EOF;
426
427         sb->buf[sb->len] = '\0';
428         return 0;
429 }
430
431 int strbuf_getline(struct strbuf *sb, FILE *fp, int term)
432 {
433         if (strbuf_getwholeline(sb, fp, term))
434                 return EOF;
435         if (sb->buf[sb->len-1] == term)
436                 strbuf_setlen(sb, sb->len-1);
437         return 0;
438 }
439
440 int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
441 {
442         strbuf_reset(sb);
443
444         while (1) {
445                 char ch;
446                 ssize_t len = xread(fd, &ch, 1);
447                 if (len <= 0)
448                         return EOF;
449                 strbuf_addch(sb, ch);
450                 if (ch == term)
451                         break;
452         }
453         return 0;
454 }
455
456 int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
457 {
458         int fd, len;
459
460         fd = open(path, O_RDONLY);
461         if (fd < 0)
462                 return -1;
463         len = strbuf_read(sb, fd, hint);
464         close(fd);
465         if (len < 0)
466                 return -1;
467
468         return len;
469 }
470
471 void strbuf_add_lines(struct strbuf *out, const char *prefix,
472                       const char *buf, size_t size)
473 {
474         add_lines(out, prefix, NULL, buf, size);
475 }
476
477 void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
478 {
479         while (*s) {
480                 size_t len = strcspn(s, "\"<>&");
481                 strbuf_add(buf, s, len);
482                 s += len;
483                 switch (*s) {
484                 case '"':
485                         strbuf_addstr(buf, "&quot;");
486                         break;
487                 case '<':
488                         strbuf_addstr(buf, "&lt;");
489                         break;
490                 case '>':
491                         strbuf_addstr(buf, "&gt;");
492                         break;
493                 case '&':
494                         strbuf_addstr(buf, "&amp;");
495                         break;
496                 case 0:
497                         return;
498                 }
499                 s++;
500         }
501 }
502
503 static int is_rfc3986_reserved(char ch)
504 {
505         switch (ch) {
506                 case '!': case '*': case '\'': case '(': case ')': case ';':
507                 case ':': case '@': case '&': case '=': case '+': case '$':
508                 case ',': case '/': case '?': case '#': case '[': case ']':
509                         return 1;
510         }
511         return 0;
512 }
513
514 static int is_rfc3986_unreserved(char ch)
515 {
516         return isalnum(ch) ||
517                 ch == '-' || ch == '_' || ch == '.' || ch == '~';
518 }
519
520 static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
521                                  int reserved)
522 {
523         strbuf_grow(sb, len);
524         while (len--) {
525                 char ch = *s++;
526                 if (is_rfc3986_unreserved(ch) ||
527                     (!reserved && is_rfc3986_reserved(ch)))
528                         strbuf_addch(sb, ch);
529                 else
530                         strbuf_addf(sb, "%%%02x", ch);
531         }
532 }
533
534 void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
535                              int reserved)
536 {
537         strbuf_add_urlencode(sb, s, strlen(s), reserved);
538 }
539
540 void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
541 {
542         if (bytes > 1 << 30) {
543                 strbuf_addf(buf, "%u.%2.2u GiB",
544                             (int)(bytes >> 30),
545                             (int)(bytes & ((1 << 30) - 1)) / 10737419);
546         } else if (bytes > 1 << 20) {
547                 int x = bytes + 5243;  /* for rounding */
548                 strbuf_addf(buf, "%u.%2.2u MiB",
549                             x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
550         } else if (bytes > 1 << 10) {
551                 int x = bytes + 5;  /* for rounding */
552                 strbuf_addf(buf, "%u.%2.2u KiB",
553                             x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
554         } else {
555                 strbuf_addf(buf, "%u bytes", (int)bytes);
556         }
557 }
558
559 int printf_ln(const char *fmt, ...)
560 {
561         int ret;
562         va_list ap;
563         va_start(ap, fmt);
564         ret = vprintf(fmt, ap);
565         va_end(ap);
566         if (ret < 0 || putchar('\n') == EOF)
567                 return -1;
568         return ret + 1;
569 }
570
571 int fprintf_ln(FILE *fp, const char *fmt, ...)
572 {
573         int ret;
574         va_list ap;
575         va_start(ap, fmt);
576         ret = vfprintf(fp, fmt, ap);
577         va_end(ap);
578         if (ret < 0 || putc('\n', fp) == EOF)
579                 return -1;
580         return ret + 1;
581 }
582
583 char *xstrdup_tolower(const char *string)
584 {
585         char *result;
586         size_t len, i;
587
588         len = strlen(string);
589         result = xmalloc(len + 1);
590         for (i = 0; i < len; i++)
591                 result[i] = tolower(string[i]);
592         result[i] = '\0';
593         return result;
594 }
595
596 char *xstrvfmt(const char *fmt, va_list ap)
597 {
598         struct strbuf buf = STRBUF_INIT;
599         strbuf_vaddf(&buf, fmt, ap);
600         return strbuf_detach(&buf, NULL);
601 }
602
603 char *xstrfmt(const char *fmt, ...)
604 {
605         va_list ap;
606         char *ret;
607
608         va_start(ap, fmt);
609         ret = xstrvfmt(fmt, ap);
610         va_end(ap);
611
612         return ret;
613 }