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