/b-gtk/fix-viz

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/b-gtk/fix-viz

« back to all changes in this revision

Viewing changes to branchview/linegraph.py

  • Committer: Jelmer Vernooij
  • Date: 2012-07-09 15:23:26 UTC
  • mto: This revision was merged to the branch mainline in revision 794.
  • Revision ID: jelmer@samba.org-20120709152326-dzxb8zoz0btull7n
Remove bzr-notify.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# -*- coding: UTF-8 -*-
2
1
"""Directed graph production.
3
2
 
4
3
This module contains the code to produce an ordered directed graph of a
6
5
window.
7
6
"""
8
7
 
9
 
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
8
__copyright__ = "Copyright 2005 Canonical Ltd."
10
9
__author__    = "Scott James Remnant <scott@ubuntu.com>"
11
10
 
12
11
from bzrlib.revision import NULL_REVISION
13
12
from bzrlib.tsort import merge_sort
14
 
 
15
 
def linegraph(repository, start_revs, maxnum, broken_line_length = None,
16
 
              graph_data = True, mainline_only = False):
 
13
from bzrlib import ui
 
14
 
 
15
 
 
16
def linegraph(graph, start_revs, maxnum=None, broken_line_length=None,
 
17
              graph_data=True, mainline_only=False, root_progress=None):
17
18
    """Produce a directed graph of a bzr repository.
18
19
 
19
20
    Returns a tuple of (line_graph, revid_index, columns_len) where
26
27
    * revid_index is a dict of each revision with the key being the revid, and
27
28
      the value the row index, and
28
29
    * columns_len is the number of columns need to draw the line graph.
29
 
    
 
30
 
30
31
 
31
32
    Node is a tuple of (column, colour) with column being a zero-indexed
32
33
    column number of the graph that this revision represents and colour
42
43
    It's up to you how to actually draw the nodes and lines (straight,
43
44
    curved, kinked, etc.) and to pick the actual colours for each index.
44
45
    """
45
 
    
46
 
    graph = repository.get_graph()
 
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(None, step_number)
 
51
 
47
52
    graph_parents = {}
48
53
    ghosts = set()
49
54
    graph_children = {}
50
 
    for (revid, parent_revids) in graph.iter_ancestry(start_revs):
51
 
        if parent_revids is None:
52
 
            ghosts.add(revid)
53
 
            continue
54
 
        if parent_revids == (NULL_REVISION,):
55
 
            graph_parents[revid] = ()
56
 
        else:
57
 
            graph_parents[revid] = parent_revids
58
 
        for parent in parent_revids:
59
 
            graph_children.setdefault(parent, []).append(revid)
60
 
        graph_children.setdefault(revid, [])
61
 
    for ghost in ghosts:
62
 
        for ghost_child in graph_children[ghost]:
63
 
            graph_parents[ghost_child] = [p for p in graph_parents[ghost_child]
64
 
                                          if p not in ghosts]
 
55
    update_root_progress(1)
 
56
    progress_bar = ui.ui_factory.nested_progress_bar()
 
57
    try:
 
58
        progress_bar.update("Arranging tree fragments")
 
59
        for i, (revid, parent_revids) in enumerate(graph.iter_ancestry(start_revs)):
 
60
            if i % 25 == 0:
 
61
                progress_bar.tick()
 
62
            if parent_revids is None:
 
63
                ghosts.add(revid)
 
64
                continue
 
65
            if parent_revids == (NULL_REVISION,):
 
66
                graph_parents[revid] = ()
 
67
            else:
 
68
                graph_parents[revid] = parent_revids
 
69
            for parent in parent_revids:
 
70
                graph_children.setdefault(parent, []).append(revid)
 
71
            graph_children.setdefault(revid, [])
 
72
    finally:
 
73
        progress_bar.finished()
 
74
 
 
75
    update_root_progress(2)
 
76
    progress_bar = ui.ui_factory.nested_progress_bar()
 
77
    try:
 
78
        progress_bar.update("Removing ghosts", 0, len(ghosts))
 
79
        for i, ghost in enumerate(ghosts):
 
80
            if i % 25 == 0:
 
81
                progress_bar.update(None, i)
 
82
            for ghost_child in graph_children[ghost]:
 
83
                graph_parents[ghost_child] = [p for p in graph_parents[ghost_child]
 
84
                                              if p not in ghosts]
 
85
    finally:
 
86
        progress_bar.finished()
65
87
    graph_parents["top:"] = start_revs
66
88
 
67
89
    if len(graph_parents)>0:
71
93
            generate_revno=True)
72
94
    else:
