strbuf.c

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