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
graph_data = True, mainline_only = False):
16
"""Produce a directed graph of a bzr repository.
18
Returns a tuple of (line_graph, revid_index, columns_len) where
19
* line_graph is a list of tuples of (revid,
25
* revid_index is a dict of each revision with the key being the revid, and
26
the value the row index, and
27
* columns_len is the number of columns need to draw the line graph.
30
Node is a tuple of (column, colour) with column being a zero-indexed
31
column number of the graph that this revision represents and colour
32
being a zero-indexed colour (which doesn't specify any actual colour
33
in particular) to draw the node in.
35
Lines is a list of tuples which represent lines you should draw away
36
from the revision, if you also need to draw lines into the revision
37
you should use the lines list from the previous iteration. Each
38
typle in the list is in the form (start, end, colour) with start and
39
end being zero-indexed column numbers and colour as in node.
41
It's up to you how to actually draw the nodes and lines (straight,
42
curved, kinked, etc.) and to pick the actual colours for each index.
45
graph_parents = repository.get_revision_graph(start)
47
for revid in graph_parents.iterkeys():
48
graph_children[revid] = []
50
if len(graph_parents)>0:
51
merge_sorted_revisions = merge_sort(
56
merge_sorted_revisions = ()
59
merge_sorted_revisions = [elem for elem in merge_sorted_revisions \
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
85
parents = graph_parents[revid]
86
for parent_revid in parents:
87
graph_children[parent_revid].append(revid)
89
linegraph.append([revid,
97
revno_index[revno_sequence] = rev_index
99
branch_id = revno_sequence[0:-1]
102
if branch_id not in branch_lines:
104
branch_lines[branch_id] = branch_line
106
branch_line = branch_lines[branch_id]
108
branch_line.append(rev_index)
111
branch_ids = branch_lines.keys()
113
def branch_id_cmp(x, y):
114
"""Compaire branch_id's first by the number of digits, then reversed
120
return cmp(len_x, len_y)
122
branch_ids.sort(branch_id_cmp)
123
# This will hold a tuple of (child_index, parent_index, col_index) for each
124
# line that needs to be drawn. If col_index is not none, then the line is
125
# drawn along that column, else the the line can be drawn directly between
126
# the child and parent because either the child and parent are in the same
127
# branch line, or the child and parent are 1 row apart.
129
empty_column = [False for i in range(len(graph_parents))]
130
# This will hold a bit map for each cell. If the cell is true, then the
131
# cell allready contains a node or line. This use when deciding what column
132
# to place a branch line or line in, without it overlaping something else.
133
columns = [list(empty_column)]
136
for branch_id in branch_ids:
137
branch_line = branch_lines[branch_id]
139
# Find the col_index for the direct parent branch. This will be the
140
# starting point when looking for a free column.
143
if len(branch_id) > 1:
144
parent_revno = branch_id[0:-1]
145
if parent_revno in revno_index:
146
parent_index = revno_index[parent_revno]
147
parent_node = linegraph[parent_index][1]
149
parent_col_index = parent_node[0]
152
col_search_order = _branch_line_col_search_order(columns,
154
color = reduce(lambda x, y: x+y, branch_id, 0)
158
last_rev_index = None
159
for rev_index in branch_line:
161
if broken_line_length and \
162
rev_index - last_rev_index > broken_line_length:
163
line_range.append(last_rev_index+1)
164
line_range.append(rev_index-1)
166
line_range.extend(range(last_rev_index+1, rev_index))
168
line_range.append(rev_index)
169
last_rev_index = rev_index
172
if broken_line_length and \
173
parent_index - last_rev_index > broken_line_length:
174
line_range.append(last_rev_index+1)
176
line_range.extend(range(last_rev_index+1, parent_index))
178
col_index = _find_free_column(columns,
182
node = (col_index, color)
183
for rev_index in branch_line:
184
linegraph[rev_index][1] = node
185
columns[col_index][rev_index] = True
187
for rev_index in branch_line:
192
end_of_merge) = merge_sorted_revisions[rev_index]
194
linegraph[rev_index][4] = graph_children[revid]
195
col_index = linegraph[rev_index][1][0]
197
for parent_revid in graph_parents[revid]:
198
if parent_revid in revid_index:
200
parent_index = revid_index[parent_revid]
201
parent_node = linegraph[parent_index][1]
203
parent_col_index = parent_node[0]
205
parent_col_index = None
207
_line_col_search_order(columns,
211
# If this line is really long, break it.
212
if len(branch_id) > 0 and \
213
broken_line_length and \
214
parent_index - rev_index > broken_line_length:
215
child_line_col_index = \
216
_find_free_column(columns,
220
_mark_column_as_used(columns,
221
child_line_col_index,
224
# Recall _line_col_search_order to reset it back to
227
_line_col_search_order(columns,
230
parent_col_line_index = \
231
_find_free_column(columns,
235
_mark_column_as_used(columns,
236
parent_col_line_index,
238
lines.append((rev_index,
240
(child_line_col_index,
241
parent_col_line_index)))
243
line_col_index = col_index
244
if parent_index - rev_index >1:
245
line_range = range(rev_index + 1, parent_index)
247
_find_free_column(columns,
251
_mark_column_as_used(columns,
254
lines.append((rev_index,
258
for (child_index, parent_index, line_col_indexes) in lines:
259
(child_col_index, child_color) = linegraph[child_index][1]
260
(parent_col_index, parent_color) = linegraph[parent_index][1]
262
if len(line_col_indexes) == 1:
263
if parent_index - child_index == 1:
264
linegraph[child_index][2].append(
269
# line from the child's column to the lines column
270
linegraph[child_index][2].append(
274
# lines down the line's column
275
for line_part_index in range(child_index+1, parent_index-1):
276
linegraph[line_part_index][2].append(
277
(line_col_indexes[0],
280
# line from the line's column to the parent's column
281
linegraph[parent_index-1][2].append(
282
(line_col_indexes[0],
287
# line from the child's column to the lines column
288
linegraph[child_index][2].append(
293
linegraph[child_index+1][2].append(
294
(line_col_indexes[0],
299
linegraph[parent_index-2][2].append(
303
# line from the line's column to the parent's column
304
linegraph[parent_index-1][2].append(
305
(line_col_indexes[1],
308
return (linegraph, revid_index, len(columns))
310
return (linegraph, revid_index, 0)
313
def _branch_line_col_search_order(columns, parent_col_index):
314
for col_index in range(parent_col_index, len(columns)):
316
for col_index in range(parent_col_index-1, -1, -1):
319
def _line_col_search_order(columns, parent_col_index, child_col_index):
320
if parent_col_index is not None:
321
max_index = max(parent_col_index, child_col_index)
322
min_index = min(parent_col_index, child_col_index)
323
for col_index in range(max_index, min_index -1, -1):
326
max_index = child_col_index
327
min_index = child_col_index
328
yield child_col_index
330
while max_index + i < len(columns) or \
332
if max_index + i < len(columns):
334
if min_index - i > -1:
338
def _find_free_column(columns, empty_column, col_search_order, line_range):
339
for col_index in col_search_order:
340
column = columns[col_index]
341
has_overlaping_line = False
342
for row_index in line_range:
343
if column[row_index]:
344
has_overlaping_line = True
346
if not has_overlaping_line:
349
col_index = len(columns)
350
column = list(empty_column)
351
columns.append(column)
354
def _mark_column_as_used(columns, col_index, line_range):
355
column = columns[col_index]
356
for row_index in line_range:
357
column[row_index] = True
359
def same_branch(a, b):
360
"""Return whether we think revisions a and b are on the same branch."""
361
if len(a.parent_ids) == 1:
362
# Defacto same branch if only parent
364
elif a.committer == b.committer:
365
# Same committer so may as well be
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 graph(branch, start):
34
"""Produce a directed graph of a bzr branch.
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. 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.
42
For each revision it then yields a tuple of (revision, node, lines).
43
If the revision is only referenced in the branch and not present in the
44
store, revision will be a DummyRevision object, otherwise it is the bzr
45
Revision object with the meta-data for the revision.
47
Node is a tuple of (column, colour) with column being a zero-indexed
48
column number of the graph that this revision represents and colour
49
being a zero-indexed colour (which doesn't specify any actual colour
50
in particular) to draw the node in.
52
Lines is a list of tuples which represent lines you should draw away
53
from the revision, if you also need to draw lines into the revision
54
you should use the lines list from the previous iteration. Each
55
typle in the list is in the form (start, end, colour) with start and
56
end being zero-indexed column numbers and colour as in node.
58
It's up to you how to actually draw the nodes and lines (straight,
59
curved, kinked, etc.) and to pick the actual colours for each index.
61
revisions = { start: branch.get_revision(start) }
62
distances = { start: 0 }
63
colours = { start: 0 }
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
73
revision = revisions[revid]
74
distance = distances[revid] + 1
75
colour = colours[revid]
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:
83
# Get the parent from the cache, or put it in the cache
85
parent = revisions[parent_id]
88
parent = revisions[parent_id] \
89
= branch.get_revision(parent_id)
90
except NoSuchRevision:
91
parent = revisions[parent_id] = DummyRevision(parent_id)
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
104
colours[parent_id] = last_colour = last_colour + 1
105
distances[parent_id] = distance + 10
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.
114
for revid in sorted(distances, key=distances.get):
119
for h_idx, hang in enumerate(hanging):
121
# We've matched a hanging revision, so need to output a node
123
node = (h_idx, colours[revid])
125
# Now we need to hang its parents, we put them at the point
126
# the old column was so anything to the right of this has
127
# to move outwards to make room. We also try and collapse
128
# hangs to keep the graph small.
129
for parent_id in revisions[revid].parent_ids:
131
n_idx = new_hanging.index(parent_id)
133
n_idx = len(new_hanging)
134
new_hanging.append(parent_id)
135
lines.append((h_idx, n_idx, colours[parent_id]))
137
# Revision keeps on hanging, adjust for any change in the
138
# graph shape and try to collapse hangs to keep the graph
141
n_idx = new_hanging.index(hang)
143
n_idx = len(new_hanging)
144
new_hanging.append(hang)
145
lines.append((h_idx, n_idx, colours[hang]))
146
hanging = new_hanging
148
yield (revisions[revid], node, lines)