2
# -*- coding: UTF-8 -*-
3
"""Directed graph production.
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
10
__copyright__ = "Copyright © 2005 Canonical Ltd."
11
__author__ = "Scott James Remnant <scott@ubuntu.com>"
14
from bzrlib.tsort import merge_sort
17
class DummyRevision(object):
18
"""Dummy bzr revision.
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).
26
def __init__(self, revid):
27
self.revision_id = revid
30
self.message = self.revision_id
33
class RevisionProxy(object):
34
"""A revision proxy object.
36
This will demand load the revision it represents when the committer or
37
message attributes are accessed in order to populate them. It is
38
constructed with the revision id and parent_ids list and a repository
39
object to request the revision from when needed.
42
def __init__(self, revid, parent_ids, repository):
43
self.revision_id = revid
44
self.parent_ids = parent_ids
45
self._repository = repository
48
def _get_attribute_getter(attr):
49
def get_attribute(self):
50
if self._revision is None:
52
return getattr(self._revision, attr)
54
committer = property(_get_attribute_getter('committer'))
55
message = property(_get_attribute_getter('message'))
56
properties = property(_get_attribute_getter('properties'))
57
timestamp = property(_get_attribute_getter('timestamp'))
58
timezone = property(_get_attribute_getter('timezone'))
61
"""Load the revision object."""
62
self._revision = self._repository.get_revision(self.revision_id)
65
class DistanceMethod(object):
67
def __init__(self, branch, start):
72
self.children_of_id = {start: set()}
73
self.parent_ids_of = {}
74
self.colours = { start: 0 }
76
self.direct_parent_of = {}
79
def fill_caches(self):
80
# FIXME: look at using repository.get_revision_graph_with_ghosts - RBC.
81
graph = self.branch.repository.get_revision_graph_with_ghosts([self.start])
82
for revid in graph.ghosts:
83
self.cache_revision(DummyRevision(revid))
84
for revid, parents in graph.get_ancestors().items():
85
self.cache_revision(RevisionProxy(revid, parents, self.branch.repository))
87
def cache_revision(self, revision):
88
"Set the caches for a newly retrieved revision."""
89
revid = revision.revision_id
90
# Build a revision cache
91
self.revisions[revid] = revision
92
# Build a children dictionary
93
for parent_id in revision.parent_ids:
94
self.children_of_id.setdefault(parent_id, set()).add(revision)
95
# Build a parents dictionnary, where redundant parents will be removed,
96
# and that will be passed along tothe rest of program.
97
if len(revision.parent_ids) != len(set(revision.parent_ids)):
98
# fix the parent_ids list.
100
parent_ids_set = set()
101
for parent_id in revision.parent_ids:
102
if parent_id in parent_ids_set:
104
parent_ids.append(parent_id)
105
parent_ids_set.add(parent_id)
106
revision.parent_ids = parent_ids
107
self.parent_ids_of[revision] = list(revision.parent_ids)
108
self.graph[revid] = revision.parent_ids
110
def make_children_map(self):
111
revisions = self.revisions
112
return dict((revisions[revid], c)
113
for (revid, c) in self.children_of_id.iteritems())
115
def sort_revisions(self, sorted_revids, maxnum):
116
revisions = self.revisions
117
parent_ids_of = self.parent_ids_of
118
children_of_id = self.children_of_id
119
# Try to compact sequences of revisions on the same branch.
122
expected_id = sorted_revids[0]
125
revid = sorted_revids.pop(0)
126
if revid != expected_id:
127
skipped_revids.append(revid)
129
revision = revisions[revid]
130
for child in children_of_id[revid]:
131
# postpone if any child is missing
132
if child.revision_id not in distances:
133
if expected_id not in pending_ids:
134
pending_ids.append(expected_id)
135
expected_id = pending_ids.pop(0)
136
skipped_revids.append(revid)
137
sorted_revids[:0] = skipped_revids
138
del skipped_revids[:]
141
# all children are here, push!
142
distances[revid] = len(distances)
143
if maxnum is not None and len(distances) > maxnum:
144
# bail out early if a limit was specified
145
sorted_revids[:0] = skipped_revids
146
for revid in sorted_revids:
147
distances[revid] = len(distances)
149
# all parents will need to be pushed as soon as possible
150
for parent in parent_ids_of[revision]:
151
if parent not in pending_ids:
152
pending_ids.insert(0, parent)
155
expected_id = pending_ids.pop(0)
156
# if the next expected revid has already been skipped, requeue
157
# the skipped ids, except those that would go right back to the
159
if expected_id in skipped_revids:
160
pos = skipped_revids.index(expected_id)
161
sorted_revids[:0] = skipped_revids[pos:]
162
del skipped_revids[pos:]
163
self.distances = distances
164
return sorted(distances, key=distances.get)
166
def choose_colour(self, revid):
167
revision = self.revisions[revid]
168
children_of_id = self.children_of_id
169
parent_ids_of = self.parent_ids_of
170
colours = self.colours
172
the_children = children_of_id[revid]
173
if len(the_children) == 1:
174
[child] = the_children
175
if len(parent_ids_of[child]) == 1:
176
# one-one relationship between parent and child, same
178
colours[revid] = colours[child.revision_id]
180
self.choose_colour_one_child(revision, child)
182
self.choose_colour_many_children(revision, the_children)
184
def choose_colour_one_child(self, revision, child):
185
revid = revision.revision_id
186
direct_parent_of = self.direct_parent_of
187
revisions = self.revisions
188
# one child with multiple parents, the first parent with
189
# the same committer gets the colour
190
direct_parent = direct_parent_of.get(child)
191
if direct_parent is None:
192
# if it has not been found yet, find it now and remember
193
for parent_id in self.parent_ids_of[child]:
194
parent_revision = revisions[parent_id]
195
if parent_revision.committer == child.committer:
196
# found the first parent with the same committer
197
direct_parent = parent_revision
198
direct_parent_of[child] = direct_parent
200
if direct_parent == revision:
201
self.colours[revid] = self.colours[child.revision_id]
203
self.colours[revid] = self.last_colour = self.last_colour + 1
205
def choose_colour_many_children(self, revision, the_children):
206
"""Colour revision revision."""
207
revid = revision.revision_id
208
direct_parent_of = self.direct_parent_of
209
# multiple children, get the colour of the last displayed child
210
# with the same committer which does not already have its colour
213
for child in the_children:
214
if child.committer != revision.committer:
216
direct_parent = direct_parent_of.get(child)
217
if direct_parent == revision:
218
self.colours[revid] = self.colours[child.revision_id]
220
# FIXME: Colouring based on whats been displayed MUST be done with
221
# knowledge of the revisions being output.
222
# until the refactoring to fold graph() into this more compactly is
223
# done, I've disabled this reuse. RBC 20060403
224
# if direct_parent is None:
225
# available[child] = distances[child.revision_id]
226
# .. it will be something like available[child] = \
227
# revs[child.revision_id][0] - which is the sequence number
230
sorted_children = sorted(available, key=available.get)
231
child = sorted_children[-1]
232
direct_parent_of[child] = revision
233
self.colours[revid] = self.colours[child.revision_id]
235
# no candidate children is available, pick the next
237
self.colours[revid] = self.last_colour = self.last_colour + 1
240
def distances(branch, start):
241
"""Sort the revisions.
243
Traverses the branch revision tree starting at start and produces an
244
ordered list of revisions such that a revision always comes after
245
any revision it is the parent of.
247
Returns a tuple of (revids, revisions, colours, children)
249
distance = DistanceMethod(branch, start)
250
distance.fill_caches()
251
distance.merge_sorted = merge_sort(distance.graph, distance.start)
252
children = distance.make_children_map()
254
for seq, revid, merge_depth, end_of_merge in distance.merge_sorted:
255
distance.choose_colour(revid)
257
revisions = distance.revisions
258
colours = distance.colours
259
parent_ids_of = distance.parent_ids_of
260
return (revisions, colours, children, parent_ids_of, distance.merge_sorted)
263
def graph(revisions, colours, merge_sorted):
264
"""Produce a directed graph of a bzr branch.
266
For each revision it then yields a tuple of (revision, node, lines).
267
If the revision is only referenced in the branch and not present in the
268
store, revision will be a DummyRevision object, otherwise it is the bzr
269
Revision object with the meta-data for the revision.
271
Node is a tuple of (column, colour) with column being a zero-indexed
272
column number of the graph that this revision represents and colour
273
being a zero-indexed colour (which doesn't specify any actual colour
274
in particular) to draw the node in.
276
Lines is a list of tuples which represent lines you should draw away
277
from the revision, if you also need to draw lines into the revision
278
you should use the lines list from the previous iteration. Each
279
typle in the list is in the form (start, end, colour) with start and
280
end being zero-indexed column numbers and colour as in node.
282
It's up to you how to actually draw the nodes and lines (straight,
283
curved, kinked, etc.) and to pick the actual colours for each index.
285
if not len(merge_sorted):
287
# split merge_sorted into a map:
289
# FIXME: get a hint on this from the merge_sorted data rather than
290
# calculating it ourselves
291
# mapping from rev_id to the sequence number of the next lowest rev
293
# mapping from rev_id to next-in-branch-revid - may be None for end
295
next_branch_revid = {}
296
# the stack we are in in the sorted data for determining which
297
# next_lower_rev to set. It is a stack which has one list at each
298
# depth - the ids at that depth that need the same id allocated.
300
for seq, revid, indent, end_merge in merge_sorted:
301
revs[revid] = (seq, indent, end_merge)
302
if indent == len(current_stack):
303
# new merge group starts
304
current_stack.append([revid])
305
elif indent == len(current_stack) - 1:
306
# part of the current merge group
307
current_stack[-1].append(revid)
309
# end of a merge group
310
while current_stack[-1]:
311
stack_rev_id = current_stack[-1].pop()
312
# record the next lower rev for this rev:
313
next_lower_rev[stack_rev_id] = seq
314
# if this followed a non-end-merge rev in this group note that
315
if len(current_stack[-1]):
316
if not revs[current_stack[-1][-1]][2]:
317
next_branch_revid[current_stack[-1][-1]] = stack_rev_id
319
# append to the now-current merge group
320
current_stack[-1].append(revid)
321
# assign a value to all the depth 0 revisions
322
while current_stack[-1]:
323
stack_rev_id = current_stack[-1].pop()
324
# record the next lower rev for this rev:
325
next_lower_rev[stack_rev_id] = len(merge_sorted)
326
# if this followed a non-end-merge rev in this group note that
327
if len(current_stack[-1]):
328
if not revs[current_stack[-1][-1]][2]:
329
next_branch_revid[current_stack[-1][-1]] = stack_rev_id
331
# a list of the current revisions we are drawing lines TO indicating
332
# the sequence of their lines on the screen.
333
# i.e. [A, B, C] means that the line to A, to B, and to C are in
334
# (respectively), 0, 1, 2 on the screen.
335
hanging = [merge_sorted[0][1]]
336
for seq, revid, indent, end_merge in merge_sorted:
337
# a list of the lines to draw: their position in the
338
# previous row, their position in this row, and the colour
339
# (which is the colour they are routing to).
344
for h_idx, hang in enumerate(hanging):
345
# one of these will be the current lines node:
346
# we are drawing a line. h_idx
348
# we have found the current lines node
349
node = (h_idx, colours[revid])
351
# note that we might have done the main parent
352
drawn_parents = set()
354
def draw_line(from_idx, to_idx, revision_id):
356
n_idx = new_hanging.index(revision_id)
358
# force this to be vertical at the place this rev was
360
new_hanging.insert(to_idx, revision_id)
362
lines.append((from_idx, n_idx, colours[revision_id]))
365
# we want to draw a line to the next commit on 'this' branch
367
# drop this line first.
368
parent_id = next_branch_revid[revid]
369
draw_line(h_idx, h_idx, parent_id)
370
# we have drawn this parent
371
drawn_parents.add(parent_id)
373
# this is the last revision in a 'merge', show where it came from
374
if len(revisions[revid].parent_ids) > 1:
376
# parents means this commit was a merge, and being
377
# the end point of a merge group means that all
378
# the parent revisions were merged into branches
379
# to the left of this before this was committed
380
# - so we want to show this as a new branch from
382
# to do this, we show the parent with the lowest
383
# sequence number, which is the one that this
384
# branch 'spawned from', and no others.
385
# If this sounds like a problem, remember that:
386
# if the parent was not already in our mainline
387
# it would show up as a merge into this making
388
# this not the end of a merge-line.
389
lowest = len(merge_sorted)
390
for parent_id in revisions[revid].parent_ids:
391
if revs[parent_id][0] < lowest:
392
lowest = revs[parent_id][0]
393
assert lowest != len(merge_sorted)
394
draw_line(h_idx, len(new_hanging), merge_sorted[lowest][1])
395
drawn_parents.add(merge_sorted[lowest][1])
396
elif len(revisions[revid].parent_ids) == 1:
397
# only one parent, must show this link to be useful.
398
parent_id = revisions[revid].parent_ids[0]
399
draw_line(h_idx, len(new_hanging), parent_id)
400
drawn_parents.add(parent_id)
402
# what do we want to draw lines to from here:
403
# each parent IF its relevant.
405
# Now we need to hang its parents, we put them at the point
406
# the old column was so anything to the right of this has
407
# to move outwards to make room. We also try and collapse
408
# hangs to keep the graph small.
409
# RBC: we do not draw lines to parents that were already merged
410
# unless its the last revision in a merge group.
411
for parent_id in revisions[revid].parent_ids:
412
if parent_id in drawn_parents:
414
parent_seq = revs[parent_id][0]
415
parent_depth = revs[parent_id][1]
416
if parent_depth == indent + 1:
417
# The parent was a merge into this branch determine if
418
# it was already merged into the mainline via a
419
# different merge: if all revisions between us and
420
# parent_seq have a indent greater than there are no
421
# revisions with a lower indent than us.
422
# We do not use 'parent_depth < indent' because that
423
# would allow un-uniqueified merges to show up, and
424
# merge_sorted should take care of that for us (but
425
# does not trim the values)
426
if parent_seq < next_lower_rev[revid]:
427
draw_line(h_idx, len(new_hanging), parent_id)
428
elif parent_depth == indent and parent_seq == seq + 1:
429
# part of this branch
430
draw_line(h_idx, len(new_hanging), parent_id)
432
# draw a line from the previous position of this line to the
434
# h_idx is the old position.
435
# new_indent is the new position.
436
draw_line(h_idx, len(new_hanging), hang)
437
# we've calculated the row, assign new_hanging to hanging to setup for
439
hanging = new_hanging
441
yield (revisions[revid], node, lines)
444
def same_branch(a, b):
445
"""Return whether we think revisions a and b are on the same branch."""
446
if len(a.parent_ids) == 1:
447
# Defacto same branch if only parent
449
elif a.committer == b.committer:
450
# Same committer so may as well be
1
# -*- coding: UTF-8 -*-
2
"""Directed graph production.
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
9
__copyright__ = "Copyright © 2005 Canonical Ltd."
10
__author__ = "Scott James Remnant <scott@ubuntu.com>"
12
from bzrlib.tsort import merge_sort
14
def linegraph(branch, start, maxnum):
15
"""Produce a directed graph of a bzr branch.
17
Returns a tuple of (line_graph, revid_index, columns_len) where
18
* line_graph is a list of tuples of (revid,
24
* revid_index is a dict of each revision with the key being the revid, and
25
the value the row index, and
26
* columns_len is the number of columns need to draw the line graph.
29
Node is a tuple of (column, colour) with column being a zero-indexed
30
column number of the graph that this revision represents and colour
31
being a zero-indexed colour (which doesn't specify any actual colour
32
in particular) to draw the node in.
34
Lines is a list of tuples which represent lines you should draw away
35
from the revision, if you also need to draw lines into the revision
36
you should use the lines list from the previous iteration. Each
37
typle in the list is in the form (start, end, colour) with start and
38
end being zero-indexed column numbers and colour as in node.
40
It's up to you how to actually draw the nodes and lines (straight,
41
curved, kinked, etc.) and to pick the actual colours for each index.
44
# FIXME: This should be configurable
45
BROKEN_LINE_LENGTH = 32
47
# We get the mainline so we can pass it to merge_sort to make merge_sort
50
mainline.extend(branch.revision_history())
51
graph_parents = branch.repository.get_revision_graph(start)
53
for revid in graph_parents.iterkeys():
54
graph_children[revid] = []
56
merge_sorted_revisions = merge_sort(
65
# This will hold an item for each "branch". For a revisions, the revsion
66
# number less the least significant digit is the branch_id, and used as the
67
# key for the dict. Hence revision with the same revsion number less the
68
# least significant digit are considered to be in the same branch line.
69
# e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
70
# and these two revisions will be in the same branch line. Each value is
71
# a list of rev_indexes in the branch.
76
for (rev_index, (sequence_number,
80
end_of_merge)) in enumerate(merge_sorted_revisions):
81
if maxnum and rev_index >= maxnum:
83
revid_index[revid] = rev_index
84
revno_index[revno_sequence] = rev_index
86
branch_id = revno_sequence[0:-1]
89
if branch_id not in branch_lines:
91
branch_lines[branch_id] = branch_line
93
branch_line = branch_lines[branch_id]
95
branch_line.append(rev_index)
97
parents = graph_parents[revid]
98
for parent_revid in parents:
99
graph_children[parent_revid].append(revid)
101
linegraph.append([revid,
108
branch_ids = branch_lines.keys()
110
def branch_id_cmp(x, y):
111
"""Compaire branch_id's first by the number of digits, then reversed
117
return cmp(len_x, len_y)
119
branch_ids.sort(branch_id_cmp)
120
# This will hold a tuple of (child_index, parent_index, col_index) for each
121
# line that needs to be drawn. If col_index is not none, then the line is
122
# drawn along that column, else the the line can be drawn directly between
123
# the child and parent because either the child and parent are in the same
124
# branch line, or the child and parent are 1 row apart.
126
empty_column = [False for i in range(len(graph_parents))]
127
# This will hold a bit map for each cell. If the cell is true, then the
128
# cell allready contains a node or line. This use when deciding what column
129
# to place a branch line or line in, without it overlaping something else.
130
columns = [list(empty_column)]
133
for branch_id in branch_ids:
134
branch_line = branch_lines[branch_id]
136
# Find the col_index for the direct parent branch. This will be the
137
# starting point when looking for a free column.
140
if len(branch_id) > 1:
141
parent_revno = branch_id[0:-1]
142
if parent_revno in revno_index:
143
parent_index = revno_index[parent_revno]
144
parent_node = linegraph[parent_index][1]
146
parent_col_index = parent_node[0]
149
col_search_order = _branch_line_col_search_order(columns,
151
color = reduce(lambda x, y: x+y, branch_id, 0)
155
last_rev_index = None
156
for rev_index in branch_line:
158
if BROKEN_LINE_LENGTH and \
159
rev_index - last_rev_index > BROKEN_LINE_LENGTH:
160
line_range.append(last_rev_index+1)
161
line_range.append(rev_index-1)
163
line_range.extend(range(last_rev_index+1, rev_index))
165
line_range.append(rev_index)
166
last_rev_index = rev_index
169
if BROKEN_LINE_LENGTH and \
170
parent_index - last_rev_index > BROKEN_LINE_LENGTH:
171
line_range.append(last_rev_index+1)
173
line_range.extend(range(last_rev_index+1, parent_index))
175
col_index = _find_free_column(columns,
179
node = (col_index, color)
180
for rev_index in branch_line:
181
linegraph[rev_index][1] = node
182
columns[col_index][rev_index] = True
184
for rev_index in branch_line:
189
end_of_merge) = merge_sorted_revisions[rev_index]
191
linegraph[rev_index][4] = graph_children[revid]
192
col_index = linegraph[rev_index][1][0]
194
for parent_revid in graph_parents[revid]:
195
if parent_revid in revid_index:
197
parent_index = revid_index[parent_revid]
198
parent_node = linegraph[parent_index][1]
200
parent_col_index = parent_node[0]
202
parent_col_index = None
204
_line_col_search_order(columns,
208
# If this line is really long, break it.
209
if len(branch_id) > 0 and \
210
BROKEN_LINE_LENGTH and \
211
parent_index - rev_index > BROKEN_LINE_LENGTH:
212
child_line_col_index = \
213
_find_free_column(columns,
217
_mark_column_as_used(columns,
218
child_line_col_index,
221
# Recall _line_col_search_order to reset it back to
224
_line_col_search_order(columns,
227
parent_col_line_index = \
228
_find_free_column(columns,
232
_mark_column_as_used(columns,
233
parent_col_line_index,
235
lines.append((rev_index,
237
(child_line_col_index,
238
parent_col_line_index)))
240
line_col_index = col_index
241
if parent_index - rev_index >1:
242
line_range = range(rev_index + 1, parent_index)
244
_find_free_column(columns,
248
_mark_column_as_used(columns,
251
lines.append((rev_index,
255
for (child_index, parent_index, line_col_indexes) in lines:
256
(child_col_index, child_color) = linegraph[child_index][1]
257
(parent_col_index, parent_color) = linegraph[parent_index][1]
259
if len(line_col_indexes) == 1:
260
if parent_index - child_index == 1:
261
linegraph[child_index][2].append(
266
# line from the child's column to the lines column
267
linegraph[child_index][2].append(
271
# lines down the line's column
272
for line_part_index in range(child_index+1, parent_index-1):
273
linegraph[line_part_index][2].append(
274
(line_col_indexes[0],
277
# line from the line's column to the parent's column
278
linegraph[parent_index-1][2].append(
279
(line_col_indexes[0],
284
# line from the child's column to the lines column
285
linegraph[child_index][2].append(
290
linegraph[child_index+1][2].append(
291
(line_col_indexes[0],
296
linegraph[parent_index-2][2].append(
300
# line from the line's column to the parent's column
301
linegraph[parent_index-1][2].append(
302
(line_col_indexes[1],
307
return (linegraph, revid_index, len(columns))
309
def _branch_line_col_search_order(columns, parent_col_index):
310
for col_index in range(parent_col_index, len(columns)):
312
for col_index in range(parent_col_index-1, -1, -1):
315
def _line_col_search_order(columns, parent_col_index, child_col_index):
316
if parent_col_index is not None:
317
max_index = max(parent_col_index, child_col_index)
318
min_index = min(parent_col_index, child_col_index)
319
for col_index in range(max_index, min_index -1, -1):
322
max_index = child_col_index
323
min_index = child_col_index
324
yield child_col_index
326
while max_index + i < len(columns) or \
328
if max_index + i < len(columns):
330
if min_index - i > -1:
334
def _find_free_column(columns, empty_column, col_search_order, line_range):
335
for col_index in col_search_order:
336
column = columns[col_index]
337
has_overlaping_line = False
338
for row_index in line_range:
339
if column[row_index]:
340
has_overlaping_line = True
342
if not has_overlaping_line:
345
col_index = len(columns)
346
column = list(empty_column)
347
columns.append(column)
350
def _mark_column_as_used(columns, col_index, line_range):
351
column = columns[col_index]
352
for row_index in line_range:
353
column[row_index] = True
355
def same_branch(a, b):
356
"""Return whether we think revisions a and b are on the same branch."""
357
if len(a.parent_ids) == 1:
358
# Defacto same branch if only parent
360
elif a.committer == b.committer:
361
# Same committer so may as well be