/b-gtk/fix-viz

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/b-gtk/fix-viz

« back to all changes in this revision

Viewing changes to graph.py

  • Committer: Scott James Remnant
  • Date: 2005-10-17 01:07:49 UTC
  • Revision ID: scott@netsplit.com-20051017010749-15fa95fc2cf09289
Commit the first version of bzrk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
graph.py
1
 
# -*- coding: UTF-8 -*-
2
 
"""Directed graph production.
3
 
 
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
6
 
window.
7
 
"""
8
 
 
9
 
__copyright__ = "Copyright © 2005 Canonical Ltd."
10
 
__author__    = "Scott James Remnant <scott@ubuntu.com>"
11
 
 
12
 
from bzrlib.tsort import merge_sort
13
 
 
14
 
def linegraph(branch, start, maxnum):
15
 
    """Produce a directed graph of a bzr branch.
16
 
 
17
 
    Returns a tuple of (line_graph, revid_index, columns_len) where
18
 
    * line_graph is a list of tuples of (revid,
19
 
                                         node,
20
 
                                         lines,
21
 
                                         parents,
22
 
                                         children,
23
 
                                         revno_sequence),
24
 
    * revid_index is a dict of each revision with the key being the revid, and
25
 
      the value the row index, and
26
 
    * columns_len is the number of columns need to draw the line graph.
27
 
    
28
 
 
29
 
    Node is a tuple of (column, colour) with column being a zero-indexed
30
 
    column number of the graph that this revision represents and colour
31
 
    being a zero-indexed colour (which doesn't specify any actual colour
32
 
    in particular) to draw the node in.
33
 
 
34
 
    Lines is a list of tuples which represent lines you should draw away
35
 
    from the revision, if you also need to draw lines into the revision
36
 
    you should use the lines list from the previous iteration.  Each
37
 
    typle in the list is in the form (start, end, colour) with start and
38
 
    end being zero-indexed column numbers and colour as in node.
39
 
 
40
 
    It's up to you how to actually draw the nodes and lines (straight,
41
 
    curved, kinked, etc.) and to pick the actual colours for each index.
42
 
    """
43
 
    
44
 
    # FIXME: This should be configurable
45
 
    BROKEN_LINE_LENGTH = 32
46
 
    
47
 
    # We get the mainline so we can pass it to merge_sort to make merge_sort
48
 
    # run faster.
49
 
    mainline = [None]
50
 
    mainline.extend(branch.revision_history())
51
 
    graph_parents = branch.repository.get_revision_graph(start)
52
 
    graph_children = {}
53
 
    for revid in graph_parents.iterkeys():
54
 
        graph_children[revid] = []
55
 
 
56
 
    merge_sorted_revisions = merge_sort(
57
 
        graph_parents,
58
 
        start,
59
 
        mainline,
60
 
        generate_revno=True)
61
 
    
62
 
    revid_index = {}
63
 
    revno_index = {}
64
 
    
65
 
    # This will hold an item for each "branch". For a revisions, the revsion
66
 
    # number less the least significant digit is the branch_id, and used as the
67
 
    # key for the dict. Hence revision with the same revsion number less the
68
 
    # least significant digit are considered to be in the same branch line.
69
 
    # e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
70
 
    # and these two revisions will be in the same branch line. Each value is
71
 
    # a list of rev_indexes in the branch.
72
 
    branch_lines = {}
73
 
    
74
 
    linegraph = []    
75
 
    
76
 
    for (rev_index, (sequence_number,
77
 
                     revid,
78
 
                     merge_depth,
79
 
                     revno_sequence,
80
 
                     end_of_merge)) in enumerate(merge_sorted_revisions):
81
 
        if maxnum and rev_index >= maxnum:
82
 
            break
83
 
        revid_index[revid] = rev_index
84
 
        revno_index[revno_sequence] = rev_index
85
 
        
86
 
        branch_id = revno_sequence[0:-1]
87
 
        
88
 
        branch_line = None
89
 
        if branch_id not in branch_lines:
90
 
            branch_line = []
91
 
            branch_lines[branch_id] = branch_line
92
 
        else:
93
 
            branch_line = branch_lines[branch_id]
94
 
        
95
 
        branch_line.append(rev_index)
96
 
        
97
 
        parents = graph_parents[revid]
98
 
        for parent_revid in parents:
