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
13 #include "parse-options.h"
14 #include "resolve-undo.h"
15 #include "string-list.h"
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
;
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
;
39 static const char *tag_cached
= "";
40 static const char *tag_unmerged
= "";
41 static const char *tag_removed
= "";
42 static const char *tag_other
= "";
43 static const char *tag_killed
= "";
44 static const char *tag_modified
= "";
45 static const char *tag_skip_worktree
= "";
46 static const char *tag_resolve_undo
= "";
48 static void write_name(const char* name
, size_t len
)
50 write_name_quoted_relative(name
, len
, prefix
, prefix_len
, stdout
,
54 static void show_dir_entry(const char *tag
, struct dir_entry
*ent
)
56 int len
= max_prefix_len
;
59 die("git ls-files: internal error - directory entry not superset of prefix");
61 if (!match_pathspec(pathspec
, ent
->name
, ent
->len
, len
, ps_matched
))
65 write_name(ent
->name
, ent
->len
);
68 static void show_other_files(struct dir_struct
*dir
)
72 for (i
= 0; i
< dir
->nr
; i
++) {
73 struct dir_entry
*ent
= dir
->entries
[i
];
74 if (!cache_name_is_other(ent
->name
, ent
->len
))
76 show_dir_entry(tag_other
, ent
);
80 static void show_killed_files(struct dir_struct
*dir
)
83 for (i
= 0; i
< dir
->nr
; i
++) {
84 struct dir_entry
*ent
= dir
->entries
[i
];
86 int pos
, len
, killed
= 0;
88 for (cp
= ent
->name
; cp
- ent
->name
< ent
->len
; cp
= sp
+ 1) {
91 /* If ent->name is prefix of an entry in the
92 * cache, it will be killed.
94 pos
= cache_name_pos(ent
->name
, ent
->len
);
96 die("bug in show-killed-files");
98 while (pos
< active_nr
&&
99 ce_stage(active_cache
[pos
]))
100 pos
++; /* skip unmerged */
101 if (active_nr
<= pos
)
103 /* pos points at a name immediately after
104 * ent->name in the cache. Does it expect
105 * ent->name to be a directory?
107 len
= ce_namelen(active_cache
[pos
]);
108 if ((ent
->len
< len
) &&
109 !strncmp(active_cache
[pos
]->name
,
110 ent
->name
, ent
->len
) &&
111 active_cache
[pos
]->name
[ent
->len
] == '/')
115 if (0 <= cache_name_pos(ent
->name
, sp
- ent
->name
)) {
116 /* If any of the leading directories in
117 * ent->name is registered in the cache,
118 * ent->name will be killed.
125 show_dir_entry(tag_killed
, dir
->entries
[i
]);
129 static void show_ce_entry(const char *tag
, struct cache_entry
*ce
)
131 int len
= max_prefix_len
;
133 if (len
>= ce_namelen(ce
))
134 die("git ls-files: internal error - cache entry not superset of prefix");
136 if (!match_pathspec(pathspec
, ce
->name
, ce_namelen(ce
), len
, ps_matched
))
139 if (tag
&& *tag
&& show_valid_bit
&&
140 (ce
->ce_flags
& CE_VALID
)) {
141 static char alttag
[4];
142 memcpy(alttag
, tag
, 3);
144 alttag
[0] = tolower(tag
[0]);
145 else if (tag
[0] == '?')
159 printf("%s%06o %s %d\t",
162 find_unique_abbrev(ce
->sha1
,abbrev
),
165 write_name(ce
->name
, ce_namelen(ce
));
167 printf(" ctime: %d:%d\n", ce
->ce_ctime
.sec
, ce
->ce_ctime
.nsec
);
168 printf(" mtime: %d:%d\n", ce
->ce_mtime
.sec
, ce
->ce_mtime
.nsec
);
169 printf(" dev: %d\tino: %d\n", ce
->ce_dev
, ce
->ce_ino
);
170 printf(" uid: %d\tgid: %d\n", ce
->ce_uid
, ce
->ce_gid
);
171 printf(" size: %d\tflags: %x\n", ce
->ce_size
, ce
->ce_flags
);
175 static void show_ru_info(void)
177 struct string_list_item
*item
;
179 if (!the_index
.resolve_undo
)
182 for_each_string_list_item(item
, the_index
.resolve_undo
) {
183 const char *path
= item
->string
;
184 struct resolve_undo_info
*ui
= item
->util
;
188 if (len
< max_prefix_len
)
189 continue; /* outside of the prefix */
190 if (!match_pathspec(pathspec
, path
, len
, max_prefix_len
, ps_matched
))
191 continue; /* uninterested */
192 for (i
= 0; i
< 3; i
++) {
195 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
196 find_unique_abbrev(ui
->sha1
[i
], abbrev
),
198 write_name(path
, len
);
203 static void show_files(struct dir_struct
*dir
)
206 struct path_exclude_check check
;
208 if ((dir
->flags
& DIR_SHOW_IGNORED
))
209 path_exclude_check_init(&check
, dir
);
211 /* For cached/deleted files we don't need to even do the readdir */
212 if (show_others
|| show_killed
) {
213 fill_directory(dir
, pathspec
);
215 show_other_files(dir
);
217 show_killed_files(dir
);
219 if (show_cached
| show_stage
) {
220 for (i
= 0; i
< active_nr
; i
++) {
221 struct cache_entry
*ce
= active_cache
[i
];
222 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
223 !path_excluded(&check
, ce
))
225 if (show_unmerged
&& !ce_stage(ce
))
227 if (ce
->ce_flags
& CE_UPDATE
)
229 show_ce_entry(ce_stage(ce
) ? tag_unmerged
:
230 (ce_skip_worktree(ce
) ? tag_skip_worktree
: tag_cached
), ce
);
233 if (show_deleted
| show_modified
) {
234 for (i
= 0; i
< active_nr
; i
++) {
235 struct cache_entry
*ce
= active_cache
[i
];
238 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
239 !path_excluded(&check
, ce
))
241 if (ce
->ce_flags
& CE_UPDATE
)
243 if (ce_skip_worktree(ce
))
245 err
= lstat(ce
->name
, &st
);
246 if (show_deleted
&& err
)
247 show_ce_entry(tag_removed
, ce
);
248 if (show_modified
&& ce_modified(ce
, &st
, 0))
249 show_ce_entry(tag_modified
, ce
);
253 if ((dir
->flags
& DIR_SHOW_IGNORED
))
254 path_exclude_check_clear(&check
);
258 * Prune the index to only contain stuff starting with "prefix"
260 static void prune_cache(const char *prefix
)
262 int pos
= cache_name_pos(prefix
, max_prefix_len
);
263 unsigned int first
, last
;
267 memmove(active_cache
, active_cache
+ pos
,
268 (active_nr
- pos
) * sizeof(struct cache_entry
*));
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
)) {
284 static void strip_trailing_slash_from_submodules(void)
288 for (p
= pathspec
; *p
!= NULL
; p
++) {
289 int len
= strlen(*p
), pos
;
291 if (len
< 1 || (*p
)[len
- 1] != '/')
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);
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.
307 void overlay_tree_on_cache(const char *tree_name
, const char *prefix
)
310 unsigned char sha1
[20];
311 struct pathspec pathspec
;
312 struct cache_entry
*last_stage0
= NULL
;
315 if (get_sha1(tree_name
, sha1
))
316 die("tree-ish %s not found.", tree_name
);
317 tree
= parse_tree_indirect(sha1
);
319 die("bad tree-ish %s", tree_name
);
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
];
326 ce
->ce_flags
|= CE_STAGEMASK
;
330 static const char *(matchbuf
[2]);
331 matchbuf
[0] = prefix
;
333 init_pathspec(&pathspec
, matchbuf
);
334 pathspec
.items
[0].use_wildcard
= 0;
336 init_pathspec(&pathspec
, NULL
);
337 if (read_tree(tree
, 1, &pathspec
))
338 die("unable to read tree entries %s", tree_name
);
340 for (i
= 0; i
< active_nr
; i
++) {
341 struct cache_entry
*ce
= active_cache
[i
];
342 switch (ce_stage(ce
)) {
350 * If there is stage #0 entry for this, we do not
351 * need to show it. We use CE_UPDATE bit to mark
355 !strcmp(last_stage0
->name
, ce
->name
))
356 ce
->ce_flags
|= CE_UPDATE
;
361 int report_path_error(const char *ps_matched
, const char **pathspec
, const char *prefix
)
364 * Make sure all pathspec matched; otherwise it is an error.
366 struct strbuf sb
= STRBUF_INIT
;
369 for (num
= 0; pathspec
[num
]; num
++) {
370 int other
, found_dup
;
375 * The caller might have fed identical pathspec
376 * twice. Do not barf on such a mistake.
378 for (found_dup
= other
= 0;
379 !found_dup
&& pathspec
[other
];
381 if (other
== num
|| !ps_matched
[other
])
383 if (!strcmp(pathspec
[other
], pathspec
[num
]))
385 * Ok, we have a match already.
392 name
= quote_path_relative(pathspec
[num
], -1, &sb
, prefix
);
393 error("pathspec '%s' did not match any file(s) known to git.",
401 static const char * const ls_files_usage
[] = {
402 "git ls-files [options] [<file>...]",
406 static int option_parse_z(const struct option
*opt
,
407 const char *arg
, int unset
)
409 line_terminator
= unset
? '\n' : '\0';
414 static int option_parse_exclude(const struct option
*opt
,
415 const char *arg
, int unset
)
417 struct exclude_list
*list
= opt
->value
;
420 add_exclude(arg
, "", 0, list
);
425 static int option_parse_exclude_from(const struct option
*opt
,
426 const char *arg
, int unset
)
428 struct dir_struct
*dir
= opt
->value
;
431 add_excludes_from_file(dir
, arg
);
436 static int option_parse_exclude_standard(const struct option
*opt
,
437 const char *arg
, int unset
)
439 struct dir_struct
*dir
= opt
->value
;
442 setup_standard_excludes(dir
);
447 int cmd_ls_files(int argc
, const char **argv
, const char *cmd_prefix
)
449 int require_work_tree
= 0, show_tag
= 0;
450 const char *max_prefix
;
451 struct dir_struct dir
;
452 struct option builtin_ls_files_options
[] = {
453 { OPTION_CALLBACK
, 'z', NULL
, NULL
, NULL
,
454 "paths are separated with NUL character",
455 PARSE_OPT_NOARG
, option_parse_z
},
456 OPT_BOOLEAN('t', NULL
, &show_tag
,
457 "identify the file status with tags"),
458 OPT_BOOLEAN('v', NULL
, &show_valid_bit
,
459 "use lowercase letters for 'assume unchanged' files"),
460 OPT_BOOLEAN('c', "cached", &show_cached
,
461 "show cached files in the output (default)"),
462 OPT_BOOLEAN('d', "deleted", &show_deleted
,
463 "show deleted files in the output"),
464 OPT_BOOLEAN('m', "modified", &show_modified
,
465 "show modified files in the output"),
466 OPT_BOOLEAN('o', "others", &show_others
,
467 "show other files in the output"),
468 OPT_BIT('i', "ignored", &dir
.flags
,
469 "show ignored files in the output",
471 OPT_BOOLEAN('s', "stage", &show_stage
,
472 "show staged contents' object name in the output"),
473 OPT_BOOLEAN('k', "killed", &show_killed
,
474 "show files on the filesystem that need to be removed"),
475 OPT_BIT(0, "directory", &dir
.flags
,
476 "show 'other' directories' name only",
477 DIR_SHOW_OTHER_DIRECTORIES
),
478 OPT_NEGBIT(0, "empty-directory", &dir
.flags
,
479 "don't show empty directories",
480 DIR_HIDE_EMPTY_DIRECTORIES
),
481 OPT_BOOLEAN('u', "unmerged", &show_unmerged
,
482 "show unmerged files in the output"),
483 OPT_BOOLEAN(0, "resolve-undo", &show_resolve_undo
,
484 "show resolve-undo information"),
485 { OPTION_CALLBACK
, 'x', "exclude", &dir
.exclude_list
[EXC_CMDL
], "pattern",
486 "skip files matching pattern",
487 0, option_parse_exclude
},
488 { OPTION_CALLBACK
, 'X', "exclude-from", &dir
, "file",
489 "exclude patterns are read from <file>",
490 0, option_parse_exclude_from
},
491 OPT_STRING(0, "exclude-per-directory", &dir
.exclude_per_dir
, "file",
492 "read additional per-directory exclude patterns in <file>"),
493 { OPTION_CALLBACK
, 0, "exclude-standard", &dir
, NULL
,
494 "add the standard git exclusions",
495 PARSE_OPT_NOARG
, option_parse_exclude_standard
},
496 { OPTION_SET_INT
, 0, "full-name", &prefix_len
, NULL
,
497 "make the output relative to the project top directory",
498 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
},
499 OPT_BOOLEAN(0, "error-unmatch", &error_unmatch
,
500 "if any <file> is not in the index, treat this as an error"),
501 OPT_STRING(0, "with-tree", &with_tree
, "tree-ish",
502 "pretend that paths removed since <tree-ish> are still present"),
503 OPT__ABBREV(&abbrev
),
504 OPT_BOOLEAN(0, "debug", &debug_mode
, "show debugging data"),
508 if (argc
== 2 && !strcmp(argv
[1], "-h"))
509 usage_with_options(ls_files_usage
, builtin_ls_files_options
);
511 memset(&dir
, 0, sizeof(dir
));
514 prefix_len
= strlen(prefix
);
515 git_config(git_default_config
, NULL
);
517 if (read_cache() < 0)
518 die("index file corrupt");
520 argc
= parse_options(argc
, argv
, prefix
, builtin_ls_files_options
,
522 if (show_tag
|| show_valid_bit
) {
529 tag_skip_worktree
= "S ";
530 tag_resolve_undo
= "U ";
532 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
533 require_work_tree
= 1;
536 * There's no point in showing unmerged unless
537 * you also show the stage information.
540 if (dir
.exclude_per_dir
)
543 if (require_work_tree
&& !is_inside_work_tree())
546 pathspec
= get_pathspec(prefix
, argv
);
548 /* be nice with submodule paths ending in a slash */
550 strip_trailing_slash_from_submodules();
552 /* Find common prefix for all pathspec's */
553 max_prefix
= common_prefix(pathspec
);
554 max_prefix_len
= max_prefix
? strlen(max_prefix
) : 0;
556 /* Treat unmatching pathspec elements as errors */
557 if (pathspec
&& error_unmatch
) {
559 for (num
= 0; pathspec
[num
]; num
++)
561 ps_matched
= xcalloc(1, num
);
564 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
565 die("ls-files --ignored needs some exclude pattern");
567 /* With no flags, we default to showing the cached files */
568 if (!(show_stage
| show_deleted
| show_others
| show_unmerged
|
569 show_killed
| show_modified
| show_resolve_undo
))
573 prune_cache(max_prefix
);
576 * Basic sanity check; show-stages and show-unmerged
577 * would not make any sense with this option.
579 if (show_stage
|| show_unmerged
)
580 die("ls-files --with-tree is incompatible with -s or -u");
581 overlay_tree_on_cache(with_tree
, max_prefix
);
584 if (show_resolve_undo
)
589 bad
= report_path_error(ps_matched
, pathspec
, prefix
);
591 fprintf(stderr
, "Did you forget to 'git add'?\n");