/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/treeview.py

  • Committer: Jelmer Vernooij
  • Date: 2008-06-29 18:12:29 UTC
  • mto: This revision was merged to the branch mainline in revision 519.
  • Revision ID: jelmer@samba.org-20080629181229-1l2m4cf7vvbyh8qg
Simplify progress bar code, use embedded progress bar inside viz window.

Show diffs side-by-side

added added

removed removed

Lines of Context:
branchview/treeview.py
3
3
 
4
4
"""
5
5
 
6
 
__copyright__ = "Copyright � 2005 Canonical Ltd."
 
6
__copyright__ = "Copyright © 2005 Canonical Ltd."
7
7
__author__    = "Daniel Schierbeck <daniel.schierbeck@gmail.com>"
8
8
 
9
9
import sys
13
13
import pango
14
14
import re
15
15
import treemodel
 
16
from bzrlib import ui
16
17
 
 
18
from bzrlib.plugins.gtk import _i18n
 
19
from bzrlib.plugins.gtk.ui import GtkProgressBar, ProgressPanel
17
20
from linegraph import linegraph, same_branch
18
21
from graphcell import CellRendererGraph
19
22
from treemodel import TreeModel
20
 
 
21
 
class TreeView(gtk.ScrolledWindow):
 
23
from bzrlib.revision import NULL_REVISION
 
24
 
 
25
 
 
26
class TreeView(gtk.VBox):
 
27
 
 
28
    __gproperties__ = {
 
29
        'branch': (gobject.TYPE_PYOBJECT,
 
30
                   'Branch',
 
31
                   'The Bazaar branch being visualized',
 
32
                   gobject.PARAM_CONSTRUCT_ONLY | gobject.PARAM_WRITABLE),
 
33
 
 
34
        'revision': (gobject.TYPE_PYOBJECT,
 
35
                     'Revision',
 
36
                     'The currently selected revision',
 
37
                     gobject.PARAM_READWRITE),
 
38
 
 
39
        'revision-number': (gobject.TYPE_STRING,
 
40
                            'Revision number',
 
41
                            'The number of the selected revision',
 
42
                            '',
 
43
                            gobject.PARAM_READABLE),
 
44
 
 
45
        'children': (gobject.TYPE_PYOBJECT,
 
46
                     'Child revisions',
 
47
                     'Children of the currently selected revision',
 
48
                     gobject.PARAM_READABLE),
 
49
 
 
50
        'parents': (gobject.TYPE_PYOBJECT,
 
51
                    'Parent revisions',
 
52
                    'Parents to the currently selected revision',
 
53
                    gobject.PARAM_READABLE),
 
54
 
 
55
        'revno-column-visible': (gobject.TYPE_BOOLEAN,
 
56
                                 'Revision number column',
 
57
                                 'Show revision number column',
 
58
                                 True,
 
59
                                 gobject.PARAM_READWRITE),
 
60
 
 
61
        'graph-column-visible': (gobject.TYPE_BOOLEAN,
 
62
                                 'Graph column',
 
63
                                 'Show graph column',
 
64
                                 True,
 
65
                                 gobject.PARAM_READWRITE),
 
66
 
 
67
        'date-column-visible': (gobject.TYPE_BOOLEAN,
 
68
                                 'Date',
 
69
                                 'Show date column',
 
70
                                 False,
 
71
                                 gobject.PARAM_READWRITE),
 
72
 
 
73
        'compact': (gobject.TYPE_BOOLEAN,
 
74
                    'Compact view',
 
75
                    'Break ancestry lines to save space',
 
76
                    True,
 
77
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
78
 
 
79
        'mainline-only': (gobject.TYPE_BOOLEAN,
 
80
                    'Mainline only',
 
81
                    'Only show the mainline history.',
 
82
                    False,
 
83
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
84
 
 
85
    }
22
86
 
23
87
    __gsignals__ = {
24
 
            'revisions-loaded': (gobject.SIGNAL_RUN_FIRST, 
25
 
                                 gobject.TYPE_NONE,
26
 
                                 ()),
27
 
            'revision-selected': (gobject.SIGNAL_RUN_FIRST,
28
 
                                  gobject.TYPE_NONE,
29
 
                                  ())
 
88
        'revision-selected': (gobject.SIGNAL_RUN_FIRST,
 
89
                              gobject.TYPE_NONE,
 
90
                              ()),
 
91
        'revision-activated': (gobject.SIGNAL_RUN_FIRST,
 
92
                              gobject.TYPE_NONE,
 
93
                              (gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT)),
 
94
        'tag-added': (gobject.SIGNAL_RUN_FIRST,
 
95
                              gobject.TYPE_NONE,
 
96
                              (gobject.TYPE_STRING, gobject.TYPE_STRING))
30
97
    }
31
98
 
32
 
    def __init__(self, branch, start, maxnum):
33
 
        gtk.ScrolledWindow.__init__(self)
34
 
 
35
 
        self.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
36
 
        self.set_shadow_type(gtk.SHADOW_IN)
37
 
 
38
 
        self.construct_treeview()
39
 
 
 
99
    def __init__(self, branch, start, maxnum, compact=True):
 
100
        """Create a new TreeView.
 
