/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/graph.py

  • Committer: Jelmer Vernooij
  • Date: 2006-09-30 10:21:43 UTC
  • Revision ID: jelmer@samba.org-20060930102143-c0ef64d6ca860c21
Merge some files from Olive and bzr-gtk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
viz/graph.py
1
 
#!/usr/bin/python
2
1
# -*- coding: UTF-8 -*-
3
2
"""Directed graph production.
4
3
 
11
10
__author__    = "Scott James Remnant <scott@ubuntu.com>"
12
11
 
13
12
 
14
 
from bzrlib.errors import NoSuchRevision
 
13
from bzrlib.tsort import merge_sort
15
14
 
16
15
 
17
16
class DummyRevision(object):
30
29
        self.message = self.revision_id
31
30
 
32
31
 
 
32
class RevisionProxy(object):
 
33
    """A revision proxy object.
 
34
 
 
35
    This will demand load the revision it represents when the committer or
 
36
    message attributes are accessed in order to populate them. It is 
 
37
    constructed with the revision id and parent_ids list and a repository
 
38
    object to request the revision from when needed.
 
39
    """
 
40
 
 
41
    def __init__(self, revid, parent_ids, repository):
 
42
        self.revision_id = revid
 
43
        self.parent_ids = parent_ids
 
44
        self._repository = repository
 
45
        self._revision = None
 
46
 
 
47
    def _get_attribute_getter(attr):
 
48
        def get_attribute(self):
 
49
            if self._revision is None:
 
50
                self._load()
 
51
            return getattr(self._revision, attr)
 
52
        return get_attribute
 
53
    committer = property(_get_attribute_getter('committer'))
 
54
    message = property(_get_attribute_getter('message'))
 
55
    properties = property(_get_attribute_getter('properties'))
 
56
    timestamp = property(_get_attribute_getter('timestamp'))
 
57
    timezone = property(_get_attribute_getter('timezone'))
 
58
 
 
59
    def _load(self):
 
60
        """Load the revision object."""
 
61
        self._revision = self._repository.get_revision(self.revision_id)
 
62
 
 
63
 
 
64
class DistanceMethod(object):
 
65
 
 
66
    def __init__(self, branch, start):
 
67
        self.branch = branch
 
68
        self.start = start
 
69
        self.revisions = {}
 
70
        self.children = {}
 
71
        self.children_of_id = {start: set()}
 
72
        self.parent_ids_of = {}
 
73
        self.colours = { start: 0 }
 
74
        self.last_colour = 0
 
75
        self.direct_parent_of = {}
 
76
        self.graph = {}
 
77
 
 
78
    def fill_caches(self):
 
79
        graph = self.branch.repository.get_revision_graph_with_ghosts([self.start])
 
80
        for revid in graph.ghosts:
 
81
            self.cache_revision(DummyRevision(revid))
 
82
        for revid, parents in graph.get_ancestors().items():
 
83
            self.cache_revision(RevisionProxy(revid, parents, self.branch.repository))
 
84
 
 
85
    def cache_revision(self, revision):
 
86
        "Set the caches for a newly retrieved revision."""
 
87
        revid = revision.revision_id
 
88
        # Build a revision cache
 
89
        self.revisions[revid] = revision
 
90
        # Build a children dictionary
 
91
        for parent_id in revision.parent_ids:
 
92
            self.children_of_id.setdefault(parent_id, set()).add(revision)
 
93
        # Build a parents dictionnary, where redundant parents will be removed,
 
94
        # and that will be passed along tothe rest of program.
 
95
        if len(revision.parent_ids) != len(set(revision.parent_ids)):
 
96
            # fix the parent_ids list.
 
97
            parent_ids = []
 
98
            parent_ids_set = set()
 
99
            for parent_id in revision.parent_ids:
 
100
                if parent_id in parent_ids_set:
 
101
                    continue
 
102
                parent_ids.append(parent_id)
 
103
                parent_ids_set.add(parent_id)
 
104
            revision.parent_ids = parent_ids
 
105
        self.parent_ids_of[revision] = list(revision.parent_ids)
 
106
        self.graph[revid] = revision.parent_ids
 
107
 
 
108
    def make_children_map(self):
 
109
        revisions = self.revisions
 
110
        return dict((revisions[revid], c)
 
111
                    for (revid, c) in self.children_of_id.iteritems())
 
112
 
 
113
    def sort_revisions(self, sorted_revids, maxnum):
 
114
        revisions = self.revisions
 
