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