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