/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: 2008-06-29 15:47:30 UTC
  • mto: This revision was merged to the branch mainline in revision 519.
  • Revision ID: jelmer@samba.org-20080629154730-xfsotoxwkiytf0ph
Pass graph object rather than full repository to linegraph.

Show diffs side-by-side

added added

removed removed

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