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