list-objects: store common func args in struct
[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         struct object *obj = &tree->object;
103         struct rev_info *revs = ctx->revs;
104         struct tree_desc desc;
105         struct name_entry entry;
106         enum interesting match = revs->diffopt.pathspec.nr == 0 ?
107                 all_entries_interesting: entry_not_interesting;
108         int baselen = base->len;
109         enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
110         int gently = revs->ignore_missing_links ||
111                      revs->exclude_promisor_objects;
112
113         if (!revs->tree_objects)
114                 return;
115         if (!obj)
116                 die("bad tree object");
117         if (obj->flags & (UNINTERESTING | SEEN))
118                 return;
119         if (parse_tree_gently(tree, gently) < 0) {
120                 if (revs->ignore_missing_links)
121                         return;
122
123                 /*
124                  * Pre-filter known-missing tree objects when explicitly
125                  * requested.  This may cause the actual filter to report
126                  * an incomplete list of missing objects.
127                  */
128                 if (revs->exclude_promisor_objects &&
129                     is_promisor_object(&obj->oid))
130                         return;
131
132                 die("bad tree object %s", oid_to_hex(&obj->oid));
133         }
134
135         strbuf_addstr(base, name);
136         if (!(obj->flags & USER_GIVEN) && ctx->filter_fn)
137                 r = ctx->filter_fn(LOFS_BEGIN_TREE, obj,
138                                    base->buf, &base->buf[baselen],
139                                    ctx->filter_data);
140         if (r & LOFR_MARK_SEEN)
141                 obj->flags |= SEEN;
142         if (r & LOFR_DO_SHOW)
143                 ctx->show_object(obj, base->buf, ctx->show_data);
144         if (base->len)
145                 strbuf_addch(base, '/');
146
147         init_tree_desc(&desc, tree->buffer, tree->size);
148
149         while (tree_entry(&desc, &entry)) {
150                 if (match != all_entries_interesting) {
151                         match = tree_entry_interesting(&entry, base, 0,
152                                                        &revs->diffopt.pathspec);
153                         if (match == all_entries_not_interesting)
154                                 break;
155                         if (match == entry_not_interesting)
156                                 continue;
157                 }
158
159                 if (S_ISDIR(entry.mode))
160                         process_tree(ctx,
161                                      lookup_tree(the_repository, entry.oid),
162                                      base, entry.path);
163                 else if (S_ISGITLINK(entry.mode))
164                         process_gitlink(ctx, entry.oid->hash, base, entry.path);
165                 else
166                         process_blob(ctx,
167                                      lookup_blob(the_repository, entry.oid),
168                                      base, entry.path);
169         }
170
171         if (!(obj->flags & USER_GIVEN) && ctx->filter_fn) {
172                 r = ctx->filter_fn(LOFS_END_TREE, obj,
173                                    base->buf, &base->buf[baselen],
174                                    ctx->filter_data);
175                 if (r & LOFR_MARK_SEEN)
176                         obj->flags |= SEEN;
177                 if (r & LOFR_DO_SHOW)
178                         ctx->show_object(obj, base->buf, ctx->show_data);
179         }
180
181         strbuf_setlen(base, baselen);
182         free_tree_buffer(tree);
183 }
184
185 static void mark_edge_parents_uninteresting(struct commit *commit,
186                                             struct rev_info *revs,
187                                             show_edge_fn show_edge)
188 {
189         struct commit_list *parents;
190
191         for (parents = commit->parents; parents; parents = parents->next) {
192                 struct commit *parent = parents->item;
193                 if (!(parent->object.flags & UNINTERESTING))
194                         continue;
195                 mark_tree_uninteresting(get_commit_tree(parent));
196                 if (revs->edge_hint && !(parent->object.flags & SHOWN)) {
197                         parent->object.flags |= SHOWN;
198                         show_edge(parent);
199                 }
200         }
201 }
202
203 void mark_edges_uninteresting(struct rev_info *revs, show_edge_fn show_edge)
204 {
205         struct commit_list *list;
206         int i;
207
208         for (list = revs->commits; list; list = list->next) {
209                 struct commit *commit = list->item;
210
211                 if (commit->object.flags & UNINTERESTING) {
212                         mark_tree_uninteresting(get_commit_tree(commit));
213                         if (revs->edge_hint_aggressive && !(commit->object.flags & SHOWN)) {
214                                 commit->object.flags |= SHOWN;
215                                 show_edge(commit);
216                         }
217                         continue;
218                 }
219                 mark_edge_parents_uninteresting(commit, revs, show_edge);
220         }
221         if (revs->edge_hint_aggressive) {
222                 for (i = 0; i < revs->cmdline.nr; i++) {
223                         struct object *obj = revs->cmdline.rev[i].item;
224                         struct commit *commit = (struct commit *)obj;
225                         if (obj->type != OBJ_COMMIT || !(obj->flags & UNINTERESTING))
226                                 continue;
227                         mark_tree_uninteresting(get_commit_tree(commit));
228                         if (!(obj->flags & SHOWN)) {
229                                 obj->flags |= SHOWN;
230                                 show_edge(commit);
231                         }
232                 }
233         }
234 }
235
236 static void add_pending_tree(struct rev_info *revs, struct tree *tree)
237 {
238         add_pending_object(revs, &tree->object, "");
239 }
240
241 static void traverse_trees_and_blobs(struct traversal_context *ctx,
242                                      struct strbuf *base)
243 {
244         int i;
245
246         assert(base->len == 0);
247
248         for (i = 0; i < ctx->revs->pending.nr; i++) {
249                 struct object_array_entry *pending = ctx->revs->pending.objects + i;
250                 struct object *obj = pending->item;
251                 const char *name = pending->name;
252                 const char *path = pending->path;
253                 if (obj->flags & (UNINTERESTING | SEEN))
254                         continue;
255                 if (obj->type == OBJ_TAG) {
256                         obj->flags |= SEEN;
257                         ctx->show_object(obj, name, ctx->show_data);
258                         continue;
259                 }
260                 if (!path)
261                         path = "";
262                 if (obj->type == OBJ_TREE) {
263                         process_tree(ctx, (struct tree *)obj, base, path);
264                         continue;
265                 }
266                 if (obj->type == OBJ_BLOB) {
267                         process_blob(ctx, (struct blob *)obj, base, path);
268                         continue;
269                 }
270                 die("unknown pending object %s (%s)",
271                     oid_to_hex(&obj->oid), name);
272         }
273         object_array_clear(&ctx->revs->pending);
274 }
275
276 static void do_traverse(struct traversal_context *ctx)
277 {
278         struct commit *commit;
279         struct strbuf csp; /* callee's scratch pad */
280         strbuf_init(&csp, PATH_MAX);
281
282         while ((commit = get_revision(ctx->revs)) != NULL) {
283                 /*
284                  * an uninteresting boundary commit may not have its tree
285                  * parsed yet, but we are not going to show them anyway
286                  */
287                 if (get_commit_tree(commit))
288                         add_pending_tree(ctx->revs, get_commit_tree(commit));
289                 ctx->show_commit(commit, ctx->show_data);
290
291                 if (ctx->revs->tree_blobs_in_commit_order)
292                         /*
293                          * NEEDSWORK: Adding the tree and then flushing it here
294                          * needs a reallocation for each commit. Can we pass the
295                          * tree directory without allocation churn?
296                          */
297                         traverse_trees_and_blobs(ctx, &csp);
298         }
299         traverse_trees_and_blobs(ctx, &csp);
300         strbuf_release(&csp);
301 }
302
303 void traverse_commit_list(struct rev_info *revs,
304                           show_commit_fn show_commit,
305                           show_object_fn show_object,
306                           void *show_data)
307 {
308         struct traversal_context ctx;
309         ctx.revs = revs;
310         ctx.show_commit = show_commit;
311         ctx.show_object = show_object;
312         ctx.show_data = show_data;
313         ctx.filter_fn = NULL;
314         ctx.filter_data = NULL;
315         do_traverse(&ctx);
316 }
317
318 void traverse_commit_list_filtered(
319         struct list_objects_filter_options *filter_options,
320         struct rev_info *revs,
321         show_commit_fn show_commit,
322         show_object_fn show_object,
323         void *show_data,
324         struct oidset *omitted)
325 {
326         struct traversal_context ctx;
327         filter_free_fn filter_free_fn = NULL;
328
329         ctx.revs = revs;
330         ctx.show_object = show_object;
331         ctx.show_commit = show_commit;
332         ctx.show_data = show_data;
333         ctx.filter_fn = NULL;
334
335         ctx.filter_data = list_objects_filter__init(omitted, filter_options,
336                                                     &ctx.filter_fn, &filter_free_fn);
337         do_traverse(&ctx);
338         if (ctx.filter_data && filter_free_fn)
339                 filter_free_fn(ctx.filter_data);
340 }