/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: Curtis Hovey
  • Date: 2011-08-29 14:12:30 UTC
  • mto: This revision was merged to the branch mainline in revision 741.
  • Revision ID: sinzui.is@verizon.net-20110829141230-6nv7h0oxjrojb1y1
Updated hacking doc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
branchview/treeview.py
6
6
__copyright__ = "Copyright © 2005 Canonical Ltd."
7
7
__author__    = "Daniel Schierbeck <daniel.schierbeck@gmail.com>"
8
8
 
9
 
import sys
10
 
import string
11
 
import gtk
12
 
import gobject
13
 
import pango
14
 
import re
15
 
import treemodel
 
9
from gi.repository import Gtk
 
10
from gi.repository import GObject
 
11
from gi.repository import Pango
 
12
 
16
13
from bzrlib import ui
17
 
 
18
 
from bzrlib.plugins.gtk import _i18n
19
 
from bzrlib.plugins.gtk.ui import GtkProgressBar, ProgressPanel
20
 
from linegraph import linegraph, same_branch
21
 
from graphcell import CellRendererGraph
22
 
from treemodel import TreeModel
23
14
from bzrlib.revision import NULL_REVISION
24
15
 
25
 
 
26
 
class TreeView(gtk.VBox):
 
16
from bzrlib.plugins.gtk import lock
 
17
from bzrlib.plugins.gtk.ui import ProgressPanel
 
18
from bzrlib.plugins.gtk.branchview import treemodel
 
19
from bzrlib.plugins.gtk.branchview.linegraph import linegraph, same_branch
 
20
from bzrlib.plugins.gtk.branchview.graphcell import CellRendererGraph
 
21
 
 
22
 
 
23
class TreeView(Gtk.VBox):
27
24
 
