1
# -*- coding: UTF-8 -*-
 
 
2
"""Revision history view.
 
 
6
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
 
7
__author__    = "Daniel Schierbeck <daniel.schierbeck@gmail.com>"
 
 
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
 
 
26
class TreeView(gtk.VBox):
 
 
29
        'branch': (gobject.TYPE_PYOBJECT,
 
 
31
                   'The Bazaar branch being visualized',
 
 
32
                   gobject.PARAM_CONSTRUCT_ONLY | gobject.PARAM_WRITABLE),
 
 
34
        'revision': (gobject.TYPE_PYOBJECT,
 
 
36
                     'The currently selected revision',
 
 
37
                     gobject.PARAM_READWRITE),
 
 
39
        'revision-number': (gobject.TYPE_STRING,
 
 
41
                            'The number of the selected revision',
 
 
43
                            gobject.PARAM_READABLE),
 
 
45
        'children': (gobject.TYPE_PYOBJECT,
 
 
47
                     'Children of the currently selected revision',
 
 
48
                     gobject.PARAM_READABLE),
 
 
50
        'parents': (gobject.TYPE_PYOBJECT,
 
 
52
                    'Parents to the currently selected revision',
 
 
53
                    gobject.PARAM_READABLE),
 
 
55
        'revno-column-visible': (gobject.TYPE_BOOLEAN,
 
 
56
                                 'Revision number column',
 
 
57
                                 'Show revision number column',
 
 
59
                                 gobject.PARAM_READWRITE),
 
 
61
        'graph-column-visible': (gobject.TYPE_BOOLEAN,
 
 
65
                                 gobject.PARAM_READWRITE),
 
 
67
        'date-column-visible': (gobject.TYPE_BOOLEAN,
 
 
71
                                 gobject.PARAM_READWRITE),
 
 
73
        'compact': (gobject.TYPE_BOOLEAN,
 
 
75
                    'Break ancestry lines to save space',
 
 
77
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
 
79
        'mainline-only': (gobject.TYPE_BOOLEAN,
 
 
81
                    'Only show the mainline history.',
 
 
83
                    gobject.PARAM_CONSTRUCT | gobject.PARAM_READWRITE),
 
 
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
        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)
 
 
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())
 
 
130
        self.compact = compact
 
 
132
        gobject.idle_add(self.populate)
 
 
134
        self.connect("destroy", lambda x: self.branch.unlock())
 
 
136
    def do_get_property(self, property):
 
 
137
        if property.name == 'revno-column-visible':
 
 
138
            return self.revno_column.get_visible()
 
 
139
        elif property.name == 'graph-column-visible':
 
 
140
            return self.graph_column.get_visible()
 
 
141
        elif property.name == 'date-column-visible':
 
 
142
            return self.date_column.get_visible()
 
 
143
        elif property.name == 'compact':
 
 
145
        elif property.name == 'mainline-only':
 
 
146
            return self.mainline_only
 
 
147
        elif property.name == 'branch':
 
 
149
        elif property.name == 'revision':
 
 
150
            return self.model.get_value(self.iter, treemodel.REVISION)
 
 
151
        elif property.name == 'revision-number':
 
 
152
            return self.model.get_value(self.iter, treemodel.REVNO)
 
 
153
        elif property.name == 'children':
 
 
154
            return self.model.get_value(self.iter, treemodel.CHILDREN)
 
 
155
        elif property.name == 'parents':
 
 
156
            return self.model.get_value(self.iter, treemodel.PARENTS)
 
 
158
            raise AttributeError, 'unknown property %s' % property.name
 
 
160
    def do_set_property(self, property, value):
 
 
161
        if property.name == 'revno-column-visible':
 
 
162
            self.revno_column.set_visible(value)
 
 
163
        elif property.name == 'graph-column-visible':
 
 
164
            self.graph_column.set_visible(value)
 
 
165
        elif property.name == 'date-column-visible':
 
 
166
            self.date_column.set_visible(value)
 
 
167
        elif property.name == 'compact':
 
 
169
        elif property.name == 'mainline-only':
 
 
170
            self.mainline_only = value
 
 
171
        elif property.name == 'branch':
 
 
173
        elif property.name == 'revision':
 
 
174
            self.set_revision_id(value.revision_id)
 
 
176
            raise AttributeError, 'unknown property %s' % property.name
 
 
178
    def get_revision(self):
 
 
179
        """Return revision id of currently selected revision, or None."""
 
 
180
        return self.get_property('revision')
 
 
182
    def set_revision(self, revision):
 
 
183
        self.set_property('revision', revision)
 
 
185
    def set_revision_id(self, revid):
 
 
186
        """Change the currently selected revision.
 
 
188
        :param revid: Revision id of revision to display.
 
 
190
        self.treeview.set_cursor(self.index[revid])
 
 
191
        self.treeview.grab_focus()
 
 
193
    def get_children(self):
 
 
194
        """Return the children of the currently selected revision.
 
 
196
        :return: list of revision ids.
 
 
198
        return self.get_property('children')
 
 
200
    def get_parents(self):
 
 
201
        """Return the parents of the currently selected revision.
 
 
203
        :return: list of revision ids.
 
 
205
        return self.get_property('parents')
 
 
207
    def add_tag(self, tag, revid=None):
 
 
208
        if revid is None: revid = self.revision.revision_id
 
 
214
                self.branch.lock_write()
 
 
215
                self.model.add_tag(tag, revid)
 
 
220
            self.branch.lock_read()
 
 
222
        self.emit('tag-added', tag, revid)
 
 
225
        gobject.idle_add(self.populate, self.get_revision())
 
 
231
                self.branch.lock_write()
 
 
