[PATCH] Unify usage strings declaration
[git.git] / rev-list.c
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "tree.h"
5 #include "blob.h"
6 #include "epoch.h"
7
8 #define SEEN            (1u << 0)
9 #define INTERESTING     (1u << 1)
10 #define COUNTED         (1u << 2)
11 #define SHOWN           (1u << 3)
12
13 static const char rev_list_usage[] =
14         "git-rev-list [OPTION] commit-id <commit-id>\n"
15                       "  --max-count=nr\n"
16                       "  --max-age=epoch\n"
17                       "  --min-age=epoch\n"
18                       "  --bisect\n"
19                       "  --objects\n"
20                       "  --unpacked\n"
21                       "  --header\n"
22                       "  --pretty\n"
23                       "  --merge-order [ --show-breaks ]";
24
25 static int unpacked = 0;
26 static int bisect_list = 0;
27 static int tag_objects = 0;
28 static int tree_objects = 0;
29 static int blob_objects = 0;
30 static int verbose_header = 0;
31 static int show_parents = 0;
32 static int hdr_termination = 0;
33 static const char *prefix = "";
34 static unsigned long max_age = -1;
35 static unsigned long min_age = -1;
36 static int max_count = -1;
37 static enum cmit_fmt commit_format = CMIT_FMT_RAW;
38 static int merge_order = 0;
39 static int show_breaks = 0;
40 static int stop_traversal = 0;
41 static int topo_order = 0;
42
43 static void show_commit(struct commit *commit)
44 {
45         commit->object.flags |= SHOWN;
46         if (show_breaks) {
47                 prefix = "| ";
48                 if (commit->object.flags & DISCONTINUITY) {
49                         prefix = "^ ";     
50                 } else if (commit->object.flags & BOUNDARY) {
51                         prefix = "= ";
52                 } 
53         }                       
54         printf("%s%s", prefix, sha1_to_hex(commit->object.sha1));
55         if (show_parents) {
56                 struct commit_list *parents = commit->parents;
57                 while (parents) {
58                         printf(" %s", sha1_to_hex(parents->item->object.sha1));
59                         parents = parents->next;
60                 }
61         }
62         putchar('\n');
63         if (verbose_header) {
64                 static char pretty_header[16384];
65                 pretty_print_commit(commit_format, commit->buffer, ~0, pretty_header, sizeof(pretty_header));
66                 printf("%s%c", pretty_header, hdr_termination);
67         }
68         fflush(stdout);
69 }
70
71 static int filter_commit(struct commit * commit)
72 {
73         if (stop_traversal && (commit->object.flags & BOUNDARY))
74                 return STOP;
75         if (commit->object.flags & (UNINTERESTING|SHOWN))
76                 return CONTINUE;
77         if (min_age != -1 && (commit->date > min_age))
78                 return CONTINUE;
79         if (max_age != -1 && (commit->date < max_age)) {
80                 stop_traversal=1;
81                 return merge_order?CONTINUE:STOP;
82         }
83         if (max_count != -1 && !max_count--)
84                 return STOP;
85         return DO;
86 }
87
88 static int process_commit(struct commit * commit)
89 {
90         int action=filter_commit(commit);
91
92         if (action == STOP) {
93                 return STOP;
94         }
95
96         if (action == CONTINUE) {
97                 return CONTINUE;
98         }
99
100         show_commit(commit);
101
102         return CONTINUE;
103 }
104
105 static struct object_list **add_object(struct object *obj, struct object_list **p, const char *name)
106 {
107         struct object_list *entry = xmalloc(sizeof(*entry));
108         entry->item = obj;
109         entry->next = *p;
110         entry->name = name;
111         *p = entry;
112         return &entry->next;
113 }
114
115 static struct object_list **process_blob(struct blob *blob, struct object_list **p, const char *name)
116 {
117         struct object *obj = &blob->object;
118
119         if (!blob_objects)
120                 return p;
121         if (obj->flags & (UNINTERESTING | SEEN))
122                 return p;
123         obj->flags |= SEEN;
124         return add_object(obj, p, name);
125 }
126
127 static struct object_list **process_tree(struct tree *tree, struct object_list **p, const char *name)
128 {
129         struct object *obj = &tree->object;
130         struct tree_entry_list *entry;
131
132         if (!tree_objects)
133                 return p;
134         if (obj->flags & (UNINTERESTING | SEEN))
135                 return p;
136         if (parse_tree(tree) < 0)
137                 die("bad tree object %s", sha1_to_hex(obj->sha1));
138         obj->flags |= SEEN;
139         p = add_object(obj, p, name);
140         for (entry = tree->entries ; entry ; entry = entry->next) {
141                 if (entry->directory)
142                         p = process_tree(entry->item.tree, p, entry->name);
143                 else
144                         p = process_blob(entry->item.blob, p, entry->name);
145         }
146         return p;
147 }
148
149 static struct object_list *pending_objects = NULL;
150
151 static void show_commit_list(struct commit_list *list)
152 {
153         struct object_list *objects = NULL, **p = &objects, *pending;
154         while (list) {
155                 struct commit *commit = pop_most_recent_commit(&list, SEEN);
156
157                 p = process_tree(commit->tree, p, "");
158                 if (process_commit(commit) == STOP)
159                         break;
160         }
161         for (pending = pending_objects; pending; pending = pending->next) {
162                 struct object *obj = pending->item;
163                 const char *name = pending->name;
164                 if (obj->flags & (UNINTERESTING | SEEN))
165                         continue;
166                 if (obj->type == tag_type) {
167                         obj->flags |= SEEN;
168                         p = add_object(obj, p, name);
169                         continue;
170                 }
171                 if (obj->type == tree_type) {
172                         p = process_tree((struct tree *)obj, p, name);
173                         continue;
174                 }
175                 if (obj->type == blob_type) {
176                         p = process_blob((struct blob *)obj, p, name);
177                         continue;
178                 }
179                 die("unknown pending object %s (%s)", sha1_to_hex(obj->sha1), name);
180         }
181         while (objects) {
182                 printf("%s %s\n", sha1_to_hex(objects->item->sha1), objects->name);
183                 objects = objects->next;
184         }
185 }
186
187 static void mark_blob_uninteresting(struct blob *blob)
188 {
189         if (!blob_objects)
190                 return;
191         if (blob->object.flags & UNINTERESTING)
192                 return;
193         blob->object.flags |= UNINTERESTING;
194 }
195
196 static void mark_tree_uninteresting(struct tree *tree)
197 {
198         struct object *obj = &tree->object;
199         struct tree_entry_list *entry;
200
201         if (!tree_objects)
202                 return;
203         if (obj->flags & UNINTERESTING)
204                 return;
205         obj->flags |= UNINTERESTING;
206         if (!has_sha1_file(obj->sha1))
207                 return;
208         if (parse_tree(tree) < 0)
209                 die("bad tree %s", sha1_to_hex(obj->sha1));
210         entry = tree->entries;
211         while (entry) {
212                 if (entry->directory)
213                         mark_tree_uninteresting(entry->item.tree);
214                 else
215                         mark_blob_uninteresting(entry->item.blob);
216                 entry = entry->next;
217         }
218 }
219
220 static void mark_parents_uninteresting(struct commit *commit)
221 {
222         struct commit_list *parents = commit->parents;
223
224         if (tree_objects)
225                 mark_tree_uninteresting(commit->tree);
226         while (parents) {
227                 struct commit *commit = parents->item;
228                 commit->object.flags |= UNINTERESTING;
229
230                 /*
231                  * Normally we haven't parsed the parent
232                  * yet, so we won't have a parent of a parent
233                  * here. However, it may turn out that we've
234                  * reached this commit some other way (where it
235                  * wasn't uninteresting), in which case we need
236                  * to mark its parents recursively too..
237                  */
238                 if (commit->parents)
239                         mark_parents_uninteresting(commit);
240
241                 /*
242                  * A missing commit is ok iff its parent is marked 
243                  * uninteresting.
244                  *
245                  * We just mark such a thing parsed, so that when
246                  * it is popped next time around, we won't be trying
247                  * to parse it and get an error.
248                  */
249                 if (!has_sha1_file(commit->object.sha1))
250                         commit->object.parsed = 1;
251                 parents = parents->next;
252         }
253 }
254
255 static int everybody_uninteresting(struct commit_list *orig)
256 {
257         struct commit_list *list = orig;
258         while (list) {
259                 struct commit *commit = list->item;
260                 list = list->next;
261                 if (commit->object.flags & UNINTERESTING)
262                         continue;
263                 return 0;
264         }
265
266         /*
267          * Ok, go back and mark all the edge trees uninteresting,
268          * since otherwise we can have situations where a parent
269          * that was marked uninteresting (and we never even had
270          * to look at) had lots of objects that we don't want to
271          * include.
272          *
273          * NOTE! This still doesn't mean that the object list is
274          * "correct", since we may end up listing objects that
275          * even older commits (that we don't list) do actually
276          * reference, but it gets us to a minimal list (or very
277          * close) in practice.
278          */
279         if (!tree_objects)
280                 return 1;
281
282         while (orig) {
283                 struct commit *commit = orig->item;
284                 if (!parse_commit(commit) && commit->tree)
285                         mark_tree_uninteresting(commit->tree);
286                 orig = orig->next;
287         }
288         return 1;
289 }
290
291 /*
292  * This is a truly stupid algorithm, but it's only
293  * used for bisection, and we just don't care enough.
294  *
295  * We care just barely enough to avoid recursing for
296  * non-merge entries.
297  */
298 static int count_distance(struct commit_list *entry)
299 {
300         int nr = 0;
301
302         while (entry) {
303                 struct commit *commit = entry->item;
304                 struct commit_list *p;
305
306                 if (commit->object.flags & (UNINTERESTING | COUNTED))
307                         break;
308                 nr++;
309                 commit->object.flags |= COUNTED;
310                 p = commit->parents;
311                 entry = p;
312                 if (p) {
313                         p = p->next;
314                         while (p) {
315                                 nr += count_distance(p);
316                                 p = p->next;
317                         }
318                 }
319         }
320         return nr;
321 }
322
323 static void clear_distance(struct commit_list *list)
324 {
325         while (list) {
326                 struct commit *commit = list->item;
327                 commit->object.flags &= ~COUNTED;
328                 list = list->next;
329         }
330 }
331
332 static struct commit_list *find_bisection(struct commit_list *list)
333 {
334         int nr, closest;
335         struct commit_list *p, *best;
336
337         nr = 0;
338         p = list;
339         while (p) {
340                 nr++;
341                 p = p->next;
342         }
343         closest = 0;
344         best = list;
345
346         p = list;
347         while (p) {
348                 int distance = count_distance(p);
349                 clear_distance(list);
350                 if (nr - distance < distance)
351                         distance = nr - distance;
352                 if (distance > closest) {
353                         best = p;
354                         closest = distance;
355                 }
356                 p = p->next;
357         }
358         if (best)
359                 best->next = NULL;
360         return best;
361 }
362
363 static struct commit_list *limit_list(struct commit_list *list)
364 {
365         struct commit_list *newlist = NULL;
366         struct commit_list **p = &newlist;
367         while (list) {
368                 struct commit *commit = pop_most_recent_commit(&list, SEEN);
369                 struct object *obj = &commit->object;
370
371                 if (unpacked && has_sha1_pack(obj->sha1))
372                         obj->flags |= UNINTERESTING;
373                 if (obj->flags & UNINTERESTING) {
374                         mark_parents_uninteresting(commit);
375                         if (everybody_uninteresting(list))
376                                 break;
377                         continue;
378                 }
379                 p = &commit_list_insert(commit, p)->next;
380         }
381         if (bisect_list)
382                 newlist = find_bisection(newlist);
383         return newlist;
384 }
385
386 static void add_pending_object(struct object *obj, const char *name)
387 {
388         add_object(obj, &pending_objects, name);
389 }
390
391 static struct commit *get_commit_reference(const char *name, unsigned int flags)
392 {
393         unsigned char sha1[20];
394         struct object *object;
395
396         if (get_sha1(name, sha1))
397                 usage(rev_list_usage);
398         object = parse_object(sha1);
399         if (!object)
400                 die("bad object %s", name);
401
402         /*
403          * Tag object? Look what it points to..
404          */
405         while (object->type == tag_type) {
406                 struct tag *tag = (struct tag *) object;
407                 object->flags |= flags;
408                 if (tag_objects && !(object->flags & UNINTERESTING))
409                         add_pending_object(object, tag->tag);
410                 object = parse_object(tag->tagged->sha1);
411         }
412
413         /*
414          * Commit object? Just return it, we'll do all the complex
415          * reachability crud.
416          */
417         if (object->type == commit_type) {
418                 struct commit *commit = (struct commit *)object;
419                 object->flags |= flags;
420                 if (parse_commit(commit) < 0)
421                         die("unable to parse commit %s", name);
422                 if (flags & UNINTERESTING)
423                         mark_parents_uninteresting(commit);
424                 return commit;
425         }
426
427         /*
428          * Tree object? Either mark it uniniteresting, or add it
429          * to the list of objects to look at later..
430          */
431         if (object->type == tree_type) {
432                 struct tree *tree = (struct tree *)object;
433                 if (!tree_objects)
434                         return NULL;
435                 if (flags & UNINTERESTING) {
436                         mark_tree_uninteresting(tree);
437                         return NULL;
438                 }
439                 add_pending_object(object, "");
440                 return NULL;
441         }
442
443         /*
444          * Blob object? You know the drill by now..
445          */
446         if (object->type == blob_type) {
447                 struct blob *blob = (struct blob *)object;
448                 if (!blob_objects)
449                         return NULL;
450                 if (flags & UNINTERESTING) {
451                         mark_blob_uninteresting(blob);
452                         return NULL;
453                 }
454                 add_pending_object(object, "");
455                 return NULL;
456         }
457         die("%s is unknown object", name);
458 }
459
460 int main(int argc, char **argv)
461 {
462         struct commit_list *list = NULL;
463         int i, limited = 0;
464
465         for (i = 1 ; i < argc; i++) {
466                 int flags;
467                 char *arg = argv[i];
468                 struct commit *commit;
469
470                 if (!strncmp(arg, "--max-count=", 12)) {
471                         max_count = atoi(arg + 12);
472                         continue;
473                 }
474                 if (!strncmp(arg, "--max-age=", 10)) {
475                         max_age = atoi(arg + 10);
476                         continue;
477                 }
478                 if (!strncmp(arg, "--min-age=", 10)) {
479                         min_age = atoi(arg + 10);
480                         continue;
481                 }
482                 if (!strcmp(arg, "--header")) {
483                         verbose_header = 1;
484                         continue;
485                 }
486                 if (!strncmp(arg, "--pretty", 8)) {
487                         commit_format = get_commit_format(arg+8);
488                         verbose_header = 1;
489                         hdr_termination = '\n';
490                         prefix = "commit ";
491                         continue;
492                 }
493                 if (!strcmp(arg, "--parents")) {
494                         show_parents = 1;
495                         continue;
496                 }
497                 if (!strcmp(arg, "--bisect")) {
498                         bisect_list = 1;
499                         continue;
500                 }
501                 if (!strcmp(arg, "--objects")) {
502                         tag_objects = 1;
503                         tree_objects = 1;
504                         blob_objects = 1;
505                         continue;
506                 }
507                 if (!strcmp(arg, "--unpacked")) {
508                         unpacked = 1;
509                         limited = 1;
510                         continue;
511                 }
512                 if (!strcmp(arg, "--merge-order")) {
513                         merge_order = 1;
514                         continue;
515                 }
516                 if (!strcmp(arg, "--show-breaks")) {
517                         show_breaks = 1;
518                         continue;
519                 }
520                 if (!strcmp(arg, "--topo-order")) {
521                         topo_order = 1;
522                         limited = 1;
523                         continue;
524                 }
525
526                 flags = 0;
527                 if (*arg == '^') {
528                         flags = UNINTERESTING;
529                         arg++;
530                         limited = 1;
531                 }
532                 if (show_breaks && !merge_order)
533                         usage(rev_list_usage);
534                 commit = get_commit_reference(arg, flags);
535                 if (!commit)
536                         continue;
537                 if (commit->object.flags & SEEN)
538                         continue;
539                 commit->object.flags |= SEEN;
540                 commit_list_insert(commit, &list);
541         }
542
543         if (!merge_order) {             
544                 sort_by_date(&list);
545                 if (limited)
546                         list = limit_list(list);
547                 if (topo_order)
548                         sort_in_topological_order(&list);
549                 show_commit_list(list);
550         } else {
551                 if (sort_list_in_merge_order(list, &process_commit)) {
552                           die("merge order sort failed\n");
553                 }
554         }
555
556         return 0;
557 }