28
25
    __gproperties__ = {
29
 
        'branch': (gobject.TYPE_PYOBJECT,
 
26
        'branch': (GObject.TYPE_PYOBJECT,
30
27
                   'Branch',
31
28
                   'The Bazaar branch being visualized',
32
 
                   gobject.PARAM_CONSTRUCT_ONLY | gobject.PARAM_WRITABLE),
 
29
                   GObject.PARAM_CONSTRUCT_ONLY | GObject.PARAM_WRITABLE),
33
30
 
34
 
        'revision': (gobject.TYPE_PYOBJECT,
 
31
        'revision': (GObject.TYPE_PYOBJECT,
35
32
                     'Revision',
36
33
                     'The currently selected revision',
37
 
                     gobject.PARAM_READWRITE),
 
34
                     GObject.PARAM_READWRITE),
38
35
 
39
 
        'revision-number': (gobject.TYPE_STRING,
 
36
        'revision-number': (GObject.TYPE_STRING,
40
37
                            'Revision number',
41
38
                            'The number of the selected revision',
42
39
                            '',
43
 
                            gobject.PARAM_READABLE),
 
40
                            GObject.PARAM_READABLE),
44
41
 
45
 
        'children': (gobject.TYPE_PYOBJECT,
 
42
        'children': (GObject.TYPE_PYOBJECT,
46
43
                     'Child revisions',
47
44
                     'Children of the currently selected revision',
48
 
                     gobject.PARAM_READABLE),
 
45
                     GObject.PARAM_READABLE),
49
46
 
50
 
        'parents': (gobject.TYPE_PYOBJECT,
 
47
        'parents': (GObject.TYPE_PYOBJECT,
51
48
                    'Parent revisions',
52
49
                    'Parents to the currently selected revision',
53
 
                    gobject.PARAM_READABLE),
 
50
                    GObject.PARAM_READABLE),
54
51
 
55
 
        'revno-column-visible': (gobject.TYPE_BOOLEAN,
 
52
        'revno-column-visible': (GObject.TYPE_BOOLEAN,
56
53
                                 'Revision number column',
57
54
                                 'Show revision number column',
58
55
                                 True,
59
 
                                 gobject.PARAM_READWRITE),
 
56
                                 GObject.PARAM_READWRITE),
60
57
 
61
 
        'graph-column-visible': (gobject.TYPE_BOOLEAN,
 
58
        'graph-column-visible': (GObject.TYPE_BOOLEAN,
62
59
                                 'Graph column',
63
60
                                 'Show graph column',
64
61
                                 True,
65
 
                                 gobject.PARAM_READWRITE),
 
62
                                 GObject.PARAM_READWRITE),
66
63
 
67
 
        'date-column-visible': (gobject.TYPE_BOOLEAN,
 
64
        'date-column-visible': (GObject.TYPE_BOOLEAN,
68
65
                                 'Date',
69
66
                                 'Show date column',
70
67
                                 False,
71
 
                                 gobject.PARAM_READWRITE),
 
68
                                 GObject.PARAM_READWRITE),
72
69
 
73
 
        'compact': (gobject.TYPE_BOOLEAN,
 
70
        'compact': (GObject.TYPE_BOOLEAN,
74
71
                    'Compact view',
75
72
                    'Break ancestry lines to save space',
76
73
                    True,
77
 
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
74
                    GObject.PARAM_CONSTRUCT | GObject.PARAM_READWRITE),
78
75
 
79
 
        'mainline-only': (gobject.TYPE_BOOLEAN,
 
76
        'mainline-only': (GObject.TYPE_BOOLEAN,
80
77
                    'Mainline only',
81
78
                    'Only show the mainline history.',
82
79
                    False,
83
 
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
80
                    GObject.PARAM_CONSTRUCT | GObject.PARAM_READWRITE),
84
81
 
85
82
    }
86
83
 
87
84
    __gsignals__ = {
88
 
        'revision-selected': (gobject.SIGNAL_RUN_FIRST,
89
 
                              gobject.TYPE_NONE,
 
85
        'revision-selected': (GObject.SignalFlags.RUN_FIRST,
 
86
                              None,
90
87
                              ()),
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))
 
88
        'revision-activated': (GObject.SignalFlags.RUN_FIRST,
 
89
                              None,
 
90
                              (GObject.TYPE_PYOBJECT, GObject.TYPE_PYOBJECT)),
 
91
        'tag-added': (GObject.SignalFlags.RUN_FIRST,
 
92
                              None,
 
93
                              (GObject.TYPE_STRING, GObject.TYPE_STRING)),
 
94
        'refreshed': (GObject.SignalFlags.RUN_FIRST, None,
 
95
                              ())
97
96
    }
98
97
 
99
98
    def __init__(self, branch, start, maxnum, compact=True):
106
105
        :param broken_line_length: After how much lines to break 
107
106
                                   branches.
108
107
        """
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)
 
108
        Gtk.VBox.__init__(self, homogeneous=False, spacing=0)
 
109
 
 
110
        self.progress_widget = ProgressPanel()
 
111
        self.pack_start(self.progress_widget, False, True, 0)
 
112
        if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
 
113
            # We'are using our own ui, let's tell it to use our widget.
 
114
            ui.ui_factory.set_progress_bar_widget(self.progress_widget)
 
115
 
 
116
        self.scrolled_window = Gtk.ScrolledWindow()
 
117
        self.scrolled_window.set_policy(Gtk.PolicyType.AUTOMATIC,
 
118
                                        Gtk.PolicyType.AUTOMATIC)
 
119
        self.scrolled_window.set_shadow_type(Gtk.ShadowType.IN)
119
120
        self.scrolled_window.show()
120
 
        self.pack_start(self.scrolled_window, expand=True, fill=True)
 
121
        self.pack_start(self.scrolled_window, True, True, 0)
121
122
 
122
123
        self.scrolled_window.add(self.construct_treeview())
123
124
 
124
 
        self.iter = None
 
125
        self.path = None
125
126
        self.branch = branch
126
127
        self.revision = None
 
128
        self.index = {}
127
129
 
128
130
        self.start = start
129
131
        self.maxnum = maxnum
130
132
        self.compact = compact
131
133
 
132
 
        gobject.idle_add(self.populate)
133
 
 
134
 
        self.connect("destroy", lambda x: self.branch.unlock())
 
134
        self.model = treemodel.TreeModel(self.branch, [])
 
135
        GObject.idle_add(self.populate)
 
136
 
 
137
        self.connect("destroy", self._on_destroy)
 
138
 
 
139
    def _on_destroy(self, *ignored):
 
140
        self.branch.unlock()
 
141
        if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
 
142
            # We'are using our own ui, let's tell it to stop using our widget.
 
143
            ui.ui_factory.set_progress_bar_widget(None)
135
144
 
136
145
    def do_get_property(self, property):
137
146
        if property.name == 'revno-column-visible':
147
156
        elif property.name == 'branch':
148
157
            return self.branch
149
158
        elif property.name == 'revision':
150
 
            return self.model.get_value(self.iter, treemodel.REVISION)
 
159
            if self.path is None:
 
160
                return None
 
161
            return self.model.get_value(self.model.get_iter(self.path),
 
162
                                        treemodel.REVISION)
151
163
        elif property.name == 'revision-number':
152
 
            return self.model.get_value(self.iter, treemodel.REVNO)
 
164
            if self.path is None:
 
165
                return None
 
166
            return self.model.get_value(self.model.get_iter(self.path),
 
167
                                        treemodel.REVNO)
153
168
        elif property.name == 'children':
154
 
            return self.model.get_value(self.iter, treemodel.CHILDREN)
 
169
            if self.path is None:
 
170
                return None
 
171
            return self.model.get_value(self.model.get_iter(self.path),
 
172
                                        treemodel.CHILDREN)
155
173
        elif property.name == 'parents':
156
 
            return self.model.get_value(self.iter, treemodel.PARENTS)
 
174
            if self.path is None:
 
175
                return None
 
176
            return self.model.get_value(self.model.get_iter(self.path),
 
177
                                        treemodel.PARENTS)
157
178
        else:
158
179
            raise AttributeError, 'unknown property %s' % property.name
159
180
 
179
200
        """Return revision id of currently selected revision, or None."""
180
201
        return self.get_property('revision')
181
202
 
 
203
    def has_revision_id(self, revision_id):
 
204
        return (revision_id in self.index)
 
205
 
182
206
    def set_revision(self, revision):
183
207
        self.set_property('revision', revision)
184
208
 
187
211
 
188
212
        :param revid: Revision id of revision to display.
189
213
        """
190
 
        self.treeview.set_cursor(self.index[revid])
 
214
        self.treeview.set_cursor(
 
215
            Gtk.TreePath(path=self.index[revid]), None, False)
191
216
        self.treeview.grab_focus()
192
217
 
193
218
    def get_children(self):
207
232
    def add_tag(self, tag, revid=None):
208
233
        if revid is None: revid = self.revision.revision_id
209
234
 
210
 
        try:
211
 
            self.branch.unlock()
212
 
 
 
235
        if lock.release(self.branch):
213
236
            try:
214
 
                self.branch.lock_write()
 
237
                lock.acquire(self.branch, lock.WRITE)
215
238
                self.model.add_tag(tag, revid)
216
239
            finally:
217
 
                self.branch.unlock()
218
 
 
219
 
        finally:
220
 
            self.branch.lock_read()
221
 
 
222
 
        self.emit('tag-added', tag, revid)
223
 
        
 
240
                lock.release(self.branch)
 
241
 
 
242
            lock.acquire(self.branch, lock.READ)
 
243
 
 
244
            self.emit('tag-added', tag, revid)
 
245
 
224
246
    def refresh(self):
225
 
        gobject.idle_add(self.populate, self.get_revision())
 
247
        GObject.idle_add(self.populate, self.get_revision())
226
248
 
227
249
    def update(self):
228
250
        try:
275
297
                       should be broken.
276
298
        """
277
299
 
 
300
        if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
 
301
            # We'are using our own ui, let's tell it to use our widget.
 
302
            ui.ui_factory.set_progress_bar_widget(self.progress_widget)
278
303
        self.progress_bar = ui.ui_factory.nested_progress_bar()
279
 
        self.progress_bar.update(msg="Loading ancestry graph", total_cnt=5)
 
304
        self.progress_bar.update("Loading ancestry graph", 0, 5)
280
305
 
281
306
        try:
282
307
            if self.compact:
283
308
                broken_line_length = 32
284
309
            else:
285
310
                broken_line_length = None
286
 
            
 
311
 
287
312
            show_graph = self.graph_column.get_visible()
288
313
 
289
314
            self.branch.lock_read()
295
320
                                                            self.mainline_only,
296
321
                                                            self.progress_bar)
297
322
 
298
 
            self.model = TreeModel(self.branch, linegraphdata)
 
323
            self.model.line_graph_data = linegraphdata
299
324
            self.graph_cell.columns_len = columns_len
300
 
            width = self.graph_cell.get_size(self.treeview)[2]
 
325
            width = self.graph_cell.get_preferred_width(self.treeview)[1]
301
326
            if width > 500:
302
327
                width = 500
 
328
            elif width == 0:
 
329
                # The get_preferred_width() call got an insane value.
 
330
                width = 200
303
331
            self.graph_column.set_fixed_width(width)
304
332
            self.graph_column.set_max_width(width)
305
333
            self.index = index
306
334
            self.treeview.set_model(self.model)
307
335
 
308
336
            if not revision or revision == NULL_REVISION:
309
 
                self.treeview.set_cursor(0)
 
337
                self.treeview.set_cursor(Gtk.TreePath(path=0), None, False)
310
338
            else:
311
339
                self.set_revision(revision)
312
340
 
 
341
            self.emit('refreshed')
313
342
            return False
314
343
        finally:
315
344
            self.progress_bar.finished()
316
345
 
317
346
    def construct_treeview(self):
318
 
        self.treeview = gtk.TreeView()
 
347
        self.treeview = Gtk.TreeView()
319
348
 
320
349
        self.treeview.set_rules_hint(True)
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)
327
 
 
 
350
        # combined revno/summary interactive search
 
351
        #
 
352
        # the row in a treemodel is considered "matched" if a REVNO *starts*
 
353
        # from the key (that is the key is found in a REVNO at the offset 0)
 
354
        # or if a MESSAGE *contains* the key anywhere (that is, the key is
 
355
        # found case insensitively in a MESSAGE at any offset)
 
356
        def search_equal_func(model, column, key, iter):
 
357
            return (model.get_value(iter, treemodel.REVNO).find(key) != 0
 
358
                and model.get_value(iter, treemodel.MESSAGE).lower().find(key.lower()) == -1)
 
359
 
 
360
        self.treeview.set_search_equal_func(search_equal_func, None)
 
361
        self.treeview.set_enable_search(True)
 
362
 
 
363
        self.treeview.set_tooltip_column(treemodel.MESSAGE)
 
364
 
 
365
        self._prev_cursor_path = None
328
366
        self.treeview.connect("cursor-changed",
329
367
                self._on_selection_changed)
330
368
 
338
376
 
339
377
        self.treeview.show()
340
378
 
341
 
        cell = gtk.CellRendererText()
 
379
        cell = Gtk.CellRendererText()
342
380
        cell.set_property("width-chars", 15)
343
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
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)
 
381
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
382
        self.revno_column = Gtk.TreeViewColumn("Revision No")
 
383
        self.revno_column.set_resizable(True)
 
384
        self.revno_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
385
        self.revno_column.set_fixed_width(
 
386
            cell.get_preferred_width(self.treeview)[1])
 
387
        self.revno_column.pack_start(cell, True)
349
388
        self.revno_column.add_attribute(cell, "text", treemodel.REVNO)
350
389
        self.treeview.append_column(self.revno_column)
351
390
 
352
391
        self.graph_cell = CellRendererGraph()
353
 
        self.graph_column = gtk.TreeViewColumn()
354
 
        self.graph_column.set_resizable(False)
355
 
        self.graph_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
356
 
        self.graph_column.pack_start(self.graph_cell, expand=True)
 
392
        self.graph_column = Gtk.TreeViewColumn()
 
393
        self.graph_column.set_resizable(True)
 
394
        self.graph_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
395
        self.graph_column.pack_start(self.graph_cell, True)
357
396
        self.graph_column.add_attribute(self.graph_cell, "node", treemodel.NODE)
358
397
        self.graph_column.add_attribute(self.graph_cell, "tags", treemodel.TAGS)
359
398
        self.graph_column.add_attribute(self.graph_cell, "in-lines", treemodel.LAST_LINES)
360
399
        self.graph_column.add_attribute(self.graph_cell, "out-lines", treemodel.LINES)
361
400
        self.treeview.append_column(self.graph_column)
362
401
 
363
 
        cell = gtk.CellRendererText()
 
402
        cell = Gtk.CellRendererText()
364
403
        cell.set_property("width-chars", 65)
365
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
366
 
        self.summary_column = gtk.TreeViewColumn("Summary")
367
 
        self.summary_column.set_resizable(False)
 
404
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
405
        self.summary_column = Gtk.TreeViewColumn("Summary")
 
406
        self.summary_column.set_resizable(True)
368
407
        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)
 
408
        self.summary_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
409
        self.summary_column.set_fixed_width(
 
410
            cell.get_preferred_width(self.treeview)[1])
 
411
        self.summary_column.pack_start(cell, True)
372
412
        self.summary_column.add_attribute(cell, "markup", treemodel.SUMMARY)
373
413
        self.treeview.append_column(self.summary_column)
374
414
 
375
 
        cell = gtk.CellRendererText()
 
415
        cell = Gtk.CellRendererText()
376
416
        cell.set_property("width-chars", 15)
377
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
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)
 
417
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
418
        self.authors_column = Gtk.TreeViewColumn("Author(s)")
 
419
        self.authors_column.set_resizable(False)
 
420
        self.authors_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
421
        self.authors_column.set_fixed_width(200)
 
422
        self.authors_column.pack_start(cell, True)
 
423
        self.authors_column.add_attribute(cell, "text", treemodel.AUTHORS)
 
424
        self.treeview.append_column(self.authors_column)
385
425
 
386
 
        cell = gtk.CellRendererText()
 
426
        cell = Gtk.CellRendererText()
387
427
        cell.set_property("width-chars", 20)
388
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
389
 
        self.date_column = gtk.TreeViewColumn("Date")
 
428
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
429
        self.date_column = Gtk.TreeViewColumn("Date")
390
430
        self.date_column.set_visible(False)
391
 
        self.date_column.set_resizable(False)
392
 
        self.date_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
431
        self.date_column.set_resizable(True)
 
432
        self.date_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
393
433
        self.date_column.set_fixed_width(130)
394
 
        self.date_column.pack_start(cell, expand=True)
 
434
        self.date_column.pack_start(cell, True)
395
435
        self.date_column.add_attribute(cell, "text", treemodel.TIMESTAMP)
396
436
        self.treeview.append_column(self.date_column)
397
 
        
 
437
 
398
438
        return self.treeview
399
 
    
 
439
 
400
440
    def _on_selection_changed(self, treeview):
401
441
        """callback for when the treeview changes."""
402
442
        (path, focus) = treeview.get_cursor()
403
 
        if path is not None:
404
 
            self.iter = self.model.get_iter(path)
 
443
        if (path is not None) and (path != self._prev_cursor_path):
 
444
            self._prev_cursor_path = path # avoid emitting twice per click
 
445
            self.path = path
405
446
            self.emit('revision-selected')
406
447
 
407
448
    def _on_revision_selected(self, widget, event):
408
 
        from bzrlib.plugins.gtk.revisionmenu import RevisionPopupMenu
 
449
        from bzrlib.plugins.gtk.revisionmenu import RevisionMenu
409
450
        if event.button == 3:
410
 
            menu = RevisionPopupMenu(self.branch.repository, 
 
451
            menu = RevisionMenu(self.branch.repository, 
411
452
                [self.get_revision().revision_id],
412
453
                self.branch)
413
454
            menu.connect('tag-added', lambda w, t, r: self.add_tag(t, r))