1
 
# -*- coding: UTF-8 -*-
 
2
 
"""Directed graph production.
 
4
 
This module contains the code to produce an ordered directed graph of a
 
5
 
bzr branch, such as we display in the tree view at the top of the bzrk
 
9
 
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
10
 
__author__    = "Scott James Remnant <scott@ubuntu.com>"
 
13
 
def linegraph(branch, start, maxnum):
 
14
 
    """Produce a directed graph of a bzr branch.
 
16
 
    Returns a list of tuples of (revision, node, lines, parents, children).
 
18
 
    Node is a tuple of (column, colour) with column being a zero-indexed
 
19
 
    column number of the graph that this revision represents and colour
 
20
 
    being a zero-indexed colour (which doesn't specify any actual colour
 
21
 
    in particular) to draw the node in.
 
23
 
    Lines is a list of tuples which represent lines you should draw away
 
24
 
    from the revision, if you also need to draw lines into the revision
 
25
 
    you should use the lines list from the previous iteration.  Each
 
26
 
    typle in the list is in the form (start, end, colour) with start and
 
27
 
    end being zero-indexed column numbers and colour as in node.
 
29
 
    It's up to you how to actually draw the nodes and lines (straight,
 
30
 
    curved, kinked, etc.) and to pick the actual colours for each index.
 
33
 
    def getdirectparent(childrevid, childindex, childsparents):
 
34
 
        """Return the revision id of the direct parent
 
36
 
        The direct parent is the first parent with the same committer"""
 
37
 
        childrevision = revisions[childindex]
 
38
 
        directparent = directparentcache[childindex]
 
39
 
        if directparent is None:
 
40
 
            for parentrevid in childsparents:
 
41
 
                if parentrevid in revindex:
 
42
 
                    parentindex = revindex[parentrevid]
 
43
 
                    parentrevision = revisions[parentindex]
 
44
 
                    if childrevision.committer == parentrevision.committer:
 
45
 
                        # This may be a direct parent, but first check that
 
46
 
                        # for this parent, there are no other children, who are
 
47
 
                        # before us in the children list, for which this parent
 
48
 
                        # is also the direct parent.
 
49
 
                        # pc in all the below var name stands for parents child
 
51
 
                        for pcrevid in revisionchildren[parentindex]:
 
52
 
                            if pcrevid == childrevid:
 
54
 
                            pcindex = revindex[pcrevid]
 
55
 
                            pcdirectparent = getdirectparent(pcrevid,
 
57
 
                                                    revisionchildren[pcindex])
 
58
 
                            if pcdirectparent==parentrevid:
 
63
 
                            directparent = parentrevid
 
65
 
            #no parents have the same commiter
 
66
 
            if directparent is None:
 
68
 
            directparentcache[childindex] = directparent
 
71
 
    def find_column_from_branchlineid(branchlineid):
 
72
 
        for index, column in enumerate(columns):
 
73
 
            if column is not None and column["branchlineid"] == branchlineid:
 
74
 
                return (index, column)
 
77
 
    def has_no_nodes_between (column, startindex, endindex):
 
78
 
        for nodeindex in column["nodeindexes"]:
 
79
 
            if nodeindex > startindex and nodeindex < endindex:
 
83
 
    def append_line (column , startindex, endindex):
 
84
 
        column["lines"].append((startindex,endindex))
 
85
 
        if endindex > column["maxindex"] :
 
86
 
            column["maxindex"] = endindex
 
88
 
    def append_column (column, minindex):
 
90
 
        for (i, c) in enumerate(columns):
 
91
 
            if c is None or (c["branchlineid"] == "finished" \
 
92
 
                             and c["maxindex"] <= minindex):
 
94
 
                columns[columnindex] = column
 
96
 
        if columnindex is None:
 
97
 
            columnindex = len(columns)
 
98
 
            columns.append(column)
 
103
 
    for (index, revid) in enumerate(reversed( \
 
104
 
            branch.repository.get_ancestry(start))):
 
