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