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.errors import NoSuchRevision
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
def distances(branch, start):
34
"""Sort the revisions.
36
Traverses the branch revision tree starting at start and produces an
37
ordered list of revisions such that a revision always comes after
38
any revision it is the parent of.
40
Returns a tuple of (revids, revisions, colours, children)
42
revisions = { start: branch.get_revision(start) }
43
children = { revisions[start]: set() }
44
distances = { start: 0 }
45
colours = { start: 0 }
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
55
revision = revisions[revid]
56
distance = distances[revid] + 1
57
colour = colours[revid]
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:
64
# Get the parent from the cache, or put it in the cache
66
parent = revisions[parent_id]
67
children[parent].add(revision)
70
parent = revisions[parent_id] \
71
= branch.get_revision(parent_id)
72
except NoSuchRevision:
73
parent = revisions[parent_id] = DummyRevision(parent_id)
75
children[parent] = set([ revision ])
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
85
distances[parent_id] = distance
87
colours[parent_id] = last_colour = last_colour + 1
88
distances[parent_id] = distance
92
return ( sorted(distances, key=distances.get), revisions, colours,
95
def graph(revids, revisions, colours):
96
"""Produce a directed graph of a bzr branch.
98
For each revision it then yields a tuple of (revision, node, lines).
99
If the revision is only referenced in the branch and not present in the
100
store, revision will be a DummyRevision object, otherwise it is the bzr
101
Revision object with the meta-data for the revision.
103
Node is a tuple of (column, colour) with column being a zero-indexed
104
column number of the graph that this revision represents and colour
105
being a zero-indexed colour (which doesn't specify any actual colour
106
in particular) to draw the node in.
108
Lines is a list of tuples which represent lines you should draw away
109
from the revision, if you also need to draw lines into the revision
110
you should use the lines list from the previous iteration. Each
111
typle in the list is in the form (start, end, colour) with start and
112
end being zero-indexed column numbers and colour as in node.
114
It's up to you how to actually draw the nodes and lines (straight,
115
curved, kinked, etc.) and to pick the actual colours for each index.
123
for h_idx, hang in enumerate(hanging):
125
# We've matched a hanging revision, so need to output a node
127
node = (h_idx, colours[revid])
129
# Now we need to hang its parents, we put them at the point
130
# the old column was so anything to the right of this has
131
# to move outwards to make room. We also try and collapse
132
# hangs to keep the graph small.
133
for parent_id in revisions[revid].parent_ids:
135
n_idx = new_hanging.index(parent_id)
137
n_idx = len(new_hanging)
138
new_hanging.append(parent_id)
139
lines.append((h_idx, n_idx, colours[parent_id]))
141
# Revision keeps on hanging, adjust for any change in the
142
# graph shape and try to collapse hangs to keep the graph
145
n_idx = new_hanging.index(hang)
147
n_idx = len(new_hanging)
148
new_hanging.append(hang)
149
lines.append((h_idx, n_idx, colours[hang]))
150
hanging = new_hanging
152
yield (revisions[revid], node, lines)
154
def same_branch(a, b):
155
"""Return whether we think revisions a and b are on the same branch."""
156
if len(a.parent_ids) == 1:
157
# Defacto same branch if only parent
159
elif a.committer == b.committer:
160
# 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(repository, start, maxnum, broken_line_length=None):
15
"""Produce a directed graph of a bzr repository.
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
graph_parents = repository.get_revision_graph(start)
46
for revid in graph_parents.iterkeys():
47
graph_children[revid] = []
49
if len(graph_parents)>0:
50
merge_sorted_revisions = merge_sort(
55
merge_sorted_revisions = ()
60
# This will hold an item for each "branch". For a revisions, the revsion
61
# number less the least significant digit is the branch_id, and used as the
62
# key for the dict. Hence revision with the same revsion number less the
63
# least significant digit are considered to be in the same branch line.
64
# e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
65
# and these two revisions will be in the same branch line. Each value is
66
# a list of rev_indexes in the branch.
71
for (rev_index, (sequence_number,
75
end_of_merge)) in enumerate(merge_sorted_revisions):
76
if maxnum and rev_index >= maxnum:
78
revid_index[revid] = rev_index
79
revno_index[revno_sequence] = rev_index
81
branch_id = revno_sequence[0:-1]
84
if branch_id not in branch_lines:
86
branch_lines[branch_id] = branch_line
88
branch_line = branch_lines[branch_id]
90
branch_line.append(rev_index)
92
parents = graph_parents[revid]
93
for parent_revid in parents:
94
graph_children[parent_revid].append(revid)
96
linegraph.append([revid,
103
branch_ids = branch_lines.keys()
105
def branch_id_cmp(x, y):
106
"""Compaire branch_id's first by the number of digits, then reversed
112
return cmp(len_x, len_y)
114
branch_ids.sort(branch_id_cmp)
115
# This will hold a tuple of (child_index, parent_index, col_index) for each
116
# line that needs to be drawn. If col_index is not none, then the line is
117
# drawn along that column, else the the line can be drawn directly between
118
# the child and parent because either the child and parent are in the same
119
# branch line, or the child and parent are 1 row apart.
121
empty_column = [False for i in range(len(graph_parents))]
122
# This will hold a bit map for each cell. If the cell is true, then the
123
# cell allready contains a node or line. This use when deciding what column
124
# to place a branch line or line in, without it overlaping something else.
125
columns = [list(empty_column)]
128
for branch_id in branch_ids:
129
branch_line = branch_lines[branch_id]
131
# Find the col_index for the direct parent branch. This will be the
132
# starting point when looking for a free column.
135
if len(branch_id) > 1:
136
parent_revno = branch_id[0:-1]
137
if parent_revno in revno_index:
138
parent_index = revno_index[parent_revno]
139
parent_node = linegraph[parent_index][1]
141
parent_col_index = parent_node[0]
144
col_search_order = _branch_line_col_search_order(columns,
146
color = reduce(lambda x, y: x+y, branch_id, 0)
150
last_rev_index = None
151
for rev_index in branch_line:
153
if broken_line_length and \
154
rev_index - last_rev_index > broken_line_length:
155
line_range.append(last_rev_index+1)
156
line_range.append(rev_index-1)
158
line_range.extend(range(last_rev_index+1, rev_index))
160
line_range.append(rev_index)
161
last_rev_index = rev_index
164
if broken_line_length and \
165
parent_index - last_rev_index > broken_line_length:
166
line_range.append(last_rev_index+1)
168
line_range.extend(range(last_rev_index+1, parent_index))
170
col_index = _find_free_column(columns,
174
node = (col_index, color)
175
for rev_index in branch_line:
176
linegraph[rev_index][1] = node
177
columns[col_index][rev_index] = True
179
for rev_index in branch_line:
184
end_of_merge) = merge_sorted_revisions[rev_index]
186
linegraph[rev_index][4] = graph_children[revid]
187
col_index = linegraph[rev_index][1][0]
189
for parent_revid in graph_parents[revid]:
190
if parent_revid in revid_index:
192
parent_index = revid_index[parent_revid]
193
parent_node = linegraph[parent_index][1]
195
parent_col_index = parent_node[0]
197
parent_col_index = None
199
_line_col_search_order(columns,
203
# If this line is really long, break it.
204
if len(branch_id) > 0 and \
205
broken_line_length and \
206
parent_index - rev_index > broken_line_length:
207
child_line_col_index = \
208
_find_free_column(columns,
212
_mark_column_as_used(columns,
213
child_line_col_index,
216
# Recall _line_col_search_order to reset it back to
219
_line_col_search_order(columns,
222
parent_col_line_index = \
223
_find_free_column(columns,
227
_mark_column_as_used(columns,
228
parent_col_line_index,
230
lines.append((rev_index,
232
(child_line_col_index,
233
parent_col_line_index)))
235
line_col_index = col_index
236
if parent_index - rev_index >1:
237
line_range = range(rev_index + 1, parent_index)
239
_find_free_column(columns,
243
_mark_column_as_used(columns,
246
lines.append((rev_index,
250
for (child_index, parent_index, line_col_indexes) in lines:
251
(child_col_index, child_color) = linegraph[child_index][1]
252
(parent_col_index, parent_color) = linegraph[parent_index][1]
254
if len(line_col_indexes) == 1:
255
if parent_index - child_index == 1:
256
linegraph[child_index][2].append(
261
# line from the child's column to the lines column
262
linegraph[child_index][2].append(
266
# lines down the line's column
267
for line_part_index in range(child_index+1, parent_index-1):
268
linegraph[line_part_index][2].append(
269
(line_col_indexes[0],
272
# line from the line's column to the parent's column
273
linegraph[parent_index-1][2].append(
274
(line_col_indexes[0],
279
# line from the child's column to the lines column
280
linegraph[child_index][2].append(
285
linegraph[child_index+1][2].append(
286
(line_col_indexes[0],
291
linegraph[parent_index-2][2].append(
295
# line from the line's column to the parent's column
296
linegraph[parent_index-1][2].append(
297
(line_col_indexes[1],
302
return (linegraph, revid_index, len(columns))
304
def _branch_line_col_search_order(columns, parent_col_index):
305
for col_index in range(parent_col_index, len(columns)):
307
for col_index in range(parent_col_index-1, -1, -1):
310
def _line_col_search_order(columns, parent_col_index, child_col_index):
311
if parent_col_index is not None:
312
max_index = max(parent_col_index, child_col_index)
313
min_index = min(parent_col_index, child_col_index)
314
for col_index in range(max_index, min_index -1, -1):
317
max_index = child_col_index
318
min_index = child_col_index
319
yield child_col_index
321
while max_index + i < len(columns) or \
323
if max_index + i < len(columns):
325
if min_index - i > -1:
329
def _find_free_column(columns, empty_column, col_search_order, line_range):
330
for col_index in col_search_order:
331
column = columns[col_index]
332
has_overlaping_line = False
333
for row_index in line_range:
334
if column[row_index]:
335
has_overlaping_line = True
337
if not has_overlaping_line:
340
col_index = len(columns)
341
column = list(empty_column)
342
columns.append(column)
345
def _mark_column_as_used(columns, col_index, line_range):
346
column = columns[col_index]
347
for row_index in line_range:
348
column[row_index] = True
350
def same_branch(a, b):
351
"""Return whether we think revisions a and b are on the same branch."""
352
if len(a.parent_ids) == 1:
353
# Defacto same branch if only parent
355
elif a.committer == b.committer:
356
# Same committer so may as well be