101
 
 
102
        :param branch: Branch object for branch to show.
 
103
        :param start: Revision id of top revision.
 
104
        :param maxnum: Maximum number of revisions to display, 
 
105
                       None for no limit.
 
106
        :param broken_line_length: After how much lines to break 
 
107
                                   branches.
 
108
        """
 
109
        gtk.VBox.__init__(self, spacing=0)
 
110
 
 
111
        loading_msg_widget = ProgressPanel()
 
112
        ui.ui_factory.set_nested_progress_bar_widget(loading_msg_widget.get_progress_bar)
 
113
        self.pack_start(loading_msg_widget, expand=False, fill=True)
 
114
 
 
115
        self.scrolled_window = gtk.ScrolledWindow()
 
116
        self.scrolled_window.set_policy(gtk.POLICY_AUTOMATIC,
 
117
                                        gtk.POLICY_AUTOMATIC)
 
118
        self.scrolled_window.set_shadow_type(gtk.SHADOW_IN)
 
119
        self.scrolled_window.show()
 
120
        self.pack_start(self.scrolled_window, expand=True, fill=True)
 
121
 
 
122
        self.scrolled_window.add(self.construct_treeview())
 
123
 
 
124
        self.iter = None
40
125
        self.branch = branch
41
 
        self.branch.lock_read()
42
 
 
43
 
        gobject.idle_add(self.populate, start, maxnum)
44
 
 
45
126
        self.revision = None
46
 
        self.children = None
47
 
        self.parents  = None
48
 
 
49
 
        self.connect('destroy', lambda w: self.branch.unlock())
 
127
 
 
128
        self.start = start
 
129
        self.maxnum = maxnum
 
130
        self.compact = compact
 
131
 
 
132
        gobject.idle_add(self.populate)
 
133
 
 
134
        self.connect("destroy", lambda x: self.branch.unlock())
 
135
 
 
136
    def do_get_property(self, property):
 
137
        if property.name == 'revno-column-visible':
 
138
            return self.revno_column.get_visible()
 
139
        elif property.name == 'graph-column-visible':
 
140
            return self.graph_column.get_visible()
 
141
        elif property.name == 'date-column-visible':
 
142
            return self.date_column.get_visible()
 
143
        elif property.name == 'compact':
 
144
            return self.compact
 
145
        elif property.name == 'mainline-only':
 
146
            return self.mainline_only
 
147
        elif property.name == 'branch':
 
148
            return self.branch
 
149
        elif property.name == 'revision':
 
150
            return self.model.get_value(self.iter, treemodel.REVISION)
 
151
        elif property.name == 'revision-number':
 
152
            return self.model.get_value(self.iter, treemodel.REVNO)
 
153
        elif property.name == 'children':
 
154
            return self.model.get_value(self.iter, treemodel.CHILDREN)
 
155
        elif property.name == 'parents':
 
156
            return self.model.get_value(self.iter, treemodel.PARENTS)
 
157
        else:
 
158
            raise AttributeError, 'unknown property %s' % property.name
 
159
 
 
160
    def do_set_property(self, property, value):
 
161
        if property.name == 'revno-column-visible':
 
162
            self.revno_column.set_visible(value)
 
163
        elif property.name == 'graph-column-visible':
 
164
            self.graph_column.set_visible(value)
 
165
        elif property.name == 'date-column-visible':
 
166
            self.date_column.set_visible(value)
 
167
        elif property.name == 'compact':
 
168
            self.compact = value
 
169
        elif property.name == 'mainline-only':
 
170
            self.mainline_only = value
 
171
        elif property.name == 'branch':
 
172
            self.branch = value
 
173
        elif property.name == 'revision':
 
174
            self.set_revision_id(value.revision_id)
 
175
        else:
 
176
            raise AttributeError, 'unknown property %s' % property.name
50
177
 
51
178
    def get_revision(self):
52
 
        return self.revision
53
 
 
54
 
    def set_revision(self, revid):
 
179
        """Return revision id of currently selected revision, or None."""
 
180
        return self.get_property('revision')
 
181
 
 
182
    def set_revision(self, revision):
 
183
        self.set_property('revision', revision)
 
184
 
 
185
    def set_revision_id(self, revid):
 
186
        """Change the currently selected revision.
 
