1
 
# -*- coding: UTF-8 -*-
 
2
 
"""Revision history view.
 
6
 
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
7
 
__author__    = "Daniel Schierbeck <daniel.schierbeck@gmail.com>"
 
17
 
from bzrlib.plugins.gtk import _i18n
 
18
 
from linegraph import linegraph, same_branch
 
19
 
from graphcell import CellRendererGraph
 
20
 
from treemodel import TreeModel
 
21
 
from bzrlib.revision import NULL_REVISION
 
23
 
class TreeView(gtk.VBox):
 
26
 
        'branch': (gobject.TYPE_PYOBJECT,
 
28
 
                   'The Bazaar branch being visualized',
 
29
 
                   gobject.PARAM_CONSTRUCT_ONLY | gobject.PARAM_WRITABLE),
 
31
 
        'revision': (gobject.TYPE_PYOBJECT,
 
33
 
                     'The currently selected revision',
 
34
 
                     gobject.PARAM_READWRITE),
 
36
 
        'revision-number': (gobject.TYPE_STRING,
 
38
 
                            'The number of the selected revision',
 
40
 
                            gobject.PARAM_READABLE),
 
42
 
        'children': (gobject.TYPE_PYOBJECT,
 
44
 
                     'Children of the currently selected revision',
 
45
 
                     gobject.PARAM_READABLE),
 
47
 
        'parents': (gobject.TYPE_PYOBJECT,
 
49
 
                    'Parents to the currently selected revision',
 
50
 
                    gobject.PARAM_READABLE),
 
52
 
        'revno-column-visible': (gobject.TYPE_BOOLEAN,
 
53
 
                                 'Revision number column',
 
54
 
                                 'Show revision number column',
 
56
 
                                 gobject.PARAM_READWRITE),
 
58
 
        'graph-column-visible': (gobject.TYPE_BOOLEAN,
 
62
 
                                 gobject.PARAM_READWRITE),
 
64
 
        'date-column-visible': (gobject.TYPE_BOOLEAN,
 
68
 
                                 gobject.PARAM_READWRITE),
 
70
 
        'compact': (gobject.TYPE_BOOLEAN,
 
72
 
                    'Break ancestry lines to save space',
 
74
 
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
76
 
        'mainline-only': (gobject.TYPE_BOOLEAN,
 
78
 
                    'Only show the mainline history.',
 
80
 
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
85
 
        'revisions-loaded': (gobject.SIGNAL_RUN_FIRST, 
 
88
 
        'revision-selected': (gobject.SIGNAL_RUN_FIRST,
 
91
 
        'revision-activated': (gobject.SIGNAL_RUN_FIRST,
 
93
 
                              (gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT)),
 
94
 
        'tag-added': (gobject.SIGNAL_RUN_FIRST,
 
96
 
                              (gobject.TYPE_STRING, gobject.TYPE_STRING))
 
99
 
    def __init__(self, branch, start, maxnum, compact=True):
 
100
 
        """Create a new TreeView.
 
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, 
 
106
 
        :param broken_line_length: After how much lines to break 
 
109
 
        gtk.VBox.__init__(self, spacing=0)
 
111
 
        self.pack_start(self.construct_loading_msg(), expand=False, fill=True)
 
112
 
        self.connect('revisions-loaded', 
 
113
 
                lambda x: self.loading_msg_box.hide())
 
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)
 
122
 
        self.scrolled_window.add(self.construct_treeview())
 
131
 
        self.compact = compact
 
133
 
        gobject.idle_add(self.populate)
 
135
 
        self.connect("destroy", lambda x: self.branch.unlock())
 
137
 
    def do_get_property(self, property):
 
138
 
        if property.name == 'revno-column-visible':
 
139
 
            return self.revno_column.get_visible()
 
140
 
        elif property.name == 'graph-column-visible':
 
141
 
            return self.graph_column.get_visible()
 
142
 
        elif property.name == 'date-column-visible':
 
143
 
            return self.date_column.get_visible()
 
144
 
        elif property.name == 'compact':
 
146
 
        elif property.name == 'mainline-only':
 
147
 
            return self.mainline_only
 
148
 
        elif property.name == 'branch':
 
150
 
        elif property.name == 'revision':
 
151
 
            return self.model.get_value(self.iter, treemodel.REVISION)
 
152
 
        elif property.name == 'revision-number':
 
153
 
            return self.model.get_value(self.iter, treemodel.REVNO)
 
154
 
        elif property.name == 'children':
 
155
 
            return self.model.get_value(self.iter, treemodel.CHILDREN)
 
156
 
        elif property.name == 'parents':
 
157
 
            return self.model.get_value(self.iter, treemodel.PARENTS)
 
159
 
            raise AttributeError, 'unknown property %s' % property.name
 
161
 
    def do_set_property(self, property, value):
 
162
 
        if property.name == 'revno-column-visible':
 
163
 
            self.revno_column.set_visible(value)
 
164
 
        elif property.name == 'graph-column-visible':
 
165
 
            self.graph_column.set_visible(value)
 
