/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: David Allouche
  • Date: 2005-12-03 01:51:28 UTC
  • Revision ID: david.allouche@canonical.com-20051203015128-5fba1772f9784017
optimise by filling caches first

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.revision import NULL_REVISION
13
 
from bzrlib.tsort import merge_sort
14
 
 
15
 
def linegraph(repository, start_revs, maxnum, broken_line_length = None,
16
 
              graph_data = True, mainline_only = False):
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
 
    
46
 
    graph = repository.get_graph()
47
 
    graph_parents = {}
48
 
    ghosts = set()
49
 
    graph_children = {}
50
 
    for (revid, parent_revids) in graph.iter_ancestry(start_revs):
51
 
        if parent_revids is None:
52
 
            ghosts.add(revid)
53
 
            continue
54
 
        if parent_revids == (NULL_REVISION,):
55
 
            graph_parents[revid] = ()
56
 
        else:
57
 
            graph_parents[revid] = parent_revids
58
 
        for parent in parent_revids:
59
 
            graph_children.setdefault(parent, []).append(revid)
60
 
        graph_children.setdefault(revid, [])
61
 
    for ghost in ghosts:
62
 
        for ghost_child in graph_children[ghost]:
63
 
            graph_parents[ghost_child] = [p for p in graph_parents[ghost_child]
64
 
                                          if p not in ghosts]
65
 
    graph_parents["top:"] = start_revs
66
 
 
67
 
    if len(graph_parents)>0:
68
 
        merge_sorted_revisions = merge_sort(
69
 
            graph_parents,
70
 
            "top:",
71
 
            generate_revno=True)
72
 
    else:
73
 
        merge_sorted_revisions = ()
74
 
    
75
 
    if mainline_only:
76
 
        merge_sorted_revisions = [elem for elem in merge_sorted_revisions \
77
 
                                  if len(elem[3])==1 ]
78
 
 
79
 
    assert merge_sorted_revisions[0][1] == "top:"
80
 
    merge_sorted_revisions = merge_sorted_revisions[1:]
81
 
    
82
 
    revid_index = {}
83
 
    revno_index = {}
84
 
    
85
 
    # This will hold an item for each "branch". For a revisions, the revsion
86
 
    # number less the least significant digit is the branch_id, and used as the
87
 
    # key for the dict. Hence revision with the same revsion number less the
88
 
    # least significant digit are considered to be in the same branch line.
89
 
    # e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
90
 
    # and these two revisions will be in the same branch line. Each value is
91
 
    # a list of rev_indexes in the branch.
92
 
    branch_lines = {}
93
 
    
94
 
    linegraph = []    
95
 
    
96
 
    for (rev_index, (sequence_number,
97
 
                     revid,
98
 
                     merge_depth,
99
 
                     revno_sequence,
100
 
                     end_of_merge)) in enumerate(merge_sorted_revisions):
101
 
        if maxnum and rev_index >= maxnum:
102
 
            break
103
 
        revid_index[revid] = rev_index
104
 
        
105
 
        parents = graph_parents[revid]
106
 
        linegraph.append([revid,
107
 
                          None,
108
 
                          [],
109
 
                          parents,
110
 
                          None,
111
 
                          revno_sequence])
112
 
        
113
 
        if graph_data:
114
 
            revno_index[revno_sequence] = rev_index
115
 
            
116
 
            branch_id = revno_sequence[0:-1]
117
 
            
118
 
            branch_line = None
119
 
            if branch_id not in branch_lines:
120
 
                branch_line = []
121
 
                branch_lines[branch_id] = branch_line
122
 
            else:
123
 
                branch_line = branch_lines[branch_id]
124
 
            
125
 
            branch_line.append(rev_index)        
126
 
 
127
 
    if graph_data:
128
 
        branch_ids = branch_lines.keys()
129
 
    
130
 
        def branch_id_cmp(x, y):
131
 
            """Compaire branch_id's first by the number of digits, then reversed
132
 
            by their value"""
133
 
            len_x = len(x)
134
 
            len_y = len(y)
135
 
            if len_x == len_y:
136
 
                return -cmp(x, y)
137
 
            return cmp(len_x, len_y)
