strbuf.c

   1 #include "cache.h"
   2 #include "refs.h"
   3 #include "utf8.h"
   4
   5 int 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
  14 /*
  15  * Used as the default ->buf value, so that people can always assume
  16  * buf is non NULL and ->buf is NUL terminated even for a freshly
  17  * initialized strbuf.
  18  */
  19 char strbuf_slopbuf[1];
  20
  21 void strbuf_init(struct strbuf *sb, size_t hint)
  22 {
  23         sb->alloc = sb->len = 0;
  24         sb->buf = strbuf_slopbuf;
  25         if (hint)
  26                 strbuf_grow(sb, hint);
  27 }
  28
  29 void strbuf_release(struct strbuf *sb)
  30 {
  31         if (sb->alloc) {
  32                 free(sb->buf);
  33                 strbuf_init(sb, 0);
  34         }
  35 }
  36
  37 char *strbuf_detach(struct strbuf *sb, size_t *sz)
  38 {
  39         char *res;
  40         strbuf_grow(sb, 0);
  41         res = sb->buf;
  42         if (sz)
  43                 *sz = sb->len;
  44         strbuf_init(sb, 0);
  45         return res;
  46 }
  47
  48 void strbuf_attach(struct strbuf *sb, void *buf, size_t len, size_t alloc)
  49 {
  50         strbuf_release(sb);
  51         sb->buf   = buf;
  52         sb->len   = len;
  53         sb->alloc = alloc;
  54         strbuf_grow(sb, 0);
  55         sb->buf[sb->len] = '\0';
  56 }
  57
  58 void strbuf_grow(struct strbuf *sb, size_t extra)
  59 {
  60         int new_buf = !sb->alloc;
  61         if (unsigned_add_overflows(extra, 1) ||
  62             unsigned_add_overflows(sb->len, extra + 1))
  63                 die("you want to use way too much memory");
  64         if (new_buf)
  65                 sb->buf = NULL;
  66         ALLOC_GROW(sb->buf, sb->len + extra + 1, sb->alloc);
  67         if (new_buf)
  68                 sb->buf[0] = '\0';
  69 }
  70
  71 void strbuf_trim(struct strbuf *sb)
  72 {
  73         strbuf_rtrim(sb);
  74         strbuf_ltrim(sb);
  75 }
  76 void strbuf_rtrim(struct strbuf *sb)
  77 {
  78         while (sb->len > 0 && isspace((unsigned char)sb->buf[sb->len - 1]))
  79                 sb->len--;
  80         sb->buf[sb->len] = '\0';
  81 }
  82
  83 void strbuf_ltrim(struct strbuf *sb)
  84 {
  85         char *b = sb->buf;
  86         while (sb->len > 0 && isspace(*b)) {
  87                 b++;
  88                 sb->len--;
  89         }
  90         memmove(sb->buf, b, sb->len);
  91         sb->buf[sb->len] = '\0';
  92 }
  93
  94 int strbuf_reencode(struct strbuf *sb, const char *from, const char *to)
  95 {
  96         char *out;
  97         int len;
  98
  99         if (same_encoding(from, to))
 100                 return 0;
 101
 102         out = reencode_string_len(sb->buf, sb->len, to, from, &len);
 103         if (!out)
 104                 return -1;
 105
 106         strbuf_attach(sb, out, len, len);
 107         return 0;
 108 }
 109
 110 void strbuf_tolower(struct strbuf *sb)
 111 {
 112         char *p = sb->buf, *end = sb->buf + sb->len;
 113         for (; p < end; p++)
 114                 *p = tolower(*p);
 115 }
 116
 117 struct strbuf **strbuf_split_buf(const char *str, size_t slen,
 118                                  int terminator, int max)
 119 {
 120         struct strbuf **ret = NULL;
 121         size_t nr = 0, alloc = 0;
 122         struct strbuf *t;
 123
 124         while (slen) {
 125                 int len = slen;
 126                 if (max <= 0 || nr + 1 < max) {
 127                         const char *end = memchr(str, terminator, slen);
 128                         if (end)
 129                                 len = end - str + 1;
 130                 }
 131                 t = xmalloc(sizeof(struct strbuf));
 132                 strbuf_init(t, len);
 133                 strbuf_add(t, str, len);
 134                 ALLOC_GROW(ret, nr + 2, alloc);
 135                 ret[nr++] = t;
 136                 str += len;
 137                 slen -= len;
 138         }
 139         ALLOC_GROW(ret, nr + 1, alloc); /* In case string was empty */
 140         ret[nr] = NULL;
 141         return ret;
 142 }
 143
 144 void strbuf_list_free(struct strbuf **sbs)
 145 {
 146         struct strbuf **s = sbs;
 147
 148         while (*s) {
 149                 strbuf_release(*s);
 150                 free(*s++);
 151         }
 152         free(sbs);
 153 }
 154
 155 int strbuf_cmp(const struct strbuf *a, const struct strbuf *b)
 156 {
 157         int len = a->len < b->len ? a->len: b->len;
 158         int cmp = memcmp(a->buf, b->buf, len);
 159         if (cmp)
 160                 return cmp;
 161         return a->len < b->len ? -1: a->len != b->len;
 162 }
 163
 164 void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
 165                                    const void *data, size_t dlen)
 166 {
 167         if (unsigned_add_overflows(pos, len))
 168                 die("you want to use way too much memory");
 169         if (pos > sb->len)
 170                 die("`pos' is too far after the end of the buffer");
 171         if (pos + len > sb->len)
 172                 die("`pos + len' is too far after the end of the buffer");
 173
 174         if (dlen >= len)
 175                 strbuf_grow(sb, dlen - len);
 176         memmove(sb->buf + pos + dlen,
 177                         sb->buf + pos + len,
 178                         sb->len - pos - len);
 179         memcpy(sb->buf + pos, data, dlen);
 180         strbuf_setlen(sb, sb->len + dlen - len);
 181 }
 182
 183 void strbuf_insert(struct strbuf *sb, size_t pos, const void *data, size_t len)
 184 {
 185         strbuf_splice(sb, pos, 0, data, len);
 186 }
 187
 188 void strbuf_remove(struct strbuf *sb, size_t pos, size_t len)
 189 {
 190         strbuf_splice(sb, pos, len, NULL, 0);
 191 }
 192
 193 void strbuf_add(struct strbuf *sb, const void *data, size_t len)
 194 {
 195         strbuf_grow(sb, len);
 196         memcpy(sb->buf + sb->len, data, len);
 197         strbuf_setlen(sb, sb->len + len);
 198 }
 199
 200 void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len)
 201 {
 202         strbuf_grow(sb, len);
 203         memcpy(sb->buf + sb->len, sb->buf + pos, len);
 204         strbuf_setlen(sb, sb->len + len);
 205 }
 206
 207 void strbuf_addf(struct strbuf *sb, const char *fmt, ...)
 208 {
 209         va_list ap;
 210         va_start(ap, fmt);
 211         strbuf_vaddf(sb, fmt, ap);
 212         va_end(ap);
 213 }
 214
 215 static void add_lines(struct strbuf *out,
 216                         const char *prefix1,
 217                         const char *prefix2,
 218                         const char *buf, size_t size)
 219 {
 220         while (size) {
 221                 const char *prefix;
 222                 const char *next = memchr(buf, '\n', size);
 223                 next = next ? (next + 1) : (buf + size);
 224
 225                 prefix = (prefix2 && buf[0] == '\n') ? prefix2 : prefix1;
 226                 strbuf_addstr(out, prefix);
 227                 strbuf_add(out, buf, next - buf);
 228                 size -= next - buf;
 229                 buf = next;
 230         }
 231         strbuf_complete_line(out);
 232 }
 233
 234 void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size)
 235 {
 236         static char prefix1[3];
 237         static char prefix2[2];
 238
 239         if (prefix1[0] != comment_line_char) {
 240                 sprintf(prefix1, "%c ", comment_line_char);
 241                 sprintf(prefix2, "%c", comment_line_char);
 242         }
 243         add_lines(out, prefix1, prefix2, buf, size);
 244 }
 245
 246 void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...)
 247 {
 248         va_list params;
 249         struct strbuf buf = STRBUF_INIT;
 250         int incomplete_line = sb->len && sb->buf[sb->len - 1] != '\n';
 251
 252         va_start(params, fmt);
 253         strbuf_vaddf(&buf, fmt, params);
 254         va_end(params);
 255
 256         strbuf_add_commented_lines(sb, buf.buf, buf.len);
 257         if (incomplete_line)
 258                 sb->buf[--sb->len] = '\0';
 259
 260         strbuf_release(&buf);
 261 }
 262
 263 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap)
 264 {
 265         int len;
 266         va_list cp;
 267
 268         if (!strbuf_avail(sb))
 269                 strbuf_grow(sb, 64);
 270         va_copy(cp, ap);
 271         len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, cp);
 272         va_end(cp);
 273         if (len < 0)
 274                 die("BUG: your vsnprintf is broken (returned %d)", len);
 275         if (len > strbuf_avail(sb)) {
 276                 strbuf_grow(sb, len);
 277                 len = vsnprintf(sb->buf + sb->len, sb->alloc - sb->len, fmt, ap);
 278                 if (len > strbuf_avail(sb))
 279                         die("BUG: your vsnprintf is broken (insatiable)");
 280         }
 281         strbuf_setlen(sb, sb->len + len);
 282 }
 283
 284 void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn,
 285                    void *context)
 286 {
 287         for (;;) {
 288                 const char *percent;
 289                 size_t consumed;
 290
 291                 percent = strchrnul(format, '%');
 292                 strbuf_add(sb, format, percent - format);
 293                 if (!*percent)
 294                         break;
 295                 format = percent + 1;
 296
 297                 if (*format == '%') {
 298                         strbuf_addch(sb, '%');
 299                         format++;
 300                         continue;
 301                 }
 302
 303                 consumed = fn(sb, format, context);
 304                 if (consumed)
 305                         format += consumed;
 306                 else
 307                         strbuf_addch(sb, '%');
 308         }
 309 }
 310
 311 size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder,
 312                 void *context)
 313 {
 314         struct strbuf_expand_dict_entry *e = context;
 315         size_t len;
 316
 317         for (; e->placeholder && (len = strlen(e->placeholder)); e++) {
 318                 if (!strncmp(placeholder, e->placeholder, len)) {
 319                         if (e->value)
 320                                 strbuf_addstr(sb, e->value);
 321                         return len;
 322                 }
 323         }
 324         return 0;
 325 }
 326
 327 void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src)
 328 {
 329         int i, len = src->len;
 330
 331         for (i = 0; i < len; i++) {
 332                 if (src->buf[i] == '%')
 333                         strbuf_addch(dst, '%');
 334                 strbuf_addch(dst, src->buf[i]);
 335         }
 336 }
 337
 338 size_t strbuf_fread(struct strbuf *sb, size_t size, FILE *f)
 339 {
 340         size_t res;
 341         size_t oldalloc = sb->alloc;
 342
 343         strbuf_grow(sb, size);
 344         res = fread(sb->buf + sb->len, 1, size, f);
 345         if (res > 0)
 346                 strbuf_setlen(sb, sb->len + res);
 347         else if (oldalloc == 0)
 348                 strbuf_release(sb);
 349         return res;
 350 }
 351
 352 ssize_t strbuf_read(struct strbuf *sb, int fd, size_t hint)
 353 {
 354         size_t oldlen = sb->len;
 355         size_t oldalloc = sb->alloc;
 356
 357         strbuf_grow(sb, hint ? hint : 8192);
 358         for (;;) {
 359                 ssize_t cnt;
 360
 361                 cnt = xread(fd, sb->buf + sb->len, sb->alloc - sb->len - 1);
 362                 if (cnt < 0) {
 363                         if (oldalloc == 0)
 364                                 strbuf_release(sb);
 365                         else
 366                                 strbuf_setlen(sb, oldlen);
 367                         return -1;
 368                 }
 369                 if (!cnt)
 370                         break;
 371                 sb->len += cnt;
 372                 strbuf_grow(sb, 8192);
 373         }
 374
 375         sb->buf[sb->len] = '\0';
 376         return sb->len - oldlen;
 377 }
 378
 379 #define STRBUF_MAXLINK (2*PATH_MAX)
 380
 381 int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint)
 382 {
 383         size_t oldalloc = sb->alloc;
 384
 385         if (hint < 32)
 386                 hint = 32;
 387
 388         while (hint < STRBUF_MAXLINK) {
 389                 int len;
 390
 391                 strbuf_grow(sb, hint);
 392                 len = readlink(path, sb->buf, hint);
 393                 if (len < 0) {
 394                         if (errno != ERANGE)
 395                                 break;
 396                 } else if (len < hint) {
 397                         strbuf_setlen(sb, len);
 398                         return 0;
 399                 }
 400
 401                 /* .. the buffer was too small - try again */
 402                 hint *= 2;
 403         }
 404         if (oldalloc == 0)
 405                 strbuf_release(sb);
 406         return -1;
 407 }
 408
 409 int strbuf_getcwd(struct strbuf *sb)
 410 {
 411         size_t oldalloc = sb->alloc;
 412         size_t guessed_len = 128;
 413
 414         for (;; guessed_len *= 2) {
 415                 strbuf_grow(sb, guessed_len);
 416                 if (getcwd(sb->buf, sb->alloc)) {
 417                         strbuf_setlen(sb, strlen(sb->buf));
 418                         return 0;
 419                 }
 420                 if (errno != ERANGE)
 421                         break;
 422         }
 423         if (oldalloc == 0)
 424                 strbuf_release(sb);
 425         else
 426                 strbuf_reset(sb);
 427         return -1;
 428 }
 429
 430 int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
 431 {
 432         int ch;
 433
 434         if (feof(fp))
 435                 return EOF;
 436
 437         strbuf_reset(sb);
 438         while ((ch = fgetc(fp)) != EOF) {
 439                 strbuf_grow(sb, 1);
 440                 sb->buf[sb->len++] = ch;
 441                 if (ch == term)
 442                         break;
 443         }
 444         if (ch == EOF && sb->len == 0)
 445                 return EOF;
 446
 447         sb->buf[sb->len] = '\0';
 448         return 0;
 449 }
 450
 451 int strbuf_getline(struct strbuf *sb, FILE *fp, int term)
 452 {
 453         if (strbuf_getwholeline(sb, fp, term))
 454                 return EOF;
 455         if (sb->buf[sb->len-1] == term)
 456                 strbuf_setlen(sb, sb->len-1);
 457         return 0;
 458 }
 459
 460 int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
 461 {
 462         strbuf_reset(sb);
 463
 464         while (1) {
 465                 char ch;
 466                 ssize_t len = xread(fd, &ch, 1);
 467                 if (len <= 0)
 468                         return EOF;
 469                 strbuf_addch(sb, ch);
 470                 if (ch == term)
 471                         break;
 472         }
 473         return 0;
 474 }
 475
 476 int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint)
 477 {
 478         int fd, len;
 479
 480         fd = open(path, O_RDONLY);
 481         if (fd < 0)
 482                 return -1;
 483         len = strbuf_read(sb, fd, hint);
 484         close(fd);
 485         if (len < 0)
 486                 return -1;
 487
 488         return len;
 489 }
 490
 491 void strbuf_add_lines(struct strbuf *out, const char *prefix,
 492                       const char *buf, size_t size)
 493 {
 494         add_lines(out, prefix, NULL, buf, size);
 495 }
 496
 497 void strbuf_addstr_xml_quoted(struct strbuf *buf, const char *s)
 498 {
 499         while (*s) {
 500                 size_t len = strcspn(s, "\"<>&");
 501                 strbuf_add(buf, s, len);
 502                 s += len;
 503                 switch (*s) {
 504                 case '"':
 505                         strbuf_addstr(buf, "&quot;");
 506                         break;
 507                 case '<':
 508                         strbuf_addstr(buf, "&lt;");
 509                         break;
 510                 case '>':
 511                         strbuf_addstr(buf, "&gt;");
 512                         break;
 513                 case '&':
 514                         strbuf_addstr(buf, "&amp;");
 515                         break;
 516                 case 0:
 517                         return;
 518                 }
 519                 s++;
 520         }
 521 }
 522
 523 static int is_rfc3986_reserved(char ch)
 524 {
 525         switch (ch) {
 526                 case '!': case '*': case '\'': case '(': case ')': case ';':
 527                 case ':': case '@': case '&': case '=': case '+': case '$':
 528                 case ',': case '/': case '?': case '#': case '[': case ']':
 529                         return 1;
 530         }
 531         return 0;
 532 }
 533
 534 static int is_rfc3986_unreserved(char ch)
 535 {
 536         return isalnum(ch) ||
 537                 ch == '-' || ch == '_' || ch == '.' || ch == '~';
 538 }
 539
 540 static void strbuf_add_urlencode(struct strbuf *sb, const char *s, size_t len,
 541                                  int reserved)
 542 {
 543         strbuf_grow(sb, len);
 544         while (len--) {
 545                 char ch = *s++;
 546                 if (is_rfc3986_unreserved(ch) ||
 547                     (!reserved && is_rfc3986_reserved(ch)))
 548                         strbuf_addch(sb, ch);
 549                 else
 550                         strbuf_addf(sb, "%%%02x", ch);
 551         }
 552 }
 553
 554 void strbuf_addstr_urlencode(struct strbuf *sb, const char *s,
 555                              int reserved)
 556 {
 557         strbuf_add_urlencode(sb, s, strlen(s), reserved);
 558 }
 559
 560 void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes)
 561 {
 562         if (bytes > 1 << 30) {
 563                 strbuf_addf(buf, "%u.%2.2u GiB",
 564                             (int)(bytes >> 30),
 565                             (int)(bytes & ((1 << 30) - 1)) / 10737419);
 566         } else if (bytes > 1 << 20) {
 567                 int x = bytes + 5243;  /* for rounding */
 568                 strbuf_addf(buf, "%u.%2.2u MiB",
 569                             x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
 570         } else if (bytes > 1 << 10) {
 571                 int x = bytes + 5;  /* for rounding */
 572                 strbuf_addf(buf, "%u.%2.2u KiB",
 573                             x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
 574         } else {
 575                 strbuf_addf(buf, "%u bytes", (int)bytes);
 576         }
 577 }
 578
 579 void strbuf_add_absolute_path(struct strbuf *sb, const char *path)
 580 {
 581         if (!*path)
 582                 die("The empty string is not a valid path");
 583         if (!is_absolute_path(path)) {
 584                 struct stat cwd_stat, pwd_stat;
 585                 size_t orig_len = sb->len;
 586                 char *cwd = xgetcwd();
 587                 char *pwd = getenv("PWD");
 588                 if (pwd && strcmp(pwd, cwd) &&
 589                     !stat(cwd, &cwd_stat) &&
 590                     (cwd_stat.st_dev || cwd_stat.st_ino) &&
 591                     !stat(pwd, &pwd_stat) &&
 592                     pwd_stat.st_dev == cwd_stat.st_dev &&
 593                     pwd_stat.st_ino == cwd_stat.st_ino)
 594                         strbuf_addstr(sb, pwd);
 595                 else
 596                         strbuf_addstr(sb, cwd);
 597                 if (sb->len > orig_len && !is_dir_sep(sb->buf[sb->len - 1]))
 598                         strbuf_addch(sb, '/');
 599                 free(cwd);
 600         }
 601         strbuf_addstr(sb, path);
 602 }
 603
 604 int printf_ln(const char *fmt, ...)
 605 {
 606         int ret;
 607         va_list ap;
 608         va_start(ap, fmt);
 609         ret = vprintf(fmt, ap);
 610         va_end(ap);
 611         if (ret < 0 || putchar('\n') == EOF)
 612                 return -1;
 613         return ret + 1;
 614 }
 615
 616 int fprintf_ln(FILE *fp, const char *fmt, ...)
 617 {
 618         int ret;
 619         va_list ap;
 620         va_start(ap, fmt);
 621         ret = vfprintf(fp, fmt, ap);
 622         va_end(ap);
 623         if (ret < 0 || putc('\n', fp) == EOF)
 624                 return -1;
 625         return ret + 1;
 626 }
 627
 628 char *xstrdup_tolower(const char *string)
 629 {
 630         char *result;
 631         size_t len, i;
 632
 633         len = strlen(string);
 634         result = xmalloc(len + 1);
 635         for (i = 0; i < len; i++)
 636                 result[i] = tolower(string[i]);
 637         result[i] = '\0';
 638         return result;
 639 }
 640
 641 char *xstrvfmt(const char *fmt, va_list ap)
 642 {
 643         struct strbuf buf = STRBUF_INIT;
 644         strbuf_vaddf(&buf, fmt, ap);
 645         return strbuf_detach(&buf, NULL);
 646 }
 647
 648 char *xstrfmt(const char *fmt, ...)
 649 {
 650         va_list ap;
 651         char *ret;
 652
 653         va_start(ap, fmt);
 654         ret = xstrvfmt(fmt, ap);
 655         va_end(ap);
 656
 657         return ret;
 658 }