115
        parent_ids_of = self.parent_ids_of
 
116
        children_of_id = self.children_of_id
 
117
        # Try to compact sequences of revisions on the same branch.
 
118
        distances = {}
 
119
        skipped_revids = []
 
120
        expected_id = sorted_revids[0]
 
121
        pending_ids = []
 
122
        while True:
 
123
            revid = sorted_revids.pop(0)
 
124
            if revid != expected_id:
 
125
                skipped_revids.append(revid)
 
126
                continue
 
127
            revision = revisions[revid]
 
128
            for child in children_of_id[revid]:
 
129
                # postpone if any child is missing
 
130
                if child.revision_id not in distances:
 
131
                    if expected_id not in pending_ids:
 
132
                        pending_ids.append(expected_id)
 
133
                    expected_id = pending_ids.pop(0)
 
134
                    skipped_revids.append(revid)
 
135
                    sorted_revids[:0] = skipped_revids
 
136
                    del skipped_revids[:]
 
137
                    break
 
138
            else:
 
139
                # all children are here, push!
 
140
                distances[revid] = len(distances)
 
141
                if maxnum is not None and len(distances) > maxnum:
 
142
                    # bail out early if a limit was specified
 
143
                    sorted_revids[:0] = skipped_revids
 
144
                    for revid in sorted_revids:
 
145
                        distances[revid] = len(distances)
 
146
                    break
 
147
                # all parents will need to be pushed as soon as possible
 
148
                for parent in parent_ids_of[revision]:
 
149
                    if parent not in pending_ids:
 
150
                        pending_ids.insert(0, parent)
 
151
                if not pending_ids:
 
152
                    break
 
153
                expected_id = pending_ids.pop(0)
 
154
                # if the next expected revid has already been skipped, requeue
 
155
                # the skipped ids, except those that would go right back to the
 
156
                # skipped list.
 
157
                if expected_id in skipped_revids:
 
158
                    pos = skipped_revids.index(expected_id)
 
159
                    sorted_revids[:0] = skipped_revids[pos:]
 
160
                    del skipped_revids[pos:]
 
161
        self.distances = distances
 
162
        return sorted(distances, key=distances.get)
 
163
 
 
164
    def choose_colour(self, revid):
 
165
        revision = self.revisions[revid]
 
166
        children_of_id = self.children_of_id
 
167
        parent_ids_of = self.parent_ids_of
 
168
        colours = self.colours
 
169
        # choose colour
 
170
        the_children = children_of_id[revid]
 
171
        if len(the_children) == 1:
 
172
            [child] = the_children
 
173
            if len(parent_ids_of[child]) == 1:
 
174
                # one-one relationship between parent and child, same
 
175
                # colour
 
176
                colours[revid] = colours[child.revision_id]
 
177
            else:
 
178
                self.choose_colour_one_child(revision, child)
 
179
        else:
 
180
            self.choose_colour_many_children(revision, the_children)
 
181
 
 
182
    def choose_colour_one_child(self, revision, child):
 
183
        revid = revision.revision_id
 
184
        direct_parent_of = self.direct_parent_of
 
185
        revisions = self.revisions
 
186
        # one child with multiple parents, the first parent with
 
187
        # the same committer gets the colour
 
188
        direct_parent = direct_parent_of.get(child)
 
189
        if direct_parent is None:
 
190
            # if it has not been found yet, find it now and remember
 
191
            for parent_id in self.parent_ids_of[child]:
 
192
                parent_revision = revisions[parent_id]
 
193
                if parent_revision.committer == child.committer:
 
194
                    # found the first parent with the same committer
 
195
                    direct_parent = parent_revision
 
196
                    direct_parent_of[child] = direct_parent
 
197
                    break
 
198
        if direct_parent == revision:
 
199
            self.colours[revid] = self.colours[child.revision_id]
 
200
        else:
 
201
            self.colours[revid] = self.last_colour = self.last_colour + 1
 
202
 
 
203
    def choose_colour_many_children(self, revision, the_children):
 
204
        """Colour revision revision."""
 
205
        revid = revision.revision_id
 
206
        direct_parent_of = self.direct_parent_of
 
207
        # multiple children, get the colour of the last displayed child
 
208
        # with the same committer which does not already have its colour
 
209
        # taken
 
210
        available = {}
 
211
        for child in the_children:
 
212
            if child.committer != revision.committer:
 
213
                continue
 
214
            direct_parent = direct_parent_of.get(child)
 
215
            if direct_parent == revision:
 
