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