138
 
        
139
 
        branch_ids.sort(branch_id_cmp)
140
 
        # This will hold a tuple of (child_index, parent_index, col_index) for each
141
 
        # line that needs to be drawn. If col_index is not none, then the line is
142
 
        # drawn along that column, else the the line can be drawn directly between
143
 
        # the child and parent because either the child and parent are in the same
144
 
        # branch line, or the child and parent are 1 row apart.
145
 
        lines = []
146
 
        empty_column = [False for i in range(len(graph_parents))]
147
 
        # This will hold a bit map for each cell. If the cell is true, then the
148
 
        # cell allready contains a node or line. This use when deciding what column
149
 
        # to place a branch line or line in, without it overlaping something else.
150
 
        columns = [list(empty_column)]
151
 
        
152
 
        
153
 
        for branch_id in branch_ids:
154
 
            branch_line = branch_lines[branch_id]
155
 
            
156
 
            # Find the col_index for the direct parent branch. This will be the
157
 
            # starting point when looking for a free column.
158
 
            parent_col_index = 0
159
 
            parent_index = None
160
 
            if len(branch_id) > 1:
161
 
                parent_revno = branch_id[0:-1]
162
 
                if parent_revno in revno_index:
163
 
                    parent_index = revno_index[parent_revno]
164
 
                    parent_node = linegraph[parent_index][1]
165
 
                    if parent_node:
166
 
                        parent_col_index = parent_node[0]
167
 
                    
168
 
            
169
 
            col_search_order = _branch_line_col_search_order(columns,
170
 
                                                             parent_col_index)
171
 
            color = reduce(lambda x, y: x+y, branch_id, 0)
172
 
            cur_cont_line = []
173
 
            
174
 
            line_range = []
175
 
            last_rev_index = None
176
 
            for rev_index in branch_line:
177
 
                if last_rev_index:
178
 
                    if broken_line_length and \
179
 
                       rev_index - last_rev_index > broken_line_length:
180
 
                        line_range.append(last_rev_index+1)
181
 
                        line_range.append(rev_index-1)
182
 
                    else:
183
 
                        line_range.extend(range(last_rev_index+1, rev_index))
184
 
                
185
 
                line_range.append(rev_index)
186
 
                last_rev_index = rev_index
187
 
            
188
 
            if parent_index:
189
 
                if broken_line_length and \
190
 
                   parent_index - last_rev_index > broken_line_length:
191
 
                    line_range.append(last_rev_index+1)
192
 
                else:
193
 
                    line_range.extend(range(last_rev_index+1, parent_index))
194
 
            
195
 
            col_index = _find_free_column(columns,
196
 
                                          empty_column,
197
 
                                          col_search_order,
198
 
                                          line_range)
199
 
            node = (col_index, color)
200
 
            for rev_index in branch_line:
201
 
                linegraph[rev_index][1] = node
202
 
                columns[col_index][rev_index] = True
203
 
            
204
 
            for rev_index in branch_line:
205
 
                (sequence_number,
206
 
                     revid,
207
 
                     merge_depth,
208
 
                     revno_sequence,
209
 
                     end_of_merge) = merge_sorted_revisions[rev_index]
210
 
                
211
 
                linegraph[rev_index][4] = graph_children[revid]
212
 
                col_index = linegraph[rev_index][1][0]
213
 
                
214
 
                for parent_revid in graph_parents[revid]:
215
 
                    if parent_revid in revid_index:
216
 
                        
217
 
                        parent_index = revid_index[parent_revid]                            
218
 
                        parent_node = linegraph[parent_index][1]
219
 
                        if parent_node:
220
 
                            parent_col_index = parent_node[0]
221
 
                        else:
222
 
                            parent_col_index = None
223
 
                        col_search_order = \
224
 
                                _line_col_search_order(columns,
225
 
                                                       parent_col_index,
226
 
                                                       col_index)
227
 
                            
228
 
                        # If this line is really long, break it.
229
 
                        if len(branch_id) > 0 and \
230
 
                           broken_line_length and \
231
 
                           parent_index - rev_index > broken_line_length:
232
 
                            child_line_col_index = \
