5 int starts_with(const char *str, const char *prefix)
7 for (; ; str++, prefix++)
10 else if (*str != *prefix)
14 int istarts_with(const char *str, const char *prefix)
16 for (; ; str++, prefix++)
19 else if (tolower(*str) != tolower(*prefix))
23 int skip_to_optional_arg_default(const char *str, const char *prefix,
24 const char **arg, const char *def)
28 if (!skip_prefix(str, prefix, &p))
46 * Used as the default ->buf value, so that people can always assume
47 * buf is non NULL and ->buf is NUL terminated even for a freshly
50 char strbuf_slopbuf[1];
52 void strbuf_init(struct strbuf *sb, size_t hint)
54 sb->alloc = sb->len = 0;
55 sb->buf = strbuf_slopbuf;
57 strbuf_grow(sb, hint);
60 void strbuf_release(struct strbuf *sb)
68 char *strbuf_detach(struct strbuf *sb, size_t *sz)
79 void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
86 sb->buf[sb->len] = '\0';
89 void strbuf_grow(struct strbuf *sb, size_t extra)
91 int new_buf = !sb->alloc;
92 if (unsigned_add_overflows(extra, 1) ||
93 unsigned_add_overflows(sb->len, extra + 1))
94 die("you want to use way too much memory");
97 ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
102 void strbuf_trim(struct strbuf *sb)
108 void strbuf_rtrim(struct strbuf *sb)
110 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
112 sb->buf[sb->len] = '\0';
115 void strbuf_trim_trailing_dir_sep(struct strbuf *sb)
117 while (sb->len > 0 && is_dir_sep((unsigned char)sb->buf[sb->len - 1]))
119 sb->buf[sb->len] = '\0';
122 void strbuf_ltrim(struct strbuf *sb)
125 while (sb->len > 0 && isspace(*b)) {
129 memmove(sb->buf, b, sb->len);
130 sb->buf[sb->len] = '\0';
133 int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
138 if (same_encoding(from, to))
141 out = reencode_string_len(sb->buf, sb->len, to, from, &len);
145 strbuf_attach(sb, out, len, len);
149 void strbuf_tolower(struct strbuf *sb)
151 char *p = sb->buf, *end = sb->buf + sb->len;
156 struct strbuf **strbuf_split_buf(const char *str, size_t slen,
157 int terminator, int max)
159 struct strbuf **ret = NULL;
160 size_t nr = 0, alloc = 0;
165 if (max <= 0 || nr + 1 < max) {
166 const char *end = memchr(str, terminator, slen);
170 t = xmalloc(sizeof(struct strbuf));
172 strbuf_add(t, str, len);
173 ALLOC_GROW(ret, nr + 2, alloc);
178 ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
183 void strbuf_list_free(struct strbuf **sbs)
185 struct strbuf **s = sbs;
194 int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
196 int len = a->len < b->len ? a->len: b->len;
197 int cmp = memcmp(a->buf, b->buf, len);
200 return a->len < b->len ? -1: a->len != b->len;
203 void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
204 const void *data, size_t dlen)
206 if (unsigned_add_overflows(pos, len))
207 die("you want to use way too much memory");
209 die("`pos' is too far after the end of the buffer");
210 if (pos + len > sb->len)
211 die("`pos + len' is too far after the end of the buffer");
214 strbuf_grow(sb, dlen - len);
215 memmove(sb->buf + pos + dlen,
217 sb->len - pos - len);
218 memcpy(sb->buf + pos, data, dlen);
219 strbuf_setlen(sb, sb->len + dlen - len);
222 void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
224 strbuf_splice(sb, pos, 0, data, len);
227 void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
229 strbuf_splice(sb, pos, len, "", 0);
232 void strbuf_add(struct strbuf *sb, const void *data, size_t len)
234 strbuf_grow(sb, len);
235 memcpy(sb->buf + sb->len, data, len);
236 strbuf_setlen(sb, sb->len + len);
239 void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
241 strbuf_grow(sb, sb2->len);
242 memcpy(sb->buf + sb->len, sb2->buf, sb2->len);
243 strbuf_setlen(sb, sb->len + sb2->len);
246 void strbuf_addchars(struct strbuf *sb, int c, size_t n)
249 memset(sb->buf + sb->len, c, n);
250 strbuf_setlen(sb, sb->len + n);
253 void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
257 strbuf_vaddf(sb, fmt, ap);
261 static void add_lines(struct strbuf *out,
264 const char *buf, size_t size)
268 const char *next = memchr(buf, '\n', size);
269 next = next ? (next + 1) : (buf + size);
271 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
272 ? prefix2 : prefix1);
273 strbuf_addstr(out, prefix);
274 strbuf_add(out, buf, next - buf);
278 strbuf_complete_line(out);
281 void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
283 static char prefix1[3];
284 static char prefix2[2];
286 if (prefix1[0] != comment_line_char) {
287 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
288 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
290 add_lines(out, prefix1, prefix2, buf, size);
293 void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
296 struct strbuf buf = STRBUF_INIT;
297 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
299 va_start(params, fmt);
300 strbuf_vaddf(&buf, fmt, params);
303 strbuf_add_commented_lines(sb, buf.buf, buf.len);
305 sb->buf[--sb->len] = '\0';
307 strbuf_release(&buf);
310 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
315 if (!strbuf_avail(sb))
318 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
321 die("BUG: your vsnprintf is broken (returned %d)", len);
322 if (len > strbuf_avail(sb)) {
323 strbuf_grow(sb, len);
324 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
325 if (len > strbuf_avail(sb))
326 die("BUG: your vsnprintf is broken (insatiable)");
328 strbuf_setlen(sb, sb->len + len);
331 void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
338 percent = strchrnul(format, '%');
339 strbuf_add(sb, format, percent - format);
342 format = percent + 1;
344 if (*format == '%') {
345 strbuf_addch(sb, '%');
350 consumed = fn(sb, format, context);
354 strbuf_addch(sb, '%');
358 size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
361 struct strbuf_expand_dict_entry *e = context;
364 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
365 if (!strncmp(placeholder, e->placeholder, len)) {
367 strbuf_addstr(sb, e->value);
374 void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
376 int i, len = src->len;
378 for (i = 0; i < len; i++) {
379 if (src->buf[i] == '%')
380 strbuf_addch(dst, '%');
381 strbuf_addch(dst, src->buf[i]);
385 size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
388 size_t oldalloc = sb->alloc;
390 strbuf_grow(sb, size);
391 res = fread(sb->buf + sb->len, 1, size, f);
393 strbuf_setlen(sb, sb->len + res);
394 else if (oldalloc == 0)
399 ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
401 size_t oldlen = sb->len;
402 size_t oldalloc = sb->alloc;
404 strbuf_grow(sb, hint ? hint : 8192);
406 ssize_t want = sb->alloc - sb->len - 1;
407 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
413 strbuf_setlen(sb, oldlen);
419 strbuf_grow(sb, 8192);
422 sb->buf[sb->len] = '\0';
423 return sb->len - oldlen;
426 ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint)
428 size_t oldalloc = sb->alloc;
431 strbuf_grow(sb, hint ? hint : 8192);
432 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
434 strbuf_setlen(sb, sb->len + cnt);
435 else if (oldalloc == 0)
440 ssize_t strbuf_write(struct strbuf *sb, FILE *f)
442 return sb->len ? fwrite(sb->buf, 1, sb->len, f) : 0;
446 #define STRBUF_MAXLINK (2*PATH_MAX)
448 int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
450 size_t oldalloc = sb->alloc;
455 while (hint < STRBUF_MAXLINK) {
458 strbuf_grow(sb, hint);
459 len = readlink(path, sb->buf, hint);
463 } else if (len < hint) {
464 strbuf_setlen(sb, len);
468 /* .. the buffer was too small - try again */
476 int strbuf_getcwd(struct strbuf *sb)
478 size_t oldalloc = sb->alloc;
479 size_t guessed_len = 128;
481 for (;; guessed_len *= 2) {
482 strbuf_grow(sb, guessed_len);
483 if (getcwd(sb->buf, sb->alloc)) {
484 strbuf_setlen(sb, strlen(sb->buf));
489 * If getcwd(3) is implemented as a syscall that falls
490 * back to a regular lookup using readdir(3) etc. then
491 * we may be able to avoid EACCES by providing enough
492 * space to the syscall as it's not necessarily bound
493 * to the same restrictions as the fallback.
495 if (errno == EACCES && guessed_len < PATH_MAX)
509 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
518 /* Translate slopbuf to NULL, as we cannot call realloc on it */
522 r = getdelim(&sb->buf, &sb->alloc, term, fp);
531 * Normally we would have called xrealloc, which will try to free
532 * memory and recover. But we have no way to tell getdelim() to do so.
533 * Worse, we cannot try to recover ENOMEM ourselves, because we have
534 * no idea how many bytes were read by getdelim.
536 * Dying here is reasonable. It mirrors what xrealloc would do on
537 * catastrophic memory failure. We skip the opportunity to free pack
538 * memory and retry, but that's unlikely to help for a malloc small
539 * enough to hold a single line of input, anyway.
542 die("Out of memory, getdelim failed");
545 * Restore strbuf invariants; if getdelim left us with a NULL pointer,
546 * we can just re-init, but otherwise we should make sure that our
547 * length is empty, and that the result is NUL-terminated.
556 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
565 while ((ch = getc_unlocked(fp)) != EOF) {
566 if (!strbuf_avail(sb))
568 sb->buf[sb->len++] = ch;
573 if (ch == EOF && sb->len == 0)
576 sb->buf[sb->len] = '\0';
581 static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
583 if (strbuf_getwholeline(sb, fp, term))
585 if (sb->buf[sb->len - 1] == term)
586 strbuf_setlen(sb, sb->len - 1);
590 int strbuf_getline(struct strbuf *sb, FILE *fp)
592 if (strbuf_getwholeline(sb, fp, '\n'))
594 if (sb->buf[sb->len - 1] == '\n') {
595 strbuf_setlen(sb, sb->len - 1);
596 if (sb->len && sb->buf[sb->len - 1] == '\r')
597 strbuf_setlen(sb, sb->len - 1);
602 int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
604 return strbuf_getdelim(sb, fp, '\n');
607 int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
609 return strbuf_getdelim(sb, fp, '\0');
612 int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
618 ssize_t len = xread(fd, &ch, 1);
621 strbuf_addch(sb, ch);
628 ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
634 fd = open(path, O_RDONLY);
637 len = strbuf_read(sb, fd, hint);
648 void strbuf_add_lines(struct strbuf *out, const char *prefix,
649 const char *buf, size_t size)
651 add_lines(out, prefix, NULL, buf, size);
654 void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
657 size_t len = strcspn(s, "\"<>&");
658 strbuf_add(buf, s, len);
662 strbuf_addstr(buf, """);
665 strbuf_addstr(buf, "<");
668 strbuf_addstr(buf, ">");
671 strbuf_addstr(buf, "&");
680 static int is_rfc3986_reserved(char ch)
683 case '!': case '*': case '\'': case '(': case ')': case ';':
684 case ':': case '@': case '&': case '=': case '+': case '$':
685 case ',': case '/': case '?': case '#': case '[': case ']':
691 static int is_rfc3986_unreserved(char ch)
693 return isalnum(ch) ||
694 ch == '-' || ch == '_' || ch == '.' || ch == '~';
697 static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
700 strbuf_grow(sb, len);
703 if (is_rfc3986_unreserved(ch) ||
704 (!reserved && is_rfc3986_reserved(ch)))
705 strbuf_addch(sb, ch);
707 strbuf_addf(sb, "%%%02x", (unsigned char)ch);
711 void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
714 strbuf_add_urlencode(sb, s, strlen(s), reserved);
717 void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
719 if (bytes > 1 << 30) {
720 strbuf_addf(buf, "%u.%2.2u GiB",
722 (int)(bytes & ((1 << 30) - 1)) / 10737419);
723 } else if (bytes > 1 << 20) {
724 int x = bytes + 5243; /* for rounding */
725 strbuf_addf(buf, "%u.%2.2u MiB",
726 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
727 } else if (bytes > 1 << 10) {
728 int x = bytes + 5; /* for rounding */
729 strbuf_addf(buf, "%u.%2.2u KiB",
730 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
732 strbuf_addf(buf, "%u bytes", (int)bytes);
736 void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
739 die("The empty string is not a valid path");
740 if (!is_absolute_path(path)) {
741 struct stat cwd_stat, pwd_stat;
742 size_t orig_len = sb->len;
743 char *cwd = xgetcwd();
744 char *pwd = getenv("PWD");
745 if (pwd && strcmp(pwd, cwd) &&
746 !stat(cwd, &cwd_stat) &&
747 (cwd_stat.st_dev || cwd_stat.st_ino) &&
748 !stat(pwd, &pwd_stat) &&
749 pwd_stat.st_dev == cwd_stat.st_dev &&
750 pwd_stat.st_ino == cwd_stat.st_ino)
751 strbuf_addstr(sb, pwd);
753 strbuf_addstr(sb, cwd);
754 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
755 strbuf_addch(sb, '/');
758 strbuf_addstr(sb, path);
761 void strbuf_add_real_path(struct strbuf *sb, const char *path)
764 struct strbuf resolved = STRBUF_INIT;
765 strbuf_realpath(&resolved, path, 1);
766 strbuf_addbuf(sb, &resolved);
767 strbuf_release(&resolved);
769 strbuf_realpath(sb, path, 1);
772 int printf_ln(const char *fmt, ...)
777 ret = vprintf(fmt, ap);
779 if (ret < 0 || putchar('\n') == EOF)
784 int fprintf_ln(FILE *fp, const char *fmt, ...)
789 ret = vfprintf(fp, fmt, ap);
791 if (ret < 0 || putc('\n', fp) == EOF)
796 char *xstrdup_tolower(const char *string)
801 len = strlen(string);
802 result = xmallocz(len);
803 for (i = 0; i < len; i++)
804 result[i] = tolower(string[i]);
808 char *xstrdup_toupper(const char *string)
813 len = strlen(string);
814 result = xmallocz(len);
815 for (i = 0; i < len; i++)
816 result[i] = toupper(string[i]);
820 char *xstrvfmt(const char *fmt, va_list ap)
822 struct strbuf buf = STRBUF_INIT;
823 strbuf_vaddf(&buf, fmt, ap);
824 return strbuf_detach(&buf, NULL);
827 char *xstrfmt(const char *fmt, ...)
833 ret = xstrvfmt(fmt, ap);
839 void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm,
840 int tz_offset, int suppress_tz_name)
842 struct strbuf munged_fmt = STRBUF_INIT;
850 * There is no portable way to pass timezone information to
851 * strftime, so we handle %z and %Z here.
854 const char *percent = strchrnul(fmt, '%');
855 strbuf_add(&munged_fmt, fmt, percent - fmt);
861 strbuf_addstr(&munged_fmt, "%%");
865 strbuf_addf(&munged_fmt, "%+05d", tz_offset);
869 if (suppress_tz_name) {
875 strbuf_addch(&munged_fmt, '%');
878 fmt = munged_fmt.buf;
880 strbuf_grow(sb, hint);
881 len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
885 * strftime reports "0" if it could not fit the result in the buffer.
886 * Unfortunately, it also reports "0" if the requested time string
887 * takes 0 bytes. So our strategy is to munge the format so that the
888 * output contains at least one character, and then drop the extra
889 * character before returning.
891 strbuf_addch(&munged_fmt, ' ');
894 strbuf_grow(sb, hint);
895 len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
898 len--; /* drop munged space */
900 strbuf_release(&munged_fmt);
901 strbuf_setlen(sb, sb->len + len);
904 void strbuf_add_unique_abbrev(struct strbuf *sb, const struct object_id *oid,
908 strbuf_grow(sb, GIT_SHA1_HEXSZ + 1);
909 r = find_unique_abbrev_r(sb->buf + sb->len, oid, abbrev_len);
910 strbuf_setlen(sb, sb->len + r);
914 * Returns the length of a line, without trailing spaces.
916 * If the line ends with newline, it will be removed too.
918 static size_t cleanup(char *line, size_t len)
921 unsigned char c = line[len - 1];
931 * Remove empty lines from the beginning and end
932 * and also trailing spaces from every line.
934 * Turn multiple consecutive empty lines between paragraphs
935 * into just one empty line.
937 * If the input has only empty lines and spaces,
938 * no output will be produced.
940 * If last line does not have a newline at the end, one is added.
942 * Enable skip_comments to skip every line starting with comment
945 void strbuf_stripspace(struct strbuf *sb, int skip_comments)
948 size_t i, j, len, newlen;
951 /* We may have to add a newline. */
954 for (i = j = 0; i < sb->len; i += len, j += newlen) {
955 eol = memchr(sb->buf + i, '\n', sb->len - i);
956 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
958 if (skip_comments && len && sb->buf[i] == comment_line_char) {
962 newlen = cleanup(sb->buf + i, len);
964 /* Not just an empty line? */
966 if (empties > 0 && j > 0)
969 memmove(sb->buf + j, sb->buf + i, newlen);
970 sb->buf[newlen + j++] = '\n';
976 strbuf_setlen(sb, j);
979 int strbuf_normalize_path(struct strbuf *src)
981 struct strbuf dst = STRBUF_INIT;
983 strbuf_grow(&dst, src->len);
984 if (normalize_path_copy(dst.buf, src->buf) < 0) {
985 strbuf_release(&dst);
990 * normalize_path does not tell us the new length, so we have to
991 * compute it by looking for the new NUL it placed
993 strbuf_setlen(&dst, strlen(dst.buf));
994 strbuf_swap(src, &dst);
995 strbuf_release(&dst);