/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: Gary van der Merwe
  • Date: 2007-08-16 13:31:29 UTC
  • mto: (256.2.37 gtk)
  • mto: This revision was merged to the branch mainline in revision 289.
  • Revision ID: garyvdm@gmail.com-20070816133129-20qwx6mad0tf6am3
Use nice Bézier curves for viz

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.revision import NULL_REVISION
13
 
from bzrlib.tsort import merge_sort
14
 
 
15
 
def linegraph(graph, start_revs, maxnum, broken_line_length = None,
16
 
              graph_data = True, mainline_only = False):
17
 
    """Produce a directed graph of a bzr repository.
18
 
 
19
 
    Returns a tuple of (line_graph, revid_index, columns_len) where
20
 
    * line_graph is a list of tuples of (revid,
21
 
                                         node,
22
 
                                         lines,
23
 
                                         parents,
24
 
                                         children,
25
 
                                         revno_sequence),
26
 
    * revid_index is a dict of each revision with the key being the revid, and
27
 
      the value the row index, and
28
 
    * columns_len is the number of columns need to draw the line graph.
29
 
    
30
 
 
31
 
    Node is a tuple of (column, colour) with column being a zero-indexed
32
 
    column number of the graph that this revision represents and colour
33
 
    being a zero-indexed colour (which doesn't specify any actual colour
34
 
    in particular) to draw the node in.
35
 
 
36
 
    Lines is a list of tuples which represent lines you should draw away
37
 
    from the revision, if you also need to draw lines into the revision
38
 
    you should use the lines list from the previous iteration.  Each
39
 
    typle in the list is in the form (start, end, colour) with start and
40
 
    end being zero-indexed column numbers and colour as in node.
41
 
 
42
 
    It's up to you how to actually draw the nodes and lines (straight,
43
 
    curved, kinked, etc.) and to pick the actual colours for each index.
44
 
    """
45
 
    
46
 
    graph_parents = {}
47
 
    ghosts = set()
48
 
    graph_children = {}
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]
64
 
    graph_parents["top:"] = start_revs
65
 
 
66
 
    if len(graph_parents)>0:
67
 
        merge_sorted_revisions = merge_sort(
68
 
            graph_parents,
69
 
            "top:",
70
 
            generate_revno=True)
71
 
    else:
72
 
        merge_sorted_revisions = ()
73
 
    
74
 
    if mainline_only:
75
 
        merge_sorted_revisions = [elem for elem in merge_sorted_revisions \
76
 
                                  if len(elem[3])==1 ]
77
 
 
78
 
    assert merge_sorted_revisions[0][1] == "top:"
79
 
    merge_sorted_revisions = merge_sorted_revisions[1:]
80
 
    
81
 
    revid_index = {}
82
 
    revno_index = {}
83
 
    
84
 
    # This will hold an item for each "branch". For a revisions, the revsion
85
 
    # number less the least significant digit is the branch_id, and used as the
86
 
    # key for the dict. Hence revision with the same revsion number less the
87
 
    # least significant digit are considered to be in the same branch line.
88
 
    # e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
89
 
    # and these two revisions will be in the same branch line. Each value is
90
 
    # a list of rev_indexes in the branch.
91
 
    branch_lines = {}
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)        
125
 
 
126
 
    if graph_data:
127
 
        branch_ids = branch_lines.keys()
128
 
    
129
 
        def branch_id_cmp(x, y):
130
 
            """Compaire branch_id's first by the number of digits, then reversed
131
 
            by their value"""
132
 
            len_x = len(x)
133
 
            len_y = len(y)
134
 
            if len_x == len_y:
135
 
                return -cmp(x, y)
136
 
            return cmp(len_x, len_y)
137
 
        
138
 
        branch_ids.sort(branch_id_cmp)
139
 
        # This will hold a tuple of (child_index, parent_index, col_index) for each
140
 
        # line that needs to be drawn. If col_index is not none, then the line is
141
 
        # drawn along that column, else the the line can be drawn directly between
142
 
        # the child and parent because either the child and parent are in the same
143
 
        # branch line, or the child and parent are 1 row apart.
144
 
        lines = []
145
 
        empty_column = [False for i in range(len(graph_parents))]
146
 
        # This will hold a bit map for each cell. If the cell is true, then the
147
 
        # cell allready contains a node or line. This use when deciding what column
148
 
        # to place a branch line or line in, without it overlaping something else.
149
 
        columns = [list(empty_column)]
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]                            
217
 
                        parent_node = linegraph[parent_index][1]
218
 
                        if parent_node:
219
 
                            parent_col_index = parent_node[0]
220
 
                        else:
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.
242
 
                            col_search_order = \
243
 
                                    _line_col_search_order(columns,
244
 
                                                           parent_col_index,
245
 
                                                           col_index)
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))
284
 
                else:
285
 
                    # line from the child's column to the lines column
286
 
                    linegraph[child_index][2].append(
287
 
                        (child_col_index,
288
 
                         line_col_indexes[0],
289
 
                         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))