233
 
                                _find_free_column(columns,
234
 
                                                  empty_column,
235
 
                                                  col_search_order,
236
 
                                                  (rev_index + 1,))
237
 
                            _mark_column_as_used(columns,
238
 
                                                 child_line_col_index,
239
 
                                                 (rev_index + 1,))
240
 
                            
241
 
                            # Recall _line_col_search_order to reset it back to
242
 
                            # the beging.
243
 
                            col_search_order = \
244
 
                                    _line_col_search_order(columns,
245
 
                                                           parent_col_index,
246
 
                                                           col_index)
247
 
                            parent_col_line_index = \
248
 
                                _find_free_column(columns,
249
 
                                                  empty_column,
250
 
                                                  col_search_order,
251
 
                                                  (parent_index - 1,))
252
 
                            _mark_column_as_used(columns,
253
 
                                                 parent_col_line_index,
254
 
                                                 (parent_index - 1,))
255
 
                            lines.append((rev_index,
256
 
                                          parent_index,
257
 
                                          (child_line_col_index,
258
 
                                           parent_col_line_index)))
259
 
                        else :
260
 
                            line_col_index = col_index
261
 
                            if parent_index - rev_index >1:
262
 
                                line_range = range(rev_index + 1, parent_index)
263
 
                                line_col_index = \
264
 
                                    _find_free_column(columns,
265
 
                                                      empty_column,
266
 
                                                      col_search_order,
267
 
                                                      line_range)
268
 
                                _mark_column_as_used(columns,
269
 
                                                     line_col_index,
270
 
                                                     line_range)
271
 
                            lines.append((rev_index,
272
 
                                          parent_index,
273
 
                                          (line_col_index,)))
274
 
        
275
 
        for (child_index, parent_index, line_col_indexes) in lines:
276
 
            (child_col_index, child_color) = linegraph[child_index][1]
277
 
            (parent_col_index, parent_color) = linegraph[parent_index][1]
278
 
            
279
 
            if len(line_col_indexes) == 1:
280
 
                if parent_index - child_index == 1:
281
 
                    linegraph[child_index][2].append(
282
 
                        (child_col_index,
283
 
                         parent_col_index,
284
 
                         parent_color))
285
 
                else:
286
 
                    # line from the child's column to the lines column
287
 
                    linegraph[child_index][2].append(
288
 
                        (child_col_index,
289
 
                         line_col_indexes[0],
290
 
                         parent_color))
291
 
                    # lines down the line's column
292
 
                    for line_part_index in range(child_index+1, parent_index-1):
293
 
                        linegraph[line_part_index][2].append(
294
 
                            (line_col_indexes[0],   
295
 
                             line_col_indexes[0],
296
 
                             parent_color))
297
 
                    # line from the line's column to the parent's column
298
 
                    linegraph[parent_index-1][2].append(
299
 
                        (line_col_indexes[0],
300
 
                         parent_col_index,
301
 
                         parent_color))
302
 
            else:
303
 
                # Broken line
304
 
                # line from the child's column to the lines column
305
 
                linegraph[child_index][2].append(
306
 
                    (child_col_index,
307
 
                     line_col_indexes[0],
308
 
                     parent_color))
309
 
                # Broken line end
310
 
                linegraph[child_index+1][2].append(
311
 
                    (line_col_indexes[0],
312
 
                     None,
313
 
                     parent_color))
314
 
                
315
 
                # Broken line end 
316
 
                linegraph[parent_index-2][2].append(
317
 
                    (None,
318
 
                     line_col_indexes[1],
319
 
                     parent_color))
320
 
                # line from the line's column to the parent's column
321
 
                linegraph[parent_index-1][2].append(
322
 
                    (line_col_indexes[1],
323
 
                     parent_col_index,
324
 
                     parent_color))
325
 
        return (linegraph, revid_index, len(columns))
326
 
    else:
327
 
        return (linegraph, revid_index, 0)
328
 
    
329
 
 
330
 
def _branch_line_col_search_order(columns, parent_col_index):
331
 
    for col_index in range(parent_col_index, len(columns)):
332
 
        yield col_index
333
 
    for col_index in range(parent_col_index-1, -1, -1):
