1
 
# -*- coding: UTF-8 -*-
 
4
 
This module contains the code to manage the branch information window,
 
5
 
which contains both the revision graph and details panes.
 
8
 
__copyright__ = "Copyright © 2005 Canonical Ltd."
 
9
 
__author__    = "Scott James Remnant <scott@ubuntu.com>"
 
16
 
from bzrlib.plugins.gtk.window import Window
 
17
 
from bzrlib.plugins.gtk import icon_path
 
18
 
from bzrlib.plugins.gtk.tags import AddTagDialog
 
19
 
from bzrlib.plugins.gtk.preferences import PreferencesWindow
 
20
 
from bzrlib.plugins.gtk.branchview import TreeView, treemodel
 
21
 
from bzrlib.revision import Revision, NULL_REVISION
 
22
 
from bzrlib.config import BranchConfig
 
23
 
from bzrlib.config import GlobalConfig
 
25
 
class BranchWindow(Window):
 
28
 
    This object represents and manages a single window containing information
 
29
 
    for a particular branch.
 
32
 
    def __init__(self, branch, start_revs, maxnum, parent=None):
 
33
 
        """Create a new BranchWindow.
 
35
 
        :param branch: Branch object for branch to show.
 
36
 
        :param start_revs: Revision ids of top revisions.
 
37
 
        :param maxnum: Maximum number of revisions to display, 
 
41
 
        Window.__init__(self, parent=parent)
 
42
 
        self.set_border_width(0)
 
45
 
        self.start_revs  = start_revs
 
47
 
        self.config      = GlobalConfig()
 
49
 
        if self.config.get_user_option('viz-compact-view') == 'yes':
 
50
 
            self.compact_view = True
 
52
 
            self.compact_view = False
 
54
 
        self.set_title(branch.nick + " - revision history")
 
56
 
        # Use three-quarters of the screen by default
 
57
 
        screen = self.get_screen()
 
58
 
        monitor = screen.get_monitor_geometry(0)
 
59
 
        width = int(monitor.width * 0.75)
 
60
 
        height = int(monitor.height * 0.75)
 
61
 
        self.set_default_size(width, height)
 
64
 
        icon = self.render_icon(gtk.STOCK_INDEX, gtk.ICON_SIZE_BUTTON)
 
67
 
        gtk.accel_map_add_entry("<viz>/Go/Next Revision", gtk.keysyms.Up, gtk.gdk.MOD1_MASK)
 
68
 
        gtk.accel_map_add_entry("<viz>/Go/Previous Revision", gtk.keysyms.Down, gtk.gdk.MOD1_MASK)
 
70
 
        self.accel_group = gtk.AccelGroup()
 
71
 
        self.add_accel_group(self.accel_group)
 
73
 
        gtk.Action.set_tool_item_type(gtk.MenuToolButton)
 
75
 
        self.prev_rev_action = gtk.Action("prev-rev", "_Previous Revision", "Go to the previous revision", gtk.STOCK_GO_DOWN)
 
76
 
        self.prev_rev_action.set_accel_path("<viz>/Go/Previous Revision")
 
77
 
        self.prev_rev_action.set_accel_group(self.accel_group)
 
78
 
        self.prev_rev_action.connect("activate", self._back_clicked_cb)
 
79
 
        self.prev_rev_action.connect_accelerator()
 
81
 
        self.next_rev_action = gtk.Action("next-rev", "_Next Revision", "Go to the next revision", gtk.STOCK_GO_UP)
 
82
 
        self.next_rev_action.set_accel_path("<viz>/Go/Next Revision")
 
83
 
        self.next_rev_action.set_accel_group(self.accel_group)
 
84
 
        self.next_rev_action.connect("activate", self._fwd_clicked_cb)
 
85
 
        self.next_rev_action.connect_accelerator()
 
89
 
    def set_revision(self, revid):
 
90
 
        self.treeview.set_revision_id(revid)
 
93
 
        """Construct the window contents."""
 
94
 
        vbox = gtk.VBox(spacing=0)
 
97
 
        self.paned = gtk.VPaned()
 
98
 
        self.paned.pack1(self.construct_top(), resize=True, shrink=False)
 
99
 
        self.paned.pack2(self.construct_bottom(), resize=False, shrink=True)
 
102
 
        vbox.pack_start(self.construct_menubar(), expand=False, fill=True)
 
103
 
        vbox.pack_start(self.construct_navigation(), expand=False, fill=True)
 
105
 
        vbox.pack_start(self.paned, expand=True, fill=True)
 
106
 
        vbox.set_focus_child(self.paned)
 
110
 
    def construct_menubar(self):
 
111
 
        menubar = gtk.MenuBar()
 
113
 
        file_menu = gtk.Menu()
 
114
 
        file_menuitem = gtk.MenuItem("_File")
 
115
 
        file_menuitem.set_submenu(file_menu)
 
117
 
        file_menu_close = gtk.ImageMenuItem(gtk.STOCK_CLOSE, self.accel_group)
 
118
 
        file_menu_close.connect('activate', lambda x: self.destroy())
 
120
 
        file_menu_quit = gtk.ImageMenuItem(gtk.STOCK_QUIT, self.accel_group)
 
121
 
        file_menu_quit.connect('activate', lambda x: gtk.main_quit())
 
123
 
        if self._parent is not None:
 
124
 
            file_menu.add(file_menu_close)
 
125
 
        file_menu.add(file_menu_quit)
 
127
 
        edit_menu = gtk.Menu()
 
128
 
        edit_menuitem = gtk.MenuItem("_Edit")
 
129
 
        edit_menuitem.set_submenu(edit_menu)
 
131
 
        edit_menu_find = gtk.ImageMenuItem(gtk.STOCK_FIND)
 
133
 
        edit_menu_branchopts = gtk.MenuItem("Branch Settings")
 
134
 
        edit_menu_branchopts.connect('activate', lambda x: PreferencesWindow(self.branch.get_config()).show())
 
136
 
        edit_menu_globopts = gtk.MenuItem("Global Settings")
 
137
 
        edit_menu_globopts.connect('activate', lambda x: PreferencesWindow().show())
 
139
 
        edit_menu.add(edit_menu_find)
 
140
 
        edit_menu.add(edit_menu_branchopts)
 
141
 
        edit_menu.add(edit_menu_globopts)
 
143
 
        view_menu = gtk.Menu()
 
144
 
        view_menuitem = gtk.MenuItem("_View")
 
145
 
        view_menuitem.set_submenu(view_menu)
 
147
 
        view_menu_toolbar = gtk.CheckMenuItem("Show Toolbar")
 
148
 
        view_menu_toolbar.set_active(True)
 
149
 
        view_menu_toolbar.connect('toggled', self._toolbar_visibility_changed)
 
151
 
        view_menu_compact = gtk.CheckMenuItem("Show Compact Graph")
 
152
 
        view_menu_compact.set_active(self.compact_view)
 
153
 
        view_menu_compact.connect('activate', self._brokenlines_toggled_cb)
 
155
 
        view_menu.add(view_menu_toolbar)
 
156
 
        view_menu.add(view_menu_compact)
 
157
 
        view_menu.add(gtk.SeparatorMenuItem())
 
159
 
        self.mnu_show_revno_column = gtk.CheckMenuItem("Show Revision _Number Column")
 
160
 
        self.mnu_show_date_column = gtk.CheckMenuItem("Show _Date Column")
 
162
 
        # Revision numbers are pointless if there are multiple branches
 
163
 
        if len(self.start_revs) > 1:
 
164
 
            self.mnu_show_revno_column.set_sensitive(False)
 
165
 
            self.treeview.set_property('revno-column-visible', False)
 
167
 
        for (col, name) in [(self.mnu_show_revno_column, "revno"), 
 
168
 
                            (self.mnu_show_date_column, "date")]:
 
169
 
            col.set_active(self.treeview.get_property(name + "-column-visible"))
 
170
 
            col.connect('toggled', self._col_visibility_changed, name)
 
174
 
        go_menu.set_accel_group(self.accel_group)
 
175
 
        go_menuitem = gtk.MenuItem("_Go")
 
176
 
        go_menuitem.set_submenu(go_menu)
 
178
 
        go_menu_next = self.next_rev_action.create_menu_item()
 
179
 
        go_menu_prev = self.prev_rev_action.create_menu_item()
 
181
 
        tag_image = gtk.Image()
 
182
 
        tag_image.set_from_file(icon_path("tag-16.png"))
 
183
 
        self.go_menu_tags = gtk.ImageMenuItem("_Tags")
 
184
 
        self.go_menu_tags.set_image(tag_image)
 
187
 
        go_menu.add(go_menu_next)
 
188
 
        go_menu.add(go_menu_prev)
 
189
 
        go_menu.add(gtk.SeparatorMenuItem())
 
190
 
        go_menu.add(self.go_menu_tags)
 
192
 
        revision_menu = gtk.Menu()
 
193
 
        revision_menuitem = gtk.MenuItem("_Revision")
 
194
 
        revision_menuitem.set_submenu(revision_menu)
 
196
 
        revision_menu_diff = gtk.MenuItem("View Changes")
 
197
 
        revision_menu_diff.connect('activate', 
 
200
 
        revision_menu_compare = gtk.MenuItem("Compare with...")
 
201
 
        revision_menu_compare.connect('activate',
 
202
 
                self._compare_with_cb)
 
204
 
        revision_menu_tag = gtk.MenuItem("Tag Revision")
 
205
 
        revision_menu_tag.connect('activate', self._tag_revision_cb)
 
207
 
        revision_menu.add(revision_menu_tag)
 
208
 
        revision_menu.add(revision_menu_diff)
 
209
 
        revision_menu.add(revision_menu_compare)
 
211
 
        branch_menu = gtk.Menu()
 
212
 
        branch_menuitem = gtk.MenuItem("_Branch")
 
213
 
        branch_menuitem.set_submenu(branch_menu)
 
215
 
        branch_menu.add(gtk.MenuItem("Pu_ll Revisions"))
 
216
 
        branch_menu.add(gtk.MenuItem("Pu_sh Revisions"))
 
218
 
        help_menu = gtk.Menu()
 
219
 
        help_menuitem = gtk.MenuItem("_Help")
 
220
 
        help_menuitem.set_submenu(help_menu)
 
222
 
        help_about_menuitem = gtk.ImageMenuItem(gtk.STOCK_ABOUT, self.accel_group)
 
223
 
        help_about_menuitem.connect('activate', self._about_dialog_cb)
 
225
 
        help_menu.add(help_about_menuitem)
 
227
 
        menubar.add(file_menuitem)
 
228
 
        menubar.add(edit_menuitem)
 
229
 
        menubar.add(view_menuitem)
 
230
 
        menubar.add(go_menuitem)
 
231
 
        menubar.add(revision_menuitem)
 
232
 
        menubar.add(branch_menuitem)
 
233
 
        menubar.add(help_menuitem)
 
238
 
    def construct_top(self):
 
239
 
        """Construct the top-half of the window."""
 
240
 
        # FIXME: Make broken_line_length configurable
 
242
 
        self.treeview = TreeView(self.branch, self.start_revs, self.maxnum, self.compact_view)
 
244
 
        self.treeview.connect('revision-selected',
 
245
 
                self._treeselection_changed_cb)
 
246
 
        self.treeview.connect('revision-activated',
 
247
 
                self._tree_revision_activated)
 
249
 
        self.treeview.connect('tag-added', lambda w, t, r: self._update_tags())
 
251
 
        for col in ["revno", "date"]:
 
252
 
            option = self.config.get_user_option(col + '-column-visible')
 
253
 
            if option is not None:
 
254
 
                self.treeview.set_property(col + '-column-visible', option == 'True')
 
256
 
                self.treeview.set_property(col + '-column-visible', False)
 
260
 
        align = gtk.Alignment(0.0, 0.0, 1.0, 1.0)
 
261
 
        align.set_padding(5, 0, 0, 0)
 
262
 
        align.add(self.treeview)
 
267
 
    def construct_navigation(self):
 
268
 
        """Construct the navigation buttons."""
 
269
 
        self.toolbar = gtk.Toolbar()
 
270
 
        self.toolbar.set_style(gtk.TOOLBAR_BOTH_HORIZ)
 
272
 
        self.prev_button = self.prev_rev_action.create_tool_item()
 
273
 
        self.toolbar.insert(self.prev_button, -1)
 
275
 
        self.next_button = self.next_rev_action.create_tool_item()
 
276
 
        self.toolbar.insert(self.next_button, -1)
 
278
 
        self.toolbar.insert(gtk.SeparatorToolItem(), -1)
 
280
 
        refresh_button = gtk.ToolButton(gtk.STOCK_REFRESH)
 
281
 
        refresh_button.connect('clicked', self._refresh_clicked)
 
282
 
        self.toolbar.insert(refresh_button, -1)
 
284
 
        self.toolbar.show_all()
 
288
 
    def construct_bottom(self):
 
289
 
        """Construct the bottom half of the window."""
 
290
 
        from bzrlib.plugins.gtk.revisionview import RevisionView
 
291
 
        self.revisionview = RevisionView(branch=self.branch)
 
292
 
        (width, height) = self.get_size()
 
293
 
        self.revisionview.set_size_request(width, int(height / 2.5))
 
294
 
        self.revisionview.show()
 
295
 
        self.revisionview.set_show_callback(self._show_clicked_cb)
 
296
 
        self.revisionview.connect('notify::revision', self._go_clicked_cb)
 
297
 
        self.treeview.connect('tag-added', lambda w, t, r: self.revisionview.update_tags())
 
298
 
        return self.revisionview
 
300
 
    def _tag_selected_cb(self, menuitem, revid):
 
301
 
        self.treeview.set_revision_id(revid)
 
303
 
    def _treeselection_changed_cb(self, selection, *args):
 
304
 
        """callback for when the treeview changes."""
 
305
 
        revision = self.treeview.get_revision()
 
306
 
        parents  = self.treeview.get_parents()
 
307
 
        children = self.treeview.get_children()
 
309
 
        if revision and revision != NULL_REVISION:
 
310
 
            prev_menu = gtk.Menu()
 
312
 
                self.prev_rev_action.set_sensitive(True)
 
313
 
                for parent_id in parents:
 
314
 
                    if parent_id and parent_id != NULL_REVISION:
 
315
 
                        parent = self.branch.repository.get_revision(parent_id)
 
317
 
                            str = ' (' + parent.properties['branch-nick'] + ')'
 
321
 
                        item = gtk.MenuItem(parent.message.split("\n")[0] + str)
 
322
 
                        item.connect('activate', self._set_revision_cb, parent_id)
 
326
 
                self.prev_rev_action.set_sensitive(False)
 
329
 
            self.prev_button.set_menu(prev_menu)
 
331
 
            next_menu = gtk.Menu()
 
332
 
            if len(children) > 0:
 
333
 
                self.next_rev_action.set_sensitive(True)
 
334
 
                for child_id in children:
 
335
 
                    child = self.branch.repository.get_revision(child_id)
 
337
 
                        str = ' (' + child.properties['branch-nick'] + ')'
 
341
 
                    item = gtk.MenuItem(child.message.split("\n")[0] + str)
 
342
 
                    item.connect('activate', self._set_revision_cb, child_id)
 
346
 
                self.next_rev_action.set_sensitive(False)
 
349
 
            self.next_button.set_menu(next_menu)
 
351
 
            self.revisionview.set_revision(revision)
 
352
 
            self.revisionview.set_children(children)
 
354
 
    def _tree_revision_activated(self, widget, path, col):
 
355
 
        # TODO: more than one parent
 
356
 
        """Callback for when a treeview row gets activated."""
 
357
 
        revision = self.treeview.get_revision()
 
358
 
        parents  = self.treeview.get_parents()
 
360
 
        if len(parents) == 0:
 
363
 
            parent_id = parents[0]
 
365
 
        self.show_diff(revision.revision_id, parent_id)
 
366
 
        self.treeview.grab_focus()
 
368
 
    def _menu_diff_cb(self,w):
 
369
 
        (path, focus) = self.treeview.treeview.get_cursor()
 
370
 
        revid = self.treeview.model[path][treemodel.REVID]
 
372
 
        parentids = self.branch.repository.revision_parents(revid)
 
374
 
        if len(parentids) == 0:
 
375
 
            parentid = NULL_REVISION
 
377
 
            parentid = parentids[0]
 
379
 
        self.show_diff(revid,parentid)    
 
381
 
    def _back_clicked_cb(self, *args):
 
382
 
        """Callback for when the back button is clicked."""
 
385
 
    def _fwd_clicked_cb(self, *args):
 
386
 
        """Callback for when the forward button is clicked."""
 
387
 
        self.treeview.forward()
 
389
 
    def _go_clicked_cb(self, w, p):
 
390
 
        """Callback for when the go button for a parent is clicked."""
 
391
 
        if self.revisionview.get_revision() is not None:
 
392
 
            self.treeview.set_revision(self.revisionview.get_revision())
 
394
 
    def _show_clicked_cb(self, revid, parentid):
 
395
 
        """Callback for when the show button for a parent is clicked."""
 
396
 
        self.show_diff(revid, parentid)
 
397
 
        self.treeview.grab_focus()
 
399
 
    def _compare_with_cb(self,w):
 
400
 
        """Callback for revision 'compare with' menu. Will show a small
 
