/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: 2012-03-29 13:15:14 UTC
  • mfrom: (786.1.1 register-lazy)
  • Revision ID: jelmer@samba.org-20120329131514-knrl1w2wzntx89rv
Use lazy registration.

Show diffs side-by-side

added added

removed removed

Lines of Context:
branchview/treeview.py
 
1
# -*- coding: UTF-8 -*-
 
2
"""Revision history view.
 
3
 
 
4
"""
 
5
 
 
6
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
7
__author__    = "Daniel Schierbeck <daniel.schierbeck@gmail.com>"
 
8
 
 
9
from gi.repository import Gtk
 
10
from gi.repository import GObject
 
11
from gi.repository import Pango
 
12
 
 
13
from bzrlib import ui
 
14
from bzrlib.revision import NULL_REVISION
 
15
 
 
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):
 
24
 
 
25
    __gproperties__ = {
 
26
        'branch': (GObject.TYPE_PYOBJECT,
 
27
                   'Branch',
 
28
                   'The Bazaar branch being visualized',
 
29
                   GObject.PARAM_CONSTRUCT_ONLY | GObject.PARAM_WRITABLE),
 
30
 
 
31
        'revision': (GObject.TYPE_PYOBJECT,
 
32
                     'Revision',
 
33
                     'The currently selected revision',
 
34
                     GObject.PARAM_READWRITE),
 
35
 
 
36
        'revision-number': (GObject.TYPE_STRING,
 
37
                            'Revision number',
 
38
                            'The number of the selected revision',
 
39
                            '',
 
40
                            GObject.PARAM_READABLE),
 
41
 
 
42
        'children': (GObject.TYPE_PYOBJECT,
 
43
                     'Child revisions',
 
44
                     'Children of the currently selected revision',
 
45
                     GObject.PARAM_READABLE),
 
46
 
 
47
        'parents': (GObject.TYPE_PYOBJECT,
 
48
                    'Parent revisions',
 
49
                    'Parents to the currently selected revision',
 
50
                    GObject.PARAM_READABLE),
 
51
 
 
52
        'revno-column-visible': (GObject.TYPE_BOOLEAN,
 
53
                                 'Revision number column',
 
54
                                 'Show revision number column',
 
55
                                 True,
 
56
                                 GObject.PARAM_READWRITE),
 
57
 
 
58
        'graph-column-visible': (GObject.TYPE_BOOLEAN,
 
59
                                 'Graph column',
 
60
                                 'Show graph column',
 
61
                                 True,
 
62
                                 GObject.PARAM_READWRITE),
 
63
 
 
64
        'date-column-visible': (GObject.TYPE_BOOLEAN,
 
65
                                 'Date',
 
66
                                 'Show date column',
 
67
                                 False,
 
68
                                 GObject.PARAM_READWRITE),
 
69
 
 
70
        'compact': (GObject.TYPE_BOOLEAN,
 
71
                    'Compact view',
 
72
                    'Break ancestry lines to save space',
 
73
                    True,
 
74
                    GObject.PARAM_CONSTRUCT | GObject.PARAM_READWRITE),
 
75
 
 
76
        'mainline-only': (GObject.TYPE_BOOLEAN,
 
77
                    'Mainline only',
 
78
                    'Only show the mainline history.',
 
79
                    False,
 
80
                    GObject.PARAM_CONSTRUCT | GObject.PARAM_READWRITE),
 
81
 
 
82
    }
 
83
 
 
84
    __gsignals__ = {
 
85
        'revision-selected': (GObject.SignalFlags.RUN_FIRST,
 
86
                              None,
 
87
                              ()),
 
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
                              ())
 
96
    }
 
97
 
 
98
    def __init__(self, branch, start, maxnum, compact=True):
 
99
        """Create a new TreeView.
 
100
 
 
101
        :param branch: Branch object for branch to show.
 
102
        :param start: Revision id of top revision.
 
103
        :param maxnum: Maximum number of revisions to display, 
 
104
                       None for no limit.
 
105
        :param broken_line_length: After how much lines to break 
 
106
                                   branches.
 
107
        """
 
108
        super(TreeView, self).__init__(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)
 
120
        self.scrolled_window.show()
 
121
        self.pack_start(self.scrolled_window, True, True, 0)
 
122
 
 
123
        self.scrolled_window.add(self.construct_treeview())
 
124
 
 
125
        self.path = None
 
126
        self.branch = branch
 
127
        self.revision = None
 