334
 
        yield col_index
335
 
 
336
 
def _line_col_search_order(columns, parent_col_index, child_col_index):
337
 
    if parent_col_index is not None:
338
 
        max_index = max(parent_col_index, child_col_index)
339
 
        min_index = min(parent_col_index, child_col_index)
340
 
        for col_index in range(max_index, min_index -1, -1):
341
 
            yield col_index
342
 
    else:
343
 
        max_index = child_col_index
344
 
        min_index = child_col_index
345
 
        yield child_col_index
346
 
    i = 1
347
 
    while max_index + i < len(columns) or \
348
 
          min_index - i > -1:
349
 
        if max_index + i < len(columns):
350
 
            yield max_index + i
351
 
        if min_index - i > -1:
352
 
            yield min_index - i
353
 
        i += 1
354
 
 
355
 
def _find_free_column(columns, empty_column, col_search_order, line_range):
356
 
    for col_index in col_search_order:
357
 
        column = columns[col_index]
358
 
        has_overlaping_line = False
359
 
        for row_index in line_range:
360
 
            if column[row_index]:
361
 
                has_overlaping_line = True
362
 
                break
363
 
        if not has_overlaping_line:
364
 
            break
365
 
    else:
366
 
        col_index = len(columns)
367
 
        column = list(empty_column)
368
 
        columns.append(column)
369
 
    return col_index
370
 
 
371
 
def _mark_column_as_used(columns, col_index, line_range):
372
 
    column = columns[col_index]
373
 
    for row_index in line_range:
374
 
        column[row_index] = True    
375
 
 
376
 
def same_branch(a, b):
377
 
    """Return whether we think revisions a and b are on the same branch."""
378
 
    if len(a.parent_ids) == 1:
379
 
        # Defacto same branch if only parent
380
 
        return True
381
 
    elif a.committer == b.committer:
382
 
        # Same committer so may as well be
383
 
        return True
384
 
    else:
385
 
        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
class DistanceMethod(object):
 
34
 
 
35
    def __init__(self, branch, start):
 
36
        self.branch = branch
 
37
        self.start = start
 
38
        self.revisions = {}
 
39
        self.children = {}
 
40
        self.children_of_id = {start: set()}
 
41
        self.parent_ids_of = {}
 
42
        self.colours = { start: 0 }
 
43
        self.last_colour = 0
 
44
        self.direct_parent_of = {}
 
45
 
 
46
    def fill_caches(self):
 
47
        branch = self.branch
 
48
        revisions = self.revisions
 
49
        todo = set([self.start])
 
50
        while todo:
 
51
            revid = todo.pop()
 
52
            try:
 
53
                revision = branch.get_revision(revid)
 
54
            except NoSuchRevision:
 
55
                revision = DummyRevision(revid)
 
56
            self.cache_revision(revid, revision)
 
57
            for parent_id in revision.parent_ids:
 
58
                if parent_id not in revisions:
 
59
                    todo.add(parent_id)
 
60
 
 
61
    def cache_revision(self, revid, revision):
 
62
        "Set the caches for a newly retrieved revision."""
 
63
        # Build a revision cache
 
64
        self.revisions[revid] = revision
 
65
        # Build a children dictionnary
 
66
        for parent_id in revision.parent_ids:
 
67
            self.children_of_id.setdefault(parent_id, set()).add(revision)
 
68
        # Build a parents dictionnary, where redundant parents will be removed,
 
69
        # and that will be passed along tothe rest of program.
 
70
        if len(revision.parent_ids) == len(set(revision.parent_ids)):
 
71
            self.parent_ids_of[revision] = list(revision.parent_ids)
 
72
        else:
 
73
            # Remove duplicate parents
 
74
            parent_ids = []
 
75
            parent_ids_set = set()
 
76
            for parent_id in revision.parent_ids:
 
77
                if parent_id in parent_ids_set:
 
78
                    continue
 
79
                parent_ids.append(parent_id)
 
80
                parent_ids_set.add(parent_id)
 
81
            self.parent_ids_of[revision] = parent_ids
 
82
 
 
83
    def make_children_map(self):
 