73
95
        merge_sorted_revisions = ()
74
 
    
 
96
 
75
97
    if mainline_only:
76
98
        merge_sorted_revisions = [elem for elem in merge_sorted_revisions \
77
99
                                  if len(elem[3])==1 ]
78
100
 
79
101
    assert merge_sorted_revisions[0][1] == "top:"
80
102
    merge_sorted_revisions = merge_sorted_revisions[1:]
81
 
    
 
103
 
82
104
    revid_index = {}
83
105
    revno_index = {}
84
 
    
 
106
 
85
107
    # This will hold an item for each "branch". For a revisions, the revsion
86
108
    # number less the least significant digit is the branch_id, and used as the
87
109
    # key for the dict. Hence revision with the same revsion number less the
90
112
    # and these two revisions will be in the same branch line. Each value is
91
113
    # a list of rev_indexes in the branch.
92
114
    branch_lines = {}
93
 
    
94
 
    linegraph = []    
95
 
    
96
 
    for (rev_index, (sequence_number,
97
 
                     revid,
98
 
                     merge_depth,
99
 
                     revno_sequence,
100
 
                     end_of_merge)) in enumerate(merge_sorted_revisions):
101
 
        if maxnum and rev_index >= maxnum:
102
 
            break
103
 
        revid_index[revid] = rev_index
104
 
        
105
 
        parents = graph_parents[revid]
106
 
        linegraph.append([revid,
107
 
                          None,
108
 
                          [],
109
 
                          parents,
110
 
                          None,
111
 
                          revno_sequence])
112
 
        
113
 
        if graph_data:
114
 
            revno_index[revno_sequence] = rev_index
115
 
            
116
 
            branch_id = revno_sequence[0:-1]
117
 
            
118
 
            branch_line = None
119
 
            if branch_id not in branch_lines:
120
 
                branch_line = []
121
 
                branch_lines[branch_id] = branch_line
122
 
            else:
123
 
                branch_line = branch_lines[branch_id]
124
 
            
125
 
            branch_line.append(rev_index)        
 
115
 
 
116
    linegraph = []
 
117
 
 
118
    update_root_progress(3)
 
119
    progress_bar = ui.ui_factory.nested_progress_bar()
 
120
    try:
 
121
        progress_bar.update("Finding nodes", 0, len(merge_sorted_revisions))
 
122
        for (rev_index, (sequence_number,
 
123
                         revid,
 
124
                         merge_depth,
 
125
                         revno_sequence,
 
126
                         end_of_merge)) in enumerate(merge_sorted_revisions):
 
127
 
 
128
            if rev_index % 25 == 0:
 
129
                progress_bar.update(None, rev_index)
 
130
            if maxnum and rev_index >= maxnum:
 
131
                break
 
132
            revid_index[revid] = rev_index
 
133
 
 
134
            parents = graph_parents[revid]
 
135
            linegraph.append([revid,
 
136
                              None,
 
137
                              [],
 
138
                              parents,
 
139
                              None,
 
140
                              revno_sequence])
 
141
 
 
142
            if graph_data:
 
143
                revno_index[revno_sequence] = rev_index
 
144
 
 
145
                branch_id = revno_sequence[0:-1]
 
146
 
 
147
                branch_line = None
 
148
                if branch_id not in branch_lines:
 
149
                    branch_line = []
 
150
                    branch_lines[branch_id] = branch_line
 
151
                else:
 
152
                    branch_line = branch_lines[branch_id]
 
153
 
 
154
                branch_line.append(rev_index)
 
155
    finally:
 
156
        progress_bar.finished()
126
157
 
127
158
    if graph_data:
128
159
        branch_ids = branch_lines.keys()
129
 
    
 
160
 
130
161
        def branch_id_cmp(x, y):
131
162
            """Compaire branch_id's first by the number of digits, then reversed
132
163
            by their value"""
135
166
            if len_x == len_y:
136
167
                return -cmp(x, y)
137
168
            return cmp(len_x, len_y)
138
 
        
 
169
 
139
170
        branch_ids.sort(branch_id_cmp)
140
171
        # This will hold a tuple of (child_index, parent_index, col_index) for each
141
172
        # line that needs to be drawn. If col_index is not none, then the line is
148
179
        # cell allready contains a node or line. This use when deciding what column
149
180
        # to place a branch line or line in, without it overlaping something else.
150
181
        columns = [list(empty_column)]
151
 
        
152
 
        
153
 
        for branch_id in branch_ids:
154
 
            branch_line = branch_lines[branch_id]
155
 
            
156
 
            # Find the col_index for the direct parent branch. This will be the