187
 
 
188
        :param revid: Revision id of revision to display.
 
189
        """
55
190
        self.treeview.set_cursor(self.index[revid])
56
191
        self.treeview.grab_focus()
57
192
 
58
193
    def get_children(self):
59
 
        return self.children
 
194
        """Return the children of the currently selected revision.
 
195
 
 
196
        :return: list of revision ids.
 
197
        """
 
198
        return self.get_property('children')
60
199
 
61
200
    def get_parents(self):
62
 
        return self.parents
 
201
        """Return the parents of the currently selected revision.
 
202
 
 
203
        :return: list of revision ids.
 
204
        """
 
205
        return self.get_property('parents')
 
206
 
 
207
    def add_tag(self, tag, revid=None):
 
208
        if revid is None: revid = self.revision.revision_id
 
209
 
 
210
        try:
 
211
            self.branch.unlock()
 
212
 
 
213
            try:
 
214
                self.branch.lock_write()
 
215
                self.model.add_tag(tag, revid)
 
216
            finally:
 
217
                self.branch.unlock()
 
218
 
 
219
        finally:
 
220
            self.branch.lock_read()
 
221
 
 
222
        self.emit('tag-added', tag, revid)
63
223
        
 
224
    def refresh(self):
 
225
        gobject.idle_add(self.populate, self.get_revision())
 
226
 
 
227
    def update(self):
 
228
        try:
 
229
            self.branch.unlock()
 
230
            try:
 
231
                self.branch.lock_write()
 
232
                self.branch.update()
 
233
            finally:
 
234
                self.branch.unlock()
 
235
        finally:
 
236
            self.branch.lock_read()
 
237
 
64
238
    def back(self):
65
 
        (path, col) = self.treeview.get_cursor()
66
 
        revision = self.model[path][treemodel.REVISION]
67
 
        parents = self.model[path][treemodel.PARENTS]
 
239
        """Signal handler for the Back button."""
 
240
        parents = self.get_parents()
68
241
        if not len(parents):
69
242
            return
70
243
 
71
244
        for parent_id in parents:
72
245
            parent_index = self.index[parent_id]
73
246
            parent = self.model[parent_index][treemodel.REVISION]
74
 
            if same_branch(revision, parent):
75
 
                self.treeview.set_cursor(parent_index)
 
247
            if same_branch(self.get_revision(), parent):
 
248
                self.set_revision(parent)
76
249
                break
77
250
        else:
78
 
            self.treeview.set_cursor(self.index[parents[0]])
79
 
        self.treeview.grab_focus()
 
251
            self.set_revision_id(parents[0])
80
252
 
81
253
    def forward(self):
82
 
        (path, col) = self.treeview.get_cursor()
83
 
        revision = self.model[path][treemodel.REVISION]
84
 
        children = self.model[path][treemodel.CHILDREN]
 
254
        """Signal handler for the Forward button."""
 
255
        children = self.get_children()
85
256
        if not len(children):
86
257
            return
87
258
 
88
259
        for child_id in children:
89
260
            child_index = self.index[child_id]
90
261
            child = self.model[child_index][treemodel.REVISION]
91
 
            if same_branch(child, revision):
92
 
                self.treeview.set_cursor(child_index)
 
262
            if same_branch(child, self.get_revision()):
 
263
                self.set_revision(child)
93
264
                break
94
265
        else:
95
 
            self.treeview.set_cursor(self.index[children[0]])
96
 
        self.treeview.grab_focus()
97
 
 
98
 
    def populate(self, start, maxnum):
99
 
        (linegraphdata, index, columns_len) = linegraph(self.branch,
100
 
                                                        start,
101
 
                                                        maxnum)
102
 
 
103
 
        self.model = TreeModel(self.branch, linegraphdata)
104
 
        self.graph_cell.columns_len = columns_len
105
 
        width = self.graph_cell.get_size(self.treeview)[2]
106
 
        self.graph_column.set_fixed_width(width)
107
 
        self.graph_column.set_max_width(width)
108
 
        self.index = index
109
 
        self.treeview.set_model(self.model)
110
 
        self.treeview.set_cursor(0)
111
 
        self.emit('revisions-loaded')
112
 
 
113
 
        return False
114
 
 
115
 
    def show_diff(self, branch, revid, parentid):
116
 
        """Open a new window to show a diff between the given revisions."""
117
 
        from bzrlib.plugins.gtk.diff import DiffWindow
118
 
        window = DiffWindow(parent=self)
119
 
        (parent_tree, rev_tree) = branch.repository.revision_trees([parentid, 
120
 
                                                                   revid])
121
 
        description = revid + " - " + branch.nick
122
 
        window.set_diff(description, rev_tree, parent_tree)
123
 
        window.show()
 
266
            self.set_revision_id(children[0])
 
267
 
 
268
    def populate(self, revision=None):
 
269
        """Fill the treeview with contents.
 
