/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-03-09 13:47:52 UTC
  • mto: This revision was merged to the branch mainline in revision 447.
  • Revision ID: jelmer@samba.org-20080309134752-syf9kwzy6e919jhj
Add note about python-nautilus requiring a libpythonXX.so symlink.

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