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 int exclude_args;
39static const char *tag_cached = "";
41static const char *tag_unmerged = "";
42static const char *tag_removed = "";
43static const char *tag_other = "";
44static const char *tag_killed = "";
45static const char *tag_modified = "";
46static const char *tag_skip_worktree = "";
47static const char *tag_resolve_undo = "";
48static void write_name(const char *name)
50{
51 /*
52 * With "--full-name", prefix_len=0; this caller needs to pass
53 * an empty string in that case (a NULL is good for "").
54 */
55 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
56 stdout, line_terminator);
57}
58static void show_dir_entry(const char *tag, struct dir_entry *ent)
60{
61 int len = max_prefix_len;
62 if (len >= ent->len)
64 die("git ls-files: internal error - directory entry not superset of prefix");
65 if (!match_pathspec(pathspec, ent->name, ent->len, len, ps_matched))
67 return;
68 fputs(tag, stdout);
70 write_name(ent->name);
71}
72static void show_other_files(struct dir_struct *dir)
74{
75 int i;
76 for (i = 0; i < dir->nr; i++) {
78 struct dir_entry *ent = dir->entries[i];
79 if (!cache_name_is_other(ent->name, ent->len))
80 continue;
81 show_dir_entry(tag_other, ent);
82 }
83}
84static void show_killed_files(struct dir_struct *dir)
86{
87 int i;
88 for (i = 0; i < dir->nr; i++) {
89 struct dir_entry *ent = dir->entries[i];
90 char *cp, *sp;
91 int pos, len, killed = 0;
92 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
94 sp = strchr(cp, '/');
95 if (!sp) {
96 /* If ent->name is prefix of an entry in the
97 * cache, it will be killed.
98 */
99 pos = cache_name_pos(ent->name, ent->len);
100 if (0 <= pos)
101 die("bug in show-killed-files");
102 pos = -pos - 1;
103 while (pos < active_nr &&
104 ce_stage(active_cache[pos]))
105 pos++; /* skip unmerged */
106 if (active_nr <= pos)
107 break;
108 /* pos points at a name immediately after
109 * ent->name in the cache. Does it expect
110 * ent->name to be a directory?
111 */
112 len = ce_namelen(active_cache[pos]);
113 if ((ent->len < len) &&
114 !strncmp(active_cache[pos]->name,
115 ent->name, ent->len) &&
116 active_cache[pos]->name[ent->len] == '/')
117 killed = 1;
118 break;
119 }
120 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
121 /* If any of the leading directories in
122 * ent->name is registered in the cache,
123 * ent->name will be killed.
124 */
125 killed = 1;
126 break;
127 }
128 }
129 if (killed)
130 show_dir_entry(tag_killed, dir->entries[i]);
131 }
132}
133static void show_ce_entry(const char *tag, const struct cache_entry *ce)
135{
136 int len = max_prefix_len;
137 if (len >= ce_namelen(ce))
139 die("git ls-files: internal error - cache entry not superset of prefix");
140 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce), len, ps_matched))
142 return;
143 if (tag && *tag && show_valid_bit &&
145 (ce->ce_flags & CE_VALID)) {
146 static char alttag[4];
147 memcpy(alttag, tag, 3);
148 if (isalpha(tag[0]))
149 alttag[0] = tolower(tag[0]);
150 else if (tag[0] == '?')
151 alttag[0] = '!';
152 else {
153 alttag[0] = 'v';
154 alttag[1] = tag[0];
155 alttag[2] = ' ';
156 alttag[3] = 0;
157 }
158 tag = alttag;
159 }
160 if (!show_stage) {
162 fputs(tag, stdout);
163 } else {
164 printf("%s%06o %s %d\t",
165 tag,
166 ce->ce_mode,
167 find_unique_abbrev(ce->sha1,abbrev),
168 ce_stage(ce));
169 }
170 write_name(ce->name);
171 if (debug_mode) {
172 const struct stat_data *sd = &ce->ce_stat_data;
173 printf(" ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
175 printf(" mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
176 printf(" dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
177 printf(" uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
178 printf(" size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
179 }
180}
181static void show_ru_info(void)
183{
184 struct string_list_item *item;
185 if (!the_index.resolve_undo)
187 return;
188 for_each_string_list_item(item, the_index.resolve_undo) {
190 const char *path = item->string;
191 struct resolve_undo_info *ui = item->util;
192 int i, len;
193 len = strlen(path);
195 if (len < max_prefix_len)
196 continue; /* outside of the prefix */
197 if (!match_pathspec(pathspec, path, len, max_prefix_len, ps_matched))
198 continue; /* uninterested */
199 for (i = 0; i < 3; i++) {
200 if (!ui->mode[i])
201 continue;
202 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
203 find_unique_abbrev(ui->sha1[i], abbrev),
204 i + 1);
205 write_name(path);
206 }
207 }
208}
209static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
211{
212 int dtype = ce_to_dtype(ce);
213 return is_excluded(dir, ce->name, &dtype);
214}
215static void show_files(struct dir_struct *dir)
217{
218 int i;
219 /* For cached/deleted files we don't need to even do the readdir */
221 if (show_others || show_killed) {
222 fill_directory(dir, pathspec);
223 if (show_others)
224 show_other_files(dir);
225 if (show_killed)
226 show_killed_files(dir);
227 }
228 if (show_cached || show_stage) {
229 for (i = 0; i < active_nr; i++) {
230 const struct cache_entry *ce = active_cache[i];
231 if ((dir->flags & DIR_SHOW_IGNORED) &&
232 !ce_excluded(dir, ce))
233 continue;
234 if (show_unmerged && !ce_stage(ce))
235 continue;
236 if (ce->ce_flags & CE_UPDATE)
237 continue;
238 show_ce_entry(ce_stage(ce) ? tag_unmerged :
239 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
240 }
241 }
242 if (show_deleted || show_modified) {
243 for (i = 0; i < active_nr; i++) {
244 const struct cache_entry *ce = active_cache[i];
245 struct stat st;
246 int err;
247 if ((dir->flags & DIR_SHOW_IGNORED) &&
248 !ce_excluded(dir, ce))
249 continue;
250 if (ce->ce_flags & CE_UPDATE)
251 continue;
252 if (ce_skip_worktree(ce))
253 continue;
254 err = lstat(ce->name, &st);
255 if (show_deleted && err)
256 show_ce_entry(tag_removed, ce);
257 if (show_modified && ce_modified(ce, &st, 0))
258 show_ce_entry(tag_modified, ce);
259 }
260 }
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 const 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].nowildcard_len = pathspec.items[0].len;
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], prefix, &sb);
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 N_("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 string_list *exclude_list = opt->value;
424 exc_given = 1;
426 string_list_append(exclude_list, arg);
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, i;
456 const char *max_prefix;
457 struct dir_struct dir;
458 struct exclude_list *el;
459 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
460 struct option builtin_ls_files_options[] = {
461 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
462 N_("paths are separated with NUL character"),
463 PARSE_OPT_NOARG, option_parse_z },
464 OPT_BOOL('t', NULL, &show_tag,
465 N_("identify the file status with tags")),
466 OPT_BOOL('v', NULL, &show_valid_bit,
467 N_("use lowercase letters for 'assume unchanged' files")),
468 OPT_BOOL('c', "cached", &show_cached,
469 N_("show cached files in the output (default)")),
470 OPT_BOOL('d', "deleted", &show_deleted,
471 N_("show deleted files in the output")),
472 OPT_BOOL('m', "modified", &show_modified,
473 N_("show modified files in the output")),
474 OPT_BOOL('o', "others", &show_others,
475 N_("show other files in the output")),
476 OPT_BIT('i', "ignored", &dir.flags,
477 N_("show ignored files in the output"),
478 DIR_SHOW_IGNORED),
479 OPT_BOOL('s', "stage", &show_stage,
480 N_("show staged contents' object name in the output")),
481 OPT_BOOL('k', "killed", &show_killed,
482 N_("show files on the filesystem that need to be removed")),
483 OPT_BIT(0, "directory", &dir.flags,
484 N_("show 'other' directories' name only"),
485 DIR_SHOW_OTHER_DIRECTORIES),
486 OPT_NEGBIT(0, "empty-directory", &dir.flags,
487 N_("don't show empty directories"),
488 DIR_HIDE_EMPTY_DIRECTORIES),
489 OPT_BOOL('u', "unmerged", &show_unmerged,
490 N_("show unmerged files in the output")),
491 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
492 N_("show resolve-undo information")),
493 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
494 N_("skip files matching pattern"),
495 0, option_parse_exclude },
496 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
497 N_("exclude patterns are read from <file>"),
498 0, option_parse_exclude_from },
499 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
500 N_("read additional per-directory exclude patterns in <file>")),
501 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
502 N_("add the standard git exclusions"),
503 PARSE_OPT_NOARG, option_parse_exclude_standard },
504 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
505 N_("make the output relative to the project top directory"),
506 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
507 OPT_BOOL(0, "error-unmatch", &error_unmatch,
508 N_("if any <file> is not in the index, treat this as an error")),
509 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
510 N_("pretend that paths removed since <tree-ish> are still present")),
511 OPT__ABBREV(&abbrev),
512 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
513 OPT_END()
514 };
515 if (argc == 2 && !strcmp(argv[1], "-h"))
517 usage_with_options(ls_files_usage, builtin_ls_files_options);
518 memset(&dir, 0, sizeof(dir));
520 prefix = cmd_prefix;
521 if (prefix)
522 prefix_len = strlen(prefix);
523 git_config(git_default_config, NULL);
524 if (read_cache() < 0)
526 die("index file corrupt");
527 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
529 ls_files_usage, 0);
530 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
531 for (i = 0; i < exclude_list.nr; i++) {
532 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
533 }
534 if (show_tag || show_valid_bit) {
535 tag_cached = "H ";
536 tag_unmerged = "M ";
537 tag_removed = "R ";
538 tag_modified = "C ";
539 tag_other = "? ";
540 tag_killed = "K ";
541 tag_skip_worktree = "S ";
542 tag_resolve_undo = "U ";
543 }
544 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
545 require_work_tree = 1;
546 if (show_unmerged)
547 /*
548 * There's no point in showing unmerged unless
549 * you also show the stage information.
550 */
551 show_stage = 1;
552 if (dir.exclude_per_dir)
553 exc_given = 1;
554 if (require_work_tree && !is_inside_work_tree())
556 setup_work_tree();
557 pathspec = get_pathspec(prefix, argv);
559 /* be nice with submodule paths ending in a slash */
561 if (pathspec)
562 strip_trailing_slash_from_submodules();
563 /* Find common prefix for all pathspec's */
565 max_prefix = common_prefix(pathspec);
566 max_prefix_len = max_prefix ? strlen(max_prefix) : 0;
567 /* Treat unmatching pathspec elements as errors */
569 if (pathspec && error_unmatch) {
570 int num;
571 for (num = 0; pathspec[num]; num++)
572 ;
573 ps_matched = xcalloc(1, num);
574 }
575 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
577 die("ls-files --ignored needs some exclude pattern");
578 /* With no flags, we default to showing the cached files */
580 if (!(show_stage || show_deleted || show_others || show_unmerged ||
581 show_killed || show_modified || show_resolve_undo))
582 show_cached = 1;
583 if (max_prefix)
585 prune_cache(max_prefix);
586 if (with_tree) {
587 /*
588 * Basic sanity check; show-stages and show-unmerged
589 * would not make any sense with this option.
590 */
591 if (show_stage || show_unmerged)
592 die("ls-files --with-tree is incompatible with -s or -u");
593 overlay_tree_on_cache(with_tree, max_prefix);
594 }
595 show_files(&dir);
596 if (show_resolve_undo)
597 show_ru_info();
598 if (ps_matched) {
600 int bad;
601 bad = report_path_error(ps_matched, pathspec, prefix);
602 if (bad)
603 fprintf(stderr, "Did you forget to 'git add'?\n");
604 return bad ? 1 : 0;
606 }
607 return 0;
609}