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