strbuf.c

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