strbuf.c

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