236
            self.branch.lock_read()
 
 
239
        """Signal handler for the Back button."""
 
 
240
        parents = self.get_parents()
 
 
244
        for parent_id in parents:
 
 
245
            parent_index = self.index[parent_id]
 
 
246
            parent = self.model[parent_index][treemodel.REVISION]
 
 
247
            if same_branch(self.get_revision(), parent):
 
 
248
                self.set_revision(parent)
 
 
251
            self.set_revision_id(parents[0])
 
 
254
        """Signal handler for the Forward button."""
 
 
255
        children = self.get_children()
 
 
256
        if not len(children):
 
 
259
        for child_id in children:
 
 
260
            child_index = self.index[child_id]
 
 
261
            child = self.model[child_index][treemodel.REVISION]
 
 
262
            if same_branch(child, self.get_revision()):
 
 
263
                self.set_revision(child)
 
 
266
            self.set_revision_id(children[0])
 
 
268
    def populate(self, revision=None):
 
 
269
        """Fill the treeview with contents.
 
 
271
        :param start: Revision id of revision to start with.
 
 
272
        :param maxnum: Maximum number of revisions to display, or None 
 
 
274
        :param broken_line_length: After how much lines branches \
 
 
278
        self.progress_bar = ui.ui_factory.nested_progress_bar()
 
 
279
        self.progress_bar.update(msg="Loading ancestry graph", total_cnt=5)
 
 
283
                broken_line_length = 32
 
 
285
                broken_line_length = None
 
 
287
            show_graph = self.graph_column.get_visible()
 
 
289
            self.branch.lock_read()
 
 
290
            (linegraphdata, index, columns_len) = linegraph(self.branch.repository.get_graph(),
 
 
298
            self.model = TreeModel(self.branch, linegraphdata)
 
 
299
            self.graph_cell.columns_len = columns_len
 
 
300
            width = self.graph_cell.get_size(self.treeview)[2]
 
 
303
            self.graph_column.set_fixed_width(width)
 
 
304
            self.graph_column.set_max_width(width)
 
 
306
            self.treeview.set_model(self.model)
 
 
308
            if not revision or revision == NULL_REVISION:
 
 
309
                self.treeview.set_cursor(0)
 
 
311
                self.set_revision(revision)
 
 
315
            self.progress_bar.finished()
 
 
317
    def construct_treeview(self):
 
 
318
        self.treeview = gtk.TreeView()
 
 
320
        self.treeview.set_rules_hint(True)
 
 
321
        self.treeview.set_search_column(treemodel.REVNO)
 
 
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)
 
 
328
        self.treeview.connect("cursor-changed",
 
 
329
                self._on_selection_changed)
 
 
331
        self.treeview.connect("row-activated", 
 
 
332
                self._on_revision_activated)
 
 
334
        self.treeview.connect("button-release-event", 
 
 
335
                self._on_revision_selected)
 
 
337
        self.treeview.set_property('fixed-height-mode', True)
 
 
341
        cell = gtk.CellRendererText()
 
 
342
        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)
 
 
349
        self.revno_column.add_attribute(cell, "text", treemodel.REVNO)
 
 
350
        self.treeview.append_column(self.revno_column)
 
 
352
        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)
 
 
357
        self.graph_column.add_attribute(self.graph_cell, "node", treemodel.NODE)
 
 
358
        self.graph_column.add_attribute(self.graph_cell, "tags", treemodel.TAGS)
 
 
359
        self.graph_column.add_attribute(self.graph_cell, "in-lines", treemodel.LAST_LINES)
 
 
360
        self.graph_column.add_attribute(self.graph_cell, "out-lines", treemodel.LINES)
 
 
361
        self.treeview.append_column(self.graph_column)
 
 
363
        cell = gtk.CellRendererText()
 
 
364
        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)
 
 
368
        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)
 
 
372
        self.summary_column.add_attribute(cell, "markup", treemodel.SUMMARY)
 
 
373
        self.treeview.append_column(self.summary_column)
 
 
375
        cell = gtk.CellRendererText()
 
 
376
        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)
 
 
386
        cell = gtk.CellRendererText()
 
 
387
        cell.set_property("width-chars", 20)
 
 
388
        cell.set_property("ellipsize", pango.ELLIPSIZE_END)
 
 
389
        self.date_column = gtk.TreeViewColumn("Date")
 
 
390
        self.date_column.set_visible(False)
 
 
391
        self.date_column.set_resizable(False)
 
 
392
        self.date_column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 
 
393
        self.date_column.set_fixed_width(130)
 
 
394
        self.date_column.pack_start(cell, expand=True)
 
 
395
        self.date_column.add_attribute(cell, "text", treemodel.TIMESTAMP)
 
 
396
        self.treeview.append_column(self.date_column)
 
 
400
    def _on_selection_changed(self, treeview):
 
 
401
        """callback for when the treeview changes."""
 
 
402
        (path, focus) = treeview.get_cursor()
 
 
404
            self.iter = self.model.get_iter(path)
 
 
405
            self.emit('revision-selected')
 
 
407
    def _on_revision_selected(self, widget, event):
 
 
408
        from bzrlib.plugins.gtk.revisionmenu import RevisionPopupMenu
 
 
409
        if event.button == 3:
 
 
410
            menu = RevisionPopupMenu(self.branch.repository, 
 
 
411
                [self.get_revision().revision_id],
 
 
413
            menu.connect('tag-added', lambda w, t, r: self.add_tag(t, r))
 
 
414
            menu.popup(None, None, None, event.button, event.get_time())
 
 
416
    def _on_revision_activated(self, widget, path, col):
 
 
417
        self.emit('revision-activated', path, col)