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.
6 * Copyright (C) Linus Torvalds, 2005
13 #include "parse-options.h"
14 #include "resolve-undo.h"
15 #include "string-list.h"
17 #include "run-command.h"
18 #include "submodule.h"
21 static int show_deleted;
22 static int show_cached;
23 static int show_others;
24 static int show_stage;
25 static int show_unmerged;
26 static int show_resolve_undo;
27 static int show_modified;
28 static int show_killed;
29 static int show_valid_bit;
30 static int line_terminator = '\n';
31 static int debug_mode;
33 static int recurse_submodules;
34 static struct argv_array submodule_options = ARGV_ARRAY_INIT;
36 static const char *prefix;
37 static const char *super_prefix;
38 static int max_prefix_len;
39 static int prefix_len;
40 static struct pathspec pathspec;
41 static int error_unmatch;
42 static char *ps_matched;
43 static const char *with_tree;
45 static int exclude_args;
47 static const char *tag_cached = "";
48 static const char *tag_unmerged = "";
49 static const char *tag_removed = "";
50 static const char *tag_other = "";
51 static const char *tag_killed = "";
52 static const char *tag_modified = "";
53 static const char *tag_skip_worktree = "";
54 static const char *tag_resolve_undo = "";
56 static void write_eolinfo(const struct cache_entry *ce, const char *path)
62 const char *i_txt = "";
63 const char *w_txt = "";
64 const char *a_txt = get_convert_attr_ascii(path);
65 if (ce && S_ISREG(ce->ce_mode))
66 i_txt = get_cached_convert_stats_ascii(&the_index,
68 if (!lstat(path, &st) && S_ISREG(st.st_mode))
69 w_txt = get_wt_convert_stats_ascii(path);
70 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
74 static void write_name(const char *name)
77 * Prepend the super_prefix to name to construct the full_name to be
80 struct strbuf full_name = STRBUF_INIT;
82 strbuf_addstr(&full_name, super_prefix);
83 strbuf_addstr(&full_name, name);
88 * With "--full-name", prefix_len=0; this caller needs to pass
89 * an empty string in that case (a NULL is good for "").
91 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
92 stdout, line_terminator);
94 strbuf_release(&full_name);
97 static void show_dir_entry(const char *tag, struct dir_entry *ent)
99 int len = max_prefix_len;
102 die("git ls-files: internal error - directory entry not superset of prefix");
104 if (!dir_path_match(ent, &pathspec, len, ps_matched))
108 write_eolinfo(NULL, ent->name);
109 write_name(ent->name);
112 static void show_other_files(struct dir_struct *dir)
116 for (i = 0; i < dir->nr; i++) {
117 struct dir_entry *ent = dir->entries[i];
118 if (!cache_name_is_other(ent->name, ent->len))
120 show_dir_entry(tag_other, ent);
124 static void show_killed_files(struct dir_struct *dir)
127 for (i = 0; i < dir->nr; i++) {
128 struct dir_entry *ent = dir->entries[i];
130 int pos, len, killed = 0;
132 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
133 sp = strchr(cp, '/');
135 /* If ent->name is prefix of an entry in the
136 * cache, it will be killed.
138 pos = cache_name_pos(ent->name, ent->len);
140 die("BUG: killed-file %.*s not found",
141 ent->len, ent->name);
143 while (pos < active_nr &&
144 ce_stage(active_cache[pos]))
145 pos++; /* skip unmerged */
146 if (active_nr <= pos)
148 /* pos points at a name immediately after
149 * ent->name in the cache. Does it expect
150 * ent->name to be a directory?
152 len = ce_namelen(active_cache[pos]);
153 if ((ent->len < len) &&
154 !strncmp(active_cache[pos]->name,
155 ent->name, ent->len) &&
156 active_cache[pos]->name[ent->len] == '/')
160 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
161 /* If any of the leading directories in
162 * ent->name is registered in the cache,
163 * ent->name will be killed.
170 show_dir_entry(tag_killed, dir->entries[i]);
175 * Compile an argv_array with all of the options supported by --recurse_submodules
177 static void compile_submodule_options(const char **argv,
178 const struct dir_struct *dir,
181 if (line_terminator == '\0')
182 argv_array_push(&submodule_options, "-z");
184 argv_array_push(&submodule_options, "-t");
186 argv_array_push(&submodule_options, "-v");
188 argv_array_push(&submodule_options, "--cached");
190 argv_array_push(&submodule_options, "--eol");
192 argv_array_push(&submodule_options, "--debug");
195 argv_array_push(&submodule_options, "--");
196 for (; *argv; argv++)
197 argv_array_push(&submodule_options, *argv);
201 * Recursively call ls-files on a submodule
203 static void show_gitlink(const struct cache_entry *ce)
205 struct child_process cp = CHILD_PROCESS_INIT;
209 prepare_submodule_repo_env(&cp.env_array);
210 argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
213 argv_array_pushf(&cp.env_array, "%s=%s",
214 GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
216 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
217 super_prefix ? super_prefix : "",
219 argv_array_push(&cp.args, "ls-files");
220 argv_array_push(&cp.args, "--recurse-submodules");
222 /* add supported options */
223 argv_array_pushv(&cp.args, submodule_options.argv);
226 dir = mkpathdup("%s/%s", get_git_work_tree(), ce->name);
228 status = run_command(&cp);
234 static void show_ce_entry(const char *tag, const struct cache_entry *ce)
236 struct strbuf name = STRBUF_INIT;
237 int len = max_prefix_len;
239 strbuf_addstr(&name, super_prefix);
240 strbuf_addstr(&name, ce->name);
242 if (len > ce_namelen(ce))
243 die("git ls-files: internal error - cache entry not superset of prefix");
245 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
246 submodule_path_match(&pathspec, name.buf, ps_matched)) {
248 } else if (match_pathspec(&pathspec, name.buf, name.len,
250 S_ISDIR(ce->ce_mode) ||
251 S_ISGITLINK(ce->ce_mode))) {
252 if (tag && *tag && show_valid_bit &&
253 (ce->ce_flags & CE_VALID)) {
254 static char alttag[4];
255 memcpy(alttag, tag, 3);
257 alttag[0] = tolower(tag[0]);
258 else if (tag[0] == '?')
272 printf("%s%06o %s %d\t",
275 find_unique_abbrev(ce->oid.hash, abbrev),
278 write_eolinfo(ce, ce->name);
279 write_name(ce->name);
281 const struct stat_data *sd = &ce->ce_stat_data;
283 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
284 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
285 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
286 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
287 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
291 strbuf_release(&name);
294 static void show_ru_info(void)
296 struct string_list_item *item;
298 if (!the_index.resolve_undo)
301 for_each_string_list_item(item, the_index.resolve_undo) {
302 const char *path = item->string;
303 struct resolve_undo_info *ui = item->util;
307 if (len < max_prefix_len)
308 continue; /* outside of the prefix */
309 if (!match_pathspec(&pathspec, path, len,
310 max_prefix_len, ps_matched, 0))
311 continue; /* uninterested */
312 for (i = 0; i < 3; i++) {
315 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
316 find_unique_abbrev(ui->sha1[i], abbrev),
323 static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
325 int dtype = ce_to_dtype(ce);
326 return is_excluded(dir, &the_index, ce->name, &dtype);
329 static void show_files(struct dir_struct *dir)
333 /* For cached/deleted files we don't need to even do the readdir */
334 if (show_others || show_killed) {
336 dir->flags |= DIR_COLLECT_KILLED_ONLY;
337 fill_directory(dir, &the_index, &pathspec);
339 show_other_files(dir);
341 show_killed_files(dir);
343 if (show_cached || show_stage) {
344 for (i = 0; i < active_nr; i++) {
345 const struct cache_entry *ce = active_cache[i];
346 if ((dir->flags & DIR_SHOW_IGNORED) &&
347 !ce_excluded(dir, ce))
349 if (show_unmerged && !ce_stage(ce))
351 if (ce->ce_flags & CE_UPDATE)
353 show_ce_entry(ce_stage(ce) ? tag_unmerged :
354 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
357 if (show_deleted || show_modified) {
358 for (i = 0; i < active_nr; i++) {
359 const struct cache_entry *ce = active_cache[i];
362 if ((dir->flags & DIR_SHOW_IGNORED) &&
363 !ce_excluded(dir, ce))
365 if (ce->ce_flags & CE_UPDATE)
367 if (ce_skip_worktree(ce))
369 err = lstat(ce->name, &st);
370 if (show_deleted && err)
371 show_ce_entry(tag_removed, ce);
372 if (show_modified && ce_modified(ce, &st, 0))
373 show_ce_entry(tag_modified, ce);
379 * Prune the index to only contain stuff starting with "prefix"
381 static void prune_cache(const char *prefix, size_t prefixlen)
384 unsigned int first, last;
388 pos = cache_name_pos(prefix, prefixlen);
393 while (last > first) {
394 int next = (last + first) >> 1;
395 const struct cache_entry *ce = active_cache[next];
396 if (!strncmp(ce->name, prefix, prefixlen)) {
402 memmove(active_cache, active_cache + pos,
403 (last - pos) * sizeof(struct cache_entry *));
404 active_nr = last - pos;
407 static int get_common_prefix_len(const char *common_prefix)
409 int common_prefix_len;
414 common_prefix_len = strlen(common_prefix);
417 * If the prefix has a trailing slash, strip it so that submodules wont
418 * be pruned from the index.
420 if (common_prefix[common_prefix_len - 1] == '/')
423 return common_prefix_len;
427 * Read the tree specified with --with-tree option
428 * (typically, HEAD) into stage #1 and then
429 * squash them down to stage #0. This is used for
430 * --error-unmatch to list and check the path patterns
431 * that were given from the command line. We are not
432 * going to write this index out.
434 void overlay_tree_on_index(struct index_state *istate,
435 const char *tree_name, const char *prefix)
438 struct object_id oid;
439 struct pathspec pathspec;
440 struct cache_entry *last_stage0 = NULL;
443 if (get_oid(tree_name, &oid))
444 die("tree-ish %s not found.", tree_name);
445 tree = parse_tree_indirect(&oid);
447 die("bad tree-ish %s", tree_name);
449 /* Hoist the unmerged entries up to stage #3 to make room */
450 for (i = 0; i < istate->cache_nr; i++) {
451 struct cache_entry *ce = istate->cache[i];
454 ce->ce_flags |= CE_STAGEMASK;
458 static const char *(matchbuf[1]);
460 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
461 PATHSPEC_PREFER_CWD, prefix, matchbuf);
463 memset(&pathspec, 0, sizeof(pathspec));
464 if (read_tree(tree, 1, &pathspec, istate))
465 die("unable to read tree entries %s", tree_name);
467 for (i = 0; i < istate->cache_nr; i++) {
468 struct cache_entry *ce = istate->cache[i];
469 switch (ce_stage(ce)) {
477 * If there is stage #0 entry for this, we do not
478 * need to show it. We use CE_UPDATE bit to mark
482 !strcmp(last_stage0->name, ce->name))
483 ce->ce_flags |= CE_UPDATE;
488 static const char * const ls_files_usage[] = {
489 N_("git ls-files [<options>] [<file>...]"),
493 static int option_parse_exclude(const struct option *opt,
494 const char *arg, int unset)
496 struct string_list *exclude_list = opt->value;
499 string_list_append(exclude_list, arg);
504 static int option_parse_exclude_from(const struct option *opt,
505 const char *arg, int unset)
507 struct dir_struct *dir = opt->value;
510 add_excludes_from_file(dir, arg);
515 static int option_parse_exclude_standard(const struct option *opt,
516 const char *arg, int unset)
518 struct dir_struct *dir = opt->value;
521 setup_standard_excludes(dir);
526 int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
528 int require_work_tree = 0, show_tag = 0, i;
529 const char *max_prefix;
530 struct dir_struct dir;
531 struct exclude_list *el;
532 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
533 struct option builtin_ls_files_options[] = {
534 /* Think twice before adding "--nul" synonym to this */
535 OPT_SET_INT('z', NULL, &line_terminator,
536 N_("paths are separated with NUL character"), '\0'),
537 OPT_BOOL('t', NULL, &show_tag,
538 N_("identify the file status with tags")),
539 OPT_BOOL('v', NULL, &show_valid_bit,
540 N_("use lowercase letters for 'assume unchanged' files")),
541 OPT_BOOL('c', "cached", &show_cached,
542 N_("show cached files in the output (default)")),
543 OPT_BOOL('d', "deleted", &show_deleted,
544 N_("show deleted files in the output")),
545 OPT_BOOL('m', "modified", &show_modified,
546 N_("show modified files in the output")),
547 OPT_BOOL('o', "others", &show_others,
548 N_("show other files in the output")),
549 OPT_BIT('i', "ignored", &dir.flags,
550 N_("show ignored files in the output"),
552 OPT_BOOL('s', "stage", &show_stage,
553 N_("show staged contents' object name in the output")),
554 OPT_BOOL('k', "killed", &show_killed,
555 N_("show files on the filesystem that need to be removed")),
556 OPT_BIT(0, "directory", &dir.flags,
557 N_("show 'other' directories' names only"),
558 DIR_SHOW_OTHER_DIRECTORIES),
559 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
560 OPT_NEGBIT(0, "empty-directory", &dir.flags,
561 N_("don't show empty directories"),
562 DIR_HIDE_EMPTY_DIRECTORIES),
563 OPT_BOOL('u', "unmerged", &show_unmerged,
564 N_("show unmerged files in the output")),
565 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
566 N_("show resolve-undo information")),
567 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
568 N_("skip files matching pattern"),
569 0, option_parse_exclude },
570 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
571 N_("exclude patterns are read from <file>"),
572 0, option_parse_exclude_from },
573 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
574 N_("read additional per-directory exclude patterns in <file>")),
575 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
576 N_("add the standard git exclusions"),
577 PARSE_OPT_NOARG, option_parse_exclude_standard },
578 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
579 N_("make the output relative to the project top directory"),
580 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
581 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
582 N_("recurse through submodules")),
583 OPT_BOOL(0, "error-unmatch", &error_unmatch,
584 N_("if any <file> is not in the index, treat this as an error")),
585 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
586 N_("pretend that paths removed since <tree-ish> are still present")),
587 OPT__ABBREV(&abbrev),
588 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
592 if (argc == 2 && !strcmp(argv[1], "-h"))
593 usage_with_options(ls_files_usage, builtin_ls_files_options);
595 memset(&dir, 0, sizeof(dir));
598 prefix_len = strlen(prefix);
599 super_prefix = get_super_prefix();
600 git_config(git_default_config, NULL);
602 if (read_cache() < 0)
603 die("index file corrupt");
605 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
607 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
608 for (i = 0; i < exclude_list.nr; i++) {
609 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
611 if (show_tag || show_valid_bit) {
618 tag_skip_worktree = "S ";
619 tag_resolve_undo = "U ";
621 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
622 require_work_tree = 1;
625 * There's no point in showing unmerged unless
626 * you also show the stage information.
629 if (dir.exclude_per_dir)
632 if (require_work_tree && !is_inside_work_tree())
635 if (recurse_submodules)
636 compile_submodule_options(argv, &dir, show_tag);
638 if (recurse_submodules &&
639 (show_stage || show_deleted || show_others || show_unmerged ||
640 show_killed || show_modified || show_resolve_undo || with_tree))
641 die("ls-files --recurse-submodules unsupported mode");
643 if (recurse_submodules && error_unmatch)
644 die("ls-files --recurse-submodules does not support "
647 parse_pathspec(&pathspec, 0,
652 * Find common prefix for all pathspec's
653 * This is used as a performance optimization which unfortunately cannot
654 * be done when recursing into submodules
656 if (recurse_submodules)
659 max_prefix = common_prefix(&pathspec);
660 max_prefix_len = get_common_prefix_len(max_prefix);
662 prune_cache(max_prefix, max_prefix_len);
664 /* Treat unmatching pathspec elements as errors */
665 if (pathspec.nr && error_unmatch)
666 ps_matched = xcalloc(pathspec.nr, 1);
668 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
669 die("ls-files --ignored needs some exclude pattern");
671 /* With no flags, we default to showing the cached files */
672 if (!(show_stage || show_deleted || show_others || show_unmerged ||
673 show_killed || show_modified || show_resolve_undo))
678 * Basic sanity check; show-stages and show-unmerged
679 * would not make any sense with this option.
681 if (show_stage || show_unmerged)
682 die("ls-files --with-tree is incompatible with -s or -u");
683 overlay_tree_on_index(&the_index, with_tree, max_prefix);
686 if (show_resolve_undo)
691 bad = report_path_error(ps_matched, &pathspec, prefix);
693 fprintf(stderr, "Did you forget to 'git add'?\n");