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#include "run-command.h"
18#include "submodule.h"
19static int abbrev;
21static int show_deleted;
22static int show_cached;
23static int show_others;
24static int show_stage;
25static int show_unmerged;
26static int show_resolve_undo;
27static int show_modified;
28static int show_killed;
29static int show_valid_bit;
30static int line_terminator = '\n';
31static int debug_mode;
32static int show_eol;
33static int recurse_submodules;
34static struct argv_array submodule_options = ARGV_ARRAY_INIT;
35static const char *prefix;
37static const char *super_prefix;
38static int max_prefix_len;
39static int prefix_len;
40static struct pathspec pathspec;
41static int error_unmatch;
42static char *ps_matched;
43static const char *with_tree;
44static int exc_given;
45static int exclude_args;
46static const char *tag_cached = "";
48static const char *tag_unmerged = "";
49static const char *tag_removed = "";
50static const char *tag_other = "";
51static const char *tag_killed = "";
52static const char *tag_modified = "";
53static const char *tag_skip_worktree = "";
54static const char *tag_resolve_undo = "";
55static void write_eolinfo(const struct cache_entry *ce, const char *path)
57{
58 if (!show_eol)
59 return;
60 else {
61 struct stat st;
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(ce->name);
67 if (!lstat(path, &st) && S_ISREG(st.st_mode))
68 w_txt = get_wt_convert_stats_ascii(path);
69 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
70 }
71}
72static void write_name(const char *name)
74{
75 /*
76 * Prepend the super_prefix to name to construct the full_name to be
77 * written.
78 */
79 struct strbuf full_name = STRBUF_INIT;
80 if (super_prefix) {
81 strbuf_addstr(&full_name, super_prefix);
82 strbuf_addstr(&full_name, name);
83 name = full_name.buf;
84 }
85 /*
87 * With "--full-name", prefix_len=0; this caller needs to pass
88 * an empty string in that case (a NULL is good for "").
89 */
90 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
91 stdout, line_terminator);
92 strbuf_release(&full_name);
94}
95static void show_dir_entry(const char *tag, struct dir_entry *ent)
97{
98 int len = max_prefix_len;
99 if (len > ent->len)
101 die("git ls-files: internal error - directory entry not superset of prefix");
102 if (!dir_path_match(ent, &pathspec, len, ps_matched))
104 return;
105 fputs(tag, stdout);
107 write_eolinfo(NULL, ent->name);
108 write_name(ent->name);
109}
110static void show_other_files(struct dir_struct *dir)
112{
113 int i;
114 for (i = 0; i < dir->nr; i++) {
116 struct dir_entry *ent = dir->entries[i];
117 if (!cache_name_is_other(ent->name, ent->len))
118 continue;
119 show_dir_entry(tag_other, ent);
120 }
121}
122static void show_killed_files(struct dir_struct *dir)
124{
125 int i;
126 for (i = 0; i < dir->nr; i++) {
127 struct dir_entry *ent = dir->entries[i];
128 char *cp, *sp;
129 int pos, len, killed = 0;
130 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
132 sp = strchr(cp, '/');
133 if (!sp) {
134 /* If ent->name is prefix of an entry in the
135 * cache, it will be killed.
136 */
137 pos = cache_name_pos(ent->name, ent->len);
138 if (0 <= pos)
139 die("BUG: killed-file %.*s not found",
140 ent->len, ent->name);
141 pos = -pos - 1;
142 while (pos < active_nr &&
143 ce_stage(active_cache[pos]))
144 pos++; /* skip unmerged */
145 if (active_nr <= pos)
146 break;
147 /* pos points at a name immediately after
148 * ent->name in the cache. Does it expect
149 * ent->name to be a directory?
150 */
151 len = ce_namelen(active_cache[pos]);
152 if ((ent->len < len) &&
153 !strncmp(active_cache[pos]->name,
154 ent->name, ent->len) &&
155 active_cache[pos]->name[ent->len] == '/')
156 killed = 1;
157 break;
158 }
159 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
160 /* If any of the leading directories in
161 * ent->name is registered in the cache,
162 * ent->name will be killed.
163 */
164 killed = 1;
165 break;
166 }
167 }
168 if (killed)
169 show_dir_entry(tag_killed, dir->entries[i]);
170 }
171}
172/*
174 * Compile an argv_array with all of the options supported by --recurse_submodules
175 */
176static void compile_submodule_options(const char **argv,
177 const struct dir_struct *dir,
178 int show_tag)
179{
180 if (line_terminator == '\0')
181 argv_array_push(&submodule_options, "-z");
182 if (show_tag)
183 argv_array_push(&submodule_options, "-t");
184 if (show_valid_bit)
185 argv_array_push(&submodule_options, "-v");
186 if (show_cached)
187 argv_array_push(&submodule_options, "--cached");
188 if (show_eol)
189 argv_array_push(&submodule_options, "--eol");
190 if (debug_mode)
191 argv_array_push(&submodule_options, "--debug");
192 /* Add Pathspecs */
194 argv_array_push(&submodule_options, "--");
195 for (; *argv; argv++)
196 argv_array_push(&submodule_options, *argv);
197}
198/**
200 * Recursively call ls-files on a submodule
201 */
202static void show_gitlink(const struct cache_entry *ce)
203{
204 struct child_process cp = CHILD_PROCESS_INIT;
205 int status;
206 char *dir;
207 prepare_submodule_repo_env(&cp.env_array);
209 argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
210 if (prefix_len)
212 argv_array_pushf(&cp.env_array, "%s=%s",
213 GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
214 prefix);
215 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
216 super_prefix ? super_prefix : "",
217 ce->name);
218 argv_array_push(&cp.args, "ls-files");
219 argv_array_push(&cp.args, "--recurse-submodules");
220 /* add supported options */
222 argv_array_pushv(&cp.args, submodule_options.argv);
223 cp.git_cmd = 1;
225 dir = mkpathdup("%s/%s", get_git_work_tree(), ce->name);
226 cp.dir = dir;
227 status = run_command(&cp);
228 free(dir);
229 if (status)
230 exit(status);
231}
232static void show_ce_entry(const char *tag, const struct cache_entry *ce)
234{
235 struct strbuf name = STRBUF_INIT;
236 int len = max_prefix_len;
237 if (super_prefix)
238 strbuf_addstr(&name, super_prefix);
239 strbuf_addstr(&name, ce->name);
240 if (len > ce_namelen(ce))
242 die("git ls-files: internal error - cache entry not superset of prefix");
243 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
245 submodule_path_match(&pathspec, name.buf, ps_matched)) {
246 show_gitlink(ce);
247 } else if (match_pathspec(&pathspec, name.buf, name.len,
248 len, ps_matched,
249 S_ISDIR(ce->ce_mode) ||
250 S_ISGITLINK(ce->ce_mode))) {
251 if (tag && *tag && show_valid_bit &&
252 (ce->ce_flags & CE_VALID)) {
253 static char alttag[4];
254 memcpy(alttag, tag, 3);
255 if (isalpha(tag[0]))
256 alttag[0] = tolower(tag[0]);
257 else if (tag[0] == '?')
258 alttag[0] = '!';
259 else {
260 alttag[0] = 'v';
261 alttag[1] = tag[0];
262 alttag[2] = ' ';
263 alttag[3] = 0;
264 }
265 tag = alttag;
266 }
267 if (!show_stage) {
269 fputs(tag, stdout);
270 } else {
271 printf("%s%06o %s %d\t",
272 tag,
273 ce->ce_mode,
274 find_unique_abbrev(ce->oid.hash, abbrev),
275 ce_stage(ce));
276 }
277 write_eolinfo(ce, ce->name);
278 write_name(ce->name);
279 if (debug_mode) {
280 const struct stat_data *sd = &ce->ce_stat_data;
281 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
283 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
284 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
285 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
286 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
287 }
288 }
289 strbuf_release(&name);
291}
292static void show_ru_info(void)
294{
295 struct string_list_item *item;
296 if (!the_index.resolve_undo)
298 return;
299 for_each_string_list_item(item, the_index.resolve_undo) {
301 const char *path = item->string;
302 struct resolve_undo_info *ui = item->util;
303 int i, len;
304 len = strlen(path);
306 if (len < max_prefix_len)
307 continue; /* outside of the prefix */
308 if (!match_pathspec(&pathspec, path, len,
309 max_prefix_len, ps_matched, 0))
310 continue; /* uninterested */
311 for (i = 0; i < 3; i++) {
312 if (!ui->mode[i])
313 continue;
314 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
315 find_unique_abbrev(ui->sha1[i], abbrev),
316 i + 1);
317 write_name(path);
318 }
319 }
320}
321static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
323{
324 int dtype = ce_to_dtype(ce);
325 return is_excluded(dir, &the_index, ce->name, &dtype);
326}
327static void show_files(struct dir_struct *dir)
329{
330 int i;
331 /* For cached/deleted files we don't need to even do the readdir */
333 if (show_others || show_killed) {
334 if (!show_others)
335 dir->flags |= DIR_COLLECT_KILLED_ONLY;
336 fill_directory(dir, &the_index, &pathspec);
337 if (show_others)
338 show_other_files(dir);
339 if (show_killed)
340 show_killed_files(dir);
341 }
342 if (show_cached || show_stage) {
343 for (i = 0; i < active_nr; i++) {
344 const struct cache_entry *ce = active_cache[i];
345 if ((dir->flags & DIR_SHOW_IGNORED) &&
346 !ce_excluded(dir, ce))
347 continue;
348 if (show_unmerged && !ce_stage(ce))
349 continue;
350 if (ce->ce_flags & CE_UPDATE)
351 continue;
352 show_ce_entry(ce_stage(ce) ? tag_unmerged :
353 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
354 }
355 }
356 if (show_deleted || show_modified) {
357 for (i = 0; i < active_nr; i++) {
358 const struct cache_entry *ce = active_cache[i];
359 struct stat st;
360 int err;
361 if ((dir->flags & DIR_SHOW_IGNORED) &&
362 !ce_excluded(dir, ce))
363 continue;
364 if (ce->ce_flags & CE_UPDATE)
365 continue;
366 if (ce_skip_worktree(ce))
367 continue;
368 err = lstat(ce->name, &st);
369 if (show_deleted && err)
370 show_ce_entry(tag_removed, ce);
371 if (show_modified && ce_modified(ce, &st, 0))
372 show_ce_entry(tag_modified, ce);
373 }
374 }
375}
376/*
378 * Prune the index to only contain stuff starting with "prefix"
379 */
380static void prune_cache(const char *prefix, size_t prefixlen)
381{
382 int pos;
383 unsigned int first, last;
384 if (!prefix)
386 return;
387 pos = cache_name_pos(prefix, prefixlen);
388 if (pos < 0)
389 pos = -pos-1;
390 first = pos;
391 last = active_nr;
392 while (last > first) {
393 int next = (last + first) >> 1;
394 const struct cache_entry *ce = active_cache[next];
395 if (!strncmp(ce->name, prefix, prefixlen)) {
396 first = next+1;
397 continue;
398 }
399 last = next;
400 }
401 memmove(active_cache, active_cache + pos,
402 (last - pos) * sizeof(struct cache_entry *));
403 active_nr = last - pos;
404}
405static int get_common_prefix_len(const char *common_prefix)
407{
408 int common_prefix_len;
409 if (!common_prefix)
411 return 0;
412 common_prefix_len = strlen(common_prefix);
414 /*
416 * If the prefix has a trailing slash, strip it so that submodules wont
417 * be pruned from the index.
418 */
419 if (common_prefix[common_prefix_len - 1] == '/')
420 common_prefix_len--;
421 return common_prefix_len;
423}
424/*
426 * Read the tree specified with --with-tree option
427 * (typically, HEAD) into stage #1 and then
428 * squash them down to stage #0. This is used for
429 * --error-unmatch to list and check the path patterns
430 * that were given from the command line. We are not
431 * going to write this index out.
432 */
433void overlay_tree_on_cache(const char *tree_name, const char *prefix)
434{
435 struct tree *tree;
436 struct object_id oid;
437 struct pathspec pathspec;
438 struct cache_entry *last_stage0 = NULL;
439 int i;
440 if (get_oid(tree_name, &oid))
442 die("tree-ish %s not found.", tree_name);
443 tree = parse_tree_indirect(&oid);
444 if (!tree)
445 die("bad tree-ish %s", tree_name);
446 /* Hoist the unmerged entries up to stage #3 to make room */
448 for (i = 0; i < active_nr; i++) {
449 struct cache_entry *ce = active_cache[i];
450 if (!ce_stage(ce))
451 continue;
452 ce->ce_flags |= CE_STAGEMASK;
453 }
454 if (prefix) {
456 static const char *(matchbuf[1]);
457 matchbuf[0] = NULL;
458 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
459 PATHSPEC_PREFER_CWD, prefix, matchbuf);
460 } else
461 memset(&pathspec, 0, sizeof(pathspec));
462 if (read_tree(tree, 1, &pathspec))
463 die("unable to read tree entries %s", tree_name);
464 for (i = 0; i < active_nr; i++) {
466 struct cache_entry *ce = active_cache[i];
467 switch (ce_stage(ce)) {
468 case 0:
469 last_stage0 = ce;
470 /* fallthru */
471 default:
472 continue;
473 case 1:
474 /*
475 * If there is stage #0 entry for this, we do not
476 * need to show it. We use CE_UPDATE bit to mark
477 * such an entry.
478 */
479 if (last_stage0 &&
480 !strcmp(last_stage0->name, ce->name))
481 ce->ce_flags |= CE_UPDATE;
482 }
483 }
484}
485static const char * const ls_files_usage[] = {
487 N_("git ls-files [<options>] [<file>...]"),
488 NULL
489};
490static int option_parse_exclude(const struct option *opt,
492 const char *arg, int unset)
493{
494 struct string_list *exclude_list = opt->value;
495 exc_given = 1;
497 string_list_append(exclude_list, arg);
498 return 0;
500}
501static int option_parse_exclude_from(const struct option *opt,
503 const char *arg, int unset)
504{
505 struct dir_struct *dir = opt->value;
506 exc_given = 1;
508 add_excludes_from_file(dir, arg);
509 return 0;
511}
512static int option_parse_exclude_standard(const struct option *opt,
514 const char *arg, int unset)
515{
516 struct dir_struct *dir = opt->value;
517 exc_given = 1;
519 setup_standard_excludes(dir);
520 return 0;
522}
523int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
525{
526 int require_work_tree = 0, show_tag = 0, i;
527 const char *max_prefix;
528 struct dir_struct dir;
529 struct exclude_list *el;
530 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
531 struct option builtin_ls_files_options[] = {
532 /* Think twice before adding "--nul" synonym to this */
533 OPT_SET_INT('z', NULL, &line_terminator,
534 N_("paths are separated with NUL character"), '\0'),
535 OPT_BOOL('t', NULL, &show_tag,
536 N_("identify the file status with tags")),
537 OPT_BOOL('v', NULL, &show_valid_bit,
538 N_("use lowercase letters for 'assume unchanged' files")),
539 OPT_BOOL('c', "cached", &show_cached,
540 N_("show cached files in the output (default)")),
541 OPT_BOOL('d', "deleted", &show_deleted,
542 N_("show deleted files in the output")),
543 OPT_BOOL('m', "modified", &show_modified,
544 N_("show modified files in the output")),
545 OPT_BOOL('o', "others", &show_others,
546 N_("show other files in the output")),
547 OPT_BIT('i', "ignored", &dir.flags,
548 N_("show ignored files in the output"),
549 DIR_SHOW_IGNORED),
550 OPT_BOOL('s', "stage", &show_stage,
551 N_("show staged contents' object name in the output")),
552 OPT_BOOL('k', "killed", &show_killed,
553 N_("show files on the filesystem that need to be removed")),
554 OPT_BIT(0, "directory", &dir.flags,
555 N_("show 'other' directories' names only"),
556 DIR_SHOW_OTHER_DIRECTORIES),
557 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
558 OPT_NEGBIT(0, "empty-directory", &dir.flags,
559 N_("don't show empty directories"),
560 DIR_HIDE_EMPTY_DIRECTORIES),
561 OPT_BOOL('u', "unmerged", &show_unmerged,
562 N_("show unmerged files in the output")),
563 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
564 N_("show resolve-undo information")),
565 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
566 N_("skip files matching pattern"),
567 0, option_parse_exclude },
568 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
569 N_("exclude patterns are read from <file>"),
570 0, option_parse_exclude_from },
571 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
572 N_("read additional per-directory exclude patterns in <file>")),
573 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
574 N_("add the standard git exclusions"),
575 PARSE_OPT_NOARG, option_parse_exclude_standard },
576 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
577 N_("make the output relative to the project top directory"),
578 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
579 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
580 N_("recurse through submodules")),
581 OPT_BOOL(0, "error-unmatch", &error_unmatch,
582 N_("if any <file> is not in the index, treat this as an error")),
583 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
584 N_("pretend that paths removed since <tree-ish> are still present")),
585 OPT__ABBREV(&abbrev),
586 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
587 OPT_END()
588 };
589 if (argc == 2 && !strcmp(argv[1], "-h"))
591 usage_with_options(ls_files_usage, builtin_ls_files_options);
592 memset(&dir, 0, sizeof(dir));
594 prefix = cmd_prefix;
595 if (prefix)
596 prefix_len = strlen(prefix);
597 super_prefix = get_super_prefix();
598 git_config(git_default_config, NULL);
599 if (read_cache() < 0)
601 die("index file corrupt");
602 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
604 ls_files_usage, 0);
605 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
606 for (i = 0; i < exclude_list.nr; i++) {
607 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
608 }
609 if (show_tag || show_valid_bit) {
610 tag_cached = "H ";
611 tag_unmerged = "M ";
612 tag_removed = "R ";
613 tag_modified = "C ";
614 tag_other = "? ";
615 tag_killed = "K ";
616 tag_skip_worktree = "S ";
617 tag_resolve_undo = "U ";
618 }
619 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
620 require_work_tree = 1;
621 if (show_unmerged)
622 /*
623 * There's no point in showing unmerged unless
624 * you also show the stage information.
625 */
626 show_stage = 1;
627 if (dir.exclude_per_dir)
628 exc_given = 1;
629 if (require_work_tree && !is_inside_work_tree())
631 setup_work_tree();
632 if (recurse_submodules)
634 compile_submodule_options(argv, &dir, show_tag);
635 if (recurse_submodules &&
637 (show_stage || show_deleted || show_others || show_unmerged ||
638 show_killed || show_modified || show_resolve_undo || with_tree))
639 die("ls-files --recurse-submodules unsupported mode");
640 if (recurse_submodules && error_unmatch)
642 die("ls-files --recurse-submodules does not support "
643 "--error-unmatch");
644 parse_pathspec(&pathspec, 0,
646 PATHSPEC_PREFER_CWD,
647 prefix, argv);
648 /*
650 * Find common prefix for all pathspec's
651 * This is used as a performance optimization which unfortunately cannot
652 * be done when recursing into submodules
653 */
654 if (recurse_submodules)
655 max_prefix = NULL;
656 else
657 max_prefix = common_prefix(&pathspec);
658 max_prefix_len = get_common_prefix_len(max_prefix);
659 prune_cache(max_prefix, max_prefix_len);
661 /* Treat unmatching pathspec elements as errors */
663 if (pathspec.nr && error_unmatch)
664 ps_matched = xcalloc(pathspec.nr, 1);
665 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
667 die("ls-files --ignored needs some exclude pattern");
668 /* With no flags, we default to showing the cached files */
670 if (!(show_stage || show_deleted || show_others || show_unmerged ||
671 show_killed || show_modified || show_resolve_undo))
672 show_cached = 1;
673 if (with_tree) {
675 /*
676 * Basic sanity check; show-stages and show-unmerged
677 * would not make any sense with this option.
678 */
679 if (show_stage || show_unmerged)
680 die("ls-files --with-tree is incompatible with -s or -u");
681 overlay_tree_on_cache(with_tree, max_prefix);
682 }
683 show_files(&dir);
684 if (show_resolve_undo)
685 show_ru_info();
686 if (ps_matched) {
688 int bad;
689 bad = report_path_error(ps_matched, &pathspec, prefix);
690 if (bad)
691 fprintf(stderr, "Did you forget to 'git add'?\n");
692 return bad ? 1 : 0;
694 }
695 return 0;
697}