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 import icon_path
17
from bzrlib.plugins.gtk.branchview import TreeView, treemodel
18
from bzrlib.plugins.gtk.tags import AddTagDialog
19
from bzrlib.plugins.gtk.preferences import PreferencesWindow
20
from bzrlib.plugins.gtk.revisionmenu import RevisionMenu
21
from bzrlib.plugins.gtk.window import Window
23
from bzrlib.config import BranchConfig, GlobalConfig
24
from bzrlib.revision import Revision, NULL_REVISION
25
from bzrlib.trace import mutter
27
class BranchWindow(Window):
30
This object represents and manages a single window containing information
31
for a particular branch.
34
def __init__(self, branch, start_revs, maxnum, parent=None):
35
"""Create a new BranchWindow.
37
:param branch: Branch object for branch to show.
38
:param start_revs: Revision ids of top revisions.
39
:param maxnum: Maximum number of revisions to display,
43
Window.__init__(self, parent=parent)
44
self.set_border_width(0)
47
self.start_revs = start_revs
49
self.config = GlobalConfig()
51
self._sizes = {} # window and widget sizes
53
if self.config.get_user_option('viz-compact-view') == 'yes':
54
self.compact_view = True
56
self.compact_view = False
58
self.set_title(branch.nick + " - revision history")
60
# user-configured window size
61
size = self._load_size('viz-window-size')
65
# Use three-quarters of the screen by default
66
screen = self.get_screen()
67
monitor = screen.get_monitor_geometry(0)
68
width = int(monitor.width * 0.75)
69
height = int(monitor.height * 0.75)
70
self.set_default_size(width, height)
71
self.set_size_request(width/3, height/3)
72
self.connect("size-allocate", self._on_size_allocate, 'viz-window-size')
75
icon = self.render_icon(gtk.STOCK_INDEX, gtk.ICON_SIZE_BUTTON)
78
gtk.accel_map_add_entry("<viz>/Go/Next Revision", gtk.keysyms.Up, gtk.gdk.MOD1_MASK)
79
gtk.accel_map_add_entry("<viz>/Go/Previous Revision", gtk.keysyms.Down, gtk.gdk.MOD1_MASK)
80
gtk.accel_map_add_entry("<viz>/View/Refresh", gtk.keysyms.F5, 0)
82
self.accel_group = gtk.AccelGroup()
83
self.add_accel_group(self.accel_group)
85
gtk.Action.set_tool_item_type(gtk.MenuToolButton)
87
self.prev_rev_action = gtk.Action("prev-rev", "_Previous Revision", "Go to the previous revision", gtk.STOCK_GO_DOWN)
88
self.prev_rev_action.set_accel_path("<viz>/Go/Previous Revision")
89
self.prev_rev_action.set_accel_group(self.accel_group)
90
self.prev_rev_action.connect("activate", self._back_clicked_cb)
91
self.prev_rev_action.connect_accelerator()
93
self.next_rev_action = gtk.Action("next-rev", "_Next Revision", "Go to the next revision", gtk.STOCK_GO_UP)
94
self.next_rev_action.set_accel_path("<viz>/Go/Next Revision")
95
self.next_rev_action.set_accel_group(self.accel_group)
96
self.next_rev_action.connect("activate", self._fwd_clicked_cb)
97
self.next_rev_action.connect_accelerator()
99
self.refresh_action = gtk.Action("refresh", "_Refresh", "Refresh view", gtk.STOCK_REFRESH)
100
self.refresh_action.set_accel_path("<viz>/View/Refresh")
101
self.refresh_action.set_accel_group(self.accel_group)
102
self.refresh_action.connect("activate", self._refresh_clicked)
103
self.refresh_action.connect_accelerator()
107
def set_revision(self, revid):
108
self.treeview.set_revision_id(revid)
111
"""Construct the window contents."""
112
vbox = gtk.VBox(spacing=0)
115
self.paned = gtk.VPaned()
116
self.paned.pack1(self.construct_top(), resize=False, shrink=True)
117
self.paned.pack2(self.construct_bottom(), resize=True, shrink=False)
120
nav = self.construct_navigation()
121
menubar = self.construct_menubar()
122
vbox.pack_start(menubar, expand=False, fill=True)
123
vbox.pack_start(nav, expand=False, fill=True)
125
vbox.pack_start(self.paned, expand=True, fill=True)
126
vbox.set_focus_child(self.paned)
130
def construct_menubar(self):
131
menubar = gtk.MenuBar()
133
file_menu = gtk.Menu()
134
file_menuitem = gtk.MenuItem("_File")
135
file_menuitem.set_submenu(file_menu)
137
file_menu_close = gtk.ImageMenuItem(gtk.STOCK_CLOSE, self.accel_group)
138
file_menu_close.connect('activate', lambda x: self.destroy())
140
file_menu_quit = gtk.ImageMenuItem(gtk.STOCK_QUIT, self.accel_group)
141
file_menu_quit.connect('activate', lambda x: gtk.main_quit())
143
if self._parent is not None:
144
file_menu.add(file_menu_close)
145
file_menu.add(file_menu_quit)
147
edit_menu = gtk.Menu()
148
edit_menuitem = gtk.MenuItem("_Edit")
149
edit_menuitem.set_submenu(edit_menu)
151
edit_menu_branchopts = gtk.MenuItem("Branch Settings")
152
edit_menu_branchopts.connect('activate', lambda x: PreferencesWindow(self.branch.get_config()).show())
154
edit_menu_globopts = gtk.MenuItem("Global Settings")
155
edit_menu_globopts.connect('activate', lambda x: PreferencesWindow().show())
157
edit_menu.add(edit_menu_branchopts)
158
edit_menu.add(edit_menu_globopts)
160
view_menu = gtk.Menu()
161
view_menuitem = gtk.MenuItem("_View")
162
view_menuitem.set_submenu(view_menu)
164
view_menu_refresh = self.refresh_action.create_menu_item()
165
view_menu_refresh.connect('activate', self._refresh_clicked)
167
view_menu.add(view_menu_refresh)
168
view_menu.add(gtk.SeparatorMenuItem())
170
view_menu_toolbar = gtk.CheckMenuItem("Show Toolbar")
171
view_menu_toolbar.set_active(True)
172
if self.config.get_user_option('viz-toolbar-visible') == 'False':
173
view_menu_toolbar.set_active(False)
175
view_menu_toolbar.connect('toggled', self._toolbar_visibility_changed)
177
view_menu_compact = gtk.CheckMenuItem("Show Compact Graph")
178
view_menu_compact.set_active(self.compact_view)
179
view_menu_compact.connect('activate', self._brokenlines_toggled_cb)
181
view_menu_diffs = gtk.CheckMenuItem("Show Diffs")
182
view_menu_diffs.set_active(False)
183
if self.config.get_user_option('viz-show-diffs') == 'True':
184
view_menu_diffs.set_active(True)
185
view_menu_diffs.connect('toggled', self._diff_visibility_changed)
187
view_menu_wide_diffs = gtk.CheckMenuItem("Wide Diffs")
188
view_menu_wide_diffs.set_active(False)
189
if self.config.get_user_option('viz-wide-diffs') == 'True':
190
view_menu_wide_diffs.set_active(True)
191
view_menu_wide_diffs.connect('toggled', self._diff_placement_changed)
193
view_menu_wrap_diffs = gtk.CheckMenuItem("Wrap _Long Lines in Diffs")
194
view_menu_wrap_diffs.set_active(False)
195
if self.config.get_user_option('viz-wrap-diffs') == 'True':
196
view_menu_wrap_diffs.set_active(True)
197
view_menu_wrap_diffs.connect('toggled', self._diff_wrap_changed)
199
view_menu.add(view_menu_toolbar)
200
view_menu.add(view_menu_compact)
201
view_menu.add(gtk.SeparatorMenuItem())
202
view_menu.add(view_menu_diffs)
203
view_menu.add(view_menu_wide_diffs)
204
view_menu.add(view_menu_wrap_diffs)
205
view_menu.add(gtk.SeparatorMenuItem())
207
self.mnu_show_revno_column = gtk.CheckMenuItem("Show Revision _Number Column")
208
self.mnu_show_date_column = gtk.CheckMenuItem("Show _Date Column")
210
# Revision numbers are pointless if there are multiple branches
211
if len(self.start_revs) > 1:
212
self.mnu_show_revno_column.set_sensitive(False)
213
self.treeview.set_property('revno-column-visible', False)
215
for (col, name) in [(self.mnu_show_revno_column, "revno"),
216
(self.mnu_show_date_column, "date")]:
217
col.set_active(self.treeview.get_property(name + "-column-visible"))
218
col.connect('toggled', self._col_visibility_changed, name)
222
go_menu.set_accel_group(self.accel_group)
223
go_menuitem = gtk.MenuItem("_Go")
224
go_menuitem.set_submenu(go_menu)
226
go_menu_next = self.next_rev_action.create_menu_item()
227
go_menu_prev = self.prev_rev_action.create_menu_item()
229
tag_image = gtk.Image()
230
tag_image.set_from_file(icon_path("tag-16.png"))
231
self.go_menu_tags = gtk.ImageMenuItem("_Tags")
232
self.go_menu_tags.set_image(tag_image)
233
self.treeview.connect('refreshed', lambda w: self._update_tags())
235
go_menu.add(go_menu_next)
236
go_menu.add(go_menu_prev)
237
go_menu.add(gtk.SeparatorMenuItem())
238
go_menu.add(self.go_menu_tags)
240
self.revision_menu = RevisionMenu(self.branch.repository, [], self.branch, parent=self)
241
revision_menuitem = gtk.MenuItem("_Revision")
242
revision_menuitem.set_submenu(self.revision_menu)
244
branch_menu = gtk.Menu()
245
branch_menuitem = gtk.MenuItem("_Branch")
246
branch_menuitem.set_submenu(branch_menu)
248
branch_menu.add(gtk.MenuItem("Pu_ll Revisions"))
249
branch_menu.add(gtk.MenuItem("Pu_sh Revisions"))
252
from bzrlib.plugins import search
254
mutter("Didn't find search plugin")
256
branch_menu.add(gtk.SeparatorMenuItem())
258
branch_index_menuitem = gtk.MenuItem("_Index")
259
branch_index_menuitem.connect('activate', self._branch_index_cb)
260
branch_menu.add(branch_index_menuitem)
262
branch_search_menuitem = gtk.MenuItem("_Search")
263
branch_search_menuitem.connect('activate', self._branch_search_cb)
264
branch_menu.add(branch_search_menuitem)
266
help_menu = gtk.Menu()
267
help_menuitem = gtk.MenuItem("_Help")
268
help_menuitem.set_submenu(help_menu)
270
help_about_menuitem = gtk.ImageMenuItem(gtk.STOCK_ABOUT, self.accel_group)
271
help_about_menuitem.connect('activate', self._about_dialog_cb)
273
help_menu.add(help_about_menuitem)
275
menubar.add(file_menuitem)
276
menubar.add(edit_menuitem)
277
menubar.add(view_menuitem)
278
menubar.add(go_menuitem)
279
menubar.add(revision_menuitem)
280
menubar.add(branch_menuitem)
281
menubar.add(help_menuitem)
286
def construct_top(self):
287
"""Construct the top-half of the window."""
288
# FIXME: Make broken_line_length configurable
290
self.treeview = TreeView(self.branch, self.start_revs, self.maxnum, self.compact_view)
292
self.treeview.connect('revision-selected',
293
self._treeselection_changed_cb)
294
self.treeview.connect('revision-activated',
295
self._tree_revision_activated)
297
self.treeview.connect('tag-added', lambda w, t, r: self._update_tags())
299
for col in ["revno", "date"]:
300
option = self.config.get_user_option(col + '-column-visible')
301
if option is not None:
302
self.treeview.set_property(col + '-column-visible', option == 'True')
304
self.treeview.set_property(col + '-column-visible', False)
308
align = gtk.Alignment(0.0, 0.0, 1.0, 1.0)
309
align.set_padding(5, 0, 0, 0)
310
align.add(self.treeview)
311
# user-configured size
312
size = self._load_size('viz-graph-size')
315
align.set_size_request(width, height)
317
(width, height) = self.get_size()
318
align.set_size_request(width, int(height / 2.5))
319
align.connect('size-allocate', self._on_size_allocate, 'viz-graph-size')
324
def construct_navigation(self):
325
"""Construct the navigation buttons."""
326
self.toolbar = gtk.Toolbar()
327
self.toolbar.set_style(gtk.TOOLBAR_BOTH_HORIZ)
329
self.prev_button = self.prev_rev_action.create_tool_item()
330
self.toolbar.insert(self.prev_button, -1)
332
self.next_button = self.next_rev_action.create_tool_item()
333
self.toolbar.insert(self.next_button, -1)
335
self.toolbar.insert(gtk.SeparatorToolItem(), -1)
337
refresh_button = gtk.ToolButton(gtk.STOCK_REFRESH)
338
refresh_button.connect('clicked', self._refresh_clicked)
339
self.toolbar.insert(refresh_button, -1)
341
self.toolbar.show_all()
345
def construct_bottom(self):
346
"""Construct the bottom half of the window."""
347
if self.config.get_user_option('viz-wide-diffs') == 'True':
348
self.diff_paned = gtk.VPaned()
350
self.diff_paned = gtk.HPaned()
351
(width, height) = self.get_size()
352
self.diff_paned.set_size_request(20, 20) # shrinkable
354
from bzrlib.plugins.gtk.revisionview import RevisionView
355
self.revisionview = RevisionView(branch=self.branch)
356
self.revisionview.set_size_request(width/3, int(height / 2.5))
357
# user-configured size
358
size = self._load_size('viz-revisionview-size')
361
self.revisionview.set_size_request(width, height)
362
self.revisionview.connect('size-allocate', self._on_size_allocate, 'viz-revisionview-size')
363
self.revisionview.show()
364
self.revisionview.set_show_callback(self._show_clicked_cb)
365
self.revisionview.connect('notify::revision', self._go_clicked_cb)
366
self.treeview.connect('tag-added', lambda w, t, r: self.revisionview.update_tags())
367
self.diff_paned.pack1(self.revisionview)
369
from bzrlib.plugins.gtk.diff import DiffWidget
370
self.diff = DiffWidget()
371
self.diff_paned.pack2(self.diff)
373
self.diff_paned.show_all()
374
if self.config.get_user_option('viz-show-diffs') != 'True':
377
return self.diff_paned
379
def _tag_selected_cb(self, menuitem, revid):
380
self.treeview.set_revision_id(revid)
382
def _treeselection_changed_cb(self, selection, *args):
383
"""callback for when the treeview changes."""
384
revision = self.treeview.get_revision()
385
parents = self.treeview.get_parents()
386
children = self.treeview.get_children()
388
self.revision_menu.set_revision_ids([revision.revision_id])
390
if revision and revision != NULL_REVISION:
391
prev_menu = gtk.Menu()
393
self.prev_rev_action.set_sensitive(True)
394
for parent_id in parents:
395
if parent_id and parent_id != NULL_REVISION:
396
parent = self.branch.repository.get_revision(parent_id)
398
str = ' (' + parent.properties['branch-nick'] + ')'
402
item = gtk.MenuItem(parent.message.split("\n")[0] + str)
403
item.connect('activate', self._set_revision_cb, parent_id)
407
self.prev_rev_action.set_sensitive(False)
410
self.prev_button.set_menu(prev_menu)
412
next_menu = gtk.Menu()
413
if len(children) > 0:
414
self.next_rev_action.set_sensitive(True)
415
for child_id in children:
416
child = self.branch.repository.get_revision(child_id)
418
str = ' (' + child.properties['branch-nick'] + ')'
422
item = gtk.MenuItem(child.message.split("\n")[0] + str)
423
item.connect('activate', self._set_revision_cb, child_id)
427
self.next_rev_action.set_sensitive(False)
430
self.next_button.set_menu(next_menu)
432
self.revisionview.set_revision(revision)
433
self.revisionview.set_children(children)
434
self.update_diff_panel(revision, parents)
436
def _tree_revision_activated(self, widget, path, col):
437
# TODO: more than one parent
438
"""Callback for when a treeview row gets activated."""
439
revision = self.treeview.get_revision()
440
parents = self.treeview.get_parents()
442
if len(parents) == 0:
445
parent_id = parents[0]
447
self.show_diff(revision.revision_id, parent_id)
448
self.treeview.grab_focus()
450
def _back_clicked_cb(self, *args):
451
"""Callback for when the back button is clicked."""
454
def _fwd_clicked_cb(self, *args):
455
"""Callback for when the forward button is clicked."""
456
self.treeview.forward()
458
def _go_clicked_cb(self, w, p):
459
"""Callback for when the go button for a parent is clicked."""
460
if self.revisionview.get_revision() is not None:
461
self.treeview.set_revision(self.revisionview.get_revision())
463
def _show_clicked_cb(self, revid, parentid):
464
"""Callback for when the show button for a parent is clicked."""
465
self.show_diff(revid, parentid)
466
self.treeview.grab_focus()
468
def _set_revision_cb(self, w, revision_id):
469
self.treeview.set_revision_id(revision_id)
471
def _brokenlines_toggled_cb(self, button):
472
self.compact_view = button.get_active()
474
if self.compact_view:
479
self.config.set_user_option('viz-compact-view', option)
480
self.treeview.set_property('compact', self.compact_view)
481
self.treeview.refresh()
483
def _branch_index_cb(self, w):
484
from bzrlib.plugins.search import index as _mod_index
485
_mod_index.index_url(self.branch.base)
487
def _branch_search_cb(self, w):
488
from bzrlib.plugins.search import index as _mod_index
489
from bzrlib.plugins.gtk.search import SearchDialog
490
from bzrlib.plugins.search import errors as search_errors
493
index = _mod_index.open_index_url(self.branch.base)
494
except search_errors.NoSearchIndex:
495
dialog = gtk.MessageDialog(self, type=gtk.MESSAGE_QUESTION,
496
buttons=gtk.BUTTONS_OK_CANCEL,
497
message_format="This branch has not been indexed yet. "
499
if dialog.run() == gtk.RESPONSE_OK:
501
index = _mod_index.index_url(self.branch.base)
506
dialog = SearchDialog(index)
508
if dialog.run() == gtk.RESPONSE_OK:
509
self.set_revision(dialog.get_revision())
513
def _about_dialog_cb(self, w):
514
from bzrlib.plugins.gtk.about import AboutDialog
518
def _col_visibility_changed(self, col, property):
519
self.config.set_user_option(property + '-column-visible', col.get_active())
520
self.treeview.set_property(property + '-column-visible', col.get_active())
522
def _toolbar_visibility_changed(self, col):
527
self.config.set_user_option('viz-toolbar-visible', col.get_active())
529
def _make_diff_nonzero_size(self):
530
"""make sure the diff isn't zero-width or zero-height"""
531
alloc = self.diff.get_allocation()
532
if (alloc.width < 10) or (alloc.height < 10):
533
width, height = self.get_size()
534
self.revisionview.set_size_request(width/3, int(height / 2.5))
536
def _diff_visibility_changed(self, col):
537
"""Hide or show the diff panel."""
540
self._make_diff_nonzero_size()
543
self.config.set_user_option('viz-show-diffs', str(col.get_active()))
544
self.update_diff_panel()
546
def _diff_placement_changed(self, col):
547
"""Toggle the diff panel's position."""
548
self.config.set_user_option('viz-wide-diffs', str(col.get_active()))
550
old = self.paned.get_child2()
551
self.paned.remove(old)
552
self.paned.pack2(self.construct_bottom(), resize=True, shrink=False)
553
self._make_diff_nonzero_size()
555
self.treeview.emit('revision-selected')
557
def _diff_wrap_changed(self, widget):
558
"""Toggle word wrap in the diff widget."""
559
self.config.set_user_option('viz-wrap-diffs', widget.get_active())
560
self.diff._on_wraplines_toggled(widget)
562
def _show_about_cb(self, w):
563
dialog = AboutDialog()
564
dialog.connect('response', lambda d,r: d.destroy())
567
def _refresh_clicked(self, w):
568
self.treeview.refresh()
570
def _update_tags(self):
573
if self.branch.supports_tags():
574
tags = self.branch.tags.get_tag_dict().items()
575
tags.sort(reverse=True)
576
for tag, revid in tags:
577
tag_image = gtk.Image()
578
tag_image.set_from_file(icon_path('tag-16.png'))
579
tag_item = gtk.ImageMenuItem(tag.replace('_', '__'))
580
tag_item.set_image(tag_image)
581
tag_item.connect('activate', self._tag_selected_cb, revid)
582
tag_item.set_sensitive(self.treeview.has_revision_id(revid))
584
self.go_menu_tags.set_submenu(menu)
586
self.go_menu_tags.set_sensitive(len(tags) != 0)
588
self.go_menu_tags.set_sensitive(False)
590
self.go_menu_tags.show_all()
592
def _load_size(self, name):
593
"""Read and parse 'name' from self.config.
594
The value is a string, formatted as WIDTHxHEIGHT
595
Returns None, or (width, height)
597
size = self.config.get_user_option(name)
599
width, height = [int(num) for num in size.split('x')]
600
# avoid writing config every time we start
601
self._sizes[name] = (width, height)
605
def _on_size_allocate(self, widget, allocation, name):
606
"""When window has been resized, save the new size."""
608
if name in self._sizes:
609
width, height = self._sizes[name]
611
size_changed = (width != allocation.width) or \
612
(height != allocation.height)
615
width, height = allocation.width, allocation.height
616
self._sizes[name] = (width, height)
617
value = '%sx%s' % (width, height)
618
self.config.set_user_option(name, value)
620
def show_diff(self, revid=None, parentid=None):
621
"""Open a new window to show a diff between the given revisions."""
622
from bzrlib.plugins.gtk.diff import DiffWindow
623
window = DiffWindow(parent=self)
626
parentid = NULL_REVISION
628
rev_tree = self.branch.repository.revision_tree(revid)
629
parent_tree = self.branch.repository.revision_tree(parentid)
631
description = revid + " - " + self.branch.nick
632
window.set_diff(description, rev_tree, parent_tree)
635
def update_diff_panel(self, revision=None, parents=None):
636
"""Show the current revision in the diff panel."""
637
if self.config.get_user_option('viz-show-diffs') != 'True':
640
if not revision: # default to selected row
641
revision = self.treeview.get_revision()
642
if (not revision) or (revision == NULL_REVISION):
645
if not parents: # default to selected row's parents
646
parents = self.treeview.get_parents()
647
if len(parents) == 0:
650
parent_id = parents[0]
652
rev_tree = self.branch.repository.revision_tree(revision.revision_id)
653
parent_tree = self.branch.repository.revision_tree(parent_id)
655
self.diff.set_diff(rev_tree, parent_tree)
656
if self.config.get_user_option('viz-wrap-diffs') == 'True':
657
self.diff._on_wraplines_toggled(wrap=True)