157
 
            # starting point when looking for a free column.
158
 
            parent_col_index = 0
159
 
            parent_index = None
160
 
            if len(branch_id) > 1:
161
 
                parent_revno = branch_id[0:-1]
162
 
                if parent_revno in revno_index:
163
 
                    parent_index = revno_index[parent_revno]
164
 
                    parent_node = linegraph[parent_index][1]
165
 
                    if parent_node:
166
 
                        parent_col_index = parent_node[0]
167
 
                    
168
 
            
169
 
            col_search_order = _branch_line_col_search_order(columns,
170
 
                                                             parent_col_index)
171
 
            color = reduce(lambda x, y: x+y, branch_id, 0)
172
 
            cur_cont_line = []
173
 
            
174
 
            line_range = []
175
 
            last_rev_index = None
176
 
            for rev_index in branch_line:
177
 
                if last_rev_index:
178
 
                    if broken_line_length and \
179
 
                       rev_index - last_rev_index > broken_line_length:
180
 
                        line_range.append(last_rev_index+1)
181
 
                        line_range.append(rev_index-1)
182
 
                    else:
183
 
                        line_range.extend(range(last_rev_index+1, rev_index))
184
 
                
185
 
                line_range.append(rev_index)
186
 
                last_rev_index = rev_index
187
 
            
188
 
            if parent_index:
189
 
                if broken_line_length and \
190
 
                   parent_index - last_rev_index > broken_line_length:
191
 
                    line_range.append(last_rev_index+1)
192
 
                else:
193
 
                    line_range.extend(range(last_rev_index+1, parent_index))
194
 
            
195
 
            col_index = _find_free_column(columns,
196
 
                                          empty_column,
197
 
                                          col_search_order,
198
 
                                          line_range)
199
 
            node = (col_index, color)
200
 
            for rev_index in branch_line:
201
 
                linegraph[rev_index][1] = node
202
 
                columns[col_index][rev_index] = True
203
 
            
204
 
            for rev_index in branch_line:
205
 
                (sequence_number,
206
 
                     revid,
207
 
                     merge_depth,
208
 
                     revno_sequence,
209
 
                     end_of_merge) = merge_sorted_revisions[rev_index]
210
 
                
211
 
                linegraph[rev_index][4] = graph_children[revid]
212
 
                col_index = linegraph[rev_index][1][0]
213
 
                
214
 
                for parent_revid in graph_parents[revid]:
215
 
                    if parent_revid in revid_index:
216
 
                        
217
 
                        parent_index = revid_index[parent_revid]                            
 
182
 
 
183
 
 
184
        update_root_progress(4)
 
185
        progress_bar = ui.ui_factory.nested_progress_bar()
 
186
        try:
 
187
            progress_bar.update("Organizing edges", 0, len(branch_ids))
 
188
            for i, branch_id in enumerate(branch_ids):
 
189
                if i % 25 == 0:
 
190
                    progress_bar.update(None, i)
 
191
                branch_line = branch_lines[branch_id]
 
192
 
 
193
                # Find the col_index for the direct parent branch. This will be the
 
194
                # starting point when looking for a free column.
 
195
                parent_col_index = 0
 
196
                parent_index = None
 
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]
218
201
                        parent_node = linegraph[parent_index][1]
219
202
                        if parent_node:
220
203
                            parent_col_index = parent_node[0]
 
204
 
 
205
 
 
206
                col_search_order = _branch_line_col_search_order(columns,
 
207
                                                                 parent_col_index)
 
208
                color = reduce(lambda x, y: x+y, branch_id, 0)
 
209
                cur_cont_line = []
 
210
 
 
211
                line_range = []
 
212
                last_rev_index = None
 
213
                for rev_index in branch_line:
 
214
                    if last_rev_index:
 
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)
221
219
                        else:
222
 
                            parent_col_index = None
223
 
                        col_search_order = \
224
 
                                _line_col_search_order(columns,
225
 
                                                       parent_col_index,
226
 
                                                       col_index)
227
 
                            
228
 
                        # If this line is really long, break it.
229
 
                        if len(branch_id) > 0 and \
230
 
                           broken_line_length and \
231
 
                           parent_index - rev_index > broken_line_length:
232
 
                            child_line_col_index = \
233
 
                                _find_free_column(columns,
234
 
                                                  empty_column,
235
 
                                                  col_search_order,
236
 
                                                  (rev_index + 1,))
237
 
                            _mark_column_as_used(columns,
238
 
                                                 child_line_col_index,
239
 
                                                 (rev_index + 1,))
240
 
                            
241
 
                            # Recall _line_col_search_order to reset it back to
