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