166
 
        elif property.name == 'date-column-visible':
 
167
 
            self.date_column.set_visible(value)
 
168
 
        elif property.name == 'compact':
 
170
 
        elif property.name == 'mainline-only':
 
171
 
            self.mainline_only = value
 
172
 
        elif property.name == 'branch':
 
174
 
        elif property.name == 'revision':
 
175
 
            self.set_revision_id(value.revision_id)
 
177
 
            raise AttributeError, 'unknown property %s' % property.name
 
179
 
    def get_revision(self):
 
180
 
        """Return revision id of currently selected revision, or None."""
 
181
 
        return self.get_property('revision')
 
183
 
    def set_revision(self, revision):
 
184
 
        self.set_property('revision', revision)
 
186
 
    def set_revision_id(self, revid):
 
187
 
        """Change the currently selected revision.
 
189
 
        :param revid: Revision id of revision to display.
 
191
 
        self.treeview.set_cursor(self.index[revid])
 
192
 
        self.treeview.grab_focus()
 
194
 
    def get_children(self):
 
195
 
        """Return the children of the currently selected revision.
 
197
 
        :return: list of revision ids.
 
199
 
        return self.get_property('children')
 
201
 
    def get_parents(self):
 
202
 
        """Return the parents of the currently selected revision.
 
204
 
        :return: list of revision ids.
 
206
 
        return self.get_property('parents')
 
208
 
    def add_tag(self, tag, revid=None):
 
209
 
        if revid is None: revid = self.revision.revision_id
 
215
 
                self.branch.lock_write()
 
216
 
                self.model.add_tag(tag, revid)
 
221
 
            self.branch.lock_read()
 
223
 
        self.emit('tag-added', tag, revid)
 
226
 
        self.loading_msg_box.show()
 
227
 
        gobject.idle_add(self.populate, self.get_revision())
 
233
 
                self.branch.lock_write()
 
238
 
            self.branch.lock_read()
 
241
 
        """Signal handler for the Back button."""
 
242
 
        parents = self.get_parents()
 
246
 
        for parent_id in parents:
 
247
 
            parent_index = self.index[parent_id]
 
248
 
            parent = self.model[parent_index][treemodel.REVISION]
 
249
 
            if same_branch(self.get_revision(), parent):
 
250
 
                self.set_revision(parent)
 
253
 
            self.set_revision_id(parents[0])
 
256
 
        """Signal handler for the Forward button."""
 
257
 
        children = self.get_children()
 
258
 
        if not len(children):
 
261
 
        for child_id in children:
 
262
 
            child_index = self.index[child_id]
 
263
 
            child = self.model[child_index][treemodel.REVISION]
 
264
 
            if same_branch(child, self.get_revision()):
 
265
 
                self.set_revision(child)
 
268
 
            self.set_revision_id(children[0])
 
270
 
    def populate(self, revision=None):
 
271
 
        """Fill the treeview with contents.
 
273
 
        :param start: Revision id of revision to start with.
 
274
 
        :param maxnum: Maximum number of revisions to display, or None 
 
276
 
        :param broken_line_length: After how much lines branches \
 
281
 
            broken_line_length = 32
 
283
 
            broken_line_length = None
 
285
 
        show_graph = self.graph_column.get_visible()
 
287
 
        self.branch.lock_read()
 
