Merge branch 'mh/packed-refs-various'
[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 dir_struct *dir, struct cache_entry *ce)
205 {
206         int dtype = ce_to_dtype(ce);
207         return is_excluded(dir, ce->name, &dtype);
208 }
209
210 static void show_files(struct dir_struct *dir)
211 {
212         int i;
213
214         /* For cached/deleted files we don't need to even do the readdir */
215         if (show_others || show_killed) {
216                 fill_directory(dir, pathspec);
217                 if (show_others)
218                         show_other_files(dir);
219                 if (show_killed)
220                         show_killed_files(dir);
221         }
222         if (show_cached | show_stage) {
223                 for (i = 0; i < active_nr; i++) {
224                         struct cache_entry *ce = active_cache[i];
225                         if ((dir->flags & DIR_SHOW_IGNORED) &&
226                             !ce_excluded(dir, ce))
227                                 continue;
228                         if (show_unmerged && !ce_stage(ce))
229                                 continue;
230                         if (ce->ce_flags & CE_UPDATE)
231                                 continue;
232                         show_ce_entry(ce_stage(ce) ? tag_unmerged :
233                                 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
234                 }
235         }
236         if (show_deleted | show_modified) {
237                 for (i = 0; i < active_nr; i++) {
238                         struct cache_entry *ce = active_cache[i];
239                         struct stat st;
240                         int err;
241                         if ((dir->flags & DIR_SHOW_IGNORED) &&
242                             !ce_excluded(dir, ce))
243                                 continue;
244                         if (ce->ce_flags & CE_UPDATE)
245                                 continue;
246                         if (ce_skip_worktree(ce))
247                                 continue;
248                         err = lstat(ce->name, &st);
249                         if (show_deleted && err)
250                                 show_ce_entry(tag_removed, ce);
251                         if (show_modified && ce_modified(ce, &st, 0))
252                                 show_ce_entry(tag_modified, ce);
253                 }
254         }
255 }
256
257 /*
258  * Prune the index to only contain stuff starting with "prefix"
259  */
260 static void prune_cache(const char *prefix)
261 {
262         int pos = cache_name_pos(prefix, max_prefix_len);
263         unsigned int first, last;
264
265         if (pos < 0)
266                 pos = -pos-1;
267         memmove(active_cache, active_cache + pos,
268                 (active_nr - pos) * sizeof(struct cache_entry *));
269         active_nr -= pos;
270         first = 0;
271         last = active_nr;
272         while (last > first) {
273                 int next = (last + first) >> 1;
274                 struct cache_entry *ce = active_cache[next];
275                 if (!strncmp(ce->name, prefix, max_prefix_len)) {
276                         first = next+1;
277                         continue;
278                 }
279                 last = next;
280         }
281         active_nr = last;
282 }
283
284 static void strip_trailing_slash_from_submodules(void)
285 {
286         const char **p;
287
288         for (p = pathspec; *p != NULL; p++) {
289                 int len = strlen(*p), pos;
290
291                 if (len < 1 || (*p)[len - 1] != '/')
292                         continue;
293                 pos = cache_name_pos(*p, len - 1);
294                 if (pos >= 0 && S_ISGITLINK(active_cache[pos]->ce_mode))
295                         *p = xstrndup(*p, len - 1);
296         }
297 }
298
299 /*
300  * Read the tree specified with --with-tree option
301  * (typically, HEAD) into stage #1 and then
302  * squash them down to stage #0.  This is used for
303  * --error-unmatch to list and check the path patterns
304  * that were given from the command line.  We are not
305  * going to write this index out.
306  */
307 void overlay_tree_on_cache(const char *tree_name, const char *prefix)
308 {
309         struct tree *tree;
310         unsigned char sha1[20];
311         struct pathspec pathspec;
312         struct cache_entry *last_stage0 = NULL;
313         int i;
314
315         if (get_sha1(tree_name, sha1))
316                 die("tree-ish %s not found.", tree_name);
317         tree = parse_tree_indirect(sha1);
318         if (!tree)
319                 die("bad tree-ish %s", tree_name);
320
321         /* Hoist the unmerged entries up to stage #3 to make room */
322         for (i = 0; i < active_nr; i++) {
323                 struct cache_entry *ce = active_cache[i];
324                 if (!ce_stage(ce))
325                         continue;
326                 ce->ce_flags |= CE_STAGEMASK;
327         }
328
329         if (prefix) {
330                 static const char *(matchbuf[2]);
331                 matchbuf[0] = prefix;
332                 matchbuf[1] = NULL;
333                 init_pathspec(&pathspec, matchbuf);
334                 pathspec.items[0].nowildcard_len = pathspec.items[0].len;
335         } else
336                 init_pathspec(&pathspec, NULL);
337         if (read_tree(tree, 1, &pathspec))
338                 die("unable to read tree entries %s", tree_name);
339
340         for (i = 0; i < active_nr; i++) {
341                 struct cache_entry *ce = active_cache[i];
342                 switch (ce_stage(ce)) {
343                 case 0:
344                         last_stage0 = ce;
345                         /* fallthru */
346                 default:
347                         continue;
348                 case 1:
349                         /*
350                          * If there is stage #0 entry for this, we do not
351                          * need to show it.  We use CE_UPDATE bit to mark
352                          * such an entry.
353                          */
354                         if (last_stage0 &&
355                             !strcmp(last_stage0->name, ce->name))
356                                 ce->ce_flags |= CE_UPDATE;
357                 }
358         }
359 }
360
361 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix)
362 {
363         /*
364          * Make sure all pathspec matched; otherwise it is an error.
365          */
366         struct strbuf sb = STRBUF_INIT;
367         const char *name;
368         int num, errors = 0;
369         for (num = 0; pathspec[num]; num++) {
370                 int other, found_dup;
371
372                 if (ps_matched[num])
373                         continue;
374                 /*
375                  * The caller might have fed identical pathspec
376                  * twice.  Do not barf on such a mistake.
377                  */
378                 for (found_dup = other = 0;
379                      !found_dup && pathspec[other];
380                      other++) {
381                         if (other == num || !ps_matched[other])
382                                 continue;
383                         if (!strcmp(pathspec[other], pathspec[num]))
384                                 /*
385                                  * Ok, we have a match already.
386                                  */
387                                 found_dup = 1;
388                 }
389                 if (found_dup)
390                         continue;
391
392                 name = quote_path_relative(pathspec[num], -1, &sb, prefix);
393                 error("pathspec '%s' did not match any file(s) known to git.",
394                       name);
395                 errors++;
396         }
397         strbuf_release(&sb);
398         return errors;
399 }
400
401 static const char * const ls_files_usage[] = {
402         N_("git ls-files [options] [<file>...]"),
403         NULL
404 };
405
406 static int option_parse_z(const struct option *opt,
407                           const char *arg, int unset)
408 {
409         line_terminator = unset ? '\n' : '\0';
410
411         return 0;
412 }
413
414 static int option_parse_exclude(const struct option *opt,
415                                 const char *arg, int unset)
416 {
417         struct string_list *exclude_list = opt->value;
418
419         exc_given = 1;
420         string_list_append(exclude_list, arg);
421
422         return 0;
423 }
424
425 static int option_parse_exclude_from(const struct option *opt,
426                                      const char *arg, int unset)
427 {
428         struct dir_struct *dir = opt->value;
429
430         exc_given = 1;
431         add_excludes_from_file(dir, arg);
432
433         return 0;
434 }
435
436 static int option_parse_exclude_standard(const struct option *opt,
437                                          const char *arg, int unset)
438 {
439         struct dir_struct *dir = opt->value;
440
441         exc_given = 1;
442         setup_standard_excludes(dir);
443
444         return 0;
445 }
446
447 int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
448 {
449         int require_work_tree = 0, show_tag = 0, i;
450         const char *max_prefix;
451         struct dir_struct dir;
452         struct exclude_list *el;
453         struct string_list exclude_list = STRING_LIST_INIT_NODUP;
454         struct option builtin_ls_files_options[] = {
455                 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
456                         N_("paths are separated with NUL character"),
457                         PARSE_OPT_NOARG, option_parse_z },
458                 OPT_BOOLEAN('t', NULL, &show_tag,
459                         N_("identify the file status with tags")),
460                 OPT_BOOLEAN('v', NULL, &show_valid_bit,
461                         N_("use lowercase letters for 'assume unchanged' files")),
462                 OPT_BOOLEAN('c', "cached", &show_cached,
463                         N_("show cached files in the output (default)")),
464                 OPT_BOOLEAN('d', "deleted", &show_deleted,
465                         N_("show deleted files in the output")),
466                 OPT_BOOLEAN('m', "modified", &show_modified,
467                         N_("show modified files in the output")),
468                 OPT_BOOLEAN('o', "others", &show_others,
469                         N_("show other files in the output")),
470                 OPT_BIT('i', "ignored", &dir.flags,
471                         N_("show ignored files in the output"),
472                         DIR_SHOW_IGNORED),
473                 OPT_BOOLEAN('s', "stage", &show_stage,
474                         N_("show staged contents' object name in the output")),
475                 OPT_BOOLEAN('k', "killed", &show_killed,
476                         N_("show files on the filesystem that need to be removed")),
477                 OPT_BIT(0, "directory", &dir.flags,
478                         N_("show 'other' directories' name only"),
479                         DIR_SHOW_OTHER_DIRECTORIES),
480                 OPT_NEGBIT(0, "empty-directory", &dir.flags,
481                         N_("don't show empty directories"),
482                         DIR_HIDE_EMPTY_DIRECTORIES),
483                 OPT_BOOLEAN('u', "unmerged", &show_unmerged,
484                         N_("show unmerged files in the output")),
485                 OPT_BOOLEAN(0, "resolve-undo", &show_resolve_undo,
486                             N_("show resolve-undo information")),
487                 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
488                         N_("skip files matching pattern"),
489                         0, option_parse_exclude },
490                 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
491                         N_("exclude patterns are read from <file>"),
492                         0, option_parse_exclude_from },
493                 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
494                         N_("read additional per-directory exclude patterns in <file>")),
495                 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
496                         N_("add the standard git exclusions"),
497                         PARSE_OPT_NOARG, option_parse_exclude_standard },
498                 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
499                         N_("make the output relative to the project top directory"),
500                         PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
501                 OPT_BOOLEAN(0, "error-unmatch", &error_unmatch,
502                         N_("if any <file> is not in the index, treat this as an error")),
503                 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
504                         N_("pretend that paths removed since <tree-ish> are still present")),
505                 OPT__ABBREV(&abbrev),
506                 OPT_BOOLEAN(0, "debug", &debug_mode, N_("show debugging data")),
507                 OPT_END()
508         };
509
510         if (argc == 2 && !strcmp(argv[1], "-h"))
511                 usage_with_options(ls_files_usage, builtin_ls_files_options);
512
513         memset(&dir, 0, sizeof(dir));
514         prefix = cmd_prefix;
515         if (prefix)
516                 prefix_len = strlen(prefix);
517         git_config(git_default_config, NULL);
518
519         if (read_cache() < 0)
520                 die("index file corrupt");
521
522         argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
523                         ls_files_usage, 0);
524         el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
525         for (i = 0; i < exclude_list.nr; i++) {
526                 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
527         }
528         if (show_tag || show_valid_bit) {
529                 tag_cached = "H ";
530                 tag_unmerged = "M ";
531                 tag_removed = "R ";
532                 tag_modified = "C ";
533                 tag_other = "? ";
534                 tag_killed = "K ";
535                 tag_skip_worktree = "S ";
536                 tag_resolve_undo = "U ";
537         }
538         if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
539                 require_work_tree = 1;
540         if (show_unmerged)
541                 /*
542                  * There's no point in showing unmerged unless
543                  * you also show the stage information.
544                  */
545                 show_stage = 1;
546         if (dir.exclude_per_dir)
547                 exc_given = 1;
548
549         if (require_work_tree && !is_inside_work_tree())
550                 setup_work_tree();
551
552         pathspec = get_pathspec(prefix, argv);
553
554         /* be nice with submodule paths ending in a slash */
555         if (pathspec)
556                 strip_trailing_slash_from_submodules();
557
558         /* Find common prefix for all pathspec's */
559         max_prefix = common_prefix(pathspec);
560         max_prefix_len = max_prefix ? strlen(max_prefix) : 0;
561
562         /* Treat unmatching pathspec elements as errors */
563         if (pathspec && error_unmatch) {
564                 int num;
565                 for (num = 0; pathspec[num]; num++)
566                         ;
567                 ps_matched = xcalloc(1, num);
568         }
569
570         if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
571                 die("ls-files --ignored needs some exclude pattern");
572
573         /* With no flags, we default to showing the cached files */
574         if (!(show_stage | show_deleted | show_others | show_unmerged |
575               show_killed | show_modified | show_resolve_undo))
576                 show_cached = 1;
577
578         if (max_prefix)
579                 prune_cache(max_prefix);
580         if (with_tree) {
581                 /*
582                  * Basic sanity check; show-stages and show-unmerged
583                  * would not make any sense with this option.
584                  */
585                 if (show_stage || show_unmerged)
586                         die("ls-files --with-tree is incompatible with -s or -u");
587                 overlay_tree_on_cache(with_tree, max_prefix);
588         }
589         show_files(&dir);
590         if (show_resolve_undo)
591                 show_ru_info();
592
593         if (ps_matched) {
594                 int bad;
595                 bad = report_path_error(ps_matched, pathspec, prefix);
596                 if (bad)
597                         fprintf(stderr, "Did you forget to 'git add'?\n");
598
599                 return bad ? 1 : 0;
600         }
601
602         return 0;
603 }