99
 
            graph_children[parent_revid].append(revid)
100
 
        
101
 
        linegraph.append([revid,
102
 
                          None,
103
 
                          [],
104
 
                          parents,
105
 
                          None,
106
 
                          revno_sequence])
107
 
 
108
 
    branch_ids = branch_lines.keys()
109
 
    
110
 
    def branch_id_cmp(x, y):
111
 
        """Compaire branch_id's first by the number of digits, then reversed
112
 
        by their value"""
113
 
        len_x = len(x)
114
 
        len_y = len(y)
115
 
        if len_x == len_y:
116
 
            return -cmp(x, y)
117
 
        return cmp(len_x, len_y)
118
 
    
119
 
    branch_ids.sort(branch_id_cmp)
120
 
    # This will hold a tuple of (child_index, parent_index, col_index) for each
121
 
    # line that needs to be drawn. If col_index is not none, then the line is
122
 
    # drawn along that column, else the the line can be drawn directly between
123
 
    # the child and parent because either the child and parent are in the same
124
 
    # branch line, or the child and parent are 1 row apart.
125
 
    lines = []
126
 
    empty_column = [False for i in range(len(graph_parents))]
127
 
    # This will hold a bit map for each cell. If the cell is true, then the
128
 
    # cell allready contains a node or line. This use when deciding what column
129
 
    # to place a branch line or line in, without it overlaping something else.
130
 
    columns = [list(empty_column)]
131
 
    
132
 
    
133
 
    for branch_id in branch_ids:
134
 
        branch_line = branch_lines[branch_id]
135
 
        
136
 
        # Find the col_index for the direct parent branch. This will be the
137
 
        # starting point when looking for a free column.
138
 
        parent_col_index = 0
139
 
        parent_index = None
140
 
        if len(branch_id) > 1:
141
 
            parent_revno = branch_id[0:-1]
142
 
            if parent_revno in revno_index:
143
 
                parent_index = revno_index[parent_revno]
144
 
                parent_node = linegraph[parent_index][1]
145
 
                if parent_node:
146
 
                    parent_col_index = parent_node[0]
147
 
                
148
 
        
149
 
        col_search_order = _branch_line_col_search_order(columns,
150
 
                                                         parent_col_index)
151
 
        color = reduce(lambda x, y: x+y, branch_id, 0)
152
 
        cur_cont_line = []
153
 
        
154
 
        line_range = []
155
 
        last_rev_index = None
156
 
        for rev_index in branch_line:
157
 
            if last_rev_index:
158
 
                if BROKEN_LINE_LENGTH and \
159
 
                   rev_index - last_rev_index > BROKEN_LINE_LENGTH:
160
 
                    line_range.append(last_rev_index+1)
161
 
                    line_range.append(rev_index-1)
162
 
                else:
163
 
                    line_range.extend(range(last_rev_index+1, rev_index))
164
 
            
165
 
            line_range.append(rev_index)
166
 
            last_rev_index = rev_index
167
 
        
168
 
        if parent_index:
169
 
            if BROKEN_LINE_LENGTH and \
170
 
               parent_index - last_rev_index > BROKEN_LINE_LENGTH:
171
 
                line_range.append(last_rev_index+1)
172
 
            else:
173
 
                line_range.extend(range(last_rev_index+1, parent_index))
174
 
        
175
 
        col_index = _find_free_column(columns,
176
 
                                      empty_column,
177
 
                                      col_search_order,
178
 
                                      line_range)
179
 
        node = (col_index, color)
180
 
        for rev_index in branch_line:
181
 
            linegraph[rev_index][1] = node
182
 
            columns[col_index][rev_index] = True
183
 
        
184
 
        for rev_index in branch_line:
185
 
            (sequence_number,
186
 
                 revid,
187
 
                 merge_depth,
188
 
                 revno_sequence,
189
 
                 end_of_merge) = merge_sorted_revisions[rev_index]
190
 
            
191
 
            linegraph[rev_index][4] = graph_children[revid]
192
 
            col_index = linegraph[rev_index][1][0]
193
 
            
194
 
            for parent_revid in graph_parents[revid]:
195
 
                if parent_revid in revid_index:
196
 
                    
197
 
                    parent_index = revid_index[parent_revid]                            
198
 
                    parent_node = linegraph[parent_index][1]
199
 
                    if parent_node:
