]>
git.ipfire.org Git - thirdparty/git.git/blob - strbuf.c
5 int starts_with(const char *str
, const char *prefix
)
7 for (; ; str
++, prefix
++)
10 else if (*str
!= *prefix
)
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
19 char strbuf_slopbuf
[1];
21 void strbuf_init(struct strbuf
*sb
, size_t hint
)
23 sb
->alloc
= sb
->len
= 0;
24 sb
->buf
= strbuf_slopbuf
;
26 strbuf_grow(sb
, hint
);
29 void strbuf_release(struct strbuf
*sb
)
37 char *strbuf_detach(struct strbuf
*sb
, size_t *sz
)
48 void strbuf_attach(struct strbuf
*sb
, void *buf
, size_t len
, size_t alloc
)
55 sb
->buf
[sb
->len
] = '\0';
58 void strbuf_grow(struct strbuf
*sb
, size_t extra
)
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");
66 ALLOC_GROW(sb
->buf
, sb
->len
+ extra
+ 1, sb
->alloc
);
71 void strbuf_trim(struct strbuf
*sb
)
76 void strbuf_rtrim(struct strbuf
*sb
)
78 while (sb
->len
> 0 && isspace((unsigned char)sb
->buf
[sb
->len
- 1]))
80 sb
->buf
[sb
->len
] = '\0';
83 void strbuf_ltrim(struct strbuf
*sb
)
86 while (sb
->len
> 0 && isspace(*b
)) {
90 memmove(sb
->buf
, b
, sb
->len
);
91 sb
->buf
[sb
->len
] = '\0';
94 int strbuf_reencode(struct strbuf
*sb
, const char *from
, const char *to
)
99 if (same_encoding(from
, to
))
102 out
= reencode_string_len(sb
->buf
, sb
->len
, to
, from
, &len
);
106 strbuf_attach(sb
, out
, len
, len
);
110 void strbuf_tolower(struct strbuf
*sb
)
112 char *p
= sb
->buf
, *end
= sb
->buf
+ sb
->len
;
117 struct strbuf
**strbuf_split_buf(const char *str
, size_t slen
,
118 int terminator
, int max
)
120 struct strbuf
**ret
= NULL
;
121 size_t nr
= 0, alloc
= 0;
126 if (max
<= 0 || nr
+ 1 < max
) {
127 const char *end
= memchr(str
, terminator
, slen
);
131 t
= xmalloc(sizeof(struct strbuf
));
133 strbuf_add(t
, str
, len
);
134 ALLOC_GROW(ret
, nr
+ 2, alloc
);
139 ALLOC_GROW(ret
, nr
+ 1, alloc
); /* In case string was empty */
144 void strbuf_list_free(struct strbuf
**sbs
)
146 struct strbuf
**s
= sbs
;
155 int strbuf_cmp(const struct strbuf
*a
, const struct strbuf
*b
)
157 int len
= a
->len
< b
->len
? a
->len
: b
->len
;
158 int cmp
= memcmp(a
->buf
, b
->buf
, len
);
161 return a
->len
< b
->len
? -1: a
->len
!= b
->len
;
164 void strbuf_splice(struct strbuf
*sb
, size_t pos
, size_t len
,
165 const void *data
, size_t dlen
)
167 if (unsigned_add_overflows(pos
, len
))
168 die("you want to use way too much memory");
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");
175 strbuf_grow(sb
, dlen
- len
);
176 memmove(sb
->buf
+ pos
+ dlen
,
178 sb
->len
- pos
- len
);
179 memcpy(sb
->buf
+ pos
, data
, dlen
);
180 strbuf_setlen(sb
, sb
->len
+ dlen
- len
);
183 void strbuf_insert(struct strbuf
*sb
, size_t pos
, const void *data
, size_t len
)
185 strbuf_splice(sb
, pos
, 0, data
, len
);
188 void strbuf_remove(struct strbuf
*sb
, size_t pos
, size_t len
)
190 strbuf_splice(sb
, pos
, len
, "", 0);
193 void strbuf_add(struct strbuf
*sb
, const void *data
, size_t len
)
195 strbuf_grow(sb
, len
);
196 memcpy(sb
->buf
+ sb
->len
, data
, len
);
197 strbuf_setlen(sb
, sb
->len
+ len
);
200 void strbuf_addbuf(struct strbuf
*sb
, const struct strbuf
*sb2
)
202 strbuf_grow(sb
, sb2
->len
);
203 memcpy(sb
->buf
+ sb
->len
, sb2
->buf
, sb2
->len
);
204 strbuf_setlen(sb
, sb
->len
+ sb2
->len
);
207 void strbuf_adddup(struct strbuf
*sb
, size_t pos
, size_t len
)
209 strbuf_grow(sb
, len
);
210 memcpy(sb
->buf
+ sb
->len
, sb
->buf
+ pos
, len
);
211 strbuf_setlen(sb
, sb
->len
+ len
);
214 void strbuf_addchars(struct strbuf
*sb
, int c
, size_t n
)
217 memset(sb
->buf
+ sb
->len
, c
, n
);
218 strbuf_setlen(sb
, sb
->len
+ n
);
221 void strbuf_addf(struct strbuf
*sb
, const char *fmt
, ...)
225 strbuf_vaddf(sb
, fmt
, ap
);
229 static void add_lines(struct strbuf
*out
,
232 const char *buf
, size_t size
)
236 const char *next
= memchr(buf
, '\n', size
);
237 next
= next
? (next
+ 1) : (buf
+ size
);
239 prefix
= ((prefix2
&& (buf
[0] == '\n' || buf
[0] == '\t'))
240 ? prefix2
: prefix1
);
241 strbuf_addstr(out
, prefix
);
242 strbuf_add(out
, buf
, next
- buf
);
246 strbuf_complete_line(out
);
249 void strbuf_add_commented_lines(struct strbuf
*out
, const char *buf
, size_t size
)
251 static char prefix1
[3];
252 static char prefix2
[2];
254 if (prefix1
[0] != comment_line_char
) {
255 xsnprintf(prefix1
, sizeof(prefix1
), "%c ", comment_line_char
);
256 xsnprintf(prefix2
, sizeof(prefix2
), "%c", comment_line_char
);
258 add_lines(out
, prefix1
, prefix2
, buf
, size
);
261 void strbuf_commented_addf(struct strbuf
*sb
, const char *fmt
, ...)
264 struct strbuf buf
= STRBUF_INIT
;
265 int incomplete_line
= sb
->len
&& sb
->buf
[sb
->len
- 1] != '\n';
267 va_start(params
, fmt
);
268 strbuf_vaddf(&buf
, fmt
, params
);
271 strbuf_add_commented_lines(sb
, buf
.buf
, buf
.len
);
273 sb
->buf
[--sb
->len
] = '\0';
275 strbuf_release(&buf
);
278 void strbuf_vaddf(struct strbuf
*sb
, const char *fmt
, va_list ap
)
283 if (!strbuf_avail(sb
))
286 len
= vsnprintf(sb
->buf
+ sb
->len
, sb
->alloc
- sb
->len
, fmt
, cp
);
289 die("BUG: your vsnprintf is broken (returned %d)", len
);
290 if (len
> strbuf_avail(sb
)) {
291 strbuf_grow(sb
, len
);
292 len
= vsnprintf(sb
->buf
+ sb
->len
, sb
->alloc
- sb
->len
, fmt
, ap
);
293 if (len
> strbuf_avail(sb
))
294 die("BUG: your vsnprintf is broken (insatiable)");
296 strbuf_setlen(sb
, sb
->len
+ len
);
299 void strbuf_expand(struct strbuf
*sb
, const char *format
, expand_fn_t fn
,
306 percent
= strchrnul(format
, '%');
307 strbuf_add(sb
, format
, percent
- format
);
310 format
= percent
+ 1;
312 if (*format
== '%') {
313 strbuf_addch(sb
, '%');
318 consumed
= fn(sb
, format
, context
);
322 strbuf_addch(sb
, '%');
326 size_t strbuf_expand_dict_cb(struct strbuf
*sb
, const char *placeholder
,
329 struct strbuf_expand_dict_entry
*e
= context
;
332 for (; e
->placeholder
&& (len
= strlen(e
->placeholder
)); e
++) {
333 if (!strncmp(placeholder
, e
->placeholder
, len
)) {
335 strbuf_addstr(sb
, e
->value
);
342 void strbuf_addbuf_percentquote(struct strbuf
*dst
, const struct strbuf
*src
)
344 int i
, len
= src
->len
;
346 for (i
= 0; i
< len
; i
++) {
347 if (src
->buf
[i
] == '%')
348 strbuf_addch(dst
, '%');
349 strbuf_addch(dst
, src
->buf
[i
]);
353 size_t strbuf_fread(struct strbuf
*sb
, size_t size
, FILE *f
)
356 size_t oldalloc
= sb
->alloc
;
358 strbuf_grow(sb
, size
);
359 res
= fread(sb
->buf
+ sb
->len
, 1, size
, f
);
361 strbuf_setlen(sb
, sb
->len
+ res
);
362 else if (oldalloc
== 0)
367 ssize_t
strbuf_read(struct strbuf
*sb
, int fd
, size_t hint
)
369 size_t oldlen
= sb
->len
;
370 size_t oldalloc
= sb
->alloc
;
372 strbuf_grow(sb
, hint
? hint
: 8192);
374 ssize_t want
= sb
->alloc
- sb
->len
- 1;
375 ssize_t got
= read_in_full(fd
, sb
->buf
+ sb
->len
, want
);
381 strbuf_setlen(sb
, oldlen
);
387 strbuf_grow(sb
, 8192);
390 sb
->buf
[sb
->len
] = '\0';
391 return sb
->len
- oldlen
;
394 ssize_t
strbuf_read_once(struct strbuf
*sb
, int fd
, size_t hint
)
398 strbuf_grow(sb
, hint
? hint
: 8192);
399 cnt
= xread(fd
, sb
->buf
+ sb
->len
, sb
->alloc
- sb
->len
- 1);
401 strbuf_setlen(sb
, sb
->len
+ cnt
);
405 ssize_t
strbuf_write(struct strbuf
*sb
, FILE *f
)
407 return sb
->len
? fwrite(sb
->buf
, 1, sb
->len
, f
) : 0;
411 #define STRBUF_MAXLINK (2*PATH_MAX)
413 int strbuf_readlink(struct strbuf
*sb
, const char *path
, size_t hint
)
415 size_t oldalloc
= sb
->alloc
;
420 while (hint
< STRBUF_MAXLINK
) {
423 strbuf_grow(sb
, hint
);
424 len
= readlink(path
, sb
->buf
, hint
);
428 } else if (len
< hint
) {
429 strbuf_setlen(sb
, len
);
433 /* .. the buffer was too small - try again */
441 int strbuf_getcwd(struct strbuf
*sb
)
443 size_t oldalloc
= sb
->alloc
;
444 size_t guessed_len
= 128;
446 for (;; guessed_len
*= 2) {
447 strbuf_grow(sb
, guessed_len
);
448 if (getcwd(sb
->buf
, sb
->alloc
)) {
449 strbuf_setlen(sb
, strlen(sb
->buf
));
463 int strbuf_getwholeline(struct strbuf
*sb
, FILE *fp
, int term
)
472 /* Translate slopbuf to NULL, as we cannot call realloc on it */
475 r
= getdelim(&sb
->buf
, &sb
->alloc
, term
, fp
);
484 * Normally we would have called xrealloc, which will try to free
485 * memory and recover. But we have no way to tell getdelim() to do so.
486 * Worse, we cannot try to recover ENOMEM ourselves, because we have
487 * no idea how many bytes were read by getdelim.
489 * Dying here is reasonable. It mirrors what xrealloc would do on
490 * catastrophic memory failure. We skip the opportunity to free pack
491 * memory and retry, but that's unlikely to help for a malloc small
492 * enough to hold a single line of input, anyway.
495 die("Out of memory, getdelim failed");
498 * Restore strbuf invariants; if getdelim left us with a NULL pointer,
499 * we can just re-init, but otherwise we should make sure that our
500 * length is empty, and that the result is NUL-terminated.
509 int strbuf_getwholeline(struct strbuf
*sb
, FILE *fp
, int term
)
518 while ((ch
= getc_unlocked(fp
)) != EOF
) {
519 if (!strbuf_avail(sb
))
521 sb
->buf
[sb
->len
++] = ch
;
526 if (ch
== EOF
&& sb
->len
== 0)
529 sb
->buf
[sb
->len
] = '\0';
534 static int strbuf_getdelim(struct strbuf
*sb
, FILE *fp
, int term
)
536 if (strbuf_getwholeline(sb
, fp
, term
))
538 if (sb
->buf
[sb
->len
- 1] == term
)
539 strbuf_setlen(sb
, sb
->len
- 1);
543 int strbuf_getline(struct strbuf
*sb
, FILE *fp
)
545 if (strbuf_getwholeline(sb
, fp
, '\n'))
547 if (sb
->buf
[sb
->len
- 1] == '\n') {
548 strbuf_setlen(sb
, sb
->len
- 1);
549 if (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\r')
550 strbuf_setlen(sb
, sb
->len
- 1);
555 int strbuf_getline_lf(struct strbuf
*sb
, FILE *fp
)
557 return strbuf_getdelim(sb
, fp
, '\n');
560 int strbuf_getline_nul(struct strbuf
*sb
, FILE *fp
)
562 return strbuf_getdelim(sb
, fp
, '\0');
565 int strbuf_getwholeline_fd(struct strbuf
*sb
, int fd
, int term
)
571 ssize_t len
= xread(fd
, &ch
, 1);
574 strbuf_addch(sb
, ch
);
581 ssize_t
strbuf_read_file(struct strbuf
*sb
, const char *path
, size_t hint
)
586 fd
= open(path
, O_RDONLY
);
589 len
= strbuf_read(sb
, fd
, hint
);
597 void strbuf_add_lines(struct strbuf
*out
, const char *prefix
,
598 const char *buf
, size_t size
)
600 add_lines(out
, prefix
, NULL
, buf
, size
);
603 void strbuf_addstr_xml_quoted(struct strbuf
*buf
, const char *s
)
606 size_t len
= strcspn(s
, "\"<>&");
607 strbuf_add(buf
, s
, len
);
611 strbuf_addstr(buf
, """);
614 strbuf_addstr(buf
, "<");
617 strbuf_addstr(buf
, ">");
620 strbuf_addstr(buf
, "&");
629 static int is_rfc3986_reserved(char ch
)
632 case '!': case '*': case '\'': case '(': case ')': case ';':
633 case ':': case '@': case '&': case '=': case '+': case '$':
634 case ',': case '/': case '?': case '#': case '[': case ']':
640 static int is_rfc3986_unreserved(char ch
)
642 return isalnum(ch
) ||
643 ch
== '-' || ch
== '_' || ch
== '.' || ch
== '~';
646 static void strbuf_add_urlencode(struct strbuf
*sb
, const char *s
, size_t len
,
649 strbuf_grow(sb
, len
);
652 if (is_rfc3986_unreserved(ch
) ||
653 (!reserved
&& is_rfc3986_reserved(ch
)))
654 strbuf_addch(sb
, ch
);
656 strbuf_addf(sb
, "%%%02x", ch
);
660 void strbuf_addstr_urlencode(struct strbuf
*sb
, const char *s
,
663 strbuf_add_urlencode(sb
, s
, strlen(s
), reserved
);
666 void strbuf_humanise_bytes(struct strbuf
*buf
, off_t bytes
)
668 if (bytes
> 1 << 30) {
669 strbuf_addf(buf
, "%u.%2.2u GiB",
671 (int)(bytes
& ((1 << 30) - 1)) / 10737419);
672 } else if (bytes
> 1 << 20) {
673 int x
= bytes
+ 5243; /* for rounding */
674 strbuf_addf(buf
, "%u.%2.2u MiB",
675 x
>> 20, ((x
& ((1 << 20) - 1)) * 100) >> 20);
676 } else if (bytes
> 1 << 10) {
677 int x
= bytes
+ 5; /* for rounding */
678 strbuf_addf(buf
, "%u.%2.2u KiB",
679 x
>> 10, ((x
& ((1 << 10) - 1)) * 100) >> 10);
681 strbuf_addf(buf
, "%u bytes", (int)bytes
);
685 void strbuf_add_absolute_path(struct strbuf
*sb
, const char *path
)
688 die("The empty string is not a valid path");
689 if (!is_absolute_path(path
)) {
690 struct stat cwd_stat
, pwd_stat
;
691 size_t orig_len
= sb
->len
;
692 char *cwd
= xgetcwd();
693 char *pwd
= getenv("PWD");
694 if (pwd
&& strcmp(pwd
, cwd
) &&
695 !stat(cwd
, &cwd_stat
) &&
696 (cwd_stat
.st_dev
|| cwd_stat
.st_ino
) &&
697 !stat(pwd
, &pwd_stat
) &&
698 pwd_stat
.st_dev
== cwd_stat
.st_dev
&&
699 pwd_stat
.st_ino
== cwd_stat
.st_ino
)
700 strbuf_addstr(sb
, pwd
);
702 strbuf_addstr(sb
, cwd
);
703 if (sb
->len
> orig_len
&& !is_dir_sep(sb
->buf
[sb
->len
- 1]))
704 strbuf_addch(sb
, '/');
707 strbuf_addstr(sb
, path
);
710 int printf_ln(const char *fmt
, ...)
715 ret
= vprintf(fmt
, ap
);
717 if (ret
< 0 || putchar('\n') == EOF
)
722 int fprintf_ln(FILE *fp
, const char *fmt
, ...)
727 ret
= vfprintf(fp
, fmt
, ap
);
729 if (ret
< 0 || putc('\n', fp
) == EOF
)
734 char *xstrdup_tolower(const char *string
)
739 len
= strlen(string
);
740 result
= xmallocz(len
);
741 for (i
= 0; i
< len
; i
++)
742 result
[i
] = tolower(string
[i
]);
747 char *xstrvfmt(const char *fmt
, va_list ap
)
749 struct strbuf buf
= STRBUF_INIT
;
750 strbuf_vaddf(&buf
, fmt
, ap
);
751 return strbuf_detach(&buf
, NULL
);
754 char *xstrfmt(const char *fmt
, ...)
760 ret
= xstrvfmt(fmt
, ap
);
766 void strbuf_addftime(struct strbuf
*sb
, const char *fmt
, const struct tm
*tm
)
774 strbuf_grow(sb
, hint
);
775 len
= strftime(sb
->buf
+ sb
->len
, sb
->alloc
- sb
->len
, fmt
, tm
);
779 * strftime reports "0" if it could not fit the result in the buffer.
780 * Unfortunately, it also reports "0" if the requested time string
781 * takes 0 bytes. So our strategy is to munge the format so that the
782 * output contains at least one character, and then drop the extra
783 * character before returning.
785 struct strbuf munged_fmt
= STRBUF_INIT
;
786 strbuf_addf(&munged_fmt
, "%s ", fmt
);
789 strbuf_grow(sb
, hint
);
790 len
= strftime(sb
->buf
+ sb
->len
, sb
->alloc
- sb
->len
,
793 strbuf_release(&munged_fmt
);
794 len
--; /* drop munged space */
796 strbuf_setlen(sb
, sb
->len
+ len
);
799 void strbuf_add_unique_abbrev(struct strbuf
*sb
, const unsigned char *sha1
,
803 strbuf_grow(sb
, GIT_SHA1_HEXSZ
+ 1);
804 r
= find_unique_abbrev_r(sb
->buf
+ sb
->len
, sha1
, abbrev_len
);
805 strbuf_setlen(sb
, sb
->len
+ r
);
809 * Returns the length of a line, without trailing spaces.
811 * If the line ends with newline, it will be removed too.
813 static size_t cleanup(char *line
, size_t len
)
816 unsigned char c
= line
[len
- 1];
826 * Remove empty lines from the beginning and end
827 * and also trailing spaces from every line.
829 * Turn multiple consecutive empty lines between paragraphs
830 * into just one empty line.
832 * If the input has only empty lines and spaces,
833 * no output will be produced.
835 * If last line does not have a newline at the end, one is added.
837 * Enable skip_comments to skip every line starting with comment
840 void strbuf_stripspace(struct strbuf
*sb
, int skip_comments
)
843 size_t i
, j
, len
, newlen
;
846 /* We may have to add a newline. */
849 for (i
= j
= 0; i
< sb
->len
; i
+= len
, j
+= newlen
) {
850 eol
= memchr(sb
->buf
+ i
, '\n', sb
->len
- i
);
851 len
= eol
? eol
- (sb
->buf
+ i
) + 1 : sb
->len
- i
;
853 if (skip_comments
&& len
&& sb
->buf
[i
] == comment_line_char
) {
857 newlen
= cleanup(sb
->buf
+ i
, len
);
859 /* Not just an empty line? */
861 if (empties
> 0 && j
> 0)
864 memmove(sb
->buf
+ j
, sb
->buf
+ i
, newlen
);
865 sb
->buf
[newlen
+ j
++] = '\n';
871 strbuf_setlen(sb
, j
);
874 int strbuf_normalize_path(struct strbuf
*src
)
876 struct strbuf dst
= STRBUF_INIT
;
878 strbuf_grow(&dst
, src
->len
);
879 if (normalize_path_copy(dst
.buf
, src
->buf
) < 0) {
880 strbuf_release(&dst
);
885 * normalize_path does not tell us the new length, so we have to
886 * compute it by looking for the new NUL it placed
888 strbuf_setlen(&dst
, strlen(dst
.buf
));
889 strbuf_swap(src
, &dst
);
890 strbuf_release(&dst
);