Merge branch 'pb/opt-cmdmode-doc' into maint
[git] / builtin / ls-tree.c
1 /*
2  * GIT - The information manager from hell
3  *
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"
14
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;
26
27 static const  char * const ls_tree_usage[] = {
28         N_("git ls-tree [<options>] <tree-ish> [<path>...]"),
29         NULL
30 };
31
32 static int show_recursive(const char *base, int baselen, const char *pathname)
33 {
34         const char **s;
35
36         if (ls_options & LS_RECURSIVE)
37                 return 1;
38
39         s = pathspec._raw;
40         if (!s)
41                 return 0;
42
43         for (;;) {
44                 const char *spec = *s++;
45                 int len, speclen;
46
47                 if (!spec)
48                         return 0;
49                 if (strncmp(base, spec, baselen))
50                         continue;
51                 len = strlen(pathname);
52                 spec += baselen;
53                 speclen = strlen(spec);
54                 if (speclen <= len)
55                         continue;
56                 if (spec[len] && spec[len] != '/')
57                         continue;
58                 if (memcmp(pathname, spec, len))
59                         continue;
60                 return 1;
61         }
62 }
63
64 static int show_tree(const unsigned char *sha1, struct strbuf *base,
65                 const char *pathname, unsigned mode, int stage, void *context)
66 {
67         int retval = 0;
68         int baselen;
69         const char *type = blob_type;
70
71         if (S_ISGITLINK(mode)) {
72                 /*
73                  * Maybe we want to have some recursive version here?
74                  *
75                  * Something similar to this incomplete example:
76                  *
77                 if (show_subprojects(base, baselen, pathname))
78                         retval = READ_TREE_RECURSIVE;
79                  *
80                  */
81                 type = commit_type;
82         } else if (S_ISDIR(mode)) {
83                 if (show_recursive(base->buf, base->len, pathname)) {
84                         retval = READ_TREE_RECURSIVE;
85                         if (!(ls_options & LS_SHOW_TREES))
86                                 return retval;
87                 }
88                 type = tree_type;
89         }
90         else if (ls_options & LS_TREE_ONLY)
91                 return 0;
92
93         if (!(ls_options & LS_NAME_ONLY)) {
94                 if (ls_options & LS_SHOW_SIZE) {
95                         char size_text[24];
96                         if (!strcmp(type, blob_type)) {
97                                 unsigned long size;
98                                 if (sha1_object_info(sha1, &size) == OBJ_BAD)
99                                         xsnprintf(size_text, sizeof(size_text),
100                                                   "BAD");
101                                 else
102                                         xsnprintf(size_text, sizeof(size_text),
103                                                   "%lu", size);
104                         } else
105                                 xsnprintf(size_text, sizeof(size_text), "-");
106                         printf("%06o %s %s %7s\t", mode, type,
107                                find_unique_abbrev(sha1, abbrev),
108                                size_text);
109                 } else
110                         printf("%06o %s %s\t", mode, type,
111                                find_unique_abbrev(sha1, abbrev));
112         }
113         baselen = base->len;
114         strbuf_addstr(base, pathname);
115         write_name_quoted_relative(base->buf,
116                                    chomp_prefix ? ls_tree_prefix : NULL,
117                                    stdout, line_termination);
118         strbuf_setlen(base, baselen);
119         return retval;
120 }
121
122 int cmd_ls_tree(int argc, const char **argv, const char *prefix)
123 {
124         unsigned char sha1[20];
125         struct tree *tree;
126         int i, full_tree = 0;
127         const struct option ls_tree_options[] = {
128                 OPT_BIT('d', NULL, &ls_options, N_("only show trees"),
129                         LS_TREE_ONLY),
130                 OPT_BIT('r', NULL, &ls_options, N_("recurse into subtrees"),
131                         LS_RECURSIVE),
132                 OPT_BIT('t', NULL, &ls_options, N_("show trees when recursing"),
133                         LS_SHOW_TREES),
134                 OPT_SET_INT('z', NULL, &line_termination,
135                             N_("terminate entries with NUL byte"), 0),
136                 OPT_BIT('l', "long", &ls_options, N_("include object size"),
137                         LS_SHOW_SIZE),
138                 OPT_BIT(0, "name-only", &ls_options, N_("list only filenames"),
139                         LS_NAME_ONLY),
140                 OPT_BIT(0, "name-status", &ls_options, N_("list only filenames"),
141                         LS_NAME_ONLY),
142                 OPT_SET_INT(0, "full-name", &chomp_prefix,
143                             N_("use full path names"), 0),
144                 OPT_BOOL(0, "full-tree", &full_tree,
145                          N_("list entire tree; not just current directory "
146                             "(implies --full-name)")),
147                 OPT__ABBREV(&abbrev),
148                 OPT_END()
149         };
150
151         git_config(git_default_config, NULL);
152         ls_tree_prefix = prefix;
153         if (prefix && *prefix)
154                 chomp_prefix = strlen(prefix);
155
156         argc = parse_options(argc, argv, prefix, ls_tree_options,
157                              ls_tree_usage, 0);
158         if (full_tree) {
159                 ls_tree_prefix = prefix = NULL;
160                 chomp_prefix = 0;
161         }
162         /* -d -r should imply -t, but -d by itself should not have to. */
163         if ( (LS_TREE_ONLY|LS_RECURSIVE) ==
164             ((LS_TREE_ONLY|LS_RECURSIVE) & ls_options))
165                 ls_options |= LS_SHOW_TREES;
166
167         if (argc < 1)
168                 usage_with_options(ls_tree_usage, ls_tree_options);
169         if (get_sha1(argv[0], sha1))
170                 die("Not a valid object name %s", argv[0]);
171
172         /*
173          * show_recursive() rolls its own matching code and is
174          * generally ignorant of 'struct pathspec'. The magic mask
175          * cannot be lifted until it is converted to use
176          * match_pathspec() or tree_entry_interesting()
177          */
178         parse_pathspec(&pathspec, PATHSPEC_GLOB | PATHSPEC_ICASE |
179                                   PATHSPEC_EXCLUDE,
180                        PATHSPEC_PREFER_CWD,
181                        prefix, argv + 1);
182         for (i = 0; i < pathspec.nr; i++)
183                 pathspec.items[i].nowildcard_len = pathspec.items[i].len;
184         pathspec.has_wildcard = 0;
185         tree = parse_tree_indirect(sha1);
186         if (!tree)
187                 die("not a tree object");
188         return !!read_tree_recursive(tree, "", 0, 0, &pathspec, show_tree, NULL);
189 }