200
 
                        parent_col_index = parent_node[0]
201
 
                    else:
202
 
                        parent_col_index = None
203
 
                    col_search_order = \
204
 
                            _line_col_search_order(columns,
205
 
                                                   parent_col_index,
206
 
                                                   col_index)
207
 
                        
208
 
                    # If this line is really long, break it.
209
 
                    if len(branch_id) > 0 and \
210
 
                       BROKEN_LINE_LENGTH and \
211
 
                       parent_index - rev_index > BROKEN_LINE_LENGTH:
212
 
                        child_line_col_index = \
213
 
                            _find_free_column(columns,
214
 
                                              empty_column,
215
 
                                              col_search_order,
216
 
                                              (rev_index + 1,))
217
 
                        _mark_column_as_used(columns,
218
 
                                             child_line_col_index,
219
 
                                             (rev_index + 1,))
220
 
                        
221
 
                        # Recall _line_col_search_order to reset it back to
222
 
                        # the beging.
223
 
                        col_search_order = \
224
 
                                _line_col_search_order(columns,
225
 
                                                       parent_col_index,
226
 
                                                       col_index)
227
 
                        parent_col_line_index = \
228
 
                            _find_free_column(columns,
229
 
                                              empty_column,
230
 
                                              col_search_order,
231
 
                                              (parent_index - 1,))
232
 
                        _mark_column_as_used(columns,
233
 
                                             parent_col_line_index,
234
 
                                             (parent_index - 1,))
235
 
                        lines.append((rev_index,
236
 
                                      parent_index,
237
 
                                      (child_line_col_index,
238
 
                                       parent_col_line_index)))
239
 
                    else :
240
 
                        line_col_index = col_index
241
 
                        if parent_index - rev_index >1:
242
 
                            line_range = range(rev_index + 1, parent_index)
243
 
                            line_col_index = \
244
 
                                _find_free_column(columns,
245
 
                                                  empty_column,
246
 
                                                  col_search_order,
247
 
                                                  line_range)
248
 
                            _mark_column_as_used(columns,
249
 
                                                 line_col_index,
250
 
                                                 line_range)
251
 
                        lines.append((rev_index,
252
 
                                      parent_index,
253
 
                                      (line_col_index,)))
254
 
    
255
 
    for (child_index, parent_index, line_col_indexes) in lines:
256
 
        (child_col_index, child_color) = linegraph[child_index][1]
257
 
        (parent_col_index, parent_color) = linegraph[parent_index][1]
258
 
        
259
 
        if len(line_col_indexes) == 1:
260
 
            if parent_index - child_index == 1:
261
 
                linegraph[child_index][2].append(
262
 
                    (child_col_index,
263
 
                     parent_col_index,
264
 
                     parent_color))
265
 
            else:
266
 
                # line from the child's column to the lines column
267
 
                linegraph[child_index][2].append(
268
 
                    (child_col_index,
269
 
                     line_col_indexes[0],
270
 
                     parent_color))
271
 
                # lines down the line's column
272
 
                for line_part_index in range(child_index+1, parent_index-1):
273
 
                    linegraph[line_part_index][2].append(
274
 
                        (line_col_indexes[0],   
275
 
                         line_col_indexes[0],
276
 
                         parent_color))
277
 
                # line from the line's column to the parent's column
278
 
                linegraph[parent_index-1][2].append(
279
 
                    (line_col_indexes[0],
280
 
                     parent_col_index,
281
 
                     parent_color))
282
 
        else:
283
 
            # Broken line
284
 
            # line from the child's column to the lines column
285
 
            linegraph[child_index][2].append(
286
 
                (child_col_index,
287
 
                 line_col_indexes[0],
288
 
                 parent_color))
289
 
            # Broken line end
290
 
            linegraph[child_index+1][2].append(
291
 
                (line_col_indexes[0],
292
 
                 None,
293
 
                 parent_color))
294
 
            
295
 
            # Broken line end 
296
 
            linegraph[parent_index-2][2].append(
297
 
                (None,
298
 
                 line_col_indexes[1],
299
 
                 parent_color))
300
 
            # line from the line's column to the parent's column
301
 
            linegraph[parent_index-1][2].append(
302
 
                (line_col_indexes[1],
303
 
                 parent_col_index,
304
 
                 parent_color))
305
 
            
306
 
    
307
 
    return (linegraph, revid_index, len(columns))
