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"
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
;
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
;
39 static int exclude_args
;
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
= "";
50 static void write_name(const char *name
)
53 * With "--full-name", prefix_len=0; this caller needs to pass
54 * an empty string in that case (a NULL is good for "").
56 write_name_quoted_relative(name
, prefix_len
? prefix
: NULL
,
57 stdout
, line_terminator
);
60 static void show_dir_entry(const char *tag
, struct dir_entry
*ent
)
62 int len
= max_prefix_len
;
65 die("git ls-files: internal error - directory entry not superset of prefix");
67 if (!dir_path_match(ent
, &pathspec
, len
, ps_matched
))
71 write_name(ent
->name
);
74 static void show_other_files(struct dir_struct
*dir
)
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
))
82 show_dir_entry(tag_other
, ent
);
86 static void show_killed_files(struct dir_struct
*dir
)
89 for (i
= 0; i
< dir
->nr
; i
++) {
90 struct dir_entry
*ent
= dir
->entries
[i
];
92 int pos
, len
, killed
= 0;
94 for (cp
= ent
->name
; cp
- ent
->name
< ent
->len
; cp
= sp
+ 1) {
97 /* If ent->name is prefix of an entry in the
98 * cache, it will be killed.
100 pos
= cache_name_pos(ent
->name
, ent
->len
);
102 die("bug in show-killed-files");
104 while (pos
< active_nr
&&
105 ce_stage(active_cache
[pos
]))
106 pos
++; /* skip unmerged */
107 if (active_nr
<= pos
)
109 /* pos points at a name immediately after
110 * ent->name in the cache. Does it expect
111 * ent->name to be a directory?
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
] == '/')
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.
131 show_dir_entry(tag_killed
, dir
->entries
[i
]);
135 static void show_ce_entry(const char *tag
, const struct cache_entry
*ce
)
137 int len
= max_prefix_len
;
139 if (len
>= ce_namelen(ce
))
140 die("git ls-files: internal error - cache entry not superset of prefix");
142 if (!match_pathspec(&pathspec
, ce
->name
, ce_namelen(ce
),
146 if (tag
&& *tag
&& show_valid_bit
&&
147 (ce
->ce_flags
& CE_VALID
)) {
148 static char alttag
[4];
149 memcpy(alttag
, tag
, 3);
151 alttag
[0] = tolower(tag
[0]);
152 else if (tag
[0] == '?')
166 printf("%s%06o %s %d\t",
169 find_unique_abbrev(ce
->sha1
,abbrev
),
172 write_name(ce
->name
);
174 const struct stat_data
*sd
= &ce
->ce_stat_data
;
176 printf(" ctime: %d:%d\n", sd
->sd_ctime
.sec
, sd
->sd_ctime
.nsec
);
177 printf(" mtime: %d:%d\n", sd
->sd_mtime
.sec
, sd
->sd_mtime
.nsec
);
178 printf(" dev: %d\tino: %d\n", sd
->sd_dev
, sd
->sd_ino
);
179 printf(" uid: %d\tgid: %d\n", sd
->sd_uid
, sd
->sd_gid
);
180 printf(" size: %d\tflags: %x\n", sd
->sd_size
, ce
->ce_flags
);
184 static void show_ru_info(void)
186 struct string_list_item
*item
;
188 if (!the_index
.resolve_undo
)
191 for_each_string_list_item(item
, the_index
.resolve_undo
) {
192 const char *path
= item
->string
;
193 struct resolve_undo_info
*ui
= item
->util
;
197 if (len
< max_prefix_len
)
198 continue; /* outside of the prefix */
199 if (!match_pathspec(&pathspec
, path
, len
,
200 max_prefix_len
, ps_matched
))
201 continue; /* uninterested */
202 for (i
= 0; i
< 3; i
++) {
205 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
206 find_unique_abbrev(ui
->sha1
[i
], abbrev
),
213 static int ce_excluded(struct dir_struct
*dir
, const struct cache_entry
*ce
)
215 int dtype
= ce_to_dtype(ce
);
216 return is_excluded(dir
, ce
->name
, &dtype
);
219 static void show_files(struct dir_struct
*dir
)
223 /* For cached/deleted files we don't need to even do the readdir */
224 if (show_others
|| show_killed
) {
226 dir
->flags
|= DIR_COLLECT_KILLED_ONLY
;
227 fill_directory(dir
, &pathspec
);
229 show_other_files(dir
);
231 show_killed_files(dir
);
233 if (show_cached
|| show_stage
) {
234 for (i
= 0; i
< active_nr
; i
++) {
235 const struct cache_entry
*ce
= active_cache
[i
];
236 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
237 !ce_excluded(dir
, ce
))
239 if (show_unmerged
&& !ce_stage(ce
))
241 if (ce
->ce_flags
& CE_UPDATE
)
243 show_ce_entry(ce_stage(ce
) ? tag_unmerged
:
244 (ce_skip_worktree(ce
) ? tag_skip_worktree
: tag_cached
), ce
);
247 if (show_deleted
|| show_modified
) {
248 for (i
= 0; i
< active_nr
; i
++) {
249 const struct cache_entry
*ce
= active_cache
[i
];
252 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
253 !ce_excluded(dir
, ce
))
255 if (ce
->ce_flags
& CE_UPDATE
)
257 if (ce_skip_worktree(ce
))
259 err
= lstat(ce
->name
, &st
);
260 if (show_deleted
&& err
)
261 show_ce_entry(tag_removed
, ce
);
262 if (show_modified
&& ce_modified(ce
, &st
, 0))
263 show_ce_entry(tag_modified
, ce
);
269 * Prune the index to only contain stuff starting with "prefix"
271 static void prune_cache(const char *prefix
)
273 int pos
= cache_name_pos(prefix
, max_prefix_len
);
274 unsigned int first
, last
;
278 memmove(active_cache
, active_cache
+ pos
,
279 (active_nr
- pos
) * sizeof(struct cache_entry
*));
283 while (last
> first
) {
284 int next
= (last
+ first
) >> 1;
285 const struct cache_entry
*ce
= active_cache
[next
];
286 if (!strncmp(ce
->name
, prefix
, max_prefix_len
)) {
296 * Read the tree specified with --with-tree option
297 * (typically, HEAD) into stage #1 and then
298 * squash them down to stage #0. This is used for
299 * --error-unmatch to list and check the path patterns
300 * that were given from the command line. We are not
301 * going to write this index out.
303 void overlay_tree_on_cache(const char *tree_name
, const char *prefix
)
306 unsigned char sha1
[20];
307 struct pathspec pathspec
;
308 struct cache_entry
*last_stage0
= NULL
;
311 if (get_sha1(tree_name
, sha1
))
312 die("tree-ish %s not found.", tree_name
);
313 tree
= parse_tree_indirect(sha1
);
315 die("bad tree-ish %s", tree_name
);
317 /* Hoist the unmerged entries up to stage #3 to make room */
318 for (i
= 0; i
< active_nr
; i
++) {
319 struct cache_entry
*ce
= active_cache
[i
];
322 ce
->ce_flags
|= CE_STAGEMASK
;
326 static const char *(matchbuf
[1]);
328 parse_pathspec(&pathspec
, PATHSPEC_ALL_MAGIC
,
329 PATHSPEC_PREFER_CWD
, prefix
, matchbuf
);
331 memset(&pathspec
, 0, sizeof(pathspec
));
332 if (read_tree(tree
, 1, &pathspec
))
333 die("unable to read tree entries %s", tree_name
);
335 for (i
= 0; i
< active_nr
; i
++) {
336 struct cache_entry
*ce
= active_cache
[i
];
337 switch (ce_stage(ce
)) {
345 * If there is stage #0 entry for this, we do not
346 * need to show it. We use CE_UPDATE bit to mark
350 !strcmp(last_stage0
->name
, ce
->name
))
351 ce
->ce_flags
|= CE_UPDATE
;
356 int report_path_error(const char *ps_matched
,
357 const struct pathspec
*pathspec
,
361 * Make sure all pathspec matched; otherwise it is an error.
363 struct strbuf sb
= STRBUF_INIT
;
365 for (num
= 0; num
< pathspec
->nr
; num
++) {
366 int other
, found_dup
;
371 * The caller might have fed identical pathspec
372 * twice. Do not barf on such a mistake.
373 * FIXME: parse_pathspec should have eliminated
374 * duplicate pathspec.
376 for (found_dup
= other
= 0;
377 !found_dup
&& other
< pathspec
->nr
;
379 if (other
== num
|| !ps_matched
[other
])
381 if (!strcmp(pathspec
->items
[other
].original
,
382 pathspec
->items
[num
].original
))
384 * Ok, we have a match already.
391 error("pathspec '%s' did not match any file(s) known to git.",
392 pathspec
->items
[num
].original
);
399 static const char * const ls_files_usage
[] = {
400 N_("git ls-files [options] [<file>...]"),
404 static int option_parse_z(const struct option
*opt
,
405 const char *arg
, int unset
)
407 line_terminator
= unset
? '\n' : '\0';
412 static int option_parse_exclude(const struct option
*opt
,
413 const char *arg
, int unset
)
415 struct string_list
*exclude_list
= opt
->value
;
418 string_list_append(exclude_list
, arg
);
423 static int option_parse_exclude_from(const struct option
*opt
,
424 const char *arg
, int unset
)
426 struct dir_struct
*dir
= opt
->value
;
429 add_excludes_from_file(dir
, arg
);
434 static int option_parse_exclude_standard(const struct option
*opt
,
435 const char *arg
, int unset
)
437 struct dir_struct
*dir
= opt
->value
;
440 setup_standard_excludes(dir
);
445 int cmd_ls_files(int argc
, const char **argv
, const char *cmd_prefix
)
447 int require_work_tree
= 0, show_tag
= 0, i
;
448 const char *max_prefix
;
449 struct dir_struct dir
;
450 struct exclude_list
*el
;
451 struct string_list exclude_list
= STRING_LIST_INIT_NODUP
;
452 struct option builtin_ls_files_options
[] = {
453 { OPTION_CALLBACK
, 'z', NULL
, NULL
, NULL
,
454 N_("paths are separated with NUL character"),
455 PARSE_OPT_NOARG
, option_parse_z
},
456 OPT_BOOL('t', NULL
, &show_tag
,
457 N_("identify the file status with tags")),
458 OPT_BOOL('v', NULL
, &show_valid_bit
,
459 N_("use lowercase letters for 'assume unchanged' files")),
460 OPT_BOOL('c', "cached", &show_cached
,
461 N_("show cached files in the output (default)")),
462 OPT_BOOL('d', "deleted", &show_deleted
,
463 N_("show deleted files in the output")),
464 OPT_BOOL('m', "modified", &show_modified
,
465 N_("show modified files in the output")),
466 OPT_BOOL('o', "others", &show_others
,
467 N_("show other files in the output")),
468 OPT_BIT('i', "ignored", &dir
.flags
,
469 N_("show ignored files in the output"),
471 OPT_BOOL('s', "stage", &show_stage
,
472 N_("show staged contents' object name in the output")),
473 OPT_BOOL('k', "killed", &show_killed
,
474 N_("show files on the filesystem that need to be removed")),
475 OPT_BIT(0, "directory", &dir
.flags
,
476 N_("show 'other' directories' name only"),
477 DIR_SHOW_OTHER_DIRECTORIES
),
478 OPT_NEGBIT(0, "empty-directory", &dir
.flags
,
479 N_("don't show empty directories"),
480 DIR_HIDE_EMPTY_DIRECTORIES
),
481 OPT_BOOL('u', "unmerged", &show_unmerged
,
482 N_("show unmerged files in the output")),
483 OPT_BOOL(0, "resolve-undo", &show_resolve_undo
,
484 N_("show resolve-undo information")),
485 { OPTION_CALLBACK
, 'x', "exclude", &exclude_list
, N_("pattern"),
486 N_("skip files matching pattern"),
487 0, option_parse_exclude
},
488 { OPTION_CALLBACK
, 'X', "exclude-from", &dir
, N_("file"),
489 N_("exclude patterns are read from <file>"),
490 0, option_parse_exclude_from
},
491 OPT_STRING(0, "exclude-per-directory", &dir
.exclude_per_dir
, N_("file"),
492 N_("read additional per-directory exclude patterns in <file>")),
493 { OPTION_CALLBACK
, 0, "exclude-standard", &dir
, NULL
,
494 N_("add the standard git exclusions"),
495 PARSE_OPT_NOARG
, option_parse_exclude_standard
},
496 { OPTION_SET_INT
, 0, "full-name", &prefix_len
, NULL
,
497 N_("make the output relative to the project top directory"),
498 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
},
499 OPT_BOOL(0, "error-unmatch", &error_unmatch
,
500 N_("if any <file> is not in the index, treat this as an error")),
501 OPT_STRING(0, "with-tree", &with_tree
, N_("tree-ish"),
502 N_("pretend that paths removed since <tree-ish> are still present")),
503 OPT__ABBREV(&abbrev
),
504 OPT_BOOL(0, "debug", &debug_mode
, N_("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 el
= add_exclude_list(&dir
, EXC_CMDL
, "--exclude option");
523 for (i
= 0; i
< exclude_list
.nr
; i
++) {
524 add_exclude(exclude_list
.items
[i
].string
, "", 0, el
, --exclude_args
);
526 if (show_tag
|| show_valid_bit
) {
533 tag_skip_worktree
= "S ";
534 tag_resolve_undo
= "U ";
536 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
537 require_work_tree
= 1;
540 * There's no point in showing unmerged unless
541 * you also show the stage information.
544 if (dir
.exclude_per_dir
)
547 if (require_work_tree
&& !is_inside_work_tree())
550 parse_pathspec(&pathspec
, 0,
551 PATHSPEC_PREFER_CWD
|
552 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP
,
555 /* Find common prefix for all pathspec's */
556 max_prefix
= common_prefix(&pathspec
);
557 max_prefix_len
= max_prefix
? strlen(max_prefix
) : 0;
559 /* Treat unmatching pathspec elements as errors */
560 if (pathspec
.nr
&& error_unmatch
)
561 ps_matched
= xcalloc(1, pathspec
.nr
);
563 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
564 die("ls-files --ignored needs some exclude pattern");
566 /* With no flags, we default to showing the cached files */
567 if (!(show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
568 show_killed
|| show_modified
|| show_resolve_undo
))
572 prune_cache(max_prefix
);
575 * Basic sanity check; show-stages and show-unmerged
576 * would not make any sense with this option.
578 if (show_stage
|| show_unmerged
)
579 die("ls-files --with-tree is incompatible with -s or -u");
580 overlay_tree_on_cache(with_tree
, max_prefix
);
583 if (show_resolve_undo
)
588 bad
= report_path_error(ps_matched
, &pathspec
, prefix
);
590 fprintf(stderr
, "Did you forget to 'git add'?\n");