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"
16static int abbrev;
18static int show_deleted;
19static int show_cached;
20static int show_others;
21static int show_stage;
22static int show_unmerged;
23static int show_resolve_undo;
24static int show_modified;
25static int show_killed;
26static int show_valid_bit;
27static int line_terminator = '\n';
28static int debug_mode;
29static const char *prefix;
31static int max_prefix_len;
32static int prefix_len;
33static const char **pathspec;
34static int error_unmatch;
35static char *ps_matched;
36static const char *with_tree;
37static int exc_given;
38static const char *tag_cached = "";
40static const char *tag_unmerged = "";
41static const char *tag_removed = "";
42static const char *tag_other = "";
43static const char *tag_killed = "";
44static const char *tag_modified = "";
45static const char *tag_skip_worktree = "";
46static const char *tag_resolve_undo = "";
47static void write_name(const char* name, size_t len)
49{
50 write_name_quoted_relative(name, len, prefix, prefix_len, stdout,
51 line_terminator);
52}
53static void show_dir_entry(const char *tag, struct dir_entry *ent)
55{
56 int len = max_prefix_len;
57 if (len >= ent->len)
59 die("git ls-files: internal error - directory entry not superset of prefix");
60 if (!match_pathspec(pathspec, ent->name, ent->len, len, ps_matched))
62 return;
63 fputs(tag, stdout);
65 write_name(ent->name, ent->len);
66}
67static void show_other_files(struct dir_struct *dir)
69{
70 int i;
71 for (i = 0; i < dir->nr; i++) {
73 struct dir_entry *ent = dir->entries[i];
74 if (!cache_name_is_other(ent->name, ent->len))
75 continue;
76 show_dir_entry(tag_other, ent);
77 }
78}
79static void show_killed_files(struct dir_struct *dir)
81{
82 int i;
83 for (i = 0; i < dir->nr; i++) {
84 struct dir_entry *ent = dir->entries[i];
85 char *cp, *sp;
86 int pos, len, killed = 0;
87 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
89 sp = strchr(cp, '/');
90 if (!sp) {
91 /* If ent->name is prefix of an entry in the
92 * cache, it will be killed.
93 */
94 pos = cache_name_pos(ent->name, ent->len);
95 if (0 <= pos)
96 die("bug in show-killed-files");
97 pos = -pos - 1;
98 while (pos < active_nr &&
99 ce_stage(active_cache[pos]))
100 pos++; /* skip unmerged */
101 if (active_nr <= pos)
102 break;
103 /* pos points at a name immediately after
104 * ent->name in the cache. Does it expect
105 * ent->name to be a directory?
106 */
107 len = ce_namelen(active_cache[pos]);
108 if ((ent->len < len) &&
109 !strncmp(active_cache[pos]->name,
110 ent->name, ent->len) &&
111 active_cache[pos]->name[ent->len] == '/')
112 killed = 1;
113 break;
114 }
115 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
116 /* If any of the leading directories in
117 * ent->name is registered in the cache,
118 * ent->name will be killed.
119 */
120 killed = 1;
121 break;
122 }
123 }
124 if (killed)
125 show_dir_entry(tag_killed, dir->entries[i]);
126 }
127}
128static void show_ce_entry(const char *tag, struct cache_entry *ce)
130{
131 int len = max_prefix_len;
132 if (len >= ce_namelen(ce))
134 die("git ls-files: internal error - cache entry not superset of prefix");
135 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce), len, ps_matched))
137 return;
138 if (tag && *tag && show_valid_bit &&
140 (ce->ce_flags & CE_VALID)) {
141 static char alttag[4];
142 memcpy(alttag, tag, 3);
143 if (isalpha(tag[0]))
144 alttag[0] = tolower(tag[0]);
145 else if (tag[0] == '?')
146 alttag[0] = '!';
147 else {
148 alttag[0] = 'v';
149 alttag[1] = tag[0];
150 alttag[2] = ' ';
151 alttag[3] = 0;
152 }
153 tag = alttag;
154 }
155 if (!show_stage) {
157 fputs(tag, stdout);
158 } else {
159 printf("%s%06o %s %d\t",
160 tag,
161 ce->ce_mode,
162 find_unique_abbrev(ce->sha1,abbrev),
163 ce_stage(ce));
164 }
165 write_name(ce->name, ce_namelen(ce));
166 if (debug_mode) {
167 printf(" ctime: %d:%d\n", ce->ce_ctime.sec, ce->ce_ctime.nsec);
168 printf(" mtime: %d:%d\n", ce->ce_mtime.sec, ce->ce_mtime.nsec);
169 printf(" dev: %d\tino: %d\n", ce->ce_dev, ce->ce_ino);
170 printf(" uid: %d\tgid: %d\n", ce->ce_uid, ce->ce_gid);
171 printf(" size: %d\tflags: %x\n", ce->ce_size, ce->ce_flags);
172 }
173}
174static void show_ru_info(void)
176{
177 struct string_list_item *item;
178 if (!the_index.resolve_undo)
180 return;
181 for_each_string_list_item(item, the_index.resolve_undo) {
183 const char *path = item->string;
184 struct resolve_undo_info *ui = item->util;
185 int i, len;
186 len = strlen(path);
188 if (len < max_prefix_len)
189 continue; /* outside of the prefix */
190 if (!match_pathspec(pathspec, path, len, max_prefix_len, ps_matched))
191 continue; /* uninterested */
192 for (i = 0; i < 3; i++) {
193 if (!ui->mode[i])
194 continue;
195 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
196 find_unique_abbrev(ui->sha1[i], abbrev),
197 i + 1);
198 write_name(path, len);
199 }
200 }
201}
202static int ce_excluded(struct path_exclude_check *check, struct cache_entry *ce)
204{
205 int dtype = ce_to_dtype(ce);
206 return is_path_excluded(check, ce->name, ce_namelen(ce), &dtype);
207}
208static void show_files(struct dir_struct *dir)
210{
211 int i;
212 struct path_exclude_check check;
213 if ((dir->flags & DIR_SHOW_IGNORED))
215 path_exclude_check_init(&check, dir);
216 /* For cached/deleted files we don't need to even do the readdir */
218 if (show_others || show_killed) {
219 fill_directory(dir, pathspec);
220 if (show_others)
221 show_other_files(dir);
222 if (show_killed)
223 show_killed_files(dir);
224 }
225 if (show_cached | show_stage) {
226 for (i = 0; i < active_nr; i++) {
227 struct cache_entry *ce = active_cache[i];
228 if ((dir->flags & DIR_SHOW_IGNORED) &&
229 !ce_excluded(&check, ce))
230 continue;
231 if (show_unmerged && !ce_stage(ce))
232 continue;
233 if (ce->ce_flags & CE_UPDATE)
234 continue;
235 show_ce_entry(ce_stage(ce) ? tag_unmerged :
236 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
237 }
238 }
239 if (show_deleted | show_modified) {
240 for (i = 0; i < active_nr; i++) {
241 struct cache_entry *ce = active_cache[i];
242 struct stat st;
243 int err;
244 if ((dir->flags & DIR_SHOW_IGNORED) &&
245 !ce_excluded(&check, ce))
246 continue;
247 if (ce->ce_flags & CE_UPDATE)
248 continue;
249 if (ce_skip_worktree(ce))
250 continue;
251 err = lstat(ce->name, &st);
252 if (show_deleted && err)
253 show_ce_entry(tag_removed, ce);
254 if (show_modified && ce_modified(ce, &st, 0))
255 show_ce_entry(tag_modified, ce);
256 }
257 }
258 if ((dir->flags & DIR_SHOW_IGNORED))
260 path_exclude_check_clear(&check);
261}
262/*
264 * Prune the index to only contain stuff starting with "prefix"
265 */
266static void prune_cache(const char *prefix)
267{
268 int pos = cache_name_pos(prefix, max_prefix_len);
269 unsigned int first, last;
270 if (pos < 0)
272 pos = -pos-1;
273 memmove(active_cache, active_cache + pos,
274 (active_nr - pos) * sizeof(struct cache_entry *));
275 active_nr -= pos;
276 first = 0;
277 last = active_nr;
278 while (last > first) {
279 int next = (last + first) >> 1;
280 struct cache_entry *ce = active_cache[next];
281 if (!strncmp(ce->name, prefix, max_prefix_len)) {
282 first = next+1;
283 continue;
284 }
285 last = next;
286 }
287 active_nr = last;
288}
289static void strip_trailing_slash_from_submodules(void)
291{
292 const char **p;
293 for (p = pathspec; *p != NULL; p++) {
295 int len = strlen(*p), pos;
296 if (len < 1 || (*p)[len - 1] != '/')
298 continue;
299 pos = cache_name_pos(*p, len - 1);
300 if (pos >= 0 && S_ISGITLINK(active_cache[pos]->ce_mode))
301 *p = xstrndup(*p, len - 1);
302 }
303}
304/*
306 * Read the tree specified with --with-tree option
307 * (typically, HEAD) into stage #1 and then
308 * squash them down to stage #0. This is used for
309 * --error-unmatch to list and check the path patterns
310 * that were given from the command line. We are not
311 * going to write this index out.
312 */
313void overlay_tree_on_cache(const char *tree_name, const char *prefix)
314{
315 struct tree *tree;
316 unsigned char sha1[20];
317 struct pathspec pathspec;
318 struct cache_entry *last_stage0 = NULL;
319 int i;
320 if (get_sha1(tree_name, sha1))
322 die("tree-ish %s not found.", tree_name);
323 tree = parse_tree_indirect(sha1);
324 if (!tree)
325 die("bad tree-ish %s", tree_name);
326 /* Hoist the unmerged entries up to stage #3 to make room */
328 for (i = 0; i < active_nr; i++) {
329 struct cache_entry *ce = active_cache[i];
330 if (!ce_stage(ce))
331 continue;
332 ce->ce_flags |= CE_STAGEMASK;
333 }
334 if (prefix) {
336 static const char *(matchbuf[2]);
337 matchbuf[0] = prefix;
338 matchbuf[1] = NULL;
339 init_pathspec(&pathspec, matchbuf);
340 pathspec.items[0].use_wildcard = 0;
341 } else
342 init_pathspec(&pathspec, NULL);
343 if (read_tree(tree, 1, &pathspec))
344 die("unable to read tree entries %s", tree_name);
345 for (i = 0; i < active_nr; i++) {
347 struct cache_entry *ce = active_cache[i];
348 switch (ce_stage(ce)) {
349 case 0:
350 last_stage0 = ce;
351 /* fallthru */
352 default:
353 continue;
354 case 1:
355 /*
356 * If there is stage #0 entry for this, we do not
357 * need to show it. We use CE_UPDATE bit to mark
358 * such an entry.
359 */
360 if (last_stage0 &&
361 !strcmp(last_stage0->name, ce->name))
362 ce->ce_flags |= CE_UPDATE;
363 }
364 }
365}
366int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix)
368{
369 /*
370 * Make sure all pathspec matched; otherwise it is an error.
371 */
372 struct strbuf sb = STRBUF_INIT;
373 const char *name;
374 int num, errors = 0;
375 for (num = 0; pathspec[num]; num++) {
376 int other, found_dup;
377 if (ps_matched[num])
379 continue;
380 /*
381 * The caller might have fed identical pathspec
382 * twice. Do not barf on such a mistake.
383 */
384 for (found_dup = other = 0;
385 !found_dup && pathspec[other];
386 other++) {
387 if (other == num || !ps_matched[other])
388 continue;
389 if (!strcmp(pathspec[other], pathspec[num]))
390 /*
391 * Ok, we have a match already.
392 */
393 found_dup = 1;
394 }
395 if (found_dup)
396 continue;
397 name = quote_path_relative(pathspec[num], -1, &sb, prefix);
399 error("pathspec '%s' did not match any file(s) known to git.",
400 name);
401 errors++;
402 }
403 strbuf_release(&sb);
404 return errors;
405}
406static const char * const ls_files_usage[] = {
408 "git ls-files [options] [<file>...]",
409 NULL
410};
411static int option_parse_z(const struct option *opt,
413 const char *arg, int unset)
414{
415 line_terminator = unset ? '\n' : '\0';
416 return 0;
418}
419static int option_parse_exclude(const struct option *opt,
421 const char *arg, int unset)
422{
423 struct exclude_list *list = opt->value;
424 exc_given = 1;
426 add_exclude(arg, "", 0, list);
427 return 0;
429}
430static int option_parse_exclude_from(const struct option *opt,
432 const char *arg, int unset)
433{
434 struct dir_struct *dir = opt->value;
435 exc_given = 1;
437 add_excludes_from_file(dir, arg);
438 return 0;
440}
441static int option_parse_exclude_standard(const struct option *opt,
443 const char *arg, int unset)
444{
445 struct dir_struct *dir = opt->value;
446 exc_given = 1;
448 setup_standard_excludes(dir);
449 return 0;
451}
452int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
454{
455 int require_work_tree = 0, show_tag = 0;
456 const char *max_prefix;
457 struct dir_struct dir;
458 struct option builtin_ls_files_options[] = {
459 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
460 "paths are separated with NUL character",
461 PARSE_OPT_NOARG, option_parse_z },
462 OPT_BOOLEAN('t', NULL, &show_tag,
463 "identify the file status with tags"),
464 OPT_BOOLEAN('v', NULL, &show_valid_bit,
465 "use lowercase letters for 'assume unchanged' files"),
466 OPT_BOOLEAN('c', "cached", &show_cached,
467 "show cached files in the output (default)"),
468 OPT_BOOLEAN('d', "deleted", &show_deleted,
469 "show deleted files in the output"),
470 OPT_BOOLEAN('m', "modified", &show_modified,
471 "show modified files in the output"),
472 OPT_BOOLEAN('o', "others", &show_others,
473 "show other files in the output"),
474 OPT_BIT('i', "ignored", &dir.flags,
475 "show ignored files in the output",
476 DIR_SHOW_IGNORED),
477 OPT_BOOLEAN('s', "stage", &show_stage,
478 "show staged contents' object name in the output"),
479 OPT_BOOLEAN('k', "killed", &show_killed,
480 "show files on the filesystem that need to be removed"),
481 OPT_BIT(0, "directory", &dir.flags,
482 "show 'other' directories' name only",
483 DIR_SHOW_OTHER_DIRECTORIES),
484 OPT_NEGBIT(0, "empty-directory", &dir.flags,
485 "don't show empty directories",
486 DIR_HIDE_EMPTY_DIRECTORIES),
487 OPT_BOOLEAN('u', "unmerged", &show_unmerged,
488 "show unmerged files in the output"),
489 OPT_BOOLEAN(0, "resolve-undo", &show_resolve_undo,
490 "show resolve-undo information"),
491 { OPTION_CALLBACK, 'x', "exclude", &dir.exclude_list[EXC_CMDL], "pattern",
492 "skip files matching pattern",
493 0, option_parse_exclude },
494 { OPTION_CALLBACK, 'X', "exclude-from", &dir, "file",
495 "exclude patterns are read from <file>",
496 0, option_parse_exclude_from },
497 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, "file",
498 "read additional per-directory exclude patterns in <file>"),
499 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
500 "add the standard git exclusions",
501 PARSE_OPT_NOARG, option_parse_exclude_standard },
502 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
503 "make the output relative to the project top directory",
504 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
505 OPT_BOOLEAN(0, "error-unmatch", &error_unmatch,
506 "if any <file> is not in the index, treat this as an error"),
507 OPT_STRING(0, "with-tree", &with_tree, "tree-ish",
508 "pretend that paths removed since <tree-ish> are still present"),
509 OPT__ABBREV(&abbrev),
510 OPT_BOOLEAN(0, "debug", &debug_mode, "show debugging data"),
511 OPT_END()
512 };
513 if (argc == 2 && !strcmp(argv[1], "-h"))
515 usage_with_options(ls_files_usage, builtin_ls_files_options);
516 memset(&dir, 0, sizeof(dir));
518 prefix = cmd_prefix;
519 if (prefix)
520 prefix_len = strlen(prefix);
521 git_config(git_default_config, NULL);
522 if (read_cache() < 0)
524 die("index file corrupt");
525 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
527 ls_files_usage, 0);
528 if (show_tag || show_valid_bit) {
529 tag_cached = "H ";
530 tag_unmerged = "M ";
531 tag_removed = "R ";
532 tag_modified = "C ";
533 tag_other = "? ";
534 tag_killed = "K ";
535 tag_skip_worktree = "S ";
536 tag_resolve_undo = "U ";
537 }
538 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
539 require_work_tree = 1;
540 if (show_unmerged)
541 /*
542 * There's no point in showing unmerged unless
543 * you also show the stage information.
544 */
545 show_stage = 1;
546 if (dir.exclude_per_dir)
547 exc_given = 1;
548 if (require_work_tree && !is_inside_work_tree())
550 setup_work_tree();
551 pathspec = get_pathspec(prefix, argv);
553 /* be nice with submodule paths ending in a slash */
555 if (pathspec)
556 strip_trailing_slash_from_submodules();
557 /* Find common prefix for all pathspec's */
559 max_prefix = common_prefix(pathspec);
560 max_prefix_len = max_prefix ? strlen(max_prefix) : 0;
561 /* Treat unmatching pathspec elements as errors */
563 if (pathspec && error_unmatch) {
564 int num;
565 for (num = 0; pathspec[num]; num++)
566 ;
567 ps_matched = xcalloc(1, num);
568 }
569 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
571 die("ls-files --ignored needs some exclude pattern");
572 /* With no flags, we default to showing the cached files */
574 if (!(show_stage | show_deleted | show_others | show_unmerged |
575 show_killed | show_modified | show_resolve_undo))
576 show_cached = 1;
577 if (max_prefix)
579 prune_cache(max_prefix);
580 if (with_tree) {
581 /*
582 * Basic sanity check; show-stages and show-unmerged
583 * would not make any sense with this option.
584 */
585 if (show_stage || show_unmerged)
586 die("ls-files --with-tree is incompatible with -s or -u");
587 overlay_tree_on_cache(with_tree, max_prefix);
588 }
589 show_files(&dir);
590 if (show_resolve_undo)
591 show_ru_info();
592 if (ps_matched) {
594 int bad;
595 bad = report_path_error(ps_matched, pathspec, prefix);
596 if (bad)
597 fprintf(stderr, "Did you forget to 'git add'?\n");
598 return bad ? 1 : 0;
600 }
601 return 0;
603}