84
        revisions = self.revisions
 
85
        return dict((revisions[revid], c)
 
86
                    for (revid, c) in self.children_of_id.iteritems())
 
87
 
 
88
    def first_ancestry_traversal(self):
 
89
        # Sort the revisions; the fastest way to do this is to visit each node
 
90
        # as few times as possible (by keeping the todo list in a set) and
 
91
        # record the largest distance to it before queuing up the children if
 
92
        # we increased the distance. This produces the sort order we desire
 
93
        distances = { self.start: 0 }
 
94
        todo = set([self.start])
 
95
        revisions = self.revisions
 
96
        while todo:
 
97
            revid = todo.pop()
 
98
            revision = revisions[revid]
 
99
            distance = distances[revid] + 1
 
100
            for parent_id in revision.parent_ids:
 
101
                if parent_id in distances and distances[parent_id] >= distance:
 
102
                    continue
 
103
                distances[parent_id] = distance
 
104
                todo.add(parent_id)
 
105
        # Topologically sorted revids, with the most recent revisions first.
 
106
        # A revision occurs only after all of its children.
 
107
        return sorted(distances, key=distances.get)
 
108
 
 
109
    def remove_redundant_parents(self, sorted_revids):
 
110
        children_of_id = self.children_of_id
 
111
        revisions = self.revisions
 
112
        parent_ids_of = self.parent_ids_of
 
113
        
 
114
        # Count the number of children of each revision, so we can release
 
115
        # memory for ancestry data as soon as it's not going to be needed
 
116
        # anymore.
 
117
        pending_count_of = {}
 
118
        for parent_id, children in children_of_id.iteritems():
 
119
            pending_count_of[parent_id] = len(children)
 
120
 
 
121
        # Build the ancestry dictionnary by examining older revisions first,
 
122
        # and remove revision parents that are ancestors of other parents of
 
123
        # the same revision.
 
124
        ancestor_ids_of = {}
 
125
        for revid in reversed(sorted_revids):
 
126
            revision = revisions[revid]
 
127
            parent_ids = parent_ids_of[revision]
 
128
            # ignore candidate parents which are an ancestor of another parent,
 
129
            # but never ignore the leftmost parent
 
130
            redundant_ids = []
 
131
            ignorable_parent_ids = parent_ids[1:] # never ignore leftmost
 
132
            for candidate_id in ignorable_parent_ids: 
 
133
                for parent_id in list(parent_ids):
 
134
                    if candidate_id in ancestor_ids_of[parent_id]:
 
135
                        redundant_ids.append(candidate_id)
 
136
                        parent_ids.remove(candidate_id)
 
137
                        children_of_candidate = children_of_id[candidate_id]
 
138
                        children_of_candidate.remove(revision)
 
139
                        break
 
140
            # save the set of ancestors of that revision
 
141
            ancestor_ids = set(parent_ids)
 
142
            for parent_id in parent_ids:
 
143
                ancestor_ids.update(ancestor_ids_of[parent_id])
 
144
            ancestor_ids_of[revid] = ancestor_ids
 
145
            # discard ancestry data for revisions whose children are already
 
146
            # done
 
147
            for parent_id in parent_ids + redundant_ids:
 
148
                pending_count = pending_count_of[parent_id] - 1
 
149
                pending_count_of[parent_id] = pending_count
 
150
                if pending_count == 0:
 
151
                    ancestor_ids_of[parent_id] = None
 
152
 
 
153
    def sort_revisions_and_set_colours(self, sorted_revids):
 
154
        revisions = self.revisions
 
155
        parent_ids_of = self.parent_ids_of
 
156
        children_of_id = self.children_of_id
 
157
        # Try to compact sequences of revisions on the same branch.
 
158
        distances = {}
 
159
        skipped_revids = []
 
160
        expected_id = sorted_revids[0]
 
161
        pending_ids = []
 
162
        while True:
 
163
            revid = sorted_revids.pop(0)
 
164
            if revid != expected_id:
 
165
                skipped_revids.append(revid)
 
166
                continue
 
167
            revision = revisions[revid]
 
168
            for child in children_of_id[revid]:
 
169
                # postpone if any child is missing
 
