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