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"
13static int abbrev;
15static int show_deleted;
16static int show_cached;
17static int show_others;
18static int show_stage;
19static int show_unmerged;
20static int show_modified;
21static int show_killed;
22static int show_valid_bit;
23static int line_terminator = '\n';
24static int prefix_len;
26static int prefix_offset;
27static const char **pathspec;
28static int error_unmatch;
29static char *ps_matched;
30static const char *with_tree;
31static const char *tag_cached = "";
33static const char *tag_unmerged = "";
34static const char *tag_removed = "";
35static const char *tag_other = "";
36static const char *tag_killed = "";
37static const char *tag_modified = "";
38/*
41 * Match a pathspec against a filename. The first "skiplen" characters
42 * are the common prefix
43 */
44int pathspec_match(const char **spec, char *ps_matched,
45 const char *filename, int skiplen)
46{
47 const char *m;
48 while ((m = *spec++) != NULL) {
50 int matchlen = strlen(m + skiplen);
51 if (!matchlen)
53 goto matched;
54 if (!strncmp(m + skiplen, filename + skiplen, matchlen)) {
55 if (m[skiplen + matchlen - 1] == '/')
56 goto matched;
57 switch (filename[skiplen + matchlen]) {
58 case '/': case '\0':
59 goto matched;
60 }
61 }
62 if (!fnmatch(m + skiplen, filename + skiplen, 0))
63 goto matched;
64 if (ps_matched)
65 ps_matched++;
66 continue;
67 matched:
68 if (ps_matched)
69 *ps_matched = 1;
70 return 1;
71 }
72 return 0;
73}
74static void show_dir_entry(const char *tag, struct dir_entry *ent)
76{
77 int len = prefix_len;
78 int offset = prefix_offset;
79 if (len >= ent->len)
81 die("git-ls-files: internal error - directory entry not superset of prefix");
82 if (pathspec && !pathspec_match(pathspec, ps_matched, ent->name, len))
84 return;
85 fputs(tag, stdout);
87 write_name_quoted(ent->name + offset, stdout, line_terminator);
88}
89static void show_other_files(struct dir_struct *dir)
91{
92 int i;
93 /*
96 * Skip matching and unmerged entries for the paths,
97 * since we want just "others".
98 *
99 * (Matching entries are normally pruned during
100 * the directory tree walk, but will show up for
101 * gitlinks because we don't necessarily have
102 * dir->show_other_directories set to suppress
103 * them).
104 */
105 for (i = 0; i < dir->nr; i++) {
106 struct dir_entry *ent = dir->entries[i];
107 int len, pos;
108 struct cache_entry *ce;
109 /*
111 * Remove the '/' at the end that directory
112 * walking adds for directory entries.
113 */
114 len = ent->len;
115 if (len && ent->name[len-1] == '/')
116 len--;
117 pos = cache_name_pos(ent->name, len);
118 if (0 <= pos)
119 continue; /* exact match */
120 pos = -pos - 1;
121 if (pos < active_nr) {
122 ce = active_cache[pos];
123 if (ce_namelen(ce) == len &&
124 !memcmp(ce->name, ent->name, len))
125 continue; /* Yup, this one exists unmerged */
126 }
127 show_dir_entry(tag_other, ent);
128 }
129}
130static void show_killed_files(struct dir_struct *dir)
132{
133 int i;
134 for (i = 0; i < dir->nr; i++) {
135 struct dir_entry *ent = dir->entries[i];
136 char *cp, *sp;
137 int pos, len, killed = 0;
138 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
140 sp = strchr(cp, '/');
141 if (!sp) {
142 /* If ent->name is prefix of an entry in the
143 * cache, it will be killed.
144 */
145 pos = cache_name_pos(ent->name, ent->len);
146 if (0 <= pos)
147 die("bug in show-killed-files");
148 pos = -pos - 1;
149 while (pos < active_nr &&
150 ce_stage(active_cache[pos]))
151 pos++; /* skip unmerged */
152 if (active_nr <= pos)
153 break;
154 /* pos points at a name immediately after
155 * ent->name in the cache. Does it expect
156 * ent->name to be a directory?
157 */
158 len = ce_namelen(active_cache[pos]);
159 if ((ent->len < len) &&
160 !strncmp(active_cache[pos]->name,
161 ent->name, ent->len) &&
162 active_cache[pos]->name[ent->len] == '/')
163 killed = 1;
164 break;
165 }
166 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
167 /* If any of the leading directories in
168 * ent->name is registered in the cache,
169 * ent->name will be killed.
170 */
171 killed = 1;
172 break;
173 }
174 }
175 if (killed)
176 show_dir_entry(tag_killed, dir->entries[i]);
177 }
178}
179static void show_ce_entry(const char *tag, struct cache_entry *ce)
181{
182 int len = prefix_len;
183 int offset = prefix_offset;
184 if (len >= ce_namelen(ce))
186 die("git-ls-files: internal error - cache entry not superset of prefix");
187 if (pathspec && !pathspec_match(pathspec, ps_matched, ce->name, len))
189 return;
190 if (tag && *tag && show_valid_bit &&
192 (ce->ce_flags & CE_VALID)) {
193 static char alttag[4];
194 memcpy(alttag, tag, 3);
195 if (isalpha(tag[0]))
196 alttag[0] = tolower(tag[0]);
197 else if (tag[0] == '?')
198 alttag[0] = '!';
199 else {
200 alttag[0] = 'v';
201 alttag[1] = tag[0];
202 alttag[2] = ' ';
203 alttag[3] = 0;
204 }
205 tag = alttag;
206 }
207 if (!show_stage) {
209 fputs(tag, stdout);
210 } else {
211 printf("%s%06o %s %d\t",
212 tag,
213 ce->ce_mode,
214 abbrev ? find_unique_abbrev(ce->sha1,abbrev)
215 : sha1_to_hex(ce->sha1),
216 ce_stage(ce));
217 }
218 write_name_quoted(ce->name + offset, stdout, line_terminator);
219}
220static void show_files(struct dir_struct *dir, const char *prefix)
222{
223 int i;
224 /* For cached/deleted files we don't need to even do the readdir */
226 if (show_others || show_killed) {
227 const char *path = ".", *base = "";
228 int baselen = prefix_len;
229 if (baselen)
231 path = base = prefix;
232 read_directory(dir, path, base, baselen, pathspec);
233 if (show_others)
234 show_other_files(dir);
235 if (show_killed)
236 show_killed_files(dir);
237 }
238 if (show_cached | show_stage) {
239 for (i = 0; i < active_nr; i++) {
240 struct cache_entry *ce = active_cache[i];
241 int dtype = ce_to_dtype(ce);
242 if (excluded(dir, ce->name, &dtype) != dir->show_ignored)
243 continue;
244 if (show_unmerged && !ce_stage(ce))
245 continue;
246 if (ce->ce_flags & CE_UPDATE)
247 continue;
248 show_ce_entry(ce_stage(ce) ? tag_unmerged : tag_cached, ce);
249 }
250 }
251 if (show_deleted | show_modified) {
252 for (i = 0; i < active_nr; i++) {
253 struct cache_entry *ce = active_cache[i];
254 struct stat st;
255 int err;
256 int dtype = ce_to_dtype(ce);
257 if (excluded(dir, ce->name, &dtype) != dir->show_ignored)
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, 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 struct cache_entry *ce = active_cache[next];
286 if (!strncmp(ce->name, prefix, prefix_len)) {
287 first = next+1;
288 continue;
289 }
290 last = next;
291 }
292 active_nr = last;
293}
294static const char *verify_pathspec(const char *prefix)
296{
297 const char **p, *n, *prev;
298 unsigned long max;
299 prev = NULL;
301 max = PATH_MAX;
302 for (p = pathspec; (n = *p) != NULL; p++) {
303 int i, len = 0;
304 for (i = 0; i < max; i++) {
305 char c = n[i];
306 if (prev && prev[i] != c)
307 break;
308 if (!c || c == '*' || c == '?')
309 break;
310 if (c == '/')
311 len = i+1;
312 }
313 prev = n;
314 if (len < max) {
315 max = len;
316 if (!max)
317 break;
318 }
319 }
320 if (prefix_offset > max || memcmp(prev, prefix, prefix_offset))
322 die("git-ls-files: cannot generate relative filenames containing '..'");
323 prefix_len = max;
325 return max ? xmemdupz(prev, max) : NULL;
326}
327/*
329 * Read the tree specified with --with-tree option
330 * (typically, HEAD) into stage #1 and then
331 * squash them down to stage #0. This is used for
332 * --error-unmatch to list and check the path patterns
333 * that were given from the command line. We are not
334 * going to write this index out.
335 */
336void overlay_tree_on_cache(const char *tree_name, const char *prefix)
337{
338 struct tree *tree;
339 unsigned char sha1[20];
340 const char **match;
341 struct cache_entry *last_stage0 = NULL;
342 int i;
343 if (get_sha1(tree_name, sha1))
345 die("tree-ish %s not found.", tree_name);
346 tree = parse_tree_indirect(sha1);
347 if (!tree)
348 die("bad tree-ish %s", tree_name);
349 /* Hoist the unmerged entries up to stage #3 to make room */
351 for (i = 0; i < active_nr; i++) {
352 struct cache_entry *ce = active_cache[i];
353 if (!ce_stage(ce))
354 continue;
355 ce->ce_flags |= CE_STAGEMASK;
356 }
357 if (prefix) {
359 static const char *(matchbuf[2]);
360 matchbuf[0] = prefix;
361 matchbuf [1] = NULL;
362 match = matchbuf;
363 } else
364 match = NULL;
365 if (read_tree(tree, 1, match))
366 die("unable to read tree entries %s", tree_name);
367 for (i = 0; i < active_nr; i++) {
369 struct cache_entry *ce = active_cache[i];
370 switch (ce_stage(ce)) {
371 case 0:
372 last_stage0 = ce;
373 /* fallthru */
374 default:
375 continue;
376 case 1:
377 /*
378 * If there is stage #0 entry for this, we do not
379 * need to show it. We use CE_UPDATE bit to mark
380 * such an entry.
381 */
382 if (last_stage0 &&
383 !strcmp(last_stage0->name, ce->name))
384 ce->ce_flags |= CE_UPDATE;
385 }
386 }
387}
388int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset)
390{
391 /*
392 * Make sure all pathspec matched; otherwise it is an error.
393 */
394 int num, errors = 0;
395 for (num = 0; pathspec[num]; num++) {
396 int other, found_dup;
397 if (ps_matched[num])
399 continue;
400 /*
401 * The caller might have fed identical pathspec
402 * twice. Do not barf on such a mistake.
403 */
404 for (found_dup = other = 0;
405 !found_dup && pathspec[other];
406 other++) {
407 if (other == num || !ps_matched[other])
408 continue;
409 if (!strcmp(pathspec[other], pathspec[num]))
410 /*
411 * Ok, we have a match already.
412 */
413 found_dup = 1;
414 }
415 if (found_dup)
416 continue;
417 error("pathspec '%s' did not match any file(s) known to git.",
419 pathspec[num] + prefix_offset);
420 errors++;
421 }
422 return errors;
423}
424static const char ls_files_usage[] =
426 "git-ls-files [-z] [-t] [-v] (--[cached|deleted|others|stage|unmerged|killed|modified])* "
427 "[ --ignored ] [--exclude=<pattern>] [--exclude-from=<file>] "
428 "[ --exclude-per-directory=<filename> ] [--exclude-standard] "
429 "[--full-name] [--abbrev] [--] [<file>]*";
430int cmd_ls_files(int argc, const char **argv, const char *prefix)
432{
433 int i;
434 int exc_given = 0, require_work_tree = 0;
435 struct dir_struct dir;
436 memset(&dir, 0, sizeof(dir));
438 if (prefix)
439 prefix_offset = strlen(prefix);
440 git_config(git_default_config);
441 for (i = 1; i < argc; i++) {
443 const char *arg = argv[i];
444 if (!strcmp(arg, "--")) {
446 i++;
447 break;
448 }
449 if (!strcmp(arg, "-z")) {
450 line_terminator = 0;
451 continue;
452 }
453 if (!strcmp(arg, "-t") || !strcmp(arg, "-v")) {
454 tag_cached = "H ";
455 tag_unmerged = "M ";
456 tag_removed = "R ";
457 tag_modified = "C ";
458 tag_other = "? ";
459 tag_killed = "K ";
460 if (arg[1] == 'v')
461 show_valid_bit = 1;
462 continue;
463 }
464 if (!strcmp(arg, "-c") || !strcmp(arg, "--cached")) {
465 show_cached = 1;
466 continue;
467 }
468 if (!strcmp(arg, "-d") || !strcmp(arg, "--deleted")) {
469 show_deleted = 1;
470 continue;
471 }
472 if (!strcmp(arg, "-m") || !strcmp(arg, "--modified")) {
473 show_modified = 1;
474 require_work_tree = 1;
475 continue;
476 }
477 if (!strcmp(arg, "-o") || !strcmp(arg, "--others")) {
478 show_others = 1;
479 require_work_tree = 1;
480 continue;
481 }
482 if (!strcmp(arg, "-i") || !strcmp(arg, "--ignored")) {
483 dir.show_ignored = 1;
484 require_work_tree = 1;
485 continue;
486 }
487 if (!strcmp(arg, "-s") || !strcmp(arg, "--stage")) {
488 show_stage = 1;
489 continue;
490 }
491 if (!strcmp(arg, "-k") || !strcmp(arg, "--killed")) {
492 show_killed = 1;
493 require_work_tree = 1;
494 continue;
495 }
496 if (!strcmp(arg, "--directory")) {
497 dir.show_other_directories = 1;
498 continue;
499 }
500 if (!strcmp(arg, "--no-empty-directory")) {
501 dir.hide_empty_directories = 1;
502 continue;
503 }
504 if (!strcmp(arg, "-u") || !strcmp(arg, "--unmerged")) {
505 /* There's no point in showing unmerged unless
506 * you also show the stage information.
507 */
508 show_stage = 1;
509 show_unmerged = 1;
510 continue;
511 }
512 if (!strcmp(arg, "-x") && i+1 < argc) {
513 exc_given = 1;
514 add_exclude(argv[++i], "", 0, &dir.exclude_list[EXC_CMDL]);
515 continue;
516 }
517 if (!prefixcmp(arg, "--exclude=")) {
518 exc_given = 1;
519 add_exclude(arg+10, "", 0, &dir.exclude_list[EXC_CMDL]);
520 continue;
521 }
522 if (!strcmp(arg, "-X") && i+1 < argc) {
523 exc_given = 1;
524 add_excludes_from_file(&dir, argv[++i]);
525 continue;
526 }
527 if (!prefixcmp(arg, "--exclude-from=")) {
528 exc_given = 1;
529 add_excludes_from_file(&dir, arg+15);
530 continue;
531 }
532 if (!prefixcmp(arg, "--exclude-per-directory=")) {
533 exc_given = 1;
534 dir.exclude_per_dir = arg + 24;
535 continue;
536 }
537 if (!strcmp(arg, "--exclude-standard")) {
538 exc_given = 1;
539 setup_standard_excludes(&dir);
540 continue;
541 }
542 if (!strcmp(arg, "--full-name")) {
543 prefix_offset = 0;
544 continue;
545 }
546 if (!strcmp(arg, "--error-unmatch")) {
547 error_unmatch = 1;
548 continue;
549 }
550 if (!prefixcmp(arg, "--with-tree=")) {
551 with_tree = arg + 12;
552 continue;
553 }
554 if (!prefixcmp(arg, "--abbrev=")) {
555 abbrev = strtoul(arg+9, NULL, 10);
556 if (abbrev && abbrev < MINIMUM_ABBREV)
557 abbrev = MINIMUM_ABBREV;
558 else if (abbrev > 40)
559 abbrev = 40;
560 continue;
561 }
562 if (!strcmp(arg, "--abbrev")) {
563 abbrev = DEFAULT_ABBREV;
564 continue;
565 }
566 if (*arg == '-')
567 usage(ls_files_usage);
568 break;
569 }
570 if (require_work_tree && !is_inside_work_tree())
572 setup_work_tree();
573 pathspec = get_pathspec(prefix, argv + i);
575 /* Verify that the pathspec matches the prefix */
577 if (pathspec) {
578 if (argc != i) {
579 int cnt;
580 for (cnt = 0; pathspec[cnt]; cnt++)
581 ;
582 if (cnt != (argc - i))
583 exit(1); /* error message already given */
584 }
585 prefix = verify_pathspec(prefix);
586 } else if (argc != i)
587 exit(1); /* error message already given */
588 /* Treat unmatching pathspec elements as errors */
590 if (pathspec && error_unmatch) {
591 int num;
592 for (num = 0; pathspec[num]; num++)
593 ;
594 ps_matched = xcalloc(1, num);
595 }
596 if (dir.show_ignored && !exc_given) {
598 fprintf(stderr, "%s: --ignored needs some exclude pattern\n",
599 argv[0]);
600 exit(1);
601 }
602 /* With no flags, we default to showing the cached files */
604 if (!(show_stage | show_deleted | show_others | show_unmerged |
605 show_killed | show_modified))
606 show_cached = 1;
607 read_cache();
609 if (prefix)
610 prune_cache(prefix);
611 if (with_tree) {
612 /*
613 * Basic sanity check; show-stages and show-unmerged
614 * would not make any sense with this option.
615 */
616 if (show_stage || show_unmerged)
617 die("ls-files --with-tree is incompatible with -s or -u");
618 overlay_tree_on_cache(with_tree, prefix);
619 }
620 show_files(&dir, prefix);
621 if (ps_matched) {
623 int bad;
624 bad = report_path_error(ps_matched, pathspec, prefix_offset);
625 if (bad)
626 fprintf(stderr, "Did you forget to 'git add'?\n");
627 return bad ? 1 : 0;
629 }
630 return 0;
632}