Documentation: fix typo 'In such these cases'
[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
11 static void process_blob(struct rev_info *revs,
12                          struct blob *blob,
13                          show_object_fn show,
14                          struct name_path *path,
15                          const char *name)
16 {
17         struct object *obj = &blob->object;
18
19         if (!revs->blob_objects)
20                 return;
21         if (!obj)
22                 die("bad blob object");
23         if (obj->flags & (UNINTERESTING | SEEN))
24                 return;
25         obj->flags |= SEEN;
26         show(obj, path, name);
27 }
28
29 /*
30  * Processing a gitlink entry currently does nothing, since
31  * we do not recurse into the subproject.
32  *
33  * We *could* eventually add a flag that actually does that,
34  * which would involve:
35  *  - is the subproject actually checked out?
36  *  - if so, see if the subproject has already been added
37  *    to the alternates list, and add it if not.
38  *  - process the commit (or tag) the gitlink points to
39  *    recursively.
40  *
41  * However, it's unclear whether there is really ever any
42  * reason to see superprojects and subprojects as such a
43  * "unified" object pool (potentially resulting in a totally
44  * humongous pack - avoiding which was the whole point of
45  * having gitlinks in the first place!).
46  *
47  * So for now, there is just a note that we *could* follow
48  * the link, and how to do it. Whether it necessarily makes
49  * any sense what-so-ever to ever do that is another issue.
50  */
51 static void process_gitlink(struct rev_info *revs,
52                             const unsigned char *sha1,
53                             show_object_fn show,
54                             struct name_path *path,
55                             const char *name)
56 {
57         /* Nothing to do */
58 }
59
60 static void process_tree(struct rev_info *revs,
61                          struct tree *tree,
62                          show_object_fn show,
63                          struct name_path *path,
64                          const char *name)
65 {
66         struct object *obj = &tree->object;
67         struct tree_desc desc;
68         struct name_entry entry;
69         struct name_path me;
70
71         if (!revs->tree_objects)
72                 return;
73         if (!obj)
74                 die("bad tree object");
75         if (obj->flags & (UNINTERESTING | SEEN))
76                 return;
77         if (parse_tree(tree) < 0)
78                 die("bad tree object %s", sha1_to_hex(obj->sha1));
79         obj->flags |= SEEN;
80         show(obj, path, name);
81         me.up = path;
82         me.elem = name;
83         me.elem_len = strlen(name);
84
85         init_tree_desc(&desc, tree->buffer, tree->size);
86
87         while (tree_entry(&desc, &entry)) {
88                 if (S_ISDIR(entry.mode))
89                         process_tree(revs,
90                                      lookup_tree(entry.sha1),
91                                      show, &me, entry.path);
92                 else if (S_ISGITLINK(entry.mode))
93                         process_gitlink(revs, entry.sha1,
94                                         show, &me, entry.path);
95                 else
96                         process_blob(revs,
97                                      lookup_blob(entry.sha1),
98                                      show, &me, entry.path);
99         }
100         free(tree->buffer);
101         tree->buffer = NULL;
102 }
103
104 static void mark_edge_parents_uninteresting(struct commit *commit,
105                                             struct rev_info *revs,
106                                             show_edge_fn show_edge)
107 {
108         struct commit_list *parents;
109
110         for (parents = commit->parents; parents; parents = parents->next) {
111                 struct commit *parent = parents->item;
112                 if (!(parent->object.flags & UNINTERESTING))
113                         continue;
114                 mark_tree_uninteresting(parent->tree);
115                 if (revs->edge_hint && !(parent->object.flags & SHOWN)) {
116                         parent->object.flags |= SHOWN;
117                         show_edge(parent);
118                 }
119         }
120 }
121
122 void mark_edges_uninteresting(struct commit_list *list,
123                               struct rev_info *revs,
124                               show_edge_fn show_edge)
125 {
126         for ( ; list; list = list->next) {
127                 struct commit *commit = list->item;
128
129                 if (commit->object.flags & UNINTERESTING) {
130                         mark_tree_uninteresting(commit->tree);
131                         continue;
132                 }
133                 mark_edge_parents_uninteresting(commit, revs, show_edge);
134         }
135 }
136
137 static void add_pending_tree(struct rev_info *revs, struct tree *tree)
138 {
139         add_pending_object(revs, &tree->object, "");
140 }
141
142 void traverse_commit_list(struct rev_info *revs,
143                           show_commit_fn show_commit,
144                           show_object_fn show_object,
145                           void *data)
146 {
147         int i;
148         struct commit *commit;
149
150         while ((commit = get_revision(revs)) != NULL) {
151                 add_pending_tree(revs, commit->tree);
152                 show_commit(commit, data);
153         }
154         for (i = 0; i < revs->pending.nr; i++) {
155                 struct object_array_entry *pending = revs->pending.objects + i;
156                 struct object *obj = pending->item;
157                 const char *name = pending->name;
158                 if (obj->flags & (UNINTERESTING | SEEN))
159                         continue;
160                 if (obj->type == OBJ_TAG) {
161                         obj->flags |= SEEN;
162                         show_object(obj, NULL, name);
163                         continue;
164                 }
165                 if (obj->type == OBJ_TREE) {
166                         process_tree(revs, (struct tree *)obj, show_object,
167                                      NULL, name);
168                         continue;
169                 }
170                 if (obj->type == OBJ_BLOB) {
171                         process_blob(revs, (struct blob *)obj, show_object,
172                                      NULL, name);
173                         continue;
174                 }
175                 die("unknown pending object %s (%s)",
176                     sha1_to_hex(obj->sha1), name);
177         }
178         if (revs->pending.nr) {
179                 free(revs->pending.objects);
180                 revs->pending.nr = 0;
181                 revs->pending.alloc = 0;
182                 revs->pending.objects = NULL;
183         }
184 }