242
 
                            # the beging.
 
220
                            line_range.extend(range(last_rev_index+1, rev_index))
 
221
 
 
222
                    line_range.append(rev_index)
 
223
                    last_rev_index = rev_index
 
224
 
 
225
                if parent_index:
 
226
                    if broken_line_length and \
 
227
                       parent_index - last_rev_index > broken_line_length:
 
228
                        line_range.append(last_rev_index+1)
 
229
                    else:
 
230
                        line_range.extend(range(last_rev_index+1, parent_index))
 
231
 
 
232
                col_index = _find_free_column(columns,
 
233
                                              empty_column,
 
234
                                              col_search_order,
 
235
                                              line_range)
 
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
 
240
 
 
241
                for rev_index in branch_line:
 
242
                    (sequence_number,
 
243
                         revid,
 
244
                         merge_depth,
 
245
                         revno_sequence,
 
246
                         end_of_merge) = merge_sorted_revisions[rev_index]
 
247
 
 
248
                    linegraph[rev_index][4] = graph_children[revid]
 
249
                    col_index = linegraph[rev_index][1][0]
 
250
 
 
251
                    for parent_revid in graph_parents[revid]:
 
252
                        if parent_revid in revid_index:
 
253
 
 
254
                            parent_index = revid_index[parent_revid]
 
255
                            parent_node = linegraph[parent_index][1]
 
256
                            if parent_node:
 
257
                                parent_col_index = parent_node[0]
 
258
                            else:
 
259
                                parent_col_index = None
243
260
                            col_search_order = \
244
261
                                    _line_col_search_order(columns,
245
262
                                                           parent_col_index,
246
263
                                                           col_index)
247
 
                            parent_col_line_index = \
248
 
                                _find_free_column(columns,
249
 
                                                  empty_column,
250
 
                                                  col_search_order,
251
 
                                                  (parent_index - 1,))
252
 
                            _mark_column_as_used(columns,
253
 
                                                 parent_col_line_index,
254
 
                                                 (parent_index - 1,))
255
 
                            lines.append((rev_index,
256
 
                                          parent_index,
257
 
                                          (child_line_col_index,
258
 
                                           parent_col_line_index)))
259
 
                        else :
260
 
                            line_col_index = col_index
261
 
                            if parent_index - rev_index >1:
262
 
                                line_range = range(rev_index + 1, parent_index)
263
 
                                line_col_index = \
264
 
                                    _find_free_column(columns,
265
 
                                                      empty_column,
266
 
                                                      col_search_order,
267
 
                                                      line_range)
268
 
                                _mark_column_as_used(columns,
269
 
                                                     line_col_index,
270
 
                                                     line_range)
271
 
                            lines.append((rev_index,
272
 
                                          parent_index,
273
 
                                          (line_col_index,)))
274
 
        
275
 
        for (child_index, parent_index, line_col_indexes) in lines:
276
 
            (child_col_index, child_color) = linegraph[child_index][1]
277
 
            (parent_col_index, parent_color) = linegraph[parent_index][1]
278
 
            
279
 
            if len(line_col_indexes) == 1:
280
 
                if parent_index - child_index == 1:
281
 
                    linegraph[child_index][2].append(
282
 
                        (child_col_index,
283
 
                         parent_col_index,
284
 
                         parent_color))
 
264
 
 
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,
 
271
                                                      empty_column,
 
272
                                                      col_search_order,
 
273
                                                      (rev_index + 1,))
 
274
                                _mark_column_as_used(columns,
 
275
                                                     child_line_col_index,
 
276
                                                     (rev_index + 1,))
 
277
 
 
278
                                # Recall _line_col_search_order to reset it back to
 
279
                                # the beging.
 
280
                                col_search_order = \
 
281
                                        _line_col_search_order(columns,
 
282
                                                               parent_col_index,
 
283
                                                               col_index)
 
284
                                parent_col_line_index = \
 
285
                                    _find_free_column(columns,
 
286
                                                      empty_column,
 
287
                                                      col_search_order,
 
288
                                                      (parent_index - 1,))
 
289
                                _mark_column_as_used(columns,
 
290
                                                     parent_col_line_index,
 
291
                                                     (parent_index - 1,))
 
292
                                lines.append((rev_index,
 
293
                                              parent_index,
 
294
                                              (child_line_col_index,
 
295
                                               parent_col_line_index)))
 
296
                            else :
 
297
                                line_col_index = col_index
 
298
                                if parent_index - rev_index >1:
 
299
                                    line_range = range(rev_index + 1, parent_index)
 
