/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: Szilveszter Farkas (Phanatic)
  • Date: 2007-06-10 15:50:23 UTC
  • mfrom: (195.1.26 browse-remote-branches)
  • Revision ID: szilveszter.farkas@gmail.com-20070610155023-o3moy5a3wrp9o412
Merge browse-remote-branches branch (experimental).

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