296
 
                    # line from the line's column to the parent's column
297
 
                    linegraph[parent_index-1][2].append(
298
 
                        (line_col_indexes[0],
299
 
                         parent_col_index,
300
 
                         parent_color))
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))
324
 
        return (linegraph, revid_index, len(columns))
325
 
    else:
326
 
        return (linegraph, revid_index, 0)
327
 
    
328
 
 
329
 
def _branch_line_col_search_order(columns, parent_col_index):
330
 
    for col_index in range(parent_col_index, len(columns)):
331
 
        yield col_index
332
 
    for col_index in range(parent_col_index-1, -1, -1):
333
 
        yield col_index
334
 
 
335
 
def _line_col_search_order(columns, parent_col_index, child_col_index):
336
 
    if parent_col_index is not None:
337
 
        max_index = max(parent_col_index, child_col_index)
338
 
        min_index = min(parent_col_index, child_col_index)
339
 
        for col_index in range(max_index, min_index -1, -1):
340
 
            yield col_index
341
 
    else:
342
 
        max_index = child_col_index
343
 
        min_index = child_col_index
344
 
        yield child_col_index
345
 
    i = 1
346
 
    while max_index + i < len(columns) or \
347
 
          min_index - i > -1:
348
 
        if max_index + i < len(columns):
349
 
            yield max_index + i
350
 
        if min_index - i > -1:
351
 
            yield min_index - i
352
 
        i += 1
353
 
 
354
 
def _find_free_column(columns, empty_column, col_search_order, line_range):
355
 
    for col_index in col_search_order:
356
 
        column = columns[col_index]
357
 
        has_overlaping_line = False
358
 
        for row_index in line_range:
359
 
            if column[row_index]:
360
 
                has_overlaping_line = True
361
 
                break
362
 
        if not has_overlaping_line:
363
 
            break
364
 
    else:
365
 
        col_index = len(columns)
366
 
        column = list(empty_column)
367
 
        columns.append(column)
368
 
    return col_index
369
 
 
370
 
def _mark_column_as_used(columns, col_index, line_range):
371
 
    column = columns[col_index]
372
 
    for row_index in line_range:
373
 
        column[row_index] = True    
374
 
 
375
 
def same_branch(a, b):
376
 
    """Return whether we think revisions a and b are on the same branch."""
377
 
    if len(a.parent_ids) == 1:
378
 
        # Defacto same branch if only parent
379
 
        return True
380
 
    elif a.committer == b.committer:
381
 
        # Same committer so may as well be
382
 
        return True
383
 
    else:
384
 
        return False
 
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
 
 
13
from bzrlib.revision import Revision
 
14
from bzrlib.tsort import merge_sort
 
15
 
 
16
def linegraph(revisions, revisionparents, revindex):
 
17
    """Produce a directed graph of a bzr branch.
 
18
 
 
19
    Returns a list of tuples of (revision, node, lines, parents, children).
 
20
 
 
21
    Node is a tuple of (column, colour) with column being a zero-indexed
 
22
    column number of the graph that this revision represents and colour
 
23
    being a zero-indexed colour (which doesn't specify any actual colour
 
24
    in particular) to draw the node in.
 
25
 
 
26
    Lines is a list of tuples which represent lines you should draw away
 
27
    from the revision, if you also need to draw lines into the revision
 
28
    you should use the lines list from the previous iteration.  Each
 
29
    typle in the list is in the form (start, end, colour) with start and
 
30
    end being zero-indexed column numbers and colour as in node.
 
31
 
 
32
    It's up to you how to actually draw the nodes and lines (straight,
 
33
    curved, kinked, etc.) and to pick the actual colours for each index.
 
34
    """
 
35
    
 
36
    directparentcache = [None for revision in revisions]
 
37
    def getdirectparent(childindex, childsparents):
 
38
        """Return the revision id of the direct parent
 
39
        
 
40
        The direct parent is the first parent with the same committer"""
 
41
        childrevision = revisions[childindex]
 
42
        directparent = directparentcache[childindex]
 
43
        if directparent is None:
 
44
            for parentrevid in childsparents:
 
45
                parentrevision = revisions[revindex[parentrevid]]
 
46
                if childrevision.committer == parentrevision.committer:
 
47
                    directparent = parentrevid
 
48
                    break
 
49
            #no parents have the same commiter
 
50
            if directparent is None:
 
51
                directparent = ""
 
52
            directparentcache[childindex] = directparent
 
53
        return directparent
 
54
        
 
55
 
 
56
    
 
57
    #This will hold the lines we have not yet added to lines
 
58
    #The position of the item in this list indicates the column, and it
 
59
    #it may change if we need to make space for other branches.
 
60
    #Each typle in the list is in the form (child index, parent revision)
 
61
    #A item may be None to indicate that there is no line for a column
 
62
    activelines = []
 
63
    
 
64
    linegraph = []
 
65
    
 
66
    lastcolor = 0
 
67
    
 
68
    for (index, revision) in enumerate(revisions):
 
69
        parents = [parent for parent in revisionparents[index]\
 
70
                   if parent!="null:"]
 
71
        
 
72
        revnodecolumn = None
 
73
        
 
74
        #This will hold a list of lines whose parent is this rev
 
75
        linesforcurrentrev = []
 
76
        
 
77
        children = []
 
78
        
 
79
        #We should maybe should pop None's at the end of activelines.
 
80
        #I'm not sure what will cost more: resizing the list, or
 
81
        #have this loop ittrate more.
 
82
        
 
83
        #Find lines that end at this rev
 
84
        for (column, activeline) in enumerate(activelines):
 
85
            if (activeline is not None):
 
86
                (childindex, parentrevid) = activeline
 
87
                if parentrevid == revision.revision_id:
 
88
                    linesforcurrentrev.append((childindex, parentrevid, column))
 
89
                    activelines[column] = None
 
90
                    children.append(linegraph[childindex][0].revision_id)
 
91
                    
 
92
                    #The node column for this rev will be the smallest
 
93
                    #column for the lines that end at this rev
 
94
                    #The smallest column is the first one we get to.
 
95
                    if revnodecolumn is None:
 
96
                        revnodecolumn = column
 
97
        
 
98
        #This will happen for the latest revision
 
99
        if revnodecolumn is None:
 
100
            revnodecolumn = 0
 
101
        
 
102
        color = None
 
103
        
 
104
        #Try and see if we are the same "branch" as one of our children
 
105
        #If we are, use the childs color
 
106
        for childrevid in children:
 
107
            childindex = revindex[childrevid]
 
108
            childsparents = revisionparents[childindex]
 
109
            if len(children) == 1 and len(childsparents) == 1: 
 
110
                # one-one relationship between parent and child, same colour
 
111
                #1st [1] selects the node
 
112
                #2nd [1] selects the color
 
113
                color = linegraph[childindex][1][1]
 
114
                break
 
115
            
 
116
            #Is the current revision the direct parent of the child?
 
117
            if revision.revision_id == getdirectparent(childindex, childsparents):
 
118
                color = linegraph[childindex][1][1]
 
119
                break
 
120
        
 
121
        if color is None:
 
122
            color = lastcolor = lastcolor + 1
 
123
        
 
124
        #We now have every thing (except for the lines) so we can add
 
125
        #our tuple to our list.
 
126
        linegraph.append((revision, (revnodecolumn, color),
 
127
                          [], parents, children))
 
128
        
 
129
        #add all the line bits to the rev that the line passes
 
130
        for (childindex, parentrevid, column) in linesforcurrentrev:
 
131
            if index>childindex+1:
 
132
                #out from the child to line
 
133
                linegraph[childindex][2].append(
 
134
                    (linegraph[childindex][1][0], #the column of the child
 
135
                     column,                      #the column of the line
 
136
                     color))
 
137
                
 
138
                #down the line
 
139
                for linepartindex in range(childindex+1, index-1):
 
140
                    linegraph[linepartindex][2].append(
 
141
                        (column,                  #the column of the line
 
142
                         column,                  #the column of the line
 
143
                         color))
 
144
                
 
145
                #in to the parent
 
146
                linegraph[index-1][2].append(
 
147
                    (column,                      #the column of the line
 
148
                     revnodecolumn,               #the column of the parent
 
149
                     color))
 
150
            else:
 
151
                #child to parent
 
152
                linegraph[childindex][2].append(
 
153
                    (linegraph[childindex][1][0], #the column of the child
 
154
                     revnodecolumn,               #the column of the parent
 
155
                     color))
 
156
                
 
157
        for parentrevid in parents:
 
158
            column = revnodecolumn
 
159
            line = (index,parentrevid)
 
160
            while True:
 
161
                if column<len(activelines):
 
162
                    if activelines[column] is None:
 
163
                        #An empty column. Put line here
 
164
                        activelines[column] = line
 
165
                        break
 
166
                    else:
 
167
                        if activelines[column][0] == index:
 
168
                            #This column is allready used for a line for
 
169
                            #this rev, Move along.
 
170
                            column += 1
 
171
                        else:
 
172
                            #This column is allready used for a line for
 
173
                            #another rev. Insert this line at this column,
 
174
                            #and in the process, move all the other lines out.
 
175
                            activelines.insert(column, line)
 
176
                            break
 
177
                else:
 
178
                    #no more columns, so add one to the end
 
179
                    activelines.append(line)
 
180
                    break
 
181
 
 
182
    return linegraph
 
183
 
 
184
 
 
185
def same_branch(a, b):
 
186
    """Return whether we think revisions a and b are on the same branch."""
 
187
    if len(a.parent_ids) == 1:
 
188
        # Defacto same branch if only parent
 
189
        return True
 
190
    elif a.committer == b.committer:
 
191
        # Same committer so may as well be
 
192
        return True
 
193
    else:
 
194
        return False