300
                                    line_col_index = \
 
301
                                        _find_free_column(columns,
 
302
                                                          empty_column,
 
303
                                                          col_search_order,
 
304
                                                          line_range)
 
305
                                    _mark_column_as_used(columns,
 
306
                                                         line_col_index,
 
307
                                                         line_range)
 
308
                                lines.append((rev_index,
 
309
                                              parent_index,
 
310
                                              (line_col_index,)))
 
311
        finally:
 
312
            progress_bar.finished()
 
313
 
 
314
        update_root_progress(5)
 
315
        progress_bar = ui.ui_factory.nested_progress_bar()
 
316
        try:
 
317
            progress_bar.update("Prettifying graph", 0, len(lines))
 
318
            for i, (child_index, parent_index, line_col_indexes) in enumerate(lines):
 
319
                if i % 25 == 0:
 
320
                    progress_bar.update(None, i)
 
321
                (child_col_index, child_color) = linegraph[child_index][1]
 
322
                (parent_col_index, parent_color) = linegraph[parent_index][1]
 
323
 
 
324
                if len(line_col_indexes) == 1:
 
325
                    if parent_index - child_index == 1:
 
326
                        linegraph[child_index][2].append(
 
327
                            (child_col_index,
 
328
                             parent_col_index,
 
329
                             parent_color))
 
330
                    else:
 
331
                        # line from the child's column to the lines column
 
332
                        linegraph[child_index][2].append(
 
333
                            (child_col_index,
 
334
                             line_col_indexes[0],
 
335
                             parent_color))
 
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], 
 
340
                                 line_col_indexes[0],
 
341
                                 parent_color))
 
342
                        # line from the line's column to the parent's column
 
343
                        linegraph[parent_index-1][2].append(
 
344
                            (line_col_indexes[0],
 
345
                             parent_col_index,
 
346
                             parent_color))
285
347
                else:
 
348
                    # Broken line
286
349
                    # line from the child's column to the lines column
287
350
                    linegraph[child_index][2].append(
288
351
                        (child_col_index,
289
352
                         line_col_indexes[0],
290
353
                         parent_color))
291
 
                    # lines down the line's column
292
 
                    for line_part_index in range(child_index+1, parent_index-1):
293
 
                        linegraph[line_part_index][2].append(
294
 
                            (line_col_indexes[0],   
295
 
                             line_col_indexes[0],
296
 
                             parent_color))
 
354
                    # Broken line end
 
355
                    linegraph[child_index+1][2].append(
 
356
                        (line_col_indexes[0],
 
357
                         None,
 
358
                         parent_color))
 
359
 
 
360
                    # Broken line end 
 
361
                    linegraph[parent_index-2][2].append(
 
362
                        (None,
 
363
                         line_col_indexes[1],
 
364
                         parent_color))
297
365
                    # line from the line's column to the parent's column
298
366
                    linegraph[parent_index-1][2].append(
299
 
                        (line_col_indexes[0],
 
367
                        (line_col_indexes[1],
300
368
                         parent_col_index,
301
369
                         parent_color))
302
 
            else:
303
 
                # Broken line
304
 
                # line from the child's column to the lines column
305
 
                linegraph[child_index][2].append(
306
 
                    (child_col_index,
307
 
                     line_col_indexes[0],
308
 
                     parent_color))
309
 
                # Broken line end
310
 
                linegraph[child_index+1][2].append(
311
 
                    (line_col_indexes[0],
312
 
                     None,
313
 
                     parent_color))
314
 
                
315
 
                # Broken line end 
316
 
                linegraph[parent_index-2][2].append(
317
 
                    (None,
318
 
                     line_col_indexes[1],
319
 
                     parent_color))
320
 
                # line from the line's column to the parent's column
321
 
                linegraph[parent_index-1][2].append(
322
 
                    (line_col_indexes[1],
323
 
                     parent_col_index,
324
 
                     parent_color))
 
370
        finally:
 
371
            progress_bar.finished()
325
372
        return (linegraph, revid_index, len(columns))
326
373
    else:
327
374
        return (linegraph, revid_index, 0)
328
 
    
 
375
 
329
376
 
330
377
def _branch_line_col_search_order(columns, parent_col_index):
331
378
    for col_index in range(parent_col_index, len(columns)):
371
418
def _mark_column_as_used(columns, col_index, line_range):
372
419
    column = columns[col_index]
373
420
    for row_index in line_range:
374
 
        column[row_index] = True    
 
421
        column[row_index] = True
375
422
 
376
423
def same_branch(a, b):
377
424
    """Return whether we think revisions a and b are on the same branch."""