/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 viz/linegraph.py

  • Committer: Jelmer Vernooij
  • Date: 2007-12-21 20:20:37 UTC
  • mto: This revision was merged to the branch mainline in revision 422.
  • Revision ID: jelmer@samba.org-20071221202037-6zvbwefvrte3e2zy
Fix URL.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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)
 
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(repository, start, maxnum, broken_line_length=None):
 
15
    """Produce a directed graph of a bzr repository.
 
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
    graph_parents = repository.get_revision_graph(start)
 
45
    graph_children = {}
 
46
    for revid in graph_parents.iterkeys():
 
47
        graph_children[revid] = []
 
48
 
 
49
    merge_sorted_revisions = merge_sort(
 
50
        graph_parents,
 
51
        start,
 
52
        generate_revno=True)
 
53
    
 
54
    revid_index = {}
 
55
    revno_index = {}
 
56
    
 
57
    # This will hold an item for each "branch". For a revisions, the revsion
 
58
    # number less the least significant digit is the branch_id, and used as the
 
59
    # key for the dict. Hence revision with the same revsion number less the
 
60
    # least significant digit are considered to be in the same branch line.
 
61
    # e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
 
62
    # and these two revisions will be in the same branch line. Each value is
 
63
    # a list of rev_indexes in the branch.
 
64
    branch_lines = {}
 
65
    
 
66
    linegraph = []    
 
67
    
 
68
    for (rev_index, (sequence_number,
 
69
                     revid,
 
70
                     merge_depth,
 
71
                     revno_sequence,
 
72
                     end_of_merge)) in enumerate(merge_sorted_revisions):
 
73
        if maxnum and rev_index >= maxnum:
 
74
            break
 
75
        revid_index[revid] = rev_index
 
76
        revno_index[revno_sequence] = rev_index
 
77
        
 
78
        branch_id = revno_sequence[0:-1]
 
79
        
 
80
        branch_line = None
 
81
        if branch_id not in branch_lines:
 
82
            branch_line = []
 
83
            branch_lines[branch_id] = branch_line
 
84
        else:
 
85
            branch_line = branch_lines[branch_id]
 
86
        
 
87
        branch_line.append(rev_index)
 
88
        
 
89
        parents = graph_parents[revid]
 
90
        for parent_revid in parents:
 
91
            graph_children[parent_revid].append(revid)
 
92
        
 
93
        linegraph.append([revid,
 
94
                          None,
 
95
                          [],
 
96
                          parents,
 
97
                          None,
 
98
                          revno_sequence])
 
99
 
 
100
    branch_ids = branch_lines.keys()
 
101
    
 
102
    def branch_id_cmp(x, y):
 
103
        """Compaire branch_id's first by the number of digits, then reversed
 