128
        self.index = {}
 
129
 
 
130
        self.start = start
 
131
        self.maxnum = maxnum
 
132
        self.compact = compact
 
133
 
 
134
        self.model = treemodel.BranchTreeModel(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)
 
144
 
 
145
    def do_get_property(self, property):
 
146
        if property.name == 'revno-column-visible':
 
147
            return self.revno_column.get_visible()
 
148
        elif property.name == 'graph-column-visible':
 
149
            return self.graph_column.get_visible()
 
150
        elif property.name == 'date-column-visible':
 
151
            return self.date_column.get_visible()
 
152
        elif property.name == 'compact':
 
153
            return self.compact
 
154
        elif property.name == 'mainline-only':
 
155
            return self.mainline_only
 
156
        elif property.name == 'branch':
 
157
            return self.branch
 
158
        elif property.name == '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)
 
163
        elif property.name == 'revision-number':
 
164
            if self.path is None:
 
165
                return None
 
166
            return self.model.get_value(self.model.get_iter(self.path),
 
167
                                        treemodel.REVNO)
 
168
        elif property.name == '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)
 
173
        elif property.name == '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)
 
178
        else:
 
179
            raise AttributeError, 'unknown property %s' % property.name
 
180
 
 
181
    def do_set_property(self, property, value):
 
182
        if property.name == 'revno-column-visible':
 
183
            self.revno_column.set_visible(value)
 
184
        elif property.name == 'graph-column-visible':
 
185
            self.graph_column.set_visible(value)
 
186
        elif property.name == 'date-column-visible':
 
187
            self.date_column.set_visible(value)
 
188
        elif property.name == 'compact':
 
189
            self.compact = value
 
190
        elif property.name == 'mainline-only':
 
191
            self.mainline_only = value
 
192
        elif property.name == 'branch':
 
193
            self.branch = value
 
194
        elif property.name == 'revision':
 
195
            self.set_revision_id(value.revision_id)
 
196
        else:
 
197
            raise AttributeError, 'unknown property %s' % property.name
 
198
 
 
199
    def get_revision(self):
 
200
        """Return revision id of currently selected revision, or None."""
 
201
        return self.get_property('revision')
 
202
 
 
203
    def has_revision_id(self, revision_id):
 
204
        return (revision_id in self.index)
 
205
 
 
206
    def set_revision(self, revision):
 
207
        self.set_property('revision', revision)
 
208
 
 
209
    def set_revision_id(self, revid):
 
210
        """Change the currently selected revision.
 
211
 
 
212
        :param revid: Revision id of revision to display.
 
213
        """
 
214
        self.treeview.set_cursor(
 
215
            Gtk.TreePath(path=self.index[revid]), None, False)
 
216
        self.treeview.grab_focus()
 
217
 
 
218
    def get_children(self):
 
219
        """Return the children of the currently selected revision.
 
220
 
 
221
        :return: list of revision ids.
 
222
        """
 
223
        return self.get_property('children')
 
224
 
 
225
    def get_parents(self):
 
226
        """Return the parents of the currently selected revision.
 
227
 
 
228
        :return: list of revision ids.
 
229
        """
 
230
        return self.get_property('parents')
 
231
 
 
232
    def add_tag(self, tag, revid=None):
 
233
        if revid is None: revid = self.revision.revision_id
 
234
 
 
235
        if lock.release(self.branch):
 
236
            try:
 
237
                lock.acquire(self.branch, lock.WRITE)
 
238
                self.model.add_tag(tag, revid)
 
239
            finally:
 
240
                lock.release(self.branch)
 
241
 
 
242
            lock.acquire(self.branch, lock.READ)
 
243
 
 
244
            self.emit('tag-added', tag, revid)
 
245
 
 
246
    def refresh(self):
 
247
        GObject.idle_add(self.populate, self.get_revision())
 
248
 
 
249
    def update(self):
 
250
        try:
 
251
            self.branch.unlock()
 
252
            try:
 
253
                self.branch.lock_write()
 
254
                self.branch.update()
 
255
            finally:
 
256
                self.branch.unlock()
 
257
        finally:
 
258
            self.branch.lock_read()
 
259
 
 
260
    def back(self):
 
261
        """Signal handler for the Back button."""
 
262
        parents = self.get_parents()
 
263
        if not parents:
 
264
            return
 
265
 
 
266
        for parent_id in parents:
 
267
            parent_index = self.index[parent_id]
 
268
            parent = self.model[parent_index][treemodel.REVISION]
 
