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
16
def linegraph(graph, start_revs, maxnum=None, broken_line_length=None,
17
graph_data=True, mainline_only=False, root_progress=None):
18
"""Produce a directed graph of a bzr repository.
20
Returns a tuple of (line_graph, revid_index, columns_len) where
21
* line_graph is a list of tuples of (revid,
27
* revid_index is a dict of each revision with the key being the revid, and
28
the value the row index, and
29
* columns_len is the number of columns need to draw the line graph.
32
Node is a tuple of (column, colour) with column being a zero-indexed
33
column number of the graph that this revision represents and colour
34
being a zero-indexed colour (which doesn't specify any actual colour
35
in particular) to draw the node in.
37
Lines is a list of tuples which represent lines you should draw away
38
from the revision, if you also need to draw lines into the revision
39
you should use the lines list from the previous iteration. Each
40
typle in the list is in the form (start, end, colour) with start and
41
end being zero-indexed column numbers and colour as in node.
43
It's up to you how to actually draw the nodes and lines (straight,
44
curved, kinked, etc.) and to pick the actual colours for each index.
46
assert isinstance(start_revs, list)
47
def update_root_progress(step_number):
48
"""IFF our container received a root progress bar, then update it."""
49
if root_progress is not None:
50
root_progress.update(current=step_number)
55
update_root_progress(1)
56
progress_bar = ui.ui_factory.nested_progress_bar()
58
progress_bar.update(msg="Arranging tree fragments")
59
for i, (revid, parent_revids) in enumerate(graph.iter_ancestry(start_revs)):
62
if parent_revids is None:
65
if parent_revids == (NULL_REVISION,):
66
graph_parents[revid] = ()
68
graph_parents[revid] = parent_revids
69
for parent in parent_revids:
70
graph_children.setdefault(parent, []).append(revid)
71
graph_children.setdefault(revid, [])
73
progress_bar.finished()
75
update_root_progress(2)
76
progress_bar = ui.ui_factory.nested_progress_bar()
78
progress_bar.update(msg="Removing ghosts", total=len(ghosts))
79
for i, ghost in enumerate(ghosts):
81
progress_bar.update(current=i)
82
for ghost_child in graph_children[ghost]:
83
graph_parents[ghost_child] = [p for p in graph_parents[ghost_child]
86
progress_bar.finished()
87
graph_parents["top:"] = start_revs
89
if len(graph_parents)>0:
90
merge_sorted_revisions = merge_sort(
95
merge_sorted_revisions = ()
98
merge_sorted_revisions = [elem for elem in merge_sorted_revisions \
101
assert merge_sorted_revisions[0][1] == "top:"
102
merge_sorted_revisions = merge_sorted_revisions[1:]
107
# This will hold an item for each "branch". For a revisions, the revsion
108
# number less the least significant digit is the branch_id, and used as the
109
# key for the dict. Hence revision with the same revsion number less the
110
# least significant digit are considered to be in the same branch line.
111
# e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
112
# and these two revisions will be in the same branch line. Each value is
113
# a list of rev_indexes in the branch.
118
update_root_progress(3)
119
progress_bar = ui.ui_factory.nested_progress_bar()
121
progress_bar.update(msg="Finding nodes", total=len(merge_sorted_revisions))
122
for (rev_index, (sequence_number,
126
end_of_merge)) in enumerate(merge_sorted_revisions):
128
if rev_index % 25 == 0:
129
progress_bar.update(current=rev_index)
130
if maxnum and rev_index >= maxnum:
132
revid_index[revid] = rev_index
134
parents = graph_parents[revid]
135
linegraph.append([revid,
143
revno_index[revno_sequence] = rev_index
145
branch_id = revno_sequence[0:-1]
148
if branch_id not in branch_lines:
150
branch_lines[branch_id] = branch_line
152
branch_line = branch_lines[branch_id]
154
branch_line.append(rev_index)
156
progress_bar.finished()
159
branch_ids = branch_lines.keys()
161
def branch_id_cmp(x, y):
162
"""Compaire branch_id's first by the number of digits, then reversed
168
return cmp(len_x, len_y)
170
branch_ids.sort(branch_id_cmp)
171
# This will hold a tuple of (child_index, parent_index, col_index) for each
172
# line that needs to be drawn. If col_index is not none, then the line is
173
# drawn along that column, else the the line can be drawn directly between
174
# the child and parent because either the child and parent are in the same
175
# branch line, or the child and parent are 1 row apart.
177
empty_column = [False for i in range(len(graph_parents))]
178
# This will hold a bit map for each cell. If the cell is true, then the
179
# cell allready contains a node or line. This use when deciding what column
180
# to place a branch line or line in, without it overlaping something else.
181
columns = [list(empty_column)]
184
update_root_progress(4)
185
progress_bar = ui.ui_factory.nested_progress_bar()
187
progress_bar.update(msg="Organizing edges", total=len(branch_ids))
188
for i, branch_id in enumerate(branch_ids):
190
progress_bar.update(current=i)
191
branch_line = branch_lines[branch_id]
193
# Find the col_index for the direct parent branch. This will be the
194
# starting point when looking for a free column.
197
if len(branch_id) > 1:
198
parent_revno = branch_id[0:-1]
199
if parent_revno in revno_index:
200
parent_index = revno_index[parent_revno]
201
parent_node = linegraph[parent_index][1]
203
parent_col_index = parent_node[0]
206
col_search_order = _branch_line_col_search_order(columns,
208
color = reduce(lambda x, y: x+y, branch_id, 0)
212
last_rev_index = None
213
for rev_index in branch_line:
215
if broken_line_length and \
216
rev_index - last_rev_index > broken_line_length:
217
line_range.append(last_rev_index+1)
218
line_range.append(rev_index-1)
220
line_range.extend(range(last_rev_index+1, rev_index))
222
line_range.append(rev_index)
223
last_rev_index = rev_index
226
if broken_line_length and \
227
parent_index - last_rev_index > broken_line_length:
228
line_range.append(last_rev_index+1)
230
line_range.extend(range(last_rev_index+1, parent_index))
232
col_index = _find_free_column(columns,
236
node = (col_index, color)
237
for rev_index in branch_line:
238
linegraph[rev_index][1] = node
239
columns[col_index][rev_index] = True
241
for rev_index in branch_line:
246
end_of_merge) = merge_sorted_revisions[rev_index]
248
linegraph[rev_index][4] = graph_children[revid]
249
col_index = linegraph[rev_index][1][0]
251
for parent_revid in graph_parents[revid]:
252
if parent_revid in revid_index:
254
parent_index = revid_index[parent_revid]
255
parent_node = linegraph[parent_index][1]
257
parent_col_index = parent_node[0]
259
parent_col_index = None
261
_line_col_search_order(columns,
265
# If this line is really long, break it.
266
if len(branch_id) > 0 and \
267
broken_line_length and \
268
parent_index - rev_index > broken_line_length:
269
child_line_col_index = \
270
_find_free_column(columns,
274
_mark_column_as_used(columns,
275
child_line_col_index,
278
# Recall _line_col_search_order to reset it back to
281
_line_col_search_order(columns,
284
parent_col_line_index = \
285
_find_free_column(columns,
289
_mark_column_as_used(columns,
290
parent_col_line_index,
292
lines.append((rev_index,
294
(child_line_col_index,
295
parent_col_line_index)))
297
line_col_index = col_index
298
if parent_index - rev_index >1:
299
line_range = range(rev_index + 1, parent_index)
301
_find_free_column(columns,
305
_mark_column_as_used(columns,
308
lines.append((rev_index,
312
progress_bar.finished()
314
update_root_progress(5)
315
progress_bar = ui.ui_factory.nested_progress_bar()
317
progress_bar.update(msg="Pretifying graph", total=len(lines))
318
for i, (child_index, parent_index, line_col_indexes) in enumerate(lines):
320
progress_bar.update(current=i)
321
(child_col_index, child_color) = linegraph[child_index][1]
322
(parent_col_index, parent_color) = linegraph[parent_index][1]
324
if len(line_col_indexes) == 1:
325
if parent_index - child_index == 1:
326
linegraph[child_index][2].append(
331
# line from the child's column to the lines column
332
linegraph[child_index][2].append(
336
# lines down the line's column
337
for line_part_index in range(child_index+1, parent_index-1):
338
linegraph[line_part_index][2].append(
339
(line_col_indexes[0],
342
# line from the line's column to the parent's column
343
linegraph[parent_index-1][2].append(
344
(line_col_indexes[0],
349
# line from the child's column to the lines column
350
linegraph[child_index][2].append(
355
linegraph[child_index+1][2].append(
356
(line_col_indexes[0],
361
linegraph[parent_index-2][2].append(
365
# line from the line's column to the parent's column
366
linegraph[parent_index-1][2].append(
367
(line_col_indexes[1],
371
progress_bar.finished()
372
return (linegraph, revid_index, len(columns))
374
return (linegraph, revid_index, 0)
377
def _branch_line_col_search_order(columns, parent_col_index):
378
for col_index in range(parent_col_index, len(columns)):
380
for col_index in range(parent_col_index-1, -1, -1):
383
def _line_col_search_order(columns, parent_col_index, child_col_index):
384
if parent_col_index is not None:
385
max_index = max(parent_col_index, child_col_index)
386
min_index = min(parent_col_index, child_col_index)
387
for col_index in range(max_index, min_index -1, -1):
390
max_index = child_col_index
391
min_index = child_col_index
392
yield child_col_index
394
while max_index + i < len(columns) or \
396
if max_index + i < len(columns):
398
if min_index - i > -1:
402
def _find_free_column(columns, empty_column, col_search_order, line_range):
403
for col_index in col_search_order:
404
column = columns[col_index]
405
has_overlaping_line = False
406
for row_index in line_range:
407
if column[row_index]:
408
has_overlaping_line = True
410
if not has_overlaping_line:
413
col_index = len(columns)
414
column = list(empty_column)
415
columns.append(column)
418
def _mark_column_as_used(columns, col_index, line_range):
419
column = columns[col_index]
420
for row_index in line_range:
421
column[row_index] = True
423
def same_branch(a, b):
424
"""Return whether we think revisions a and b are on the same branch."""
425
if len(a.parent_ids) == 1:
426
# Defacto same branch if only parent
428
elif a.committer == b.committer:
429
# 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
def linegraph(branch, start, maxnum):
14
"""Produce a directed graph of a bzr branch.
16
Returns a list of tuples of (revision, node, lines, parents, children).
18
Node is a tuple of (column, colour) with column being a zero-indexed
19
column number of the graph that this revision represents and colour
20
being a zero-indexed colour (which doesn't specify any actual colour
21
in particular) to draw the node in.
23
Lines is a list of tuples which represent lines you should draw away
24
from the revision, if you also need to draw lines into the revision
25
you should use the lines list from the previous iteration. Each
26
typle in the list is in the form (start, end, colour) with start and
27
end being zero-indexed column numbers and colour as in node.
29
It's up to you how to actually draw the nodes and lines (straight,
30
curved, kinked, etc.) and to pick the actual colours for each index.
33
def getdirectparent(childrevid, childindex, childsparents):
34
"""Return the revision id of the direct parent
36
The direct parent is the first parent with the same committer"""
37
childrevision = revisions[childindex]
38
directparent = directparentcache[childindex]
39
if directparent is None:
40
for parentrevid in childsparents:
41
if parentrevid in revindex:
42
parentindex = revindex[parentrevid]
43
parentrevision = revisions[parentindex]
44
if childrevision.committer == parentrevision.committer:
45
# This may be a direct parent, but first check that
46
# for this parent, there are no other children, who are
47
# before us in the children list, for which this parent
48
# is also the direct parent.
49
# pc in all the below var name stands for parents child
51
for pcrevid in revisionchildren[parentindex]:
52
if pcrevid == childrevid:
54
pcindex = revindex[pcrevid]
55
pcdirectparent = getdirectparent(pcrevid,
57
revisionchildren[pcindex])
58
if pcdirectparent==parentrevid:
63
directparent = parentrevid
65
#no parents have the same commiter
66
if directparent is None:
68
directparentcache[childindex] = directparent
71
def find_column_from_branchlineid(branchlineid):
72
for index, column in enumerate(columns):
73
if column is not None and column["branchlineid"] == branchlineid:
74
return (index, column)
77
def has_no_nodes_between (column, startindex, endindex):
78
for nodeindex in column["nodeindexes"]:
79
if nodeindex > startindex and nodeindex < endindex:
83
def append_line (column , startindex, endindex):
84
column["lines"].append((startindex,endindex))
85
if endindex > column["maxindex"] :
86
column["maxindex"] = endindex
88
def append_column (column, minindex):
90
for (i, c) in enumerate(columns):
91
if c is None or (c["branchlineid"] == "finished" \
92
and c["maxindex"] <= minindex):
94
columns[columnindex] = column
96
if columnindex is None:
97
columnindex = len(columns)
98
columns.append(column)
103
for (index, revid) in enumerate(reversed( \
104
branch.repository.get_ancestry(start))):
105
if revid is not None:
107
revindex[revid] = index
108
if maxnum is not None and index > maxnum:
112
revisions = branch.repository.get_revisions(revids)
113
revisionparents = branch.repository.get_graph().get_parents(revids)
114
directparentcache = [None for revision in revisions]
116
# This will hold what we plan to put in each column.
117
# The position of the item in this list indicates the column, and it
118
# it may change if we need to make space for other things.
119
# Each typle in the list is in the form:
120
# (branchlineid, nodeindexes, lines, maxindex)
121
# A item may be None to indicate that there is nothing in the column
128
revisionchildren = [[] for revision in revisions]
131
for (index, revision) in enumerate(revisions):
132
parents = [parent for parent in revisionparents[index] \
134
for parentrevid in parents:
135
if parentrevid in revindex:
136
revisionchildren[revindex[parentrevid]]\
137
.append(revision.revision_id)
139
children = revisionchildren[index]
141
#We use childrevid, childindex, childbranchlineid often, so cache it
143
for childrevid in children:
144
childindex = revindex[childrevid]
145
children_ext.append((childrevid,
147
branchlineids[childindex]))
149
linegraph.append([revision, None,
150
[], parents, children])
153
#Try and see if we are the same branchline as one of our children
154
#If we are, use the same branchlineid
155
for (childrevid, childindex, childbranchlineid) in children_ext:
156
childsparents = revisionparents[childindex]
158
if len(children) == 1 and len(childsparents) == 1:
159
# one-one relationship between parent and child
160
branchlineid = childbranchlineid
163
#Is the current revision the direct parent of the child?
164
if revision.revision_id == \
165
getdirectparent(childrevid, childindex, childsparents):
166
branchlineid = childbranchlineid
169
if branchlineid is None:
170
branchlineid = lastbranchlineid = lastbranchlineid + 1
172
branchlineids.append(branchlineid)
174
(columnindex, column) = find_column_from_branchlineid(branchlineid)
176
if columnindex is None:
177
for (childrevid, childindex, childbranchlineid) in children_ext:
178
(i, c) = find_column_from_branchlineid(childbranchlineid)
179
if c is not None and c["maxindex"] <= index:
180
(columnindex, column) = (i, c)
185
if columnindex is None:
187
for childrevid in children:
188
childindex = revindex[childrevid]
189
if childindex<minindex:
190
minindex = childindex
192
column = {"branchlineid": branchlineid,
193
"nodeindexes": [index],
196
columnindex = append_column(column, minindex)
198
column["branchlineid"] = branchlineid
199
column["nodeindexes"].append(index)
201
opentillparent = getdirectparent(revision.revision_id, index, parents)
202
if opentillparent == "":
204
opentillparent = parents[0]
206
opentillparent = None
208
if opentillparent is not None and opentillparent in revindex:
209
parentindex = revindex[opentillparent]
210
if parentindex > column["maxindex"]:
211
column["maxindex"] = parentindex
213
for (childrevid, childindex, childbranchlineid) in children_ext:
214
(childcolumnindex, childcolumn) = \
215
find_column_from_branchlineid(childbranchlineid)
217
if index-childindex == 1 or childcolumnindex is None:
218
append_line(column,childindex,index)
219
elif childcolumnindex >= columnindex and \
220
has_no_nodes_between(childcolumn, childindex, index):
221
append_line(childcolumn,childindex,index)
222
elif childcolumnindex > columnindex and \
223
has_no_nodes_between(column, childindex, index):
224
append_line(column,childindex,index)
225
elif childcolumnindex < columnindex and \
226
has_no_nodes_between(column, childindex, index):
227
append_line(column,childindex,index)
228
elif childcolumnindex < columnindex and \
229
has_no_nodes_between(childcolumn, childindex, index):
230
append_line(childcolumn,childindex,index)
232
append_column({"branchlineid": "line",
234
"lines": [(childindex,index)],
235
"maxindex": index}, childindex)
237
for (columnindex, column) in enumerate(columns):
238
if column is not None and column["maxindex"] <= index \
239
and column["branchlineid"] != "finished":
240
for nodeindex in column["nodeindexes"]:
241
linegraph[nodeindex][1] = (columnindex,
242
branchlineids[nodeindex])
244
for (childindex, parentindex) in column["lines"]:
245
notdrawnlines.append((columnindex, childindex, parentindex))
247
column["branchlineid"] = "finished"
248
column["nodeindexes"] = []
251
for (lineindex,(columnindex, childindex, parentindex))\
252
in enumerate(notdrawnlines):
254
childnode = linegraph[childindex][1]
255
parentnode = linegraph[parentindex][1]
256
if childnode is not None and parentnode is not None:
257
notdrawnlines[lineindex] = None
258
if parentindex>childindex+1:
259
#out from the child to line
260
linegraph[childindex][2].append(
261
(childnode[0], #the column of the child
262
columnindex, #the column of the line
266
for linepartindex in range(childindex+1, parentindex-1):
267
linegraph[linepartindex][2].append(
268
(columnindex, #the column of the line
269
columnindex, #the column of the line
273
linegraph[parentindex-1][2].append(
274
(columnindex, #the column of the line
275
parentnode[0], #the column of the parent
279
linegraph[childindex][2].append(
280
(childnode[0], #the column of the child
281
parentnode[0], #the column of the parent
284
notdrawnlines = [line for line in notdrawnlines if line is not None]
287
return (linegraph, revindex, revisions)
290
def same_branch(a, b):
291
"""Return whether we think revisions a and b are on the same branch."""
292
if len(a.parent_ids) == 1:
293
# Defacto same branch if only parent
295
elif a.committer == b.committer:
296
# Same committer so may as well be