3 #include "string-list.h"
6 int starts_with(const char *str, const char *prefix)
8 for (; ; str++, prefix++)
11 else if (*str != *prefix)
15 int istarts_with(const char *str, const char *prefix)
17 for (; ; str++, prefix++)
20 else if (tolower(*str) != tolower(*prefix))
24 int skip_to_optional_arg_default(const char *str, const char *prefix,
25 const char **arg, const char *def)
29 if (!skip_prefix(str, prefix, &p))
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
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;
58 strbuf_grow(sb, hint);
61 void strbuf_release(struct strbuf *sb)
69 char *strbuf_detach(struct strbuf *sb, size_t *sz)
80 void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
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");
98 ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
103 void strbuf_trim(struct strbuf *sb)
109 void strbuf_rtrim(struct strbuf *sb)
111 while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
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]))
120 sb->buf[sb->len] = '\0';
123 void strbuf_ltrim(struct strbuf *sb)
126 while (sb->len > 0 && isspace(*b)) {
130 memmove(sb->buf, b, sb->len);
131 sb->buf[sb->len] = '\0';
134 int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
139 if (same_encoding(from, to))
142 out = reencode_string_len(sb->buf, sb->len, to, from, &len);
146 strbuf_attach(sb, out, len, len);
150 void strbuf_tolower(struct strbuf *sb)
152 char *p = sb->buf, *end = sb->buf + sb->len;
157 struct strbuf **strbuf_split_buf(const char *str, size_t slen,
158 int terminator, int max)
160 struct strbuf **ret = NULL;
161 size_t nr = 0, alloc = 0;
166 if (max <= 0 || nr + 1 < max) {
167 const char *end = memchr(str, terminator, slen);
171 t = xmalloc(sizeof(struct strbuf));
173 strbuf_add(t, str, len);
174 ALLOC_GROW(ret, nr + 2, alloc);
179 ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
184 void strbuf_add_separated_string_list(struct strbuf *str,
186 struct string_list *slist)
188 struct string_list_item *item;
191 for_each_string_list_item(item, slist) {
193 strbuf_addstr(str, sep);
194 strbuf_addstr(str, item->string);
199 void strbuf_list_free(struct strbuf **sbs)
201 struct strbuf **s = sbs;
210 int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
212 size_t len = a->len < b->len ? a->len: b->len;
213 int cmp = memcmp(a->buf, b->buf, len);
216 return a->len < b->len ? -1: a->len != b->len;
219 void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
220 const void *data, size_t dlen)
222 if (unsigned_add_overflows(pos, len))
223 die("you want to use way too much memory");
225 die("`pos' is too far after the end of the buffer");
226 if (pos + len > sb->len)
227 die("`pos + len' is too far after the end of the buffer");
230 strbuf_grow(sb, dlen - len);
231 memmove(sb->buf + pos + dlen,
233 sb->len - pos - len);
234 memcpy(sb->buf + pos, data, dlen);
235 strbuf_setlen(sb, sb->len + dlen - len);
238 void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
240 strbuf_splice(sb, pos, 0, data, len);
243 void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
245 strbuf_splice(sb, pos, len, "", 0);
248 void strbuf_add(struct strbuf *sb, const void *data, size_t len)
250 strbuf_grow(sb, len);
251 memcpy(sb->buf + sb->len, data, len);
252 strbuf_setlen(sb, sb->len + len);
255 void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
257 strbuf_grow(sb, sb2->len);
258 memcpy(sb->buf + sb->len, sb2->buf, sb2->len);
259 strbuf_setlen(sb, sb->len + sb2->len);
262 void strbuf_addchars(struct strbuf *sb, int c, size_t n)
265 memset(sb->buf + sb->len, c, n);
266 strbuf_setlen(sb, sb->len + n);
269 void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
273 strbuf_vaddf(sb, fmt, ap);
277 static void add_lines(struct strbuf *out,
280 const char *buf, size_t size)
284 const char *next = memchr(buf, '\n', size);
285 next = next ? (next + 1) : (buf + size);
287 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
288 ? prefix2 : prefix1);
289 strbuf_addstr(out, prefix);
290 strbuf_add(out, buf, next - buf);
294 strbuf_complete_line(out);
297 void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
299 static char prefix1[3];
300 static char prefix2[2];
302 if (prefix1[0] != comment_line_char) {
303 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
304 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
306 add_lines(out, prefix1, prefix2, buf, size);
309 void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
312 struct strbuf buf = STRBUF_INIT;
313 int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
315 va_start(params, fmt);
316 strbuf_vaddf(&buf, fmt, params);
319 strbuf_add_commented_lines(sb, buf.buf, buf.len);
321 sb->buf[--sb->len] = '\0';
323 strbuf_release(&buf);
326 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
331 if (!strbuf_avail(sb))
334 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
337 BUG("your vsnprintf is broken (returned %d)", len);
338 if (len > strbuf_avail(sb)) {
339 strbuf_grow(sb, len);
340 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
341 if (len > strbuf_avail(sb))
342 BUG("your vsnprintf is broken (insatiable)");
344 strbuf_setlen(sb, sb->len + len);
347 void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
354 percent = strchrnul(format, '%');
355 strbuf_add(sb, format, percent - format);
358 format = percent + 1;
360 if (*format == '%') {
361 strbuf_addch(sb, '%');
366 consumed = fn(sb, format, context);
370 strbuf_addch(sb, '%');
374 size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
377 struct strbuf_expand_dict_entry *e = context;
380 for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
381 if (!strncmp(placeholder, e->placeholder, len)) {
383 strbuf_addstr(sb, e->value);
390 void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
392 size_t i, len = src->len;
394 for (i = 0; i < len; i++) {
395 if (src->buf[i] == '%')
396 strbuf_addch(dst, '%');
397 strbuf_addch(dst, src->buf[i]);
401 size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
404 size_t oldalloc = sb->alloc;
406 strbuf_grow(sb, size);
407 res = fread(sb->buf + sb->len, 1, size, f);
409 strbuf_setlen(sb, sb->len + res);
410 else if (oldalloc == 0)
415 ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
417 size_t oldlen = sb->len;
418 size_t oldalloc = sb->alloc;
420 strbuf_grow(sb, hint ? hint : 8192);
422 ssize_t want = sb->alloc - sb->len - 1;
423 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
429 strbuf_setlen(sb, oldlen);
435 strbuf_grow(sb, 8192);
438 sb->buf[sb->len] = '\0';
439 return sb->len - oldlen;
442 ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint)
444 size_t oldalloc = sb->alloc;
447 strbuf_grow(sb, hint ? hint : 8192);
448 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
450 strbuf_setlen(sb, sb->len + cnt);
451 else if (oldalloc == 0)
456 ssize_t strbuf_write(struct strbuf *sb, FILE *f)
458 return sb->len ? fwrite(sb->buf, 1, sb->len, f) : 0;
462 #define STRBUF_MAXLINK (2*PATH_MAX)
464 int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
466 size_t oldalloc = sb->alloc;
471 while (hint < STRBUF_MAXLINK) {
474 strbuf_grow(sb, hint);
475 len = readlink(path, sb->buf, hint);
479 } else if (len < hint) {
480 strbuf_setlen(sb, len);
484 /* .. the buffer was too small - try again */
492 int strbuf_getcwd(struct strbuf *sb)
494 size_t oldalloc = sb->alloc;
495 size_t guessed_len = 128;
497 for (;; guessed_len *= 2) {
498 strbuf_grow(sb, guessed_len);
499 if (getcwd(sb->buf, sb->alloc)) {
500 strbuf_setlen(sb, strlen(sb->buf));
505 * If getcwd(3) is implemented as a syscall that falls
506 * back to a regular lookup using readdir(3) etc. then
507 * we may be able to avoid EACCES by providing enough
508 * space to the syscall as it's not necessarily bound
509 * to the same restrictions as the fallback.
511 if (errno == EACCES && guessed_len < PATH_MAX)
525 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
534 /* Translate slopbuf to NULL, as we cannot call realloc on it */
538 r = getdelim(&sb->buf, &sb->alloc, term, fp);
547 * Normally we would have called xrealloc, which will try to free
548 * memory and recover. But we have no way to tell getdelim() to do so.
549 * Worse, we cannot try to recover ENOMEM ourselves, because we have
550 * no idea how many bytes were read by getdelim.
552 * Dying here is reasonable. It mirrors what xrealloc would do on
553 * catastrophic memory failure. We skip the opportunity to free pack
554 * memory and retry, but that's unlikely to help for a malloc small
555 * enough to hold a single line of input, anyway.
558 die("Out of memory, getdelim failed");
561 * Restore strbuf invariants; if getdelim left us with a NULL pointer,
562 * we can just re-init, but otherwise we should make sure that our
563 * length is empty, and that the result is NUL-terminated.
572 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
581 while ((ch = getc_unlocked(fp)) != EOF) {
582 if (!strbuf_avail(sb))
584 sb->buf[sb->len++] = ch;
589 if (ch == EOF && sb->len == 0)
592 sb->buf[sb->len] = '\0';
597 static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
599 if (strbuf_getwholeline(sb, fp, term))
601 if (sb->buf[sb->len - 1] == term)
602 strbuf_setlen(sb, sb->len - 1);
606 int strbuf_getline(struct strbuf *sb, FILE *fp)
608 if (strbuf_getwholeline(sb, fp, '\n'))
610 if (sb->buf[sb->len - 1] == '\n') {
611 strbuf_setlen(sb, sb->len - 1);
612 if (sb->len && sb->buf[sb->len - 1] == '\r')
613 strbuf_setlen(sb, sb->len - 1);
618 int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
620 return strbuf_getdelim(sb, fp, '\n');
623 int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
625 return strbuf_getdelim(sb, fp, '\0');
628 int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
634 ssize_t len = xread(fd, &ch, 1);
637 strbuf_addch(sb, ch);
644 ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
650 fd = open(path, O_RDONLY);
653 len = strbuf_read(sb, fd, hint);
664 void strbuf_add_lines(struct strbuf *out, const char *prefix,
665 const char *buf, size_t size)
667 add_lines(out, prefix, NULL, buf, size);
670 void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
673 size_t len = strcspn(s, "\"<>&");
674 strbuf_add(buf, s, len);
678 strbuf_addstr(buf, """);
681 strbuf_addstr(buf, "<");
684 strbuf_addstr(buf, ">");
687 strbuf_addstr(buf, "&");
696 static int is_rfc3986_reserved(char ch)
699 case '!': case '*': case '\'': case '(': case ')': case ';':
700 case ':': case '@': case '&': case '=': case '+': case '$':
701 case ',': case '/': case '?': case '#': case '[': case ']':
707 static int is_rfc3986_unreserved(char ch)
709 return isalnum(ch) ||
710 ch == '-' || ch == '_' || ch == '.' || ch == '~';
713 static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
716 strbuf_grow(sb, len);
719 if (is_rfc3986_unreserved(ch) ||
720 (!reserved && is_rfc3986_reserved(ch)))
721 strbuf_addch(sb, ch);
723 strbuf_addf(sb, "%%%02x", (unsigned char)ch);
727 void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
730 strbuf_add_urlencode(sb, s, strlen(s), reserved);
733 void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
735 if (bytes > 1 << 30) {
736 strbuf_addf(buf, "%u.%2.2u GiB",
737 (unsigned)(bytes >> 30),
738 (unsigned)(bytes & ((1 << 30) - 1)) / 10737419);
739 } else if (bytes > 1 << 20) {
740 unsigned x = bytes + 5243; /* for rounding */
741 strbuf_addf(buf, "%u.%2.2u MiB",
742 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
743 } else if (bytes > 1 << 10) {
744 unsigned x = bytes + 5; /* for rounding */
745 strbuf_addf(buf, "%u.%2.2u KiB",
746 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
748 strbuf_addf(buf, "%u bytes", (unsigned)bytes);
752 void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
755 die("The empty string is not a valid path");
756 if (!is_absolute_path(path)) {
757 struct stat cwd_stat, pwd_stat;
758 size_t orig_len = sb->len;
759 char *cwd = xgetcwd();
760 char *pwd = getenv("PWD");
761 if (pwd && strcmp(pwd, cwd) &&
762 !stat(cwd, &cwd_stat) &&
763 (cwd_stat.st_dev || cwd_stat.st_ino) &&
764 !stat(pwd, &pwd_stat) &&
765 pwd_stat.st_dev == cwd_stat.st_dev &&
766 pwd_stat.st_ino == cwd_stat.st_ino)
767 strbuf_addstr(sb, pwd);
769 strbuf_addstr(sb, cwd);
770 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
771 strbuf_addch(sb, '/');
774 strbuf_addstr(sb, path);
777 void strbuf_add_real_path(struct strbuf *sb, const char *path)
780 struct strbuf resolved = STRBUF_INIT;
781 strbuf_realpath(&resolved, path, 1);
782 strbuf_addbuf(sb, &resolved);
783 strbuf_release(&resolved);
785 strbuf_realpath(sb, path, 1);
788 int printf_ln(const char *fmt, ...)
793 ret = vprintf(fmt, ap);
795 if (ret < 0 || putchar('\n') == EOF)
800 int fprintf_ln(FILE *fp, const char *fmt, ...)
805 ret = vfprintf(fp, fmt, ap);
807 if (ret < 0 || putc('\n', fp) == EOF)
812 char *xstrdup_tolower(const char *string)
817 len = strlen(string);
818 result = xmallocz(len);
819 for (i = 0; i < len; i++)
820 result[i] = tolower(string[i]);
824 char *xstrdup_toupper(const char *string)
829 len = strlen(string);
830 result = xmallocz(len);
831 for (i = 0; i < len; i++)
832 result[i] = toupper(string[i]);
836 char *xstrvfmt(const char *fmt, va_list ap)
838 struct strbuf buf = STRBUF_INIT;
839 strbuf_vaddf(&buf, fmt, ap);
840 return strbuf_detach(&buf, NULL);
843 char *xstrfmt(const char *fmt, ...)
849 ret = xstrvfmt(fmt, ap);
855 void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm,
856 int tz_offset, int suppress_tz_name)
858 struct strbuf munged_fmt = STRBUF_INIT;
866 * There is no portable way to pass timezone information to
867 * strftime, so we handle %z and %Z here.
870 const char *percent = strchrnul(fmt, '%');
871 strbuf_add(&munged_fmt, fmt, percent - fmt);
877 strbuf_addstr(&munged_fmt, "%%");
881 strbuf_addf(&munged_fmt, "%+05d", tz_offset);
885 if (suppress_tz_name) {
891 strbuf_addch(&munged_fmt, '%');
894 fmt = munged_fmt.buf;
896 strbuf_grow(sb, hint);
897 len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
901 * strftime reports "0" if it could not fit the result in the buffer.
902 * Unfortunately, it also reports "0" if the requested time string
903 * takes 0 bytes. So our strategy is to munge the format so that the
904 * output contains at least one character, and then drop the extra
905 * character before returning.
907 strbuf_addch(&munged_fmt, ' ');
910 strbuf_grow(sb, hint);
911 len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
914 len--; /* drop munged space */
916 strbuf_release(&munged_fmt);
917 strbuf_setlen(sb, sb->len + len);
920 void strbuf_add_unique_abbrev(struct strbuf *sb, const struct object_id *oid,
924 strbuf_grow(sb, GIT_SHA1_HEXSZ + 1);
925 r = find_unique_abbrev_r(sb->buf + sb->len, oid, abbrev_len);
926 strbuf_setlen(sb, sb->len + r);
930 * Returns the length of a line, without trailing spaces.
932 * If the line ends with newline, it will be removed too.
934 static size_t cleanup(char *line, size_t len)
937 unsigned char c = line[len - 1];
947 * Remove empty lines from the beginning and end
948 * and also trailing spaces from every line.
950 * Turn multiple consecutive empty lines between paragraphs
951 * into just one empty line.
953 * If the input has only empty lines and spaces,
954 * no output will be produced.
956 * If last line does not have a newline at the end, one is added.
958 * Enable skip_comments to skip every line starting with comment
961 void strbuf_stripspace(struct strbuf *sb, int skip_comments)
964 size_t i, j, len, newlen;
967 /* We may have to add a newline. */
970 for (i = j = 0; i < sb->len; i += len, j += newlen) {
971 eol = memchr(sb->buf + i, '\n', sb->len - i);
972 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
974 if (skip_comments && len && sb->buf[i] == comment_line_char) {
978 newlen = cleanup(sb->buf + i, len);
980 /* Not just an empty line? */
982 if (empties > 0 && j > 0)
985 memmove(sb->buf + j, sb->buf + i, newlen);
986 sb->buf[newlen + j++] = '\n';
992 strbuf_setlen(sb, j);
995 int strbuf_normalize_path(struct strbuf *src)
997 struct strbuf dst = STRBUF_INIT;
999 strbuf_grow(&dst, src->len);
1000 if (normalize_path_copy(dst.buf, src->buf) < 0) {
1001 strbuf_release(&dst);
1006 * normalize_path does not tell us the new length, so we have to
1007 * compute it by looking for the new NUL it placed
1009 strbuf_setlen(&dst, strlen(dst.buf));
1010 strbuf_swap(src, &dst);
1011 strbuf_release(&dst);