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
49
mainline = branch.revision_history()
50
graph_parents = branch.repository.get_revision_graph(start)
52
for revid in graph_parents.iterkeys():
53
graph_children[revid] = []
55
merge_sorted_revisions = merge_sort(
64
# This will hold an item for each "branch". For a revisions, the revsion
65
# number less the least significant digit is the branch_id, and used as the
66
# key for the dict. Hence revision with the same revsion number less the
67
# least significant digit are considered to be in the same branch line.
68
# e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
69
# and these two revisions will be in the same branch line. Each value is
70
# a list of rev_indexes in the branch.
75
for (rev_index, (sequence_number,
79
end_of_merge)) in enumerate(merge_sorted_revisions):
80
if maxnum and rev_index >= maxnum:
82
revid_index[revid] = rev_index
83
revno_index[revno_sequence] = rev_index
85
branch_id = revno_sequence[0:-1]
88
if branch_id not in branch_lines:
90
branch_lines[branch_id] = branch_line
92
branch_line = branch_lines[branch_id]
94
branch_line.append(rev_index)
96
parents = graph_parents[revid]
97
for parent_revid in parents:
98
graph_children[parent_revid].append(revid)
100
linegraph.append([revid,
107
branch_ids = branch_lines.keys()
109
def branch_id_cmp(x, y):
110
"""Compaire branch_id's first by the number of digits, then reversed
116
return cmp(len_x, len_y)
118
branch_ids.sort(branch_id_cmp)
119
# This will hold a tuple of (child_index, parent_index, col_index) for each
120
# line that needs to be drawn. If col_index is not none, then the line is
121
# drawn along that column, else the the line can be drawn directly between
122
# the child and parent because either the child and parent are in the same
123
# branch line, or the child and parent are 1 row apart.
125
empty_column = [False for i in range(len(graph_parents))]
126
# This will hold a bit map for each cell. If the cell is true, then the
127
# cell allready contains a node or line. This use when deciding what column
128
# to place a branch line or line in, without it overlaping something else.
129
columns = [list(empty_column)]
132
for branch_id in branch_ids:
133
branch_line = branch_lines[branch_id]
135
# Find the col_index for the direct parent branch. This will be the
136
# starting point when looking for a free column.
139
if len(branch_id) > 1:
140
parent_revno = branch_id[0:-1]
141
if parent_revno in revno_index:
142
parent_index = revno_index[parent_revno]
143
parent_node = linegraph[parent_index][1]
145
parent_col_index = parent_node[0]
148
col_search_order = _branch_line_col_search_order(columns,
150
color = reduce(lambda x, y: x+y, branch_id, 0)
154
last_rev_index = None
155
for rev_index in branch_line:
157
if BROKEN_LINE_LENGTH and \
158
rev_index - last_rev_index > BROKEN_LINE_LENGTH:
159
line_range.append(last_rev_index+1)
160
line_range.append(rev_index-1)
162
line_range.extend(range(last_rev_index+1, rev_index))
164
line_range.append(rev_index)
165
last_rev_index = rev_index
168
if BROKEN_LINE_LENGTH and \
169
parent_index - last_rev_index > BROKEN_LINE_LENGTH:
170
line_range.append(last_rev_index+1)
172
line_range.extend(range(last_rev_index+1, parent_index))
174
col_index = _find_free_column(columns,
178
node = (col_index, color)
179
for rev_index in branch_line:
180
linegraph[rev_index][1] = node
181
columns[col_index][rev_index] = True
183
for rev_index in branch_line:
188
end_of_merge) = merge_sorted_revisions[rev_index]
190
linegraph[rev_index][4] = graph_children[revid]
191
col_index = linegraph[rev_index][1][0]
193
for parent_revid in graph_parents[revid]:
194
if parent_revid in revid_index:
196
parent_index = revid_index[parent_revid]
197
parent_node = linegraph[parent_index][1]
199
parent_col_index = parent_node[0]
201
parent_col_index = None
203
_line_col_search_order(columns,
207
# If this line is really long, break it.
208
if len(branch_id) > 0 and \
209
BROKEN_LINE_LENGTH and \
210
parent_index - rev_index > BROKEN_LINE_LENGTH:
211
child_line_col_index = \
212
_find_free_column(columns,
216
_mark_column_as_used(columns,
217
child_line_col_index,
220
# Recall _line_col_search_order to reset it back to
223
_line_col_search_order(columns,
226
parent_col_line_index = \
227
_find_free_column(columns,
231
_mark_column_as_used(columns,
232
parent_col_line_index,
234
lines.append((rev_index,
236
(child_line_col_index,
237
parent_col_line_index)))
239
line_col_index = col_index
240
if parent_index - rev_index >1:
241
line_range = range(rev_index + 1, parent_index)
243
_find_free_column(columns,
247
_mark_column_as_used(columns,
250
lines.append((rev_index,
254
for (child_index, parent_index, line_col_indexes) in lines:
255
(child_col_index, child_color) = linegraph[child_index][1]
256
(parent_col_index, parent_color) = linegraph[parent_index][1]
258
if len(line_col_indexes) == 1:
259
if parent_index - child_index == 1:
260
linegraph[child_index][2].append(
265
# line from the child's column to the lines column
266
linegraph[child_index][2].append(
270
# lines down the line's column
271
for line_part_index in range(child_index+1, parent_index-1):
272
linegraph[line_part_index][2].append(
273
(line_col_indexes[0],
276
# line from the line's column to the parent's column
277
linegraph[parent_index-1][2].append(
278
(line_col_indexes[0],
283
# line from the child's column to the lines column
284
linegraph[child_index][2].append(
289
linegraph[child_index+1][2].append(
290
(line_col_indexes[0],
295
linegraph[parent_index-2][2].append(
299
# line from the line's column to the parent's column
300
linegraph[parent_index-1][2].append(
301
(line_col_indexes[1],
306
return (linegraph, revid_index, len(columns))
308
def _branch_line_col_search_order(columns, parent_col_index):
309
for col_index in range(parent_col_index, len(columns)):
311
for col_index in range(parent_col_index-1, -1, -1):
314
def _line_col_search_order(columns, parent_col_index, child_col_index):
315
if parent_col_index is not None:
316
max_index = max(parent_col_index, child_col_index)
317
min_index = min(parent_col_index, child_col_index)
318
for col_index in range(max_index, min_index -1, -1):
321
max_index = child_col_index
322
min_index = child_col_index
323
yield child_col_index
325
while max_index + i < len(columns) or \
327
if max_index + i < len(columns):
329
if min_index - i > -1:
333
def _find_free_column(columns, empty_column, col_search_order, line_range):
334
for col_index in col_search_order:
335
column = columns[col_index]
336
has_overlaping_line = False
337
for row_index in line_range:
338
if column[row_index]:
339
has_overlaping_line = True
341
if not has_overlaping_line:
344
col_index = len(columns)
345
column = list(empty_column)
346
columns.append(column)
349
def _mark_column_as_used(columns, col_index, line_range):
350
column = columns[col_index]
351
for row_index in line_range:
352
column[row_index] = True
354
def same_branch(a, b):
355
"""Return whether we think revisions a and b are on the same branch."""
356
if len(a.parent_ids) == 1:
357
# Defacto same branch if only parent
359
elif a.committer == b.committer:
360
# Same committer so may as well be