builtin/ls-files.c

   1 /*
   2  * This merges the file listing in the directory cache index
   3  * with the actual working directory list, and shows different
   4  * combinations of the two.
   5  *
   6  * Copyright (C) Linus Torvalds, 2005
   7  */
   8 #include "cache.h"
   9 #include "quote.h"
  10 #include "dir.h"
  11 #include "builtin.h"
  12 #include "tree.h"
  13 #include "parse-options.h"
  14 #include "resolve-undo.h"
  15 #include "string-list.h"
  16
  17 static int abbrev;
  18 static int show_deleted;
  19 static int show_cached;
  20 static int show_others;
  21 static int show_stage;
  22 static int show_unmerged;
  23 static int show_resolve_undo;
  24 static int show_modified;
  25 static int show_killed;
  26 static int show_valid_bit;
  27 static int line_terminator = '\n';
  28 static int debug_mode;
  29
  30 static const char *prefix;
  31 static int max_prefix_len;
  32 static int prefix_len;
  33 static const char **pathspec;
  34 static int error_unmatch;
  35 static char *ps_matched;
  36 static const char *with_tree;
  37 static int exc_given;
  38
  39 static const char *tag_cached = "";
  40 static const char *tag_unmerged = "";
  41 static const char *tag_removed = "";
  42 static const char *tag_other = "";
  43 static const char *tag_killed = "";
  44 static const char *tag_modified = "";
  45 static const char *tag_skip_worktree = "";
  46 static const char *tag_resolve_undo = "";
  47
  48 static void write_name(const char* name, size_t len)
  49 {
  50         write_name_quoted_relative(name, len, prefix, prefix_len, stdout,
  51                         line_terminator);
  52 }
  53
  54 static void show_dir_entry(const char *tag, struct dir_entry *ent)
  55 {
  56         int len = max_prefix_len;
  57
  58         if (len >= ent->len)
  59                 die("git ls-files: internal error - directory entry not superset of prefix");
  60
  61         if (!match_pathspec(pathspec, ent->name, ent->len, len, ps_matched))
  62                 return;
  63
  64         fputs(tag, stdout);
  65         write_name(ent->name, ent->len);
  66 }
  67
  68 static void show_other_files(struct dir_struct *dir)
  69 {
  70         int i;
  71
  72         for (i = 0; i < dir->nr; i++) {
  73                 struct dir_entry *ent = dir->entries[i];
  74                 if (!cache_name_is_other(ent->name, ent->len))
  75                         continue;
  76                 show_dir_entry(tag_other, ent);
  77         }
  78 }
  79
  80 static void show_killed_files(struct dir_struct *dir)
  81 {
  82         int i;
  83         for (i = 0; i < dir->nr; i++) {
  84                 struct dir_entry *ent = dir->entries[i];
  85                 char *cp, *sp;
  86                 int pos, len, killed = 0;
  87
  88                 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
  89                         sp = strchr(cp, '/');
  90                         if (!sp) {
  91                                 /* If ent->name is prefix of an entry in the
  92                                  * cache, it will be killed.
  93                                  */
  94                                 pos = cache_name_pos(ent->name, ent->len);
  95                                 if (0 <= pos)
  96                                         die("bug in show-killed-files");
  97                                 pos = -pos - 1;
  98                                 while (pos < active_nr &&
  99                                        ce_stage(active_cache[pos]))
 100                                         pos++; /* skip unmerged */
 101                                 if (active_nr <= pos)
 102                                         break;
 103                                 /* pos points at a name immediately after
 104                                  * ent->name in the cache.  Does it expect
 105                                  * ent->name to be a directory?
 106                                  */
 107                                 len = ce_namelen(active_cache[pos]);
 108                                 if ((ent->len < len) &&
 109                                     !strncmp(active_cache[pos]->name,
 110                                              ent->name, ent->len) &&
 111                                     active_cache[pos]->name[ent->len] == '/')
 112                                         killed = 1;
 113                                 break;
 114                         }
 115                         if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
 116                                 /* If any of the leading directories in
 117                                  * ent->name is registered in the cache,
 118                                  * ent->name will be killed.
 119                                  */
 120                                 killed = 1;
 121                                 break;
 122                         }
 123                 }
 124                 if (killed)
 125                         show_dir_entry(tag_killed, dir->entries[i]);
 126         }
 127 }
 128
 129 static void show_ce_entry(const char *tag, struct cache_entry *ce)
 130 {
 131         int len = max_prefix_len;
 132
 133         if (len >= ce_namelen(ce))
 134                 die("git ls-files: internal error - cache entry not superset of prefix");
 135
 136         if (!match_pathspec(pathspec, ce->name, ce_namelen(ce), len, ps_matched))
 137                 return;
 138
 139         if (tag && *tag && show_valid_bit &&
 140             (ce->ce_flags & CE_VALID)) {
 141                 static char alttag[4];
 142                 memcpy(alttag, tag, 3);
 143                 if (isalpha(tag[0]))
 144                         alttag[0] = tolower(tag[0]);
 145                 else if (tag[0] == '?')
 146                         alttag[0] = '!';
 147                 else {
 148                         alttag[0] = 'v';
 149                         alttag[1] = tag[0];
 150                         alttag[2] = ' ';
 151                         alttag[3] = 0;
 152                 }
 153                 tag = alttag;
 154         }
 155
 156         if (!show_stage) {
 157                 fputs(tag, stdout);
 158         } else {
 159                 printf("%s%06o %s %d\t",
 160                        tag,
 161                        ce->ce_mode,
 162                        find_unique_abbrev(ce->sha1,abbrev),
 163                        ce_stage(ce));
 164         }
 165         write_name(ce->name, ce_namelen(ce));
 166         if (debug_mode) {
 167                 printf("  ctime: %d:%d\n", ce->ce_ctime.sec, ce->ce_ctime.nsec);
 168                 printf("  mtime: %d:%d\n", ce->ce_mtime.sec, ce->ce_mtime.nsec);
 169                 printf("  dev: %d\tino: %d\n", ce->ce_dev, ce->ce_ino);
 170                 printf("  uid: %d\tgid: %d\n", ce->ce_uid, ce->ce_gid);
 171                 printf("  size: %d\tflags: %x\n", ce->ce_size, ce->ce_flags);
 172         }
 173 }
 174
 175 static void show_ru_info(void)
 176 {
 177         struct string_list_item *item;
 178
 179         if (!the_index.resolve_undo)
 180                 return;
 181
 182         for_each_string_list_item(item, the_index.resolve_undo) {
 183                 const char *path = item->string;
 184                 struct resolve_undo_info *ui = item->util;
 185                 int i, len;
 186
 187                 len = strlen(path);
 188                 if (len < max_prefix_len)
 189                         continue; /* outside of the prefix */
 190                 if (!match_pathspec(pathspec, path, len, max_prefix_len, ps_matched))
 191                         continue; /* uninterested */
 192                 for (i = 0; i < 3; i++) {
 193                         if (!ui->mode[i])
 194                                 continue;
 195                         printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
 196                                find_unique_abbrev(ui->sha1[i], abbrev),
 197                                i + 1);
 198                         write_name(path, len);
 199                 }
 200         }
 201 }
 202
 203 static void show_files(struct dir_struct *dir)
 204 {
 205         int i;
 206
 207         /* For cached/deleted files we don't need to even do the readdir */
 208         if (show_others || show_killed) {
 209                 fill_directory(dir, pathspec);
 210                 if (show_others)
 211                         show_other_files(dir);
 212                 if (show_killed)
 213                         show_killed_files(dir);
 214         }
 215         if (show_cached | show_stage) {
 216                 for (i = 0; i < active_nr; i++) {
 217                         struct cache_entry *ce = active_cache[i];
 218                         int dtype = ce_to_dtype(ce);
 219                         if (dir->flags & DIR_SHOW_IGNORED &&
 220                             !excluded(dir, ce->name, &dtype))
 221                                 continue;
 222                         if (show_unmerged && !ce_stage(ce))
 223                                 continue;
 224                         if (ce->ce_flags & CE_UPDATE)
 225                                 continue;
 226                         show_ce_entry(ce_stage(ce) ? tag_unmerged :
 227                                 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
 228                 }
 229         }
 230         if (show_deleted | show_modified) {
 231                 for (i = 0; i < active_nr; i++) {
 232                         struct cache_entry *ce = active_cache[i];
 233                         struct stat st;
 234                         int err;
 235                         int dtype = ce_to_dtype(ce);
 236                         if (dir->flags & DIR_SHOW_IGNORED &&
 237                             !excluded(dir, ce->name, &dtype))
 238                                 continue;
 239                         if (ce->ce_flags & CE_UPDATE)
 240                                 continue;
 241                         if (ce_skip_worktree(ce))
 242                                 continue;
 243                         err = lstat(ce->name, &st);
 244                         if (show_deleted && err)
 245                                 show_ce_entry(tag_removed, ce);
 246                         if (show_modified && ce_modified(ce, &st, 0))
 247                                 show_ce_entry(tag_modified, ce);
 248                 }
 249         }
 250 }
 251
 252 /*
 253  * Prune the index to only contain stuff starting with "prefix"
 254  */
 255 static void prune_cache(const char *prefix)
 256 {
 257         int pos = cache_name_pos(prefix, max_prefix_len);
 258         unsigned int first, last;
 259
 260         if (pos < 0)
 261                 pos = -pos-1;
 262         memmove(active_cache, active_cache + pos,
 263                 (active_nr - pos) * sizeof(struct cache_entry *));
 264         active_nr -= pos;
 265         first = 0;
 266         last = active_nr;
 267         while (last > first) {
 268                 int next = (last + first) >> 1;
 269                 struct cache_entry *ce = active_cache[next];
 270                 if (!strncmp(ce->name, prefix, max_prefix_len)) {
 271                         first = next+1;
 272                         continue;
 273                 }
 274                 last = next;
 275         }
 276         active_nr = last;
 277 }
 278
 279 static const char *pathspec_prefix(const char *prefix)
 280 {
 281         const char **p, *n, *prev;
 282         unsigned long max;
 283
 284         if (!pathspec) {
 285                 max_prefix_len = prefix ? strlen(prefix) : 0;
 286                 return prefix;
 287         }
 288
 289         prev = NULL;
 290         max = PATH_MAX;
 291         for (p = pathspec; (n = *p) != NULL; p++) {
 292                 int i, len = 0;
 293                 for (i = 0; i < max; i++) {
 294                         char c = n[i];
 295                         if (prev && prev[i] != c)
 296                                 break;
 297                         if (!c || c == '*' || c == '?')
 298                                 break;
 299                         if (c == '/')
 300                                 len = i+1;
 301                 }
 302                 prev = n;
 303                 if (len < max) {
 304                         max = len;
 305                         if (!max)
 306                                 break;
 307                 }
 308         }
 309
 310         max_prefix_len = max;
 311         return max ? xmemdupz(prev, max) : NULL;
 312 }
 313
 314 static void strip_trailing_slash_from_submodules(void)
 315 {
 316         const char **p;
 317
 318         for (p = pathspec; *p != NULL; p++) {
 319                 int len = strlen(*p), pos;
 320
 321                 if (len < 1 || (*p)[len - 1] != '/')
 322                         continue;
 323                 pos = cache_name_pos(*p, len - 1);
 324                 if (pos >= 0 && S_ISGITLINK(active_cache[pos]->ce_mode))
 325                         *p = xstrndup(*p, len - 1);
 326         }
 327 }
 328
 329 /*
 330  * Read the tree specified with --with-tree option
 331  * (typically, HEAD) into stage #1 and then
 332  * squash them down to stage #0.  This is used for
 333  * --error-unmatch to list and check the path patterns
 334  * that were given from the command line.  We are not
 335  * going to write this index out.
 336  */
 337 void overlay_tree_on_cache(const char *tree_name, const char *prefix)
 338 {
 339         struct tree *tree;
 340         unsigned char sha1[20];
 341         const char **match;
 342         struct cache_entry *last_stage0 = NULL;
 343         int i;
 344
 345         if (get_sha1(tree_name, sha1))
 346                 die("tree-ish %s not found.", tree_name);
 347         tree = parse_tree_indirect(sha1);
 348         if (!tree)
 349                 die("bad tree-ish %s", tree_name);
 350
 351         /* Hoist the unmerged entries up to stage #3 to make room */
 352         for (i = 0; i < active_nr; i++) {
 353                 struct cache_entry *ce = active_cache[i];
 354                 if (!ce_stage(ce))
 355                         continue;
 356                 ce->ce_flags |= CE_STAGEMASK;
 357         }
 358
 359         if (prefix) {
 360                 static const char *(matchbuf[2]);
 361                 matchbuf[0] = prefix;
 362                 matchbuf[1] = NULL;
 363                 match = matchbuf;
 364         } else
 365                 match = NULL;
 366         if (read_tree(tree, 1, match))
 367                 die("unable to read tree entries %s", tree_name);
 368
 369         for (i = 0; i < active_nr; i++) {
 370                 struct cache_entry *ce = active_cache[i];
 371                 switch (ce_stage(ce)) {
 372                 case 0:
 373                         last_stage0 = ce;
 374                         /* fallthru */
 375                 default:
 376                         continue;
 377                 case 1:
 378                         /*
 379                          * If there is stage #0 entry for this, we do not
 380                          * need to show it.  We use CE_UPDATE bit to mark
 381                          * such an entry.
 382                          */
 383                         if (last_stage0 &&
 384                             !strcmp(last_stage0->name, ce->name))
 385                                 ce->ce_flags |= CE_UPDATE;
 386                 }
 387         }
 388 }
 389
 390 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_len)
 391 {
 392         /*
 393          * Make sure all pathspec matched; otherwise it is an error.
 394          */
 395         int num, errors = 0;
 396         for (num = 0; pathspec[num]; num++) {
 397                 int other, found_dup;
 398
 399                 if (ps_matched[num])
 400                         continue;
 401                 /*
 402                  * The caller might have fed identical pathspec
 403                  * twice.  Do not barf on such a mistake.
 404                  */
 405                 for (found_dup = other = 0;
 406                      !found_dup && pathspec[other];
 407                      other++) {
 408                         if (other == num || !ps_matched[other])
 409                                 continue;
 410                         if (!strcmp(pathspec[other], pathspec[num]))
 411                                 /*
 412                                  * Ok, we have a match already.
 413                                  */
 414                                 found_dup = 1;
 415                 }
 416                 if (found_dup)
 417                         continue;
 418
 419                 error("pathspec '%s' did not match any file(s) known to git.",
 420                       pathspec[num] + prefix_len);
 421                 errors++;
 422         }
 423         return errors;
 424 }
 425
 426 static const char * const ls_files_usage[] = {
 427         "git ls-files [options] [<file>]*",
 428         NULL
 429 };
 430
 431 static int option_parse_z(const struct option *opt,
 432                           const char *arg, int unset)
 433 {
 434         line_terminator = unset ? '\n' : '\0';
 435
 436         return 0;
 437 }
 438
 439 static int option_parse_exclude(const struct option *opt,
 440                                 const char *arg, int unset)
 441 {
 442         struct exclude_list *list = opt->value;
 443
 444         exc_given = 1;
 445         add_exclude(arg, "", 0, list);
 446
 447         return 0;
 448 }
 449
 450 static int option_parse_exclude_from(const struct option *opt,
 451                                      const char *arg, int unset)
 452 {
 453         struct dir_struct *dir = opt->value;
 454
 455         exc_given = 1;
 456         add_excludes_from_file(dir, arg);
 457
 458         return 0;
 459 }
 460
 461 static int option_parse_exclude_standard(const struct option *opt,
 462                                          const char *arg, int unset)
 463 {
 464         struct dir_struct *dir = opt->value;
 465
 466         exc_given = 1;
 467         setup_standard_excludes(dir);
 468
 469         return 0;
 470 }
 471
 472 int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
 473 {
 474         int require_work_tree = 0, show_tag = 0;
 475         const char *max_prefix;
 476         struct dir_struct dir;
 477         struct option builtin_ls_files_options[] = {
 478                 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
 479                         "paths are separated with NUL character",
 480                         PARSE_OPT_NOARG, option_parse_z },
 481                 OPT_BOOLEAN('t', NULL, &show_tag,
 482                         "identify the file status with tags"),
 483                 OPT_BOOLEAN('v', NULL, &show_valid_bit,
 484                         "use lowercase letters for 'assume unchanged' files"),
 485                 OPT_BOOLEAN('c', "cached", &show_cached,
 486                         "show cached files in the output (default)"),
 487                 OPT_BOOLEAN('d', "deleted", &show_deleted,
 488                         "show deleted files in the output"),
 489                 OPT_BOOLEAN('m', "modified", &show_modified,
 490                         "show modified files in the output"),
 491                 OPT_BOOLEAN('o', "others", &show_others,
 492                         "show other files in the output"),
 493                 OPT_BIT('i', "ignored", &dir.flags,
 494                         "show ignored files in the output",
 495                         DIR_SHOW_IGNORED),
 496                 OPT_BOOLEAN('s', "stage", &show_stage,
 497                         "show staged contents' object name in the output"),
 498                 OPT_BOOLEAN('k', "killed", &show_killed,
 499                         "show files on the filesystem that need to be removed"),
 500                 OPT_BIT(0, "directory", &dir.flags,
 501                         "show 'other' directories' name only",
 502                         DIR_SHOW_OTHER_DIRECTORIES),
 503                 OPT_NEGBIT(0, "empty-directory", &dir.flags,
 504                         "don't show empty directories",
 505                         DIR_HIDE_EMPTY_DIRECTORIES),
 506                 OPT_BOOLEAN('u', "unmerged", &show_unmerged,
 507                         "show unmerged files in the output"),
 508                 OPT_BOOLEAN(0, "resolve-undo", &show_resolve_undo,
 509                             "show resolve-undo information"),
 510                 { OPTION_CALLBACK, 'x', "exclude", &dir.exclude_list[EXC_CMDL], "pattern",
 511                         "skip files matching pattern",
 512                         0, option_parse_exclude },
 513                 { OPTION_CALLBACK, 'X', "exclude-from", &dir, "file",
 514                         "exclude patterns are read from <file>",
 515                         0, option_parse_exclude_from },
 516                 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, "file",
 517                         "read additional per-directory exclude patterns in <file>"),
 518                 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
 519                         "add the standard git exclusions",
 520                         PARSE_OPT_NOARG, option_parse_exclude_standard },
 521                 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
 522                         "make the output relative to the project top directory",
 523                         PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
 524                 OPT_BOOLEAN(0, "error-unmatch", &error_unmatch,
 525                         "if any <file> is not in the index, treat this as an error"),
 526                 OPT_STRING(0, "with-tree", &with_tree, "tree-ish",
 527                         "pretend that paths removed since <tree-ish> are still present"),
 528                 OPT__ABBREV(&abbrev),
 529                 OPT_BOOLEAN(0, "debug", &debug_mode, "show debugging data"),
 530                 OPT_END()
 531         };
 532
 533         if (argc == 2 && !strcmp(argv[1], "-h"))
 534                 usage_with_options(ls_files_usage, builtin_ls_files_options);
 535
 536         memset(&dir, 0, sizeof(dir));
 537         prefix = cmd_prefix;
 538         if (prefix)
 539                 prefix_len = strlen(prefix);
 540         git_config(git_default_config, NULL);
 541
 542         if (read_cache() < 0)
 543                 die("index file corrupt");
 544
 545         argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
 546                         ls_files_usage, 0);
 547         if (show_tag || show_valid_bit) {
 548                 tag_cached = "H ";
 549                 tag_unmerged = "M ";
 550                 tag_removed = "R ";
 551                 tag_modified = "C ";
 552                 tag_other = "? ";
 553                 tag_killed = "K ";
 554                 tag_skip_worktree = "S ";
 555                 tag_resolve_undo = "U ";
 556         }
 557         if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
 558                 require_work_tree = 1;
 559         if (show_unmerged)
 560                 /*
 561                  * There's no point in showing unmerged unless
 562                  * you also show the stage information.
 563                  */
 564                 show_stage = 1;
 565         if (dir.exclude_per_dir)
 566                 exc_given = 1;
 567
 568         if (require_work_tree && !is_inside_work_tree())
 569                 setup_work_tree();
 570
 571         pathspec = get_pathspec(prefix, argv);
 572
 573         /* be nice with submodule paths ending in a slash */
 574         if (pathspec)
 575                 strip_trailing_slash_from_submodules();
 576
 577         /* Find common prefix for all pathspec's */
 578         max_prefix = pathspec_prefix(prefix);
 579
 580         /* Treat unmatching pathspec elements as errors */
 581         if (pathspec && error_unmatch) {
 582                 int num;
 583                 for (num = 0; pathspec[num]; num++)
 584                         ;
 585                 ps_matched = xcalloc(1, num);
 586         }
 587
 588         if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
 589                 die("ls-files --ignored needs some exclude pattern");
 590
 591         /* With no flags, we default to showing the cached files */
 592         if (!(show_stage | show_deleted | show_others | show_unmerged |
 593               show_killed | show_modified | show_resolve_undo))
 594                 show_cached = 1;
 595
 596         if (max_prefix)
 597                 prune_cache(max_prefix);
 598         if (with_tree) {
 599                 /*
 600                  * Basic sanity check; show-stages and show-unmerged
 601                  * would not make any sense with this option.
 602                  */
 603                 if (show_stage || show_unmerged)
 604                         die("ls-files --with-tree is incompatible with -s or -u");
 605                 overlay_tree_on_cache(with_tree, max_prefix);
 606         }
 607         show_files(&dir);
 608         if (show_resolve_undo)
 609                 show_ru_info();
 610
 611         if (ps_matched) {
 612                 int bad;
 613                 bad = report_path_error(ps_matched, pathspec, prefix_len);
 614                 if (bad)
 615                         fprintf(stderr, "Did you forget to 'git add'?\n");
 616
 617                 return bad ? 1 : 0;
 618         }
 619
 620         return 0;
 621 }