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