269
            if same_branch(self.get_revision(), parent):
 
270
                self.set_revision(parent)
 
271
                break
 
272
        else:
 
273
            self.set_revision_id(parents[0])
 
274
 
 
275
    def forward(self):
 
276
        """Signal handler for the Forward button."""
 
277
        children = self.get_children()
 
278
        if not children:
 
279
            return
 
280
 
 
281
        for child_id in children:
 
282
            child_index = self.index[child_id]
 
283
            child = self.model[child_index][treemodel.REVISION]
 
284
            if same_branch(child, self.get_revision()):
 
285
                self.set_revision(child)
 
286
                break
 
287
        else:
 
288
            self.set_revision_id(children[0])
 
289
 
 
290
    def populate(self, revision=None):
 
291
        """Fill the treeview with contents.
 
292
 
 
293
        :param start: Revision id of revision to start with.
 
294
        :param maxnum: Maximum number of revisions to display, or None 
 
295
                       for no limit.
 
296
        :param broken_line_length: After how much lines branches \
 
297
                       should be broken.
 
298
        """
 
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)
 
303
        self.progress_bar = ui.ui_factory.nested_progress_bar()
 
304
        self.progress_bar.update("Loading ancestry graph", 0, 5)
 
305
 
 
306
        try:
 
307
            if self.compact:
 
308
                broken_line_length = 32
 
309
            else:
 
310
                broken_line_length = None
 
311
 
 
312
            show_graph = self.graph_column.get_visible()
 
313
 
 
314
            self.branch.lock_read()
 
315
            (linegraphdata, index, columns_len) = linegraph(
 
316
                self.branch.repository.get_graph(),
 
317
                self.start,
 
318
                self.maxnum, 
 
319
                broken_line_length,
 
320
                show_graph,
 
321
                self.mainline_only,
 
322
                self.progress_bar)
 
323
 
 
324
            self.model.set_line_graph_data(linegraphdata)
 
325
            self.graph_cell.columns_len = columns_len
 
326
            width = self.graph_cell.get_preferred_width(self.treeview)[1]
 
327
            if width > 500:
 
328
                width = 500
 
329
            elif width == 0:
 
330
                # The get_preferred_width() call got an insane value.
 
331
                width = 200
 
332
            self.graph_column.set_fixed_width(width)
 
333
            self.graph_column.set_max_width(width)
 
334
            self.index = index
 
335
            self.treeview.set_model(self.model)
 
336
 
 
337
            if not revision or revision == NULL_REVISION:
 
338
                self.treeview.set_cursor(Gtk.TreePath(path=0), None, False)
 
339
            else:
 
340
                self.set_revision(revision)
 
341
 
 
342
            self.emit('refreshed')
 
343
            return False
 
344
        finally:
 
345
            self.progress_bar.finished()
 
346
 
 
347
    def construct_treeview(self):
 
348
        self.treeview = Gtk.TreeView()
 
349
 
 
350
        self.treeview.set_rules_hint(True)
 
351
        # combined revno/summary interactive search
 
352
        #
 
353
        # the row in a treemodel is considered "matched" if a REVNO *starts*
 
354
        # from the key (that is the key is found in a REVNO at the offset 0)
 
355
        # or if a MESSAGE *contains* the key anywhere (that is, the key is
 
356
        # found case insensitively in a MESSAGE at any offset)
 
357
        def search_equal_func(model, column, key, iter, ignored):
 
358
            return (model.get_value(iter, treemodel.REVNO).find(key) != 0
 
359
                and model.get_value(iter, treemodel.MESSAGE).lower().find(key.lower()) == -1)
 
360
 
 
361
        self.treeview.set_search_equal_func(search_equal_func, None)
 
362
        self.treeview.set_enable_search(True)
 
363
 
 
364
        self.treeview.set_tooltip_column(treemodel.MESSAGE)
 
365
        self.treeview.set_headers_visible(True)
 
366
 
 
367
        self._prev_cursor_path = None
 
368
        self.treeview.connect("cursor-changed",
 
369
                self._on_selection_changed)
 
370
 
 
371
        self.treeview.connect("row-activated", 
 
372
                self._on_revision_activated)
 
373
 
 
374
        self.treeview.connect("button-release-event", 
 
375
                self._on_revision_selected)
 
376
 
 
377
        self.treeview.set_property('fixed-height-mode', True)
 
378
 
 
379
        self.treeview.show()
 
380
 
 
381
        cell = Gtk.CellRendererText()
 
382
        cell.set_property("width-chars", 15)
 
383
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
384
        self.revno_column = Gtk.TreeViewColumn("Revision No")
 
385
        self.revno_column.set_resizable(True)
 
386
        self.revno_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
387
        self.revno_column.set_fixed_width(
 
388
            cell.get_preferred_width(self.treeview)[1])
 
389
        self.revno_column.pack_start(cell, True)
 
390
        self.revno_column.add_attribute(cell, "text", treemodel.REVNO)
 
391
        self.treeview.append_column(self.revno_column)
 
392
 
 
393
        self.graph_cell = CellRendererGraph()
 
394
        self.graph_column = Gtk.TreeViewColumn()
 
395
        self.graph_column.set_resizable(True)
 
396
        self.graph_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
397
        self.graph_column.pack_start(self.graph_cell, True)
 
398
        self.graph_column.add_attribute(
 
399
            self.graph_cell, "node", treemodel.NODE)
 
400
        self.graph_column.add_attribute(
 
401
            self.graph_cell, "tags", treemodel.TAGS)
 
402
        self.graph_column.add_attribute(
 
403
            self.graph_cell, "in-lines", treemodel.LAST_LINES)
 
404
        self.graph_column.add_attribute(
 
405
            self.graph_cell, "out-lines", treemodel.LINES)
 
406
        self.treeview.append_column(self.graph_column)
 
407
 
 
408
        cell = Gtk.CellRendererText()
 
409
        cell.set_property("width-chars", 65)
 
410
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
411
        self.summary_column = Gtk.TreeViewColumn("Summary")
 
412
        self.summary_column.set_resizable(True)
 
413
        self.summary_column.set_expand(True)
 
414
        self.summary_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
415
        self.summary_column.set_fixed_width(
 
416
            cell.get_preferred_width(self.treeview)[1])
 
417
        self.summary_column.pack_start(cell, True)
 
418
        self.summary_column.add_attribute(cell, "markup", treemodel.SUMMARY)
 
419
        self.treeview.append_column(self.summary_column)
 
420
 
 
421
        cell = Gtk.CellRendererText()
 
422
        cell.set_property("width-chars", 15)
 
423
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
424
        self.authors_column = Gtk.TreeViewColumn("Author(s)")
 
425
        self.authors_column.set_resizable(False)
 
426
        self.authors_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
427
        self.authors_column.set_fixed_width(200)
 
428
        self.authors_column.pack_start(cell, True)
 
429
        self.authors_column.add_attribute(cell, "text", treemodel.AUTHORS)
 
430
        self.treeview.append_column(self.authors_column)
 
431
 
 
432
        cell = Gtk.CellRendererText()
 
433
        cell.set_property("width-chars", 20)
 
434
        cell.set_property("ellipsize", Pango.EllipsizeMode.END)
 
435
        self.date_column = Gtk.TreeViewColumn("Date")
 
436
        self.date_column.set_visible(False)
 
437
        self.date_column.set_resizable(True)
 
438
        self.date_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
 
439
        self.date_column.set_fixed_width(130)
 
440
        self.date_column.pack_start(cell, True)
 
441
        self.date_column.add_attribute(cell, "text", treemodel.TIMESTAMP)
 
442
        self.treeview.append_column(self.date_column)
 
443
 
 
444
        return self.treeview
 
445
 
 
446
    def _on_selection_changed(self, treeview):
 
447
        """callback for when the treeview changes."""
 
448
        (path, focus) = treeview.get_cursor()
 
449
        if (path is not None) and (path != self._prev_cursor_path):
 
450
            self._prev_cursor_path = path # avoid emitting twice per click
 
451
            self.path = path
 
452
            self.emit('revision-selected')
 
453
 
 
454
    def _on_revision_selected(self, widget, event):
 
455
        from bzrlib.plugins.gtk.revisionmenu import RevisionMenu
 
456
        if event.button == 3:
 
457
            revs = []
 
458
            rev = self.get_revision()
 
459
            if rev is not None:
 
460
                revs.append(rev.revision_id)
 
461
            menu = RevisionMenu(self.branch.repository, revs, self.branch)
 
462
            menu.connect('tag-added', lambda w, t, r: self.add_tag(t, r))
 
463
            menu.popup(None, None, None, None, event.button, event.get_time())
 
464
 
 
465
    def _on_revision_activated(self, widget, path, col):
 
466
        self.emit('revision-activated', path, col)