170
                if child.revision_id not in distances:
 
171
                    if expected_id not in pending_ids:
 
172
                        pending_ids.append(expected_id)
 
173
                    assert len(pending_ids) > 1
 
174
                    expected_id = pending_ids.pop(0)
 
175
                    skipped_revids.append(revid)
 
176
                    sorted_revids[:0] = skipped_revids
 
177
                    skipped_revids = []
 
178
                    break
 
179
            else:
 
180
                # all children are here, push!
 
181
                distances[revid] = len(distances)
 
182
                self.choose_colour(revision, distances)
 
183
                # all parents will need to be pushed as soon as possible
 
184
                for parent in parent_ids_of[revision]:
 
185
                    if parent not in pending_ids:
 
186
                        pending_ids.insert(0, parent)
 
187
                if not pending_ids:
 
188
                    break
 
189
                expected_id = pending_ids.pop(0)
 
190
                # if the next expected revid has already been skipped, requeue
 
191
                # it and its potential ancestors.
 
192
                if expected_id in skipped_revids:
 
193
                    pos = skipped_revids.index(expected_id)
 
194
                    sorted_revids[:0] = skipped_revids[pos:]
 
195
                    del skipped_revids[pos:]
 
196
        return sorted(distances, key=distances.get)
 
197
 
 
198
    def choose_colour(self, revision, distances):
 
199
        revid = revision.revision_id
 
200
        children_of_id = self.children_of_id
 
201
        parent_ids_of = self.parent_ids_of
 
202
        colours = self.colours
 
203
        # choose colour
 
204
        the_children = children_of_id[revid]
 
205
        if len(the_children) == 1:
 
206
            [child] = the_children
 
207
            if len(parent_ids_of[child]) == 1:
 
208
                # one-one relationship between parent and child, same
 
209
                # colour
 
210
                colours[revid] = colours[child.revision_id]
 
211
            else:
 
212
                self.choose_colour_one_child(revision, child)
 
213
        else:
 
214
            self.choose_colour_many_children(revision, the_children, distances)
 
215
 
 
216
    def choose_colour_one_child(self, revision, child):
 
217
        revid = revision.revision_id
 
218
        direct_parent_of = self.direct_parent_of
 
219
        revisions = self.revisions
 
220
        # one child with multiple parents, the first parent with
 
221
        # the same committer gets the colour
 
222
        direct_parent = direct_parent_of.get(child)
 
223
        if direct_parent is None:
 
224
            # if it has not been found yet, find it now and remember
 
225
            for parent_id in self.parent_ids_of[child]:
 
226
                parent_revision = revisions[parent_id]
 
227
                if parent_revision.committer == child.committer:
 
228
                    # found the first parent with the same committer
 
229
                    direct_parent = parent_revision
 
230
                    direct_parent_of[child] = direct_parent
 
231
                    break
 
232
        if direct_parent == revision:
 
233
            self.colours[revid] = self.colours[child.revision_id]
 
234
        else:
 
235
            self.colours[revid] = self.last_colour = self.last_colour + 1
 
236
 
 
237
    def choose_colour_many_children(self, revision, the_children, distances):
 
238
        revid = revision.revision_id
 
239
        direct_parent_of = self.direct_parent_of
 
240
        # multiple children, get the colour of the last displayed child
 
241
        # with the same committer which does not already have its colour
 
242
        # taken
 
243
        available = {}
 
244
        for child in the_children:
 
245
            if child.committer != revision.committer:
 
246
                continue
 
247
            direct_parent = direct_parent_of.get(child)
 
248
            if direct_parent == revision:
 
249
                self.colours[revid] = self.colours[child.revision_id]
 
250
                break
 
251
            if direct_parent is None:
 
252
                available[child] = distances[child.revision_id]
 
253
        else:
 
254
            if available:
 
255
                sorted_children = sorted(available, key=available.get)
 
256
                child = sorted_children[-1]
 
257
                direct_parent_of[child] = revision
 
258
                self.colours[revid] = self.colours[child.revision_id]
 
259
            else:
 
260
                # no candidate children is available, pick the next
 
261
                # colour
 
