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

  • Committer: Daniel Schierbeck
  • Date: 2008-01-13 14:12:49 UTC
  • mto: (423.1.2 trunk)
  • mto: This revision was merged to the branch mainline in revision 429.
  • Revision ID: daniel.schierbeck@gmail.com-20080113141249-gd0i2lknr3yik55r
Moved branch view to its own package.

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