list-objects: add "void *data" parameter to show functions
[git/git.git] / builtin-rev-list.c
1 #include "cache.h"
2 #include "commit.h"
3 #include "diff.h"
4 #include "revision.h"
5 #include "list-objects.h"
6 #include "builtin.h"
7 #include "log-tree.h"
8 #include "graph.h"
9 #include "bisect.h"
10
11 static const char rev_list_usage[] =
12 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
13 " limiting output:\n"
14 " --max-count=nr\n"
15 " --max-age=epoch\n"
16 " --min-age=epoch\n"
17 " --sparse\n"
18 " --no-merges\n"
19 " --remove-empty\n"
20 " --all\n"
21 " --branches\n"
22 " --tags\n"
23 " --remotes\n"
24 " --stdin\n"
25 " --quiet\n"
26 " ordering output:\n"
27 " --topo-order\n"
28 " --date-order\n"
29 " --reverse\n"
30 " formatting output:\n"
31 " --parents\n"
32 " --children\n"
33 " --objects | --objects-edge\n"
34 " --unpacked\n"
35 " --header | --pretty\n"
36 " --abbrev=nr | --no-abbrev\n"
37 " --abbrev-commit\n"
38 " --left-right\n"
39 " special purpose:\n"
40 " --bisect\n"
41 " --bisect-vars\n"
42 " --bisect-all"
43 ;
44
45 static int show_timestamp;
46 static int hdr_termination;
47 static const char *header_prefix;
48
49 static void finish_commit(struct commit *commit, void *data);
50 static void show_commit(struct commit *commit, void *data)
51 {
52 struct rev_info *revs = data;
53
54 graph_show_commit(revs->graph);
55
56 if (show_timestamp)
57 printf("%lu ", commit->date);
58 if (header_prefix)
59 fputs(header_prefix, stdout);
60
61 if (!revs->graph) {
62 if (commit->object.flags & BOUNDARY)
63 putchar('-');
64 else if (commit->object.flags & UNINTERESTING)
65 putchar('^');
66 else if (revs->left_right) {
67 if (commit->object.flags & SYMMETRIC_LEFT)
68 putchar('<');
69 else
70 putchar('>');
71 }
72 }
73 if (revs->abbrev_commit && revs->abbrev)
74 fputs(find_unique_abbrev(commit->object.sha1, revs->abbrev),
75 stdout);
76 else
77 fputs(sha1_to_hex(commit->object.sha1), stdout);
78 if (revs->print_parents) {
79 struct commit_list *parents = commit->parents;
80 while (parents) {
81 printf(" %s", sha1_to_hex(parents->item->object.sha1));
82 parents = parents->next;
83 }
84 }
85 if (revs->children.name) {
86 struct commit_list *children;
87
88 children = lookup_decoration(&revs->children, &commit->object);
89 while (children) {
90 printf(" %s", sha1_to_hex(children->item->object.sha1));
91 children = children->next;
92 }
93 }
94 show_decorations(revs, commit);
95 if (revs->commit_format == CMIT_FMT_ONELINE)
96 putchar(' ');
97 else
98 putchar('\n');
99
100 if (revs->verbose_header && commit->buffer) {
101 struct strbuf buf = STRBUF_INIT;
102 pretty_print_commit(revs->commit_format, commit,
103 &buf, revs->abbrev, NULL, NULL,
104 revs->date_mode, 0);
105 if (revs->graph) {
106 if (buf.len) {
107 if (revs->commit_format != CMIT_FMT_ONELINE)
108 graph_show_oneline(revs->graph);
109
110 graph_show_commit_msg(revs->graph, &buf);
111
112 /*
113 * Add a newline after the commit message.
114 *
115 * Usually, this newline produces a blank
116 * padding line between entries, in which case
117 * we need to add graph padding on this line.
118 *
119 * However, the commit message may not end in a
120 * newline. In this case the newline simply
121 * ends the last line of the commit message,
122 * and we don't need any graph output. (This
123 * always happens with CMIT_FMT_ONELINE, and it
124 * happens with CMIT_FMT_USERFORMAT when the
125 * format doesn't explicitly end in a newline.)
126 */
127 if (buf.len && buf.buf[buf.len - 1] == '\n')
128 graph_show_padding(revs->graph);
129 putchar('\n');
130 } else {
131 /*
132 * If the message buffer is empty, just show
133 * the rest of the graph output for this
134 * commit.
135 */
136 if (graph_show_remainder(revs->graph))
137 putchar('\n');
138 }
139 } else {
140 if (buf.len)
141 printf("%s%c", buf.buf, hdr_termination);
142 }
143 strbuf_release(&buf);
144 } else {
145 if (graph_show_remainder(revs->graph))
146 putchar('\n');
147 }
148 maybe_flush_or_die(stdout, "stdout");
149 finish_commit(commit, data);
150 }
151
152 static void finish_commit(struct commit *commit, void *data)
153 {
154 if (commit->parents) {
155 free_commit_list(commit->parents);
156 commit->parents = NULL;
157 }
158 free(commit->buffer);
159 commit->buffer = NULL;
160 }
161
162 static void finish_object(struct object_array_entry *p, void *data)
163 {
164 if (p->item->type == OBJ_BLOB && !has_sha1_file(p->item->sha1))
165 die("missing blob object '%s'", sha1_to_hex(p->item->sha1));
166 }
167
168 static void show_object(struct object_array_entry *p, void *data)
169 {
170 /* An object with name "foo\n0000000..." can be used to
171 * confuse downstream "git pack-objects" very badly.
172 */
173 const char *ep = strchr(p->name, '\n');
174
175 finish_object(p, data);
176 if (ep) {
177 printf("%s %.*s\n", sha1_to_hex(p->item->sha1),
178 (int) (ep - p->name),
179 p->name);
180 }
181 else
182 printf("%s %s\n", sha1_to_hex(p->item->sha1), p->name);
183 }
184
185 static void show_edge(struct commit *commit)
186 {
187 printf("-%s\n", sha1_to_hex(commit->object.sha1));
188 }
189
190 static inline int log2i(int n)
191 {
192 int log2 = 0;
193
194 for (; n > 1; n >>= 1)
195 log2++;
196
197 return log2;
198 }
199
200 static inline int exp2i(int n)
201 {
202 return 1 << n;
203 }
204
205 /*
206 * Estimate the number of bisect steps left (after the current step)
207 *
208 * For any x between 0 included and 2^n excluded, the probability for
209 * n - 1 steps left looks like:
210 *
211 * P(2^n + x) == (2^n - x) / (2^n + x)
212 *
213 * and P(2^n + x) < 0.5 means 2^n < 3x
214 */
215 static int estimate_bisect_steps(int all)
216 {
217 int n, x, e;
218
219 if (all < 3)
220 return 0;
221
222 n = log2i(all);
223 e = exp2i(n);
224 x = all - e;
225
226 return (e < 3 * x) ? n : n - 1;
227 }
228
229 static void show_tried_revs(struct commit_list *tried, int stringed)
230 {
231 printf("bisect_tried='");
232 for (;tried; tried = tried->next) {
233 char *format = tried->next ? "%s|" : "%s";
234 printf(format, sha1_to_hex(tried->item->object.sha1));
235 }
236 printf(stringed ? "' &&\n" : "'\n");
237 }
238
239 int show_bisect_vars(struct rev_info *revs, int reaches, int all, int flags)
240 {
241 int cnt;
242 char hex[41] = "", *format;
243 struct commit_list *tried;
244
245 if (!revs->commits && !(flags & BISECT_SHOW_TRIED))
246 return 1;
247
248 revs->commits = filter_skipped(revs->commits, &tried, flags & BISECT_SHOW_ALL);
249
250 /*
251 * revs->commits can reach "reaches" commits among
252 * "all" commits. If it is good, then there are
253 * (all-reaches) commits left to be bisected.
254 * On the other hand, if it is bad, then the set
255 * to bisect is "reaches".
256 * A bisect set of size N has (N-1) commits further
257 * to test, as we already know one bad one.
258 */
259 cnt = all - reaches;
260 if (cnt < reaches)
261 cnt = reaches;
262
263 if (revs->commits)
264 strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
265
266 if (flags & BISECT_SHOW_ALL) {
267 traverse_commit_list(revs, show_commit, show_object, revs);
268 printf("------\n");
269 }
270
271 if (flags & BISECT_SHOW_TRIED)
272 show_tried_revs(tried, flags & BISECT_SHOW_STRINGED);
273 format = (flags & BISECT_SHOW_STRINGED) ?
274 "bisect_rev=%s &&\n"
275 "bisect_nr=%d &&\n"
276 "bisect_good=%d &&\n"
277 "bisect_bad=%d &&\n"
278 "bisect_all=%d &&\n"
279 "bisect_steps=%d\n"
280 :
281 "bisect_rev=%s\n"
282 "bisect_nr=%d\n"
283 "bisect_good=%d\n"
284 "bisect_bad=%d\n"
285 "bisect_all=%d\n"
286 "bisect_steps=%d\n";
287 printf(format,
288 hex,
289 cnt - 1,
290 all - reaches - 1,
291 reaches - 1,
292 all,
293 estimate_bisect_steps(all));
294
295 return 0;
296 }
297
298 int cmd_rev_list(int argc, const char **argv, const char *prefix)
299 {
300 struct rev_info revs;
301 struct commit_list *list;
302 int i;
303 int read_from_stdin = 0;
304 int bisect_list = 0;
305 int bisect_show_vars = 0;
306 int bisect_find_all = 0;
307 int bisect_show_all = 0;
308 int quiet = 0;
309
310 git_config(git_default_config, NULL);
311 init_revisions(&revs, prefix);
312 revs.abbrev = 0;
313 revs.commit_format = CMIT_FMT_UNSPECIFIED;
314 argc = setup_revisions(argc, argv, &revs, NULL);
315
316 quiet = DIFF_OPT_TST(&revs.diffopt, QUIET);
317 for (i = 1 ; i < argc; i++) {
318 const char *arg = argv[i];
319
320 if (!strcmp(arg, "--header")) {
321 revs.verbose_header = 1;
322 continue;
323 }
324 if (!strcmp(arg, "--timestamp")) {
325 show_timestamp = 1;
326 continue;
327 }
328 if (!strcmp(arg, "--bisect")) {
329 bisect_list = 1;
330 continue;
331 }
332 if (!strcmp(arg, "--bisect-all")) {
333 bisect_list = 1;
334 bisect_find_all = 1;
335 bisect_show_all = 1;
336 revs.show_decorations = 1;
337 continue;
338 }
339 if (!strcmp(arg, "--bisect-vars")) {
340 bisect_list = 1;
341 bisect_show_vars = 1;
342 continue;
343 }
344 if (!strcmp(arg, "--stdin")) {
345 if (read_from_stdin++)
346 die("--stdin given twice?");
347 read_revisions_from_stdin(&revs);
348 continue;
349 }
350 usage(rev_list_usage);
351
352 }
353 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
354 /* The command line has a --pretty */
355 hdr_termination = '\n';
356 if (revs.commit_format == CMIT_FMT_ONELINE)
357 header_prefix = "";
358 else
359 header_prefix = "commit ";
360 }
361 else if (revs.verbose_header)
362 /* Only --header was specified */
363 revs.commit_format = CMIT_FMT_RAW;
364
365 list = revs.commits;
366
367 if ((!list &&
368 (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
369 !revs.pending.nr)) ||
370 revs.diff)
371 usage(rev_list_usage);
372
373 save_commit_buffer = revs.verbose_header ||
374 revs.grep_filter.pattern_list;
375 if (bisect_list)
376 revs.limited = 1;
377
378 if (prepare_revision_walk(&revs))
379 die("revision walk setup failed");
380 if (revs.tree_objects)
381 mark_edges_uninteresting(revs.commits, &revs, show_edge);
382
383 if (bisect_list) {
384 int reaches = reaches, all = all;
385
386 revs.commits = find_bisection(revs.commits, &reaches, &all,
387 bisect_find_all);
388
389 if (bisect_show_vars)
390 return show_bisect_vars(&revs, reaches, all,
391 bisect_show_all ? BISECT_SHOW_ALL : 0);
392 }
393
394 traverse_commit_list(&revs,
395 quiet ? finish_commit : show_commit,
396 quiet ? finish_object : show_object,
397 &revs);
398
399 return 0;
400 }