401
 
            dialog with branch revisions to compare with selected revision in TreeView"""
 
403
 
        from bzrlib.plugins.gtk.revbrowser import RevisionBrowser
 
405
 
        rb = RevisionBrowser(self.branch,self)
 
408
 
        if ret == gtk.RESPONSE_OK:          
 
409
 
            (path, focus) = self.treeview.treeview.get_cursor()
 
410
 
            revid = self.treeview.model[path][treemodel.REVID]
 
411
 
            self.show_diff(revid, rb.selected_revid)
 
415
 
    def _set_revision_cb(self, w, revision_id):
 
416
 
        self.treeview.set_revision_id(revision_id)
 
418
 
    def _brokenlines_toggled_cb(self, button):
 
419
 
        self.compact_view = button.get_active()
 
421
 
        if self.compact_view:
 
426
 
        self.config.set_user_option('viz-compact-view', option)
 
427
 
        self.treeview.set_property('compact', self.compact_view)
 
428
 
        self.treeview.refresh()
 
430
 
    def _tag_revision_cb(self, w):
 
432
 
            self.treeview.set_sensitive(False)
 
433
 
            dialog = AddTagDialog(self.branch.repository, self.treeview.get_revision().revision_id, self.branch)
 
434
 
            response = dialog.run()
 
435
 
            if response != gtk.RESPONSE_NONE:
 
438
 
                if response == gtk.RESPONSE_OK:
 
439
 
                    self.treeview.add_tag(dialog.tagname, dialog._revid)
 
444
 
            self.treeview.set_sensitive(True)
 
446
 
    def _about_dialog_cb(self, w):
 
447
 
        from bzrlib.plugins.gtk.about import AboutDialog
 
451
 
    def _col_visibility_changed(self, col, property):
 
452
 
        self.config.set_user_option(property + '-column-visible', col.get_active())
 
453
 
        self.treeview.set_property(property + '-column-visible', col.get_active())
 
455
 
    def _toolbar_visibility_changed(self, col):
 
461
 
    def _show_about_cb(self, w):
 
462
 
        dialog = AboutDialog()
 
463
 
        dialog.connect('response', lambda d,r: d.destroy())
 
466
 
    def _refresh_clicked(self, w):
 
467
 
        self.treeview.refresh()
 
469
 
    def _update_tags(self):
 
472
 
        if self.branch.supports_tags():
 
473
 
            tags = self.branch.tags.get_tag_dict().items()
 
476
 
            for tag, revid in tags:
 
477
 
                tag_image = gtk.Image()
 
478
 
                tag_image.set_from_file(icon_path('tag-16.png'))
 
479
 
                tag_item = gtk.ImageMenuItem(tag.replace('_', '__'))
 
480
 
                tag_item.set_image(tag_image)
 
481
 
                tag_item.connect('activate', self._tag_selected_cb, revid)
 
483
 
            self.go_menu_tags.set_submenu(menu)
 
485
 
            self.go_menu_tags.set_sensitive(len(tags) != 0)
 
487
 
            self.go_menu_tags.set_sensitive(False)
 
489
 
        self.go_menu_tags.show_all()
 
491
 
    def show_diff(self, revid=None, parentid=None):
 
492
 
        """Open a new window to show a diff between the given revisions."""
 
493
 
        from bzrlib.plugins.gtk.diff import DiffWindow
 
494
 
        window = DiffWindow(parent=self)
 
497
 
            parentid = NULL_REVISION
 
499
 
        rev_tree    = self.branch.repository.revision_tree(revid)
 
500
 
        parent_tree = self.branch.repository.revision_tree(parentid)
 
502
 
        description = revid + " - " + self.branch.nick
 
503
 
        window.set_diff(description, rev_tree, parent_tree)