list-objects: refactor to process_tree_contents
[git] / list-objects.c
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "tree.h"
5 #include "blob.h"
6 #include "diff.h"
7 #include "tree-walk.h"
8 #include "revision.h"
9 #include "list-objects.h"
10 #include "list-objects-filter.h"
11 #include "list-objects-filter-options.h"
12 #include "packfile.h"
13 #include "object-store.h"
14
15 struct traversal_context {
16         struct rev_info *revs;
17         show_object_fn show_object;
18         show_commit_fn show_commit;
19         void *show_data;
20         filter_object_fn filter_fn;
21         void *filter_data;
22 };
23
24 static void process_blob(struct traversal_context *ctx,
25                          struct blob *blob,
26                          struct strbuf *path,
27                          const char *name)
28 {
29         struct object *obj = &blob->object;
30         size_t pathlen;
31         enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
32
33         if (!ctx->revs->blob_objects)
34                 return;
35         if (!obj)
36                 die("bad blob object");
37         if (obj->flags & (UNINTERESTING | SEEN))
38                 return;
39
40         /*
41          * Pre-filter known-missing objects when explicitly requested.
42          * Otherwise, a missing object error message may be reported
43          * later (depending on other filtering criteria).
44          *
45          * Note that this "--exclude-promisor-objects" pre-filtering
46          * may cause the actual filter to report an incomplete list
47          * of missing objects.
48          */
49         if (ctx->revs->exclude_promisor_objects &&
50             !has_object_file(&obj->oid) &&
51             is_promisor_object(&obj->oid))
52                 return;
53
54         pathlen = path->len;
55         strbuf_addstr(path, name);
56         if (!(obj->flags & USER_GIVEN) && ctx->filter_fn)
57                 r = ctx->filter_fn(LOFS_BLOB, obj,
58                                    path->buf, &path->buf[pathlen],
59                                    ctx->filter_data);
60         if (r & LOFR_MARK_SEEN)
61                 obj->flags |= SEEN;
62         if (r & LOFR_DO_SHOW)
63                 ctx->show_object(obj, path->buf, ctx->show_data);
64         strbuf_setlen(path, pathlen);
65 }
66
67 /*
68  * Processing a gitlink entry currently does nothing, since
69  * we do not recurse into the subproject.
70  *
71  * We *could* eventually add a flag that actually does that,
72  * which would involve:
73  *  - is the subproject actually checked out?
74  *  - if so, see if the subproject has already been added
75  *    to the alternates list, and add it if not.
76  *  - process the commit (or tag) the gitlink points to
77  *    recursively.
78  *
79  * However, it's unclear whether there is really ever any
80  * reason to see superprojects and subprojects as such a
81  * "unified" object pool (potentially resulting in a totally
82  * humongous pack - avoiding which was the whole point of
83  * having gitlinks in the first place!).
84  *
85  * So for now, there is just a note that we *could* follow
86  * the link, and how to do it. Whether it necessarily makes
87  * any sense what-so-ever to ever do that is another issue.
88  */
89 static void process_gitlink(struct traversal_context *ctx,
90                             const unsigned char *sha1,
91                             struct strbuf *path,
92                             const char *name)
93 {
94         /* Nothing to do */
95 }
96
97 static void process_tree(struct traversal_context *ctx,
98                          struct tree *tree,
99                          struct strbuf *base,
100                          const char *name);
101
102 static void process_tree_contents(struct traversal_context *ctx,
103                                   struct tree *tree,
104                                   struct strbuf *base)
105 {
106         struct tree_desc desc;
107         struct name_entry entry;
108         enum interesting match = ctx->revs->diffopt.pathspec.nr == 0 ?
109                 all_entries_interesting : entry_not_interesting;
110
111         init_tree_desc(&desc, tree->buffer, tree->size);
112
113         while (tree_entry(&desc, &entry)) {
114                 if (match != all_entries_interesting) {
115                         match = tree_entry_interesting(&entry, base, 0,
116                                                        &ctx->revs->diffopt.pathspec);
117                         if (match == all_entries_not_interesting)
118                                 break;
119                         if (match == entry_not_interesting)
120                                 continue;
121                 }
122
123                 if (S_ISDIR(entry.mode))
124                         process_tree(ctx,
125                                      lookup_tree(the_repository, entry.oid),
126                                      base, entry.path);
127                 else if (S_ISGITLINK(entry.mode))
128                         process_gitlink(ctx, entry.oid->hash,
129                                         base, entry.path);
130                 else
131                         process_blob(ctx,
132                                      lookup_blob(the_repository, entry.oid),
133                                      base, entry.path);
134         }
135 }
136
137 static void process_tree(struct traversal_context *ctx,
138                          struct tree *tree,
139                          struct strbuf *base,
140                          const char *name)
141 {
142         struct object *obj = &tree->object;
143         struct rev_info *revs = ctx->revs;
144         int baselen = base->len;
145         enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
146         int gently = revs->ignore_missing_links ||
147                      revs->exclude_promisor_objects;
148
149         if (!revs->tree_objects)
150                 return;
151         if (!obj)
152                 die("bad tree object");
153         if (obj->flags & (UNINTERESTING | SEEN))
154                 return;
155         if (parse_tree_gently(tree, gently) < 0) {
156                 if (revs->ignore_missing_links)
157                         return;
158
159                 /*
160                  * Pre-filter known-missing tree objects when explicitly
161                  * requested.  This may cause the actual filter to report
162                  * an incomplete list of missing objects.
163                  */
164                 if (revs->exclude_promisor_objects &&
165                     is_promisor_object(&obj->oid))
166                         return;
167
168                 die("bad tree object %s", oid_to_hex(&obj->oid));
169         }
170
171         strbuf_addstr(base, name);
172         if (!(obj->flags & USER_GIVEN) && ctx->filter_fn)
173                 r = ctx->filter_fn(LOFS_BEGIN_TREE, obj,
174                                    base->buf, &base->buf[baselen],
175                                    ctx->filter_data);
176         if (r & LOFR_MARK_SEEN)
177                 obj->flags |= SEEN;
178         if (r & LOFR_DO_SHOW)
179                 ctx->show_object(obj, base->buf, ctx->show_data);
180         if (base->len)
181                 strbuf_addch(base, '/');
182
183         process_tree_contents(ctx, tree, base);
184
185         if (!(obj->flags & USER_GIVEN) && ctx->filter_fn) {
186                 r = ctx->filter_fn(LOFS_END_TREE, obj,
187                                    base->buf, &base->buf[baselen],
188                                    ctx->filter_data);
189                 if (r & LOFR_MARK_SEEN)
190                         obj->flags |= SEEN;
191                 if (r & LOFR_DO_SHOW)
192                         ctx->show_object(obj, base->buf, ctx->show_data);
193         }
194
195         strbuf_setlen(base, baselen);
196         free_tree_buffer(tree);
197 }
198
199 static void mark_edge_parents_uninteresting(struct commit *commit,
200                                             struct rev_info *revs,
201                                             show_edge_fn show_edge)
202 {
203         struct commit_list *parents;
204
205         for (parents = commit->parents; parents; parents = parents->next) {
206                 struct commit *parent = parents->item;
207                 if (!(parent->object.flags & UNINTERESTING))
208                         continue;
209                 mark_tree_uninteresting(get_commit_tree(parent));
210                 if (revs->edge_hint && !(parent->object.flags & SHOWN)) {
211                         parent->object.flags |= SHOWN;
212                         show_edge(parent);
213                 }
214         }
215 }
216
217 void mark_edges_uninteresting(struct rev_info *revs, show_edge_fn show_edge)
218 {
219         struct commit_list *list;
220         int i;
221
222         for (list = revs->commits; list; list = list->next) {
223                 struct commit *commit = list->item;
224
225                 if (commit->object.flags & UNINTERESTING) {
226                         mark_tree_uninteresting(get_commit_tree(commit));
227                         if (revs->edge_hint_aggressive && !(commit->object.flags & SHOWN)) {
228                                 commit->object.flags |= SHOWN;
229                                 show_edge(commit);
230                         }
231                         continue;
232                 }
233                 mark_edge_parents_uninteresting(commit, revs, show_edge);
234         }
235         if (revs->edge_hint_aggressive) {
236                 for (i = 0; i < revs->cmdline.nr; i++) {
237                         struct object *obj = revs->cmdline.rev[i].item;
238                         struct commit *commit = (struct commit *)obj;
239                         if (obj->type != OBJ_COMMIT || !(obj->flags & UNINTERESTING))
240                                 continue;
241                         mark_tree_uninteresting(get_commit_tree(commit));
242                         if (!(obj->flags & SHOWN)) {
243                                 obj->flags |= SHOWN;
244                                 show_edge(commit);
245                         }
246                 }
247         }
248 }
249
250 static void add_pending_tree(struct rev_info *revs, struct tree *tree)
251 {
252         add_pending_object(revs, &tree->object, "");
253 }
254
255 static void traverse_trees_and_blobs(struct traversal_context *ctx,
256                                      struct strbuf *base)
257 {
258         int i;
259
260         assert(base->len == 0);
261
262         for (i = 0; i < ctx->revs->pending.nr; i++) {
263                 struct object_array_entry *pending = ctx->revs->pending.objects + i;
264                 struct object *obj = pending->item;
265                 const char *name = pending->name;
266                 const char *path = pending->path;
267                 if (obj->flags & (UNINTERESTING | SEEN))
268                         continue;
269                 if (obj->type == OBJ_TAG) {
270                         obj->flags |= SEEN;
271                         ctx->show_object(obj, name, ctx->show_data);
272                         continue;
273                 }
274                 if (!path)
275                         path = "";
276                 if (obj->type == OBJ_TREE) {
277                         process_tree(ctx, (struct tree *)obj, base, path);
278                         continue;
279                 }
280                 if (obj->type == OBJ_BLOB) {
281                         process_blob(ctx, (struct blob *)obj, base, path);
282                         continue;
283                 }
284                 die("unknown pending object %s (%s)",
285                     oid_to_hex(&obj->oid), name);
286         }
287         object_array_clear(&ctx->revs->pending);
288 }
289
290 static void do_traverse(struct traversal_context *ctx)
291 {
292         struct commit *commit;
293         struct strbuf csp; /* callee's scratch pad */
294         strbuf_init(&csp, PATH_MAX);
295
296         while ((commit = get_revision(ctx->revs)) != NULL) {
297                 /*
298                  * an uninteresting boundary commit may not have its tree
299                  * parsed yet, but we are not going to show them anyway
300                  */
301                 if (get_commit_tree(commit))
302                         add_pending_tree(ctx->revs, get_commit_tree(commit));
303                 ctx->show_commit(commit, ctx->show_data);
304
305                 if (ctx->revs->tree_blobs_in_commit_order)
306                         /*
307                          * NEEDSWORK: Adding the tree and then flushing it here
308                          * needs a reallocation for each commit. Can we pass the
309                          * tree directory without allocation churn?
310                          */
311                         traverse_trees_and_blobs(ctx, &csp);
312         }
313         traverse_trees_and_blobs(ctx, &csp);
314         strbuf_release(&csp);
315 }
316
317 void traverse_commit_list(struct rev_info *revs,
318                           show_commit_fn show_commit,
319                           show_object_fn show_object,
320                           void *show_data)
321 {
322         struct traversal_context ctx;
323         ctx.revs = revs;
324         ctx.show_commit = show_commit;
325         ctx.show_object = show_object;
326         ctx.show_data = show_data;
327         ctx.filter_fn = NULL;
328         ctx.filter_data = NULL;
329         do_traverse(&ctx);
330 }
331
332 void traverse_commit_list_filtered(
333         struct list_objects_filter_options *filter_options,
334         struct rev_info *revs,
335         show_commit_fn show_commit,
336         show_object_fn show_object,
337         void *show_data,
338         struct oidset *omitted)
339 {
340         struct traversal_context ctx;
341         filter_free_fn filter_free_fn = NULL;
342
343         ctx.revs = revs;
344         ctx.show_object = show_object;
345         ctx.show_commit = show_commit;
346         ctx.show_data = show_data;
347         ctx.filter_fn = NULL;
348
349         ctx.filter_data = list_objects_filter__init(omitted, filter_options,
350                                                     &ctx.filter_fn, &filter_free_fn);
351         do_traverse(&ctx);
352         if (ctx.filter_data && filter_free_fn)
353                 filter_free_fn(ctx.filter_data);
354 }