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 int show_one_ru(struct string_list_item *item, void *cbdata)
176{
177 const char *path = item->string;
178 struct resolve_undo_info *ui = item->util;
179 int i, len;
180 len = strlen(path);
182 if (len < max_prefix_len)
183 return 0; /* outside of the prefix */
184 if (!match_pathspec(pathspec, path, len, max_prefix_len, ps_matched))
185 return 0; /* uninterested */
186 for (i = 0; i < 3; i++) {
187 if (!ui->mode[i])
188 continue;
189 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
190 find_unique_abbrev(ui->sha1[i], abbrev),
191 i + 1);
192 write_name(path, len);
193 }
194 return 0;
195}
196static void show_ru_info(void)
198{
199 if (!the_index.resolve_undo)
200 return;
201 for_each_string_list(the_index.resolve_undo, show_one_ru, NULL);
202}
203static void show_files(struct dir_struct *dir)
205{
206 int i;
207 /* For cached/deleted files we don't need to even do the readdir */
209 if (show_others || show_killed) {
210 fill_directory(dir, pathspec);
211 if (show_others)
212 show_other_files(dir);
213 if (show_killed)
214 show_killed_files(dir);
215 }
216 if (show_cached | show_stage) {
217 for (i = 0; i < active_nr; i++) {
218 struct cache_entry *ce = active_cache[i];
219 int dtype = ce_to_dtype(ce);
220 if (dir->flags & DIR_SHOW_IGNORED &&
221 !excluded(dir, ce->name, &dtype))
222 continue;
223 if (show_unmerged && !ce_stage(ce))
224 continue;
225 if (ce->ce_flags & CE_UPDATE)
226 continue;
227 show_ce_entry(ce_stage(ce) ? tag_unmerged :
228 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
229 }
230 }
231 if (show_deleted | show_modified) {
232 for (i = 0; i < active_nr; i++) {
233 struct cache_entry *ce = active_cache[i];
234 struct stat st;
235 int err;
236 int dtype = ce_to_dtype(ce);
237 if (dir->flags & DIR_SHOW_IGNORED &&
238 !excluded(dir, ce->name, &dtype))
239 continue;
240 if (ce->ce_flags & CE_UPDATE)
241 continue;
242 if (ce_skip_worktree(ce))
243 continue;
244 err = lstat(ce->name, &st);
245 if (show_deleted && err)
246 show_ce_entry(tag_removed, ce);
247 if (show_modified && ce_modified(ce, &st, 0))
248 show_ce_entry(tag_modified, ce);
249 }
250 }
251}
252/*
254 * Prune the index to only contain stuff starting with "prefix"
255 */
256static void prune_cache(const char *prefix)
257{
258 int pos = cache_name_pos(prefix, max_prefix_len);
259 unsigned int first, last;
260 if (pos < 0)
262 pos = -pos-1;
263 memmove(active_cache, active_cache + pos,
264 (active_nr - pos) * sizeof(struct cache_entry *));
265 active_nr -= pos;
266 first = 0;
267 last = active_nr;
268 while (last > first) {
269 int next = (last + first) >> 1;
270 struct cache_entry *ce = active_cache[next];
271 if (!strncmp(ce->name, prefix, max_prefix_len)) {
272 first = next+1;
273 continue;
274 }
275 last = next;
276 }
277 active_nr = last;
278}
279static const char *pathspec_prefix(const char *prefix)
281{
282 const char **p, *n, *prev;
283 unsigned long max;
284 if (!pathspec) {
286 max_prefix_len = prefix ? strlen(prefix) : 0;
287 return prefix;
288 }
289 prev = NULL;
291 max = PATH_MAX;
292 for (p = pathspec; (n = *p) != NULL; p++) {
293 int i, len = 0;
294 for (i = 0; i < max; i++) {
295 char c = n[i];
296 if (prev && prev[i] != c)
297 break;
298 if (!c || c == '*' || c == '?')
299 break;
300 if (c == '/')
301 len = i+1;
302 }
303 prev = n;
304 if (len < max) {
305 max = len;
306 if (!max)
307 break;
308 }
309 }
310 max_prefix_len = max;
312 return max ? xmemdupz(prev, max) : NULL;
313}
314static void strip_trailing_slash_from_submodules(void)
316{
317 const char **p;
318 for (p = pathspec; *p != NULL; p++) {
320 int len = strlen(*p), pos;
321 if (len < 1 || (*p)[len - 1] != '/')
323 continue;
324 pos = cache_name_pos(*p, len - 1);
325 if (pos >= 0 && S_ISGITLINK(active_cache[pos]->ce_mode))
326 *p = xstrndup(*p, len - 1);
327 }
328}
329/*
331 * Read the tree specified with --with-tree option
332 * (typically, HEAD) into stage #1 and then
333 * squash them down to stage #0. This is used for
334 * --error-unmatch to list and check the path patterns
335 * that were given from the command line. We are not
336 * going to write this index out.
337 */
338void overlay_tree_on_cache(const char *tree_name, const char *prefix)
339{
340 struct tree *tree;
341 unsigned char sha1[20];
342 const char **match;
343 struct cache_entry *last_stage0 = NULL;
344 int i;
345 if (get_sha1(tree_name, sha1))
347 die("tree-ish %s not found.", tree_name);
348 tree = parse_tree_indirect(sha1);
349 if (!tree)
350 die("bad tree-ish %s", tree_name);
351 /* Hoist the unmerged entries up to stage #3 to make room */
353 for (i = 0; i < active_nr; i++) {
354 struct cache_entry *ce = active_cache[i];
355 if (!ce_stage(ce))
356 continue;
357 ce->ce_flags |= CE_STAGEMASK;
358 }
359 if (prefix) {
361 static const char *(matchbuf[2]);
362 matchbuf[0] = prefix;
363 matchbuf[1] = NULL;
364 match = matchbuf;
365 } else
366 match = NULL;
367 if (read_tree(tree, 1, match))
368 die("unable to read tree entries %s", tree_name);
369 for (i = 0; i < active_nr; i++) {
371 struct cache_entry *ce = active_cache[i];
372 switch (ce_stage(ce)) {
373 case 0:
374 last_stage0 = ce;
375 /* fallthru */
376 default:
377 continue;
378 case 1:
379 /*
380 * If there is stage #0 entry for this, we do not
381 * need to show it. We use CE_UPDATE bit to mark
382 * such an entry.
383 */
384 if (last_stage0 &&
385 !strcmp(last_stage0->name, ce->name))
386 ce->ce_flags |= CE_UPDATE;
387 }
388 }
389}
390int report_path_error(const char *ps_matched, const char **pathspec, int prefix_len)
392{
393 /*
394 * Make sure all pathspec matched; otherwise it is an error.
395 */
396 int num, errors = 0;
397 for (num = 0; pathspec[num]; num++) {
398 int other, found_dup;
399 if (ps_matched[num])
401 continue;
402 /*
403 * The caller might have fed identical pathspec
404 * twice. Do not barf on such a mistake.
405 */
406 for (found_dup = other = 0;
407 !found_dup && pathspec[other];
408 other++) {
409 if (other == num || !ps_matched[other])
410 continue;
411 if (!strcmp(pathspec[other], pathspec[num]))
412 /*
413 * Ok, we have a match already.
414 */
415 found_dup = 1;
416 }
417 if (found_dup)
418 continue;
419 error("pathspec '%s' did not match any file(s) known to git.",
421 pathspec[num] + prefix_len);
422 errors++;
423 }
424 return errors;
425}
426static const char * const ls_files_usage[] = {
428 "git ls-files [options] [<file>]*",
429 NULL
430};
431static int option_parse_z(const struct option *opt,
433 const char *arg, int unset)
434{
435 line_terminator = unset ? '\n' : '\0';
436 return 0;
438}
439static int option_parse_exclude(const struct option *opt,
441 const char *arg, int unset)
442{
443 struct exclude_list *list = opt->value;
444 exc_given = 1;
446 add_exclude(arg, "", 0, list);
447 return 0;
449}
450static int option_parse_exclude_from(const struct option *opt,
452 const char *arg, int unset)
453{
454 struct dir_struct *dir = opt->value;
455 exc_given = 1;
457 add_excludes_from_file(dir, arg);
458 return 0;
460}
461static int option_parse_exclude_standard(const struct option *opt,
463 const char *arg, int unset)
464{
465 struct dir_struct *dir = opt->value;
466 exc_given = 1;
468 setup_standard_excludes(dir);
469 return 0;
471}
472int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
474{
475 int require_work_tree = 0, show_tag = 0;
476 const char *max_prefix;
477 struct dir_struct dir;
478 struct option builtin_ls_files_options[] = {
479 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
480 "paths are separated with NUL character",
481 PARSE_OPT_NOARG, option_parse_z },
482 OPT_BOOLEAN('t', NULL, &show_tag,
483 "identify the file status with tags"),
484 OPT_BOOLEAN('v', NULL, &show_valid_bit,
485 "use lowercase letters for 'assume unchanged' files"),
486 OPT_BOOLEAN('c', "cached", &show_cached,
487 "show cached files in the output (default)"),
488 OPT_BOOLEAN('d', "deleted", &show_deleted,
489 "show deleted files in the output"),
490 OPT_BOOLEAN('m', "modified", &show_modified,
491 "show modified files in the output"),
492 OPT_BOOLEAN('o', "others", &show_others,
493 "show other files in the output"),
494 OPT_BIT('i', "ignored", &dir.flags,
495 "show ignored files in the output",
496 DIR_SHOW_IGNORED),
497 OPT_BOOLEAN('s', "stage", &show_stage,
498 "show staged contents' object name in the output"),
499 OPT_BOOLEAN('k', "killed", &show_killed,
500 "show files on the filesystem that need to be removed"),
501 OPT_BIT(0, "directory", &dir.flags,
502 "show 'other' directories' name only",
503 DIR_SHOW_OTHER_DIRECTORIES),
504 OPT_NEGBIT(0, "empty-directory", &dir.flags,
505 "don't show empty directories",
506 DIR_HIDE_EMPTY_DIRECTORIES),
507 OPT_BOOLEAN('u', "unmerged", &show_unmerged,
508 "show unmerged files in the output"),
509 OPT_BOOLEAN(0, "resolve-undo", &show_resolve_undo,
510 "show resolve-undo information"),
511 { OPTION_CALLBACK, 'x', "exclude", &dir.exclude_list[EXC_CMDL], "pattern",
512 "skip files matching pattern",
513 0, option_parse_exclude },
514 { OPTION_CALLBACK, 'X', "exclude-from", &dir, "file",
515 "exclude patterns are read from <file>",
516 0, option_parse_exclude_from },
517 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, "file",
518 "read additional per-directory exclude patterns in <file>"),
519 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
520 "add the standard git exclusions",
521 PARSE_OPT_NOARG, option_parse_exclude_standard },
522 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
523 "make the output relative to the project top directory",
524 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
525 OPT_BOOLEAN(0, "error-unmatch", &error_unmatch,
526 "if any <file> is not in the index, treat this as an error"),
527 OPT_STRING(0, "with-tree", &with_tree, "tree-ish",
528 "pretend that paths removed since <tree-ish> are still present"),
529 OPT__ABBREV(&abbrev),
530 OPT_BOOLEAN(0, "debug", &debug_mode, "show debugging data"),
531 OPT_END()
532 };
533 memset(&dir, 0, sizeof(dir));
535 prefix = cmd_prefix;
536 if (prefix)
537 prefix_len = strlen(prefix);
538 git_config(git_default_config, NULL);
539 if (read_cache() < 0)
541 die("index file corrupt");
542 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
544 ls_files_usage, 0);
545 if (show_tag || show_valid_bit) {
546 tag_cached = "H ";
547 tag_unmerged = "M ";
548 tag_removed = "R ";
549 tag_modified = "C ";
550 tag_other = "? ";
551 tag_killed = "K ";
552 tag_skip_worktree = "S ";
553 tag_resolve_undo = "U ";
554 }
555 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
556 require_work_tree = 1;
557 if (show_unmerged)
558 /*
559 * There's no point in showing unmerged unless
560 * you also show the stage information.
561 */
562 show_stage = 1;
563 if (dir.exclude_per_dir)
564 exc_given = 1;
565 if (require_work_tree && !is_inside_work_tree())
567 setup_work_tree();
568 pathspec = get_pathspec(prefix, argv);
570 /* be nice with submodule paths ending in a slash */
572 if (pathspec)
573 strip_trailing_slash_from_submodules();
574 /* Find common prefix for all pathspec's */
576 max_prefix = pathspec_prefix(prefix);
577 /* Treat unmatching pathspec elements as errors */
579 if (pathspec && error_unmatch) {
580 int num;
581 for (num = 0; pathspec[num]; num++)
582 ;
583 ps_matched = xcalloc(1, num);
584 }
585 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
587 die("ls-files --ignored needs some exclude pattern");
588 /* With no flags, we default to showing the cached files */
590 if (!(show_stage | show_deleted | show_others | show_unmerged |
591 show_killed | show_modified | show_resolve_undo))
592 show_cached = 1;
593 if (max_prefix)
595 prune_cache(max_prefix);
596 if (with_tree) {
597 /*
598 * Basic sanity check; show-stages and show-unmerged
599 * would not make any sense with this option.
600 */
601 if (show_stage || show_unmerged)
602 die("ls-files --with-tree is incompatible with -s or -u");
603 overlay_tree_on_cache(with_tree, max_prefix);
604 }
605 show_files(&dir);
606 if (show_resolve_undo)
607 show_ru_info();
608 if (ps_matched) {
610 int bad;
611 bad = report_path_error(ps_matched, pathspec, prefix_len);
612 if (bad)
613 fprintf(stderr, "Did you forget to 'git add'?\n");
614 return bad ? 1 : 0;
616 }
617 return 0;
619}