e9b3546ca053f20c9582e6bf831bd922042bb07d
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 "quote.h"
10#include "dir.h"
11#include "builtin.h"
12#include "tree.h"
13#include "parse-options.h"
14#include "resolve-undo.h"
15#include "string-list.h"
16#include "pathspec.h"
17#include "run-command.h"
18#include "submodule.h"
19static int abbrev;
21static int show_deleted;
22static int show_cached;
23static int show_others;
24static int show_stage;
25static int show_unmerged;
26static int show_resolve_undo;
27static int show_modified;
28static int show_killed;
29static int show_valid_bit;
30static int line_terminator = '\n';
31static int debug_mode;
32static int show_eol;
33static int recurse_submodules;
34static struct argv_array submodule_options = ARGV_ARRAY_INIT;
35static const char *prefix;
37static const char *super_prefix;
38static int max_prefix_len;
39static int prefix_len;
40static struct pathspec pathspec;
41static int error_unmatch;
42static char *ps_matched;
43static const char *with_tree;
44static int exc_given;
45static int exclude_args;
46static const char *tag_cached = "";
48static const char *tag_unmerged = "";
49static const char *tag_removed = "";
50static const char *tag_other = "";
51static const char *tag_killed = "";
52static const char *tag_modified = "";
53static const char *tag_skip_worktree = "";
54static const char *tag_resolve_undo = "";
55static void write_eolinfo(const struct cache_entry *ce, const char *path)
57{
58 if (!show_eol)
59 return;
60 else {
61 struct stat st;
62 const char *i_txt = "";
63 const char *w_txt = "";
64 const char *a_txt = get_convert_attr_ascii(path);
65 if (ce && S_ISREG(ce->ce_mode))
66 i_txt = get_cached_convert_stats_ascii(ce->name);
67 if (!lstat(path, &st) && S_ISREG(st.st_mode))
68 w_txt = get_wt_convert_stats_ascii(path);
69 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
70 }
71}
72static void write_name(const char *name)
74{
75 /*
76 * Prepend the super_prefix to name to construct the full_name to be
77 * written.
78 */
79 struct strbuf full_name = STRBUF_INIT;
80 if (super_prefix) {
81 strbuf_addstr(&full_name, super_prefix);
82 strbuf_addstr(&full_name, name);
83 name = full_name.buf;
84 }
85 /*
87 * With "--full-name", prefix_len=0; this caller needs to pass
88 * an empty string in that case (a NULL is good for "").
89 */
90 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
91 stdout, line_terminator);
92 strbuf_release(&full_name);
94}
95static void show_dir_entry(const char *tag, struct dir_entry *ent)
97{
98 int len = max_prefix_len;
99 if (len >= ent->len)
101 die("git ls-files: internal error - directory entry not superset of prefix");
102 if (!dir_path_match(ent, &pathspec, len, ps_matched))
104 return;
105 fputs(tag, stdout);
107 write_eolinfo(NULL, ent->name);
108 write_name(ent->name);
109}
110static void show_other_files(struct dir_struct *dir)
112{
113 int i;
114 for (i = 0; i < dir->nr; i++) {
116 struct dir_entry *ent = dir->entries[i];
117 if (!cache_name_is_other(ent->name, ent->len))
118 continue;
119 show_dir_entry(tag_other, ent);
120 }
121}
122static void show_killed_files(struct dir_struct *dir)
124{
125 int i;
126 for (i = 0; i < dir->nr; i++) {
127 struct dir_entry *ent = dir->entries[i];
128 char *cp, *sp;
129 int pos, len, killed = 0;
130 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
132 sp = strchr(cp, '/');
133 if (!sp) {
134 /* If ent->name is prefix of an entry in the
135 * cache, it will be killed.
136 */
137 pos = cache_name_pos(ent->name, ent->len);
138 if (0 <= pos)
139 die("BUG: killed-file %.*s not found",
140 ent->len, ent->name);
141 pos = -pos - 1;
142 while (pos < active_nr &&
143 ce_stage(active_cache[pos]))
144 pos++; /* skip unmerged */
145 if (active_nr <= pos)
146 break;
147 /* pos points at a name immediately after
148 * ent->name in the cache. Does it expect
149 * ent->name to be a directory?
150 */
151 len = ce_namelen(active_cache[pos]);
152 if ((ent->len < len) &&
153 !strncmp(active_cache[pos]->name,
154 ent->name, ent->len) &&
155 active_cache[pos]->name[ent->len] == '/')
156 killed = 1;
157 break;
158 }
159 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
160 /* If any of the leading directories in
161 * ent->name is registered in the cache,
162 * ent->name will be killed.
163 */
164 killed = 1;
165 break;
166 }
167 }
168 if (killed)
169 show_dir_entry(tag_killed, dir->entries[i]);
170 }
171}
172/*
174 * Compile an argv_array with all of the options supported by --recurse_submodules
175 */
176static void compile_submodule_options(const char **argv,
177 const struct dir_struct *dir,
178 int show_tag)
179{
180 if (line_terminator == '\0')
181 argv_array_push(&submodule_options, "-z");
182 if (show_tag)
183 argv_array_push(&submodule_options, "-t");
184 if (show_valid_bit)
185 argv_array_push(&submodule_options, "-v");
186 if (show_cached)
187 argv_array_push(&submodule_options, "--cached");
188 if (show_eol)
189 argv_array_push(&submodule_options, "--eol");
190 if (debug_mode)
191 argv_array_push(&submodule_options, "--debug");
192 /* Add Pathspecs */
194 argv_array_push(&submodule_options, "--");
195 for (; *argv; argv++)
196 argv_array_push(&submodule_options, *argv);
197}
198/**
200 * Recursively call ls-files on a submodule
201 */
202static void show_gitlink(const struct cache_entry *ce)
203{
204 struct child_process cp = CHILD_PROCESS_INIT;
205 int status;
206 prepare_submodule_repo_env(&cp.env_array);
208 argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
209 if (prefix_len)
211 argv_array_pushf(&cp.env_array, "%s=%s",
212 GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
213 prefix);
214 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
215 super_prefix ? super_prefix : "",
216 ce->name);
217 argv_array_push(&cp.args, "ls-files");
218 argv_array_push(&cp.args, "--recurse-submodules");
219 /* add supported options */
221 argv_array_pushv(&cp.args, submodule_options.argv);
222 cp.git_cmd = 1;
224 cp.dir = ce->name;
225 status = run_command(&cp);
226 if (status)
227 exit(status);
228}
229static void show_ce_entry(const char *tag, const struct cache_entry *ce)
231{
232 struct strbuf name = STRBUF_INIT;
233 int len = max_prefix_len;
234 if (super_prefix)
235 strbuf_addstr(&name, super_prefix);
236 strbuf_addstr(&name, ce->name);
237 if (len >= ce_namelen(ce))
239 die("git ls-files: internal error - cache entry not superset of prefix");
240 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
242 submodule_path_match(&pathspec, name.buf, ps_matched)) {
243 show_gitlink(ce);
244 } else if (match_pathspec(&pathspec, name.buf, name.len,
245 len, ps_matched,
246 S_ISDIR(ce->ce_mode) ||
247 S_ISGITLINK(ce->ce_mode))) {
248 if (tag && *tag && show_valid_bit &&
249 (ce->ce_flags & CE_VALID)) {
250 static char alttag[4];
251 memcpy(alttag, tag, 3);
252 if (isalpha(tag[0]))
253 alttag[0] = tolower(tag[0]);
254 else if (tag[0] == '?')
255 alttag[0] = '!';
256 else {
257 alttag[0] = 'v';
258 alttag[1] = tag[0];
259 alttag[2] = ' ';
260 alttag[3] = 0;
261 }
262 tag = alttag;
263 }
264 if (!show_stage) {
266 fputs(tag, stdout);
267 } else {
268 printf("%s%06o %s %d\t",
269 tag,
270 ce->ce_mode,
271 find_unique_abbrev(ce->oid.hash, abbrev),
272 ce_stage(ce));
273 }
274 write_eolinfo(ce, ce->name);
275 write_name(ce->name);
276 if (debug_mode) {
277 const struct stat_data *sd = &ce->ce_stat_data;
278 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
280 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
281 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
282 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
283 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
284 }
285 }
286 strbuf_release(&name);
288}
289static void show_ru_info(void)
291{
292 struct string_list_item *item;
293 if (!the_index.resolve_undo)
295 return;
296 for_each_string_list_item(item, the_index.resolve_undo) {
298 const char *path = item->string;
299 struct resolve_undo_info *ui = item->util;
300 int i, len;
301 len = strlen(path);
303 if (len < max_prefix_len)
304 continue; /* outside of the prefix */
305 if (!match_pathspec(&pathspec, path, len,
306 max_prefix_len, ps_matched, 0))
307 continue; /* uninterested */
308 for (i = 0; i < 3; i++) {
309 if (!ui->mode[i])
310 continue;
311 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
312 find_unique_abbrev(ui->sha1[i], abbrev),
313 i + 1);
314 write_name(path);
315 }
316 }
317}
318static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
320{
321 int dtype = ce_to_dtype(ce);
322 return is_excluded(dir, ce->name, &dtype);
323}
324static void show_files(struct dir_struct *dir)
326{
327 int i;
328 /* For cached/deleted files we don't need to even do the readdir */
330 if (show_others || show_killed) {
331 if (!show_others)
332 dir->flags |= DIR_COLLECT_KILLED_ONLY;
333 fill_directory(dir, &pathspec);
334 if (show_others)
335 show_other_files(dir);
336 if (show_killed)
337 show_killed_files(dir);
338 }
339 if (show_cached || show_stage) {
340 for (i = 0; i < active_nr; i++) {
341 const struct cache_entry *ce = active_cache[i];
342 if ((dir->flags & DIR_SHOW_IGNORED) &&
343 !ce_excluded(dir, ce))
344 continue;
345 if (show_unmerged && !ce_stage(ce))
346 continue;
347 if (ce->ce_flags & CE_UPDATE)
348 continue;
349 show_ce_entry(ce_stage(ce) ? tag_unmerged :
350 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
351 }
352 }
353 if (show_deleted || show_modified) {
354 for (i = 0; i < active_nr; i++) {
355 const struct cache_entry *ce = active_cache[i];
356 struct stat st;
357 int err;
358 if ((dir->flags & DIR_SHOW_IGNORED) &&
359 !ce_excluded(dir, ce))
360 continue;
361 if (ce->ce_flags & CE_UPDATE)
362 continue;
363 if (ce_skip_worktree(ce))
364 continue;
365 err = lstat(ce->name, &st);
366 if (show_deleted && err)
367 show_ce_entry(tag_removed, ce);
368 if (show_modified && ce_modified(ce, &st, 0))
369 show_ce_entry(tag_modified, ce);
370 }
371 }
372}
373/*
375 * Prune the index to only contain stuff starting with "prefix"
376 */
377static void prune_cache(const char *prefix, size_t prefixlen)
378{
379 int pos;
380 unsigned int first, last;
381 if (!prefix)
383 return;
384 pos = cache_name_pos(prefix, prefixlen);
385 if (pos < 0)
386 pos = -pos-1;
387 first = pos;
388 last = active_nr;
389 while (last > first) {
390 int next = (last + first) >> 1;
391 const struct cache_entry *ce = active_cache[next];
392 if (!strncmp(ce->name, prefix, prefixlen)) {
393 first = next+1;
394 continue;
395 }
396 last = next;
397 }
398 memmove(active_cache, active_cache + pos,
399 (last - pos) * sizeof(struct cache_entry *));
400 active_nr = last - pos;
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_cache(const char *tree_name, const char *prefix)
412{
413 struct tree *tree;
414 unsigned char sha1[20];
415 struct pathspec pathspec;
416 struct cache_entry *last_stage0 = NULL;
417 int i;
418 if (get_sha1(tree_name, sha1))
420 die("tree-ish %s not found.", tree_name);
421 tree = parse_tree_indirect(sha1);
422 if (!tree)
423 die("bad tree-ish %s", tree_name);
424 /* Hoist the unmerged entries up to stage #3 to make room */
426 for (i = 0; i < active_nr; i++) {
427 struct cache_entry *ce = active_cache[i];
428 if (!ce_stage(ce))
429 continue;
430 ce->ce_flags |= CE_STAGEMASK;
431 }
432 if (prefix) {
434 static const char *(matchbuf[1]);
435 matchbuf[0] = NULL;
436 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
437 PATHSPEC_PREFER_CWD, prefix, matchbuf);
438 } else
439 memset(&pathspec, 0, sizeof(pathspec));
440 if (read_tree(tree, 1, &pathspec))
441 die("unable to read tree entries %s", tree_name);
442 for (i = 0; i < active_nr; i++) {
444 struct cache_entry *ce = active_cache[i];
445 switch (ce_stage(ce)) {
446 case 0:
447 last_stage0 = ce;
448 /* fallthru */
449 default:
450 continue;
451 case 1:
452 /*
453 * If there is stage #0 entry for this, we do not
454 * need to show it. We use CE_UPDATE bit to mark
455 * such an entry.
456 */
457 if (last_stage0 &&
458 !strcmp(last_stage0->name, ce->name))
459 ce->ce_flags |= CE_UPDATE;
460 }
461 }
462}
463static const char * const ls_files_usage[] = {
465 N_("git ls-files [<options>] [<file>...]"),
466 NULL
467};
468static int option_parse_exclude(const struct option *opt,
470 const char *arg, int unset)
471{
472 struct string_list *exclude_list = opt->value;
473 exc_given = 1;
475 string_list_append(exclude_list, arg);
476 return 0;
478}
479static int option_parse_exclude_from(const struct option *opt,
481 const char *arg, int unset)
482{
483 struct dir_struct *dir = opt->value;
484 exc_given = 1;
486 add_excludes_from_file(dir, arg);
487 return 0;
489}
490static int option_parse_exclude_standard(const struct option *opt,
492 const char *arg, int unset)
493{
494 struct dir_struct *dir = opt->value;
495 exc_given = 1;
497 setup_standard_excludes(dir);
498 return 0;
500}
501int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
503{
504 int require_work_tree = 0, show_tag = 0, i;
505 const char *max_prefix;
506 struct dir_struct dir;
507 struct exclude_list *el;
508 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
509 struct option builtin_ls_files_options[] = {
510 /* Think twice before adding "--nul" synonym to this */
511 OPT_SET_INT('z', NULL, &line_terminator,
512 N_("paths are separated with NUL character"), '\0'),
513 OPT_BOOL('t', NULL, &show_tag,
514 N_("identify the file status with tags")),
515 OPT_BOOL('v', NULL, &show_valid_bit,
516 N_("use lowercase letters for 'assume unchanged' files")),
517 OPT_BOOL('c', "cached", &show_cached,
518 N_("show cached files in the output (default)")),
519 OPT_BOOL('d', "deleted", &show_deleted,
520 N_("show deleted files in the output")),
521 OPT_BOOL('m', "modified", &show_modified,
522 N_("show modified files in the output")),
523 OPT_BOOL('o', "others", &show_others,
524 N_("show other files in the output")),
525 OPT_BIT('i', "ignored", &dir.flags,
526 N_("show ignored files in the output"),
527 DIR_SHOW_IGNORED),
528 OPT_BOOL('s', "stage", &show_stage,
529 N_("show staged contents' object name in the output")),
530 OPT_BOOL('k', "killed", &show_killed,
531 N_("show files on the filesystem that need to be removed")),
532 OPT_BIT(0, "directory", &dir.flags,
533 N_("show 'other' directories' names only"),
534 DIR_SHOW_OTHER_DIRECTORIES),
535 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
536 OPT_NEGBIT(0, "empty-directory", &dir.flags,
537 N_("don't show empty directories"),
538 DIR_HIDE_EMPTY_DIRECTORIES),
539 OPT_BOOL('u', "unmerged", &show_unmerged,
540 N_("show unmerged files in the output")),
541 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
542 N_("show resolve-undo information")),
543 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
544 N_("skip files matching pattern"),
545 0, option_parse_exclude },
546 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
547 N_("exclude patterns are read from <file>"),
548 0, option_parse_exclude_from },
549 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
550 N_("read additional per-directory exclude patterns in <file>")),
551 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
552 N_("add the standard git exclusions"),
553 PARSE_OPT_NOARG, option_parse_exclude_standard },
554 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
555 N_("make the output relative to the project top directory"),
556 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
557 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
558 N_("recurse through submodules")),
559 OPT_BOOL(0, "error-unmatch", &error_unmatch,
560 N_("if any <file> is not in the index, treat this as an error")),
561 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
562 N_("pretend that paths removed since <tree-ish> are still present")),
563 OPT__ABBREV(&abbrev),
564 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
565 OPT_END()
566 };
567 if (argc == 2 && !strcmp(argv[1], "-h"))
569 usage_with_options(ls_files_usage, builtin_ls_files_options);
570 memset(&dir, 0, sizeof(dir));
572 prefix = cmd_prefix;
573 if (prefix)
574 prefix_len = strlen(prefix);
575 super_prefix = get_super_prefix();
576 git_config(git_default_config, NULL);
577 if (read_cache() < 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 compile_submodule_options(argv, &dir, show_tag);
613 if (recurse_submodules &&
615 (show_stage || show_deleted || show_others || show_unmerged ||
616 show_killed || show_modified || show_resolve_undo || with_tree))
617 die("ls-files --recurse-submodules unsupported mode");
618 if (recurse_submodules && error_unmatch)
620 die("ls-files --recurse-submodules does not support "
621 "--error-unmatch");
622 parse_pathspec(&pathspec, 0,
624 PATHSPEC_PREFER_CWD |
625 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
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
632 */
633 if (recurse_submodules)
634 max_prefix = NULL;
635 else
636 max_prefix = common_prefix(&pathspec);
637 max_prefix_len = max_prefix ? strlen(max_prefix) : 0;
638 /* Treat unmatching pathspec elements as errors */
640 if (pathspec.nr && error_unmatch)
641 ps_matched = xcalloc(pathspec.nr, 1);
642 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
644 die("ls-files --ignored needs some exclude pattern");
645 /* With no flags, we default to showing the cached files */
647 if (!(show_stage || show_deleted || show_others || show_unmerged ||
648 show_killed || show_modified || show_resolve_undo))
649 show_cached = 1;
650 prune_cache(max_prefix, max_prefix_len);
652 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_cache(with_tree, max_prefix);
660 }
661 show_files(&dir);
662 if (show_resolve_undo)
663 show_ru_info();
664 if (ps_matched) {
666 int bad;
667 bad = report_path_error(ps_matched, &pathspec, prefix);
668 if (bad)
669 fprintf(stderr, "Did you forget to 'git add'?\n");
670 return bad ? 1 : 0;
672 }
673 return 0;
675}