/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:
1
 
"""Directed graph production.
2
 
 
3
 
This module contains the code to produce an ordered directed graph of a
4
 
bzr branch, such as we display in the tree view at the top of the bzrk
5
 
window.
6
 
"""
7
 
 
8
 
__copyright__ = "Copyright 2005 Canonical Ltd."
9
 
__author__    = "Scott James Remnant <scott@ubuntu.com>"
10
 
 
11
 
from bzrlib.revision import NULL_REVISION
12
 
from bzrlib.tsort import merge_sort
13
 
from bzrlib import ui
14
 
 
15
 
def linegraph(graph, start_revs, maxnum=None, broken_line_length=None,
16
 
              graph_data=True, mainline_only=False, root_progress=None):
17
 
    """Produce a directed graph of a bzr repository.
18
 
 
19
 
    Returns a tuple of (line_graph, revid_index, columns_len) where
20
 
    * line_graph is a list of tuples of (revid,
21
 
                                         node,
22
 
                                         lines,
23
 
                                         parents,
24
 
                                         children,
25
 
                                         revno_sequence),
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.
29
 
    
30
 
 
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.
35
 
 
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.
41
 
 
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.
44
 
    """
45
 
    assert isinstance(start_revs, list)
46
 
    def update_root_progress(step_number):
47
 
        """IFF our container received a root progress bar, then update it."""
48
 
        if root_progress is not None:
49
 
            root_progress.update(None, step_number)
50
 
 
51
 
    graph_parents = {}
52
 
    ghosts = set()
53
 
    graph_children = {}
54
 
    update_root_progress(1)
55
 
    progress_bar = ui.ui_factory.nested_progress_bar()
56
 
    try:
57
 
        progress_bar.update("Arranging tree fragments")
58
 
        for i, (revid, parent_revids) in enumerate(graph.iter_ancestry(start_revs)):
59
 
            if i % 25 == 0:
60
 
                progress_bar.tick()
61
 
            if parent_revids is None:
62
 
                ghosts.add(revid)
63
 
                continue
64
 
            if parent_revids == (NULL_REVISION,):
65
 
                graph_parents[revid] = ()
66
 
            else:
67
 
                graph_parents[revid] = parent_revids
68
 
            for parent in parent_revids:
69
 
                graph_children.setdefault(parent, []).append(revid)
70
 
            graph_children.setdefault(revid, [])
71
 
    finally:
72
 
        progress_bar.finished()
73
 
 
74
 
    update_root_progress(2)
75
 
    progress_bar = ui.ui_factory.nested_progress_bar()
76
 
    try:
77
 
        progress_bar.update("Removing ghosts", 0, len(ghosts))
78
 
        for i, ghost in enumerate(ghosts):
79
 
            if i % 25 == 0:
80
 
                progress_bar.update(None, i)
81
 
            for ghost_child in graph_children[ghost]:
82
 
                graph_parents[ghost_child] = [p for p in graph_parents[ghost_child]
83
 
                                              if p not in ghosts]
84
 
    finally:
85
 
        progress_bar.finished()
86
 
    graph_parents["top:"] = start_revs
87
 
 
88
 
    if len(graph_parents)>0:
89
 
        merge_sorted_revisions = merge_sort(
90
 
            graph_parents,
91
 
            "top:",
92
 
            generate_revno=True)
93
 
    else:
94
 
        merge_sorted_revisions = ()
95
 
    
96
 
    if mainline_only:
97
 
        merge_sorted_revisions = [elem for elem in merge_sorted_revisions \
98
 
                                  if len(elem[3])==1 ]
99
 
 
100
 
    assert merge_sorted_revisions[0][1] == "top:"
101
 
    merge_sorted_revisions = merge_sorted_revisions[1:]
102
 
    
103
 
    revid_index = {}
104
 
    revno_index = {}
105
 
    
106
 
    # This will hold an item for each "branch". For a revisions, the revsion
107
 
    # number less the least significant digit is the branch_id, and used as the
108
 
    # key for the dict. Hence revision with the same revsion number less the
109
 
    # least significant digit are considered to be in the same branch line.
110
 
    # e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
111
 
    # and these two revisions will be in the same branch line. Each value is
112
 
    # a list of rev_indexes in the branch.
113
 
    branch_lines = {}
114
 
    
115
 
    linegraph = []    
