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"
18static int abbrev;
20static int show_deleted;
21static int show_cached;
22static int show_others;
23static int show_stage;
24static int show_unmerged;
25static int show_resolve_undo;
26static int show_modified;
27static int show_killed;
28static int show_valid_bit;
29static int line_terminator = '\n';
30static int debug_mode;
31static int show_eol;
32static int recurse_submodules;
33static const char *prefix;
35static const char *super_prefix;
36static int max_prefix_len;
37static int prefix_len;
38static struct pathspec pathspec;
39static int error_unmatch;
40static char *ps_matched;
41static const char *with_tree;
42static int exc_given;
43static int exclude_args;
44static const char *tag_cached = "";
46static const char *tag_unmerged = "";
47static const char *tag_removed = "";
48static const char *tag_other = "";
49static const char *tag_killed = "";
50static const char *tag_modified = "";
51static const char *tag_skip_worktree = "";
52static const char *tag_resolve_undo = "";
53static void write_eolinfo(const struct cache_entry *ce, const char *path)
55{
56 if (!show_eol)
57 return;
58 else {
59 struct stat st;
60 const char *i_txt = "";
61 const char *w_txt = "";
62 const char *a_txt = get_convert_attr_ascii(path);
63 if (ce && S_ISREG(ce->ce_mode))
64 i_txt = get_cached_convert_stats_ascii(ce->name);
65 if (!lstat(path, &st) && S_ISREG(st.st_mode))
66 w_txt = get_wt_convert_stats_ascii(path);
67 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
68 }
69}
70static void write_name(const char *name)
72{
73 /*
74 * Prepend the super_prefix to name to construct the full_name to be
75 * written.
76 */
77 struct strbuf full_name = STRBUF_INIT;
78 if (super_prefix) {
79 strbuf_addstr(&full_name, super_prefix);
80 strbuf_addstr(&full_name, name);
81 name = full_name.buf;
82 }
83 /*
85 * With "--full-name", prefix_len=0; this caller needs to pass
86 * an empty string in that case (a NULL is good for "").
87 */
88 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
89 stdout, line_terminator);
90 strbuf_release(&full_name);
92}
93static void show_dir_entry(const char *tag, struct dir_entry *ent)
95{
96 int len = max_prefix_len;
97 if (len >= ent->len)
99 die("git ls-files: internal error - directory entry not superset of prefix");
100 if (!dir_path_match(ent, &pathspec, len, ps_matched))
102 return;
103 fputs(tag, stdout);
105 write_eolinfo(NULL, ent->name);
106 write_name(ent->name);
107}
108static void show_other_files(struct dir_struct *dir)
110{
111 int i;
112 for (i = 0; i < dir->nr; i++) {
114 struct dir_entry *ent = dir->entries[i];
115 if (!cache_name_is_other(ent->name, ent->len))
116 continue;
117 show_dir_entry(tag_other, ent);
118 }
119}
120static void show_killed_files(struct dir_struct *dir)
122{
123 int i;
124 for (i = 0; i < dir->nr; i++) {
125 struct dir_entry *ent = dir->entries[i];
126 char *cp, *sp;
127 int pos, len, killed = 0;
128 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
130 sp = strchr(cp, '/');
131 if (!sp) {
132 /* If ent->name is prefix of an entry in the
133 * cache, it will be killed.
134 */
135 pos = cache_name_pos(ent->name, ent->len);
136 if (0 <= pos)
137 die("BUG: killed-file %.*s not found",
138 ent->len, ent->name);
139 pos = -pos - 1;
140 while (pos < active_nr &&
141 ce_stage(active_cache[pos]))
142 pos++; /* skip unmerged */
143 if (active_nr <= pos)
144 break;
145 /* pos points at a name immediately after
146 * ent->name in the cache. Does it expect
147 * ent->name to be a directory?
148 */
149 len = ce_namelen(active_cache[pos]);
150 if ((ent->len < len) &&
151 !strncmp(active_cache[pos]->name,
152 ent->name, ent->len) &&
153 active_cache[pos]->name[ent->len] == '/')
154 killed = 1;
155 break;
156 }
157 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
158 /* If any of the leading directories in
159 * ent->name is registered in the cache,
160 * ent->name will be killed.
161 */
162 killed = 1;
163 break;
164 }
165 }
166 if (killed)
167 show_dir_entry(tag_killed, dir->entries[i]);
168 }
169}
170/**
172 * Recursively call ls-files on a submodule
173 */
174static void show_gitlink(const struct cache_entry *ce)
175{
176 struct child_process cp = CHILD_PROCESS_INIT;
177 int status;
178 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
180 super_prefix ? super_prefix : "",
181 ce->name);
182 argv_array_push(&cp.args, "ls-files");
183 argv_array_push(&cp.args, "--recurse-submodules");
184 cp.git_cmd = 1;
186 cp.dir = ce->name;
187 status = run_command(&cp);
188 if (status)
189 exit(status);
190}
191static void show_ce_entry(const char *tag, const struct cache_entry *ce)
193{
194 struct strbuf name = STRBUF_INIT;
195 int len = max_prefix_len;
196 if (super_prefix)
197 strbuf_addstr(&name, super_prefix);
198 strbuf_addstr(&name, ce->name);
199 if (len >= ce_namelen(ce))
201 die("git ls-files: internal error - cache entry not superset of prefix");
202 if (recurse_submodules && S_ISGITLINK(ce->ce_mode)) {
204 show_gitlink(ce);
205 } else if (match_pathspec(&pathspec, name.buf, name.len,
206 len, ps_matched,
207 S_ISDIR(ce->ce_mode) ||
208 S_ISGITLINK(ce->ce_mode))) {
209 if (tag && *tag && show_valid_bit &&
210 (ce->ce_flags & CE_VALID)) {
211 static char alttag[4];
212 memcpy(alttag, tag, 3);
213 if (isalpha(tag[0]))
214 alttag[0] = tolower(tag[0]);
215 else if (tag[0] == '?')
216 alttag[0] = '!';
217 else {
218 alttag[0] = 'v';
219 alttag[1] = tag[0];
220 alttag[2] = ' ';
221 alttag[3] = 0;
222 }
223 tag = alttag;
224 }
225 if (!show_stage) {
227 fputs(tag, stdout);
228 } else {
229 printf("%s%06o %s %d\t",
230 tag,
231 ce->ce_mode,
232 find_unique_abbrev(ce->sha1,abbrev),
233 ce_stage(ce));
234 }
235 write_eolinfo(ce, ce->name);
236 write_name(ce->name);
237 if (debug_mode) {
238 const struct stat_data *sd = &ce->ce_stat_data;
239 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
241 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
242 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
243 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
244 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
245 }
246 }
247 strbuf_release(&name);
249}
250static void show_ru_info(void)
252{
253 struct string_list_item *item;
254 if (!the_index.resolve_undo)
256 return;
257 for_each_string_list_item(item, the_index.resolve_undo) {
259 const char *path = item->string;
260 struct resolve_undo_info *ui = item->util;
261 int i, len;
262 len = strlen(path);
264 if (len < max_prefix_len)
265 continue; /* outside of the prefix */
266 if (!match_pathspec(&pathspec, path, len,
267 max_prefix_len, ps_matched, 0))
268 continue; /* uninterested */
269 for (i = 0; i < 3; i++) {
270 if (!ui->mode[i])
271 continue;
272 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
273 find_unique_abbrev(ui->sha1[i], abbrev),
274 i + 1);
275 write_name(path);
276 }
277 }
278}
279static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
281{
282 int dtype = ce_to_dtype(ce);
283 return is_excluded(dir, ce->name, &dtype);
284}
285static void show_files(struct dir_struct *dir)
287{
288 int i;
289 /* For cached/deleted files we don't need to even do the readdir */
291 if (show_others || show_killed) {
292 if (!show_others)
293 dir->flags |= DIR_COLLECT_KILLED_ONLY;
294 fill_directory(dir, &pathspec);
295 if (show_others)
296 show_other_files(dir);
297 if (show_killed)
298 show_killed_files(dir);
299 }
300 if (show_cached || show_stage) {
301 for (i = 0; i < active_nr; i++) {
302 const struct cache_entry *ce = active_cache[i];
303 if ((dir->flags & DIR_SHOW_IGNORED) &&
304 !ce_excluded(dir, ce))
305 continue;
306 if (show_unmerged && !ce_stage(ce))
307 continue;
308 if (ce->ce_flags & CE_UPDATE)
309 continue;
310 show_ce_entry(ce_stage(ce) ? tag_unmerged :
311 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
312 }
313 }
314 if (show_deleted || show_modified) {
315 for (i = 0; i < active_nr; i++) {
316 const struct cache_entry *ce = active_cache[i];
317 struct stat st;
318 int err;
319 if ((dir->flags & DIR_SHOW_IGNORED) &&
320 !ce_excluded(dir, ce))
321 continue;
322 if (ce->ce_flags & CE_UPDATE)
323 continue;
324 if (ce_skip_worktree(ce))
325 continue;
326 err = lstat(ce->name, &st);
327 if (show_deleted && err)
328 show_ce_entry(tag_removed, ce);
329 if (show_modified && ce_modified(ce, &st, 0))
330 show_ce_entry(tag_modified, ce);
331 }
332 }
333}
334/*
336 * Prune the index to only contain stuff starting with "prefix"
337 */
338static void prune_cache(const char *prefix)
339{
340 int pos = cache_name_pos(prefix, max_prefix_len);
341 unsigned int first, last;
342 if (pos < 0)
344 pos = -pos-1;
345 memmove(active_cache, active_cache + pos,
346 (active_nr - pos) * sizeof(struct cache_entry *));
347 active_nr -= pos;
348 first = 0;
349 last = active_nr;
350 while (last > first) {
351 int next = (last + first) >> 1;
352 const struct cache_entry *ce = active_cache[next];
353 if (!strncmp(ce->name, prefix, max_prefix_len)) {
354 first = next+1;
355 continue;
356 }
357 last = next;
358 }
359 active_nr = last;
360}
361/*
363 * Read the tree specified with --with-tree option
364 * (typically, HEAD) into stage #1 and then
365 * squash them down to stage #0. This is used for
366 * --error-unmatch to list and check the path patterns
367 * that were given from the command line. We are not
368 * going to write this index out.
369 */
370void overlay_tree_on_cache(const char *tree_name, const char *prefix)
371{
372 struct tree *tree;
373 unsigned char sha1[20];
374 struct pathspec pathspec;
375 struct cache_entry *last_stage0 = NULL;
376 int i;
377 if (get_sha1(tree_name, sha1))
379 die("tree-ish %s not found.", tree_name);
380 tree = parse_tree_indirect(sha1);
381 if (!tree)
382 die("bad tree-ish %s", tree_name);
383 /* Hoist the unmerged entries up to stage #3 to make room */
385 for (i = 0; i < active_nr; i++) {
386 struct cache_entry *ce = active_cache[i];
387 if (!ce_stage(ce))
388 continue;
389 ce->ce_flags |= CE_STAGEMASK;
390 }
391 if (prefix) {
393 static const char *(matchbuf[1]);
394 matchbuf[0] = NULL;
395 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
396 PATHSPEC_PREFER_CWD, prefix, matchbuf);
397 } else
398 memset(&pathspec, 0, sizeof(pathspec));
399 if (read_tree(tree, 1, &pathspec))
400 die("unable to read tree entries %s", tree_name);
401 for (i = 0; i < active_nr; i++) {
403 struct cache_entry *ce = active_cache[i];
404 switch (ce_stage(ce)) {
405 case 0:
406 last_stage0 = ce;
407 /* fallthru */
408 default:
409 continue;
410 case 1:
411 /*
412 * If there is stage #0 entry for this, we do not
413 * need to show it. We use CE_UPDATE bit to mark
414 * such an entry.
415 */
416 if (last_stage0 &&
417 !strcmp(last_stage0->name, ce->name))
418 ce->ce_flags |= CE_UPDATE;
419 }
420 }
421}
422static const char * const ls_files_usage[] = {
424 N_("git ls-files [<options>] [<file>...]"),
425 NULL
426};
427static int option_parse_exclude(const struct option *opt,
429 const char *arg, int unset)
430{
431 struct string_list *exclude_list = opt->value;
432 exc_given = 1;
434 string_list_append(exclude_list, arg);
435 return 0;
437}
438static int option_parse_exclude_from(const struct option *opt,
440 const char *arg, int unset)
441{
442 struct dir_struct *dir = opt->value;
443 exc_given = 1;
445 add_excludes_from_file(dir, arg);
446 return 0;
448}
449static int option_parse_exclude_standard(const struct option *opt,
451 const char *arg, int unset)
452{
453 struct dir_struct *dir = opt->value;
454 exc_given = 1;
456 setup_standard_excludes(dir);
457 return 0;
459}
460int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
462{
463 int require_work_tree = 0, show_tag = 0, i;
464 const char *max_prefix;
465 struct dir_struct dir;
466 struct exclude_list *el;
467 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
468 struct option builtin_ls_files_options[] = {
469 /* Think twice before adding "--nul" synonym to this */
470 OPT_SET_INT('z', NULL, &line_terminator,
471 N_("paths are separated with NUL character"), '\0'),
472 OPT_BOOL('t', NULL, &show_tag,
473 N_("identify the file status with tags")),
474 OPT_BOOL('v', NULL, &show_valid_bit,
475 N_("use lowercase letters for 'assume unchanged' files")),
476 OPT_BOOL('c', "cached", &show_cached,
477 N_("show cached files in the output (default)")),
478 OPT_BOOL('d', "deleted", &show_deleted,
479 N_("show deleted files in the output")),
480 OPT_BOOL('m', "modified", &show_modified,
481 N_("show modified files in the output")),
482 OPT_BOOL('o', "others", &show_others,
483 N_("show other files in the output")),
484 OPT_BIT('i', "ignored", &dir.flags,
485 N_("show ignored files in the output"),
486 DIR_SHOW_IGNORED),
487 OPT_BOOL('s', "stage", &show_stage,
488 N_("show staged contents' object name in the output")),
489 OPT_BOOL('k', "killed", &show_killed,
490 N_("show files on the filesystem that need to be removed")),
491 OPT_BIT(0, "directory", &dir.flags,
492 N_("show 'other' directories' names only"),
493 DIR_SHOW_OTHER_DIRECTORIES),
494 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
495 OPT_NEGBIT(0, "empty-directory", &dir.flags,
496 N_("don't show empty directories"),
497 DIR_HIDE_EMPTY_DIRECTORIES),
498 OPT_BOOL('u', "unmerged", &show_unmerged,
499 N_("show unmerged files in the output")),
500 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
501 N_("show resolve-undo information")),
502 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
503 N_("skip files matching pattern"),
504 0, option_parse_exclude },
505 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
506 N_("exclude patterns are read from <file>"),
507 0, option_parse_exclude_from },
508 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
509 N_("read additional per-directory exclude patterns in <file>")),
510 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
511 N_("add the standard git exclusions"),
512 PARSE_OPT_NOARG, option_parse_exclude_standard },
513 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
514 N_("make the output relative to the project top directory"),
515 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
516 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
517 N_("recurse through submodules")),
518 OPT_BOOL(0, "error-unmatch", &error_unmatch,
519 N_("if any <file> is not in the index, treat this as an error")),
520 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
521 N_("pretend that paths removed since <tree-ish> are still present")),
522 OPT__ABBREV(&abbrev),
523 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
524 OPT_END()
525 };
526 if (argc == 2 && !strcmp(argv[1], "-h"))
528 usage_with_options(ls_files_usage, builtin_ls_files_options);
529 memset(&dir, 0, sizeof(dir));
531 prefix = cmd_prefix;
532 if (prefix)
533 prefix_len = strlen(prefix);
534 super_prefix = get_super_prefix();
535 git_config(git_default_config, NULL);
536 if (read_cache() < 0)
538 die("index file corrupt");
539 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
541 ls_files_usage, 0);
542 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
543 for (i = 0; i < exclude_list.nr; i++) {
544 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
545 }
546 if (show_tag || show_valid_bit) {
547 tag_cached = "H ";
548 tag_unmerged = "M ";
549 tag_removed = "R ";
550 tag_modified = "C ";
551 tag_other = "? ";
552 tag_killed = "K ";
553 tag_skip_worktree = "S ";
554 tag_resolve_undo = "U ";
555 }
556 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
557 require_work_tree = 1;
558 if (show_unmerged)
559 /*
560 * There's no point in showing unmerged unless
561 * you also show the stage information.
562 */
563 show_stage = 1;
564 if (dir.exclude_per_dir)
565 exc_given = 1;
566 if (require_work_tree && !is_inside_work_tree())
568 setup_work_tree();
569 if (recurse_submodules &&
571 (show_stage || show_deleted || show_others || show_unmerged ||
572 show_killed || show_modified || show_resolve_undo ||
573 show_valid_bit || show_tag || show_eol || with_tree ||
574 (line_terminator == '\0')))
575 die("ls-files --recurse-submodules unsupported mode");
576 if (recurse_submodules && error_unmatch)
578 die("ls-files --recurse-submodules does not support "
579 "--error-unmatch");
580 if (recurse_submodules && argc)
582 die("ls-files --recurse-submodules does not support pathspec");
583 parse_pathspec(&pathspec, 0,
585 PATHSPEC_PREFER_CWD |
586 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
587 prefix, argv);
588 /* Find common prefix for all pathspec's */
590 max_prefix = common_prefix(&pathspec);
591 max_prefix_len = max_prefix ? strlen(max_prefix) : 0;
592 /* Treat unmatching pathspec elements as errors */
594 if (pathspec.nr && error_unmatch)
595 ps_matched = xcalloc(pathspec.nr, 1);
596 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
598 die("ls-files --ignored needs some exclude pattern");
599 /* With no flags, we default to showing the cached files */
601 if (!(show_stage || show_deleted || show_others || show_unmerged ||
602 show_killed || show_modified || show_resolve_undo))
603 show_cached = 1;
604 if (max_prefix)
606 prune_cache(max_prefix);
607 if (with_tree) {
608 /*
609 * Basic sanity check; show-stages and show-unmerged
610 * would not make any sense with this option.
611 */
612 if (show_stage || show_unmerged)
613 die("ls-files --with-tree is incompatible with -s or -u");
614 overlay_tree_on_cache(with_tree, max_prefix);
615 }
616 show_files(&dir);
617 if (show_resolve_undo)
618 show_ru_info();
619 if (ps_matched) {
621 int bad;
622 bad = report_path_error(ps_matched, &pathspec, prefix);
623 if (bad)
624 fprintf(stderr, "Did you forget to 'git add'?\n");
625 return bad ? 1 : 0;
627 }
628 return 0;
630}