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#define NO_THE_INDEX_COMPATIBILITY_MACROS
9#include "cache.h"
10#include "repository.h"
11#include "config.h"
12#include "quote.h"
13#include "dir.h"
14#include "builtin.h"
15#include "tree.h"
16#include "parse-options.h"
17#include "resolve-undo.h"
18#include "string-list.h"
19#include "pathspec.h"
20#include "run-command.h"
21#include "submodule.h"
22#include "submodule-config.h"
23static int abbrev;
25static int show_deleted;
26static int show_cached;
27static int show_others;
28static int show_stage;
29static int show_unmerged;
30static int show_resolve_undo;
31static int show_modified;
32static int show_killed;
33static int show_valid_bit;
34static int show_fsmonitor_bit;
35static int line_terminator = '\n';
36static int debug_mode;
37static int show_eol;
38static int recurse_submodules;
39static const char *prefix;
41static int max_prefix_len;
42static int prefix_len;
43static struct pathspec pathspec;
44static int error_unmatch;
45static char *ps_matched;
46static const char *with_tree;
47static int exc_given;
48static int exclude_args;
49static const char *tag_cached = "";
51static const char *tag_unmerged = "";
52static const char *tag_removed = "";
53static const char *tag_other = "";
54static const char *tag_killed = "";
55static const char *tag_modified = "";
56static const char *tag_skip_worktree = "";
57static const char *tag_resolve_undo = "";
58static void write_eolinfo(const struct index_state *istate,
60 const struct cache_entry *ce, const char *path)
61{
62 if (show_eol) {
63 struct stat st;
64 const char *i_txt = "";
65 const char *w_txt = "";
66 const char *a_txt = get_convert_attr_ascii(istate, path);
67 if (ce && S_ISREG(ce->ce_mode))
68 i_txt = get_cached_convert_stats_ascii(istate,
69 ce->name);
70 if (!lstat(path, &st) && S_ISREG(st.st_mode))
71 w_txt = get_wt_convert_stats_ascii(path);
72 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
73 }
74}
75static void write_name(const char *name)
77{
78 /*
79 * With "--full-name", prefix_len=0; this caller needs to pass
80 * an empty string in that case (a NULL is good for "").
81 */
82 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
83 stdout, line_terminator);
84}
85static const char *get_tag(const struct cache_entry *ce, const char *tag)
87{
88 static char alttag[4];
89 if (tag && *tag && ((show_valid_bit && (ce->ce_flags & CE_VALID)) ||
91 (show_fsmonitor_bit && (ce->ce_flags & CE_FSMONITOR_VALID)))) {
92 memcpy(alttag, tag, 3);
93 if (isalpha(tag[0])) {
95 alttag[0] = tolower(tag[0]);
96 } else if (tag[0] == '?') {
97 alttag[0] = '!';
98 } else {
99 alttag[0] = 'v';
100 alttag[1] = tag[0];
101 alttag[2] = ' ';
102 alttag[3] = 0;
103 }
104 tag = alttag;
106 }
107 return tag;
109}
110static void print_debug(const struct cache_entry *ce)
112{
113 if (debug_mode) {
114 const struct stat_data *sd = &ce->ce_stat_data;
115 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
117 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
118 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
119 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
120 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
121 }
122}
123static void show_dir_entry(const struct index_state *istate,
125 const char *tag, struct dir_entry *ent)
126{
127 int len = max_prefix_len;
128 if (len > ent->len)
130 die("git ls-files: internal error - directory entry not superset of prefix");
131 if (!dir_path_match(istate, ent, &pathspec, len, ps_matched))
133 return;
134 fputs(tag, stdout);
136 write_eolinfo(istate, NULL, ent->name);
137 write_name(ent->name);
138}
139static void show_other_files(const struct index_state *istate,
141 const struct dir_struct *dir)
142{
143 int i;
144 for (i = 0; i < dir->nr; i++) {
146 struct dir_entry *ent = dir->entries[i];
147 if (!index_name_is_other(istate, ent->name, ent->len))
148 continue;
149 show_dir_entry(istate, tag_other, ent);
150 }
151}
152static void show_killed_files(const struct index_state *istate,
154 const struct dir_struct *dir)
155{
156 int i;
157 for (i = 0; i < dir->nr; i++) {
158 struct dir_entry *ent = dir->entries[i];
159 char *cp, *sp;
160 int pos, len, killed = 0;
161 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
163 sp = strchr(cp, '/');
164 if (!sp) {
165 /* If ent->name is prefix of an entry in the
166 * cache, it will be killed.
167 */
168 pos = index_name_pos(istate, ent->name, ent->len);
169 if (0 <= pos)
170 BUG("killed-file %.*s not found",
171 ent->len, ent->name);
172 pos = -pos - 1;
173 while (pos < istate->cache_nr &&
174 ce_stage(istate->cache[pos]))
175 pos++; /* skip unmerged */
176 if (istate->cache_nr <= pos)
177 break;
178 /* pos points at a name immediately after
179 * ent->name in the cache. Does it expect
180 * ent->name to be a directory?
181 */
182 len = ce_namelen(istate->cache[pos]);
183 if ((ent->len < len) &&
184 !strncmp(istate->cache[pos]->name,
185 ent->name, ent->len) &&
186 istate->cache[pos]->name[ent->len] == '/')
187 killed = 1;
188 break;
189 }
190 if (0 <= index_name_pos(istate, ent->name, sp - ent->name)) {
191 /* If any of the leading directories in
192 * ent->name is registered in the cache,
193 * ent->name will be killed.
194 */
195 killed = 1;
196 break;
197 }
198 }
199 if (killed)
200 show_dir_entry(istate, tag_killed, dir->entries[i]);
201 }
202}
203static void show_files(struct repository *repo, struct dir_struct *dir);
205static void show_submodule(struct repository *superproject,
207 struct dir_struct *dir, const char *path)
208{
209 struct repository subrepo;
210 const struct submodule *sub = submodule_from_path(superproject,
211 &null_oid, path);
212 if (repo_submodule_init(&subrepo, superproject, sub))
214 return;
215 if (repo_read_index(&subrepo) < 0)
217 die("index file corrupt");
218 show_files(&subrepo, dir);
220 repo_clear(&subrepo);
222}
223static void show_ce(struct repository *repo, struct dir_struct *dir,
225 const struct cache_entry *ce, const char *fullname,
226 const char *tag)
227{
228 if (max_prefix_len > strlen(fullname))
229 die("git ls-files: internal error - cache entry not superset of prefix");
230 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
232 is_submodule_active(repo, ce->name)) {
233 show_submodule(repo, dir, ce->name);
234 } else if (match_pathspec(repo->index, &pathspec, fullname, strlen(fullname),
235 max_prefix_len, ps_matched,
236 S_ISDIR(ce->ce_mode) ||
237 S_ISGITLINK(ce->ce_mode))) {
238 tag = get_tag(ce, tag);
239 if (!show_stage) {
241 fputs(tag, stdout);
242 } else {
243 printf("%s%06o %s %d\t",
244 tag,
245 ce->ce_mode,
246 find_unique_abbrev(&ce->oid, abbrev),
247 ce_stage(ce));
248 }
249 write_eolinfo(repo->index, ce, fullname);
250 write_name(fullname);
251 print_debug(ce);
252 }
253}
254static void show_ru_info(const struct index_state *istate)
256{
257 struct string_list_item *item;
258 if (!istate->resolve_undo)
260 return;
261 for_each_string_list_item(item, istate->resolve_undo) {
263 const char *path = item->string;
264 struct resolve_undo_info *ui = item->util;
265 int i, len;
266 len = strlen(path);
268 if (len < max_prefix_len)
269 continue; /* outside of the prefix */
270 if (!match_pathspec(istate, &pathspec, path, len,
271 max_prefix_len, ps_matched, 0))
272 continue; /* uninterested */
273 for (i = 0; i < 3; i++) {
274 if (!ui->mode[i])
275 continue;
276 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
277 find_unique_abbrev(&ui->oid[i], abbrev),
278 i + 1);
279 write_name(path);
280 }
281 }
282}
283static int ce_excluded(struct dir_struct *dir, struct index_state *istate,
285 const char *fullname, const struct cache_entry *ce)
286{
287 int dtype = ce_to_dtype(ce);
288 return is_excluded(dir, istate, fullname, &dtype);
289}
290static void construct_fullname(struct strbuf *out, const struct repository *repo,
292 const struct cache_entry *ce)
293{
294 strbuf_reset(out);
295 if (repo->submodule_prefix)
296 strbuf_addstr(out, repo->submodule_prefix);
297 strbuf_addstr(out, ce->name);
298}
299static void show_files(struct repository *repo, struct dir_struct *dir)
301{
302 int i;
303 struct strbuf fullname = STRBUF_INIT;
304 /* For cached/deleted files we don't need to even do the readdir */
306 if (show_others || show_killed) {
307 if (!show_others)
308 dir->flags |= DIR_COLLECT_KILLED_ONLY;
309 fill_directory(dir, repo->index, &pathspec);
310 if (show_others)
311 show_other_files(repo->index, dir);
312 if (show_killed)
313 show_killed_files(repo->index, dir);
314 }
315 if (show_cached || show_stage) {
316 for (i = 0; i < repo->index->cache_nr; i++) {
317 const struct cache_entry *ce = repo->index->cache[i];
318 construct_fullname(&fullname, repo, ce);
320 if ((dir->flags & DIR_SHOW_IGNORED) &&
322 !ce_excluded(dir, repo->index, fullname.buf, ce))
323 continue;
324 if (show_unmerged && !ce_stage(ce))
325 continue;
326 if (ce->ce_flags & CE_UPDATE)
327 continue;
328 show_ce(repo, dir, ce, fullname.buf,
329 ce_stage(ce) ? tag_unmerged :
330 (ce_skip_worktree(ce) ? tag_skip_worktree :
331 tag_cached));
332 }
333 }
334 if (show_deleted || show_modified) {
335 for (i = 0; i < repo->index->cache_nr; i++) {
336 const struct cache_entry *ce = repo->index->cache[i];
337 struct stat st;
338 int err;
339 construct_fullname(&fullname, repo, ce);
341 if ((dir->flags & DIR_SHOW_IGNORED) &&
343 !ce_excluded(dir, repo->index, fullname.buf, ce))
344 continue;
345 if (ce->ce_flags & CE_UPDATE)
346 continue;
347 if (ce_skip_worktree(ce))
348 continue;
349 err = lstat(fullname.buf, &st);
350 if (show_deleted && err)
351 show_ce(repo, dir, ce, fullname.buf, tag_removed);
352 if (show_modified && ie_modified(repo->index, ce, &st, 0))
353 show_ce(repo, dir, ce, fullname.buf, tag_modified);
354 }
355 }
356 strbuf_release(&fullname);
358}
359/*
361 * Prune the index to only contain stuff starting with "prefix"
362 */
363static void prune_index(struct index_state *istate,
364 const char *prefix, size_t prefixlen)
365{
366 int pos;
367 unsigned int first, last;
368 if (!prefix || !istate->cache_nr)
370 return;
371 pos = index_name_pos(istate, prefix, prefixlen);
372 if (pos < 0)
373 pos = -pos-1;
374 first = pos;
375 last = istate->cache_nr;
376 while (last > first) {
377 int next = (last + first) >> 1;
378 const struct cache_entry *ce = istate->cache[next];
379 if (!strncmp(ce->name, prefix, prefixlen)) {
380 first = next+1;
381 continue;
382 }
383 last = next;
384 }
385 MOVE_ARRAY(istate->cache, istate->cache + pos, last - pos);
386 istate->cache_nr = last - pos;
387}
388static int get_common_prefix_len(const char *common_prefix)
390{
391 int common_prefix_len;
392 if (!common_prefix)
394 return 0;
395 common_prefix_len = strlen(common_prefix);
397 /*
399 * If the prefix has a trailing slash, strip it so that submodules wont
400 * be pruned from the index.
401 */
402 if (common_prefix[common_prefix_len - 1] == '/')
403 common_prefix_len--;
404 return common_prefix_len;
406}
407/*
409 * Read the tree specified with --with-tree option
410 * (typically, HEAD) into stage #1 and then
411 * squash them down to stage #0. This is used for
412 * --error-unmatch to list and check the path patterns
413 * that were given from the command line. We are not
414 * going to write this index out.
415 */
416void overlay_tree_on_index(struct index_state *istate,
417 const char *tree_name, const char *prefix)
418{
419 struct tree *tree;
420 struct object_id oid;
421 struct pathspec pathspec;
422 struct cache_entry *last_stage0 = NULL;
423 int i;
424 if (get_oid(tree_name, &oid))
426 die("tree-ish %s not found.", tree_name);
427 tree = parse_tree_indirect(&oid);
428 if (!tree)
429 die("bad tree-ish %s", tree_name);
430 /* Hoist the unmerged entries up to stage #3 to make room */
432 for (i = 0; i < istate->cache_nr; i++) {
433 struct cache_entry *ce = istate->cache[i];
434 if (!ce_stage(ce))
435 continue;
436 ce->ce_flags |= CE_STAGEMASK;
437 }
438 if (prefix) {
440 static const char *(matchbuf[1]);
441 matchbuf[0] = NULL;
442 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
443 PATHSPEC_PREFER_CWD, prefix, matchbuf);
444 } else
445 memset(&pathspec, 0, sizeof(pathspec));
446 if (read_tree(the_repository, tree, 1, &pathspec, istate))
447 die("unable to read tree entries %s", tree_name);
448 for (i = 0; i < istate->cache_nr; i++) {
450 struct cache_entry *ce = istate->cache[i];
451 switch (ce_stage(ce)) {
452 case 0:
453 last_stage0 = ce;
454 /* fallthru */
455 default:
456 continue;
457 case 1:
458 /*
459 * If there is stage #0 entry for this, we do not
460 * need to show it. We use CE_UPDATE bit to mark
461 * such an entry.
462 */
463 if (last_stage0 &&
464 !strcmp(last_stage0->name, ce->name))
465 ce->ce_flags |= CE_UPDATE;
466 }
467 }
468}
469static const char * const ls_files_usage[] = {
471 N_("git ls-files [<options>] [<file>...]"),
472 NULL
473};
474static int option_parse_exclude(const struct option *opt,
476 const char *arg, int unset)
477{
478 struct string_list *exclude_list = opt->value;
479 BUG_ON_OPT_NEG(unset);
481 exc_given = 1;
483 string_list_append(exclude_list, arg);
484 return 0;
486}
487static int option_parse_exclude_from(const struct option *opt,
489 const char *arg, int unset)
490{
491 struct dir_struct *dir = opt->value;
492 BUG_ON_OPT_NEG(unset);
494 exc_given = 1;
496 add_excludes_from_file(dir, arg);
497 return 0;
499}
500static int option_parse_exclude_standard(const struct option *opt,
502 const char *arg, int unset)
503{
504 struct dir_struct *dir = opt->value;
505 BUG_ON_OPT_NEG(unset);
507 BUG_ON_OPT_ARG(arg);
508 exc_given = 1;
510 setup_standard_excludes(dir);
511 return 0;
513}
514int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
516{
517 int require_work_tree = 0, show_tag = 0, i;
518 const char *max_prefix;
519 struct dir_struct dir;
520 struct exclude_list *el;
521 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
522 struct option builtin_ls_files_options[] = {
523 /* Think twice before adding "--nul" synonym to this */
524 OPT_SET_INT('z', NULL, &line_terminator,
525 N_("paths are separated with NUL character"), '\0'),
526 OPT_BOOL('t', NULL, &show_tag,
527 N_("identify the file status with tags")),
528 OPT_BOOL('v', NULL, &show_valid_bit,
529 N_("use lowercase letters for 'assume unchanged' files")),
530 OPT_BOOL('f', NULL, &show_fsmonitor_bit,
531 N_("use lowercase letters for 'fsmonitor clean' files")),
532 OPT_BOOL('c', "cached", &show_cached,
533 N_("show cached files in the output (default)")),
534 OPT_BOOL('d', "deleted", &show_deleted,
535 N_("show deleted files in the output")),
536 OPT_BOOL('m', "modified", &show_modified,
537 N_("show modified files in the output")),
538 OPT_BOOL('o', "others", &show_others,
539 N_("show other files in the output")),
540 OPT_BIT('i', "ignored", &dir.flags,
541 N_("show ignored files in the output"),
542 DIR_SHOW_IGNORED),
543 OPT_BOOL('s', "stage", &show_stage,
544 N_("show staged contents' object name in the output")),
545 OPT_BOOL('k', "killed", &show_killed,
546 N_("show files on the filesystem that need to be removed")),
547 OPT_BIT(0, "directory", &dir.flags,
548 N_("show 'other' directories' names only"),
549 DIR_SHOW_OTHER_DIRECTORIES),
550 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
551 OPT_NEGBIT(0, "empty-directory", &dir.flags,
552 N_("don't show empty directories"),
553 DIR_HIDE_EMPTY_DIRECTORIES),
554 OPT_BOOL('u', "unmerged", &show_unmerged,
555 N_("show unmerged files in the output")),
556 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
557 N_("show resolve-undo information")),
558 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
559 N_("skip files matching pattern"),
560 PARSE_OPT_NONEG, option_parse_exclude },
561 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
562 N_("exclude patterns are read from <file>"),
563 PARSE_OPT_NONEG, option_parse_exclude_from },
564 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
565 N_("read additional per-directory exclude patterns in <file>")),
566 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
567 N_("add the standard git exclusions"),
568 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
569 option_parse_exclude_standard },
570 OPT_SET_INT_F(0, "full-name", &prefix_len,
571 N_("make the output relative to the project top directory"),
572 0, PARSE_OPT_NONEG),
573 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
574 N_("recurse through submodules")),
575 OPT_BOOL(0, "error-unmatch", &error_unmatch,
576 N_("if any <file> is not in the index, treat this as an error")),
577 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
578 N_("pretend that paths removed since <tree-ish> are still present")),
579 OPT__ABBREV(&abbrev),
580 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
581 OPT_END()
582 };
583 if (argc == 2 && !strcmp(argv[1], "-h"))
585 usage_with_options(ls_files_usage, builtin_ls_files_options);
586 memset(&dir, 0, sizeof(dir));
588 prefix = cmd_prefix;
589 if (prefix)
590 prefix_len = strlen(prefix);
591 git_config(git_default_config, NULL);
592 if (repo_read_index(the_repository) < 0)
594 die("index file corrupt");
595 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
597 ls_files_usage, 0);
598 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
599 for (i = 0; i < exclude_list.nr; i++) {
600 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
601 }
602 if (show_tag || show_valid_bit || show_fsmonitor_bit) {
603 tag_cached = "H ";
604 tag_unmerged = "M ";
605 tag_removed = "R ";
606 tag_modified = "C ";
607 tag_other = "? ";
608 tag_killed = "K ";
609 tag_skip_worktree = "S ";
610 tag_resolve_undo = "U ";
611 }
612 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
613 require_work_tree = 1;
614 if (show_unmerged)
615 /*
616 * There's no point in showing unmerged unless
617 * you also show the stage information.
618 */
619 show_stage = 1;
620 if (dir.exclude_per_dir)
621 exc_given = 1;
622 if (require_work_tree && !is_inside_work_tree())
624 setup_work_tree();
625 if (recurse_submodules &&
627 (show_stage || show_deleted || show_others || show_unmerged ||
628 show_killed || show_modified || show_resolve_undo || with_tree))
629 die("ls-files --recurse-submodules unsupported mode");
630 if (recurse_submodules && error_unmatch)
632 die("ls-files --recurse-submodules does not support "
633 "--error-unmatch");
634 parse_pathspec(&pathspec, 0,
636 PATHSPEC_PREFER_CWD,
637 prefix, argv);
638 /*
640 * Find common prefix for all pathspec's
641 * This is used as a performance optimization which unfortunately cannot
642 * be done when recursing into submodules because when a pathspec is
643 * given which spans repository boundaries you can't simply remove the
644 * submodule entry because the pathspec may match something inside the
645 * submodule.
646 */
647 if (recurse_submodules)
648 max_prefix = NULL;
649 else
650 max_prefix = common_prefix(&pathspec);
651 max_prefix_len = get_common_prefix_len(max_prefix);
652 prune_index(the_repository->index, max_prefix, max_prefix_len);
654 /* Treat unmatching pathspec elements as errors */
656 if (pathspec.nr && error_unmatch)
657 ps_matched = xcalloc(pathspec.nr, 1);
658 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
660 die("ls-files --ignored needs some exclude pattern");
661 /* With no flags, we default to showing the cached files */
663 if (!(show_stage || show_deleted || show_others || show_unmerged ||
664 show_killed || show_modified || show_resolve_undo))
665 show_cached = 1;
666 if (with_tree) {
668 /*
669 * Basic sanity check; show-stages and show-unmerged
670 * would not make any sense with this option.
671 */
672 if (show_stage || show_unmerged)
673 die("ls-files --with-tree is incompatible with -s or -u");
674 overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
675 }
676 show_files(the_repository, &dir);
678 if (show_resolve_undo)
680 show_ru_info(the_repository->index);
681 if (ps_matched) {
683 int bad;
684 bad = report_path_error(ps_matched, &pathspec, prefix);
685 if (bad)
686 fprintf(stderr, "Did you forget to 'git add'?\n");
687 return bad ? 1 : 0;
689 }
690 UNLEAK(dir);
692 return 0;
693}