262
                self.colours[revid] = self.last_colour = self.last_colour + 1
 
263
 
 
264
 
 
265
def distances(branch, start):
 
266
    """Sort the revisions.
 
267
 
 
268
    Traverses the branch revision tree starting at start and produces an
 
269
    ordered list of revisions such that a revision always comes after
 
270
    any revision it is the parent of.
 
271
 
 
272
    Returns a tuple of (revids, revisions, colours, children)
 
273
    """
 
274
    distance = DistanceMethod(branch, start)
 
275
    distance.fill_caches()
 
276
    sorted_revids = distance.first_ancestry_traversal()
 
277
    distance.remove_redundant_parents(sorted_revids)
 
278
    sorted_revids = distance.sort_revisions_and_set_colours(sorted_revids)
 
279
 
 
280
    revisions = distance.revisions
 
281
    colours = distance.colours
 
282
    children = distance.make_children_map()
 
283
    parent_ids_of = distance.parent_ids_of
 
284
    return (sorted_revids, revisions, colours, children, parent_ids_of)
 
285
 
 
286
def graph(revids, revisions, colours, parent_ids):
 
287
    """Produce a directed graph of a bzr branch.
 
288
 
 
289
    For each revision it then yields a tuple of (revision, node, lines).
 
290
    If the revision is only referenced in the branch and not present in the
 
291
    store, revision will be a DummyRevision object, otherwise it is the bzr
 
292
    Revision object with the meta-data for the revision.
 
293
 
 
294
    Node is a tuple of (column, colour) with column being a zero-indexed
 
295
    column number of the graph that this revision represents and colour
 
296
    being a zero-indexed colour (which doesn't specify any actual colour
 
297
    in particular) to draw the node in.
 
298
 
 
299
    Lines is a list of tuples which represent lines you should draw away
 
300
    from the revision, if you also need to draw lines into the revision
 
301
    you should use the lines list from the previous iteration.  Each
 
302
    typle in the list is in the form (start, end, colour) with start and
 
303
    end being zero-indexed column numbers and colour as in node.
 
304
 
 
305
    It's up to you how to actually draw the nodes and lines (straight,
 
306
    curved, kinked, etc.) and to pick the actual colours for each index.
 
307
    """
 
308
    hanging = revids[:1]
 
309
    for revid in revids:
 
310
        lines = []
 
311
        node = None
 
312
 
 
313
        new_hanging = []
 
314
        for h_idx, hang in enumerate(hanging):
 
315
            if hang == revid:
 
316
                # We've matched a hanging revision, so need to output a node
 
317
                # at this point
 
318
                node = (h_idx, colours[revid])
 
319
 
 
320
                # Now we need to hang its parents, we put them at the point
 
321
                # the old column was so anything to the right of this has
 
322
                # to move outwards to make room.  We also try and collapse
 
323
                # hangs to keep the graph small.
 
324
                for parent_id in parent_ids[revisions[revid]]:
 
325
                    try:
 
326
                        n_idx = new_hanging.index(parent_id)
 
327
                    except ValueError:
 
328
                        n_idx = len(new_hanging)
 
329
                        new_hanging.append(parent_id)
 
330
                    lines.append((h_idx, n_idx, colours[parent_id]))
 
331
            else:
 
332
                # Revision keeps on hanging, adjust for any change in the
 
333
                # graph shape and try to collapse hangs to keep the graph
 
334
                # small.
 
335
                try:
 
336
                    n_idx = new_hanging.index(hang)
 
337
                except ValueError:
 
338
                    n_idx = len(new_hanging)
 
339
                    new_hanging.append(hang)
 
340
                lines.append((h_idx, n_idx, colours[hang]))
 
341
        hanging = new_hanging
 
342
 
 
343
        yield (revisions[revid], node, lines)
 
344
 
 
345
 
 
346
def same_branch(a, b):
 
347
    """Return whether we think revisions a and b are on the same branch."""
 
348
    if len(a.parent_ids) == 1:
 
349
        # Defacto same branch if only parent
 
350
        return True
 
351
    elif a.committer == b.committer:
 
352
        # Same committer so may as well be
 
353
        return True
 
354
    else:
 
355
        return False