/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: 2006-05-19 16:56:46 UTC
  • mfrom: (0.1.25 gannotate)
  • Revision ID: jelmer@samba.org-20060519165646-0d867938fdbc9097
Merge in Dan Loda's gannotate plugin and put it in annotate/

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
import sys
10
 
import string
11
 
import gtk
12
 
import gobject
13
 
import pango
14
 
import re
15
 
import treemodel
16
 
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
 
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
 
    }
86
 
 
87
 
    __gsignals__ = {
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)),
97
 
        'refreshed': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
98
 
                              ())
99
 
    }
100
 
 
101
 
    def __init__(self, branch, start, maxnum, compact=True):
102
 
        """Create a new TreeView.
103
 
 
104
 
        :param branch: Branch object for branch to show.
105
 
        :param start: Revision id of top revision.
106
 
        :param maxnum: Maximum number of revisions to display, 
107
 
                       None for no limit.
108
 
        :param broken_line_length: After how much lines to break 
109
 
                                   branches.
110
 
        """
111
 
        gtk.VBox.__init__(self, spacing=0)
112
 
 
113
 
        self.progress_widget = ProgressPanel()
114
 
        self.pack_start(self.progress_widget, expand=False, fill=True)
115
 
        if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
116
 
            # We'are using our own ui, let's tell it to use our widget.
117
 
            ui.ui_factory.set_progress_bar_widget(self.progress_widget)
118
 
 
119
 
        self.scrolled_window = gtk.ScrolledWindow()
120
 
        self.scrolled_window.set_policy(gtk.POLICY_AUTOMATIC,
121
 
                                        gtk.POLICY_AUTOMATIC)
122
 
        self.scrolled_window.set_shadow_type(gtk.SHADOW_IN)
123
 
        self.scrolled_window.show()
124
 
        self.pack_start(self.scrolled_window, expand=True, fill=True)
125
 
 
126
 
        self.scrolled_window.add(self.construct_treeview())
127
 
 
128
 
        self.path = None
129
 
        self.branch = branch
130
 
        self.revision = None
131
 
        self.index = {}
132
 
 
133
 
        self.start = start
134
 
        self.maxnum = maxnum
135
 
        self.compact = compact
136
 
 
137
 
        gobject.idle_add(self.populate)
138
 
 
139
 
        self.connect("destroy", self._on_destroy)
140
 
 
141
 
    def _on_destroy(self, *ignored):
142
 
        self.branch.unlock()
143
 
        if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
144
 
            # We'are using our own ui, let's tell it to stop using our widget.
145
 
            ui.ui_factory.set_progress_bar_widget(None)
146
 
 
147
 
    def do_get_property(self, property):
148
 
        if property.name == 'revno-column-visible':
149
 
            return self.revno_column.get_visible()
150
 
        elif property.name == 'graph-column-visible':
151
 
            return self.graph_column.get_visible()
152
 
        elif property.name == 'date-column-visible':
153
 
            return self.date_column.get_visible()
154
 
        elif property.name == 'compact':
155
 
            return self.compact
156
 
        elif property.name == 'mainline-only':
157
 
            return self.mainline_only
158
 
        elif property.name == 'branch':
159
 
            return self.branch
160
 
        elif property.name == 'revision':
161
 
            return self.model.get_value(self.model.get_iter(self.path),
162
 
                                        treemodel.REVISION)
163
 
        elif property.name == 'revision-number':
164
 
            return self.model.get_value(self.model.get_iter(self.path),
165
 
                                        treemodel.REVNO)
166
 
        elif property.name == 'children':
167
 
            return self.model.get_value(self.model.get_iter(self.path),
168
 
                                        treemodel.CHILDREN)
169
 
        elif property.name == 'parents':
170
 
            return self.model.get_value(self.model.get_iter(self.path),
171
 
                                        treemodel.PARENTS)
172
 
        else:
173
 
            raise AttributeError, 'unknown property %s' % property.name
174
 
 
175
 
    def do_set_property(self, property, value):
176
 
        if property.name == 'revno-column-visible':
177
 
            self.revno_column.set_visible(value)
178
 
        elif property.name == 'graph-column-visible':
179
 
            self.graph_column.set_visible(value)
180
 
        elif property.name == 'date-column-visible':
181
 
            self.date_column.set_visible(value)
182
 
        elif property.name == 'compact':
183
 
            self.compact = value
184
 
        elif property.name == 'mainline-only':
185
 
            self.mainline_only = value
186
 
        elif property.name == 'branch':
187
 
            self.branch = value
188
 
        elif property.name == 'revision':
189
 
            self.set_revision_id(value.revision_id)
190
 
        else:
191
 
            raise AttributeError, 'unknown property %s' % property.name
192
 
 
193
 
    def get_revision(self):
194
 
        """Return revision id of currently selected revision, or None."""
195
 
        return self.get_property('revision')
196
 
 
197
 
    def has_revision_id(self, revision_id):
198
 
        return (revision_id in self.index)
199
 
 
200
 
    def set_revision(self, revision):
201
 
        self.set_property('revision', revision)
