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