Fifth batch
[git.git] / strbuf.c
blobe3397cc4c72a05c1709264489d9addf935881c9e
1 #include "cache.h"
2 #include "refs.h"
3 #include "string-list.h"
4 #include "utf8.h"
6 int starts_with(const char *str, const char *prefix)
8 for (; ; str++, prefix++)
9 if (!*prefix)
10 return 1;
11 else if (*str != *prefix)
12 return 0;
15 int istarts_with(const char *str, const char *prefix)
17 for (; ; str++, prefix++)
18 if (!*prefix)
19 return 1;
20 else if (tolower(*str) != tolower(*prefix))
21 return 0;
24 int skip_to_optional_arg_default(const char *str, const char *prefix,
25 const char **arg, const char *def)
27 const char *p;
29 if (!skip_prefix(str, prefix, &p))
30 return 0;
32 if (!*p) {
33 if (arg)
34 *arg = def;
35 return 1;
38 if (*p != '=')
39 return 0;
41 if (arg)
42 *arg = p + 1;
43 return 1;
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.
51 char strbuf_slopbuf[1];
53 void strbuf_init(struct strbuf *sb, size_t hint)
55 sb->alloc = sb->len = 0;
56 sb->buf = strbuf_slopbuf;
57 if (hint)
58 strbuf_grow(sb, hint);
61 void strbuf_release(struct strbuf *sb)
63 if (sb->alloc) {
64 free(sb->buf);
65 strbuf_init(sb, 0);
69 char *strbuf_detach(struct strbuf *sb, size_t *sz)
71 char *res;
72 strbuf_grow(sb, 0);
73 res = sb->buf;
74 if (sz)
75 *sz = sb->len;
76 strbuf_init(sb, 0);
77 return res;
80 void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
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';
90 void strbuf_grow(struct strbuf *sb, size_t extra)
92 int new_buf = !sb->alloc;
93 if (unsigned_add_overflows(extra, 1) ||
94 unsigned_add_overflows(sb->len, extra + 1))
95 die("you want to use way too much memory");
96 if (new_buf)
97 sb->buf = NULL;
98 ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
99 if (new_buf)
100 sb->buf[0] = '\0';
103 void strbuf_trim(struct strbuf *sb)
105 strbuf_rtrim(sb);
106 strbuf_ltrim(sb);
109 void strbuf_rtrim(struct strbuf *sb)
111 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
112 sb->len--;
113 sb->buf[sb->len] = '\0';
116 void strbuf_trim_trailing_dir_sep(struct strbuf *sb)
118 while (sb->len > 0 && is_dir_sep((unsigned char)sb->buf[sb->len - 1]))
119 sb->len--;
120 sb->buf[sb->len] = '\0';
123 void strbuf_trim_trailing_newline(struct strbuf *sb)
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';
132 void strbuf_ltrim(struct strbuf *sb)
134 char *b = sb->buf;
135 while (sb->len > 0 && isspace(*b)) {
136 b++;
137 sb->len--;
139 memmove(sb->buf, b, sb->len);
140 sb->buf[sb->len] = '\0';
143 int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
145 char *out;
146 size_t len;
148 if (same_encoding(from, to))
149 return 0;
151 out = reencode_string_len(sb->buf, sb->len, to, from, &len);
152 if (!out)
153 return -1;
155 strbuf_attach(sb, out, len, len);
156 return 0;
159 void strbuf_tolower(struct strbuf *sb)
161 char *p = sb->buf, *end = sb->buf + sb->len;
162 for (; p < end; p++)
163 *p = tolower(*p);
166 struct strbuf **strbuf_split_buf(const char *str, size_t slen,
167 int terminator, int max)
169 struct strbuf **ret = NULL;
170 size_t nr = 0, alloc = 0;
171 struct strbuf *t;
173 while (slen) {
174 int len = slen;
175 if (max <= 0 || nr + 1 < max) {
176 const char *end = memchr(str, terminator, slen);
177 if (end)
178 len = end - str + 1;
180 t = xmalloc(sizeof(struct strbuf));
181 strbuf_init(t, len);
182 strbuf_add(t, str, len);
183 ALLOC_GROW(ret, nr + 2, alloc);
184 ret[nr++] = t;
185 str += len;
186 slen -= len;
188 ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
189 ret[nr] = NULL;
190 return ret;
193 void strbuf_add_separated_string_list(struct strbuf *str,
194 const char *sep,
195 struct string_list *slist)
197 struct string_list_item *item;
198 int sep_needed = 0;
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;
208 void strbuf_list_free(struct strbuf **sbs)
210 struct strbuf **s = sbs;
212 while (*s) {
213 strbuf_release(*s);
214 free(*s++);
216 free(sbs);
219 int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
221 size_t len = a->len < b->len ? a->len: b->len;
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;
228 void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
229 const void *data, size_t dlen)
231 if (unsigned_add_overflows(pos, len))
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");
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);
247 void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
249 strbuf_splice(sb, pos, 0, data, len);
252 void strbuf_vinsertf(struct strbuf *sb, size_t pos, const char *fmt, va_list ap)
254 int len, len2;
255 char save;
256 va_list cp;
258 if (pos > sb->len)
259 die("`pos' is too far after the end of the buffer");
260 va_copy(cp, ap);
261 len = vsnprintf(sb->buf + sb->len, 0, fmt, cp);
262 va_end(cp);
263 if (len < 0)
264 BUG("your vsnprintf is broken (returned %d)", len);
265 if (!len)
266 return; /* nothing to do */
267 if (unsigned_add_overflows(sb->len, len))
268 die("you want to use way too much memory");
269 strbuf_grow(sb, len);
270 memmove(sb->buf + pos + len, sb->buf + pos, sb->len - pos);
271 /* vsnprintf() will append a NUL, overwriting one of our characters */
272 save = sb->buf[pos + len];
273 len2 = vsnprintf(sb->buf + pos, len + 1, fmt, ap);
274 sb->buf[pos + len] = save;
275 if (len2 != len)
276 BUG("your vsnprintf is broken (returns inconsistent lengths)");
277 strbuf_setlen(sb, sb->len + len);
280 void strbuf_insertf(struct strbuf *sb, size_t pos, const char *fmt, ...)
282 va_list ap;
283 va_start(ap, fmt);
284 strbuf_vinsertf(sb, pos, fmt, ap);
285 va_end(ap);
288 void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
290 strbuf_splice(sb, pos, len, "", 0);
293 void strbuf_add(struct strbuf *sb, const void *data, size_t len)
295 strbuf_grow(sb, len);
296 memcpy(sb->buf + sb->len, data, len);
297 strbuf_setlen(sb, sb->len + len);
300 void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
302 strbuf_grow(sb, sb2->len);
303 memcpy(sb->buf + sb->len, sb2->buf, sb2->len);
304 strbuf_setlen(sb, sb->len + sb2->len);
307 const char *strbuf_join_argv(struct strbuf *buf,
308 int argc, const char **argv, char delim)
310 if (!argc)
311 return buf->buf;
313 strbuf_addstr(buf, *argv);
314 while (--argc) {
315 strbuf_addch(buf, delim);
316 strbuf_addstr(buf, *(++argv));
319 return buf->buf;
322 void strbuf_addchars(struct strbuf *sb, int c, size_t n)
324 strbuf_grow(sb, n);
325 memset(sb->buf + sb->len, c, n);
326 strbuf_setlen(sb, sb->len + n);
329 void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
331 va_list ap;
332 va_start(ap, fmt);
333 strbuf_vaddf(sb, fmt, ap);
334 va_end(ap);
337 static void add_lines(struct strbuf *out,
338 const char *prefix1,
339 const char *prefix2,
340 const char *buf, size_t size)
342 while (size) {
343 const char *prefix;
344 const char *next = memchr(buf, '\n', size);
345 next = next ? (next + 1) : (buf + size);
347 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
348 ? prefix2 : prefix1);
349 strbuf_addstr(out, prefix);
350 strbuf_add(out, buf, next - buf);
351 size -= next - buf;
352 buf = next;
354 strbuf_complete_line(out);
357 void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
359 static char prefix1[3];
360 static char prefix2[2];
362 if (prefix1[0] != comment_line_char) {
363 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
364 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
366 add_lines(out, prefix1, prefix2, buf, size);
369 void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
371 va_list params;
372 struct strbuf buf = STRBUF_INIT;
373 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
375 va_start(params, fmt);
376 strbuf_vaddf(&buf, fmt, params);
377 va_end(params);
379 strbuf_add_commented_lines(sb, buf.buf, buf.len);
380 if (incomplete_line)
381 sb->buf[--sb->len] = '\0';
383 strbuf_release(&buf);
386 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
388 int len;
389 va_list cp;
391 if (!strbuf_avail(sb))
392 strbuf_grow(sb, 64);
393 va_copy(cp, ap);
394 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
395 va_end(cp);
396 if (len < 0)
397 BUG("your vsnprintf is broken (returned %d)", len);
398 if (len > strbuf_avail(sb)) {
399 strbuf_grow(sb, len);
400 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
401 if (len > strbuf_avail(sb))
402 BUG("your vsnprintf is broken (insatiable)");
404 strbuf_setlen(sb, sb->len + len);
407 void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
408 void *context)
410 for (;;) {
411 const char *percent;
412 size_t consumed;
414 percent = strchrnul(format, '%');
415 strbuf_add(sb, format, percent - format);
416 if (!*percent)
417 break;
418 format = percent + 1;
420 if (*format == '%') {
421 strbuf_addch(sb, '%');
422 format++;
423 continue;
426 consumed = fn(sb, format, context);
427 if (consumed)
428 format += consumed;
429 else
430 strbuf_addch(sb, '%');
434 size_t strbuf_expand_literal_cb(struct strbuf *sb,
435 const char *placeholder,
436 void *context)
438 int ch;
440 switch (placeholder[0]) {
441 case 'n': /* newline */
442 strbuf_addch(sb, '\n');
443 return 1;
444 case 'x':
445 /* %x00 == NUL, %x0a == LF, etc. */
446 ch = hex2chr(placeholder + 1);
447 if (ch < 0)
448 return 0;
449 strbuf_addch(sb, ch);
450 return 3;
452 return 0;
455 size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
456 void *context)
458 struct strbuf_expand_dict_entry *e = context;
459 size_t len;
461 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
462 if (!strncmp(placeholder, e->placeholder, len)) {
463 if (e->value)
464 strbuf_addstr(sb, e->value);
465 return len;
468 return 0;
471 void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
473 size_t i, len = src->len;
475 for (i = 0; i < len; i++) {
476 if (src->buf[i] == '%')
477 strbuf_addch(dst, '%');
478 strbuf_addch(dst, src->buf[i]);
482 #define URL_UNSAFE_CHARS " <>\"%{}|\\^`:?#[]@!$&'()*+,;="
484 void strbuf_add_percentencode(struct strbuf *dst, const char *src, int flags)
486 size_t i, len = strlen(src);
488 for (i = 0; i < len; i++) {
489 unsigned char ch = src[i];
490 if (ch <= 0x1F || ch >= 0x7F ||
491 (ch == '/' && (flags & STRBUF_ENCODE_SLASH)) ||
492 strchr(URL_UNSAFE_CHARS, ch))
493 strbuf_addf(dst, "%%%02X", (unsigned char)ch);
494 else
495 strbuf_addch(dst, ch);
499 size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
501 size_t res;
502 size_t oldalloc = sb->alloc;
504 strbuf_grow(sb, size);
505 res = fread(sb->buf + sb->len, 1, size, f);
506 if (res > 0)
507 strbuf_setlen(sb, sb->len + res);
508 else if (oldalloc == 0)
509 strbuf_release(sb);
510 return res;
513 ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
515 size_t oldlen = sb->len;
516 size_t oldalloc = sb->alloc;
518 strbuf_grow(sb, hint ? hint : 8192);
519 for (;;) {
520 ssize_t want = sb->alloc - sb->len - 1;
521 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
523 if (got < 0) {
524 if (oldalloc == 0)
525 strbuf_release(sb);
526 else
527 strbuf_setlen(sb, oldlen);
528 return -1;
530 sb->len += got;
531 if (got < want)
532 break;
533 strbuf_grow(sb, 8192);
536 sb->buf[sb->len] = '\0';
537 return sb->len - oldlen;
540 ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint)
542 size_t oldalloc = sb->alloc;
543 ssize_t cnt;
545 strbuf_grow(sb, hint ? hint : 8192);
546 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
547 if (cnt > 0)
548 strbuf_setlen(sb, sb->len + cnt);
549 else if (oldalloc == 0)
550 strbuf_release(sb);
551 return cnt;
554 ssize_t strbuf_write(struct strbuf *sb, FILE *f)
556 return sb->len ? fwrite(sb->buf, 1, sb->len, f) : 0;
559 #define STRBUF_MAXLINK (2*PATH_MAX)
561 int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
563 size_t oldalloc = sb->alloc;
565 if (hint < 32)
566 hint = 32;
568 while (hint < STRBUF_MAXLINK) {
569 ssize_t len;
571 strbuf_grow(sb, hint);
572 len = readlink(path, sb->buf, hint);
573 if (len < 0) {
574 if (errno != ERANGE)
575 break;
576 } else if (len < hint) {
577 strbuf_setlen(sb, len);
578 return 0;
581 /* .. the buffer was too small - try again */
582 hint *= 2;
584 if (oldalloc == 0)
585 strbuf_release(sb);
586 return -1;
589 int strbuf_getcwd(struct strbuf *sb)
591 size_t oldalloc = sb->alloc;
592 size_t guessed_len = 128;
594 for (;; guessed_len *= 2) {
595 strbuf_grow(sb, guessed_len);
596 if (getcwd(sb->buf, sb->alloc)) {
597 strbuf_setlen(sb, strlen(sb->buf));
598 return 0;
602 * If getcwd(3) is implemented as a syscall that falls
603 * back to a regular lookup using readdir(3) etc. then
604 * we may be able to avoid EACCES by providing enough
605 * space to the syscall as it's not necessarily bound
606 * to the same restrictions as the fallback.
608 if (errno == EACCES && guessed_len < PATH_MAX)
609 continue;
611 if (errno != ERANGE)
612 break;
614 if (oldalloc == 0)
615 strbuf_release(sb);
616 else
617 strbuf_reset(sb);
618 return -1;
621 #ifdef HAVE_GETDELIM
622 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
624 ssize_t r;
626 if (feof(fp))
627 return EOF;
629 strbuf_reset(sb);
631 /* Translate slopbuf to NULL, as we cannot call realloc on it */
632 if (!sb->alloc)
633 sb->buf = NULL;
634 errno = 0;
635 r = getdelim(&sb->buf, &sb->alloc, term, fp);
637 if (r > 0) {
638 sb->len = r;
639 return 0;
641 assert(r == -1);
644 * Normally we would have called xrealloc, which will try to free
645 * memory and recover. But we have no way to tell getdelim() to do so.
646 * Worse, we cannot try to recover ENOMEM ourselves, because we have
647 * no idea how many bytes were read by getdelim.
649 * Dying here is reasonable. It mirrors what xrealloc would do on
650 * catastrophic memory failure. We skip the opportunity to free pack
651 * memory and retry, but that's unlikely to help for a malloc small
652 * enough to hold a single line of input, anyway.
654 if (errno == ENOMEM)
655 die("Out of memory, getdelim failed");
658 * Restore strbuf invariants; if getdelim left us with a NULL pointer,
659 * we can just re-init, but otherwise we should make sure that our
660 * length is empty, and that the result is NUL-terminated.
662 if (!sb->buf)
663 strbuf_init(sb, 0);
664 else
665 strbuf_reset(sb);
666 return EOF;
668 #else
669 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
671 int ch;
673 if (feof(fp))
674 return EOF;
676 strbuf_reset(sb);
677 flockfile(fp);
678 while ((ch = getc_unlocked(fp)) != EOF) {
679 if (!strbuf_avail(sb))
680 strbuf_grow(sb, 1);
681 sb->buf[sb->len++] = ch;
682 if (ch == term)
683 break;
685 funlockfile(fp);
686 if (ch == EOF && sb->len == 0)
687 return EOF;
689 sb->buf[sb->len] = '\0';
690 return 0;
692 #endif
694 int strbuf_appendwholeline(struct strbuf *sb, FILE *fp, int term)
696 struct strbuf line = STRBUF_INIT;
697 if (strbuf_getwholeline(&line, fp, term))
698 return EOF;
699 strbuf_addbuf(sb, &line);
700 strbuf_release(&line);
701 return 0;
704 static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
706 if (strbuf_getwholeline(sb, fp, term))
707 return EOF;
708 if (sb->buf[sb->len - 1] == term)
709 strbuf_setlen(sb, sb->len - 1);
710 return 0;
713 int strbuf_getline(struct strbuf *sb, FILE *fp)
715 if (strbuf_getwholeline(sb, fp, '\n'))
716 return EOF;
717 if (sb->buf[sb->len - 1] == '\n') {
718 strbuf_setlen(sb, sb->len - 1);
719 if (sb->len && sb->buf[sb->len - 1] == '\r')
720 strbuf_setlen(sb, sb->len - 1);
722 return 0;
725 int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
727 return strbuf_getdelim(sb, fp, '\n');
730 int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
732 return strbuf_getdelim(sb, fp, '\0');
735 int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
737 strbuf_reset(sb);
739 while (1) {
740 char ch;
741 ssize_t len = xread(fd, &ch, 1);
742 if (len <= 0)
743 return EOF;
744 strbuf_addch(sb, ch);
745 if (ch == term)
746 break;
748 return 0;
751 ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
753 int fd;
754 ssize_t len;
755 int saved_errno;
757 fd = open(path, O_RDONLY);
758 if (fd < 0)
759 return -1;
760 len = strbuf_read(sb, fd, hint);
761 saved_errno = errno;
762 close(fd);
763 if (len < 0) {
764 errno = saved_errno;
765 return -1;
768 return len;
771 void strbuf_add_lines(struct strbuf *out, const char *prefix,
772 const char *buf, size_t size)
774 add_lines(out, prefix, NULL, buf, size);
777 void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
779 while (*s) {
780 size_t len = strcspn(s, "\"<>&");
781 strbuf_add(buf, s, len);
782 s += len;
783 switch (*s) {
784 case '"':
785 strbuf_addstr(buf, "&quot;");
786 break;
787 case '<':
788 strbuf_addstr(buf, "&lt;");
789 break;
790 case '>':
791 strbuf_addstr(buf, "&gt;");
792 break;
793 case '&':
794 strbuf_addstr(buf, "&amp;");
795 break;
796 case 0:
797 return;
799 s++;
803 int is_rfc3986_reserved_or_unreserved(char ch)
805 if (is_rfc3986_unreserved(ch))
806 return 1;
807 switch (ch) {
808 case '!': case '*': case '\'': case '(': case ')': case ';':
809 case ':': case '@': case '&': case '=': case '+': case '$':
810 case ',': case '/': case '?': case '#': case '[': case ']':
811 return 1;
813 return 0;
816 int is_rfc3986_unreserved(char ch)
818 return isalnum(ch) ||
819 ch == '-' || ch == '_' || ch == '.' || ch == '~';
822 static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
823 char_predicate allow_unencoded_fn)
825 strbuf_grow(sb, len);
826 while (len--) {
827 char ch = *s++;
828 if (allow_unencoded_fn(ch))
829 strbuf_addch(sb, ch);
830 else
831 strbuf_addf(sb, "%%%02x", (unsigned char)ch);
835 void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
836 char_predicate allow_unencoded_fn)
838 strbuf_add_urlencode(sb, s, strlen(s), allow_unencoded_fn);
841 static void strbuf_humanise(struct strbuf *buf, off_t bytes,
842 int humanise_rate)
844 if (bytes > 1 << 30) {
845 strbuf_addf(buf,
846 humanise_rate == 0 ?
847 /* TRANSLATORS: IEC 80000-13:2008 gibibyte */
848 _("%u.%2.2u GiB") :
849 /* TRANSLATORS: IEC 80000-13:2008 gibibyte/second */
850 _("%u.%2.2u GiB/s"),
851 (unsigned)(bytes >> 30),
852 (unsigned)(bytes & ((1 << 30) - 1)) / 10737419);
853 } else if (bytes > 1 << 20) {
854 unsigned x = bytes + 5243; /* for rounding */
855 strbuf_addf(buf,
856 humanise_rate == 0 ?
857 /* TRANSLATORS: IEC 80000-13:2008 mebibyte */
858 _("%u.%2.2u MiB") :
859 /* TRANSLATORS: IEC 80000-13:2008 mebibyte/second */
860 _("%u.%2.2u MiB/s"),
861 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
862 } else if (bytes > 1 << 10) {
863 unsigned x = bytes + 5; /* for rounding */
864 strbuf_addf(buf,
865 humanise_rate == 0 ?
866 /* TRANSLATORS: IEC 80000-13:2008 kibibyte */
867 _("%u.%2.2u KiB") :
868 /* TRANSLATORS: IEC 80000-13:2008 kibibyte/second */
869 _("%u.%2.2u KiB/s"),
870 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
871 } else {
872 strbuf_addf(buf,
873 humanise_rate == 0 ?
874 /* TRANSLATORS: IEC 80000-13:2008 byte */
875 Q_("%u byte", "%u bytes", (unsigned)bytes) :
876 /* TRANSLATORS: IEC 80000-13:2008 byte/second */
877 Q_("%u byte/s", "%u bytes/s", (unsigned)bytes),
878 (unsigned)bytes);
882 void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
884 strbuf_humanise(buf, bytes, 0);
887 void strbuf_humanise_rate(struct strbuf *buf, off_t bytes)
889 strbuf_humanise(buf, bytes, 1);
892 void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
894 if (!*path)
895 die("The empty string is not a valid path");
896 if (!is_absolute_path(path)) {
897 struct stat cwd_stat, pwd_stat;
898 size_t orig_len = sb->len;
899 char *cwd = xgetcwd();
900 char *pwd = getenv("PWD");
901 if (pwd && strcmp(pwd, cwd) &&
902 !stat(cwd, &cwd_stat) &&
903 (cwd_stat.st_dev || cwd_stat.st_ino) &&
904 !stat(pwd, &pwd_stat) &&
905 pwd_stat.st_dev == cwd_stat.st_dev &&
906 pwd_stat.st_ino == cwd_stat.st_ino)
907 strbuf_addstr(sb, pwd);
908 else
909 strbuf_addstr(sb, cwd);
910 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
911 strbuf_addch(sb, '/');
912 free(cwd);
914 strbuf_addstr(sb, path);
917 void strbuf_add_real_path(struct strbuf *sb, const char *path)
919 if (sb->len) {
920 struct strbuf resolved = STRBUF_INIT;
921 strbuf_realpath(&resolved, path, 1);
922 strbuf_addbuf(sb, &resolved);
923 strbuf_release(&resolved);
924 } else
925 strbuf_realpath(sb, path, 1);
928 int printf_ln(const char *fmt, ...)
930 int ret;
931 va_list ap;
932 va_start(ap, fmt);
933 ret = vprintf(fmt, ap);
934 va_end(ap);
935 if (ret < 0 || putchar('\n') == EOF)
936 return -1;
937 return ret + 1;
940 int fprintf_ln(FILE *fp, const char *fmt, ...)
942 int ret;
943 va_list ap;
944 va_start(ap, fmt);
945 ret = vfprintf(fp, fmt, ap);
946 va_end(ap);
947 if (ret < 0 || putc('\n', fp) == EOF)
948 return -1;
949 return ret + 1;
952 char *xstrdup_tolower(const char *string)
954 char *result;
955 size_t len, i;
957 len = strlen(string);
958 result = xmallocz(len);
959 for (i = 0; i < len; i++)
960 result[i] = tolower(string[i]);
961 return result;
964 char *xstrdup_toupper(const char *string)
966 char *result;
967 size_t len, i;
969 len = strlen(string);
970 result = xmallocz(len);
971 for (i = 0; i < len; i++)
972 result[i] = toupper(string[i]);
973 return result;
976 char *xstrvfmt(const char *fmt, va_list ap)
978 struct strbuf buf = STRBUF_INIT;
979 strbuf_vaddf(&buf, fmt, ap);
980 return strbuf_detach(&buf, NULL);
983 char *xstrfmt(const char *fmt, ...)
985 va_list ap;
986 char *ret;
988 va_start(ap, fmt);
989 ret = xstrvfmt(fmt, ap);
990 va_end(ap);
992 return ret;
995 void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm,
996 int tz_offset, int suppress_tz_name)
998 struct strbuf munged_fmt = STRBUF_INIT;
999 size_t hint = 128;
1000 size_t len;
1002 if (!*fmt)
1003 return;
1006 * There is no portable way to pass timezone information to
1007 * strftime, so we handle %z and %Z here.
1009 for (;;) {
1010 const char *percent = strchrnul(fmt, '%');
1011 strbuf_add(&munged_fmt, fmt, percent - fmt);
1012 if (!*percent)
1013 break;
1014 fmt = percent + 1;
1015 switch (*fmt) {
1016 case '%':
1017 strbuf_addstr(&munged_fmt, "%%");
1018 fmt++;
1019 break;
1020 case 'z':
1021 strbuf_addf(&munged_fmt, "%+05d", tz_offset);
1022 fmt++;
1023 break;
1024 case 'Z':
1025 if (suppress_tz_name) {
1026 fmt++;
1027 break;
1029 /* FALLTHROUGH */
1030 default:
1031 strbuf_addch(&munged_fmt, '%');
1034 fmt = munged_fmt.buf;
1036 strbuf_grow(sb, hint);
1037 len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
1039 if (!len) {
1041 * strftime reports "0" if it could not fit the result in the buffer.
1042 * Unfortunately, it also reports "0" if the requested time string
1043 * takes 0 bytes. So our strategy is to munge the format so that the
1044 * output contains at least one character, and then drop the extra
1045 * character before returning.
1047 strbuf_addch(&munged_fmt, ' ');
1048 while (!len) {
1049 hint *= 2;
1050 strbuf_grow(sb, hint);
1051 len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
1052 munged_fmt.buf, tm);
1054 len--; /* drop munged space */
1056 strbuf_release(&munged_fmt);
1057 strbuf_setlen(sb, sb->len + len);
1060 void strbuf_add_unique_abbrev(struct strbuf *sb, const struct object_id *oid,
1061 int abbrev_len)
1063 int r;
1064 strbuf_grow(sb, GIT_MAX_HEXSZ + 1);
1065 r = find_unique_abbrev_r(sb->buf + sb->len, oid, abbrev_len);
1066 strbuf_setlen(sb, sb->len + r);
1070 * Returns the length of a line, without trailing spaces.
1072 * If the line ends with newline, it will be removed too.
1074 static size_t cleanup(char *line, size_t len)
1076 while (len) {
1077 unsigned char c = line[len - 1];
1078 if (!isspace(c))
1079 break;
1080 len--;
1083 return len;
1087 * Remove empty lines from the beginning and end
1088 * and also trailing spaces from every line.
1090 * Turn multiple consecutive empty lines between paragraphs
1091 * into just one empty line.
1093 * If the input has only empty lines and spaces,
1094 * no output will be produced.
1096 * If last line does not have a newline at the end, one is added.
1098 * Enable skip_comments to skip every line starting with comment
1099 * character.
1101 void strbuf_stripspace(struct strbuf *sb, int skip_comments)
1103 size_t empties = 0;
1104 size_t i, j, len, newlen;
1105 char *eol;
1107 /* We may have to add a newline. */
1108 strbuf_grow(sb, 1);
1110 for (i = j = 0; i < sb->len; i += len, j += newlen) {
1111 eol = memchr(sb->buf + i, '\n', sb->len - i);
1112 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
1114 if (skip_comments && len && sb->buf[i] == comment_line_char) {
1115 newlen = 0;
1116 continue;
1118 newlen = cleanup(sb->buf + i, len);
1120 /* Not just an empty line? */
1121 if (newlen) {
1122 if (empties > 0 && j > 0)
1123 sb->buf[j++] = '\n';
1124 empties = 0;
1125 memmove(sb->buf + j, sb->buf + i, newlen);
1126 sb->buf[newlen + j++] = '\n';
1127 } else {
1128 empties++;
1132 strbuf_setlen(sb, j);
1135 int strbuf_normalize_path(struct strbuf *src)
1137 struct strbuf dst = STRBUF_INIT;
1139 strbuf_grow(&dst, src->len);
1140 if (normalize_path_copy(dst.buf, src->buf) < 0) {
1141 strbuf_release(&dst);
1142 return -1;
1146 * normalize_path does not tell us the new length, so we have to
1147 * compute it by looking for the new NUL it placed
1149 strbuf_setlen(&dst, strlen(dst.buf));
1150 strbuf_swap(src, &dst);
1151 strbuf_release(&dst);
1152 return 0;
1155 int strbuf_edit_interactively(struct strbuf *buffer, const char *path,
1156 const char *const *env)
1158 char *path2 = NULL;
1159 int fd, res = 0;
1161 if (!is_absolute_path(path))
1162 path = path2 = xstrdup(git_path("%s", path));
1164 fd = open(path, O_WRONLY | O_CREAT | O_TRUNC, 0666);
1165 if (fd < 0)
1166 res = error_errno(_("could not open '%s' for writing"), path);
1167 else if (write_in_full(fd, buffer->buf, buffer->len) < 0) {
1168 res = error_errno(_("could not write to '%s'"), path);
1169 close(fd);
1170 } else if (close(fd) < 0)
1171 res = error_errno(_("could not close '%s'"), path);
1172 else {
1173 strbuf_reset(buffer);
1174 if (launch_editor(path, buffer, env) < 0)
1175 res = error_errno(_("could not edit '%s'"), path);
1176 unlink(path);
1179 free(path2);
1180 return res;