308
 
 
309
 
def _branch_line_col_search_order(columns, parent_col_index):
310
 
    for col_index in range(parent_col_index, len(columns)):
311
 
        yield col_index
312
 
    for col_index in range(parent_col_index-1, -1, -1):
313
 
        yield col_index
314
 
 
315
 
def _line_col_search_order(columns, parent_col_index, child_col_index):
316
 
    if parent_col_index is not None:
317
 
        max_index = max(parent_col_index, child_col_index)
318
 
        min_index = min(parent_col_index, child_col_index)
319
 
        for col_index in range(max_index, min_index -1, -1):
320
 
            yield col_index
321
 
    else:
322
 
        max_index = child_col_index
323
 
        min_index = child_col_index
324
 
        yield child_col_index
325
 
    i = 1
326
 
    while max_index + i < len(columns) or \
327
 
          min_index - i > -1:
328
 
        if max_index + i < len(columns):
329
 
            yield max_index + i
330
 
        if min_index - i > -1:
331
 
            yield min_index - i
332
 
        i += 1
333
 
 
334
 
def _find_free_column(columns, empty_column, col_search_order, line_range):
335
 
    for col_index in col_search_order:
336
 
        column = columns[col_index]
337
 
        has_overlaping_line = False
338
 
        for row_index in line_range:
339
 
            if column[row_index]:
340
 
                has_overlaping_line = True
341
 
                break
342
 
        if not has_overlaping_line:
343
 
            break
344
 
    else:
345
 
        col_index = len(columns)
346
 
        column = list(empty_column)
347
 
        columns.append(column)
348
 
    return col_index
349
 
 
350
 
def _mark_column_as_used(columns, col_index, line_range):
351
 
    column = columns[col_index]
352
 
    for row_index in line_range:
353
 
        column[row_index] = True    
354
 
 
355
 
def same_branch(a, b):
356
 
    """Return whether we think revisions a and b are on the same branch."""
357
 
    if len(a.parent_ids) == 1:
358
 
        # Defacto same branch if only parent
359
 
        return True
360
 
    elif a.committer == b.committer:
361
 
        # Same committer so may as well be
362
 
        return True
363
 
    else:
364
 
        return False
 
1
#!/usr/bin/python
 
2
# -*- coding: UTF-8 -*-
 
3
"""Directed graph production.
 
4
 
 
5
This module contains the code to produce an ordered directed graph of a
 
6
bzr branch, such as we display in the tree view at the top of the bzrk
 
7
window.
 
8
"""
 
9
 
 
10
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
11
__author__    = "Scott James Remnant <scott@ubuntu.com>"
 
12
 
 
13
 
 
14
from bzrlib.errors import NoSuchRevision
 
15
 
 
16
 
 
17
class DummyRevision(object):
 
18
    """Dummy bzr revision.
 
19
 
 
20
    Sometimes, especially in older bzr branches, a revision is referenced
 
21
    as the parent of another but not actually present in the branch's store.
 
22
    When this happens we use an instance of this class instead of the real
 
23
    Revision object (which we can't get).
 
24
    """
 
25
 
 
26
    def __init__(self, revid):
 
27
        self.revision_id = revid
 
28
        self.parent_ids = []
 
29
        self.committer = None
 
30
        self.message = self.revision_id
 
31
 
 
32
 
 
33
def graph(branch, start):
 
34
    """Produce a directed graph of a bzr branch.
 
35
 
 
36
    Traverses the branch revision tree starting at start and produces an
 
37
    ordered list of revisions such that a revision always comes after
 
38
    any revision it is the parent of.  It also tries to make a reasonably
 
39
    not-too-stupid decision whether a parent revision is on the same
 
40
    logical branch, as that information is not available with bzr.
 
41
 
 
42
    For each revision it then yields a tuple of (revision, node, lines).
 
43
    If the revision is only referenced in the branch and not present in the
 
44
    store, revision will be a DummyRevision object, otherwise it is the bzr
 
45
    Revision object with the meta-data for the revision.
 
46
 
 
47
    Node is a tuple of (column, colour) with column being a zero-indexed
 
48
    column number of the graph that this revision represents and colour
 
49
    being a zero-indexed colour (which doesn't specify any actual colour
 
50
    in particular) to draw the node in.
 
51
 
 
52
    Lines is a list of tuples which represent lines you should draw away
 
53
    from the revision, if you also need to draw lines into the revision
 
54
    you should use the lines list from the previous iteration.  Each
 
55
    typle in the list is in the form (start, end, colour) with start and
 
56
    end being zero-indexed column numbers and colour as in node.
 
57
 
 
58
    It's up to you how to actually draw the nodes and lines (straight,
 
59
    curved, kinked, etc.) and to pick the actual colours for each index.
 
60
    """
 
