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