graph.con commit graph API: fix "git log --graph --first-parent" (a0ebe57)
   1#include "cache.h"
   2#include "commit.h"
   3#include "graph.h"
   4#include "diff.h"
   5#include "revision.h"
   6
   7/*
   8 * TODO:
   9 * - Add colors to the graph.
  10 *   Pick a color for each column, and print all characters
  11 *   in that column with the specified color.
  12 *
  13 * - Limit the number of columns, similar to the way gitk does.
  14 *   If we reach more than a specified number of columns, omit
  15 *   sections of some columns.
  16 *
  17 * - The output during the GRAPH_PRE_COMMIT and GRAPH_COLLAPSING states
  18 *   could be made more compact by printing horizontal lines, instead of
  19 *   long diagonal lines.  For example, during collapsing, something like
  20 *   this:          instead of this:
  21 *   | | | | |      | | | | |
  22 *   | |_|_|/       | | | |/
  23 *   |/| | |        | | |/|
  24 *   | | | |        | |/| |
  25 *                  |/| | |
  26 *                  | | | |
  27 *
  28 *   If there are several parallel diagonal lines, they will need to be
  29 *   replaced with horizontal lines on subsequent rows.
  30 */
  31
  32struct column {
  33        /*
  34         * The parent commit of this column.
  35         */
  36        struct commit *commit;
  37        /*
  38         * XXX: Once we add support for colors, struct column could also
  39         * contain the color of its branch line.
  40         */
  41};
  42
  43enum graph_state {
  44        GRAPH_PADDING,
  45        GRAPH_SKIP,
  46        GRAPH_PRE_COMMIT,
  47        GRAPH_COMMIT,
  48        GRAPH_POST_MERGE,
  49        GRAPH_COLLAPSING
  50};
  51
  52struct git_graph {
  53        /*
  54         * The commit currently being processed
  55         */
  56        struct commit *commit;
  57        /* The rev-info used for the current traversal */
  58        struct rev_info *revs;
  59        /*
  60         * The number of interesting parents that this commit has.
  61         *
  62         * Note that this is not the same as the actual number of parents.
  63         * This count excludes parents that won't be printed in the graph
  64         * output, as determined by graph_is_interesting().
  65         */
  66        int num_parents;
  67        /*
  68         * The width of the graph output for this commit.
  69         * All rows for this commit are padded to this width, so that
  70         * messages printed after the graph output are aligned.
  71         */
  72        int width;
  73        /*
  74         * The next expansion row to print
  75         * when state is GRAPH_PRE_COMMIT
  76         */
  77        int expansion_row;
  78        /*
  79         * The current output state.
  80         * This tells us what kind of line graph_next_line() should output.
  81         */
  82        enum graph_state state;
  83        /*
  84         * The output state for the previous line of output.
  85         * This is primarily used to determine how the first merge line
  86         * should appear, based on the last line of the previous commit.
  87         */
  88        enum graph_state prev_state;
  89        /*
  90         * The index of the column that refers to this commit.
  91         *
  92         * If none of the incoming columns refer to this commit,
  93         * this will be equal to num_columns.
  94         */
  95        int commit_index;
  96        /*
  97         * The commit_index for the previously displayed commit.
  98         *
  99         * This is used to determine how the first line of a merge
 100         * graph output should appear, based on the last line of the
 101         * previous commit.
 102         */
 103        int prev_commit_index;
 104        /*
 105         * The maximum number of columns that can be stored in the columns
 106         * and new_columns arrays.  This is also half the number of entries
 107         * that can be stored in the mapping and new_mapping arrays.
 108         */
 109        int column_capacity;
 110        /*
 111         * The number of columns (also called "branch lines" in some places)
 112         */
 113        int num_columns;
 114        /*
 115         * The number of columns in the new_columns array
 116         */
 117        int num_new_columns;
 118        /*
 119         * The number of entries in the mapping array
 120         */
 121        int mapping_size;
 122        /*
 123         * The column state before we output the current commit.
 124         */
 125        struct column *columns;
 126        /*
 127         * The new column state after we output the current commit.
 128         * Only valid when state is GRAPH_COLLAPSING.
 129         */
 130        struct column *new_columns;
 131        /*
 132         * An array that tracks the current state of each
 133         * character in the output line during state GRAPH_COLLAPSING.
 134         * Each entry is -1 if this character is empty, or a non-negative
 135         * integer if the character contains a branch line.  The value of
 136         * the integer indicates the target position for this branch line.
 137         * (I.e., this array maps the current column positions to their
 138         * desired positions.)
 139         *
 140         * The maximum capacity of this array is always
 141         * sizeof(int) * 2 * column_capacity.
 142         */
 143        int *mapping;
 144        /*
 145         * A temporary array for computing the next mapping state
 146         * while we are outputting a mapping line.  This is stored as part
 147         * of the git_graph simply so we don't have to allocate a new
 148         * temporary array each time we have to output a collapsing line.
 149         */
 150        int *new_mapping;
 151};
 152
 153struct git_graph *graph_init(struct rev_info *opt)
 154{
 155        struct git_graph *graph = xmalloc(sizeof(struct git_graph));
 156        graph->commit = NULL;
 157        graph->revs = opt;
 158        graph->num_parents = 0;
 159        graph->expansion_row = 0;
 160        graph->state = GRAPH_PADDING;
 161        graph->prev_state = GRAPH_PADDING;
 162        graph->commit_index = 0;
 163        graph->prev_commit_index = 0;
 164        graph->num_columns = 0;
 165        graph->num_new_columns = 0;
 166        graph->mapping_size = 0;
 167
 168        /*
 169         * Allocate a reasonably large default number of columns
 170         * We'll automatically grow columns later if we need more room.
 171         */
 172        graph->column_capacity = 30;
 173        graph->columns = xmalloc(sizeof(struct column) *
 174                                 graph->column_capacity);
 175        graph->new_columns = xmalloc(sizeof(struct column) *
 176                                     graph->column_capacity);
 177        graph->mapping = xmalloc(sizeof(int) * 2 * graph->column_capacity);
 178        graph->new_mapping = xmalloc(sizeof(int) * 2 * graph->column_capacity);
 179
 180        return graph;
 181}
 182
 183void graph_release(struct git_graph *graph)
 184{
 185        free(graph->columns);
 186        free(graph->new_columns);
 187        free(graph->mapping);
 188        free(graph);
 189}
 190
 191static void graph_update_state(struct git_graph *graph, enum graph_state s)
 192{
 193        graph->prev_state = graph->state;
 194        graph->state = s;
 195}
 196
 197static void graph_ensure_capacity(struct git_graph *graph, int num_columns)
 198{
 199        if (graph->column_capacity >= num_columns)
 200                return;
 201
 202        do {
 203                graph->column_capacity *= 2;
 204        } while (graph->column_capacity < num_columns);
 205
 206        graph->columns = xrealloc(graph->columns,
 207                                  sizeof(struct column) *
 208                                  graph->column_capacity);
 209        graph->new_columns = xrealloc(graph->new_columns,
 210                                      sizeof(struct column) *
 211                                      graph->column_capacity);
 212        graph->mapping = xrealloc(graph->mapping,
 213                                  sizeof(int) * 2 * graph->column_capacity);
 214        graph->new_mapping = xrealloc(graph->new_mapping,
 215                                      sizeof(int) * 2 * graph->column_capacity);
 216}
 217
 218/*
 219 * Returns 1 if the commit will be printed in the graph output,
 220 * and 0 otherwise.
 221 */
 222static int graph_is_interesting(struct git_graph *graph, struct commit *commit)
 223{
 224        /*
 225         * If revs->boundary is set, commits whose children have
 226         * been shown are always interesting, even if they have the
 227         * UNINTERESTING or TREESAME flags set.
 228         */
 229        if (graph->revs && graph->revs->boundary) {
 230                if (commit->object.flags & CHILD_SHOWN)
 231                        return 1;
 232        }
 233
 234        /*
 235         * Uninteresting and pruned commits won't be printed
 236         */
 237        return (commit->object.flags & (UNINTERESTING | TREESAME)) ? 0 : 1;
 238}
 239
 240static struct commit_list *next_interesting_parent(struct git_graph *graph,
 241                                                   struct commit_list *orig)
 242{
 243        struct commit_list *list;
 244
 245        /*
 246         * If revs->first_parent_only is set, only the first
 247         * parent is interesting.  None of the others are.
 248         */
 249        if (graph->revs->first_parent_only)
 250                return NULL;
 251
 252        /*
 253         * Return the next interesting commit after orig
 254         */
 255        for (list = orig->next; list; list = list->next) {
 256                if (graph_is_interesting(graph, list->item))
 257                        return list;
 258        }
 259
 260        return NULL;
 261}
 262
 263static struct commit_list *first_interesting_parent(struct git_graph *graph)
 264{
 265        struct commit_list *parents = graph->commit->parents;
 266
 267        /*
 268         * If this commit has no parents, ignore it
 269         */
 270        if (!parents)
 271                return NULL;
 272
 273        /*
 274         * If the first parent is interesting, return it
 275         */
 276        if (graph_is_interesting(graph, parents->item))
 277                return parents;
 278
 279        /*
 280         * Otherwise, call next_interesting_parent() to get
 281         * the next interesting parent
 282         */
 283        return next_interesting_parent(graph, parents);
 284}
 285
 286static void graph_insert_into_new_columns(struct git_graph *graph,
 287                                          struct commit *commit,
 288                                          int *mapping_index)
 289{
 290        int i;
 291
 292        /*
 293         * If the commit is already in the new_columns list, we don't need to
 294         * add it.  Just update the mapping correctly.
 295         */
 296        for (i = 0; i < graph->num_new_columns; i++) {
 297                if (graph->new_columns[i].commit == commit) {
 298                        graph->mapping[*mapping_index] = i;
 299                        *mapping_index += 2;
 300                        return;
 301                }
 302        }
 303
 304        /*
 305         * This commit isn't already in new_columns.  Add it.
 306         */
 307        graph->new_columns[graph->num_new_columns].commit = commit;
 308        graph->mapping[*mapping_index] = graph->num_new_columns;
 309        *mapping_index += 2;
 310        graph->num_new_columns++;
 311}
 312
 313static void graph_update_width(struct git_graph *graph,
 314                               int is_commit_in_existing_columns)
 315{
 316        /*
 317         * Compute the width needed to display the graph for this commit.
 318         * This is the maximum width needed for any row.  All other rows
 319         * will be padded to this width.
 320         *
 321         * Compute the number of columns in the widest row:
 322         * Count each existing column (graph->num_columns), and each new
 323         * column added by this commit.
 324         */
 325        int max_cols = graph->num_columns + graph->num_parents;
 326
 327        /*
 328         * Even if the current commit has no parents to be printed, it
 329         * still takes up a column for itself.
 330         */
 331        if (graph->num_parents < 1)
 332                max_cols++;
 333
 334        /*
 335         * We added a column for the the current commit as part of
 336         * graph->num_parents.  If the current commit was already in
 337         * graph->columns, then we have double counted it.
 338         */
 339        if (is_commit_in_existing_columns)
 340                max_cols--;
 341
 342        /*
 343         * Each column takes up 2 spaces
 344         */
 345        graph->width = max_cols * 2;
 346}
 347
 348static void graph_update_columns(struct git_graph *graph)
 349{
 350        struct commit_list *parent;
 351        struct column *tmp_columns;
 352        int max_new_columns;
 353        int mapping_idx;
 354        int i, seen_this, is_commit_in_columns;
 355
 356        /*
 357         * Swap graph->columns with graph->new_columns
 358         * graph->columns contains the state for the previous commit,
 359         * and new_columns now contains the state for our commit.
 360         *
 361         * We'll re-use the old columns array as storage to compute the new
 362         * columns list for the commit after this one.
 363         */
 364        tmp_columns = graph->columns;
 365        graph->columns = graph->new_columns;
 366        graph->num_columns = graph->num_new_columns;
 367
 368        graph->new_columns = tmp_columns;
 369        graph->num_new_columns = 0;
 370
 371        /*
 372         * Now update new_columns and mapping with the information for the
 373         * commit after this one.
 374         *
 375         * First, make sure we have enough room.  At most, there will
 376         * be graph->num_columns + graph->num_parents columns for the next
 377         * commit.
 378         */
 379        max_new_columns = graph->num_columns + graph->num_parents;
 380        graph_ensure_capacity(graph, max_new_columns);
 381
 382        /*
 383         * Clear out graph->mapping
 384         */
 385        graph->mapping_size = 2 * max_new_columns;
 386        for (i = 0; i < graph->mapping_size; i++)
 387                graph->mapping[i] = -1;
 388
 389        /*
 390         * Populate graph->new_columns and graph->mapping
 391         *
 392         * Some of the parents of this commit may already be in
 393         * graph->columns.  If so, graph->new_columns should only contain a
 394         * single entry for each such commit.  graph->mapping should
 395         * contain information about where each current branch line is
 396         * supposed to end up after the collapsing is performed.
 397         */
 398        seen_this = 0;
 399        mapping_idx = 0;
 400        is_commit_in_columns = 1;
 401        for (i = 0; i <= graph->num_columns; i++) {
 402                struct commit *col_commit;
 403                if (i == graph->num_columns) {
 404                        if (seen_this)
 405                                break;
 406                        is_commit_in_columns = 0;
 407                        col_commit = graph->commit;
 408                } else {
 409                        col_commit = graph->columns[i].commit;
 410                }
 411
 412                if (col_commit == graph->commit) {
 413                        int old_mapping_idx = mapping_idx;
 414                        seen_this = 1;
 415                        graph->commit_index = i;
 416                        for (parent = first_interesting_parent(graph);
 417                             parent;
 418                             parent = next_interesting_parent(graph, parent)) {
 419                                graph_insert_into_new_columns(graph,
 420                                                              parent->item,
 421                                                              &mapping_idx);
 422                        }
 423                        /*
 424                         * We always need to increment mapping_idx by at
 425                         * least 2, even if it has no interesting parents.
 426                         * The current commit always takes up at least 2
 427                         * spaces.
 428                         */
 429                        if (mapping_idx == old_mapping_idx)
 430                                mapping_idx += 2;
 431                } else {
 432                        graph_insert_into_new_columns(graph, col_commit,
 433                                                      &mapping_idx);
 434                }
 435        }
 436
 437        /*
 438         * Shrink mapping_size to be the minimum necessary
 439         */
 440        while (graph->mapping_size > 1 &&
 441               graph->mapping[graph->mapping_size - 1] < 0)
 442                graph->mapping_size--;
 443
 444        /*
 445         * Compute graph->width for this commit
 446         */
 447        graph_update_width(graph, is_commit_in_columns);
 448}
 449
 450void graph_update(struct git_graph *graph, struct commit *commit)
 451{
 452        struct commit_list *parent;
 453
 454        /*
 455         * Set the new commit
 456         */
 457        graph->commit = commit;
 458
 459        /*
 460         * Count how many interesting parents this commit has
 461         */
 462        graph->num_parents = 0;
 463        for (parent = first_interesting_parent(graph);
 464             parent;
 465             parent = next_interesting_parent(graph, parent))
 466        {
 467                graph->num_parents++;
 468        }
 469
 470        /*
 471         * Store the old commit_index in prev_commit_index.
 472         * graph_update_columns() will update graph->commit_index for this
 473         * commit.
 474         */
 475        graph->prev_commit_index = graph->commit_index;
 476
 477        /*
 478         * Call graph_update_columns() to update
 479         * columns, new_columns, and mapping.
 480         */
 481        graph_update_columns(graph);
 482
 483        graph->expansion_row = 0;
 484
 485        /*
 486         * Update graph->state.
 487         * Note that we don't call graph_update_state() here, since
 488         * we don't want to update graph->prev_state.  No line for
 489         * graph->state was ever printed.
 490         *
 491         * If the previous commit didn't get to the GRAPH_PADDING state,
 492         * it never finished its output.  Goto GRAPH_SKIP, to print out
 493         * a line to indicate that portion of the graph is missing.
 494         *
 495         * If there are 3 or more parents, we may need to print extra rows
 496         * before the commit, to expand the branch lines around it and make
 497         * room for it.  We need to do this only if there is a branch row
 498         * (or more) to the right of this commit.
 499         *
 500         * If there are less than 3 parents, we can immediately print the
 501         * commit line.
 502         */
 503        if (graph->state != GRAPH_PADDING)
 504                graph->state = GRAPH_SKIP;
 505        else if (graph->num_parents >= 3 &&
 506                 graph->commit_index < (graph->num_columns - 1))
 507                graph->state = GRAPH_PRE_COMMIT;
 508        else
 509                graph->state = GRAPH_COMMIT;
 510}
 511
 512static int graph_is_mapping_correct(struct git_graph *graph)
 513{
 514        int i;
 515
 516        /*
 517         * The mapping is up to date if each entry is at its target,
 518         * or is 1 greater than its target.
 519         * (If it is 1 greater than the target, '/' will be printed, so it
 520         * will look correct on the next row.)
 521         */
 522        for (i = 0; i < graph->mapping_size; i++) {
 523                int target = graph->mapping[i];
 524                if (target < 0)
 525                        continue;
 526                if (target == (i / 2))
 527                        continue;
 528                return 0;
 529        }
 530
 531        return 1;
 532}
 533
 534static void graph_pad_horizontally(struct git_graph *graph, struct strbuf *sb)
 535{
 536        /*
 537         * Add additional spaces to the end of the strbuf, so that all
 538         * lines for a particular commit have the same width.
 539         *
 540         * This way, fields printed to the right of the graph will remain
 541         * aligned for the entire commit.
 542         */
 543        int extra;
 544        if (sb->len >= graph->width)
 545                return;
 546
 547        extra = graph->width - sb->len;
 548        strbuf_addf(sb, "%*s", (int) extra, "");
 549}
 550
 551static void graph_output_padding_line(struct git_graph *graph,
 552                                      struct strbuf *sb)
 553{
 554        int i;
 555
 556        /*
 557         * We could conceivable be called with a NULL commit
 558         * if our caller has a bug, and invokes graph_next_line()
 559         * immediately after graph_init(), without first calling
 560         * graph_update().  Return without outputting anything in this
 561         * case.
 562         */
 563        if (!graph->commit)
 564                return;
 565
 566        /*
 567         * Output a padding row, that leaves all branch lines unchanged
 568         */
 569        for (i = 0; i < graph->num_new_columns; i++) {
 570                strbuf_addstr(sb, "| ");
 571        }
 572
 573        graph_pad_horizontally(graph, sb);
 574}
 575
 576static void graph_output_skip_line(struct git_graph *graph, struct strbuf *sb)
 577{
 578        /*
 579         * Output an ellipsis to indicate that a portion
 580         * of the graph is missing.
 581         */
 582        strbuf_addstr(sb, "...");
 583        graph_pad_horizontally(graph, sb);
 584
 585        if (graph->num_parents >= 3 &&
 586            graph->commit_index < (graph->num_columns - 1))
 587                graph_update_state(graph, GRAPH_PRE_COMMIT);
 588        else
 589                graph_update_state(graph, GRAPH_COMMIT);
 590}
 591
 592static void graph_output_pre_commit_line(struct git_graph *graph,
 593                                         struct strbuf *sb)
 594{
 595        int num_expansion_rows;
 596        int i, seen_this;
 597
 598        /*
 599         * This function formats a row that increases the space around a commit
 600         * with multiple parents, to make room for it.  It should only be
 601         * called when there are 3 or more parents.
 602         *
 603         * We need 2 extra rows for every parent over 2.
 604         */
 605        assert(graph->num_parents >= 3);
 606        num_expansion_rows = (graph->num_parents - 2) * 2;
 607
 608        /*
 609         * graph->expansion_row tracks the current expansion row we are on.
 610         * It should be in the range [0, num_expansion_rows - 1]
 611         */
 612        assert(0 <= graph->expansion_row &&
 613               graph->expansion_row < num_expansion_rows);
 614
 615        /*
 616         * Output the row
 617         */
 618        seen_this = 0;
 619        for (i = 0; i < graph->num_columns; i++) {
 620                struct column *col = &graph->columns[i];
 621                if (col->commit == graph->commit) {
 622                        seen_this = 1;
 623                        strbuf_addf(sb, "| %*s", graph->expansion_row, "");
 624                } else if (seen_this && (graph->expansion_row == 0)) {
 625                        /*
 626                         * This is the first line of the pre-commit output.
 627                         * If the previous commit was a merge commit and
 628                         * ended in the GRAPH_POST_MERGE state, all branch
 629                         * lines after graph->prev_commit_index were
 630                         * printed as "\" on the previous line.  Continue
 631                         * to print them as "\" on this line.  Otherwise,
 632                         * print the branch lines as "|".
 633                         */
 634                        if (graph->prev_state == GRAPH_POST_MERGE &&
 635                            graph->prev_commit_index < i)
 636                                strbuf_addstr(sb, "\\ ");
 637                        else
 638                                strbuf_addstr(sb, "| ");
 639                } else if (seen_this && (graph->expansion_row > 0)) {
 640                        strbuf_addstr(sb, "\\ ");
 641                } else {
 642                        strbuf_addstr(sb, "| ");
 643                }
 644        }
 645
 646        graph_pad_horizontally(graph, sb);
 647
 648        /*
 649         * Increment graph->expansion_row,
 650         * and move to state GRAPH_COMMIT if necessary
 651         */
 652        graph->expansion_row++;
 653        if (graph->expansion_row >= num_expansion_rows)
 654                graph_update_state(graph, GRAPH_COMMIT);
 655}
 656
 657static void graph_output_commit_char(struct git_graph *graph, struct strbuf *sb)
 658{
 659        /*
 660         * For boundary commits, print 'o'
 661         * (We should only see boundary commits when revs->boundary is set.)
 662         */
 663        if (graph->commit->object.flags & BOUNDARY) {
 664                assert(graph->revs->boundary);
 665                strbuf_addch(sb, 'o');
 666                return;
 667        }
 668
 669        /*
 670         * If revs->left_right is set, print '<' for commits that
 671         * come from the left side, and '>' for commits from the right
 672         * side.
 673         */
 674        if (graph->revs && graph->revs->left_right) {
 675                if (graph->commit->object.flags & SYMMETRIC_LEFT)
 676                        strbuf_addch(sb, '<');
 677                else
 678                        strbuf_addch(sb, '>');
 679                return;
 680        }
 681
 682        /*
 683         * Print 'M' for merge commits
 684         *
 685         * Note that we don't check graph->num_parents to determine if the
 686         * commit is a merge, since that only tracks the number of
 687         * "interesting" parents.  We want to print 'M' for merge commits
 688         * even if they have less than 2 interesting parents.
 689         */
 690        if (graph->commit->parents != NULL &&
 691            graph->commit->parents->next != NULL) {
 692                strbuf_addch(sb, 'M');
 693                return;
 694        }
 695
 696        /*
 697         * Print '*' in all other cases
 698         */
 699        strbuf_addch(sb, '*');
 700}
 701
 702void graph_output_commit_line(struct git_graph *graph, struct strbuf *sb)
 703{
 704        int seen_this = 0;
 705        int i, j;
 706
 707        /*
 708         * Output the row containing this commit
 709         * Iterate up to and including graph->num_columns,
 710         * since the current commit may not be in any of the existing
 711         * columns.  (This happens when the current commit doesn't have any
 712         * children that we have already processed.)
 713         */
 714        seen_this = 0;
 715        for (i = 0; i <= graph->num_columns; i++) {
 716                struct commit *col_commit;
 717                if (i == graph->num_columns) {
 718                        if (seen_this)
 719                                break;
 720                        col_commit = graph->commit;
 721                } else {
 722                        col_commit = graph->columns[i].commit;
 723                }
 724
 725                if (col_commit == graph->commit) {
 726                        seen_this = 1;
 727                        graph_output_commit_char(graph, sb);
 728
 729                        if (graph->num_parents < 3)
 730                                strbuf_addch(sb, ' ');
 731                        else {
 732                                int num_dashes =
 733                                        ((graph->num_parents - 2) * 2) - 1;
 734                                for (j = 0; j < num_dashes; j++)
 735                                        strbuf_addch(sb, '-');
 736                                strbuf_addstr(sb, ". ");
 737                        }
 738                } else if (seen_this && (graph->num_parents > 2)) {
 739                        strbuf_addstr(sb, "\\ ");
 740                } else if (seen_this && (graph->num_parents == 2)) {
 741                        /*
 742                         * This is a 2-way merge commit.
 743                         * There is no GRAPH_PRE_COMMIT stage for 2-way
 744                         * merges, so this is the first line of output
 745                         * for this commit.  Check to see what the previous
 746                         * line of output was.
 747                         *
 748                         * If it was GRAPH_POST_MERGE, the branch line
 749                         * coming into this commit may have been '\',
 750                         * and not '|' or '/'.  If so, output the branch
 751                         * line as '\' on this line, instead of '|'.  This
 752                         * makes the output look nicer.
 753                         */
 754                        if (graph->prev_state == GRAPH_POST_MERGE &&
 755                            graph->prev_commit_index < i)
 756                                strbuf_addstr(sb, "\\ ");
 757                        else
 758                                strbuf_addstr(sb, "| ");
 759                } else {
 760                        strbuf_addstr(sb, "| ");
 761                }
 762        }
 763
 764        graph_pad_horizontally(graph, sb);
 765
 766        /*
 767         * Update graph->state
 768         */
 769        if (graph->num_parents > 1)
 770                graph_update_state(graph, GRAPH_POST_MERGE);
 771        else if (graph_is_mapping_correct(graph))
 772                graph_update_state(graph, GRAPH_PADDING);
 773        else
 774                graph_update_state(graph, GRAPH_COLLAPSING);
 775}
 776
 777void graph_output_post_merge_line(struct git_graph *graph, struct strbuf *sb)
 778{
 779        int seen_this = 0;
 780        int i, j;
 781
 782        /*
 783         * Output the post-merge row
 784         */
 785        for (i = 0; i <= graph->num_columns; i++) {
 786                struct commit *col_commit;
 787                if (i == graph->num_columns) {
 788                        if (seen_this)
 789                                break;
 790                        col_commit = graph->commit;
 791                } else {
 792                        col_commit = graph->columns[i].commit;
 793                }
 794
 795                if (col_commit == graph->commit) {
 796                        seen_this = 1;
 797                        strbuf_addch(sb, '|');
 798                        for (j = 0; j < graph->num_parents - 1; j++)
 799                                strbuf_addstr(sb, "\\ ");
 800                } else if (seen_this) {
 801                        strbuf_addstr(sb, "\\ ");
 802                } else {
 803                        strbuf_addstr(sb, "| ");
 804                }
 805        }
 806
 807        graph_pad_horizontally(graph, sb);
 808
 809        /*
 810         * Update graph->state
 811         */
 812        if (graph_is_mapping_correct(graph))
 813                graph_update_state(graph, GRAPH_PADDING);
 814        else
 815                graph_update_state(graph, GRAPH_COLLAPSING);
 816}
 817
 818void graph_output_collapsing_line(struct git_graph *graph, struct strbuf *sb)
 819{
 820        int i;
 821        int *tmp_mapping;
 822
 823        /*
 824         * Clear out the new_mapping array
 825         */
 826        for (i = 0; i < graph->mapping_size; i++)
 827                graph->new_mapping[i] = -1;
 828
 829        for (i = 0; i < graph->mapping_size; i++) {
 830                int target = graph->mapping[i];
 831                if (target < 0)
 832                        continue;
 833
 834                /*
 835                 * Since update_columns() always inserts the leftmost
 836                 * column first, each branch's target location should
 837                 * always be either its current location or to the left of
 838                 * its current location.
 839                 *
 840                 * We never have to move branches to the right.  This makes
 841                 * the graph much more legible, since whenever branches
 842                 * cross, only one is moving directions.
 843                 */
 844                assert(target * 2 <= i);
 845
 846                if (target * 2 == i) {
 847                        /*
 848                         * This column is already in the
 849                         * correct place
 850                         */
 851                        assert(graph->new_mapping[i] == -1);
 852                        graph->new_mapping[i] = target;
 853                } else if (graph->new_mapping[i - 1] < 0) {
 854                        /*
 855                         * Nothing is to the left.
 856                         * Move to the left by one
 857                         */
 858                        graph->new_mapping[i - 1] = target;
 859                } else if (graph->new_mapping[i - 1] == target) {
 860                        /*
 861                         * There is a branch line to our left
 862                         * already, and it is our target.  We
 863                         * combine with this line, since we share
 864                         * the same parent commit.
 865                         *
 866                         * We don't have to add anything to the
 867                         * output or new_mapping, since the
 868                         * existing branch line has already taken
 869                         * care of it.
 870                         */
 871                } else {
 872                        /*
 873                         * There is a branch line to our left,
 874                         * but it isn't our target.  We need to
 875                         * cross over it.
 876                         *
 877                         * The space just to the left of this
 878                         * branch should always be empty.
 879                         */
 880                        assert(graph->new_mapping[i - 1] > target);
 881                        assert(graph->new_mapping[i - 2] < 0);
 882                        graph->new_mapping[i - 2] = target;
 883                }
 884        }
 885
 886        /*
 887         * The new mapping may be 1 smaller than the old mapping
 888         */
 889        if (graph->new_mapping[graph->mapping_size - 1] < 0)
 890                graph->mapping_size--;
 891
 892        /*
 893         * Output out a line based on the new mapping info
 894         */
 895        for (i = 0; i < graph->mapping_size; i++) {
 896                int target = graph->new_mapping[i];
 897                if (target < 0)
 898                        strbuf_addch(sb, ' ');
 899                else if (target * 2 == i)
 900                        strbuf_addch(sb, '|');
 901                else
 902                        strbuf_addch(sb, '/');
 903        }
 904
 905        graph_pad_horizontally(graph, sb);
 906
 907        /*
 908         * Swap mapping and new_mapping
 909         */
 910        tmp_mapping = graph->mapping;
 911        graph->mapping = graph->new_mapping;
 912        graph->new_mapping = tmp_mapping;
 913
 914        /*
 915         * If graph->mapping indicates that all of the branch lines
 916         * are already in the correct positions, we are done.
 917         * Otherwise, we need to collapse some branch lines together.
 918         */
 919        if (graph_is_mapping_correct(graph))
 920                graph_update_state(graph, GRAPH_PADDING);
 921}
 922
 923int graph_next_line(struct git_graph *graph, struct strbuf *sb)
 924{
 925        switch (graph->state) {
 926        case GRAPH_PADDING:
 927                graph_output_padding_line(graph, sb);
 928                return 0;
 929        case GRAPH_SKIP:
 930                graph_output_skip_line(graph, sb);
 931                return 0;
 932        case GRAPH_PRE_COMMIT:
 933                graph_output_pre_commit_line(graph, sb);
 934                return 0;
 935        case GRAPH_COMMIT:
 936                graph_output_commit_line(graph, sb);
 937                return 1;
 938        case GRAPH_POST_MERGE:
 939                graph_output_post_merge_line(graph, sb);
 940                return 0;
 941        case GRAPH_COLLAPSING:
 942                graph_output_collapsing_line(graph, sb);
 943                return 0;
 944        }
 945
 946        assert(0);
 947        return 0;
 948}
 949
 950void graph_padding_line(struct git_graph *graph, struct strbuf *sb)
 951{
 952        int i, j;
 953
 954        if (graph->state != GRAPH_COMMIT) {
 955                graph_next_line(graph, sb);
 956                return;
 957        }
 958
 959        /*
 960         * Output the row containing this commit
 961         * Iterate up to and including graph->num_columns,
 962         * since the current commit may not be in any of the existing
 963         * columns.  (This happens when the current commit doesn't have any
 964         * children that we have already processed.)
 965         */
 966        for (i = 0; i < graph->num_columns; i++) {
 967                struct commit *col_commit = graph->columns[i].commit;
 968                if (col_commit == graph->commit) {
 969                        strbuf_addch(sb, '|');
 970
 971                        if (graph->num_parents < 3)
 972                                strbuf_addch(sb, ' ');
 973                        else {
 974                                int num_spaces = ((graph->num_parents - 2) * 2);
 975                                for (j = 0; j < num_spaces; j++)
 976                                        strbuf_addch(sb, ' ');
 977                        }
 978                } else {
 979                        strbuf_addstr(sb, "| ");
 980                }
 981        }
 982
 983        graph_pad_horizontally(graph, sb);
 984
 985        /*
 986         * Update graph->prev_state since we have output a padding line
 987         */
 988        graph->prev_state = GRAPH_PADDING;
 989}
 990
 991int graph_is_commit_finished(struct git_graph const *graph)
 992{
 993        return (graph->state == GRAPH_PADDING);
 994}
 995
 996void graph_show_commit(struct git_graph *graph)
 997{
 998        struct strbuf msgbuf;
 999        int shown_commit_line = 0;
1000
1001        if (!graph)
1002                return;
1003
1004        strbuf_init(&msgbuf, 0);
1005
1006        while (!shown_commit_line) {
1007                shown_commit_line = graph_next_line(graph, &msgbuf);
1008                fwrite(msgbuf.buf, sizeof(char), msgbuf.len, stdout);
1009                if (!shown_commit_line)
1010                        putchar('\n');
1011                strbuf_setlen(&msgbuf, 0);
1012        }
1013
1014        strbuf_release(&msgbuf);
1015}
1016
1017void graph_show_oneline(struct git_graph *graph)
1018{
1019        struct strbuf msgbuf;
1020
1021        if (!graph)
1022                return;
1023
1024        strbuf_init(&msgbuf, 0);
1025        graph_next_line(graph, &msgbuf);
1026        fwrite(msgbuf.buf, sizeof(char), msgbuf.len, stdout);
1027        strbuf_release(&msgbuf);
1028}
1029
1030void graph_show_padding(struct git_graph *graph)
1031{
1032        struct strbuf msgbuf;
1033
1034        if (!graph)
1035                return;
1036
1037        strbuf_init(&msgbuf, 0);
1038        graph_padding_line(graph, &msgbuf);
1039        fwrite(msgbuf.buf, sizeof(char), msgbuf.len, stdout);
1040        strbuf_release(&msgbuf);
1041}
1042
1043int graph_show_remainder(struct git_graph *graph)
1044{
1045        struct strbuf msgbuf;
1046        int shown = 0;
1047
1048        if (!graph)
1049                return 0;
1050
1051        if (graph_is_commit_finished(graph))
1052                return 0;
1053
1054        strbuf_init(&msgbuf, 0);
1055        for (;;) {
1056                graph_next_line(graph, &msgbuf);
1057                fwrite(msgbuf.buf, sizeof(char), msgbuf.len, stdout);
1058                strbuf_setlen(&msgbuf, 0);
1059                shown = 1;
1060
1061                if (!graph_is_commit_finished(graph))
1062                        putchar('\n');
1063                else
1064                        break;
1065        }
1066        strbuf_release(&msgbuf);
1067
1068        return shown;
1069}
1070
1071
1072void graph_show_strbuf(struct git_graph *graph, struct strbuf const *sb)
1073{
1074        char *p;
1075
1076        if (!graph) {
1077                fwrite(sb->buf, sizeof(char), sb->len, stdout);
1078                return;
1079        }
1080
1081        /*
1082         * Print the strbuf line by line,
1083         * and display the graph info before each line but the first.
1084         */
1085        p = sb->buf;
1086        while (p) {
1087                size_t len;
1088                char *next_p = strchr(p, '\n');
1089                if (next_p) {
1090                        next_p++;
1091                        len = next_p - p;
1092                } else {
1093                        len = (sb->buf + sb->len) - p;
1094                }
1095                fwrite(p, sizeof(char), len, stdout);
1096                if (next_p && *next_p != '\0')
1097                        graph_show_oneline(graph);
1098                p = next_p;
1099        }
1100}
1101
1102void graph_show_commit_msg(struct git_graph *graph,
1103                           struct strbuf const *sb)
1104{
1105        int newline_terminated;
1106
1107        if (!graph) {
1108                /*
1109                 * If there's no graph, just print the message buffer.
1110                 *
1111                 * The message buffer for CMIT_FMT_ONELINE and
1112                 * CMIT_FMT_USERFORMAT are already missing a terminating
1113                 * newline.  All of the other formats should have it.
1114                 */
1115                fwrite(sb->buf, sizeof(char), sb->len, stdout);
1116                return;
1117        }
1118
1119        newline_terminated = (sb->len && sb->buf[sb->len - 1] == '\n');
1120
1121        /*
1122         * Show the commit message
1123         */
1124        graph_show_strbuf(graph, sb);
1125
1126        /*
1127         * If there is more output needed for this commit, show it now
1128         */
1129        if (!graph_is_commit_finished(graph)) {
1130                /*
1131                 * If sb doesn't have a terminating newline, print one now,
1132                 * so we can start the remainder of the graph output on a
1133                 * new line.
1134                 */
1135                if (!newline_terminated)
1136                        putchar('\n');
1137
1138                graph_show_remainder(graph);
1139
1140                /*
1141                 * If sb ends with a newline, our output should too.
1142                 */
1143                if (newline_terminated)
1144                        putchar('\n');
1145        }
1146}