git.oblomov.eu Git - git/blob - strbuf.c

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