270
 
 
271
        :param start: Revision id of revision to start with.
 
272
        :param maxnum: Maximum number of revisions to display, or None 
 
273
                       for no limit.
 
274
        :param broken_line_length: After how much lines branches \
 
275
                       should be broken.
 
276
        """
 
277
 
 
278
        self.progress_bar = ui.ui_factory.nested_progress_bar()
 
279
        self.progress_bar.update(msg="Loading ancestry graph", total_cnt=5)
 
280
 
 
281
        try:
 
282
            if self.compact:
 
283
                broken_line_length = 32
 
284
            else:
 
285
                broken_line_length = None
 
286
            
 
287
            show_graph = self.graph_column.get_visible()
 
288
 
 
289
            self.branch.lock_read()
 
290
            (linegraphdata, index, columns_len) = linegraph(self.branch.repository.get_graph(),
 
291
                                                            self.start,
 
292
                                                            self.maxnum, 
 
293
                                                            broken_line_length,
 
294
                                                            show_graph,
 
295
                                                            self.mainline_only,
 
296
                                                            self.progress_bar)
 
297
 
 
298
            self.model = TreeModel(self.branch, linegraphdata)
 
299
            self.graph_cell.columns_len = columns_len
 
300
            width = self.graph_cell.get_size(self.treeview)[2]
 
301
            if width > 500:
 
302
                width = 500
 
303
            self.graph_column.set_fixed_width(width)
 
304
            self.graph_column.set_max_width(width)
 
305
            self.index = index
 
306
            self.treeview.set_model(self.model)
 
307
 
 
308
            if not revision or revision == NULL_REVISION:
 
309
                self.treeview.set_cursor(0)
 
310
            else:
 
311
                self.set_revision(revision)
 
312
 
 
313
            return False
 
314
        finally:
 
315
            self.progress_bar.finished()
124
316
 
125
317
    def construct_treeview(self):
126
318
        self.treeview = gtk.TreeView()
127
319
 
128
320
        self.treeview.set_rules_hint(True)
129
 
        self.treeview.set_search_column(4)
 
321
        self.treeview.set_search_column(treemodel.REVNO)
 
322
        
 
323
        # Fix old PyGTK bug - by JAM
 
324
        set_tooltip = getattr(self.treeview, 'set_tooltip_column', None)
 
325
        if set_tooltip is not None:
 
326
            set_tooltip(treemodel.MESSAGE)
130
327
 
131
 
        self.treeview.get_selection().connect("changed",
 
328
        self.treeview.connect("cursor-changed",
132
329
                self._on_selection_changed)
133
330
 
134
331
        self.treeview.connect("row-activated", 
139
336
 
140
337
        self.treeview.set_property('fixed-height-mode', True)
141
338
 
142
 
        self.add(self.treeview)
143
339
        self.treeview.show()
144
340
 
145
341
        cell = gtk.CellRendererText()
146
342
        cell.set_property("width-chars", 15)
147
343
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
148
 
        column = gtk.TreeViewColumn("Revision No")
149
 
        column.set_resizable(True)
150
 
        column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
151
 
        column.set_fixed_width(cell.get_size(self.treeview)[2])
152
 
        column.pack_start(cell, expand=True)
153
 
        column.add_attribute(cell, "text", treemodel.REVNO)
154
 
        self.treeview.append_column(column)
 
344
        self.revno_column = gtk.TreeViewColumn("Revision No")
 
345
        self.revno_column.set_resizable(False)
 
346
        self.revno_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
347
        self.revno_column.set_fixed_width(cell.get_size(self.treeview)[2])
 
348
        self.revno_column.pack_start(cell, expand=True)
 
349
        self.revno_column.add_attribute(cell, "text", treemodel.REVNO)
 
350
        self.treeview.append_column(self.revno_column)
155
351
 
156
352
        self.graph_cell = CellRendererGraph()
157
353
        self.graph_column = gtk.TreeViewColumn()
158
 
        self.graph_column.set_resizable(True)
 
354
        self.graph_column.set_resizable(False)
159
355
        self.graph_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
160
 
        self.graph_column.pack_start(self.graph_cell, expand=False)
 
356
        self.graph_column.pack_start(self.graph_cell, expand=True)
161
357
        self.graph_column.add_attribute(self.graph_cell, "node", treemodel.NODE)
 
358
        self.graph_column.add_attribute(self.graph_cell, "tags", treemodel.TAGS)
162
359
        self.graph_column.add_attribute(self.graph_cell, "in-lines", treemodel.LAST_LINES)
163
360
        self.graph_column.add_attribute(self.graph_cell, "out-lines", treemodel.LINES)
164
361
        self.treeview.append_column(self.graph_column)
166
363
        cell = gtk.CellRendererText()
167
364
        cell.set_property("width-chars", 65)
168
365
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
169
 
        column = gtk.TreeViewColumn("Message")
170
 
        column.set_resizable(True)
171
 
        column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
172
 
        column.set_fixed_width(cell.get_size(self.treeview)[2])
173
 
        column.pack_start(cell, expand=True)
174
 
        column.add_attribute(cell, "text", treemodel.MESSAGE)
175
 
        self.treeview.append_column(column)
 
366
        self.summary_column = gtk.TreeViewColumn("Summary")
 
367
        self.summary_column.set_resizable(False)
 
368
        self.summary_column.set_expand(True)
 
369
        self.summary_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
370
        self.summary_column.set_fixed_width(cell.get_size(self.treeview)[2])
 
371
        self.summary_column.pack_start(cell, expand=True)
 
372
        self.summary_column.add_attribute(cell, "markup", treemodel.SUMMARY)
 
373
        self.treeview.append_column(self.summary_column)
176
374
 
177
375
        cell = gtk.CellRendererText()
178
376
        cell.set_property("width-chars", 15)
179
377
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
180
 
        column = gtk.TreeViewColumn("Committer")
181
 
        column.set_resizable(True)
182
 
        column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
183
 
        column.set_fixed_width(cell.get_size(self.treeview)[2])
184
 
        column.pack_start(cell, expand=True)
185
 
        column.add_attribute(cell, "text", treemodel.COMMITER)
186
 
        self.treeview.append_column(column)
 
378
        self.committer_column = gtk.TreeViewColumn("Committer")
 
379
        self.committer_column.set_resizable(False)
 
380
        self.committer_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
381
        self.committer_column.set_fixed_width(200)
 
382
        self.committer_column.pack_start(cell, expand=True)
 
383
        self.committer_column.add_attribute(cell, "text", treemodel.COMMITTER)
 
384
        self.treeview.append_column(self.committer_column)
187
385
 
188
 
    def _on_selection_changed(self, selection, *args):
 
386
        cell = gtk.CellRendererText()
 
387
        cell.set_property("width-chars", 20)
 
388
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
 
389
        self.date_column = gtk.TreeViewColumn("Date")
 
390
        self.date_column.set_visible(False)
 
391
        self.date_column.set_resizable(False)
 
392
        self.date_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
393
        self.date_column.set_fixed_width(130)
 
394
        self.date_column.pack_start(cell, expand=True)
 
395
        self.date_column.add_attribute(cell, "text", treemodel.TIMESTAMP)
 
396
        self.treeview.append_column(self.date_column)
 
397
        
 
398
        return self.treeview
 
399
    
 
400
    def _on_selection_changed(self, treeview):
189
401
        """callback for when the treeview changes."""
190
 
        (model, selected_rows) = selection.get_selected_rows()
191
 
        if len(selected_rows) > 0:
192
 
            iter = self.model.get_iter(selected_rows[0])
193
 
            self.revision = self.model.get_value(iter, treemodel.REVISION)
194
 
            self.parents = self.model.get_value(iter, treemodel.PARENTS)
195
 
            self.children = self.model.get_value(iter, treemodel.CHILDREN)
196
 
 
 
402
        (path, focus) = treeview.get_cursor()
 
403
        if path is not None:
 
404
            self.iter = self.model.get_iter(path)
197
405
            self.emit('revision-selected')
198
406
 
199
407
    def _on_revision_selected(self, widget, event):
202
410
            menu = RevisionPopupMenu(self.branch.repository, 
203
411
                [self.get_revision().revision_id],
204
412
                self.branch)
 
413
            menu.connect('tag-added', lambda w, t, r: self.add_tag(t, r))
205
414
            menu.popup(None, None, None, event.button, event.get_time())
206
415
 
207
416
    def _on_revision_activated(self, widget, path, col):
208
 
        # TODO: more than one parent
209
 
        """Callback for when a treeview row gets activated."""
210
 
        revision_id = self.model[path][treemodel.REVID]
211
 
        parents = self.model[path][treemodel.PARENTS]
212
 
        if len(parents) == 0:
213
 
            # Ignore revisions without parent
214
 
            return
215
 
        parent_id = parents[0]
216
 
        self.show_diff(self.branch, revision_id, parent_id)
217
 
        self.treeview.grab_focus()
 
417
        self.emit('revision-activated', path, col)