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(&the_index,
67 ce->name);
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);
71 }
72}
73static void write_name(const char *name)
75{
76 /*
77 * Prepend the super_prefix to name to construct the full_name to be
78 * written.
79 */
80 struct strbuf full_name = STRBUF_INIT;
81 if (super_prefix) {
82 strbuf_addstr(&full_name, super_prefix);
83 strbuf_addstr(&full_name, name);
84 name = full_name.buf;
85 }
86 /*
88 * With "--full-name", prefix_len=0; this caller needs to pass
89 * an empty string in that case (a NULL is good for "").
90 */
91 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
92 stdout, line_terminator);
93 strbuf_release(&full_name);
95}
96static void show_dir_entry(const char *tag, struct dir_entry *ent)
98{
99 int len = max_prefix_len;
100 if (len > ent->len)
102 die("git ls-files: internal error - directory entry not superset of prefix");
103 if (!dir_path_match(ent, &pathspec, len, ps_matched))
105 return;
106 fputs(tag, stdout);
108 write_eolinfo(NULL, ent->name);
109 write_name(ent->name);
110}
111static void show_other_files(struct dir_struct *dir)
113{
114 int i;
115 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))
119 continue;
120 show_dir_entry(tag_other, ent);
121 }
122}
123static void show_killed_files(struct dir_struct *dir)
125{
126 int i;
127 for (i = 0; i < dir->nr; i++) {
128 struct dir_entry *ent = dir->entries[i];
129 char *cp, *sp;
130 int pos, len, killed = 0;
131 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
133 sp = strchr(cp, '/');
134 if (!sp) {
135 /* If ent->name is prefix of an entry in the
136 * cache, it will be killed.
137 */
138 pos = cache_name_pos(ent->name, ent->len);
139 if (0 <= pos)
140 die("BUG: killed-file %.*s not found",
141 ent->len, ent->name);
142 pos = -pos - 1;
143 while (pos < active_nr &&
144 ce_stage(active_cache[pos]))
145 pos++; /* skip unmerged */
146 if (active_nr <= pos)
147 break;
148 /* pos points at a name immediately after
149 * ent->name in the cache. Does it expect
150 * ent->name to be a directory?
151 */
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] == '/')
157 killed = 1;
158 break;
159 }
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.
164 */
165 killed = 1;
166 break;
167 }
168 }
169 if (killed)
170 show_dir_entry(tag_killed, dir->entries[i]);
171 }
172}
173/*
175 * Compile an argv_array with all of the options supported by --recurse_submodules
176 */
177static void compile_submodule_options(const char **argv,
178 const struct dir_struct *dir,
179 int show_tag)
180{
181 if (line_terminator == '\0')
182 argv_array_push(&submodule_options, "-z");
183 if (show_tag)
184 argv_array_push(&submodule_options, "-t");
185 if (show_valid_bit)
186 argv_array_push(&submodule_options, "-v");
187 if (show_cached)
188 argv_array_push(&submodule_options, "--cached");
189 if (show_eol)
190 argv_array_push(&submodule_options, "--eol");
191 if (debug_mode)
192 argv_array_push(&submodule_options, "--debug");
193 /* Add Pathspecs */
195 argv_array_push(&submodule_options, "--");
196 for (; *argv; argv++)
197 argv_array_push(&submodule_options, *argv);
198}
199/**
201 * Recursively call ls-files on a submodule
202 */
203static void show_gitlink(const struct cache_entry *ce)
204{
205 struct child_process cp = CHILD_PROCESS_INIT;
206 int status;
207 char *dir;
208 prepare_submodule_repo_env(&cp.env_array);
210 argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
211 if (prefix_len)
213 argv_array_pushf(&cp.env_array, "%s=%s",
214 GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
215 prefix);
216 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
217 super_prefix ? super_prefix : "",
218 ce->name);
219 argv_array_push(&cp.args, "ls-files");
220 argv_array_push(&cp.args, "--recurse-submodules");
221 /* add supported options */
223 argv_array_pushv(&cp.args, submodule_options.argv);
224 cp.git_cmd = 1;
226 dir = mkpathdup("%s/%s", get_git_work_tree(), ce->name);
227 cp.dir = dir;
228 status = run_command(&cp);
229 free(dir);
230 if (status)
231 exit(status);
232}
233static void show_ce_entry(const char *tag, const struct cache_entry *ce)
235{
236 struct strbuf name = STRBUF_INIT;
237 int len = max_prefix_len;
238 if (super_prefix)
239 strbuf_addstr(&name, super_prefix);
240 strbuf_addstr(&name, ce->name);
241 if (len > ce_namelen(ce))
243 die("git ls-files: internal error - cache entry not superset of prefix");
244 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
246 submodule_path_match(&pathspec, name.buf, ps_matched)) {
247 show_gitlink(ce);
248 } else if (match_pathspec(&pathspec, name.buf, name.len,
249 len, ps_matched,
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);
256 if (isalpha(tag[0]))
257 alttag[0] = tolower(tag[0]);
258 else if (tag[0] == '?')
259 alttag[0] = '!';
260 else {
261 alttag[0] = 'v';
262 alttag[1] = tag[0];
263 alttag[2] = ' ';
264 alttag[3] = 0;
265 }
266 tag = alttag;
267 }
268 if (!show_stage) {
270 fputs(tag, stdout);
271 } else {
272 printf("%s%06o %s %d\t",
273 tag,
274 ce->ce_mode,
275 find_unique_abbrev(ce->oid.hash, abbrev),
276 ce_stage(ce));
277 }
278 write_eolinfo(ce, ce->name);
279 write_name(ce->name);
280 if (debug_mode) {
281 const struct stat_data *sd = &ce->ce_stat_data;
282 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);
288 }
289 }
290 strbuf_release(&name);
292}
293static void show_ru_info(void)
295{
296 struct string_list_item *item;
297 if (!the_index.resolve_undo)
299 return;
300 for_each_string_list_item(item, the_index.resolve_undo) {
302 const char *path = item->string;
303 struct resolve_undo_info *ui = item->util;
304 int i, len;
305 len = strlen(path);
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++) {
313 if (!ui->mode[i])
314 continue;
315 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
316 find_unique_abbrev(ui->sha1[i], abbrev),
317 i + 1);
318 write_name(path);
319 }
320 }
321}
322static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
324{
325 int dtype = ce_to_dtype(ce);
326 return is_excluded(dir, &the_index, ce->name, &dtype);
327}
328static void show_files(struct dir_struct *dir)
330{
331 int i;
332 /* For cached/deleted files we don't need to even do the readdir */
334 if (show_others || show_killed) {
335 if (!show_others)
336 dir->flags |= DIR_COLLECT_KILLED_ONLY;
337 fill_directory(dir, &the_index, &pathspec);
338 if (show_others)
339 show_other_files(dir);
340 if (show_killed)
341 show_killed_files(dir);
342 }
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))
348 continue;
349 if (show_unmerged && !ce_stage(ce))
350 continue;
351 if (ce->ce_flags & CE_UPDATE)
352 continue;
353 show_ce_entry(ce_stage(ce) ? tag_unmerged :
354 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
355 }
356 }
357 if (show_deleted || show_modified) {
358 for (i = 0; i < active_nr; i++) {
359 const struct cache_entry *ce = active_cache[i];
360 struct stat st;
361 int err;
362 if ((dir->flags & DIR_SHOW_IGNORED) &&
363 !ce_excluded(dir, ce))
364 continue;
365 if (ce->ce_flags & CE_UPDATE)
366 continue;
367 if (ce_skip_worktree(ce))
368 continue;
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);
374 }
375 }
376}
377/*
379 * Prune the index to only contain stuff starting with "prefix"
380 */
381static void prune_cache(const char *prefix, size_t prefixlen)
382{
383 int pos;
384 unsigned int first, last;
385 if (!prefix)
387 return;
388 pos = cache_name_pos(prefix, prefixlen);
389 if (pos < 0)
390 pos = -pos-1;
391 first = pos;
392 last = active_nr;
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)) {
397 first = next+1;
398 continue;
399 }
400 last = next;
401 }
402 memmove(active_cache, active_cache + pos,
403 (last - pos) * sizeof(struct cache_entry *));
404 active_nr = last - pos;
405}
406static int get_common_prefix_len(const char *common_prefix)
408{
409 int common_prefix_len;
410 if (!common_prefix)
412 return 0;
413 common_prefix_len = strlen(common_prefix);
415 /*
417 * If the prefix has a trailing slash, strip it so that submodules wont
418 * be pruned from the index.
419 */
420 if (common_prefix[common_prefix_len - 1] == '/')
421 common_prefix_len--;
422 return common_prefix_len;
424}
425/*
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.
433 */
434void overlay_tree_on_cache(const char *tree_name, const char *prefix)
435{
436 struct tree *tree;
437 struct object_id oid;
438 struct pathspec pathspec;
439 struct cache_entry *last_stage0 = NULL;
440 int i;
441 if (get_oid(tree_name, &oid))
443 die("tree-ish %s not found.", tree_name);
444 tree = parse_tree_indirect(&oid);
445 if (!tree)
446 die("bad tree-ish %s", tree_name);
447 /* Hoist the unmerged entries up to stage #3 to make room */
449 for (i = 0; i < active_nr; i++) {
450 struct cache_entry *ce = active_cache[i];
451 if (!ce_stage(ce))
452 continue;
453 ce->ce_flags |= CE_STAGEMASK;
454 }
455 if (prefix) {
457 static const char *(matchbuf[1]);
458 matchbuf[0] = NULL;
459 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
460 PATHSPEC_PREFER_CWD, prefix, matchbuf);
461 } else
462 memset(&pathspec, 0, sizeof(pathspec));
463 if (read_tree(tree, 1, &pathspec))
464 die("unable to read tree entries %s", tree_name);
465 for (i = 0; i < active_nr; i++) {
467 struct cache_entry *ce = active_cache[i];
468 switch (ce_stage(ce)) {
469 case 0:
470 last_stage0 = ce;
471 /* fallthru */
472 default:
473 continue;
474 case 1:
475 /*
476 * If there is stage #0 entry for this, we do not
477 * need to show it. We use CE_UPDATE bit to mark
478 * such an entry.
479 */
480 if (last_stage0 &&
481 !strcmp(last_stage0->name, ce->name))
482 ce->ce_flags |= CE_UPDATE;
483 }
484 }
485}
486static const char * const ls_files_usage[] = {
488 N_("git ls-files [<options>] [<file>...]"),
489 NULL
490};
491static int option_parse_exclude(const struct option *opt,
493 const char *arg, int unset)
494{
495 struct string_list *exclude_list = opt->value;
496 exc_given = 1;
498 string_list_append(exclude_list, arg);
499 return 0;
501}
502static int option_parse_exclude_from(const struct option *opt,
504 const char *arg, int unset)
505{
506 struct dir_struct *dir = opt->value;
507 exc_given = 1;
509 add_excludes_from_file(dir, arg);
510 return 0;
512}
513static int option_parse_exclude_standard(const struct option *opt,
515 const char *arg, int unset)
516{
517 struct dir_struct *dir = opt->value;
518 exc_given = 1;
520 setup_standard_excludes(dir);
521 return 0;
523}
524int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
526{
527 int require_work_tree = 0, show_tag = 0, i;
528 const char *max_prefix;
529 struct dir_struct dir;
530 struct exclude_list *el;
531 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
532 struct option builtin_ls_files_options[] = {
533 /* Think twice before adding "--nul" synonym to this */
534 OPT_SET_INT('z', NULL, &line_terminator,
535 N_("paths are separated with NUL character"), '\0'),
536 OPT_BOOL('t', NULL, &show_tag,
537 N_("identify the file status with tags")),
538 OPT_BOOL('v', NULL, &show_valid_bit,
539 N_("use lowercase letters for 'assume unchanged' files")),
540 OPT_BOOL('c', "cached", &show_cached,
541 N_("show cached files in the output (default)")),
542 OPT_BOOL('d', "deleted", &show_deleted,
543 N_("show deleted files in the output")),
544 OPT_BOOL('m', "modified", &show_modified,
545 N_("show modified files in the output")),
546 OPT_BOOL('o', "others", &show_others,
547 N_("show other files in the output")),
548 OPT_BIT('i', "ignored", &dir.flags,
549 N_("show ignored files in the output"),
550 DIR_SHOW_IGNORED),
551 OPT_BOOL('s', "stage", &show_stage,
552 N_("show staged contents' object name in the output")),
553 OPT_BOOL('k', "killed", &show_killed,
554 N_("show files on the filesystem that need to be removed")),
555 OPT_BIT(0, "directory", &dir.flags,
556 N_("show 'other' directories' names only"),
557 DIR_SHOW_OTHER_DIRECTORIES),
558 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
559 OPT_NEGBIT(0, "empty-directory", &dir.flags,
560 N_("don't show empty directories"),
561 DIR_HIDE_EMPTY_DIRECTORIES),
562 OPT_BOOL('u', "unmerged", &show_unmerged,
563 N_("show unmerged files in the output")),
564 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
565 N_("show resolve-undo information")),
566 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
567 N_("skip files matching pattern"),
568 0, option_parse_exclude },
569 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
570 N_("exclude patterns are read from <file>"),
571 0, option_parse_exclude_from },
572 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
573 N_("read additional per-directory exclude patterns in <file>")),
574 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
575 N_("add the standard git exclusions"),
576 PARSE_OPT_NOARG, option_parse_exclude_standard },
577 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
578 N_("make the output relative to the project top directory"),
579 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
580 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
581 N_("recurse through submodules")),
582 OPT_BOOL(0, "error-unmatch", &error_unmatch,
583 N_("if any <file> is not in the index, treat this as an error")),
584 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
585 N_("pretend that paths removed since <tree-ish> are still present")),
586 OPT__ABBREV(&abbrev),
587 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
588 OPT_END()
589 };
590 if (argc == 2 && !strcmp(argv[1], "-h"))
592 usage_with_options(ls_files_usage, builtin_ls_files_options);
593 memset(&dir, 0, sizeof(dir));
595 prefix = cmd_prefix;
596 if (prefix)
597 prefix_len = strlen(prefix);
598 super_prefix = get_super_prefix();
599 git_config(git_default_config, NULL);
600 if (read_cache() < 0)
602 die("index file corrupt");
603 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
605 ls_files_usage, 0);
606 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
607 for (i = 0; i < exclude_list.nr; i++) {
608 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
609 }
610 if (show_tag || show_valid_bit) {
611 tag_cached = "H ";
612 tag_unmerged = "M ";
613 tag_removed = "R ";
614 tag_modified = "C ";
615 tag_other = "? ";
616 tag_killed = "K ";
617 tag_skip_worktree = "S ";
618 tag_resolve_undo = "U ";
619 }
620 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
621 require_work_tree = 1;
622 if (show_unmerged)
623 /*
624 * There's no point in showing unmerged unless
625 * you also show the stage information.
626 */
627 show_stage = 1;
628 if (dir.exclude_per_dir)
629 exc_given = 1;
630 if (require_work_tree && !is_inside_work_tree())
632 setup_work_tree();
633 if (recurse_submodules)
635 compile_submodule_options(argv, &dir, show_tag);
636 if (recurse_submodules &&
638 (show_stage || show_deleted || show_others || show_unmerged ||
639 show_killed || show_modified || show_resolve_undo || with_tree))
640 die("ls-files --recurse-submodules unsupported mode");
641 if (recurse_submodules && error_unmatch)
643 die("ls-files --recurse-submodules does not support "
644 "--error-unmatch");
645 parse_pathspec(&pathspec, 0,
647 PATHSPEC_PREFER_CWD,
648 prefix, argv);
649 /*
651 * Find common prefix for all pathspec's
652 * This is used as a performance optimization which unfortunately cannot
653 * be done when recursing into submodules
654 */
655 if (recurse_submodules)
656 max_prefix = NULL;
657 else
658 max_prefix = common_prefix(&pathspec);
659 max_prefix_len = get_common_prefix_len(max_prefix);
660 prune_cache(max_prefix, max_prefix_len);
662 /* Treat unmatching pathspec elements as errors */
664 if (pathspec.nr && error_unmatch)
665 ps_matched = xcalloc(pathspec.nr, 1);
666 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
668 die("ls-files --ignored needs some exclude pattern");
669 /* With no flags, we default to showing the cached files */
671 if (!(show_stage || show_deleted || show_others || show_unmerged ||
672 show_killed || show_modified || show_resolve_undo))
673 show_cached = 1;
674 if (with_tree) {
676 /*
677 * Basic sanity check; show-stages and show-unmerged
678 * would not make any sense with this option.
679 */
680 if (show_stage || show_unmerged)
681 die("ls-files --with-tree is incompatible with -s or -u");
682 overlay_tree_on_cache(with_tree, max_prefix);
683 }
684 show_files(&dir);
685 if (show_resolve_undo)
686 show_ru_info();
687 if (ps_matched) {
689 int bad;
690 bad = report_path_error(ps_matched, &pathspec, prefix);
691 if (bad)
692 fprintf(stderr, "Did you forget to 'git add'?\n");
693 return bad ? 1 : 0;
695 }
696 return 0;
698}