b82b78036df7041f25fc2b0df87e6942196e72ac
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 index_state *istate,
57 const struct cache_entry *ce, const char *path)
58{
59 if (show_eol) {
60 struct stat st;
61 const char *i_txt = "";
62 const char *w_txt = "";
63 const char *a_txt = get_convert_attr_ascii(path);
64 if (ce && S_ISREG(ce->ce_mode))
65 i_txt = get_cached_convert_stats_ascii(istate,
66 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, 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(const struct index_state *istate,
124 const struct dir_struct *dir)
125{
126 int i;
127 for (i = 0; i < dir->nr; i++) {
128 struct dir_entry *ent = dir->entries[i];
129 char *cp, *sp;
130 int pos, len, killed = 0;
131 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
133 sp = strchr(cp, '/');
134 if (!sp) {
135 /* If ent->name is prefix of an entry in the
136 * cache, it will be killed.
137 */
138 pos = index_name_pos(istate, ent->name, ent->len);
139 if (0 <= pos)
140 die("BUG: killed-file %.*s not found",
141 ent->len, ent->name);
142 pos = -pos - 1;
143 while (pos < istate->cache_nr &&
144 ce_stage(istate->cache[pos]))
145 pos++; /* skip unmerged */
146 if (istate->cache_nr <= pos)
147 break;
148 /* pos points at a name immediately after
149 * ent->name in the cache. Does it expect
150 * ent->name to be a directory?
151 */
152 len = ce_namelen(istate->cache[pos]);
153 if ((ent->len < len) &&
154 !strncmp(istate->cache[pos]->name,
155 ent->name, ent->len) &&
156 istate->cache[pos]->name[ent->len] == '/')
157 killed = 1;
158 break;
159 }
160 if (0 <= index_name_pos(istate, ent->name, sp - ent->name)) {
161 /* If any of the leading directories in
162 * ent->name is registered in the cache,
163 * ent->name will be killed.
164 */
165 killed = 1;
166 break;
167 }
168 }
169 if (killed)
170 show_dir_entry(tag_killed, dir->entries[i]);
171 }
172}
173/*
175 * Compile an argv_array with all of the options supported by --recurse_submodules
176 */
177static void compile_submodule_options(const char **argv,
178 const struct dir_struct *dir,
179 int show_tag)
180{
181 if (line_terminator == '\0')
182 argv_array_push(&submodule_options, "-z");
183 if (show_tag)
184 argv_array_push(&submodule_options, "-t");
185 if (show_valid_bit)
186 argv_array_push(&submodule_options, "-v");
187 if (show_cached)
188 argv_array_push(&submodule_options, "--cached");
189 if (show_eol)
190 argv_array_push(&submodule_options, "--eol");
191 if (debug_mode)
192 argv_array_push(&submodule_options, "--debug");
193 /* Add Pathspecs */
195 argv_array_push(&submodule_options, "--");
196 for (; *argv; argv++)
197 argv_array_push(&submodule_options, *argv);
198}
199/**
201 * Recursively call ls-files on a submodule
202 */
203static void show_gitlink(const struct cache_entry *ce)
204{
205 struct child_process cp = CHILD_PROCESS_INIT;
206 int status;
207 char *dir;
208 prepare_submodule_repo_env(&cp.env_array);
210 argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
211 if (prefix_len)
213 argv_array_pushf(&cp.env_array, "%s=%s",
214 GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
215 prefix);
216 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
217 super_prefix ? super_prefix : "",
218 ce->name);
219 argv_array_push(&cp.args, "ls-files");
220 argv_array_push(&cp.args, "--recurse-submodules");
221 /* add supported options */
223 argv_array_pushv(&cp.args, submodule_options.argv);
224 cp.git_cmd = 1;
226 dir = mkpathdup("%s/%s", get_git_work_tree(), ce->name);
227 cp.dir = dir;
228 status = run_command(&cp);
229 free(dir);
230 if (status)
231 exit(status);
232}
233static void show_ce_entry(const char *tag, const struct cache_entry *ce)
235{
236 struct strbuf name = STRBUF_INIT;
237 int len = max_prefix_len;
238 if (super_prefix)
239 strbuf_addstr(&name, super_prefix);
240 strbuf_addstr(&name, ce->name);
241 if (len > ce_namelen(ce))
243 die("git ls-files: internal error - cache entry not superset of prefix");
244 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
246 submodule_path_match(&pathspec, name.buf, ps_matched)) {
247 show_gitlink(ce);
248 } else if (match_pathspec(&pathspec, name.buf, name.len,
249 len, ps_matched,
250 S_ISDIR(ce->ce_mode) ||
251 S_ISGITLINK(ce->ce_mode))) {
252 if (tag && *tag && show_valid_bit &&
253 (ce->ce_flags & CE_VALID)) {
254 static char alttag[4];
255 memcpy(alttag, tag, 3);
256 if (isalpha(tag[0]))
257 alttag[0] = tolower(tag[0]);
258 else if (tag[0] == '?')
259 alttag[0] = '!';
260 else {
261 alttag[0] = 'v';
262 alttag[1] = tag[0];
263 alttag[2] = ' ';
264 alttag[3] = 0;
265 }
266 tag = alttag;
267 }
268 if (!show_stage) {
270 fputs(tag, stdout);
271 } else {
272 printf("%s%06o %s %d\t",
273 tag,
274 ce->ce_mode,
275 find_unique_abbrev(ce->oid.hash, abbrev),
276 ce_stage(ce));
277 }
278 write_eolinfo(&the_index, ce, ce->name);
279 write_name(ce->name);
280 if (debug_mode) {
281 const struct stat_data *sd = &ce->ce_stat_data;
282 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
284 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
285 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
286 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
287 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
288 }
289 }
290 strbuf_release(&name);
292}
293static void show_ru_info(void)
295{
296 struct string_list_item *item;
297 if (!the_index.resolve_undo)
299 return;
300 for_each_string_list_item(item, the_index.resolve_undo) {
302 const char *path = item->string;
303 struct resolve_undo_info *ui = item->util;
304 int i, len;
305 len = strlen(path);
307 if (len < max_prefix_len)
308 continue; /* outside of the prefix */
309 if (!match_pathspec(&pathspec, path, len,
310 max_prefix_len, ps_matched, 0))
311 continue; /* uninterested */
312 for (i = 0; i < 3; i++) {
313 if (!ui->mode[i])
314 continue;
315 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
316 find_unique_abbrev(ui->sha1[i], abbrev),
317 i + 1);
318 write_name(path);
319 }
320 }
321}
322static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
324{
325 int dtype = ce_to_dtype(ce);
326 return is_excluded(dir, &the_index, ce->name, &dtype);
327}
328static void show_files(struct dir_struct *dir)
330{
331 int i;
332 /* For cached/deleted files we don't need to even do the readdir */
334 if (show_others || show_killed) {
335 if (!show_others)
336 dir->flags |= DIR_COLLECT_KILLED_ONLY;
337 fill_directory(dir, &the_index, &pathspec);
338 if (show_others)
339 show_other_files(dir);
340 if (show_killed)
341 show_killed_files(&the_index, dir);
342 }
343 if (show_cached || show_stage) {
344 for (i = 0; i < active_nr; i++) {
345 const struct cache_entry *ce = active_cache[i];
346 if ((dir->flags & DIR_SHOW_IGNORED) &&
347 !ce_excluded(dir, ce))
348 continue;
349 if (show_unmerged && !ce_stage(ce))
350 continue;
351 if (ce->ce_flags & CE_UPDATE)
352 continue;
353 show_ce_entry(ce_stage(ce) ? tag_unmerged :
354 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
355 }
356 }
357 if (show_deleted || show_modified) {
358 for (i = 0; i < active_nr; i++) {
359 const struct cache_entry *ce = active_cache[i];
360 struct stat st;
361 int err;
362 if ((dir->flags & DIR_SHOW_IGNORED) &&
363 !ce_excluded(dir, ce))
364 continue;
365 if (ce->ce_flags & CE_UPDATE)
366 continue;
367 if (ce_skip_worktree(ce))
368 continue;
369 err = lstat(ce->name, &st);
370 if (show_deleted && err)
371 show_ce_entry(tag_removed, ce);
372 if (show_modified && ce_modified(ce, &st, 0))
373 show_ce_entry(tag_modified, ce);
374 }
375 }
376}
377/*
379 * Prune the index to only contain stuff starting with "prefix"
380 */
381static void prune_cache(const char *prefix, size_t prefixlen)
382{
383 int pos;
384 unsigned int first, last;
385 if (!prefix)
387 return;
388 pos = cache_name_pos(prefix, prefixlen);
389 if (pos < 0)
390 pos = -pos-1;
391 first = pos;
392 last = active_nr;
393 while (last > first) {
394 int next = (last + first) >> 1;
395 const struct cache_entry *ce = active_cache[next];
396 if (!strncmp(ce->name, prefix, prefixlen)) {
397 first = next+1;
398 continue;
399 }
400 last = next;
401 }
402 memmove(active_cache, active_cache + pos,
403 (last - pos) * sizeof(struct cache_entry *));
404 active_nr = last - pos;
405}
406static int get_common_prefix_len(const char *common_prefix)
408{
409 int common_prefix_len;
410 if (!common_prefix)
412 return 0;
413 common_prefix_len = strlen(common_prefix);
415 /*
417 * If the prefix has a trailing slash, strip it so that submodules wont
418 * be pruned from the index.
419 */
420 if (common_prefix[common_prefix_len - 1] == '/')
421 common_prefix_len--;
422 return common_prefix_len;
424}
425/*
427 * Read the tree specified with --with-tree option
428 * (typically, HEAD) into stage #1 and then
429 * squash them down to stage #0. This is used for
430 * --error-unmatch to list and check the path patterns
431 * that were given from the command line. We are not
432 * going to write this index out.
433 */
434void overlay_tree_on_index(struct index_state *istate,
435 const char *tree_name, const char *prefix)
436{
437 struct tree *tree;
438 struct object_id oid;
439 struct pathspec pathspec;
440 struct cache_entry *last_stage0 = NULL;
441 int i;
442 if (get_oid(tree_name, &oid))
444 die("tree-ish %s not found.", tree_name);
445 tree = parse_tree_indirect(&oid);
446 if (!tree)
447 die("bad tree-ish %s", tree_name);
448 /* Hoist the unmerged entries up to stage #3 to make room */
450 for (i = 0; i < istate->cache_nr; i++) {
451 struct cache_entry *ce = istate->cache[i];
452 if (!ce_stage(ce))
453 continue;
454 ce->ce_flags |= CE_STAGEMASK;
455 }
456 if (prefix) {
458 static const char *(matchbuf[1]);
459 matchbuf[0] = NULL;
460 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
461 PATHSPEC_PREFER_CWD, prefix, matchbuf);
462 } else
463 memset(&pathspec, 0, sizeof(pathspec));
464 if (read_tree(tree, 1, &pathspec, istate))
465 die("unable to read tree entries %s", tree_name);
466 for (i = 0; i < istate->cache_nr; i++) {
468 struct cache_entry *ce = istate->cache[i];
469 switch (ce_stage(ce)) {
470 case 0:
471 last_stage0 = ce;
472 /* fallthru */
473 default:
474 continue;
475 case 1:
476 /*
477 * If there is stage #0 entry for this, we do not
478 * need to show it. We use CE_UPDATE bit to mark
479 * such an entry.
480 */
481 if (last_stage0 &&
482 !strcmp(last_stage0->name, ce->name))
483 ce->ce_flags |= CE_UPDATE;
484 }
485 }
486}
487static const char * const ls_files_usage[] = {
489 N_("git ls-files [<options>] [<file>...]"),
490 NULL
491};
492static int option_parse_exclude(const struct option *opt,
494 const char *arg, int unset)
495{
496 struct string_list *exclude_list = opt->value;
497 exc_given = 1;
499 string_list_append(exclude_list, arg);
500 return 0;
502}
503static int option_parse_exclude_from(const struct option *opt,
505 const char *arg, int unset)
506{
507 struct dir_struct *dir = opt->value;
508 exc_given = 1;
510 add_excludes_from_file(dir, arg);
511 return 0;
513}
514static int option_parse_exclude_standard(const struct option *opt,
516 const char *arg, int unset)
517{
518 struct dir_struct *dir = opt->value;
519 exc_given = 1;
521 setup_standard_excludes(dir);
522 return 0;
524}
525int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
527{
528 int require_work_tree = 0, show_tag = 0, i;
529 const char *max_prefix;
530 struct dir_struct dir;
531 struct exclude_list *el;
532 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
533 struct option builtin_ls_files_options[] = {
534 /* Think twice before adding "--nul" synonym to this */
535 OPT_SET_INT('z', NULL, &line_terminator,
536 N_("paths are separated with NUL character"), '\0'),
537 OPT_BOOL('t', NULL, &show_tag,
538 N_("identify the file status with tags")),
539 OPT_BOOL('v', NULL, &show_valid_bit,
540 N_("use lowercase letters for 'assume unchanged' files")),
541 OPT_BOOL('c', "cached", &show_cached,
542 N_("show cached files in the output (default)")),
543 OPT_BOOL('d', "deleted", &show_deleted,
544 N_("show deleted files in the output")),
545 OPT_BOOL('m', "modified", &show_modified,
546 N_("show modified files in the output")),
547 OPT_BOOL('o', "others", &show_others,
548 N_("show other files in the output")),
549 OPT_BIT('i', "ignored", &dir.flags,
550 N_("show ignored files in the output"),
551 DIR_SHOW_IGNORED),
552 OPT_BOOL('s', "stage", &show_stage,
553 N_("show staged contents' object name in the output")),
554 OPT_BOOL('k', "killed", &show_killed,
555 N_("show files on the filesystem that need to be removed")),
556 OPT_BIT(0, "directory", &dir.flags,
557 N_("show 'other' directories' names only"),
558 DIR_SHOW_OTHER_DIRECTORIES),
559 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
560 OPT_NEGBIT(0, "empty-directory", &dir.flags,
561 N_("don't show empty directories"),
562 DIR_HIDE_EMPTY_DIRECTORIES),
563 OPT_BOOL('u', "unmerged", &show_unmerged,
564 N_("show unmerged files in the output")),
565 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
566 N_("show resolve-undo information")),
567 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
568 N_("skip files matching pattern"),
569 0, option_parse_exclude },
570 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
571 N_("exclude patterns are read from <file>"),
572 0, option_parse_exclude_from },
573 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
574 N_("read additional per-directory exclude patterns in <file>")),
575 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
576 N_("add the standard git exclusions"),
577 PARSE_OPT_NOARG, option_parse_exclude_standard },
578 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
579 N_("make the output relative to the project top directory"),
580 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
581 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
582 N_("recurse through submodules")),
583 OPT_BOOL(0, "error-unmatch", &error_unmatch,
584 N_("if any <file> is not in the index, treat this as an error")),
585 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
586 N_("pretend that paths removed since <tree-ish> are still present")),
587 OPT__ABBREV(&abbrev),
588 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
589 OPT_END()
590 };
591 if (argc == 2 && !strcmp(argv[1], "-h"))
593 usage_with_options(ls_files_usage, builtin_ls_files_options);
594 memset(&dir, 0, sizeof(dir));
596 prefix = cmd_prefix;
597 if (prefix)
598 prefix_len = strlen(prefix);
599 super_prefix = get_super_prefix();
600 git_config(git_default_config, NULL);
601 if (read_cache() < 0)
603 die("index file corrupt");
604 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
606 ls_files_usage, 0);
607 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
608 for (i = 0; i < exclude_list.nr; i++) {
609 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
610 }
611 if (show_tag || show_valid_bit) {
612 tag_cached = "H ";
613 tag_unmerged = "M ";
614 tag_removed = "R ";
615 tag_modified = "C ";
616 tag_other = "? ";
617 tag_killed = "K ";
618 tag_skip_worktree = "S ";
619 tag_resolve_undo = "U ";
620 }
621 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
622 require_work_tree = 1;
623 if (show_unmerged)
624 /*
625 * There's no point in showing unmerged unless
626 * you also show the stage information.
627 */
628 show_stage = 1;
629 if (dir.exclude_per_dir)
630 exc_given = 1;
631 if (require_work_tree && !is_inside_work_tree())
633 setup_work_tree();
634 if (recurse_submodules)
636 compile_submodule_options(argv, &dir, show_tag);
637 if (recurse_submodules &&
639 (show_stage || show_deleted || show_others || show_unmerged ||
640 show_killed || show_modified || show_resolve_undo || with_tree))
641 die("ls-files --recurse-submodules unsupported mode");
642 if (recurse_submodules && error_unmatch)
644 die("ls-files --recurse-submodules does not support "
645 "--error-unmatch");
646 parse_pathspec(&pathspec, 0,
648 PATHSPEC_PREFER_CWD,
649 prefix, argv);
650 /*
652 * Find common prefix for all pathspec's
653 * This is used as a performance optimization which unfortunately cannot
654 * be done when recursing into submodules
655 */
656 if (recurse_submodules)
657 max_prefix = NULL;
658 else
659 max_prefix = common_prefix(&pathspec);
660 max_prefix_len = get_common_prefix_len(max_prefix);
661 prune_cache(max_prefix, max_prefix_len);
663 /* Treat unmatching pathspec elements as errors */
665 if (pathspec.nr && error_unmatch)
666 ps_matched = xcalloc(pathspec.nr, 1);
667 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
669 die("ls-files --ignored needs some exclude pattern");
670 /* With no flags, we default to showing the cached files */
672 if (!(show_stage || show_deleted || show_others || show_unmerged ||
673 show_killed || show_modified || show_resolve_undo))
674 show_cached = 1;
675 if (with_tree) {
677 /*
678 * Basic sanity check; show-stages and show-unmerged
679 * would not make any sense with this option.
680 */
681 if (show_stage || show_unmerged)
682 die("ls-files --with-tree is incompatible with -s or -u");
683 overlay_tree_on_index(&the_index, with_tree, max_prefix);
684 }
685 show_files(&dir);
686 if (show_resolve_undo)
687 show_ru_info();
688 if (ps_matched) {
690 int bad;
691 bad = report_path_error(ps_matched, &pathspec, prefix);
692 if (bad)
693 fprintf(stderr, "Did you forget to 'git add'?\n");
694 return bad ? 1 : 0;
696 }
697 return 0;
699}