116
 
    
117
 
    update_root_progress(3)
118
 
    progress_bar = ui.ui_factory.nested_progress_bar()
119
 
    try:
120
 
        progress_bar.update("Finding nodes", 0, len(merge_sorted_revisions))
121
 
        for (rev_index, (sequence_number,
122
 
                         revid,
123
 
                         merge_depth,
124
 
                         revno_sequence,
125
 
                         end_of_merge)) in enumerate(merge_sorted_revisions):
126
 
 
127
 
            if rev_index % 25 == 0:
128
 
                progress_bar.update(None, rev_index)
129
 
            if maxnum and rev_index >= maxnum:
130
 
                break
131
 
            revid_index[revid] = rev_index
132
 
            
133
 
            parents = graph_parents[revid]
134
 
            linegraph.append([revid,
135
 
                              None,
136
 
                              [],
137
 
                              parents,
138
 
                              None,
139
 
                              revno_sequence])
140
 
            
141
 
            if graph_data:
142
 
                revno_index[revno_sequence] = rev_index
143
 
                
144
 
                branch_id = revno_sequence[0:-1]
145
 
                
146
 
                branch_line = None
147
 
                if branch_id not in branch_lines:
148
 
                    branch_line = []
149
 
                    branch_lines[branch_id] = branch_line
150
 
                else:
151
 
                    branch_line = branch_lines[branch_id]
152
 
                
153
 
                branch_line.append(rev_index)        
154
 
    finally:
155
 
        progress_bar.finished()
156
 
 
157
 
    if graph_data:
158
 
        branch_ids = branch_lines.keys()
159
 
    
160
 
        def branch_id_cmp(x, y):
161
 
            """Compaire branch_id's first by the number of digits, then reversed
162
 
            by their value"""
163
 
            len_x = len(x)
164
 
            len_y = len(y)
165
 
            if len_x == len_y:
166
 
                return -cmp(x, y)
167
 
            return cmp(len_x, len_y)
168
 
        
169
 
        branch_ids.sort(branch_id_cmp)
170
 
        # This will hold a tuple of (child_index, parent_index, col_index) for each
171
 
        # line that needs to be drawn. If col_index is not none, then the line is
172
 
        # drawn along that column, else the the line can be drawn directly between
173
 
        # the child and parent because either the child and parent are in the same
174
 
        # branch line, or the child and parent are 1 row apart.
175
 
        lines = []
176
 
        empty_column = [False for i in range(len(graph_parents))]
177
 
        # This will hold a bit map for each cell. If the cell is true, then the
178
 
        # cell allready contains a node or line. This use when deciding what column
179
 
        # to place a branch line or line in, without it overlaping something else.
180
 
        columns = [list(empty_column)]
181
 
        
182
 
        
183
 
        update_root_progress(4)
184
 
        progress_bar = ui.ui_factory.nested_progress_bar()
185
 
        try:
186
 
            progress_bar.update("Organizing edges", 0, len(branch_ids))
187
 
            for i, branch_id in enumerate(branch_ids):
188
 
                if i % 25 == 0:
189
 
                    progress_bar.update(None, i)
190
 
                branch_line = branch_lines[branch_id]
191
 
                
192
 
                # Find the col_index for the direct parent branch. This will be the
193
 
                # starting point when looking for a free column.
194
 
                parent_col_index = 0
195
 
                parent_index = None
196
 
                if len(branch_id) > 1:
197
 
                    parent_revno = branch_id[0:-1]
198
 
                    if parent_revno in revno_index:
199
 
                        parent_index = revno_index[parent_revno]
200
 
                        parent_node = linegraph[parent_index][1]
201
 
                        if parent_node:
202
 
                            parent_col_index = parent_node[0]
203
 
                        
204
 
                
205
 
                col_search_order = _branch_line_col_search_order(columns,
206
 
                                                                 parent_col_index)
207
 
                color = reduce(lambda x, y: x+y, branch_id, 0)
208
 
                cur_cont_line = []
209
 
                
210
 
                line_range = []
211
 
                last_rev_index = None
212
 
                for rev_index in branch_line:
213
 
                    if last_rev_index:
214
 
                        if broken_line_length and \
215
 
                           rev_index - last_rev_index > broken_line_length:
216
 
                            line_range.append(last_rev_index+1)
217
 
                            line_range.append(rev_index-1)
218
 
                        else:
