git.oblomov.eu Git - git/blob - strbuf.c

   1 #include "cache.h"
   2 #include "refs.h"
   3 #include "string-list.h"
   4 #include "utf8.h"
   5
   6 int starts_with(const char *str, const char *prefix)
   7 {
   8         for (; ; str++, prefix++)
   9                 if (!*prefix)
  10                         return 1;
  11                 else if (*str != *prefix)
  12                         return 0;
  13 }
  14
  15 int istarts_with(const char *str, const char *prefix)
  16 {
  17         for (; ; str++, prefix++)
  18                 if (!*prefix)
  19                         return 1;
  20                 else if (tolower(*str) != tolower(*prefix))
  21                         return 0;
  22 }
  23
  24 int skip_to_optional_arg_default(const char *str, const char *prefix,
  25                                  const char **arg, const char *def)
  26 {
  27         const char *p;
  28
  29         if (!skip_prefix(str, prefix, &p))
  30                 return 0;
  31
  32         if (!*p) {
  33                 if (arg)
  34                         *arg = def;
  35                 return 1;
  36         }
  37
  38         if (*p != '=')
  39                 return 0;
  40
  41         if (arg)
  42                 *arg = p + 1;
  43         return 1;
  44 }
  45
  46 /*
  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.
  50  */
  51 char strbuf_slopbuf[1];
  52
  53 void strbuf_init(struct strbuf *sb, size_t hint)
  54 {
  55         sb->alloc = sb->len = 0;
  56         sb->buf = strbuf_slopbuf;
  57         if (hint)
  58                 strbuf_grow(sb, hint);
  59 }
  60
  61 void strbuf_release(struct strbuf *sb)
  62 {
  63         if (sb->alloc) {
  64                 free(sb->buf);
  65                 strbuf_init(sb, 0);
  66         }
  67 }
  68
  69 char *strbuf_detach(struct strbuf *sb, size_t *sz)
  70 {
  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;
  78 }
  79
  80 void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
  81 {
  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';
  88 }
  89
  90 void strbuf_grow(struct strbuf *sb, size_t extra)
  91 {
  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';
 101 }
 102
 103 void strbuf_trim(struct strbuf *sb)
 104 {
 105         strbuf_rtrim(sb);
 106         strbuf_ltrim(sb);
 107 }
 108
 109 void strbuf_rtrim(struct strbuf *sb)
 110 {
 111         while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
 112                 sb->len--;
 113         sb->buf[sb->len] = '\0';
 114 }
 115
 116 void strbuf_trim_trailing_dir_sep(struct strbuf *sb)
 117 {
 118         while (sb->len > 0 && is_dir_sep((unsigned char)sb->buf[sb->len - 1]))
 119                 sb->len--;
 120         sb->buf[sb->len] = '\0';
 121 }
 122
 123 void strbuf_trim_trailing_newline(struct strbuf *sb)
 124 {
 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';
 129         }
 130 }
 131
 132 void strbuf_ltrim(struct strbuf *sb)
 133 {
 134         char *b = sb->buf;
 135         while (sb->len > 0 && isspace(*b)) {
 136                 b++;
 137                 sb->len--;
 138         }
 139         memmove(sb->buf, b, sb->len);
 140         sb->buf[sb->len] = '\0';
 141 }
 142
 143 int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
 144 {
 145         char *out;
 146         size_t len;
 147
 148         if (same_encoding(from, to))
 149                 return 0;
 150
 151         out = reencode_string_len(sb->buf, sb->len, to, from, &len);
 152         if (!out)
 153                 return -1;
 154
 155         strbuf_attach(sb, out, len, len);
 156         return 0;
 157 }
 158
 159 void strbuf_tolower(struct strbuf *sb)
 160 {
 161         char *p = sb->buf, *end = sb->buf + sb->len;
 162         for (; p < end; p++)
 163                 *p = tolower(*p);
 164 }
 165
 166 struct strbuf **strbuf_split_buf(const char *str, size_t slen,
 167                                  int terminator, int max)
 168 {
 169         struct strbuf **ret = NULL;
 170         size_t nr = 0, alloc = 0;
 171         struct strbuf *t;
 172
 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;
 179                 }
 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;
 187         }
 188         ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
 189         ret[nr] = NULL;
 190         return ret;
 191 }
 192
 193 void strbuf_add_separated_string_list(struct strbuf *str,
 194                                       const char *sep,
 195                                       struct string_list *slist)
 196 {
 197         struct string_list_item *item;
 198         int sep_needed = 0;
 199
 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;
 205         }
 206 }
 207
 208 void strbuf_list_free(struct strbuf **sbs)
 209 {
 210         struct strbuf **s = sbs;
 211
 212         while (*s) {
 213                 strbuf_release(*s);
 214                 free(*s++);
 215         }
 216         free(sbs);
 217 }
 218
 219 int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
 220 {
 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;
 226 }
 227
 228 void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
 229                                    const void *data, size_t dlen)
 230 {
 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");
 237
 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);
 245 }
 246
 247 void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
 248 {
 249         strbuf_splice(sb, pos, 0, data, len);
 250 }
 251
 252 void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
 253 {
 254         strbuf_splice(sb, pos, len, "", 0);
 255 }
 256
 257 void strbuf_add(struct strbuf *sb, const void *data, size_t len)
 258 {
 259         strbuf_grow(sb, len);
 260         memcpy(sb->buf + sb->len, data, len);
 261         strbuf_setlen(sb, sb->len + len);
 262 }
 263
 264 void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
 265 {
 266         strbuf_grow(sb, sb2->len);
 267         memcpy(sb->buf + sb->len, sb2->buf, sb2->len);
 268         strbuf_setlen(sb, sb->len + sb2->len);
 269 }
 270
 271 const char *strbuf_join_argv(struct strbuf *buf,
 272                              int argc, const char **argv, char delim)
 273 {
 274         if (!argc)
 275                 return buf->buf;
 276
 277         strbuf_addstr(buf, *argv);
 278         while (--argc) {
 279                 strbuf_addch(buf, delim);
 280                 strbuf_addstr(buf, *(++argv));
 281         }
 282
 283         return buf->buf;
 284 }
 285
 286 void strbuf_addchars(struct strbuf *sb, int c, size_t n)
 287 {
 288         strbuf_grow(sb, n);
 289         memset(sb->buf + sb->len, c, n);
 290         strbuf_setlen(sb, sb->len + n);
 291 }
 292
 293 void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
 294 {
 295         va_list ap;
 296         va_start(ap, fmt);
 297         strbuf_vaddf(sb, fmt, ap);
 298         va_end(ap);
 299 }
 300
 301 static void add_lines(struct strbuf *out,
 302                         const char *prefix1,
 303                         const char *prefix2,
 304                         const char *buf, size_t size)
 305 {
 306         while (size) {
 307                 const char *prefix;
 308                 const char *next = memchr(buf, '\n', size);
 309                 next = next ? (next + 1) : (buf + size);
 310
 311                 prefix = ((prefix2 && (buf[0] == '\n' || buf[0] == '\t'))
 312                           ? prefix2 : prefix1);
 313                 strbuf_addstr(out, prefix);
 314                 strbuf_add(out, buf, next - buf);
 315                 size -= next - buf;
 316                 buf = next;
 317         }
 318         strbuf_complete_line(out);
 319 }
 320
 321 void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
 322 {
 323         static char prefix1[3];
 324         static char prefix2[2];
 325
 326         if (prefix1[0] != comment_line_char) {
 327                 xsnprintf(prefix1, sizeof(prefix1), "%c ", comment_line_char);
 328                 xsnprintf(prefix2, sizeof(prefix2), "%c", comment_line_char);
 329         }
 330         add_lines(out, prefix1, prefix2, buf, size);
 331 }
 332
 333 void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
 334 {
 335         va_list params;
 336         struct strbuf buf = STRBUF_INIT;
 337         int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
 338
 339         va_start(params, fmt);
 340         strbuf_vaddf(&buf, fmt, params);
 341         va_end(params);
 342
 343         strbuf_add_commented_lines(sb, buf.buf, buf.len);
 344         if (incomplete_line)
 345                 sb->buf[--sb->len] = '\0';
 346
 347         strbuf_release(&buf);
 348 }
 349
 350 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
 351 {
 352         int len;
 353         va_list cp;
 354
 355         if (!strbuf_avail(sb))
 356                 strbuf_grow(sb, 64);
 357         va_copy(cp, ap);
 358         len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
 359         va_end(cp);
 360         if (len < 0)
 361                 BUG("your vsnprintf is broken (returned %d)", len);
 362         if (len > strbuf_avail(sb)) {
 363                 strbuf_grow(sb, len);
 364                 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
 365                 if (len > strbuf_avail(sb))
 366                         BUG("your vsnprintf is broken (insatiable)");
 367         }
 368         strbuf_setlen(sb, sb->len + len);
 369 }
 370
 371 void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
 372                    void *context)
 373 {
 374         for (;;) {
 375                 const char *percent;
 376                 size_t consumed;
 377
 378                 percent = strchrnul(format, '%');
 379                 strbuf_add(sb, format, percent - format);
 380                 if (!*percent)
 381                         break;
 382                 format = percent + 1;
 383
 384                 if (*format == '%') {
 385                         strbuf_addch(sb, '%');
 386                         format++;
 387                         continue;
 388                 }
 389
 390                 consumed = fn(sb, format, context);
 391                 if (consumed)
 392                         format += consumed;
 393                 else
 394                         strbuf_addch(sb, '%');
 395         }
 396 }
 397
 398 size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
 399                 void *context)
 400 {
 401         struct strbuf_expand_dict_entry *e = context;
 402         size_t len;
 403
 404         for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
 405                 if (!strncmp(placeholder, e->placeholder, len)) {
 406                         if (e->value)
 407                                 strbuf_addstr(sb, e->value);
 408                         return len;
 409                 }
 410         }
 411         return 0;
 412 }
 413
 414 void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
 415 {
 416         size_t i, len = src->len;
 417
 418         for (i = 0; i < len; i++) {
 419                 if (src->buf[i] == '%')
 420                         strbuf_addch(dst, '%');
 421                 strbuf_addch(dst, src->buf[i]);
 422         }
 423 }
 424
 425 size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
 426 {
 427         size_t res;
 428         size_t oldalloc = sb->alloc;
 429
 430         strbuf_grow(sb, size);
 431         res = fread(sb->buf + sb->len, 1, size, f);
 432         if (res > 0)
 433                 strbuf_setlen(sb, sb->len + res);
 434         else if (oldalloc == 0)
 435                 strbuf_release(sb);
 436         return res;
 437 }
 438
 439 ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
 440 {
 441         size_t oldlen = sb->len;
 442         size_t oldalloc = sb->alloc;
 443
 444         strbuf_grow(sb, hint ? hint : 8192);
 445         for (;;) {
 446                 ssize_t want = sb->alloc - sb->len - 1;
 447                 ssize_t got = read_in_full(fd, sb->buf + sb->len, want);
 448
 449                 if (got < 0) {
 450                         if (oldalloc == 0)
 451                                 strbuf_release(sb);
 452                         else
 453                                 strbuf_setlen(sb, oldlen);
 454                         return -1;
 455                 }
 456                 sb->len += got;
 457                 if (got < want)
 458                         break;
 459                 strbuf_grow(sb, 8192);
 460         }
 461
 462         sb->buf[sb->len] = '\0';
 463         return sb->len - oldlen;
 464 }
 465
 466 ssize_t strbuf_read_once(struct strbuf *sb, int fd, size_t hint)
 467 {
 468         size_t oldalloc = sb->alloc;
 469         ssize_t cnt;
 470
 471         strbuf_grow(sb, hint ? hint : 8192);
 472         cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
 473         if (cnt > 0)
 474                 strbuf_setlen(sb, sb->len + cnt);
 475         else if (oldalloc == 0)
 476                 strbuf_release(sb);
 477         return cnt;
 478 }
 479
 480 ssize_t strbuf_write(struct strbuf *sb, FILE *f)
 481 {
 482         return sb->len ? fwrite(sb->buf, 1, sb->len, f) : 0;
 483 }
 484
 485
 486 #define STRBUF_MAXLINK (2*PATH_MAX)
 487
 488 int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
 489 {
 490         size_t oldalloc = sb->alloc;
 491
 492         if (hint < 32)
 493                 hint = 32;
 494
 495         while (hint < STRBUF_MAXLINK) {
 496                 ssize_t len;
 497
 498                 strbuf_grow(sb, hint);
 499                 len = readlink(path, sb->buf, hint);
 500                 if (len < 0) {
 501                         if (errno != ERANGE)
 502                                 break;
 503                 } else if (len < hint) {
 504                         strbuf_setlen(sb, len);
 505                         return 0;
 506                 }
 507
 508                 /* .. the buffer was too small - try again */
 509                 hint *= 2;
 510         }
 511         if (oldalloc == 0)
 512                 strbuf_release(sb);
 513         return -1;
 514 }
 515
 516 int strbuf_getcwd(struct strbuf *sb)
 517 {
 518         size_t oldalloc = sb->alloc;
 519         size_t guessed_len = 128;
 520
 521         for (;; guessed_len *= 2) {
 522                 strbuf_grow(sb, guessed_len);
 523                 if (getcwd(sb->buf, sb->alloc)) {
 524                         strbuf_setlen(sb, strlen(sb->buf));
 525                         return 0;
 526                 }
 527
 528                 /*
 529                  * If getcwd(3) is implemented as a syscall that falls
 530                  * back to a regular lookup using readdir(3) etc. then
 531                  * we may be able to avoid EACCES by providing enough
 532                  * space to the syscall as it's not necessarily bound
 533                  * to the same restrictions as the fallback.
 534                  */
 535                 if (errno == EACCES && guessed_len < PATH_MAX)
 536                         continue;
 537
 538                 if (errno != ERANGE)
 539                         break;
 540         }
 541         if (oldalloc == 0)
 542                 strbuf_release(sb);
 543         else
 544                 strbuf_reset(sb);
 545         return -1;
 546 }
 547
 548 #ifdef HAVE_GETDELIM
 549 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
 550 {
 551         ssize_t r;
 552
 553         if (feof(fp))
 554                 return EOF;
 555
 556         strbuf_reset(sb);
 557
 558         /* Translate slopbuf to NULL, as we cannot call realloc on it */
 559         if (!sb->alloc)
 560                 sb->buf = NULL;
 561         errno = 0;
 562         r = getdelim(&sb->buf, &sb->alloc, term, fp);
 563
 564         if (r > 0) {
 565                 sb->len = r;
 566                 return 0;
 567         }
 568         assert(r == -1);
 569
 570         /*
 571          * Normally we would have called xrealloc, which will try to free
 572          * memory and recover. But we have no way to tell getdelim() to do so.
 573          * Worse, we cannot try to recover ENOMEM ourselves, because we have
 574          * no idea how many bytes were read by getdelim.
 575          *
 576          * Dying here is reasonable. It mirrors what xrealloc would do on
 577          * catastrophic memory failure. We skip the opportunity to free pack
 578          * memory and retry, but that's unlikely to help for a malloc small
 579          * enough to hold a single line of input, anyway.
 580          */
 581         if (errno == ENOMEM)
 582                 die("Out of memory, getdelim failed");
 583
 584         /*
 585          * Restore strbuf invariants; if getdelim left us with a NULL pointer,
 586          * we can just re-init, but otherwise we should make sure that our
 587          * length is empty, and that the result is NUL-terminated.
 588          */
 589         if (!sb->buf)
 590                 strbuf_init(sb, 0);
 591         else
 592                 strbuf_reset(sb);
 593         return EOF;
 594 }
 595 #else
 596 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
 597 {
 598         int ch;
 599
 600         if (feof(fp))
 601                 return EOF;
 602
 603         strbuf_reset(sb);
 604         flockfile(fp);
 605         while ((ch = getc_unlocked(fp)) != EOF) {
 606                 if (!strbuf_avail(sb))
 607                         strbuf_grow(sb, 1);
 608                 sb->buf[sb->len++] = ch;
 609                 if (ch == term)
 610                         break;
 611         }
 612         funlockfile(fp);
 613         if (ch == EOF && sb->len == 0)
 614                 return EOF;
 615
 616         sb->buf[sb->len] = '\0';
 617         return 0;
 618 }
 619 #endif
 620
 621 static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
 622 {
 623         if (strbuf_getwholeline(sb, fp, term))
 624                 return EOF;
 625         if (sb->buf[sb->len - 1] == term)
 626                 strbuf_setlen(sb, sb->len - 1);
 627         return 0;
 628 }
 629
 630 int strbuf_getline(struct strbuf *sb, FILE *fp)
 631 {
 632         if (strbuf_getwholeline(sb, fp, '\n'))
 633                 return EOF;
 634         if (sb->buf[sb->len - 1] == '\n') {
 635                 strbuf_setlen(sb, sb->len - 1);
 636                 if (sb->len && sb->buf[sb->len - 1] == '\r')
 637                         strbuf_setlen(sb, sb->len - 1);
 638         }
 639         return 0;
 640 }
 641
 642 int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
 643 {
 644         return strbuf_getdelim(sb, fp, '\n');
 645 }
 646
 647 int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
 648 {
 649         return strbuf_getdelim(sb, fp, '\0');
 650 }
 651
 652 int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
 653 {
 654         strbuf_reset(sb);
 655
 656         while (1) {
 657                 char ch;
 658                 ssize_t len = xread(fd, &ch, 1);
 659                 if (len <= 0)
 660                         return EOF;
 661                 strbuf_addch(sb, ch);
 662                 if (ch == term)
 663                         break;
 664         }
 665         return 0;
 666 }
 667
 668 ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
 669 {
 670         int fd;
 671         ssize_t len;
 672         int saved_errno;
 673
 674         fd = open(path, O_RDONLY);
 675         if (fd < 0)
 676                 return -1;
 677         len = strbuf_read(sb, fd, hint);
 678         saved_errno = errno;
 679         close(fd);
 680         if (len < 0) {
 681                 errno = saved_errno;
 682                 return -1;
 683         }
 684
 685         return len;
 686 }
 687
 688 void strbuf_add_lines(struct strbuf *out, const char *prefix,
 689                       const char *buf, size_t size)
 690 {
 691         add_lines(out, prefix, NULL, buf, size);
 692 }
 693
 694 void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
 695 {
 696         while (*s) {
 697                 size_t len = strcspn(s, "\"<>&");
 698                 strbuf_add(buf, s, len);
 699                 s += len;
 700                 switch (*s) {
 701                 case '"':
 702                         strbuf_addstr(buf, "&quot;");
 703                         break;
 704                 case '<':
 705                         strbuf_addstr(buf, "&lt;");
 706                         break;
 707                 case '>':
 708                         strbuf_addstr(buf, "&gt;");
 709                         break;
 710                 case '&':
 711                         strbuf_addstr(buf, "&amp;");
 712                         break;
 713                 case 0:
 714                         return;
 715                 }
 716                 s++;
 717         }
 718 }
 719
 720 static int is_rfc3986_reserved(char ch)
 721 {
 722         switch (ch) {
 723                 case '!': case '*': case '\'': case '(': case ')': case ';':
 724                 case ':': case '@': case '&': case '=': case '+': case '$':
 725                 case ',': case '/': case '?': case '#': case '[': case ']':
 726                         return 1;
 727         }
 728         return 0;
 729 }
 730
 731 static int is_rfc3986_unreserved(char ch)
 732 {
 733         return isalnum(ch) ||
 734                 ch == '-' || ch == '_' || ch == '.' || ch == '~';
 735 }
 736
 737 static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
 738                                  int reserved)
 739 {
 740         strbuf_grow(sb, len);
 741         while (len--) {
 742                 char ch = *s++;
 743                 if (is_rfc3986_unreserved(ch) ||
 744                     (!reserved && is_rfc3986_reserved(ch)))
 745                         strbuf_addch(sb, ch);
 746                 else
 747                         strbuf_addf(sb, "%%%02x", (unsigned char)ch);
 748         }
 749 }
 750
 751 void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
 752                              int reserved)
 753 {
 754         strbuf_add_urlencode(sb, s, strlen(s), reserved);
 755 }
 756
 757 void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
 758 {
 759         if (bytes > 1 << 30) {
 760                 strbuf_addf(buf, "%u.%2.2u GiB",
 761                             (unsigned)(bytes >> 30),
 762                             (unsigned)(bytes & ((1 << 30) - 1)) / 10737419);
 763         } else if (bytes > 1 << 20) {
 764                 unsigned x = bytes + 5243;  /* for rounding */
 765                 strbuf_addf(buf, "%u.%2.2u MiB",
 766                             x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
 767         } else if (bytes > 1 << 10) {
 768                 unsigned x = bytes + 5;  /* for rounding */
 769                 strbuf_addf(buf, "%u.%2.2u KiB",
 770                             x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
 771         } else {
 772                 strbuf_addf(buf, "%u bytes", (unsigned)bytes);
 773         }
 774 }
 775
 776 void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
 777 {
 778         if (!*path)
 779                 die("The empty string is not a valid path");
 780         if (!is_absolute_path(path)) {
 781                 struct stat cwd_stat, pwd_stat;
 782                 size_t orig_len = sb->len;
 783                 char *cwd = xgetcwd();
 784                 char *pwd = getenv("PWD");
 785                 if (pwd && strcmp(pwd, cwd) &&
 786                     !stat(cwd, &cwd_stat) &&
 787                     (cwd_stat.st_dev || cwd_stat.st_ino) &&
 788                     !stat(pwd, &pwd_stat) &&
 789                     pwd_stat.st_dev == cwd_stat.st_dev &&
 790                     pwd_stat.st_ino == cwd_stat.st_ino)
 791                         strbuf_addstr(sb, pwd);
 792                 else
 793                         strbuf_addstr(sb, cwd);
 794                 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
 795                         strbuf_addch(sb, '/');
 796                 free(cwd);
 797         }
 798         strbuf_addstr(sb, path);
 799 }
 800
 801 void strbuf_add_real_path(struct strbuf *sb, const char *path)
 802 {
 803         if (sb->len) {
 804                 struct strbuf resolved = STRBUF_INIT;
 805                 strbuf_realpath(&resolved, path, 1);
 806                 strbuf_addbuf(sb, &resolved);
 807                 strbuf_release(&resolved);
 808         } else
 809                 strbuf_realpath(sb, path, 1);
 810 }
 811
 812 int printf_ln(const char *fmt, ...)
 813 {
 814         int ret;
 815         va_list ap;
 816         va_start(ap, fmt);
 817         ret = vprintf(fmt, ap);
 818         va_end(ap);
 819         if (ret < 0 || putchar('\n') == EOF)
 820                 return -1;
 821         return ret + 1;
 822 }
 823
 824 int fprintf_ln(FILE *fp, const char *fmt, ...)
 825 {
 826         int ret;
 827         va_list ap;
 828         va_start(ap, fmt);
 829         ret = vfprintf(fp, fmt, ap);
 830         va_end(ap);
 831         if (ret < 0 || putc('\n', fp) == EOF)
 832                 return -1;
 833         return ret + 1;
 834 }
 835
 836 char *xstrdup_tolower(const char *string)
 837 {
 838         char *result;
 839         size_t len, i;
 840
 841         len = strlen(string);
 842         result = xmallocz(len);
 843         for (i = 0; i < len; i++)
 844                 result[i] = tolower(string[i]);
 845         return result;
 846 }
 847
 848 char *xstrdup_toupper(const char *string)
 849 {
 850         char *result;
 851         size_t len, i;
 852
 853         len = strlen(string);
 854         result = xmallocz(len);
 855         for (i = 0; i < len; i++)
 856                 result[i] = toupper(string[i]);
 857         return result;
 858 }
 859
 860 char *xstrvfmt(const char *fmt, va_list ap)
 861 {
 862         struct strbuf buf = STRBUF_INIT;
 863         strbuf_vaddf(&buf, fmt, ap);
 864         return strbuf_detach(&buf, NULL);
 865 }
 866
 867 char *xstrfmt(const char *fmt, ...)
 868 {
 869         va_list ap;
 870         char *ret;
 871
 872         va_start(ap, fmt);
 873         ret = xstrvfmt(fmt, ap);
 874         va_end(ap);
 875
 876         return ret;
 877 }
 878
 879 void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm *tm,
 880                      int tz_offset, int suppress_tz_name)
 881 {
 882         struct strbuf munged_fmt = STRBUF_INIT;
 883         size_t hint = 128;
 884         size_t len;
 885
 886         if (!*fmt)
 887                 return;
 888
 889         /*
 890          * There is no portable way to pass timezone information to
 891          * strftime, so we handle %z and %Z here.
 892          */
 893         for (;;) {
 894                 const char *percent = strchrnul(fmt, '%');
 895                 strbuf_add(&munged_fmt, fmt, percent - fmt);
 896                 if (!*percent)
 897                         break;
 898                 fmt = percent + 1;
 899                 switch (*fmt) {
 900                 case '%':
 901                         strbuf_addstr(&munged_fmt, "%%");
 902                         fmt++;
 903                         break;
 904                 case 'z':
 905                         strbuf_addf(&munged_fmt, "%+05d", tz_offset);
 906                         fmt++;
 907                         break;
 908                 case 'Z':
 909                         if (suppress_tz_name) {
 910                                 fmt++;
 911                                 break;
 912                         }
 913                         /* FALLTHROUGH */
 914                 default:
 915                         strbuf_addch(&munged_fmt, '%');
 916                 }
 917         }
 918         fmt = munged_fmt.buf;
 919
 920         strbuf_grow(sb, hint);
 921         len = strftime(sb->buf + sb->len, sb->alloc - sb->len, fmt, tm);
 922
 923         if (!len) {
 924                 /*
 925                  * strftime reports "0" if it could not fit the result in the buffer.
 926                  * Unfortunately, it also reports "0" if the requested time string
 927                  * takes 0 bytes. So our strategy is to munge the format so that the
 928                  * output contains at least one character, and then drop the extra
 929                  * character before returning.
 930                  */
 931                 strbuf_addch(&munged_fmt, ' ');
 932                 while (!len) {
 933                         hint *= 2;
 934                         strbuf_grow(sb, hint);
 935                         len = strftime(sb->buf + sb->len, sb->alloc - sb->len,
 936                                        munged_fmt.buf, tm);
 937                 }
 938                 len--; /* drop munged space */
 939         }
 940         strbuf_release(&munged_fmt);
 941         strbuf_setlen(sb, sb->len + len);
 942 }
 943
 944 void strbuf_add_unique_abbrev(struct strbuf *sb, const struct object_id *oid,
 945                               int abbrev_len)
 946 {
 947         int r;
 948         strbuf_grow(sb, GIT_MAX_HEXSZ + 1);
 949         r = find_unique_abbrev_r(sb->buf + sb->len, oid, abbrev_len);
 950         strbuf_setlen(sb, sb->len + r);
 951 }
 952
 953 /*
 954  * Returns the length of a line, without trailing spaces.
 955  *
 956  * If the line ends with newline, it will be removed too.
 957  */
 958 static size_t cleanup(char *line, size_t len)
 959 {
 960         while (len) {
 961                 unsigned char c = line[len - 1];
 962                 if (!isspace(c))
 963                         break;
 964                 len--;
 965         }
 966
 967         return len;
 968 }
 969
 970 /*
 971  * Remove empty lines from the beginning and end
 972  * and also trailing spaces from every line.
 973  *
 974  * Turn multiple consecutive empty lines between paragraphs
 975  * into just one empty line.
 976  *
 977  * If the input has only empty lines and spaces,
 978  * no output will be produced.
 979  *
 980  * If last line does not have a newline at the end, one is added.
 981  *
 982  * Enable skip_comments to skip every line starting with comment
 983  * character.
 984  */
 985 void strbuf_stripspace(struct strbuf *sb, int skip_comments)
 986 {
 987         size_t empties = 0;
 988         size_t i, j, len, newlen;
 989         char *eol;
 990
 991         /* We may have to add a newline. */
 992         strbuf_grow(sb, 1);
 993
 994         for (i = j = 0; i < sb->len; i += len, j += newlen) {
 995                 eol = memchr(sb->buf + i, '\n', sb->len - i);
 996                 len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
 997
 998                 if (skip_comments && len && sb->buf[i] == comment_line_char) {
 999                         newlen = 0;
1000                         continue;
1001                 }
1002                 newlen = cleanup(sb->buf + i, len);
1003
1004                 /* Not just an empty line? */
1005                 if (newlen) {
1006                         if (empties > 0 && j > 0)
1007                                 sb->buf[j++] = '\n';
1008                         empties = 0;
1009                         memmove(sb->buf + j, sb->buf + i, newlen);
1010                         sb->buf[newlen + j++] = '\n';
1011                 } else {
1012                         empties++;
1013                 }
1014         }
1015
1016         strbuf_setlen(sb, j);
1017 }
1018
1019 int strbuf_normalize_path(struct strbuf *src)
1020 {
1021         struct strbuf dst = STRBUF_INIT;
1022
1023         strbuf_grow(&dst, src->len);
1024         if (normalize_path_copy(dst.buf, src->buf) < 0) {
1025                 strbuf_release(&dst);
1026                 return -1;
1027         }
1028
1029         /*
1030          * normalize_path does not tell us the new length, so we have to
1031          * compute it by looking for the new NUL it placed
1032          */
1033         strbuf_setlen(&dst, strlen(dst.buf));
1034         strbuf_swap(src, &dst);
1035         strbuf_release(&dst);
1036         return 0;
1037 }