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 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(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 memcpy(alttag, tag, 3);
91 if (isalpha(tag[0])) {
93 alttag[0] = tolower(tag[0]);
94 } else if (tag[0] == '?') {
95 alttag[0] = '!';
96 } else {
97 alttag[0] = 'v';
98 alttag[1] = tag[0];
99 alttag[2] = ' ';
100 alttag[3] = 0;
101 }
102 tag = alttag;
104 }
105 return tag;
107}
108static void print_debug(const struct cache_entry *ce)
110{
111 if (debug_mode) {
112 const struct stat_data *sd = &ce->ce_stat_data;
113 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
115 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
116 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
117 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
118 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
119 }
120}
121static void show_dir_entry(const char *tag, struct dir_entry *ent)
123{
124 int len = max_prefix_len;
125 if (len > ent->len)
127 die("git ls-files: internal error - directory entry not superset of prefix");
128 if (!dir_path_match(ent, &pathspec, len, ps_matched))
130 return;
131 fputs(tag, stdout);
133 write_eolinfo(NULL, NULL, ent->name);
134 write_name(ent->name);
135}
136static void show_other_files(const struct index_state *istate,
138 const struct dir_struct *dir)
139{
140 int i;
141 for (i = 0; i < dir->nr; i++) {
143 struct dir_entry *ent = dir->entries[i];
144 if (!index_name_is_other(istate, ent->name, ent->len))
145 continue;
146 show_dir_entry(tag_other, ent);
147 }
148}
149static void show_killed_files(const struct index_state *istate,
151 const struct dir_struct *dir)
152{
153 int i;
154 for (i = 0; i < dir->nr; i++) {
155 struct dir_entry *ent = dir->entries[i];
156 char *cp, *sp;
157 int pos, len, killed = 0;
158 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
160 sp = strchr(cp, '/');
161 if (!sp) {
162 /* If ent->name is prefix of an entry in the
163 * cache, it will be killed.
164 */
165 pos = index_name_pos(istate, ent->name, ent->len);
166 if (0 <= pos)
167 die("BUG: killed-file %.*s not found",
168 ent->len, ent->name);
169 pos = -pos - 1;
170 while (pos < istate->cache_nr &&
171 ce_stage(istate->cache[pos]))
172 pos++; /* skip unmerged */
173 if (istate->cache_nr <= pos)
174 break;
175 /* pos points at a name immediately after
176 * ent->name in the cache. Does it expect
177 * ent->name to be a directory?
178 */
179 len = ce_namelen(istate->cache[pos]);
180 if ((ent->len < len) &&
181 !strncmp(istate->cache[pos]->name,
182 ent->name, ent->len) &&
183 istate->cache[pos]->name[ent->len] == '/')
184 killed = 1;
185 break;
186 }
187 if (0 <= index_name_pos(istate, ent->name, sp - ent->name)) {
188 /* If any of the leading directories in
189 * ent->name is registered in the cache,
190 * ent->name will be killed.
191 */
192 killed = 1;
193 break;
194 }
195 }
196 if (killed)
197 show_dir_entry(tag_killed, dir->entries[i]);
198 }
199}
200static void show_files(struct repository *repo, struct dir_struct *dir);
202static void show_submodule(struct repository *superproject,
204 struct dir_struct *dir, const char *path)
205{
206 struct repository submodule;
207 if (repo_submodule_init(&submodule, superproject, path))
209 return;
210 if (repo_read_index(&submodule) < 0)
212 die("index file corrupt");
213 repo_read_gitmodules(&submodule);
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)
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 memmove(istate->cache, istate->cache + pos,
383 (last - pos) * sizeof(struct cache_entry *));
384 istate->cache_nr = last - pos;
385}
386static int get_common_prefix_len(const char *common_prefix)
388{
389 int common_prefix_len;
390 if (!common_prefix)
392 return 0;
393 common_prefix_len = strlen(common_prefix);
395 /*
397 * If the prefix has a trailing slash, strip it so that submodules wont
398 * be pruned from the index.
399 */
400 if (common_prefix[common_prefix_len - 1] == '/')
401 common_prefix_len--;
402 return common_prefix_len;
404}
405/*
407 * Read the tree specified with --with-tree option
408 * (typically, HEAD) into stage #1 and then
409 * squash them down to stage #0. This is used for
410 * --error-unmatch to list and check the path patterns
411 * that were given from the command line. We are not
412 * going to write this index out.
413 */
414void overlay_tree_on_index(struct index_state *istate,
415 const char *tree_name, const char *prefix)
416{
417 struct tree *tree;
418 struct object_id oid;
419 struct pathspec pathspec;
420 struct cache_entry *last_stage0 = NULL;
421 int i;
422 if (get_oid(tree_name, &oid))
424 die("tree-ish %s not found.", tree_name);
425 tree = parse_tree_indirect(&oid);
426 if (!tree)
427 die("bad tree-ish %s", tree_name);
428 /* Hoist the unmerged entries up to stage #3 to make room */
430 for (i = 0; i < istate->cache_nr; i++) {
431 struct cache_entry *ce = istate->cache[i];
432 if (!ce_stage(ce))
433 continue;
434 ce->ce_flags |= CE_STAGEMASK;
435 }
436 if (prefix) {
438 static const char *(matchbuf[1]);
439 matchbuf[0] = NULL;
440 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
441 PATHSPEC_PREFER_CWD, prefix, matchbuf);
442 } else
443 memset(&pathspec, 0, sizeof(pathspec));
444 if (read_tree(tree, 1, &pathspec, istate))
445 die("unable to read tree entries %s", tree_name);
446 for (i = 0; i < istate->cache_nr; i++) {
448 struct cache_entry *ce = istate->cache[i];
449 switch (ce_stage(ce)) {
450 case 0:
451 last_stage0 = ce;
452 /* fallthru */
453 default:
454 continue;
455 case 1:
456 /*
457 * If there is stage #0 entry for this, we do not
458 * need to show it. We use CE_UPDATE bit to mark
459 * such an entry.
460 */
461 if (last_stage0 &&
462 !strcmp(last_stage0->name, ce->name))
463 ce->ce_flags |= CE_UPDATE;
464 }
465 }
466}
467static const char * const ls_files_usage[] = {
469 N_("git ls-files [<options>] [<file>...]"),
470 NULL
471};
472static int option_parse_exclude(const struct option *opt,
474 const char *arg, int unset)
475{
476 struct string_list *exclude_list = opt->value;
477 exc_given = 1;
479 string_list_append(exclude_list, arg);
480 return 0;
482}
483static int option_parse_exclude_from(const struct option *opt,
485 const char *arg, int unset)
486{
487 struct dir_struct *dir = opt->value;
488 exc_given = 1;
490 add_excludes_from_file(dir, arg);
491 return 0;
493}
494static int option_parse_exclude_standard(const struct option *opt,
496 const char *arg, int unset)
497{
498 struct dir_struct *dir = opt->value;
499 exc_given = 1;
501 setup_standard_excludes(dir);
502 return 0;
504}
505int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
507{
508 int require_work_tree = 0, show_tag = 0, i;
509 const char *max_prefix;
510 struct dir_struct dir;
511 struct exclude_list *el;
512 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
513 struct option builtin_ls_files_options[] = {
514 /* Think twice before adding "--nul" synonym to this */
515 OPT_SET_INT('z', NULL, &line_terminator,
516 N_("paths are separated with NUL character"), '\0'),
517 OPT_BOOL('t', NULL, &show_tag,
518 N_("identify the file status with tags")),
519 OPT_BOOL('v', NULL, &show_valid_bit,
520 N_("use lowercase letters for 'assume unchanged' files")),
521 OPT_BOOL('c', "cached", &show_cached,
522 N_("show cached files in the output (default)")),
523 OPT_BOOL('d', "deleted", &show_deleted,
524 N_("show deleted files in the output")),
525 OPT_BOOL('m', "modified", &show_modified,
526 N_("show modified files in the output")),
527 OPT_BOOL('o', "others", &show_others,
528 N_("show other files in the output")),
529 OPT_BIT('i', "ignored", &dir.flags,
530 N_("show ignored files in the output"),
531 DIR_SHOW_IGNORED),
532 OPT_BOOL('s', "stage", &show_stage,
533 N_("show staged contents' object name in the output")),
534 OPT_BOOL('k', "killed", &show_killed,
535 N_("show files on the filesystem that need to be removed")),
536 OPT_BIT(0, "directory", &dir.flags,
537 N_("show 'other' directories' names only"),
538 DIR_SHOW_OTHER_DIRECTORIES),
539 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
540 OPT_NEGBIT(0, "empty-directory", &dir.flags,
541 N_("don't show empty directories"),
542 DIR_HIDE_EMPTY_DIRECTORIES),
543 OPT_BOOL('u', "unmerged", &show_unmerged,
544 N_("show unmerged files in the output")),
545 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
546 N_("show resolve-undo information")),
547 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
548 N_("skip files matching pattern"),
549 0, option_parse_exclude },
550 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
551 N_("exclude patterns are read from <file>"),
552 0, option_parse_exclude_from },
553 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
554 N_("read additional per-directory exclude patterns in <file>")),
555 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
556 N_("add the standard git exclusions"),
557 PARSE_OPT_NOARG, option_parse_exclude_standard },
558 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
559 N_("make the output relative to the project top directory"),
560 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
561 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
562 N_("recurse through submodules")),
563 OPT_BOOL(0, "error-unmatch", &error_unmatch,
564 N_("if any <file> is not in the index, treat this as an error")),
565 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
566 N_("pretend that paths removed since <tree-ish> are still present")),
567 OPT__ABBREV(&abbrev),
568 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
569 OPT_END()
570 };
571 if (argc == 2 && !strcmp(argv[1], "-h"))
573 usage_with_options(ls_files_usage, builtin_ls_files_options);
574 memset(&dir, 0, sizeof(dir));
576 prefix = cmd_prefix;
577 if (prefix)
578 prefix_len = strlen(prefix);
579 git_config(git_default_config, NULL);
580 if (repo_read_index(the_repository) < 0)
582 die("index file corrupt");
583 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
585 ls_files_usage, 0);
586 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
587 for (i = 0; i < exclude_list.nr; i++) {
588 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
589 }
590 if (show_tag || show_valid_bit) {
591 tag_cached = "H ";
592 tag_unmerged = "M ";
593 tag_removed = "R ";
594 tag_modified = "C ";
595 tag_other = "? ";
596 tag_killed = "K ";
597 tag_skip_worktree = "S ";
598 tag_resolve_undo = "U ";
599 }
600 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
601 require_work_tree = 1;
602 if (show_unmerged)
603 /*
604 * There's no point in showing unmerged unless
605 * you also show the stage information.
606 */
607 show_stage = 1;
608 if (dir.exclude_per_dir)
609 exc_given = 1;
610 if (require_work_tree && !is_inside_work_tree())
612 setup_work_tree();
613 if (recurse_submodules)
615 repo_read_gitmodules(the_repository);
616 if (recurse_submodules &&
618 (show_stage || show_deleted || show_others || show_unmerged ||
619 show_killed || show_modified || show_resolve_undo || with_tree))
620 die("ls-files --recurse-submodules unsupported mode");
621 if (recurse_submodules && error_unmatch)
623 die("ls-files --recurse-submodules does not support "
624 "--error-unmatch");
625 parse_pathspec(&pathspec, 0,
627 PATHSPEC_PREFER_CWD,
628 prefix, argv);
629 /*
631 * Find common prefix for all pathspec's
632 * This is used as a performance optimization which unfortunately cannot
633 * be done when recursing into submodules because when a pathspec is
634 * given which spans repository boundaries you can't simply remove the
635 * submodule entry because the pathspec may match something inside the
636 * submodule.
637 */
638 if (recurse_submodules)
639 max_prefix = NULL;
640 else
641 max_prefix = common_prefix(&pathspec);
642 max_prefix_len = get_common_prefix_len(max_prefix);
643 prune_index(the_repository->index, max_prefix, max_prefix_len);
645 /* Treat unmatching pathspec elements as errors */
647 if (pathspec.nr && error_unmatch)
648 ps_matched = xcalloc(pathspec.nr, 1);
649 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
651 die("ls-files --ignored needs some exclude pattern");
652 /* With no flags, we default to showing the cached files */
654 if (!(show_stage || show_deleted || show_others || show_unmerged ||
655 show_killed || show_modified || show_resolve_undo))
656 show_cached = 1;
657 if (with_tree) {
659 /*
660 * Basic sanity check; show-stages and show-unmerged
661 * would not make any sense with this option.
662 */
663 if (show_stage || show_unmerged)
664 die("ls-files --with-tree is incompatible with -s or -u");
665 overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
666 }
667 show_files(the_repository, &dir);
669 if (show_resolve_undo)
671 show_ru_info(the_repository->index);
672 if (ps_matched) {
674 int bad;
675 bad = report_path_error(ps_matched, &pathspec, prefix);
676 if (bad)
677 fprintf(stderr, "Did you forget to 'git add'?\n");
678 return bad ? 1 : 0;
680 }
681 return 0;
683}