216
                self.colours[revid] = self.colours[child.revision_id]
 
217
                break
 
218
            # FIXME: Colouring based on whats been displayed MUST be done with 
 
219
            # knowledge of the revisions being output.
 
220
            # until the refactoring to fold graph() into this more compactly is
 
221
            # done, I've disabled this reuse. RBC 20060403
 
222
            # if direct_parent is None:
 
223
            #     available[child] = distances[child.revision_id] 
 
224
            #   .. it will be something like available[child] =  \
 
225
            #  revs[child.revision_id][0] - which is the sequence number
 
226
        else:
 
227
            if available:
 
228
                sorted_children = sorted(available, key=available.get)
 
229
                child = sorted_children[-1]
 
230
                direct_parent_of[child] = revision
 
231
                self.colours[revid] = self.colours[child.revision_id]
 
232
            else:
 
233
                # no candidate children is available, pick the next
 
234
                # colour
 
235
                self.colours[revid] = self.last_colour = self.last_colour + 1
 
236
 
 
237
 
33
238
def distances(branch, start):
34
239
    """Sort the revisions.
35
240
 
39
244
 
40
245
    Returns a tuple of (revids, revisions, colours, children)
41
246
    """
42
 
    revisions = { start: branch.get_revision(start) }
43
 
    children = { revisions[start]: set() }
44
 
    distances = { start: 0 }
45
 
    colours = { start: 0 }
46
 
    last_colour = 0
47
 
 
48
 
    # Sort the revisions; the fastest way to do this is to visit each node
49
 
    # as few times as possible (by keeping the todo list in a set) and record
50
 
    # the largest distance to it before queuing up the children if we
51
 
    # increased the distance.  This produces the sort order we desire
52
 
    todo = set([ start ])
53
 
    while todo:
54
 
        revid = todo.pop()
55
 
        revision = revisions[revid]
56
 
        distance = distances[revid] + 1
57
 
        colour = colours[revid]
58
 
 
59
 
        for parent_id in revision.parent_ids:
60
 
            # Check whether there's any point re-processing this
61
 
            if parent_id in distances and distances[parent_id] >= distance:
62
 
                continue
63
 
 
64
 
            # Get the parent from the cache, or put it in the cache
65
 
            try:
66
 
                parent = revisions[parent_id]
67
 
                children[parent].add(revision)
68
 
            except KeyError:
69
 
                try:
70
 
                    parent = revisions[parent_id] \
71
 
                             = branch.get_revision(parent_id)
72
 
                except NoSuchRevision:
73
 
                    parent = revisions[parent_id] = DummyRevision(parent_id)
74
 
 
75
 
                children[parent] = set([ revision ])
76
 
 
77
 
            # Penalise revisions a little at a fork if we think they're on
78
 
            # the same branch -- this makes the few few (at least) revisions
79
 
            # of a branch appear straight after the fork
80
 
            if same_branch(revision, parent):
81
 
                colours[parent_id] = colour
82
 
                if len(revision.parent_ids) > 1:
83
 
                    distances[parent_id] = distance + 10
84
 
                else:
85
 
                    distances[parent_id] = distance
86
 
            else:
87
 
                colours[parent_id] = last_colour = last_colour + 1
88
 
                distances[parent_id] = distance
89
 
 
90
 
            todo.add(parent_id)
91
 
 
92
 
    return ( sorted(distances, key=distances.get), revisions, colours,
93
 
             children )
94
 
 
95
 
def graph(revids, revisions, colours):
 
247
    distance = DistanceMethod(branch, start)
 
248
    distance.fill_caches()
 
249
    distance.merge_sorted = merge_sort(distance.graph, distance.start)
 
250
    children = distance.make_children_map()
 
251
    
 
252
    for seq, revid, merge_depth, end_of_merge in distance.merge_sorted:
 
253
        distance.choose_colour(revid)
 
254
 
 
255
    revisions = distance.revisions
 
256
    colours = distance.colours
 
257
    parent_ids_of = distance.parent_ids_of
 
258
    return (revisions, colours, children, parent_ids_of, distance.merge_sorted)
 
259
 
 
260
 
 
261
def graph(revisions, colours, merge_sorted):
96
262
    """Produce a directed graph of a bzr branch.
97
263
 
98
264
    For each revision it then yields a tuple of (revision, node, lines).
114
280
    It's up to you how to actually draw the nodes and lines (straight,
115
281
    curved, kinked, etc.) and to pick the actual colours for each index.
116
282
    """