104
        by their value"""
 
105
        len_x = len(x)
 
106
        len_y = len(y)
 
107
        if len_x == len_y:
 
108
            return -cmp(x, y)
 
109
        return cmp(len_x, len_y)
 
110
    
 
111
    branch_ids.sort(branch_id_cmp)
 
112
    # This will hold a tuple of (child_index, parent_index, col_index) for each
 
113
    # line that needs to be drawn. If col_index is not none, then the line is
 
114
    # drawn along that column, else the the line can be drawn directly between
 
115
    # the child and parent because either the child and parent are in the same
 
116
    # branch line, or the child and parent are 1 row apart.
 
117
    lines = []
 
118
    empty_column = [False for i in range(len(graph_parents))]
 
119
    # This will hold a bit map for each cell. If the cell is true, then the
 
120
    # cell allready contains a node or line. This use when deciding what column
 
121
    # to place a branch line or line in, without it overlaping something else.
 
122
    columns = [list(empty_column)]
 
123
    
 
124
    
 
125
    for branch_id in branch_ids:
 
126
        branch_line = branch_lines[branch_id]
 
127
        
 
128
        # Find the col_index for the direct parent branch. This will be the
 
129
        # starting point when looking for a free column.
 
130
        parent_col_index = 0
 
131
        parent_index = None
 
132
        if len(branch_id) > 1:
 
133
            parent_revno = branch_id[0:-1]
 
134
            if parent_revno in revno_index:
 
135
                parent_index = revno_index[parent_revno]
 
136
                parent_node = linegraph[parent_index][1]
 
137
                if parent_node:
 
138
                    parent_col_index = parent_node[0]
 
139
                
 
140
        
 
141
        col_search_order = _branch_line_col_search_order(columns,
 
142
                                                         parent_col_index)
 
143
        color = reduce(lambda x, y: x+y, branch_id, 0)
 
144
        cur_cont_line = []
 
145
        
 
146
        line_range = []
 
147
        last_rev_index = None
 
148
        for rev_index in branch_line:
 
149
            if last_rev_index:
 
150
                if broken_line_length and \
 
151
                   rev_index - last_rev_index > broken_line_length:
 
152
                    line_range.append(last_rev_index+1)
 
153
                    line_range.append(rev_index-1)
 
154
                else:
 
155
                    line_range.extend(range(last_rev_index+1, rev_index))
 
156
            
 
157
            line_range.append(rev_index)
 
158
            last_rev_index = rev_index
 
159
        
 
160
        if parent_index:
 
161
            if broken_line_length and \
 
162
               parent_index - last_rev_index > broken_line_length:
 
163
                line_range.append(last_rev_index+1)
 
164
            else:
 
165
                line_range.extend(range(last_rev_index+1, parent_index))
 
166
        
 
167
        col_index = _find_free_column(columns,
 
168
                                      empty_column,
 
169
                                      col_search_order,
 
170
                                      line_range)
 
171
        node = (col_index, color)
 
172
        for rev_index in branch_line:
 
173
            linegraph[rev_index][1] = node
 
174
            columns[col_index][rev_index] = True
 
175
        
 
176
        for rev_index in branch_line:
 
177
            (sequence_number,
 
178
                 revid,
 
179
                 merge_depth,
 
180
                 revno_sequence,
 
181
                 end_of_merge) = merge_sorted_revisions[rev_index]
 
182
            
 
183
            linegraph[rev_index][4] = graph_children[revid]
 
184
            col_index = linegraph[rev_index][1][0]
 
185
            
 
186
            for parent_revid in graph_parents[revid]:
 
187
                if parent_revid in revid_index:
 
188
                    
 
189
                    parent_index = revid_index[parent_revid]                            
 
190
                    parent_node = linegraph[parent_index][1]
 
191
                    if parent_node:
 
192
                        parent_col_index = parent_node[0]
 
193
                    else:
 
194
                        parent_col_index = None
 
195
                    col_search_order = \
 
196
                            _line_col_search_order(columns,
 
197
                                                   parent_col_index,
 
198
                                                   col_index)
 
199
                        
 
200
                    # If this line is really long, break it.
 
201
                    if len(branch_id) > 0 and \
 
202
                       broken_line_length and \
 
203
                       parent_index - rev_index > broken_line_length:
 
204
                        child_line_col_index = \
 
205
                            _find_free_column(columns,
 
206
                                              empty_column,
 
207
                                              col_search_order,
 
208
                                              (rev_index + 1,))
 
209
                        _mark_column_as_used(columns,
 
210
                                             child_line_col_index,
 
211
                                             (rev_index + 1,))
 
212
                        
 
213
                        # Recall _line_col_search_order to reset it back to
 
214
                        # the beging.
 
215
                        col_search_order = \
 
216
                                _line_col_search_order(columns,
 
217
                                                       parent_col_index,
 
218
                                                       col_index)
 
219
                        parent_col_line_index = \
 
220
                            _find_free_column(columns,
 
221
                                              empty_column,
 
222
                                              col_search_order,
 
223
                                              (parent_index - 1,))
 
224
                        _mark_column_as_used(columns,
 
225
                                             parent_col_line_index,
 
226
                                             (parent_index - 1,))
 
227
                        lines.append((rev_index,
 
228
                                      parent_index,
 
229
                                      (child_line_col_index,
 
230
                                       parent_col_line_index)))
 
231
                    else :
 
232
                        line_col_index = col_index
 
233
                        if parent_index - rev_index >1:
 
234
                            line_range = range(rev_index + 1, parent_index)
 
235
                            line_col_index = \
 
236
                                _find_free_column(columns,
 
237
                                                  empty_column,
 
238
                                                  col_search_order,
 
239
                                                  line_range)
 
240
                            _mark_column_as_used(columns,
 
241
                                                 line_col_index,
 
242
                                                 line_range)
 
243
                        lines.append((rev_index,
 
244
                                      parent_index,
 
245
                                      (line_col_index,)))
 
246
    
 
247
    for (child_index, parent_index, line_col_indexes) in lines:
 
248
        (child_col_index, child_color) = linegraph[child_index][1]
 
249
        (parent_col_index, parent_color) = linegraph[parent_index][1]
 
250
        
 
251
        if len(line_col_indexes) == 1:
 
252
            if parent_index - child_index == 1:
 
253
                linegraph[child_index][2].append(
 
254
                    (child_col_index,
 
255
                     parent_col_index,
 
256
                     parent_color))
 
257
            else:
 
258
                # line from the child's column to the lines column
 
259
                linegraph[child_index][2].append(
 
260
                    (child_col_index,
 
261
                     line_col_indexes[0],
 
262
                     parent_color))
 
263
                # lines down the line's column
 
264
                for line_part_index in range(child_index+1, parent_index-1):
 
265
                    linegraph[line_part_index][2].append(
 
266
                        (line_col_indexes[0],   
 
267
                         line_col_indexes[0],
 
268
                         parent_color))
 
269
                # line from the line's column to the parent's column
 
270
                linegraph[parent_index-1][2].append(
 
271
                    (line_col_indexes[0],
 
272
                     parent_col_index,
 
273
                     parent_color))
 
274
        else:
 
275
            # Broken line
 
276
            # line from the child's column to the lines column
 
277
            linegraph[child_index][2].append(
 
278
                (child_col_index,
 
279
                 line_col_indexes[0],
 
280
                 parent_color))
 
281
            # Broken line end
 
282
            linegraph[child_index+1][2].append(
 
283
                (line_col_indexes[0],
 
284
                 None,
 
285
                 parent_color))
 
286
            
 
287
            # Broken line end 
 
288
            linegraph[parent_index-2][2].append(
 
289
                (None,
 
290
                 line_col_indexes[1],
 
291
                 parent_color))
 
292
            # line from the line's column to the parent's column
 
293
            linegraph[parent_index-1][2].append(
 
294
                (line_col_indexes[1],
 
295
                 parent_col_index,
 
296
                 parent_color))
 
297
            
 
298
    
 
299
    return (linegraph, revid_index, len(columns))
 
300
 
 
301
def _branch_line_col_search_order(columns, parent_col_index):
 
302
    for col_index in range(parent_col_index, len(columns)):
 
303
        yield col_index
 
304
    for col_index in range(parent_col_index-1, -1, -1):
 
305
        yield col_index
 
306
 
 
307
def _line_col_search_order(columns, parent_col_index, child_col_index):
 
308
    if parent_col_index is not None:
 
309
        max_index = max(parent_col_index, child_col_index)
 
310
        min_index = min(parent_col_index, child_col_index)
 
311
        for col_index in range(max_index, min_index -1, -1):
 
312
            yield col_index
 
313
    else:
 
314
        max_index = child_col_index
 
315
        min_index = child_col_index
 
316
        yield child_col_index
 
317
    i = 1
 
318
    while max_index + i < len(columns) or \
 
319
          min_index - i > -1:
 
320
        if max_index + i < len(columns):
 
321
            yield max_index + i
 
322
        if min_index - i > -1:
 
323
            yield min_index - i
 
324
        i += 1
 
325
 
 
326
def _find_free_column(columns, empty_column, col_search_order, line_range):
 
327
    for col_index in col_search_order:
 
328
        column = columns[col_index]
 
329
        has_overlaping_line = False
 
330
        for row_index in line_range:
 
331
            if column[row_index]:
 
332
                has_overlaping_line = True
 
333
                break
 
334
        if not has_overlaping_line:
 
335
            break
 
336
    else:
 
337
        col_index = len(columns)
 
338
        column = list(empty_column)
 
339
        columns.append(column)
 
340
    return col_index
 
341
 
 
342
def _mark_column_as_used(columns, col_index, line_range):
 
343
    column = columns[col_index]
 
344
    for row_index in line_range:
 
345
        column[row_index] = True    
 
346
 
 
347
def same_branch(a, b):
 
348
    """Return whether we think revisions a and b are on the same branch."""
 
349
    if len(a.parent_ids) == 1:
 
350
        # Defacto same branch if only parent
 
351
        return True
 
352
    elif a.committer == b.committer:
 
353
        # Same committer so may as well be
 
354
        return True
 
355
    else:
 
356
        return False