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

  • Committer: Jelmer Vernooij
  • Date: 2007-10-24 18:03:11 UTC
  • Revision ID: jelmer@samba.org-20071024180311-f7117v3sfyw3e9sc
Add docstrings.

Show diffs side-by-side

added added

removed removed

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