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
merge_sorted_revisions = merge_sort(
57
# This will hold an item for each "branch". For a revisions, the revsion
58
# number less the least significant digit is the branch_id, and used as the
59
# key for the dict. Hence revision with the same revsion number less the
60
# least significant digit are considered to be in the same branch line.
61
# e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
62
# and these two revisions will be in the same branch line. Each value is
63
# a list of rev_indexes in the branch.
68
for (rev_index, (sequence_number,
72
end_of_merge)) in enumerate(merge_sorted_revisions):
73
if maxnum and rev_index >= maxnum:
75
revid_index[revid] = rev_index
76
revno_index[revno_sequence] = rev_index
78
branch_id = revno_sequence[0:-1]
81
if branch_id not in branch_lines:
83
branch_lines[branch_id] = branch_line
85
branch_line = branch_lines[branch_id]
87
branch_line.append(rev_index)
89
parents = graph_parents[revid]
90
for parent_revid in parents:
91
graph_children[parent_revid].append(revid)
93
linegraph.append([revid,
100
branch_ids = branch_lines.keys()
102
def branch_id_cmp(x, y):
103
"""Compaire branch_id's first by the number of digits, then reversed
109
return cmp(len_x, len_y)
111
branch_ids.sort(branch_id_cmp)
112
# This will hold a tuple of (child_index, parent_index, col_index) for each
113
# line that needs to be drawn. If col_index is not none, then the line is
114
# drawn along that column, else the the line can be drawn directly between
115
# the child and parent because either the child and parent are in the same
116
# branch line, or the child and parent are 1 row apart.
118
empty_column = [False for i in range(len(graph_parents))]
119
# This will hold a bit map for each cell. If the cell is true, then the
120
# cell allready contains a node or line. This use when deciding what column
121
# to place a branch line or line in, without it overlaping something else.
122
columns = [list(empty_column)]
125
for branch_id in branch_ids:
126
branch_line = branch_lines[branch_id]
128
# Find the col_index for the direct parent branch. This will be the
129
# starting point when looking for a free column.
132
if len(branch_id) > 1:
133
parent_revno = branch_id[0:-1]
134
if parent_revno in revno_index:
135
parent_index = revno_index[parent_revno]
136
parent_node = linegraph[parent_index][1]
138
parent_col_index = parent_node[0]
141
col_search_order = _branch_line_col_search_order(columns,
143
color = reduce(lambda x, y: x+y, branch_id, 0)
147
last_rev_index = None
148
for rev_index in branch_line:
150
if broken_line_length and \
151
rev_index - last_rev_index > broken_line_length:
152
line_range.append(last_rev_index+1)
153
line_range.append(rev_index-1)
155
line_range.extend(range(last_rev_index+1, rev_index))
157
line_range.append(rev_index)
158
last_rev_index = rev_index
161
if broken_line_length and \
162
parent_index - last_rev_index > broken_line_length:
163
line_range.append(last_rev_index+1)
165
line_range.extend(range(last_rev_index+1, parent_index))
167
col_index = _find_free_column(columns,
171
node = (col_index, color)
172
for rev_index in branch_line:
173
linegraph[rev_index][1] = node
174
columns[col_index][rev_index] = True
176
for rev_index in branch_line:
181
end_of_merge) = merge_sorted_revisions[rev_index]
183
linegraph[rev_index][4] = graph_children[revid]
184
col_index = linegraph[rev_index][1][0]
186
for parent_revid in graph_parents[revid]:
187
if parent_revid in revid_index:
189
parent_index = revid_index[parent_revid]
190
parent_node = linegraph[parent_index][1]
192
parent_col_index = parent_node[0]
194
parent_col_index = None
196
_line_col_search_order(columns,
200
# If this line is really long, break it.
201
if len(branch_id) > 0 and \
202
broken_line_length and \
203
parent_index - rev_index > broken_line_length:
204
child_line_col_index = \
205
_find_free_column(columns,
209
_mark_column_as_used(columns,
210
child_line_col_index,
213
# Recall _line_col_search_order to reset it back to
216
_line_col_search_order(columns,
219
parent_col_line_index = \
220
_find_free_column(columns,
224
_mark_column_as_used(columns,
225
parent_col_line_index,
227
lines.append((rev_index,
229
(child_line_col_index,
230
parent_col_line_index)))
232
line_col_index = col_index
233
if parent_index - rev_index >1:
234
line_range = range(rev_index + 1, parent_index)
236
_find_free_column(columns,
240
_mark_column_as_used(columns,
243
lines.append((rev_index,
247
for (child_index, parent_index, line_col_indexes) in lines:
248
(child_col_index, child_color) = linegraph[child_index][1]
249
(parent_col_index, parent_color) = linegraph[parent_index][1]
251
if len(line_col_indexes) == 1:
252
if parent_index - child_index == 1:
253
linegraph[child_index][2].append(
258
# line from the child's column to the lines column
259
linegraph[child_index][2].append(
263
# lines down the line's column
264
for line_part_index in range(child_index+1, parent_index-1):
265
linegraph[line_part_index][2].append(
266
(line_col_indexes[0],
269
# line from the line's column to the parent's column
270
linegraph[parent_index-1][2].append(
271
(line_col_indexes[0],
276
# line from the child's column to the lines column
277
linegraph[child_index][2].append(
282
linegraph[child_index+1][2].append(
283
(line_col_indexes[0],
288
linegraph[parent_index-2][2].append(
292
# line from the line's column to the parent's column
293
linegraph[parent_index-1][2].append(
294
(line_col_indexes[1],
299
return (linegraph, revid_index, len(columns))
301
def _branch_line_col_search_order(columns, parent_col_index):
302
for col_index in range(parent_col_index, len(columns)):
304
for col_index in range(parent_col_index-1, -1, -1):
307
def _line_col_search_order(columns, parent_col_index, child_col_index):
308
if parent_col_index is not None:
309
max_index = max(parent_col_index, child_col_index)
310
min_index = min(parent_col_index, child_col_index)
311
for col_index in range(max_index, min_index -1, -1):
314
max_index = child_col_index
315
min_index = child_col_index
316
yield child_col_index
318
while max_index + i < len(columns) or \
320
if max_index + i < len(columns):
322
if min_index - i > -1:
326
def _find_free_column(columns, empty_column, col_search_order, line_range):
327
for col_index in col_search_order:
328
column = columns[col_index]
329
has_overlaping_line = False
330
for row_index in line_range:
331
if column[row_index]:
332
has_overlaping_line = True
334
if not has_overlaping_line:
337
col_index = len(columns)
338
column = list(empty_column)
339
columns.append(column)
342
def _mark_column_as_used(columns, col_index, line_range):
343
column = columns[col_index]
344
for row_index in line_range:
345
column[row_index] = True
347
def same_branch(a, b):
348
"""Return whether we think revisions a and b are on the same branch."""
349
if len(a.parent_ids) == 1:
350
# Defacto same branch if only parent
352
elif a.committer == b.committer:
353
# Same committer so may as well be