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