strbuf.c

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