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