Doc/checkout: checking out using @{-N} can lead to detached state
[git/debian.git] / builtin / ls-tree.c
blobd7ebeb4ce6b1f1a0491f8db8a66001968a41b641
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "blob.h"
8 #include "tree.h"
9 #include "commit.h"
10 #include "quote.h"
11 #include "builtin.h"
12 #include "parse-options.h"
13 #include "pathspec.h"
15 static int line_termination = '\n';
16 #define LS_RECURSIVE 1
17 #define LS_TREE_ONLY 2
18 #define LS_SHOW_TREES 4
19 #define LS_NAME_ONLY 8
20 #define LS_SHOW_SIZE 16
21 static int abbrev;
22 static int ls_options;
23 static struct pathspec pathspec;
24 static int chomp_prefix;
25 static const char *ls_tree_prefix;
27 static const char * const ls_tree_usage[] = {
28 N_("git ls-tree [<options>] <tree-ish> [<path>...]"),
29 NULL
32 static int show_recursive(const char *base, int baselen, const char *pathname)
34 int i;
36 if (ls_options & LS_RECURSIVE)
37 return 1;
39 if (!pathspec.nr)
40 return 0;
42 for (i = 0; i < pathspec.nr; i++) {
43 const char *spec = pathspec.items[i].match;
44 int len, speclen;
46 if (strncmp(base, spec, baselen))
47 continue;
48 len = strlen(pathname);
49 spec += baselen;
50 speclen = strlen(spec);
51 if (speclen <= len)
52 continue;
53 if (spec[len] && spec[len] != '/')
54 continue;
55 if (memcmp(pathname, spec, len))
56 continue;
57 return 1;
59 return 0;
62 static int show_tree(const unsigned char *sha1, struct strbuf *base,
63 const char *pathname, unsigned mode, int stage, void *context)
65 int retval = 0;
66 int baselen;
67 const char *type = blob_type;
69 if (S_ISGITLINK(mode)) {
71 * Maybe we want to have some recursive version here?
73 * Something similar to this incomplete example:
75 if (show_subprojects(base, baselen, pathname))
76 retval = READ_TREE_RECURSIVE;
79 type = commit_type;
80 } else if (S_ISDIR(mode)) {
81 if (show_recursive(base->buf, base->len, pathname)) {
82 retval = READ_TREE_RECURSIVE;
83 if (!(ls_options & LS_SHOW_TREES))
84 return retval;
86 type = tree_type;
88 else if (ls_options & LS_TREE_ONLY)
89 return 0;
91 if (!(ls_options & LS_NAME_ONLY)) {
92 if (ls_options & LS_SHOW_SIZE) {
93 char size_text[24];
94 if (!strcmp(type, blob_type)) {
95 unsigned long size;
96 if (sha1_object_info(sha1, &size) == OBJ_BAD)
97 xsnprintf(size_text, sizeof(size_text),
98 "BAD");
99 else
100 xsnprintf(size_text, sizeof(size_text),
101 "%lu", size);
102 } else
103 xsnprintf(size_text, sizeof(size_text), "-");
104 printf("%06o %s %s %7s\t", mode, type,
105 find_unique_abbrev(sha1, abbrev),
106 size_text);
107 } else
108 printf("%06o %s %s\t", mode, type,
109 find_unique_abbrev(sha1, abbrev));
111 baselen = base->len;
112 strbuf_addstr(base, pathname);
113 write_name_quoted_relative(base->buf,
114 chomp_prefix ? ls_tree_prefix : NULL,
115 stdout, line_termination);
116 strbuf_setlen(base, baselen);
117 return retval;
120 int cmd_ls_tree(int argc, const char **argv, const char *prefix)
122 unsigned char sha1[20];
123 struct tree *tree;
124 int i, full_tree = 0;
125 const struct option ls_tree_options[] = {
126 OPT_BIT('d', NULL, &ls_options, N_("only show trees"),
127 LS_TREE_ONLY),
128 OPT_BIT('r', NULL, &ls_options, N_("recurse into subtrees"),
129 LS_RECURSIVE),
130 OPT_BIT('t', NULL, &ls_options, N_("show trees when recursing"),
131 LS_SHOW_TREES),
132 OPT_SET_INT('z', NULL, &line_termination,
133 N_("terminate entries with NUL byte"), 0),
134 OPT_BIT('l', "long", &ls_options, N_("include object size"),
135 LS_SHOW_SIZE),
136 OPT_BIT(0, "name-only", &ls_options, N_("list only filenames"),
137 LS_NAME_ONLY),
138 OPT_BIT(0, "name-status", &ls_options, N_("list only filenames"),
139 LS_NAME_ONLY),
140 OPT_SET_INT(0, "full-name", &chomp_prefix,
141 N_("use full path names"), 0),
142 OPT_BOOL(0, "full-tree", &full_tree,
143 N_("list entire tree; not just current directory "
144 "(implies --full-name)")),
145 OPT__ABBREV(&abbrev),
146 OPT_END()
149 git_config(git_default_config, NULL);
150 ls_tree_prefix = prefix;
151 if (prefix && *prefix)
152 chomp_prefix = strlen(prefix);
154 argc = parse_options(argc, argv, prefix, ls_tree_options,
155 ls_tree_usage, 0);
156 if (full_tree) {
157 ls_tree_prefix = prefix = NULL;
158 chomp_prefix = 0;
160 /* -d -r should imply -t, but -d by itself should not have to. */
161 if ( (LS_TREE_ONLY|LS_RECURSIVE) ==
162 ((LS_TREE_ONLY|LS_RECURSIVE) & ls_options))
163 ls_options |= LS_SHOW_TREES;
165 if (argc < 1)
166 usage_with_options(ls_tree_usage, ls_tree_options);
167 if (get_sha1(argv[0], sha1))
168 die("Not a valid object name %s", argv[0]);
171 * show_recursive() rolls its own matching code and is
172 * generally ignorant of 'struct pathspec'. The magic mask
173 * cannot be lifted until it is converted to use
174 * match_pathspec() or tree_entry_interesting()
176 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC &
177 ~(PATHSPEC_FROMTOP | PATHSPEC_LITERAL),
178 PATHSPEC_PREFER_CWD,
179 prefix, argv + 1);
180 for (i = 0; i < pathspec.nr; i++)
181 pathspec.items[i].nowildcard_len = pathspec.items[i].len;
182 pathspec.has_wildcard = 0;
183 tree = parse_tree_indirect(sha1);
184 if (!tree)
185 die("not a tree object");
186 return !!read_tree_recursive(tree, "", 0, 0, &pathspec, show_tree, NULL);