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.
6 * Copyright (C) Linus Torvalds, 2005
13 #include "parse-options.h"
16 static int show_deleted;
17 static int show_cached;
18 static int show_others;
19 static int show_stage;
20 static int show_unmerged;
21 static int show_modified;
22 static int show_killed;
23 static int show_valid_bit;
24 static int line_terminator = '\n';
26 static int prefix_len;
27 static int prefix_offset;
28 static const char **pathspec;
29 static int error_unmatch;
30 static char *ps_matched;
31 static const char *with_tree;
34 static const char *tag_cached = "";
35 static const char *tag_unmerged = "";
36 static const char *tag_removed = "";
37 static const char *tag_other = "";
38 static const char *tag_killed = "";
39 static const char *tag_modified = "";
41 static void show_dir_entry(const char *tag, struct dir_entry *ent)
44 int offset = prefix_offset;
47 die("git ls-files: internal error - directory entry not superset of prefix");
49 if (!match_pathspec(pathspec, ent->name, ent->len, len, ps_matched))
53 write_name_quoted(ent->name + offset, stdout, line_terminator);
56 static void show_other_files(struct dir_struct *dir)
60 for (i = 0; i < dir->nr; i++) {
61 struct dir_entry *ent = dir->entries[i];
62 if (!cache_name_is_other(ent->name, ent->len))
64 show_dir_entry(tag_other, ent);
68 static void show_killed_files(struct dir_struct *dir)
71 for (i = 0; i < dir->nr; i++) {
72 struct dir_entry *ent = dir->entries[i];
74 int pos, len, killed = 0;
76 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
79 /* If ent->name is prefix of an entry in the
80 * cache, it will be killed.
82 pos = cache_name_pos(ent->name, ent->len);
84 die("bug in show-killed-files");
86 while (pos < active_nr &&
87 ce_stage(active_cache[pos]))
88 pos++; /* skip unmerged */
91 /* pos points at a name immediately after
92 * ent->name in the cache. Does it expect
93 * ent->name to be a directory?
95 len = ce_namelen(active_cache[pos]);
96 if ((ent->len < len) &&
97 !strncmp(active_cache[pos]->name,
98 ent->name, ent->len) &&
99 active_cache[pos]->name[ent->len] == '/')
103 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
104 /* If any of the leading directories in
105 * ent->name is registered in the cache,
106 * ent->name will be killed.
113 show_dir_entry(tag_killed, dir->entries[i]);
117 static void show_ce_entry(const char *tag, struct cache_entry *ce)
119 int len = prefix_len;
120 int offset = prefix_offset;
122 if (len >= ce_namelen(ce))
123 die("git ls-files: internal error - cache entry not superset of prefix");
125 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce), len, ps_matched))
128 if (tag && *tag && show_valid_bit &&
129 (ce->ce_flags & CE_VALID)) {
130 static char alttag[4];
131 memcpy(alttag, tag, 3);
133 alttag[0] = tolower(tag[0]);
134 else if (tag[0] == '?')
148 printf("%s%06o %s %d\t",
151 abbrev ? find_unique_abbrev(ce->sha1,abbrev)
152 : sha1_to_hex(ce->sha1),
155 write_name_quoted(ce->name + offset, stdout, line_terminator);
158 static void show_files(struct dir_struct *dir, const char *prefix)
162 /* For cached/deleted files we don't need to even do the readdir */
163 if (show_others || show_killed) {
164 const char *path = ".", *base = "";
165 int baselen = prefix_len;
168 path = base = prefix;
169 read_directory(dir, path, base, baselen, pathspec);
171 show_other_files(dir);
173 show_killed_files(dir);
175 if (show_cached | show_stage) {
176 for (i = 0; i < active_nr; i++) {
177 struct cache_entry *ce = active_cache[i];
178 if (show_unmerged && !ce_stage(ce))
180 if (ce->ce_flags & CE_UPDATE)
182 show_ce_entry(ce_stage(ce) ? tag_unmerged : tag_cached, ce);
185 if (show_deleted | show_modified) {
186 for (i = 0; i < active_nr; i++) {
187 struct cache_entry *ce = active_cache[i];
190 if (ce->ce_flags & CE_UPDATE)
192 err = lstat(ce->name, &st);
193 if (show_deleted && err)
194 show_ce_entry(tag_removed, ce);
195 if (show_modified && ce_modified(ce, &st, 0))
196 show_ce_entry(tag_modified, ce);
202 * Prune the index to only contain stuff starting with "prefix"
204 static void prune_cache(const char *prefix)
206 int pos = cache_name_pos(prefix, prefix_len);
207 unsigned int first, last;
211 memmove(active_cache, active_cache + pos,
212 (active_nr - pos) * sizeof(struct cache_entry *));
216 while (last > first) {
217 int next = (last + first) >> 1;
218 struct cache_entry *ce = active_cache[next];
219 if (!strncmp(ce->name, prefix, prefix_len)) {
228 static const char *verify_pathspec(const char *prefix)
230 const char **p, *n, *prev;
235 for (p = pathspec; (n = *p) != NULL; p++) {
237 for (i = 0; i < max; i++) {
239 if (prev && prev[i] != c)
241 if (!c || c == '*' || c == '?')
254 if (prefix_offset > max || memcmp(prev, prefix, prefix_offset))
255 die("git ls-files: cannot generate relative filenames containing '..'");
258 return max ? xmemdupz(prev, max) : NULL;
261 static void strip_trailing_slash_from_submodules(void)
265 for (p = pathspec; *p != NULL; p++) {
266 int len = strlen(*p), pos;
268 if (len < 1 || (*p)[len - 1] != '/')
270 pos = cache_name_pos(*p, len - 1);
271 if (pos >= 0 && S_ISGITLINK(active_cache[pos]->ce_mode))
272 *p = xstrndup(*p, len - 1);
277 * Read the tree specified with --with-tree option
278 * (typically, HEAD) into stage #1 and then
279 * squash them down to stage #0. This is used for
280 * --error-unmatch to list and check the path patterns
281 * that were given from the command line. We are not
282 * going to write this index out.
284 void overlay_tree_on_cache(const char *tree_name, const char *prefix)
287 unsigned char sha1[20];
289 struct cache_entry *last_stage0 = NULL;
292 if (get_sha1(tree_name, sha1))
293 die("tree-ish %s not found.", tree_name);
294 tree = parse_tree_indirect(sha1);
296 die("bad tree-ish %s", tree_name);
298 /* Hoist the unmerged entries up to stage #3 to make room */
299 for (i = 0; i < active_nr; i++) {
300 struct cache_entry *ce = active_cache[i];
303 ce->ce_flags |= CE_STAGEMASK;
307 static const char *(matchbuf[2]);
308 matchbuf[0] = prefix;
313 if (read_tree(tree, 1, match))
314 die("unable to read tree entries %s", tree_name);
316 for (i = 0; i < active_nr; i++) {
317 struct cache_entry *ce = active_cache[i];
318 switch (ce_stage(ce)) {
326 * If there is stage #0 entry for this, we do not
327 * need to show it. We use CE_UPDATE bit to mark
331 !strcmp(last_stage0->name, ce->name))
332 ce->ce_flags |= CE_UPDATE;
337 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset)
340 * Make sure all pathspec matched; otherwise it is an error.
343 for (num = 0; pathspec[num]; num++) {
344 int other, found_dup;
349 * The caller might have fed identical pathspec
350 * twice. Do not barf on such a mistake.
352 for (found_dup = other = 0;
353 !found_dup && pathspec[other];
355 if (other == num || !ps_matched[other])
357 if (!strcmp(pathspec[other], pathspec[num]))
359 * Ok, we have a match already.
366 error("pathspec '%s' did not match any file(s) known to git.",
367 pathspec[num] + prefix_offset);
373 static const char * const ls_files_usage[] = {
374 "git ls-files [options] [<file>]*",
378 static int option_parse_z(const struct option *opt,
379 const char *arg, int unset)
381 line_terminator = unset ? '\n' : '\0';
386 static int option_parse_exclude(const struct option *opt,
387 const char *arg, int unset)
389 struct exclude_list *list = opt->value;
392 add_exclude(arg, "", 0, list);
397 static int option_parse_exclude_from(const struct option *opt,
398 const char *arg, int unset)
400 struct dir_struct *dir = opt->value;
403 add_excludes_from_file(dir, arg);
408 static int option_parse_exclude_standard(const struct option *opt,
409 const char *arg, int unset)
411 struct dir_struct *dir = opt->value;
414 setup_standard_excludes(dir);
419 int cmd_ls_files(int argc, const char **argv, const char *prefix)
421 int require_work_tree = 0, show_tag = 0;
422 struct dir_struct dir;
423 struct option builtin_ls_files_options[] = {
424 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
425 "paths are separated with NUL character",
426 PARSE_OPT_NOARG, option_parse_z },
427 OPT_BOOLEAN('t', NULL, &show_tag,
428 "identify the file status with tags"),
429 OPT_BOOLEAN('v', NULL, &show_valid_bit,
430 "use lowercase letters for 'assume unchanged' files"),
431 OPT_BOOLEAN('c', "cached", &show_cached,
432 "show cached files in the output (default)"),
433 OPT_BOOLEAN('d', "deleted", &show_deleted,
434 "show deleted files in the output"),
435 OPT_BOOLEAN('m', "modified", &show_modified,
436 "show modified files in the output"),
437 OPT_BOOLEAN('o', "others", &show_others,
438 "show other files in the output"),
439 OPT_BIT('i', "ignored", &dir.flags,
440 "show ignored files in the output",
442 OPT_BOOLEAN('s', "stage", &show_stage,
443 "show staged contents' object name in the output"),
444 OPT_BOOLEAN('k', "killed", &show_killed,
445 "show files on the filesystem that need to be removed"),
446 OPT_BIT(0, "directory", &dir.flags,
447 "show 'other' directories' name only",
448 DIR_SHOW_OTHER_DIRECTORIES),
449 OPT_BIT(0, "no-empty-directory", &dir.flags,
450 "don't show empty directories",
451 DIR_HIDE_EMPTY_DIRECTORIES),
452 OPT_BOOLEAN('u', "unmerged", &show_unmerged,
453 "show unmerged files in the output"),
454 { OPTION_CALLBACK, 'x', "exclude", &dir.exclude_list[EXC_CMDL], "pattern",
455 "skip files matching pattern",
456 0, option_parse_exclude },
457 { OPTION_CALLBACK, 'X', "exclude-from", &dir, "file",
458 "exclude patterns are read from <file>",
459 0, option_parse_exclude_from },
460 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, "file",
461 "read additional per-directory exclude patterns in <file>"),
462 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
463 "add the standard git exclusions",
464 PARSE_OPT_NOARG, option_parse_exclude_standard },
465 { OPTION_SET_INT, 0, "full-name", &prefix_offset, NULL,
466 "make the output relative to the project top directory",
467 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
468 OPT_BOOLEAN(0, "error-unmatch", &error_unmatch,
469 "if any <file> is not in the index, treat this as an error"),
470 OPT_STRING(0, "with-tree", &with_tree, "tree-ish",
471 "pretend that paths removed since <tree-ish> are still present"),
472 OPT__ABBREV(&abbrev),
476 memset(&dir, 0, sizeof(dir));
478 prefix_offset = strlen(prefix);
479 git_config(git_default_config, NULL);
481 argc = parse_options(argc, argv, builtin_ls_files_options,
483 if (show_tag || show_valid_bit) {
491 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
492 require_work_tree = 1;
495 * There's no point in showing unmerged unless
496 * you also show the stage information.
499 if (dir.exclude_per_dir)
502 if (require_work_tree && !is_inside_work_tree())
505 pathspec = get_pathspec(prefix, argv);
507 /* be nice with submodule paths ending in a slash */
510 strip_trailing_slash_from_submodules();
512 /* Verify that the pathspec matches the prefix */
514 prefix = verify_pathspec(prefix);
516 /* Treat unmatching pathspec elements as errors */
517 if (pathspec && error_unmatch) {
519 for (num = 0; pathspec[num]; num++)
521 ps_matched = xcalloc(1, num);
524 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given) {
525 fprintf(stderr, "%s: --ignored needs some exclude pattern\n",
530 /* With no flags, we default to showing the cached files */
531 if (!(show_stage | show_deleted | show_others | show_unmerged |
532 show_killed | show_modified))
539 * Basic sanity check; show-stages and show-unmerged
540 * would not make any sense with this option.
542 if (show_stage || show_unmerged)
543 die("ls-files --with-tree is incompatible with -s or -u");
544 overlay_tree_on_cache(with_tree, prefix);
546 show_files(&dir, prefix);
550 bad = report_path_error(ps_matched, pathspec, prefix_offset);
552 fprintf(stderr, "Did you forget to 'git add'?\n");