202
 
 
203
 
    def set_revision_id(self, revid):
204
 
        """Change the currently selected revision.
205
 
 
206
 
        :param revid: Revision id of revision to display.
207
 
        """
208
 
        self.treeview.set_cursor(self.index[revid])
209
 
        self.treeview.grab_focus()
210
 
 
211
 
    def get_children(self):
212
 
        """Return the children of the currently selected revision.
213
 
 
214
 
        :return: list of revision ids.
215
 
        """
216
 
        return self.get_property('children')
217
 
 
218
 
    def get_parents(self):
219
 
        """Return the parents of the currently selected revision.
220
 
 
221
 
        :return: list of revision ids.
222
 
        """
223
 
        return self.get_property('parents')
224
 
 
225
 
    def add_tag(self, tag, revid=None):
226
 
        if revid is None: revid = self.revision.revision_id
227
 
 
228
 
        try:
229
 
            self.branch.unlock()
230
 
 
231
 
            try:
232
 
                self.branch.lock_write()
233
 
                self.model.add_tag(tag, revid)
234
 
            finally:
235
 
                self.branch.unlock()
236
 
 
237
 
        finally:
238
 
            self.branch.lock_read()
239
 
 
240
 
        self.emit('tag-added', tag, revid)
241
 
        
242
 
    def refresh(self):
243
 
        gobject.idle_add(self.populate, self.get_revision())
244
 
 
245
 
    def update(self):
246
 
        try:
247
 
            self.branch.unlock()
248
 
            try:
249
 
                self.branch.lock_write()
250
 
                self.branch.update()
251
 
            finally:
252
 
                self.branch.unlock()
253
 
        finally:
254
 
            self.branch.lock_read()
255
 
 
256
 
    def back(self):
257
 
        """Signal handler for the Back button."""
258
 
        parents = self.get_parents()
259
 
        if not len(parents):
260
 
            return
261
 
 
262
 
        for parent_id in parents:
263
 
            parent_index = self.index[parent_id]
264
 
            parent = self.model[parent_index][treemodel.REVISION]
265
 
            if same_branch(self.get_revision(), parent):
266
 
                self.set_revision(parent)
267
 
                break
268
 
        else:
269
 
            self.set_revision_id(parents[0])
270
 
 
271
 
    def forward(self):
272
 
        """Signal handler for the Forward button."""
273
 
        children = self.get_children()
274
 
        if not len(children):
275
 
            return
276
 
 
277
 
        for child_id in children:
278
 
            child_index = self.index[child_id]
279
 
            child = self.model[child_index][treemodel.REVISION]
280
 
            if same_branch(child, self.get_revision()):
281
 
                self.set_revision(child)
282
 
                break
283
 
        else:
284
 
            self.set_revision_id(children[0])
285
 
 
286
 
    def populate(self, revision=None):
287
 
        """Fill the treeview with contents.
288
 
 
289
 
        :param start: Revision id of revision to start with.
290
 
        :param maxnum: Maximum number of revisions to display, or None 
291
 
                       for no limit.
292
 
        :param broken_line_length: After how much lines branches \
293
 
                       should be broken.
294
 
        """
295
 
 
296
 
        if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
297
 
            # We'are using our own ui, let's tell it to use our widget.
298
 
            ui.ui_factory.set_progress_bar_widget(self.progress_widget)
299
 
        self.progress_bar = ui.ui_factory.nested_progress_bar()
300
 
        self.progress_bar.update("Loading ancestry graph", 0, 5)
301
 
 
302
 
        try:
303
 
            if self.compact:
304
 
                broken_line_length = 32
305
 
            else:
306
 
                broken_line_length = None
307
 
            
308
 
            show_graph = self.graph_column.get_visible()
309
 
 
310
 
            self.branch.lock_read()
311
 
            (linegraphdata, index, columns_len) = linegraph(self.branch.repository.get_graph(),
312
 
                                                            self.start,
313
 
                                                            self.maxnum, 
314
 
                                                            broken_line_length,
315
 
                                                            show_graph,
316
 
                                                            self.mainline_only,
317
 
                                                            self.progress_bar)
318
 
 
319
 
            self.model = TreeModel(self.branch, linegraphdata)
320
 
            self.graph_cell.columns_len = columns_len
321
 
            width = self.graph_cell.get_size(self.treeview)[2]
322
 
            if width > 500:
323
 
                width = 500
324
 
            self.graph_column.set_fixed_width(width)
325
 
            self.graph_column.set_max_width(width)
326
 
            self.index = index
327
 
            self.treeview.set_model(self.model)
328
 
 
329
 
            if not revision or revision == NULL_REVISION:
330
 
                self.treeview.set_cursor(0)
331
 
            else:
332
 
                self.set_revision(revision)
333
 
 
334
 
            self.emit('refreshed')
335
 
            return False
336
 
        finally:
337
 
            self.progress_bar.finished()
338
 
 
339
 
    def construct_treeview(self):
340
 
        self.treeview = gtk.TreeView()
341
 
 
342
 
        self.treeview.set_rules_hint(True)
343
 
        self.treeview.set_search_column(treemodel.REVNO)
344
 
        
345
 
        # Fix old PyGTK bug - by JAM
346
 
        set_tooltip = getattr(self.treeview, 'set_tooltip_column', None)
347
 
        if set_tooltip is not None:
348
 
            set_tooltip(treemodel.MESSAGE)
349
 
 
350
 
        self._prev_cursor_path = None
351
 
        self.treeview.connect("cursor-changed",
352
 
                self._on_selection_changed)
353
 
 
354
 
        self.treeview.connect("row-activated", 
355
 
                self._on_revision_activated)
356
 
 
357
 
        self.treeview.connect("button-release-event", 
358
 
                self._on_revision_selected)
359
 
 
360
 
        self.treeview.set_property('fixed-height-mode', True)
361
 
 
362
 
        self.treeview.show()
363
 
 
364
 
        cell = gtk.CellRendererText()
365
 
        cell.set_property("width-chars", 15)
366
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
367
 
        self.revno_column = gtk.TreeViewColumn("Revision No")
368
 
        self.revno_column.set_resizable(False)
369
 
        self.revno_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
370
 
        self.revno_column.set_fixed_width(cell.get_size(self.treeview)[2])
371
 
        self.revno_column.pack_start(cell, expand=True)
372
 
        self.revno_column.add_attribute(cell, "text", treemodel.REVNO)
373
 
        self.treeview.append_column(self.revno_column)
374
 
 
375
 
        self.graph_cell = CellRendererGraph()
376
 
        self.graph_column = gtk.TreeViewColumn()
377
 
        self.graph_column.set_resizable(False)
378
 
        self.graph_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
379
 
        self.graph_column.pack_start(self.graph_cell, expand=True)
380
 
        self.graph_column.add_attribute(self.graph_cell, "node", treemodel.NODE)
381
 
        self.graph_column.add_attribute(self.graph_cell, "tags", treemodel.TAGS)
382
 
        self.graph_column.add_attribute(self.graph_cell, "in-lines", treemodel.LAST_LINES)
383
 
        self.graph_column.add_attribute(self.graph_cell, "out-lines", treemodel.LINES)
384
 
        self.treeview.append_column(self.graph_column)
385
 
 
386
 
        cell = gtk.CellRendererText()
387
 
        cell.set_property("width-chars", 65)
388
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
389
 
        self.summary_column = gtk.TreeViewColumn("Summary")
390
 
        self.summary_column.set_resizable(False)
391
 
        self.summary_column.set_expand(True)
392
 
        self.summary_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
393
 
        self.summary_column.set_fixed_width(cell.get_size(self.treeview)[2])
394
 
        self.summary_column.pack_start(cell, expand=True)
395
 
        self.summary_column.add_attribute(cell, "markup", treemodel.SUMMARY)
396
 
        self.treeview.append_column(self.summary_column)
397
 
 
398
 
        cell = gtk.CellRendererText()
399
 
        cell.set_property("width-chars", 15)
400
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
401
 
        self.committer_column = gtk.TreeViewColumn("Committer")
402
 
        self.committer_column.set_resizable(False)
403
 
        self.committer_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
404
 
        self.committer_column.set_fixed_width(200)
405
 
        self.committer_column.pack_start(cell, expand=True)
406
 
        self.committer_column.add_attribute(cell, "text", treemodel.COMMITTER)
407
 
        self.treeview.append_column(self.committer_column)
408
 
 
409
 
        cell = gtk.CellRendererText()
410
 
        cell.set_property("width-chars", 20)
411
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
412
 
        self.date_column = gtk.TreeViewColumn("Date")
413
 
        self.date_column.set_visible(False)
414
 
        self.date_column.set_resizable(False)
415
 
        self.date_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
416
 
        self.date_column.set_fixed_width(130)
417
 
        self.date_column.pack_start(cell, expand=True)
418
 
        self.date_column.add_attribute(cell, "text", treemodel.TIMESTAMP)
419
 
        self.treeview.append_column(self.date_column)
420
 
        
421
 
        return self.treeview
422
 
    
423
 
    def _on_selection_changed(self, treeview):
424
 
        """callback for when the treeview changes."""
425
 
        (path, focus) = treeview.get_cursor()
426
 
        if (path is not None) and (path != self._prev_cursor_path):
427
 
            self._prev_cursor_path = path # avoid emitting twice per click
428
 
            self.path = path
429
 
            self.emit('revision-selected')
430
 
 
431
 
    def _on_revision_selected(self, widget, event):
432
 
        from bzrlib.plugins.gtk.revisionmenu import RevisionMenu
433
 
        if event.button == 3:
434
 
            menu = RevisionMenu(self.branch.repository, 
435
 
                [self.get_revision().revision_id],
436
 
                self.branch)
437
 
            menu.connect('tag-added', lambda w, t, r: self.add_tag(t, r))
438
 
            menu.popup(None, None, None, event.button, event.get_time())
439
 
 
440
 
    def _on_revision_activated(self, widget, path, col):
441
 
        self.emit('revision-activated', path, col)