117
 
    hanging = revids[:1]
118
 
    for revid in revids:
 
283
    if not len(merge_sorted):
 
284
        return
 
285
    # split merge_sorted into a map:
 
286
    revs = {}
 
287
    # FIXME: get a hint on this from the merge_sorted data rather than
 
288
    # calculating it ourselves
 
289
    # mapping from rev_id to the sequence number of the next lowest rev
 
290
    next_lower_rev = {}
 
291
    # mapping from rev_id to next-in-branch-revid - may be None for end
 
292
    # of branch
 
293
    next_branch_revid = {}
 
294
    # the stack we are in in the sorted data for determining which 
 
295
    # next_lower_rev to set. It is a stack which has one list at each
 
296
    # depth - the ids at that depth that need the same id allocated.
 
297
    current_stack = [[]]
 
298
    for seq, revid, indent, end_merge in merge_sorted:
 
299
        revs[revid] = (seq, indent, end_merge)
 
300
        if indent == len(current_stack):
 
301
            # new merge group starts
 
302
            current_stack.append([revid])
 
303
        elif indent == len(current_stack) - 1:
 
304
            # part of the current merge group
 
305
            current_stack[-1].append(revid)
 
306
        else:
 
307
            # end of a merge group
 
308
            while current_stack[-1]:
 
309
                stack_rev_id = current_stack[-1].pop()
 
310
                # record the next lower rev for this rev:
 
311
                next_lower_rev[stack_rev_id] = seq
 
312
                # if this followed a non-end-merge rev in this group note that
 
313
                if len(current_stack[-1]):
 
314
                    if not revs[current_stack[-1][-1]][2]:
 
315
                        next_branch_revid[current_stack[-1][-1]] = stack_rev_id
 
316
            current_stack.pop()
 
317
            # append to the now-current merge group
 
318
            current_stack[-1].append(revid)
 
319
    # assign a value to all the depth 0 revisions
 
320
    while current_stack[-1]:
 
321
        stack_rev_id = current_stack[-1].pop()
 
322
        # record the next lower rev for this rev:
 
323
        next_lower_rev[stack_rev_id] = len(merge_sorted)
 
324
        # if this followed a non-end-merge rev in this group note that
 
325
        if len(current_stack[-1]):
 
326
            if not revs[current_stack[-1][-1]][2]:
 
327
                next_branch_revid[current_stack[-1][-1]] = stack_rev_id
 
328
 
 
329
    # a list of the current revisions we are drawing lines TO indicating
 
330
    # the sequence of their lines on the screen.
 
331
    # i.e. [A, B, C] means that the line to A, to B, and to C are in
 
332
    # (respectively), 0, 1, 2 on the screen.
 
333
    hanging = [merge_sorted[0][1]]
 
334
    for seq, revid, indent, end_merge in merge_sorted:
 
335
        # a list of the lines to draw: their position in the
 
336
        # previous row, their position in this row, and the colour
 
337
        # (which is the colour they are routing to).
119
338
        lines = []
120
 
        node = None
121
339
 
122
340
        new_hanging = []
 
341
 
123
342
        for h_idx, hang in enumerate(hanging):
 
343
            # one of these will be the current lines node:
 
344
            # we are drawing a line. h_idx 
124
345
            if hang == revid:
125
 
                # We've matched a hanging revision, so need to output a node
126
 
                # at this point
 
346
                # we have found the current lines node
127
347
                node = (h_idx, colours[revid])
128
348
 
 
349
                # note that we might have done the main parent
 
350
                drawn_parents = set()
 
351
 
 
352
                def draw_line(from_idx, to_idx, revision_id):
 
353
                    try:
 
354
                        n_idx = new_hanging.index(revision_id)
 
355
                    except ValueError:
 
356
                        # force this to be vertical at the place this rev was
 
357
                        # drawn.
 
358
                        new_hanging.insert(to_idx, revision_id)
 
359
                        n_idx = to_idx
 
360
                    lines.append((from_idx, n_idx, colours[revision_id]))
 
361
 
 
362
                
 
363
                # we want to draw a line to the next commit on 'this' branch
 
364
                if not end_merge:
 
365
                    # drop this line first.
 
366
                    parent_id = next_branch_revid[revid]
 
367
                    draw_line(h_idx, h_idx, parent_id)
 
368
                    # we have drawn this parent
 
369
                    drawn_parents.add(parent_id)
 
370
                else:
 
371
                    # this is the last revision in a 'merge', show where it came from
 
