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(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 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(ent, &pathspec, len, ps_matched))
132 return;
133 fputs(tag, stdout);
135 write_eolinfo(NULL, 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(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 die("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(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 submodule;
209 if (repo_submodule_init(&submodule, superproject, path))
211 return;
212 if (repo_read_index(&submodule) < 0)
214 die("index file corrupt");
215 show_files(&submodule, dir);
217 repo_clear(&submodule);
219}
220static void show_ce(struct repository *repo, struct dir_struct *dir,
222 const struct cache_entry *ce, const char *fullname,
223 const char *tag)
224{
225 if (max_prefix_len > strlen(fullname))
226 die("git ls-files: internal error - cache entry not superset of prefix");
227 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
229 is_submodule_active(repo, ce->name)) {
230 show_submodule(repo, dir, ce->name);
231 } else if (match_pathspec(&pathspec, fullname, strlen(fullname),
232 max_prefix_len, ps_matched,
233 S_ISDIR(ce->ce_mode) ||
234 S_ISGITLINK(ce->ce_mode))) {
235 tag = get_tag(ce, tag);
236 if (!show_stage) {
238 fputs(tag, stdout);
239 } else {
240 printf("%s%06o %s %d\t",
241 tag,
242 ce->ce_mode,
243 find_unique_abbrev(ce->oid.hash, abbrev),
244 ce_stage(ce));
245 }
246 write_eolinfo(repo->index, ce, fullname);
247 write_name(fullname);
248 print_debug(ce);
249 }
250}
251static void show_ru_info(const struct index_state *istate)
253{
254 struct string_list_item *item;
255 if (!istate->resolve_undo)
257 return;
258 for_each_string_list_item(item, istate->resolve_undo) {
260 const char *path = item->string;
261 struct resolve_undo_info *ui = item->util;
262 int i, len;
263 len = strlen(path);
265 if (len < max_prefix_len)
266 continue; /* outside of the prefix */
267 if (!match_pathspec(&pathspec, path, len,
268 max_prefix_len, ps_matched, 0))
269 continue; /* uninterested */
270 for (i = 0; i < 3; i++) {
271 if (!ui->mode[i])
272 continue;
273 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
274 find_unique_abbrev(ui->sha1[i], abbrev),
275 i + 1);
276 write_name(path);
277 }
278 }
279}
280static int ce_excluded(struct dir_struct *dir, struct index_state *istate,
282 const char *fullname, const struct cache_entry *ce)
283{
284 int dtype = ce_to_dtype(ce);
285 return is_excluded(dir, istate, fullname, &dtype);
286}
287static void construct_fullname(struct strbuf *out, const struct repository *repo,
289 const struct cache_entry *ce)
290{
291 strbuf_reset(out);
292 if (repo->submodule_prefix)
293 strbuf_addstr(out, repo->submodule_prefix);
294 strbuf_addstr(out, ce->name);
295}
296static void show_files(struct repository *repo, struct dir_struct *dir)
298{
299 int i;
300 struct strbuf fullname = STRBUF_INIT;
301 /* For cached/deleted files we don't need to even do the readdir */
303 if (show_others || show_killed) {
304 if (!show_others)
305 dir->flags |= DIR_COLLECT_KILLED_ONLY;
306 fill_directory(dir, repo->index, &pathspec);
307 if (show_others)
308 show_other_files(repo->index, dir);
309 if (show_killed)
310 show_killed_files(repo->index, dir);
311 }
312 if (show_cached || show_stage) {
313 for (i = 0; i < repo->index->cache_nr; i++) {
314 const struct cache_entry *ce = repo->index->cache[i];
315 construct_fullname(&fullname, repo, ce);
317 if ((dir->flags & DIR_SHOW_IGNORED) &&
319 !ce_excluded(dir, repo->index, fullname.buf, ce))
320 continue;
321 if (show_unmerged && !ce_stage(ce))
322 continue;
323 if (ce->ce_flags & CE_UPDATE)
324 continue;
325 show_ce(repo, dir, ce, fullname.buf,
326 ce_stage(ce) ? tag_unmerged :
327 (ce_skip_worktree(ce) ? tag_skip_worktree :
328 tag_cached));
329 }
330 }
331 if (show_deleted || show_modified) {
332 for (i = 0; i < repo->index->cache_nr; i++) {
333 const struct cache_entry *ce = repo->index->cache[i];
334 struct stat st;
335 int err;
336 construct_fullname(&fullname, repo, ce);
338 if ((dir->flags & DIR_SHOW_IGNORED) &&
340 !ce_excluded(dir, repo->index, fullname.buf, ce))
341 continue;
342 if (ce->ce_flags & CE_UPDATE)
343 continue;
344 if (ce_skip_worktree(ce))
345 continue;
346 err = lstat(fullname.buf, &st);
347 if (show_deleted && err)
348 show_ce(repo, dir, ce, fullname.buf, tag_removed);
349 if (show_modified && ie_modified(repo->index, ce, &st, 0))
350 show_ce(repo, dir, ce, fullname.buf, tag_modified);
351 }
352 }
353 strbuf_release(&fullname);
355}
356/*
358 * Prune the index to only contain stuff starting with "prefix"
359 */
360static void prune_index(struct index_state *istate,
361 const char *prefix, size_t prefixlen)
362{
363 int pos;
364 unsigned int first, last;
365 if (!prefix || !istate->cache_nr)
367 return;
368 pos = index_name_pos(istate, prefix, prefixlen);
369 if (pos < 0)
370 pos = -pos-1;
371 first = pos;
372 last = istate->cache_nr;
373 while (last > first) {
374 int next = (last + first) >> 1;
375 const struct cache_entry *ce = istate->cache[next];
376 if (!strncmp(ce->name, prefix, prefixlen)) {
377 first = next+1;
378 continue;
379 }
380 last = next;
381 }
382 MOVE_ARRAY(istate->cache, istate->cache + pos, last - pos);
383 istate->cache_nr = last - pos;
384}
385static int get_common_prefix_len(const char *common_prefix)
387{
388 int common_prefix_len;
389 if (!common_prefix)
391 return 0;
392 common_prefix_len = strlen(common_prefix);
394 /*
396 * If the prefix has a trailing slash, strip it so that submodules wont
397 * be pruned from the index.
398 */
399 if (common_prefix[common_prefix_len - 1] == '/')
400 common_prefix_len--;
401 return common_prefix_len;
403}
404/*
406 * Read the tree specified with --with-tree option
407 * (typically, HEAD) into stage #1 and then
408 * squash them down to stage #0. This is used for
409 * --error-unmatch to list and check the path patterns
410 * that were given from the command line. We are not
411 * going to write this index out.
412 */
413void overlay_tree_on_index(struct index_state *istate,
414 const char *tree_name, const char *prefix)
415{
416 struct tree *tree;
417 struct object_id oid;
418 struct pathspec pathspec;
419 struct cache_entry *last_stage0 = NULL;
420 int i;
421 if (get_oid(tree_name, &oid))
423 die("tree-ish %s not found.", tree_name);
424 tree = parse_tree_indirect(&oid);
425 if (!tree)
426 die("bad tree-ish %s", tree_name);
427 /* Hoist the unmerged entries up to stage #3 to make room */
429 for (i = 0; i < istate->cache_nr; i++) {
430 struct cache_entry *ce = istate->cache[i];
431 if (!ce_stage(ce))
432 continue;
433 ce->ce_flags |= CE_STAGEMASK;
434 }
435 if (prefix) {
437 static const char *(matchbuf[1]);
438 matchbuf[0] = NULL;
439 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
440 PATHSPEC_PREFER_CWD, prefix, matchbuf);
441 } else
442 memset(&pathspec, 0, sizeof(pathspec));
443 if (read_tree(tree, 1, &pathspec, istate))
444 die("unable to read tree entries %s", tree_name);
445 for (i = 0; i < istate->cache_nr; i++) {
447 struct cache_entry *ce = istate->cache[i];
448 switch (ce_stage(ce)) {
449 case 0:
450 last_stage0 = ce;
451 /* fallthru */
452 default:
453 continue;
454 case 1:
455 /*
456 * If there is stage #0 entry for this, we do not
457 * need to show it. We use CE_UPDATE bit to mark
458 * such an entry.
459 */
460 if (last_stage0 &&
461 !strcmp(last_stage0->name, ce->name))
462 ce->ce_flags |= CE_UPDATE;
463 }
464 }
465}
466static const char * const ls_files_usage[] = {
468 N_("git ls-files [<options>] [<file>...]"),
469 NULL
470};
471static int option_parse_exclude(const struct option *opt,
473 const char *arg, int unset)
474{
475 struct string_list *exclude_list = opt->value;
476 exc_given = 1;
478 string_list_append(exclude_list, arg);
479 return 0;
481}
482static int option_parse_exclude_from(const struct option *opt,
484 const char *arg, int unset)
485{
486 struct dir_struct *dir = opt->value;
487 exc_given = 1;
489 add_excludes_from_file(dir, arg);
490 return 0;
492}
493static int option_parse_exclude_standard(const struct option *opt,
495 const char *arg, int unset)
496{
497 struct dir_struct *dir = opt->value;
498 exc_given = 1;
500 setup_standard_excludes(dir);
501 return 0;
503}
504int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
506{
507 int require_work_tree = 0, show_tag = 0, i;
508 const char *max_prefix;
509 struct dir_struct dir;
510 struct exclude_list *el;
511 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
512 struct option builtin_ls_files_options[] = {
513 /* Think twice before adding "--nul" synonym to this */
514 OPT_SET_INT('z', NULL, &line_terminator,
515 N_("paths are separated with NUL character"), '\0'),
516 OPT_BOOL('t', NULL, &show_tag,
517 N_("identify the file status with tags")),
518 OPT_BOOL('v', NULL, &show_valid_bit,
519 N_("use lowercase letters for 'assume unchanged' files")),
520 OPT_BOOL('f', NULL, &show_fsmonitor_bit,
521 N_("use lowercase letters for 'fsmonitor clean' files")),
522 OPT_BOOL('c', "cached", &show_cached,
523 N_("show cached files in the output (default)")),
524 OPT_BOOL('d', "deleted", &show_deleted,
525 N_("show deleted files in the output")),
526 OPT_BOOL('m', "modified", &show_modified,
527 N_("show modified files in the output")),
528 OPT_BOOL('o', "others", &show_others,
529 N_("show other files in the output")),
530 OPT_BIT('i', "ignored", &dir.flags,
531 N_("show ignored files in the output"),
532 DIR_SHOW_IGNORED),
533 OPT_BOOL('s', "stage", &show_stage,
534 N_("show staged contents' object name in the output")),
535 OPT_BOOL('k', "killed", &show_killed,
536 N_("show files on the filesystem that need to be removed")),
537 OPT_BIT(0, "directory", &dir.flags,
538 N_("show 'other' directories' names only"),
539 DIR_SHOW_OTHER_DIRECTORIES),
540 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
541 OPT_NEGBIT(0, "empty-directory", &dir.flags,
542 N_("don't show empty directories"),
543 DIR_HIDE_EMPTY_DIRECTORIES),
544 OPT_BOOL('u', "unmerged", &show_unmerged,
545 N_("show unmerged files in the output")),
546 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
547 N_("show resolve-undo information")),
548 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
549 N_("skip files matching pattern"),
550 0, option_parse_exclude },
551 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
552 N_("exclude patterns are read from <file>"),
553 0, option_parse_exclude_from },
554 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
555 N_("read additional per-directory exclude patterns in <file>")),
556 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
557 N_("add the standard git exclusions"),
558 PARSE_OPT_NOARG, option_parse_exclude_standard },
559 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
560 N_("make the output relative to the project top directory"),
561 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
562 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
563 N_("recurse through submodules")),
564 OPT_BOOL(0, "error-unmatch", &error_unmatch,
565 N_("if any <file> is not in the index, treat this as an error")),
566 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
567 N_("pretend that paths removed since <tree-ish> are still present")),
568 OPT__ABBREV(&abbrev),
569 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
570 OPT_END()
571 };
572 if (argc == 2 && !strcmp(argv[1], "-h"))
574 usage_with_options(ls_files_usage, builtin_ls_files_options);
575 memset(&dir, 0, sizeof(dir));
577 prefix = cmd_prefix;
578 if (prefix)
579 prefix_len = strlen(prefix);
580 git_config(git_default_config, NULL);
581 if (repo_read_index(the_repository) < 0)
583 die("index file corrupt");
584 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
586 ls_files_usage, 0);
587 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
588 for (i = 0; i < exclude_list.nr; i++) {
589 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
590 }
591 if (show_tag || show_valid_bit || show_fsmonitor_bit) {
592 tag_cached = "H ";
593 tag_unmerged = "M ";
594 tag_removed = "R ";
595 tag_modified = "C ";
596 tag_other = "? ";
597 tag_killed = "K ";
598 tag_skip_worktree = "S ";
599 tag_resolve_undo = "U ";
600 }
601 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
602 require_work_tree = 1;
603 if (show_unmerged)
604 /*
605 * There's no point in showing unmerged unless
606 * you also show the stage information.
607 */
608 show_stage = 1;
609 if (dir.exclude_per_dir)
610 exc_given = 1;
611 if (require_work_tree && !is_inside_work_tree())
613 setup_work_tree();
614 if (recurse_submodules &&
616 (show_stage || show_deleted || show_others || show_unmerged ||
617 show_killed || show_modified || show_resolve_undo || with_tree))
618 die("ls-files --recurse-submodules unsupported mode");
619 if (recurse_submodules && error_unmatch)
621 die("ls-files --recurse-submodules does not support "
622 "--error-unmatch");
623 parse_pathspec(&pathspec, 0,
625 PATHSPEC_PREFER_CWD,
626 prefix, argv);
627 /*
629 * Find common prefix for all pathspec's
630 * This is used as a performance optimization which unfortunately cannot
631 * be done when recursing into submodules because when a pathspec is
632 * given which spans repository boundaries you can't simply remove the
633 * submodule entry because the pathspec may match something inside the
634 * submodule.
635 */
636 if (recurse_submodules)
637 max_prefix = NULL;
638 else
639 max_prefix = common_prefix(&pathspec);
640 max_prefix_len = get_common_prefix_len(max_prefix);
641 prune_index(the_repository->index, max_prefix, max_prefix_len);
643 /* Treat unmatching pathspec elements as errors */
645 if (pathspec.nr && error_unmatch)
646 ps_matched = xcalloc(pathspec.nr, 1);
647 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
649 die("ls-files --ignored needs some exclude pattern");
650 /* With no flags, we default to showing the cached files */
652 if (!(show_stage || show_deleted || show_others || show_unmerged ||
653 show_killed || show_modified || show_resolve_undo))
654 show_cached = 1;
655 if (with_tree) {
657 /*
658 * Basic sanity check; show-stages and show-unmerged
659 * would not make any sense with this option.
660 */
661 if (show_stage || show_unmerged)
662 die("ls-files --with-tree is incompatible with -s or -u");
663 overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
664 }
665 show_files(the_repository, &dir);
667 if (show_resolve_undo)
669 show_ru_info(the_repository->index);
670 if (ps_matched) {
672 int bad;
673 bad = report_path_error(ps_matched, &pathspec, prefix);
674 if (bad)
675 fprintf(stderr, "Did you forget to 'git add'?\n");
676 return bad ? 1 : 0;
678 }
679 UNLEAK(dir);
681 return 0;
682}