288
 
        (linegraphdata, index, columns_len) = linegraph(self.branch.repository.get_graph(),
 
289
 
                                                        (self.start,) , # Sequence of start revisions
 
295
 
        self.model = TreeModel(self.branch, linegraphdata)
 
296
 
        self.graph_cell.columns_len = columns_len
 
297
 
        width = self.graph_cell.get_size(self.treeview)[2]
 
300
 
        self.graph_column.set_fixed_width(width)
 
301
 
        self.graph_column.set_max_width(width)
 
303
 
        self.treeview.set_model(self.model)
 
305
 
        if not revision or revision == NULL_REVISION:
 
306
 
            self.treeview.set_cursor(0)
 
308
 
            self.set_revision(revision)
 
310
 
        self.emit('revisions-loaded')
 
314
 
    def construct_treeview(self):
 
315
 
        self.treeview = gtk.TreeView()
 
317
 
        self.treeview.set_rules_hint(True)
 
318
 
        self.treeview.set_search_column(treemodel.REVNO)
 
320
 
        # Fix old PyGTK bug - by JAM
 
321
 
        set_tooltip = getattr(self.treeview, 'set_tooltip_column', None)
 
322
 
        if set_tooltip is not None:
 
323
 
            set_tooltip(treemodel.MESSAGE)
 
325
 
        self.treeview.connect("cursor-changed",
 
326
 
                self._on_selection_changed)
 
328
 
        self.treeview.connect("row-activated", 
 
329
 
                self._on_revision_activated)
 
331
 
        self.treeview.connect("button-release-event", 
 
332
 
                self._on_revision_selected)
 
334
 
        self.treeview.set_property('fixed-height-mode', True)
 
338
 
        cell = gtk.CellRendererText()
 
339
 
        cell.set_property("width-chars", 15)
 
340
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
 
341
 
        self.revno_column = gtk.TreeViewColumn("Revision No")
 
342
 
        self.revno_column.set_resizable(False)
 
343
 
        self.revno_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
344
 
        self.revno_column.set_fixed_width(cell.get_size(self.treeview)[2])
 
345
 
        self.revno_column.pack_start(cell, expand=True)
 
346
 
        self.revno_column.add_attribute(cell, "text", treemodel.REVNO)
 
347
 
        self.treeview.append_column(self.revno_column)
 
349
 
        self.graph_cell = CellRendererGraph()
 
350
 
        self.graph_column = gtk.TreeViewColumn()
 
351
 
        self.graph_column.set_resizable(False)
 
352
 
        self.graph_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
353
 
        self.graph_column.pack_start(self.graph_cell, expand=True)
 
354
 
        self.graph_column.add_attribute(self.graph_cell, "node", treemodel.NODE)
 
355
 
        self.graph_column.add_attribute(self.graph_cell, "tags", treemodel.TAGS)
 
356
 
        self.graph_column.add_attribute(self.graph_cell, "in-lines", treemodel.LAST_LINES)
 
357
 
        self.graph_column.add_attribute(self.graph_cell, "out-lines", treemodel.LINES)
 
358
 
        self.treeview.append_column(self.graph_column)
 
360
 
        cell = gtk.CellRendererText()
 
361
 
        cell.set_property("width-chars", 65)
 
362
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
 
363
 
        self.summary_column = gtk.TreeViewColumn("Summary")
 
364
 
        self.summary_column.set_resizable(False)
 
365
 
        self.summary_column.set_expand(True)
 
366
 
        self.summary_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
367
 
        self.summary_column.set_fixed_width(cell.get_size(self.treeview)[2])
 
368
 
        self.summary_column.pack_start(cell, expand=True)
 
369
 
        self.summary_column.add_attribute(cell, "markup", treemodel.SUMMARY)
 
370
 
        self.treeview.append_column(self.summary_column)
 
372
 
        cell = gtk.CellRendererText()
 
373
 
        cell.set_property("width-chars", 15)
 
374
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
 
375
 
        self.committer_column = gtk.TreeViewColumn("Committer")
 
376
 
        self.committer_column.set_resizable(False)
 
377
 
        self.committer_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
378
 
        self.committer_column.set_fixed_width(200)
 
379
 
        self.committer_column.pack_start(cell, expand=True)
 
380
 
        self.committer_column.add_attribute(cell, "text", treemodel.COMMITTER)
 
381
 
        self.treeview.append_column(self.committer_column)
 
383
 
        cell = gtk.CellRendererText()
 
384
 
        cell.set_property("width-chars", 20)
 
385
 
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
 
386
 
        self.date_column = gtk.TreeViewColumn("Date")
 
387
 
        self.date_column.set_visible(False)
 
388
 
        self.date_column.set_resizable(False)
 
389
 
        self.date_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
390
 
        self.date_column.set_fixed_width(130)
 
391
 
        self.date_column.pack_start(cell, expand=True)
 
392
 
        self.date_column.add_attribute(cell, "text", treemodel.TIMESTAMP)
 
393
 
        self.treeview.append_column(self.date_column)
 
397
 
    def construct_loading_msg(self):
 
398
 
        image_loading = gtk.image_new_from_stock(gtk.STOCK_REFRESH,
 
399
 
                                                 gtk.ICON_SIZE_BUTTON)
 
402
 
        label_loading = gtk.Label(
 
403
 
            _i18n("Please wait, loading ancestral graph..."))
 
404
 
        label_loading.set_alignment(0.0, 0.5)
 
407
 
        self.loading_msg_box = gtk.HBox()
 
408
 
        self.loading_msg_box.set_spacing(5)
 
409
 
        self.loading_msg_box.set_border_width(5)        
 
410
 
        self.loading_msg_box.pack_start(image_loading, False, False)
 
411
 
        self.loading_msg_box.pack_start(label_loading, True, True)
 
412
 
        self.loading_msg_box.show()
 
414
 
        return self.loading_msg_box
 
416
 
    def _on_selection_changed(self, treeview):
 
417
 
        """callback for when the treeview changes."""
 
418
 
        (path, focus) = treeview.get_cursor()
 
420
 
            self.iter = self.model.get_iter(path)
 
421
 
            self.emit('revision-selected')
 
423
 
    def _on_revision_selected(self, widget, event):
 
424
 
        from bzrlib.plugins.gtk.revisionmenu import RevisionPopupMenu
 
425
 
        if event.button == 3:
 
426
 
            menu = RevisionPopupMenu(self.branch.repository, 
 
427
 
                [self.get_revision().revision_id],
 
429
 
            menu.connect('tag-added', lambda w, t, r: self.add_tag(t, r))
 
430
 
            menu.popup(None, None, None, event.button, event.get_time())
 
432
 
    def _on_revision_activated(self, widget, path, col):
 
433
 
        self.emit('revision-activated', path, col)