219
 
                            line_range.extend(range(last_rev_index+1, rev_index))
220
 
                    
221
 
                    line_range.append(rev_index)
222
 
                    last_rev_index = rev_index
223
 
                
224
 
                if parent_index:
225
 
                    if broken_line_length and \
226
 
                       parent_index - last_rev_index > broken_line_length:
227
 
                        line_range.append(last_rev_index+1)
228
 
                    else:
229
 
                        line_range.extend(range(last_rev_index+1, parent_index))
230
 
                
231
 
                col_index = _find_free_column(columns,
232
 
                                              empty_column,
233
 
                                              col_search_order,
234
 
                                              line_range)
235
 
                node = (col_index, color)
236
 
                for rev_index in branch_line:
237
 
                    linegraph[rev_index][1] = node
238
 
                    columns[col_index][rev_index] = True
239
 
                
240
 
                for rev_index in branch_line:
241
 
                    (sequence_number,
242
 
                         revid,
243
 
                         merge_depth,
244
 
                         revno_sequence,
245
 
                         end_of_merge) = merge_sorted_revisions[rev_index]
246
 
                    
247
 
                    linegraph[rev_index][4] = graph_children[revid]
248
 
                    col_index = linegraph[rev_index][1][0]
249
 
                    
250
 
                    for parent_revid in graph_parents[revid]:
251
 
                        if parent_revid in revid_index:
252
 
                            
253
 
                            parent_index = revid_index[parent_revid]                            
254
 
                            parent_node = linegraph[parent_index][1]
255
 
                            if parent_node:
256
 
                                parent_col_index = parent_node[0]
257
 
                            else:
258
 
                                parent_col_index = None
259
 
                            col_search_order = \
260
 
                                    _line_col_search_order(columns,
261
 
                                                           parent_col_index,
262
 
                                                           col_index)
263
 
                                
264
 
                            # If this line is really long, break it.
265
 
                            if len(branch_id) > 0 and \
266
 
                               broken_line_length and \
267
 
                               parent_index - rev_index > broken_line_length:
268
 
                                child_line_col_index = \
269
 
                                    _find_free_column(columns,
270
 
                                                      empty_column,
271
 
                                                      col_search_order,
272
 
                                                      (rev_index + 1,))
273
 
                                _mark_column_as_used(columns,
274
 
                                                     child_line_col_index,
275
 
                                                     (rev_index + 1,))
276
 
                                
277
 
                                # Recall _line_col_search_order to reset it back to
278
 
                                # the beging.
279
 
                                col_search_order = \
280
 
                                        _line_col_search_order(columns,
281
 
                                                               parent_col_index,
282
 
                                                               col_index)
283
 
                                parent_col_line_index = \
284
 
                                    _find_free_column(columns,
285
 
                                                      empty_column,
286
 
                                                      col_search_order,
287
 
                                                      (parent_index - 1,))
288
 
                                _mark_column_as_used(columns,
289
 
                                                     parent_col_line_index,
290
 
                                                     (parent_index - 1,))
291
 
                                lines.append((rev_index,
292
 
                                              parent_index,
293
 
                                              (child_line_col_index,
294
 
                                               parent_col_line_index)))
295
 
                            else :
296
 
                                line_col_index = col_index
297
 
                                if parent_index - rev_index >1:
298
 
                                    line_range = range(rev_index + 1, parent_index)
299
 
                                    line_col_index = \
300
 
                                        _find_free_column(columns,
301
 
                                                          empty_column,
302
 
                                                          col_search_order,
303
 
                                                          line_range)
304
 
                                    _mark_column_as_used(columns,
305
 
                                                         line_col_index,
306
 
                                                         line_range)
307
 
                                lines.append((rev_index,
308
 
                                              parent_index,
309
 
                                              (line_col_index,)))
310
 
        finally:
311
 
            progress_bar.finished()
312
 
        
313
 
        update_root_progress(5)
314
 
        progress_bar = ui.ui_factory.nested_progress_bar()
315
 
        try:
316
 
            progress_bar.update("Prettifying graph", 0, len(lines))
317
 
            for i, (child_index, parent_index, line_col_indexes) in enumerate(lines):
318
 
                if i % 25 == 0:
319
 
                    progress_bar.update(None, i)
320
 
                (child_col_index, child_color) = linegraph[child_index][1]