105
 
        if revid is not None:
 
107
 
            revindex[revid] = index
 
108
 
        if maxnum is not None and index > maxnum:
 
111
 
    mainline = branch.revision_history()
 
112
 
    revisions = branch.repository.get_revisions(revids)
 
113
 
    revisionparents = branch.repository.get_graph().get_parents(revids)    
 
114
 
    directparentcache = [None for revision in revisions]
 
116
 
    # This will hold what we plan to put in each column.
 
117
 
    # The position of the item in this list indicates the column, and it
 
118
 
    # it may change if we need to make space for other things.
 
119
 
    # Each typle in the list is in the form:
 
120
 
    # (branchlineid, nodeindexes, lines, maxindex)
 
121
 
    # A item may be None to indicate that there is nothing in the column
 
128
 
    revisionchildren = [[] for revision in revisions]
 
131
 
    for (index, revision) in enumerate(revisions):
 
132
 
        parents = [parent for parent in revisionparents[index] \
 
134
 
        for parentrevid in parents:
 
135
 
            if parentrevid in revindex:
 
136
 
                revisionchildren[revindex[parentrevid]]\
 
137
 
                    .append(revision.revision_id)
 
139
 
        children = revisionchildren[index]
 
141
 
        #We use childrevid, childindex, childbranchlineid often, so cache it
 
143
 
        for childrevid in children:
 
144
 
            childindex = revindex[childrevid]
 
145
 
            children_ext.append((childrevid,
 
147
 
                                 branchlineids[childindex]))
 
149
 
        linegraph.append([revision, None,
 
150
 
                          [], parents, children])
 
154
 
        if revision.revision_id in mainline:
 
157
 
            #Try and see if we are the same branchline as one of our children
 
158
 
            #If we are, use the same branchlineid
 
159
 
            for (childrevid, childindex, childbranchlineid) in children_ext: 
 
160
 
                childsparents = revisionparents[childindex]
 
162
 
                if len(children) == 1 and len(childsparents) == 1: 
 
163
 
                    # one-one relationship between parent and child
 
164
 
                    branchlineid = childbranchlineid
 
167
 
                #Is the current revision the direct parent of the child?
 
168
 
                if childbranchlineid != 0 and revision.revision_id == \
 
169
 
                        getdirectparent(childrevid, childindex, childsparents):
 
170
 
                    branchlineid = childbranchlineid
 
173
 
        if branchlineid is None:
 
174
 
            branchlineid = lastbranchlineid = lastbranchlineid + 1
 
176
 
        branchlineids.append(branchlineid)
 
178
 
        (columnindex, column) = find_column_from_branchlineid(branchlineid)
 
180
 
        if columnindex is None:
 
181
 
            for (childrevid, childindex, childbranchlineid) in children_ext:
 
182
 
                (i, c) = find_column_from_branchlineid(childbranchlineid)
 
183
 
                if c is not None and c["maxindex"] <= index:
 
184
 
                    (columnindex, column) = (i, c)
 
189
 
        if columnindex is None:
 
191
 
            for childrevid in children:
 
192
 
                childindex = revindex[childrevid]
 
193
 
                if childindex<minindex:
 
194
 
                    minindex = childindex
 
196
 
            column = {"branchlineid": branchlineid,
 
197
 
                      "nodeindexes": [index],
 
200
 
            columnindex = append_column(column, minindex)
 
202
 
            column["branchlineid"] = branchlineid
 
203
 
            column["nodeindexes"].append(index)
 
205
 
        opentillparent = getdirectparent(revision.revision_id, index, parents)
 
206
 
        if opentillparent == "":
 
208
 
                opentillparent = parents[0]
 
210
 
                opentillparent = None
 
212
 
        if opentillparent is not None and opentillparent in revindex:
 
213
 
            parentindex = revindex[opentillparent]
 
214
 
            if parentindex > column["maxindex"]:
 
215
 
                column["maxindex"] = parentindex
 
217
 
        for (childrevid, childindex, childbranchlineid) in children_ext: 
 
218
 
            (childcolumnindex, childcolumn) = \
 
219
 
                find_column_from_branchlineid(childbranchlineid)
 
221
 
            if index-childindex == 1 or childcolumnindex is None:
 
222
 
                append_line(column,childindex,index)
 
223
 
            elif childcolumnindex >= columnindex and \
 
224
 
                    has_no_nodes_between(childcolumn, childindex, index):
 
225
 
                append_line(childcolumn,childindex,index)
 
226
 
            elif childcolumnindex > columnindex and \
 
227
 
                    has_no_nodes_between(column, childindex, index):
 
228
 
                append_line(column,childindex,index)
 
229
 
            elif childcolumnindex < columnindex and \
 
230
 
                    has_no_nodes_between(column, childindex, index):
 
231
 
                append_line(column,childindex,index)
 
232
 
            elif childcolumnindex < columnindex and \
 
233
 
                    has_no_nodes_between(childcolumn, childindex, index):
 
234
 
                append_line(childcolumn,childindex,index)
 
236
 
                append_column({"branchlineid": "line",
 
238
 
                                "lines": [(childindex,index)],
 
239
 
                                "maxindex": index}, childindex)
 
241
 
        for (columnindex, column) in enumerate(columns):
 
242
 
            if column is not None and column["maxindex"] <= index \
 
243
 
                    and column["branchlineid"] != "finished":
 
244
 
                for nodeindex in column["nodeindexes"]:
 
245
 
                    linegraph[nodeindex][1] = (columnindex,
 
246
 
                                               branchlineids[nodeindex])
 
248
 
                for (childindex, parentindex) in column["lines"]:
 
249
 
                    notdrawnlines.append((columnindex, childindex, parentindex))
 
251
 
                column["branchlineid"] = "finished"
 
252
 
                column["nodeindexes"] = []
 
255
 
        for (lineindex,(columnindex, childindex, parentindex))\
 
256
 
                in enumerate(notdrawnlines):
 
258
 
            childnode = linegraph[childindex][1]
 
259
 
            parentnode = linegraph[parentindex][1]
 
260
 
            if childnode is not None and parentnode is not None:
 
261
 
                notdrawnlines[lineindex] = None
 
262
 
                if parentindex>childindex+1:
 
263
 
                    #out from the child to line
 
264
 
                    linegraph[childindex][2].append(
 
265
 
                        (childnode[0],    #the column of the child
 
266
 
                         columnindex,     #the column of the line
 
270
 
                    for linepartindex in range(childindex+1, parentindex-1):
 
271
 
                        linegraph[linepartindex][2].append(
 
272
 
                            (columnindex, #the column of the line
 
273
 
                             columnindex, #the column of the line
 
277
 
                    linegraph[parentindex-1][2].append(
 
278
 
                        (columnindex,     #the column of the line
 
279
 
                         parentnode[0],   #the column of the parent
 
283
 
                    linegraph[childindex][2].append(
 
284
 
                        (childnode[0],    #the column of the child
 
285
 
                         parentnode[0],   #the column of the parent
 
288
 
        notdrawnlines = [line for line in notdrawnlines if line is not None]
 
291
 
    return (linegraph, revindex, revisions)
 
294
 
def same_branch(a, b):
 
295
 
    """Return whether we think revisions a and b are on the same branch."""
 
296
 
    if len(a.parent_ids) == 1:
 
297
 
        # Defacto same branch if only parent
 
299
 
    elif a.committer == b.committer:
 
300
 
        # Same committer so may as well be
 
 
1
# -*- coding: UTF-8 -*-
 
 
2
"""Directed graph production.
 
 
4
This module contains the code to produce an ordered directed graph of a
 
 
5
bzr branch, such as we display in the tree view at the top of the bzrk
 
 
9
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
 
10
__author__    = "Scott James Remnant <scott@ubuntu.com>"
 
 
12
from bzrlib.revision import NULL_REVISION
 
 
13
from bzrlib.tsort import merge_sort
 
 
15
def linegraph(graph, start_revs, maxnum=None, broken_line_length=None,
 
 
16
              graph_data=True, mainline_only=False):
 
 
17
    """Produce a directed graph of a bzr repository.
 
 
19
    Returns a tuple of (line_graph, revid_index, columns_len) where
 
 
20
    * line_graph is a list of tuples of (revid,
 
 
26
    * revid_index is a dict of each revision with the key being the revid, and
 
 
27
      the value the row index, and
 
 
28
    * columns_len is the number of columns need to draw the line graph.
 
 
31
    Node is a tuple of (column, colour) with column being a zero-indexed
 
 
32
    column number of the graph that this revision represents and colour
 
 
33
    being a zero-indexed colour (which doesn't specify any actual colour
 
 
34
    in particular) to draw the node in.
 
 
36
    Lines is a list of tuples which represent lines you should draw away
 
 
37
    from the revision, if you also need to draw lines into the revision
 
 
38
    you should use the lines list from the previous iteration.  Each
 
 
39
    typle in the list is in the form (start, end, colour) with start and
 
 
40
    end being zero-indexed column numbers and colour as in node.
 
 
42
    It's up to you how to actually draw the nodes and lines (straight,
 
 
43
    curved, kinked, etc.) and to pick the actual colours for each index.
 
 
49
    for (revid, parent_revids) in graph.iter_ancestry(start_revs):
 
 
50
        if parent_revids is None:
 
 
53
        if parent_revids == (NULL_REVISION,):
 
 
54
            graph_parents[revid] = ()
 
 
56
            graph_parents[revid] = parent_revids
 
 
57
        for parent in parent_revids:
 
 
58
            graph_children.setdefault(parent, []).append(revid)
 
 
59
        graph_children.setdefault(revid, [])
 
 
61
        for ghost_child in graph_children[ghost]:
 
 
62
            graph_parents[ghost_child] = [p for p in graph_parents[ghost_child]
 
 
64
    graph_parents["top:"] = start_revs
 
 
66
    if len(graph_parents)>0:
 
 
67
        merge_sorted_revisions = merge_sort(
 
 
72
        merge_sorted_revisions = ()
 
 
75
        merge_sorted_revisions = [elem for elem in merge_sorted_revisions \
 
 
78
    assert merge_sorted_revisions[0][1] == "top:"
 
 
79
    merge_sorted_revisions = merge_sorted_revisions[1:]
 
 
84
    # This will hold an item for each "branch". For a revisions, the revsion
 
 
85
    # number less the least significant digit is the branch_id, and used as the
 
 
86
    # key for the dict. Hence revision with the same revsion number less the
 
 
87
    # least significant digit are considered to be in the same branch line.
 
 
88
    # e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
 
 
89
    # and these two revisions will be in the same branch line. Each value is
 
 
90
    # a list of rev_indexes in the branch.
 
 
95
    for (rev_index, (sequence_number,
 
 
99
                     end_of_merge)) in enumerate(merge_sorted_revisions):
 
 
100
        if maxnum and rev_index >= maxnum:
 
 
102
        revid_index[revid] = rev_index
 
 
104
        parents = graph_parents[revid]
 
 
105
        linegraph.append([revid,
 
 
113
            revno_index[revno_sequence] = rev_index
 
 
115
            branch_id = revno_sequence[0:-1]
 
 
118
            if branch_id not in branch_lines:
 
 
120
                branch_lines[branch_id] = branch_line
 
 
122
                branch_line = branch_lines[branch_id]
 
 
124
            branch_line.append(rev_index)        
 
 
127
        branch_ids = branch_lines.keys()
 
 
129
        def branch_id_cmp(x, y):
 
 
130
            """Compaire branch_id's first by the number of digits, then reversed
 
 
136
            return cmp(len_x, len_y)
 
 
138
        branch_ids.sort(branch_id_cmp)
 
 
139
        # This will hold a tuple of (child_index, parent_index, col_index) for each
 
 
140
        # line that needs to be drawn. If col_index is not none, then the line is
 
 
141
        # drawn along that column, else the the line can be drawn directly between
 
 
142
        # the child and parent because either the child and parent are in the same
 
 
143
        # branch line, or the child and parent are 1 row apart.
 
 
145
        empty_column = [False for i in range(len(graph_parents))]
 
 
146
        # This will hold a bit map for each cell. If the cell is true, then the
 
 
147
        # cell allready contains a node or line. This use when deciding what column
 
 
148
        # to place a branch line or line in, without it overlaping something else.
 
 
149
        columns = [list(empty_column)]
 
 
152
        for branch_id in branch_ids:
 
 
153
            branch_line = branch_lines[branch_id]
 
 
155
            # Find the col_index for the direct parent branch. This will be the
 
 
156
            # starting point when looking for a free column.
 
 
159
            if len(branch_id) > 1:
 
 
160
                parent_revno = branch_id[0:-1]
 
 
161
                if parent_revno in revno_index:
 
 
162
                    parent_index = revno_index[parent_revno]
 
 
163
                    parent_node = linegraph[parent_index][1]
 
 
165
                        parent_col_index = parent_node[0]
 
 
168
            col_search_order = _branch_line_col_search_order(columns,
 
 
170
            color = reduce(lambda x, y: x+y, branch_id, 0)
 
 
174
            last_rev_index = None
 
 
175
            for rev_index in branch_line:
 
 
177
                    if broken_line_length and \
 
 
178
                       rev_index - last_rev_index > broken_line_length:
 
 
179
                        line_range.append(last_rev_index+1)
 
 
180
                        line_range.append(rev_index-1)
 
 
182
                        line_range.extend(range(last_rev_index+1, rev_index))
 
 
184
                line_range.append(rev_index)
 
 
185
                last_rev_index = rev_index
 
 
188
                if broken_line_length and \
 
 
189
                   parent_index - last_rev_index > broken_line_length:
 
 
190
                    line_range.append(last_rev_index+1)
 
 
192
                    line_range.extend(range(last_rev_index+1, parent_index))
 
 
194
            col_index = _find_free_column(columns,
 
 
198
            node = (col_index, color)
 
 
199
            for rev_index in branch_line:
 
 
200
                linegraph[rev_index][1] = node
 
 
201
                columns[col_index][rev_index] = True
 
 
203
            for rev_index in branch_line:
 
 
208
                     end_of_merge) = merge_sorted_revisions[rev_index]
 
 
210
                linegraph[rev_index][4] = graph_children[revid]
 
 
211
                col_index = linegraph[rev_index][1][0]
 
 
213
                for parent_revid in graph_parents[revid]:
 
 
214
                    if parent_revid in revid_index:
 
 
216
                        parent_index = revid_index[parent_revid]                            
 
 
217
                        parent_node = linegraph[parent_index][1]
 
 
219
                            parent_col_index = parent_node[0]
 
 
221
                            parent_col_index = None
 
 
223
                                _line_col_search_order(columns,
 
 
227
                        # If this line is really long, break it.
 
 
228
                        if len(branch_id) > 0 and \
 
 
229
                           broken_line_length and \
 
 
230
                           parent_index - rev_index > broken_line_length:
 
 
231
                            child_line_col_index = \
 
 
232
                                _find_free_column(columns,
 
 
236
                            _mark_column_as_used(columns,
 
 
237
                                                 child_line_col_index,
 
 
240
                            # Recall _line_col_search_order to reset it back to
 
 
243
                                    _line_col_search_order(columns,
 
 
246
                            parent_col_line_index = \
 
 
247
                                _find_free_column(columns,
 
 
251
                            _mark_column_as_used(columns,
 
 
252
                                                 parent_col_line_index,
 
 
254
                            lines.append((rev_index,
 
 
256
                                          (child_line_col_index,
 
 
257
                                           parent_col_line_index)))
 
 
259
                            line_col_index = col_index
 
 
260
                            if parent_index - rev_index >1:
 
 
261
                                line_range = range(rev_index + 1, parent_index)
 
 
263
                                    _find_free_column(columns,
 
 
267
                                _mark_column_as_used(columns,
 
 
270
                            lines.append((rev_index,
 
 
274
        for (child_index, parent_index, line_col_indexes) in lines:
 
 
275
            (child_col_index, child_color) = linegraph[child_index][1]
 
 
276
            (parent_col_index, parent_color) = linegraph[parent_index][1]
 
 
278
            if len(line_col_indexes) == 1:
 
 
279
                if parent_index - child_index == 1:
 
 
280
                    linegraph[child_index][2].append(
 
 
285
                    # line from the child's column to the lines column
 
 
286
                    linegraph[child_index][2].append(
 
 
290
                    # lines down the line's column
 
 
291
                    for line_part_index in range(child_index+1, parent_index-1):
 
 
292
                        linegraph[line_part_index][2].append(
 
 
293
                            (line_col_indexes[0],   
 
 
296
                    # line from the line's column to the parent's column
 
 
297
                    linegraph[parent_index-1][2].append(
 
 
298
                        (line_col_indexes[0],
 
 
303
                # line from the child's column to the lines column
 
 
304
                linegraph[child_index][2].append(
 
 
309
                linegraph[child_index+1][2].append(
 
 
310
                    (line_col_indexes[0],
 
 
315
                linegraph[parent_index-2][2].append(
 
 
319
                # line from the line's column to the parent's column
 
 
320
                linegraph[parent_index-1][2].append(
 
 
321
                    (line_col_indexes[1],
 
 
324
        return (linegraph, revid_index, len(columns))
 
 
326
        return (linegraph, revid_index, 0)
 
 
329
def _branch_line_col_search_order(columns, parent_col_index):
 
 
330
    for col_index in range(parent_col_index, len(columns)):
 
 
332
    for col_index in range(parent_col_index-1, -1, -1):
 
 
335
def _line_col_search_order(columns, parent_col_index, child_col_index):
 
 
336
    if parent_col_index is not None:
 
 
337
        max_index = max(parent_col_index, child_col_index)
 
 
338
        min_index = min(parent_col_index, child_col_index)
 
 
339
        for col_index in range(max_index, min_index -1, -1):
 
 
342
        max_index = child_col_index
 
 
343
        min_index = child_col_index
 
 
344
        yield child_col_index
 
 
346
    while max_index + i < len(columns) or \
 
 
348
        if max_index + i < len(columns):
 
 
350
        if min_index - i > -1:
 
 
354
def _find_free_column(columns, empty_column, col_search_order, line_range):
 
 
355
    for col_index in col_search_order:
 
 
356
        column = columns[col_index]
 
 
357
        has_overlaping_line = False
 
 
358
        for row_index in line_range:
 
 
359
            if column[row_index]:
 
 
360
                has_overlaping_line = True
 
 
362
        if not has_overlaping_line:
 
 
365
        col_index = len(columns)
 
 
366
        column = list(empty_column)
 
 
367
        columns.append(column)
 
 
370
def _mark_column_as_used(columns, col_index, line_range):
 
 
371
    column = columns[col_index]
 
 
372
    for row_index in line_range:
 
 
373
        column[row_index] = True    
 
 
375
def same_branch(a, b):
 
 
376
    """Return whether we think revisions a and b are on the same branch."""
 
 
377
    if len(a.parent_ids) == 1:
 
 
378
        # Defacto same branch if only parent
 
 
380
    elif a.committer == b.committer:
 
 
381
        # Same committer so may as well be