rebase -i: Document how temporary files are used
[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
14 static int line_termination = '\n';
15 #define LS_RECURSIVE 1
16 #define LS_TREE_ONLY 2
17 #define LS_SHOW_TREES 4
18 #define LS_NAME_ONLY 8
19 #define LS_SHOW_SIZE 16
20 static int abbrev;
21 static int ls_options;
22 static const char **pathspec;
23 static int chomp_prefix;
24 static const char *ls_tree_prefix;
25
26 static const  char * const ls_tree_usage[] = {
27         "git ls-tree [<options>] <tree-ish> [path...]",
28         NULL
29 };
30
31 static int show_recursive(const char *base, int baselen, const char *pathname)
32 {
33         const char **s;
34
35         if (ls_options & LS_RECURSIVE)
36                 return 1;
37
38         s = pathspec;
39         if (!s)
40                 return 0;
41
42         for (;;) {
43                 const char *spec = *s++;
44                 int len, speclen;
45
46                 if (!spec)
47                         return 0;
48                 if (strncmp(base, spec, baselen))
49                         continue;
50                 len = strlen(pathname);
51                 spec += baselen;
52                 speclen = strlen(spec);
53                 if (speclen <= len)
54                         continue;
55                 if (memcmp(pathname, spec, len))
56                         continue;
57                 return 1;
58         }
59 }
60
61 static int show_tree(const unsigned char *sha1, const char *base, int baselen,
62                 const char *pathname, unsigned mode, int stage, void *context)
63 {
64         int retval = 0;
65         const char *type = blob_type;
66
67         if (S_ISGITLINK(mode)) {
68                 /*
69                  * Maybe we want to have some recursive version here?
70                  *
71                  * Something similar to this incomplete example:
72                  *
73                 if (show_subprojects(base, baselen, pathname))
74                         retval = READ_TREE_RECURSIVE;
75                  *
76                  */
77                 type = commit_type;
78         } else if (S_ISDIR(mode)) {
79                 if (show_recursive(base, baselen, pathname)) {
80                         retval = READ_TREE_RECURSIVE;
81                         if (!(ls_options & LS_SHOW_TREES))
82                                 return retval;
83                 }
84                 type = tree_type;
85         }
86         else if (ls_options & LS_TREE_ONLY)
87                 return 0;
88
89         if (chomp_prefix &&
90             (baselen < chomp_prefix || memcmp(ls_tree_prefix, base, chomp_prefix)))
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                                         strcpy(size_text, "BAD");
100                                 else
101                                         snprintf(size_text, sizeof(size_text),
102                                                  "%lu", size);
103                         } else
104                                 strcpy(size_text, "-");
105                         printf("%06o %s %s %7s\t", mode, type,
106                                abbrev ? find_unique_abbrev(sha1, abbrev)
107                                       : sha1_to_hex(sha1),
108                                size_text);
109                 } else
110                         printf("%06o %s %s\t", mode, type,
111                                abbrev ? find_unique_abbrev(sha1, abbrev)
112                                       : sha1_to_hex(sha1));
113         }
114         write_name_quotedpfx(base + chomp_prefix, baselen - chomp_prefix,
115                           pathname, stdout, line_termination);
116         return retval;
117 }
118
119 int cmd_ls_tree(int argc, const char **argv, const char *prefix)
120 {
121         unsigned char sha1[20];
122         struct tree *tree;
123         int full_tree = 0;
124         const struct option ls_tree_options[] = {
125                 OPT_BIT('d', NULL, &ls_options, "only show trees",
126                         LS_TREE_ONLY),
127                 OPT_BIT('r', NULL, &ls_options, "recurse into subtrees",
128                         LS_RECURSIVE),
129                 OPT_BIT('t', NULL, &ls_options, "show trees when recursing",
130                         LS_SHOW_TREES),
131                 OPT_SET_INT('z', NULL, &line_termination,
132                             "terminate entries with NUL byte", 0),
133                 OPT_BIT('l', "long", &ls_options, "include object size",
134                         LS_SHOW_SIZE),
135                 OPT_BIT(0, "name-only", &ls_options, "list only filenames",
136                         LS_NAME_ONLY),
137                 OPT_BIT(0, "name-status", &ls_options, "list only filenames",
138                         LS_NAME_ONLY),
139                 OPT_SET_INT(0, "full-name", &chomp_prefix,
140                             "use full path names", 0),
141                 OPT_BOOLEAN(0, "full-tree", &full_tree,
142                             "list entire tree; not just current directory "
143                             "(implies --full-name)"),
144                 OPT__ABBREV(&abbrev),
145                 OPT_END()
146         };
147
148         git_config(git_default_config, NULL);
149         ls_tree_prefix = prefix;
150         if (prefix && *prefix)
151                 chomp_prefix = strlen(prefix);
152
153         argc = parse_options(argc, argv, prefix, ls_tree_options,
154                              ls_tree_usage, 0);
155         if (full_tree) {
156                 ls_tree_prefix = prefix = NULL;
157                 chomp_prefix = 0;
158         }
159         /* -d -r should imply -t, but -d by itself should not have to. */
160         if ( (LS_TREE_ONLY|LS_RECURSIVE) ==
161             ((LS_TREE_ONLY|LS_RECURSIVE) & ls_options))
162                 ls_options |= LS_SHOW_TREES;
163
164         if (argc < 1)
165                 usage_with_options(ls_tree_usage, ls_tree_options);
166         if (get_sha1(argv[0], sha1))
167                 die("Not a valid object name %s", argv[0]);
168
169         pathspec = get_pathspec(prefix, argv + 1);
170         tree = parse_tree_indirect(sha1);
171         if (!tree)
172                 die("not a tree object");
173         read_tree_recursive(tree, "", 0, 0, pathspec, show_tree, NULL);
174
175         return 0;
176 }