372
                    if len(revisions[revid].parent_ids) > 1:
 
373
                        # having > 1
 
374
                        # parents means this commit was a merge, and being
 
375
                        # the end point of a merge group means that all
 
376
                        # the parent revisions were merged into branches
 
377
                        # to the left of this before this was committed
 
378
                        # - so we want to show this as a new branch from
 
379
                        # those revisions.
 
380
                        # to do this, we show the parent with the lowest
 
381
                        # sequence number, which is the one that this
 
382
                        # branch 'spawned from', and no others.
 
383
                        # If this sounds like a problem, remember that:
 
384
                        # if the parent was not already in our mainline
 
385
                        # it would show up as a merge into this making
 
386
                        # this not the end of a merge-line.
 
387
                        lowest = len(merge_sorted)
 
388
                        for parent_id in revisions[revid].parent_ids:
 
389
                            if revs[parent_id][0] < lowest:
 
390
                                lowest = revs[parent_id][0]
 
391
                        assert lowest != len(merge_sorted)
 
392
                        draw_line(h_idx, len(new_hanging), merge_sorted[lowest][1])
 
393
                        drawn_parents.add(merge_sorted[lowest][1])
 
394
                    elif len(revisions[revid].parent_ids) == 1:
 
395
                        # only one parent, must show this link to be useful.
 
396
                        parent_id = revisions[revid].parent_ids[0]
 
397
                        draw_line(h_idx, len(new_hanging), parent_id)
 
398
                        drawn_parents.add(parent_id)
 
399
                
 
400
                # what do we want to draw lines to from here:
 
401
                # each parent IF its relevant.
 
402
                #
129
403
                # Now we need to hang its parents, we put them at the point
130
404
                # the old column was so anything to the right of this has
131
405
                # to move outwards to make room.  We also try and collapse
132
406
                # hangs to keep the graph small.
 
407
                # RBC: we do not draw lines to parents that were already merged
 
408
                # unless its the last revision in a merge group.
133
409
                for parent_id in revisions[revid].parent_ids:
134
 
                    try:
135
 
                        n_idx = new_hanging.index(parent_id)
136
 
                    except ValueError:
137
 
                        n_idx = len(new_hanging)
138
 
                        new_hanging.append(parent_id)
139
 
                    lines.append((h_idx, n_idx, colours[parent_id]))
 
410
                    if parent_id in drawn_parents:
 
411
                        continue
 
412
                    parent_seq = revs[parent_id][0]
 
413
                    parent_depth = revs[parent_id][1]
 
414
                    if parent_depth == indent + 1:
 
415
                        # The parent was a merge into this branch determine if
 
416
                        # it was already merged into the mainline via a
 
417
                        # different merge: if all revisions between us and
 
418
                        # parent_seq have a indent greater than there are no
 
419
                        # revisions with a lower indent than us.
 
420
                        # We do not use 'parent_depth < indent' because that
 
421
                        # would allow un-uniqueified merges to show up, and
 
422
                        # merge_sorted should take care of that for us (but
 
423
                        # does not trim the values)
 
424
                        if parent_seq < next_lower_rev[revid]:
 
425
                            draw_line(h_idx, len(new_hanging), parent_id)
 
426
                    elif parent_depth == indent and parent_seq == seq + 1:
 
427
                        # part of this branch
 
428
                        draw_line(h_idx, len(new_hanging), parent_id)
140
429
            else:
141
 
                # Revision keeps on hanging, adjust for any change in the
142
 
                # graph shape and try to collapse hangs to keep the graph
143
 
                # small.
144
 
                try:
145
 
                    n_idx = new_hanging.index(hang)
146
 
                except ValueError:
147
 
                    n_idx = len(new_hanging)
148
 
                    new_hanging.append(hang)
149
 
                lines.append((h_idx, n_idx, colours[hang]))
 
430
                # draw a line from the previous position of this line to the 
 
431
                # new position.
 
432
                # h_idx is the old position.
 
433
                # new_indent is the new position. 
 
434
                draw_line(h_idx, len(new_hanging), hang)
 
435
        # we've calculated the row, assign new_hanging to hanging to setup for
 
436
        # the next row
150
437
        hanging = new_hanging
151
438
 
152
439
        yield (revisions[revid], node, lines)
153
440
 
 
441
 
154
442
def same_branch(a, b):
155
443
    """Return whether we think revisions a and b are on the same branch."""
156
444
    if len(a.parent_ids) == 1: