/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-09-21 13:39:57 UTC
  • mto: (256.2.54 gtk)
  • mto: This revision was merged to the branch mainline in revision 289.
  • Revision ID: garyvdm@gmail.com-20070921133957-ucfd7ktz5igb2em9
Add NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
9
9
__copyright__ = "Copyright © 2005 Canonical Ltd."
10
10
__author__    = "Scott James Remnant <scott@ubuntu.com>"
11
11
 
12
 
from bzrlib.revision import NULL_REVISION
13
12
from bzrlib.tsort import merge_sort
14
13
 
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.
 
14
def linegraph(branch, start, maxnum):
 
15
    """Produce a directed graph of a bzr branch.
18
16
 
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
 
    
 
17
    Returns a list of tuples of (revid,
 
18
                                 node,
 
19
                                 lines,
 
20
                                 parents,
 
21
                                 children,
 
22
                                 revno_sequence).
30
23
 
31
24
    Node is a tuple of (column, colour) with column being a zero-indexed
32
25
    column number of the graph that this revision represents and colour
43
36
    curved, kinked, etc.) and to pick the actual colours for each index.
44
37
    """
45
38
    
46
 
    graph_parents = {}
47
 
    ghosts = set()
 
39
    # We get the mainline so we can pass it to merge_sort to make merge_sort
 
40
    # run faster.
 
41
    mainline = branch.revision_history()
 
42
    graph_parents = branch.repository.get_revision_graph(start)
48
43
    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:]
 
44
    for revid in graph_parents.iterkeys():
 
45
        graph_children[revid] = []
 
46
 
 
47
    merge_sorted_revisions = merge_sort(
 
48
        graph_parents,
 
49
        start,
 
50
        mainline,
 
51
        generate_revno=True)
80
52
    
81
53
    revid_index = {}
82
54
    revno_index = {}
87
59
    # least significant digit are considered to be in the same branch line.
88
60
    # e.g.: for revisions 290.12.1 and 290.12.2, the branch_id would be 290.12,
89
61
    # and these two revisions will be in the same branch line. Each value is
90
 
    # a list of rev_indexes in the branch.
 
62
    # a list of [rev_indexes, min_index, max_index, col_index].
91
63
    branch_lines = {}
 
64
    BL_REV_INDEXES = 0
 
65
    BL_MIN_INDEX = 1
 
66
    BL_MAX_INDEX = 2
 
67
    BL_COL_INDEX = 3
92
68
    
93
69
    linegraph = []    
94
70
    
97
73
                     merge_depth,
98
74
                     revno_sequence,
99
75
                     end_of_merge)) in enumerate(merge_sorted_revisions):
100
 
        if maxnum and rev_index >= maxnum:
101
 
            break
 
76
        
102
77
        revid_index[revid] = rev_index
 
78
        revno_index[revno_sequence] = rev_index
 
79
        
 
80
        branch_id = revno_sequence[0:-1]
 
81
        
 
82
        branch_line = None
 
83
        if branch_id not in branch_lines:
 
84
            branch_line = [[],        # BL_REV_INDEXES
 
85
                           rev_index, # BL_MIN_INDEX
 
86
                           0,         # BL_MAX_INDEX
 
87
                           None]      # BL_COL_INDEX
 
88
            branch_lines[branch_id] = branch_line
 
89
        else:
 
90
            branch_line = branch_lines[branch_id]
 
91
        
 
92
        branch_line[BL_REV_INDEXES].append(rev_index)
 
93
        if rev_index > branch_line[BL_MAX_INDEX]:
 
94
            branch_line[BL_MAX_INDEX] = rev_index
103
95
        
104
96
        parents = graph_parents[revid]
 
97
        for parent_revid in parents:
 
98
            graph_children[parent_revid].append(revid)
 
99
        
105
100
        linegraph.append([revid,
106
101
                          None,
107
102
                          [],
108
103
                          parents,
109
104
                          None,
110
105
                          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
106
 
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]
 
107
    branch_ids = branch_lines.keys()
 
108
    
 
109
    def branch_id_cmp(x, y):
 
110
        """Compaire branch_id's first by the number of digits, then reversed
 
111
        by their value"""
 
112
        len_x = len(x)
 
113
        len_y = len(y)
 
114
        if len_x == len_y:
 
115
            return -cmp(x, y)
 
116
        return cmp(len_x, len_y)
 
117
    
 
118
    branch_ids.sort(branch_id_cmp)
 
119
    # This will hold a tuple of (child_index, parent_index, col_index) for each
 
120
    # line that needs to be drawn. If col_index is not none, then the line is
 
121
    # drawn along that column, else the the line can be drawn directly between
 
122
    # the child and parent because either the child and parent are in the same
 
123
    # branch line, or the child and parent are 1 row apart.
 
124
    lines = []
 
125
    empty_column = [False for i in range(len(graph_parents))]
 
126
    # This will hold a bit map for each cell. If the cell is true, then the
 
127
    # cell allready contains a node or line. This use when deciding what column
 
128
    # to place a branch line or line in, without it overlaping something else.
 
129
    columns = [list(empty_column)]
 
130
    
 
131
    
 
132
    for branch_id in branch_ids:
 
133
        branch_line = branch_lines[branch_id]
 
134
        
 
135
        # Find the col_index for the direct parent branch. This will be the
 
136
        # starting point when looking for a free column.
 
137
        parent_col_index = 0
 
138
        if len(branch_id) > 1:
 
139
            parent_branch_id = branch_id[0:-2]
 
140
            parent_col_index = branch_lines[parent_branch_id][BL_COL_INDEX]
 
141
            parent_revno = branch_id[0:-1]
 
142
            if parent_revno in revno_index:
 
143
                parent_index = revno_index[parent_revno]
 
144
                branch_line[BL_MAX_INDEX] = parent_index - 1
 
145
        
 
146
        col_search_order = _branch_line_col_search_order(columns,
 
147
                                                         parent_col_index)
 
148
        branch_line[BL_COL_INDEX] = _append_line(columns,
 
149
                                                (branch_line[BL_MIN_INDEX],
 
150
                                                 branch_line[BL_MAX_INDEX]),
 
151
                                                empty_column,
 
152
                                                col_search_order)
 
153
        color = reduce(lambda x, y: x+y, branch_id, 0)
 
154
        col_index = branch_line[BL_COL_INDEX]
 
155
        node = (col_index, color)        
 
156
        
 
157
        for rev_index in branch_line[BL_REV_INDEXES]:
 
158
            (sequence_number,
 
159
                 revid,
 
160
                 merge_depth,
 
161
                 revno_sequence,
 
162
                 end_of_merge) = merge_sorted_revisions[rev_index]
 
163
            
 
164
            linegraph[rev_index][1] = node
 
165
            linegraph[rev_index][4] = graph_children[revid]
 
166
            
 
167
            for parent_revid in graph_parents[revid]:
 
168
                if parent_revid in revid_index:
 
169
                    parent_index = revid_index[parent_revid]
 
170
                    parent_revno = merge_sorted_revisions[parent_index][3]
 
171
                    parent_branch_id = parent_revno[0:-1]
 
172
                    col_index = None
 
173
                    is_direct_parent_line = False
 
174
                    if len(branch_id) > 1:
 
175
                        if parent_revno == branch_id[0:-1]:
 
176
                            is_direct_parent_line = True
166
177
                    
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]                            
 
178
                    # A line only needs it's own column if it is going from
 
179
                    # one branch line to another, it's not the line to the
 
180
                    # direct parent, and if it is longer than one row.
 
181
                    if branch_id != parent_branch_id and \
 
182
                       parent_index - rev_index > 1 and \
 
183
                       not is_direct_parent_line:
217
184
                        parent_node = linegraph[parent_index][1]
218
185
                        if parent_node:
