strbuf.c

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