/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: Javier Derderian
  • Date: 2008-04-11 20:34:06 UTC
  • mto: (465.1.1 gtk.patch)
  • mto: This revision was merged to the branch mainline in revision 466.
  • Revision ID: javierder@gmail.com-20080411203406-ftlwyodw9vr87olv
Updated "Compare with..." (#78765) to use revbrowser.RevisionBrowser.
Also needed to fix #215872 to make it work.

Show diffs side-by-side

added added

removed removed

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