219
186
                            parent_col_index = parent_node[0]
222
189
                        col_search_order = \
223
190
                                _line_col_search_order(columns,
224
191
                                                       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
 
    
 
192
                                                       branch_line[BL_COL_INDEX])
 
193
                        col_index = _append_line(columns,
 
194
                                                 (rev_index+1, parent_index-1),
 
195
                                                 empty_column,
 
196
                                                 col_search_order)
 
197
                    lines.append((rev_index, parent_index, col_index))
 
198
    
 
199
    for (child_index, parent_index, line_col_index) in lines:
 
200
        child_col_index = linegraph[child_index][1][0]
 
201
        
 
202
        parent_node = linegraph[parent_index][1]
 
203
        parent_col_index = parent_node[0]
 
204
        color = parent_node[1]
 
205
        
 
206
        if line_col_index:
 
207
            # line from the child's column to the lines column
 
208
            linegraph[child_index][2].append(
 
209
                (child_col_index,
 
210
                 line_col_index,
 
211
                 color))
 
212
            # lines down the line's column
 
213
            for line_part_index in range(child_index+1, parent_index-1):
 
214
                linegraph[line_part_index][2].append(
 
215
                    (line_col_index,   
 
216
                     line_col_index,
 
217
                     color))
 
218
            # line from the line's column to the parent's column
 
219
            linegraph[parent_index-1][2].append(
 
220
                (line_col_index,
 
221
                 parent_col_index,
 
222
                 color))
 
223
        else:
 
224
            # lines down the child's column
 
225
            for line_part_index in range(child_index, parent_index-1):
 
226
                linegraph[line_part_index][2].append(
 
227
                    (child_col_index,   
 
228
                     child_col_index,
 
229
                     color))
 
230
            # line from the child's column to the parent's column
 
231
            linegraph[parent_index-1][2].append(
 
232
                (child_col_index,
 
233
                 parent_col_index,
 
234
                 color))
 
235
    
 
236
    return (linegraph, revid_index)
328
237
 
329
238
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
 
239
    return range(parent_col_index, len(columns)) + \
 
240
           range(parent_col_index-1, -1, -1)
334
241
 
335
242
def _line_col_search_order(columns, parent_col_index, child_col_index):
 
243
    dest_col_indexes = []
336
244
    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
 
245
        dest_col_indexes.append(parent_col_index)
341
246
    else:
342
 
        max_index = child_col_index
343
 
        min_index = child_col_index
344
 
        yield child_col_index
 
247
        dest_col_indexes.append(child_col_index)
 
248
    dest_col_indexes.append(child_col_index)
 
249
    dest_col_indexes.sort()
 
250
    col_search_order = range(dest_col_indexes[1], dest_col_indexes[0] -1, -1) 
345
251
    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
 
252
    while dest_col_indexes[1] + i < len(columns) or \
 
253
          dest_col_indexes[0] - i > -1:
 
254
        if dest_col_indexes[1] + i < len(columns):
 
255
            col_search_order.append(dest_col_indexes[1] + i)
 
256
        if dest_col_indexes[0] - i > -1:
 
257
            col_search_order.append(dest_col_indexes[0] - i)
352
258
        i += 1
 
259
    return col_search_order
353
260
 
354
 
def _find_free_column(columns, empty_column, col_search_order, line_range):
 
261
def _append_line(columns, line, empty_column, col_search_order):
 
262
    line_range = range(line[0], line[1]+1)
 
263
    
355
264
    for col_index in col_search_order:
356
265
        column = columns[col_index]
357
266
        has_overlaping_line = False
365
274
        col_index = len(columns)
366
275
        column = list(empty_column)
367
276
        columns.append(column)
 
277
    
 
278
    for row_index in line_range:
 
279
        column[row_index] = True
368
280
    return col_index
369
281
 
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
282
def same_branch(a, b):
376
283
    """Return whether we think revisions a and b are on the same branch."""
377
284
    if len(a.parent_ids) == 1: