5 int starts_with(const char *str, const char *prefix)
7 for (; ; str++, prefix++)
10 else if (*str != *prefix)
14 int skip_to_optional_arg_default(const char *str, const char *prefix,
15 const char **arg, const char *def)
19 if (!skip_prefix(str, prefix, &p))
37 * Used as the default ->buf value, so that people can always assume
38 * buf is non NULL and ->buf is NUL terminated even for a freshly
41 char strbuf_slopbuf[1];
43 void strbuf_init(struct strbuf *sb, size_t hint)
45 sb->alloc = sb->len = 0;
46 sb->buf = strbuf_slopbuf;
48 strbuf_grow(sb, hint);
51 void strbuf_release(struct strbuf *sb)
59 char *strbuf_detach(struct strbuf *sb, size_t *sz)
70 void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
77 sb->buf[sb->len] = '\0';
80 void strbuf_grow(struct strbuf *sb, size_t extra)
82 int new_buf = !sb->alloc;
83 if (unsigned_add_overflows(extra, 1) ||
84 unsigned_add_overflows(sb->len, extra + 1))
85 die("you want to use way too much memory");
88 ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
93 void strbuf_trim(struct strbuf *sb)
98 void strbuf_rtrim(struct strbuf *sb)
100 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
102 sb->buf[sb->len] = '\0';
105 void strbuf_ltrim(struct strbuf *sb)
108 while (sb->len > 0 && isspace(*b)) {
112 memmove(sb->buf, b, sb->len);
113 sb->buf[sb->len] = '\0';
116 int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
121 if (same_encoding(from, to))
124 out = reencode_string_len(sb->buf, sb->len, to, from, &len);
128 strbuf_attach(sb, out, len, len);
132 void strbuf_tolower(struct strbuf *sb)
134 char *p = sb->buf, *end = sb->buf + sb->len;
139 struct strbuf **strbuf_split_buf(const char *str, size_t slen,
140 int terminator, int max)
142 struct strbuf **ret = NULL;
143 size_t nr = 0, alloc = 0;
148 if (max <= 0 || nr + 1 < max) {
149 const char *end = memchr(str, terminator, slen);
153 t = xmalloc(sizeof(struct strbuf));
155 strbuf_add(t, str, len);
156 ALLOC_GROW(ret, nr + 2, alloc);
161 ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
166 void strbuf_list_free(struct strbuf **sbs)
168 struct strbuf **s = sbs;
177 int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
179 int len = a->len < b->len ? a->len: b->len;
180 int cmp = memcmp(a->buf, b->buf, len);
183 return a->len < b->len ? -1: a->len != b->len;
186 void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
187 const void *data, size_t dlen)
189 if (unsigned_add_overflows(pos, len))
190 die("you want to use way too much memory");
192 die("`pos' is too far after the end of the buffer");
193 if (pos + len > sb->len)
194 die("`pos + len' is too far after the end of the buffer");
197 strbuf_grow(sb, dlen - len);
198 memmove(sb->buf + pos + dlen,
200 sb->len - pos - len);
201 memcpy(sb->buf + pos, data, dlen);
202 strbuf_setlen(sb, sb->len + dlen - len);
205 void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
207 strbuf_splice(sb, pos, 0, data, len);
210 void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
212 strbuf_splice(sb, pos, len, "", 0);
215 void strbuf_add(struct strbuf *sb, const void *data, size_t len)
217 strbuf_grow(sb, len);
218 memcpy(sb->buf + sb->len, data, len);
219 strbuf_setlen(sb, sb->len + len);
222 void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
224 strbuf_grow(sb, sb2->len);
225 memcpy(sb->buf + sb->len, sb2->buf, sb2->len);
226 strbuf_setlen(sb, sb->len + sb2->len);
229 void strbuf_addchars(struct strbuf *sb, int c, size_t n)
232 memset(sb->buf + sb->len, c, n);
233 strbuf_setlen(sb, sb->len + n);
236 void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
240 strbuf_vaddf(sb, fmt, ap);
244 static void add_lines(struct strbuf *out,
247 const char *buf, size_t size)
251 const char *next = memchr(buf, '\n', size);
252 next = next ? (next + 1) : (buf + size);
254 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
255 ? prefix2 : prefix1);
256 strbuf_addstr(out, prefix);
257 strbuf_add(out, buf, next - buf);
261 strbuf_complete_line(out);
264 void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
266 static char prefix1[3];
267 static char prefix2[2];
269 if (prefix1[0] != comment_line_char) {
270 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
271 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
273 add_lines(out, prefix1, prefix2, buf, size);
276 void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
279 struct strbuf buf = STRBUF_INIT;
280 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
282 va_start(params, fmt);
283 strbuf_vaddf(&buf, fmt, params);
286 strbuf_add_commented_lines(sb, buf.buf, buf.len);
288 sb->buf[--sb->len] = '\0';
290 strbuf_release(&buf);
293 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
298 if (!strbuf_avail(sb))
301 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
304 die("BUG: your vsnprintf is broken (returned %d)", len);
305 if (len > strbuf_avail(sb)) {
306 strbuf_grow(sb, len);
307 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
308 if (len > strbuf_avail(sb))
309 die("BUG: your vsnprintf is broken (insatiable)");
311 strbuf_setlen(sb, sb->len + len);
314 void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
321 percent = strchrnul(format, '%');
322 strbuf_add(sb, format, percent - format);
325 format = percent + 1;
327 if (*format == '%') {
328 strbuf_addch(sb, '%');
333 consumed = fn(sb, format, context);
337 strbuf_addch(sb, '%');
341 size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
344 struct strbuf_expand_dict_entry *e = context;
347 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
348 if (!strncmp(placeholder, e->placeholder, len)) {
350 strbuf_addstr(sb, e->value);
357 void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
359 int i, len = src->len;
361 for (i = 0; i < len; i++) {
362 if (src->buf[i] == '%')
363 strbuf_addch(dst, '%');
364 strbuf_addch(dst, src->buf[i]);
368 size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
371 size_t oldalloc = sb->alloc;
373 strbuf_grow(sb, size);
374 res = fread(sb->buf + sb->len, 1, size, f);
376 strbuf_setlen(sb, sb->len + res);
377 else if (oldalloc == 0)
382 ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
384 size_t oldlen = sb->len;
385 size_t oldalloc = sb->alloc;
387 strbuf_grow(sb, hint ? hint : 8192);
389 ssize_t want = sb->alloc - sb->len - 1;
390 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
396 strbuf_setlen(sb, oldlen);
402 strbuf_grow(sb, 8192);
405 sb->buf[sb->len] = '\0';
406 return sb->len - oldlen;
409 ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint)
411 size_t oldalloc = sb->alloc;
414 strbuf_grow(sb, hint ? hint : 8192);
415 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
417 strbuf_setlen(sb, sb->len + cnt);
418 else if (oldalloc == 0)
423 ssize_t strbuf_write(struct strbuf *sb, FILE *f)
425 return sb->len ? fwrite(sb->buf, 1, sb->len, f) : 0;
429 #define STRBUF_MAXLINK (2*PATH_MAX)
431 int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
433 size_t oldalloc = sb->alloc;
438 while (hint < STRBUF_MAXLINK) {
441 strbuf_grow(sb, hint);
442 len = readlink(path, sb->buf, hint);
446 } else if (len < hint) {
447 strbuf_setlen(sb, len);
451 /* .. the buffer was too small - try again */
459 int strbuf_getcwd(struct strbuf *sb)
461 size_t oldalloc = sb->alloc;
462 size_t guessed_len = 128;
464 for (;; guessed_len *= 2) {
465 strbuf_grow(sb, guessed_len);
466 if (getcwd(sb->buf, sb->alloc)) {
467 strbuf_setlen(sb, strlen(sb->buf));
472 * If getcwd(3) is implemented as a syscall that falls
473 * back to a regular lookup using readdir(3) etc. then
474 * we may be able to avoid EACCES by providing enough
475 * space to the syscall as it's not necessarily bound
476 * to the same restrictions as the fallback.
478 if (errno == EACCES && guessed_len < PATH_MAX)
492 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
501 /* Translate slopbuf to NULL, as we cannot call realloc on it */
505 r = getdelim(&sb->buf, &sb->alloc, term, fp);
514 * Normally we would have called xrealloc, which will try to free
515 * memory and recover. But we have no way to tell getdelim() to do so.
516 * Worse, we cannot try to recover ENOMEM ourselves, because we have
517 * no idea how many bytes were read by getdelim.
519 * Dying here is reasonable. It mirrors what xrealloc would do on
520 * catastrophic memory failure. We skip the opportunity to free pack
521 * memory and retry, but that's unlikely to help for a malloc small
522 * enough to hold a single line of input, anyway.
525 die("Out of memory, getdelim failed");
528 * Restore strbuf invariants; if getdelim left us with a NULL pointer,
529 * we can just re-init, but otherwise we should make sure that our
530 * length is empty, and that the result is NUL-terminated.
539 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
548 while ((ch = getc_unlocked(fp)) != EOF) {
549 if (!strbuf_avail(sb))
551 sb->buf[sb->len++] = ch;
556 if (ch == EOF && sb->len == 0)
559 sb->buf[sb->len] = '\0';
564 static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
566 if (strbuf_getwholeline(sb, fp, term))
568 if (sb->buf[sb->len - 1] == term)
569 strbuf_setlen(sb, sb->len - 1);
573 int strbuf_getline(struct strbuf *sb, FILE *fp)
575 if (strbuf_getwholeline(sb, fp, '\n'))
577 if (sb->buf[sb->len - 1] == '\n') {
578 strbuf_setlen(sb, sb->len - 1);
579 if (sb->len && sb->buf[sb->len - 1] == '\r')
580 strbuf_setlen(sb, sb->len - 1);
585 int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
587 return strbuf_getdelim(sb, fp, '\n');
590 int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
592 return strbuf_getdelim(sb, fp, '\0');
595 int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
601 ssize_t len = xread(fd, &ch, 1);
604 strbuf_addch(sb, ch);
611 ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
617 fd = open(path, O_RDONLY);
620 len = strbuf_read(sb, fd, hint);
631 void strbuf_add_lines(struct strbuf *out, const char *prefix,
632 const char *buf, size_t size)
634 add_lines(out, prefix, NULL, buf, size);
637 void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
640 size_t len = strcspn(s, "\"<>&");
641 strbuf_add(buf, s, len);
645 strbuf_addstr(buf, """);
648 strbuf_addstr(buf, "<");
651 strbuf_addstr(buf, ">");
654 strbuf_addstr(buf, "&");
663 static int is_rfc3986_reserved(char ch)
666 case '!': case '*': case '\'': case '(': case ')': case ';':
667 case ':': case '@': case '&': case '=': case '+': case '$':
668 case ',': case '/': case '?': case '#': case '[': case ']':
674 static int is_rfc3986_unreserved(char ch)
676 return isalnum(ch) ||
677 ch == '-' || ch == '_' || ch == '.' || ch == '~';
680 static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
683 strbuf_grow(sb, len);
686 if (is_rfc3986_unreserved(ch) ||
687 (!reserved && is_rfc3986_reserved(ch)))
688 strbuf_addch(sb, ch);
690 strbuf_addf(sb, "%%%02x", (unsigned char)ch);
694 void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
697 strbuf_add_urlencode(sb, s, strlen(s), reserved);
700 void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
702 if (bytes > 1 << 30) {
703 strbuf_addf(buf, "%u.%2.2u GiB",
705 (int)(bytes & ((1 << 30) - 1)) / 10737419);
706 } else if (bytes > 1 << 20) {
707 int x = bytes + 5243; /* for rounding */
708 strbuf_addf(buf, "%u.%2.2u MiB",
709 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
710 } else if (bytes > 1 << 10) {
711 int x = bytes + 5; /* for rounding */
712 strbuf_addf(buf, "%u.%2.2u KiB",
713 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
715 strbuf_addf(buf, "%u bytes", (int)bytes);
719 void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
722 die("The empty string is not a valid path");
723 if (!is_absolute_path(path)) {
724 struct stat cwd_stat, pwd_stat;
725 size_t orig_len = sb->len;
726 char *cwd = xgetcwd();
727 char *pwd = getenv("PWD");
728 if (pwd && strcmp(pwd, cwd) &&
729 !stat(cwd, &cwd_stat) &&
730 (cwd_stat.st_dev || cwd_stat.st_ino) &&
731 !stat(pwd, &pwd_stat) &&
732 pwd_stat.st_dev == cwd_stat.st_dev &&
733 pwd_stat.st_ino == cwd_stat.st_ino)
734 strbuf_addstr(sb, pwd);
736 strbuf_addstr(sb, cwd);
737 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
738 strbuf_addch(sb, '/');
741 strbuf_addstr(sb, path);
744 void strbuf_add_real_path(struct strbuf *sb, const char *path)
747 struct strbuf resolved = STRBUF_INIT;
748 strbuf_realpath(&resolved, path, 1);
749 strbuf_addbuf(sb, &resolved);
750 strbuf_release(&resolved);
752 strbuf_realpath(sb, path, 1);
755 int printf_ln(const char *fmt, ...)
760 ret = vprintf(fmt, ap);
762 if (ret < 0 || putchar('\n') == EOF)
767 int fprintf_ln(FILE *fp, const char *fmt, ...)
772 ret = vfprintf(fp, fmt, ap);
774 if (ret < 0 || putc('\n', fp) == EOF)
779 char *xstrdup_tolower(const char *string)
784 len = strlen(string);
785 result = xmallocz(len);
786 for (i = 0; i < len; i++)
787 result[i] = tolower(string[i]);
792 char *xstrvfmt(const char *fmt, va_list ap)
794 struct strbuf buf = STRBUF_INIT;
795 strbuf_vaddf(&buf, fmt, ap);
796 return strbuf_detach(&buf, NULL);
799 char *xstrfmt(const char *fmt, ...)
805 ret = xstrvfmt(fmt, ap);
811 void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm,
812 int tz_offset, int suppress_tz_name)
814 struct strbuf munged_fmt = STRBUF_INIT;
822 * There is no portable way to pass timezone information to
823 * strftime, so we handle %z and %Z here.
826 const char *percent = strchrnul(fmt, '%');
827 strbuf_add(&munged_fmt, fmt, percent - fmt);
833 strbuf_addstr(&munged_fmt, "%%");
837 strbuf_addf(&munged_fmt, "%+05d", tz_offset);
841 if (suppress_tz_name) {
847 strbuf_addch(&munged_fmt, '%');
850 fmt = munged_fmt.buf;
852 strbuf_grow(sb, hint);
853 len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
857 * strftime reports "0" if it could not fit the result in the buffer.
858 * Unfortunately, it also reports "0" if the requested time string
859 * takes 0 bytes. So our strategy is to munge the format so that the
860 * output contains at least one character, and then drop the extra
861 * character before returning.
863 strbuf_addch(&munged_fmt, ' ');
866 strbuf_grow(sb, hint);
867 len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
870 len--; /* drop munged space */
872 strbuf_release(&munged_fmt);
873 strbuf_setlen(sb, sb->len + len);
876 void strbuf_add_unique_abbrev(struct strbuf *sb, const unsigned char *sha1,
880 strbuf_grow(sb, GIT_SHA1_HEXSZ + 1);
881 r = find_unique_abbrev_r(sb->buf + sb->len, sha1, abbrev_len);
882 strbuf_setlen(sb, sb->len + r);
886 * Returns the length of a line, without trailing spaces.
888 * If the line ends with newline, it will be removed too.
890 static size_t cleanup(char *line, size_t len)
893 unsigned char c = line[len - 1];
903 * Remove empty lines from the beginning and end
904 * and also trailing spaces from every line.
906 * Turn multiple consecutive empty lines between paragraphs
907 * into just one empty line.
909 * If the input has only empty lines and spaces,
910 * no output will be produced.
912 * If last line does not have a newline at the end, one is added.
914 * Enable skip_comments to skip every line starting with comment
917 void strbuf_stripspace(struct strbuf *sb, int skip_comments)
920 size_t i, j, len, newlen;
923 /* We may have to add a newline. */
926 for (i = j = 0; i < sb->len; i += len, j += newlen) {
927 eol = memchr(sb->buf + i, '\n', sb->len - i);
928 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
930 if (skip_comments && len && sb->buf[i] == comment_line_char) {
934 newlen = cleanup(sb->buf + i, len);
936 /* Not just an empty line? */
938 if (empties > 0 && j > 0)
941 memmove(sb->buf + j, sb->buf + i, newlen);
942 sb->buf[newlen + j++] = '\n';
948 strbuf_setlen(sb, j);
951 int strbuf_normalize_path(struct strbuf *src)
953 struct strbuf dst = STRBUF_INIT;
955 strbuf_grow(&dst, src->len);
956 if (normalize_path_copy(dst.buf, src->buf) < 0) {
957 strbuf_release(&dst);
962 * normalize_path does not tell us the new length, so we have to
963 * compute it by looking for the new NUL it placed
965 strbuf_setlen(&dst, strlen(dst.buf));
966 strbuf_swap(src, &dst);
967 strbuf_release(&dst);