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