61
    revisions = { start: branch.get_revision(start) }
 
62
    distances = { start: 0 }
 
63
    colours = { start: 0 }
 
64
    last_colour = 0
 
65
 
 
66
    # Sort the revisions; the fastest way to do this is to visit each node
 
67
    # as few times as possible (by keeping the todo list in a set) and record
 
68
    # the largest distance to it before queuing up the children if we
 
69
    # increased the distance.  This produces the sort order we desire
 
70
    todo = set([ start ])
 
71
    while todo:
 
72
        revid = todo.pop()
 
73
        revision = revisions[revid]
 
74
        distance = distances[revid] + 1
 
75
        colour = colours[revid]
 
76
 
 
77
        reused = False
 
78
        for parent_id in revision.parent_ids:
 
79
            # Check whether there's any point re-processing this
 
80
            if parent_id in distances and distances[parent_id] >= distance:
 
81
                continue
 
82
 
 
83
            # Get the parent from the cache, or put it in the cache
 
84
            try:
 
85
                parent = revisions[parent_id]
 
86
            except KeyError:
 
87
                try:
 
88
                    parent = revisions[parent_id] \
 
89
                             = branch.get_revision(parent_id)
 
90
                except NoSuchRevision:
 
91
                    parent = revisions[parent_id] = DummyRevision(parent_id)
 
92
 
 
93
            # Make a guess as to whether this node represents the same
 
94
            # branch, or a new one.  Penalise same branches in the distance
 
95
            # stakes to give new ones a chance to appear first as one set.
 
96
            if len(revision.parent_ids) == 1:
 
97
                colours[parent_id] = colour
 
98
                distances[parent_id] = distance
 
99
            elif revision.committer == parent.committer and not reused:
 
100
                colours[parent_id] = colour
 
101
                distances[parent_id] = distance
 
102
                reused = True
 
103
            else:
 
104
                colours[parent_id] = last_colour = last_colour + 1
 
105
                distances[parent_id] = distance + 10
 
106
 
 
107
            todo.add(parent_id)
 
108
 
 
109
    # Now iterate the revisions again, but this time in list order rather
 
110
    # than traversing the tree, and build up the graph lines.  We do this
 
111
    # by keeping a list of "hanging parents", which can only be removed
 
112
    # once we encounter the revision being hung.
 
113
    hanging = [ start ]
 
114
    for revid in sorted(distances, key=distances.get):
 
115
        lines = []
 
116
        node = None
 
117
 
 
118
        new_hanging = []
 
119
        for h_idx, hang in enumerate(hanging):
 
120
            if hang == revid:
 
121
                # We've matched a hanging revision, so need to output a node
 
122
                # at this point
 
123
                node = (h_idx, colours[revid])
 
124
 
 
125
                # Now we need to hang its parents, we put them at the point
 
126
                # the old column was so anything to the right of this has
 
127
                # to move outwards to make room.  We also try and collapse
 
128
                # hangs to keep the graph small.
 
129
                for parent_id in revisions[revid].parent_ids:
 
130
                    try:
 
131
                        n_idx = new_hanging.index(parent_id)
 
132
                    except ValueError:
 
133
                        n_idx = len(new_hanging)
 
134
                        new_hanging.append(parent_id)
 
135
                    lines.append((h_idx, n_idx, colours[parent_id]))
 
136
            else:
 
137
                # Revision keeps on hanging, adjust for any change in the
 
138
                # graph shape and try to collapse hangs to keep the graph
 
139
                # small.
 
140
                try:
 
141
                    n_idx = new_hanging.index(hang)
 
142
                except ValueError:
 
143
                    n_idx = len(new_hanging)
 
144
                    new_hanging.append(hang)
 
145
                lines.append((h_idx, n_idx, colours[hang]))
 
146
        hanging = new_hanging
 
147
 
 
148
        yield (revisions[revid], node, lines)