321
 
                (parent_col_index, parent_color) = linegraph[parent_index][1]
322
 
                
323
 
                if len(line_col_indexes) == 1:
324
 
                    if parent_index - child_index == 1:
325
 
                        linegraph[child_index][2].append(
326
 
                            (child_col_index,
327
 
                             parent_col_index,
328
 
                             parent_color))
329
 
                    else:
330
 
                        # line from the child's column to the lines column
331
 
                        linegraph[child_index][2].append(
332
 
                            (child_col_index,
333
 
                             line_col_indexes[0],
334
 
                             parent_color))
335
 
                        # lines down the line's column
336
 
                        for line_part_index in range(child_index+1, parent_index-1):
337
 
                            linegraph[line_part_index][2].append(
338
 
                                (line_col_indexes[0],   
339
 
                                 line_col_indexes[0],
340
 
                                 parent_color))
341
 
                        # line from the line's column to the parent's column
342
 
                        linegraph[parent_index-1][2].append(
343
 
                            (line_col_indexes[0],
344
 
                             parent_col_index,
345
 
                             parent_color))
346
 
                else:
347
 
                    # Broken line
348
 
                    # line from the child's column to the lines column
349
 
                    linegraph[child_index][2].append(
350
 
                        (child_col_index,
351
 
                         line_col_indexes[0],
352
 
                         parent_color))
353
 
                    # Broken line end
354
 
                    linegraph[child_index+1][2].append(
355
 
                        (line_col_indexes[0],
356
 
                         None,
357
 
                         parent_color))
358
 
                    
359
 
                    # Broken line end 
360
 
                    linegraph[parent_index-2][2].append(
361
 
                        (None,
362
 
                         line_col_indexes[1],
363
 
                         parent_color))
364
 
                    # line from the line's column to the parent's column
365
 
                    linegraph[parent_index-1][2].append(
366
 
                        (line_col_indexes[1],
367
 
                         parent_col_index,
368
 
                         parent_color))
369
 
        finally:
370
 
            progress_bar.finished()
371
 
        return (linegraph, revid_index, len(columns))
372
 
    else:
373
 
        return (linegraph, revid_index, 0)
374
 
    
375
 
 
376
 
def _branch_line_col_search_order(columns, parent_col_index):
377
 
    for col_index in range(parent_col_index, len(columns)):
378
 
        yield col_index
379
 
    for col_index in range(parent_col_index-1, -1, -1):
380
 
        yield col_index
381
 
 
382
 
def _line_col_search_order(columns, parent_col_index, child_col_index):
383
 
    if parent_col_index is not None:
384
 
        max_index = max(parent_col_index, child_col_index)
385
 
        min_index = min(parent_col_index, child_col_index)
386
 
        for col_index in range(max_index, min_index -1, -1):
387
 
            yield col_index
388
 
    else:
389
 
        max_index = child_col_index
390
 
        min_index = child_col_index
391
 
        yield child_col_index
392
 
    i = 1
393
 
    while max_index + i < len(columns) or \
394
 
          min_index - i > -1:
395
 
        if max_index + i < len(columns):
396
 
            yield max_index + i
397
 
        if min_index - i > -1:
398
 
            yield min_index - i
399
 
        i += 1
400
 
 
401
 
def _find_free_column(columns, empty_column, col_search_order, line_range):
402
 
    for col_index in col_search_order:
403
 
        column = columns[col_index]
404
 
        has_overlaping_line = False
405
 
        for row_index in line_range:
406
 
            if column[row_index]:
407
 
                has_overlaping_line = True
408
 
                break
409
 
        if not has_overlaping_line:
410
 
            break
411
 
    else:
412
 
        col_index = len(columns)
413
 
        column = list(empty_column)
414
 
        columns.append(column)
415
 
    return col_index
416
 
 
417
 
def _mark_column_as_used(columns, col_index, line_range):
418
 
    column = columns[col_index]
419
 
    for row_index in line_range:
420
 
        column[row_index] = True    
421
 
 
422
 
def same_branch(a, b):
423
 
    """Return whether we think revisions a and b are on the same branch."""
424
 
    if len(a.parent_ids) == 1:
425
 
        # Defacto same branch if only parent
426
 
        return True
427
 
    elif a.committer == b.committer:
428
 
        # Same committer so may as well be
429
 
        return True
430
 
    else:
431
 
        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)