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