/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 viz/linegraph.py

  • Committer: Jelmer Vernooij
  • Date: 2007-12-21 20:20:37 UTC
  • mto: This revision was merged to the branch mainline in revision 422.
  • Revision ID: jelmer@samba.org-20071221202037-6zvbwefvrte3e2zy
Fix URL.

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