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