strbuf.c

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