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