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.
6 * Copyright (C) Linus Torvalds, 2005
8 #define NO_THE_INDEX_COMPATIBILITY_MACROS
10 #include "repository.h"
16 #include "parse-options.h"
17 #include "resolve-undo.h"
18 #include "string-list.h"
20 #include "run-command.h"
21 #include "submodule.h"
22 #include "submodule-config.h"
25 static int show_deleted
;
26 static int show_cached
;
27 static int show_others
;
28 static int show_stage
;
29 static int show_unmerged
;
30 static int show_resolve_undo
;
31 static int show_modified
;
32 static int show_killed
;
33 static int show_valid_bit
;
34 static int line_terminator
= '\n';
35 static int debug_mode
;
37 static int recurse_submodules
;
39 static const char *prefix
;
40 static int max_prefix_len
;
41 static int prefix_len
;
42 static struct pathspec pathspec
;
43 static int error_unmatch
;
44 static char *ps_matched
;
45 static const char *with_tree
;
47 static int exclude_args
;
49 static const char *tag_cached
= "";
50 static const char *tag_unmerged
= "";
51 static const char *tag_removed
= "";
52 static const char *tag_other
= "";
53 static const char *tag_killed
= "";
54 static const char *tag_modified
= "";
55 static const char *tag_skip_worktree
= "";
56 static const char *tag_resolve_undo
= "";
58 static void write_eolinfo(const struct index_state
*istate
,
59 const struct cache_entry
*ce
, const char *path
)
63 const char *i_txt
= "";
64 const char *w_txt
= "";
65 const char *a_txt
= get_convert_attr_ascii(path
);
66 if (ce
&& S_ISREG(ce
->ce_mode
))
67 i_txt
= get_cached_convert_stats_ascii(istate
,
69 if (!lstat(path
, &st
) && S_ISREG(st
.st_mode
))
70 w_txt
= get_wt_convert_stats_ascii(path
);
71 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt
, w_txt
, a_txt
);
75 static void write_name(const char *name
)
78 * With "--full-name", prefix_len=0; this caller needs to pass
79 * an empty string in that case (a NULL is good for "").
81 write_name_quoted_relative(name
, prefix_len
? prefix
: NULL
,
82 stdout
, line_terminator
);
85 static const char *get_tag(const struct cache_entry
*ce
, const char *tag
)
87 static char alttag
[4];
89 if (tag
&& *tag
&& show_valid_bit
&& (ce
->ce_flags
& CE_VALID
)) {
90 memcpy(alttag
, tag
, 3);
92 if (isalpha(tag
[0])) {
93 alttag
[0] = tolower(tag
[0]);
94 } else if (tag
[0] == '?') {
109 static void print_debug(const struct cache_entry
*ce
)
112 const struct stat_data
*sd
= &ce
->ce_stat_data
;
114 printf(" ctime: %d:%d\n", sd
->sd_ctime
.sec
, sd
->sd_ctime
.nsec
);
115 printf(" mtime: %d:%d\n", sd
->sd_mtime
.sec
, sd
->sd_mtime
.nsec
);
116 printf(" dev: %d\tino: %d\n", sd
->sd_dev
, sd
->sd_ino
);
117 printf(" uid: %d\tgid: %d\n", sd
->sd_uid
, sd
->sd_gid
);
118 printf(" size: %d\tflags: %x\n", sd
->sd_size
, ce
->ce_flags
);
122 static void show_dir_entry(const char *tag
, struct dir_entry
*ent
)
124 int len
= max_prefix_len
;
127 die("git ls-files: internal error - directory entry not superset of prefix");
129 if (!dir_path_match(ent
, &pathspec
, len
, ps_matched
))
133 write_eolinfo(NULL
, NULL
, ent
->name
);
134 write_name(ent
->name
);
137 static void show_other_files(const struct index_state
*istate
,
138 const struct dir_struct
*dir
)
142 for (i
= 0; i
< dir
->nr
; i
++) {
143 struct dir_entry
*ent
= dir
->entries
[i
];
144 if (!index_name_is_other(istate
, ent
->name
, ent
->len
))
146 show_dir_entry(tag_other
, ent
);
150 static void show_killed_files(const struct index_state
*istate
,
151 const struct dir_struct
*dir
)
154 for (i
= 0; i
< dir
->nr
; i
++) {
155 struct dir_entry
*ent
= dir
->entries
[i
];
157 int pos
, len
, killed
= 0;
159 for (cp
= ent
->name
; cp
- ent
->name
< ent
->len
; cp
= sp
+ 1) {
160 sp
= strchr(cp
, '/');
162 /* If ent->name is prefix of an entry in the
163 * cache, it will be killed.
165 pos
= index_name_pos(istate
, ent
->name
, ent
->len
);
167 die("BUG: killed-file %.*s not found",
168 ent
->len
, ent
->name
);
170 while (pos
< istate
->cache_nr
&&
171 ce_stage(istate
->cache
[pos
]))
172 pos
++; /* skip unmerged */
173 if (istate
->cache_nr
<= pos
)
175 /* pos points at a name immediately after
176 * ent->name in the cache. Does it expect
177 * ent->name to be a directory?
179 len
= ce_namelen(istate
->cache
[pos
]);
180 if ((ent
->len
< len
) &&
181 !strncmp(istate
->cache
[pos
]->name
,
182 ent
->name
, ent
->len
) &&
183 istate
->cache
[pos
]->name
[ent
->len
] == '/')
187 if (0 <= index_name_pos(istate
, ent
->name
, sp
- ent
->name
)) {
188 /* If any of the leading directories in
189 * ent->name is registered in the cache,
190 * ent->name will be killed.
197 show_dir_entry(tag_killed
, dir
->entries
[i
]);
201 static void show_files(struct repository
*repo
, struct dir_struct
*dir
);
203 static void show_submodule(struct repository
*superproject
,
204 struct dir_struct
*dir
, const char *path
)
206 struct repository submodule
;
208 if (repo_submodule_init(&submodule
, superproject
, path
))
211 if (repo_read_index(&submodule
) < 0)
212 die("index file corrupt");
214 show_files(&submodule
, dir
);
216 repo_clear(&submodule
);
219 static void show_ce(struct repository
*repo
, struct dir_struct
*dir
,
220 const struct cache_entry
*ce
, const char *fullname
,
223 if (max_prefix_len
> strlen(fullname
))
224 die("git ls-files: internal error - cache entry not superset of prefix");
226 if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
227 is_submodule_active(repo
, ce
->name
)) {
228 show_submodule(repo
, dir
, ce
->name
);
229 } else if (match_pathspec(&pathspec
, fullname
, strlen(fullname
),
230 max_prefix_len
, ps_matched
,
231 S_ISDIR(ce
->ce_mode
) ||
232 S_ISGITLINK(ce
->ce_mode
))) {
233 tag
= get_tag(ce
, tag
);
238 printf("%s%06o %s %d\t",
241 find_unique_abbrev(ce
->oid
.hash
, abbrev
),
244 write_eolinfo(repo
->index
, ce
, fullname
);
245 write_name(fullname
);
250 static void show_ru_info(const struct index_state
*istate
)
252 struct string_list_item
*item
;
254 if (!istate
->resolve_undo
)
257 for_each_string_list_item(item
, istate
->resolve_undo
) {
258 const char *path
= item
->string
;
259 struct resolve_undo_info
*ui
= item
->util
;
263 if (len
< max_prefix_len
)
264 continue; /* outside of the prefix */
265 if (!match_pathspec(&pathspec
, path
, len
,
266 max_prefix_len
, ps_matched
, 0))
267 continue; /* uninterested */
268 for (i
= 0; i
< 3; i
++) {
271 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
272 find_unique_abbrev(ui
->sha1
[i
], abbrev
),
279 static int ce_excluded(struct dir_struct
*dir
, struct index_state
*istate
,
280 const char *fullname
, const struct cache_entry
*ce
)
282 int dtype
= ce_to_dtype(ce
);
283 return is_excluded(dir
, istate
, fullname
, &dtype
);
286 static void construct_fullname(struct strbuf
*out
, const struct repository
*repo
,
287 const struct cache_entry
*ce
)
290 if (repo
->submodule_prefix
)
291 strbuf_addstr(out
, repo
->submodule_prefix
);
292 strbuf_addstr(out
, ce
->name
);
295 static void show_files(struct repository
*repo
, struct dir_struct
*dir
)
298 struct strbuf fullname
= STRBUF_INIT
;
300 /* For cached/deleted files we don't need to even do the readdir */
301 if (show_others
|| show_killed
) {
303 dir
->flags
|= DIR_COLLECT_KILLED_ONLY
;
304 fill_directory(dir
, repo
->index
, &pathspec
);
306 show_other_files(repo
->index
, dir
);
308 show_killed_files(repo
->index
, dir
);
310 if (show_cached
|| show_stage
) {
311 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
312 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
314 construct_fullname(&fullname
, repo
, ce
);
316 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
317 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
319 if (show_unmerged
&& !ce_stage(ce
))
321 if (ce
->ce_flags
& CE_UPDATE
)
323 show_ce(repo
, dir
, ce
, fullname
.buf
,
324 ce_stage(ce
) ? tag_unmerged
:
325 (ce_skip_worktree(ce
) ? tag_skip_worktree
:
329 if (show_deleted
|| show_modified
) {
330 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
331 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
335 construct_fullname(&fullname
, repo
, ce
);
337 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
338 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
340 if (ce
->ce_flags
& CE_UPDATE
)
342 if (ce_skip_worktree(ce
))
344 err
= lstat(fullname
.buf
, &st
);
345 if (show_deleted
&& err
)
346 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_removed
);
347 if (show_modified
&& ie_modified(repo
->index
, ce
, &st
, 0))
348 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_modified
);
352 strbuf_release(&fullname
);
356 * Prune the index to only contain stuff starting with "prefix"
358 static void prune_index(struct index_state
*istate
,
359 const char *prefix
, size_t prefixlen
)
362 unsigned int first
, last
;
364 if (!prefix
|| !istate
->cache_nr
)
366 pos
= index_name_pos(istate
, prefix
, prefixlen
);
370 last
= istate
->cache_nr
;
371 while (last
> first
) {
372 int next
= (last
+ first
) >> 1;
373 const struct cache_entry
*ce
= istate
->cache
[next
];
374 if (!strncmp(ce
->name
, prefix
, prefixlen
)) {
380 MOVE_ARRAY(istate
->cache
, istate
->cache
+ pos
, last
- pos
);
381 istate
->cache_nr
= last
- pos
;
384 static int get_common_prefix_len(const char *common_prefix
)
386 int common_prefix_len
;
391 common_prefix_len
= strlen(common_prefix
);
394 * If the prefix has a trailing slash, strip it so that submodules wont
395 * be pruned from the index.
397 if (common_prefix
[common_prefix_len
- 1] == '/')
400 return common_prefix_len
;
404 * Read the tree specified with --with-tree option
405 * (typically, HEAD) into stage #1 and then
406 * squash them down to stage #0. This is used for
407 * --error-unmatch to list and check the path patterns
408 * that were given from the command line. We are not
409 * going to write this index out.
411 void overlay_tree_on_index(struct index_state
*istate
,
412 const char *tree_name
, const char *prefix
)
415 struct object_id oid
;
416 struct pathspec pathspec
;
417 struct cache_entry
*last_stage0
= NULL
;
420 if (get_oid(tree_name
, &oid
))
421 die("tree-ish %s not found.", tree_name
);
422 tree
= parse_tree_indirect(&oid
);
424 die("bad tree-ish %s", tree_name
);
426 /* Hoist the unmerged entries up to stage #3 to make room */
427 for (i
= 0; i
< istate
->cache_nr
; i
++) {
428 struct cache_entry
*ce
= istate
->cache
[i
];
431 ce
->ce_flags
|= CE_STAGEMASK
;
435 static const char *(matchbuf
[1]);
437 parse_pathspec(&pathspec
, PATHSPEC_ALL_MAGIC
,
438 PATHSPEC_PREFER_CWD
, prefix
, matchbuf
);
440 memset(&pathspec
, 0, sizeof(pathspec
));
441 if (read_tree(tree
, 1, &pathspec
, istate
))
442 die("unable to read tree entries %s", tree_name
);
444 for (i
= 0; i
< istate
->cache_nr
; i
++) {
445 struct cache_entry
*ce
= istate
->cache
[i
];
446 switch (ce_stage(ce
)) {
454 * If there is stage #0 entry for this, we do not
455 * need to show it. We use CE_UPDATE bit to mark
459 !strcmp(last_stage0
->name
, ce
->name
))
460 ce
->ce_flags
|= CE_UPDATE
;
465 static const char * const ls_files_usage
[] = {
466 N_("git ls-files [<options>] [<file>...]"),
470 static int option_parse_exclude(const struct option
*opt
,
471 const char *arg
, int unset
)
473 struct string_list
*exclude_list
= opt
->value
;
476 string_list_append(exclude_list
, arg
);
481 static int option_parse_exclude_from(const struct option
*opt
,
482 const char *arg
, int unset
)
484 struct dir_struct
*dir
= opt
->value
;
487 add_excludes_from_file(dir
, arg
);
492 static int option_parse_exclude_standard(const struct option
*opt
,
493 const char *arg
, int unset
)
495 struct dir_struct
*dir
= opt
->value
;
498 setup_standard_excludes(dir
);
503 int cmd_ls_files(int argc
, const char **argv
, const char *cmd_prefix
)
505 int require_work_tree
= 0, show_tag
= 0, i
;
506 const char *max_prefix
;
507 struct dir_struct dir
;
508 struct exclude_list
*el
;
509 struct string_list exclude_list
= STRING_LIST_INIT_NODUP
;
510 struct option builtin_ls_files_options
[] = {
511 /* Think twice before adding "--nul" synonym to this */
512 OPT_SET_INT('z', NULL
, &line_terminator
,
513 N_("paths are separated with NUL character"), '\0'),
514 OPT_BOOL('t', NULL
, &show_tag
,
515 N_("identify the file status with tags")),
516 OPT_BOOL('v', NULL
, &show_valid_bit
,
517 N_("use lowercase letters for 'assume unchanged' files")),
518 OPT_BOOL('c', "cached", &show_cached
,
519 N_("show cached files in the output (default)")),
520 OPT_BOOL('d', "deleted", &show_deleted
,
521 N_("show deleted files in the output")),
522 OPT_BOOL('m', "modified", &show_modified
,
523 N_("show modified files in the output")),
524 OPT_BOOL('o', "others", &show_others
,
525 N_("show other files in the output")),
526 OPT_BIT('i', "ignored", &dir
.flags
,
527 N_("show ignored files in the output"),
529 OPT_BOOL('s', "stage", &show_stage
,
530 N_("show staged contents' object name in the output")),
531 OPT_BOOL('k', "killed", &show_killed
,
532 N_("show files on the filesystem that need to be removed")),
533 OPT_BIT(0, "directory", &dir
.flags
,
534 N_("show 'other' directories' names only"),
535 DIR_SHOW_OTHER_DIRECTORIES
),
536 OPT_BOOL(0, "eol", &show_eol
, N_("show line endings of files")),
537 OPT_NEGBIT(0, "empty-directory", &dir
.flags
,
538 N_("don't show empty directories"),
539 DIR_HIDE_EMPTY_DIRECTORIES
),
540 OPT_BOOL('u', "unmerged", &show_unmerged
,
541 N_("show unmerged files in the output")),
542 OPT_BOOL(0, "resolve-undo", &show_resolve_undo
,
543 N_("show resolve-undo information")),
544 { OPTION_CALLBACK
, 'x', "exclude", &exclude_list
, N_("pattern"),
545 N_("skip files matching pattern"),
546 0, option_parse_exclude
},
547 { OPTION_CALLBACK
, 'X', "exclude-from", &dir
, N_("file"),
548 N_("exclude patterns are read from <file>"),
549 0, option_parse_exclude_from
},
550 OPT_STRING(0, "exclude-per-directory", &dir
.exclude_per_dir
, N_("file"),
551 N_("read additional per-directory exclude patterns in <file>")),
552 { OPTION_CALLBACK
, 0, "exclude-standard", &dir
, NULL
,
553 N_("add the standard git exclusions"),
554 PARSE_OPT_NOARG
, option_parse_exclude_standard
},
555 { OPTION_SET_INT
, 0, "full-name", &prefix_len
, NULL
,
556 N_("make the output relative to the project top directory"),
557 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
},
558 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
559 N_("recurse through submodules")),
560 OPT_BOOL(0, "error-unmatch", &error_unmatch
,
561 N_("if any <file> is not in the index, treat this as an error")),
562 OPT_STRING(0, "with-tree", &with_tree
, N_("tree-ish"),
563 N_("pretend that paths removed since <tree-ish> are still present")),
564 OPT__ABBREV(&abbrev
),
565 OPT_BOOL(0, "debug", &debug_mode
, N_("show debugging data")),
569 if (argc
== 2 && !strcmp(argv
[1], "-h"))
570 usage_with_options(ls_files_usage
, builtin_ls_files_options
);
572 memset(&dir
, 0, sizeof(dir
));
575 prefix_len
= strlen(prefix
);
576 git_config(git_default_config
, NULL
);
578 if (repo_read_index(the_repository
) < 0)
579 die("index file corrupt");
581 argc
= parse_options(argc
, argv
, prefix
, builtin_ls_files_options
,
583 el
= add_exclude_list(&dir
, EXC_CMDL
, "--exclude option");
584 for (i
= 0; i
< exclude_list
.nr
; i
++) {
585 add_exclude(exclude_list
.items
[i
].string
, "", 0, el
, --exclude_args
);
587 if (show_tag
|| show_valid_bit
) {
594 tag_skip_worktree
= "S ";
595 tag_resolve_undo
= "U ";
597 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
598 require_work_tree
= 1;
601 * There's no point in showing unmerged unless
602 * you also show the stage information.
605 if (dir
.exclude_per_dir
)
608 if (require_work_tree
&& !is_inside_work_tree())
611 if (recurse_submodules
&&
612 (show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
613 show_killed
|| show_modified
|| show_resolve_undo
|| with_tree
))
614 die("ls-files --recurse-submodules unsupported mode");
616 if (recurse_submodules
&& error_unmatch
)
617 die("ls-files --recurse-submodules does not support "
620 parse_pathspec(&pathspec
, 0,
625 * Find common prefix for all pathspec's
626 * This is used as a performance optimization which unfortunately cannot
627 * be done when recursing into submodules because when a pathspec is
628 * given which spans repository boundaries you can't simply remove the
629 * submodule entry because the pathspec may match something inside the
632 if (recurse_submodules
)
635 max_prefix
= common_prefix(&pathspec
);
636 max_prefix_len
= get_common_prefix_len(max_prefix
);
638 prune_index(the_repository
->index
, max_prefix
, max_prefix_len
);
640 /* Treat unmatching pathspec elements as errors */
641 if (pathspec
.nr
&& error_unmatch
)
642 ps_matched
= xcalloc(pathspec
.nr
, 1);
644 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
645 die("ls-files --ignored needs some exclude pattern");
647 /* With no flags, we default to showing the cached files */
648 if (!(show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
649 show_killed
|| show_modified
|| show_resolve_undo
))
654 * Basic sanity check; show-stages and show-unmerged
655 * would not make any sense with this option.
657 if (show_stage
|| show_unmerged
)
658 die("ls-files --with-tree is incompatible with -s or -u");
659 overlay_tree_on_index(the_repository
->index
, with_tree
, max_prefix
);
662 show_files(the_repository
, &dir
);
664 if (show_resolve_undo
)
665 show_ru_info(the_repository
->index
);
669 bad
= report_path_error(ps_matched
, &pathspec
, prefix
);
671 fprintf(stderr
, "Did you forget to 'git add'?\n");