1
# -*- coding: UTF-8 -*-
2
"""Revision history view.
6
__copyright__ = "Copyright © 2005 Canonical Ltd."
7
__author__ = "Daniel Schierbeck <daniel.schierbeck@gmail.com>"
9
from gi.repository import Gtk
10
from gi.repository import GObject
11
from gi.repository import Pango
14
from bzrlib.revision import NULL_REVISION
16
from bzrlib.plugins.gtk import lock
17
from bzrlib.plugins.gtk.ui import ProgressPanel
18
from bzrlib.plugins.gtk.branchview import treemodel
19
from bzrlib.plugins.gtk.branchview.linegraph import linegraph, same_branch
20
from bzrlib.plugins.gtk.branchview.graphcell import CellRendererGraph
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
'revision-selected': (GObject.SignalFlags.RUN_FIRST,
88
'revision-activated': (GObject.SignalFlags.RUN_FIRST,
90
(GObject.TYPE_PYOBJECT, GObject.TYPE_PYOBJECT)),
91
'tag-added': (GObject.SignalFlags.RUN_FIRST,
93
(GObject.TYPE_STRING, GObject.TYPE_STRING)),
94
'refreshed': (GObject.SignalFlags.RUN_FIRST, None,
98
def __init__(self, branch, start, maxnum, compact=True):
99
"""Create a new TreeView.
101
:param branch: Branch object for branch to show.
102
:param start: Revision id of top revision.
103
:param maxnum: Maximum number of revisions to display,
105
:param broken_line_length: After how much lines to break
108
GObject.GObject.__init__(self, spacing=0)
110
self.progress_widget = ProgressPanel()
111
self.pack_start(self.progress_widget, expand=False, fill=True)
112
if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
113
# We'are using our own ui, let's tell it to use our widget.
114
ui.ui_factory.set_progress_bar_widget(self.progress_widget)
116
self.scrolled_window = Gtk.ScrolledWindow()
117
self.scrolled_window.set_policy(Gtk.PolicyType.AUTOMATIC,
118
Gtk.PolicyType.AUTOMATIC)
119
self.scrolled_window.set_shadow_type(Gtk.ShadowType.IN)
120
self.scrolled_window.show()
121
self.pack_start(self.scrolled_window, expand=True, fill=True)
123
self.scrolled_window.add(self.construct_treeview())
132
self.compact = compact
134
self.model = treemodel.TreeModel(self.branch, [])
135
GObject.idle_add(self.populate)
137
self.connect("destroy", self._on_destroy)
139
def _on_destroy(self, *ignored):
141
if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
142
# We'are using our own ui, let's tell it to stop using our widget.
143
ui.ui_factory.set_progress_bar_widget(None)
145
def do_get_property(self, property):
146
if property.name == 'revno-column-visible':
147
return self.revno_column.get_visible()
148
elif property.name == 'graph-column-visible':
149
return self.graph_column.get_visible()
150
elif property.name == 'date-column-visible':
151
return self.date_column.get_visible()
152
elif property.name == 'compact':
154
elif property.name == 'mainline-only':
155
return self.mainline_only
156
elif property.name == 'branch':
158
elif property.name == 'revision':
159
if self.path is None:
161
return self.model.get_value(self.model.get_iter(self.path),
163
elif property.name == 'revision-number':
164
if self.path is None:
166
return self.model.get_value(self.model.get_iter(self.path),
168
elif property.name == 'children':
169
if self.path is None:
171
return self.model.get_value(self.model.get_iter(self.path),
173
elif property.name == 'parents':
174
if self.path is None:
176
return self.model.get_value(self.model.get_iter(self.path),
179
raise AttributeError, 'unknown property %s' % property.name
181
def do_set_property(self, property, value):
182
if property.name == 'revno-column-visible':
183
self.revno_column.set_visible(value)
184
elif property.name == 'graph-column-visible':
185
self.graph_column.set_visible(value)
186
elif property.name == 'date-column-visible':
187
self.date_column.set_visible(value)
188
elif property.name == 'compact':
190
elif property.name == 'mainline-only':
191
self.mainline_only = value
192
elif property.name == 'branch':
194
elif property.name == 'revision':
195
self.set_revision_id(value.revision_id)
197
raise AttributeError, 'unknown property %s' % property.name
199
def get_revision(self):
200
"""Return revision id of currently selected revision, or None."""
201
return self.get_property('revision')
203
def has_revision_id(self, revision_id):
204
return (revision_id in self.index)
206
def set_revision(self, revision):
207
self.set_property('revision', revision)
209
def set_revision_id(self, revid):
210
"""Change the currently selected revision.
212
:param revid: Revision id of revision to display.
214
self.treeview.set_cursor(self.index[revid])
215
self.treeview.grab_focus()
217
def get_children(self):
218
"""Return the children of the currently selected revision.
220
:return: list of revision ids.
222
return self.get_property('children')
224
def get_parents(self):
225
"""Return the parents of the currently selected revision.
227
:return: list of revision ids.
229
return self.get_property('parents')
231
def add_tag(self, tag, revid=None):
232
if revid is None: revid = self.revision.revision_id
234
if lock.release(self.branch):
236
lock.acquire(self.branch, lock.WRITE)
237
self.model.add_tag(tag, revid)
239
lock.release(self.branch)
241
lock.acquire(self.branch, lock.READ)
243
self.emit('tag-added', tag, revid)
246
GObject.idle_add(self.populate, self.get_revision())
252
self.branch.lock_write()
257
self.branch.lock_read()
260
"""Signal handler for the Back button."""
261
parents = self.get_parents()
265
for parent_id in parents:
266
parent_index = self.index[parent_id]
267
parent = self.model[parent_index][treemodel.REVISION]
268
if same_branch(self.get_revision(), parent):
269
self.set_revision(parent)
272
self.set_revision_id(parents[0])
275
"""Signal handler for the Forward button."""
276
children = self.get_children()
277
if not len(children):
280
for child_id in children:
281
child_index = self.index[child_id]
282
child = self.model[child_index][treemodel.REVISION]
283
if same_branch(child, self.get_revision()):
284
self.set_revision(child)
287
self.set_revision_id(children[0])
289
def populate(self, revision=None):
290
"""Fill the treeview with contents.
292
:param start: Revision id of revision to start with.
293
:param maxnum: Maximum number of revisions to display, or None
295
:param broken_line_length: After how much lines branches \
299
if getattr(ui.ui_factory, "set_progress_bar_widget", None) is not None:
300
# We'are using our own ui, let's tell it to use our widget.
301
ui.ui_factory.set_progress_bar_widget(self.progress_widget)
302
self.progress_bar = ui.ui_factory.nested_progress_bar()
303
self.progress_bar.update("Loading ancestry graph", 0, 5)
307
broken_line_length = 32
309
broken_line_length = None
311
show_graph = self.graph_column.get_visible()
313
self.branch.lock_read()
314
(linegraphdata, index, columns_len) = linegraph(self.branch.repository.get_graph(),
322
self.model.line_graph_data = linegraphdata
323
self.graph_cell.columns_len = columns_len
324
width = self.graph_cell.get_size(self.treeview)[2]
327
self.graph_column.set_fixed_width(width)
328
self.graph_column.set_max_width(width)
330
self.treeview.set_model(self.model)
332
if not revision or revision == NULL_REVISION:
333
self.treeview.set_cursor(0)
335
self.set_revision(revision)
337
self.emit('refreshed')
340
self.progress_bar.finished()
342
def construct_treeview(self):
343
self.treeview = Gtk.TreeView()
345
self.treeview.set_rules_hint(True)
346
# combined revno/summary interactive search
348
# the row in a treemodel is considered "matched" if a REVNO *starts*
349
# from the key (that is the key is found in a REVNO at the offset 0)
350
# or if a MESSAGE *contains* the key anywhere (that is, the key is
351
# found case insensitively in a MESSAGE at any offset)
352
def search_equal_func(model, column, key, iter):
353
return (model.get_value(iter, treemodel.REVNO).find(key) != 0
354
and model.get_value(iter, treemodel.MESSAGE).lower().find(key.lower()) == -1)
356
self.treeview.set_search_equal_func(search_equal_func)
357
self.treeview.set_enable_search(True)
359
set_tooltip(treemodel.MESSAGE)
361
self._prev_cursor_path = None
362
self.treeview.connect("cursor-changed",
363
self._on_selection_changed)
365
self.treeview.connect("row-activated",
366
self._on_revision_activated)
368
self.treeview.connect("button-release-event",
369
self._on_revision_selected)
371
self.treeview.set_property('fixed-height-mode', True)
375
cell = Gtk.CellRendererText()
376
cell.set_property("width-chars", 15)
377
cell.set_property("ellipsize", Pango.EllipsizeMode.END)
378
self.revno_column = Gtk.TreeViewColumn("Revision No")
379
self.revno_column.set_resizable(True)
380
self.revno_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
381
self.revno_column.set_fixed_width(cell.get_size(self.treeview)[2])
382
self.revno_column.pack_start(cell, True, True, 0)
383
self.revno_column.add_attribute(cell, "text", treemodel.REVNO)
384
self.treeview.append_column(self.revno_column)
386
self.graph_cell = CellRendererGraph()
387
self.graph_column = Gtk.TreeViewColumn()
388
self.graph_column.set_resizable(True)
389
self.graph_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
390
self.graph_column.pack_start(self.graph_cell, True, True, 0)
391
self.graph_column.add_attribute(self.graph_cell, "node", treemodel.NODE)
392
self.graph_column.add_attribute(self.graph_cell, "tags", treemodel.TAGS)
393
self.graph_column.add_attribute(self.graph_cell, "in-lines", treemodel.LAST_LINES)
394
self.graph_column.add_attribute(self.graph_cell, "out-lines", treemodel.LINES)
395
self.treeview.append_column(self.graph_column)
397
cell = Gtk.CellRendererText()
398
cell.set_property("width-chars", 65)
399
cell.set_property("ellipsize", Pango.EllipsizeMode.END)
400
self.summary_column = Gtk.TreeViewColumn("Summary")
401
self.summary_column.set_resizable(True)
402
self.summary_column.set_expand(True)
403
self.summary_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
404
self.summary_column.set_fixed_width(cell.get_size(self.treeview)[2])
405
self.summary_column.pack_start(cell, True, True, 0)
406
self.summary_column.add_attribute(cell, "markup", treemodel.SUMMARY)
407
self.treeview.append_column(self.summary_column)
409
cell = Gtk.CellRendererText()
410
cell.set_property("width-chars", 15)
411
cell.set_property("ellipsize", Pango.EllipsizeMode.END)
412
self.authors_column = Gtk.TreeViewColumn("Author(s)")
413
self.authors_column.set_resizable(False)
414
self.authors_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
415
self.authors_column.set_fixed_width(200)
416
self.authors_column.pack_start(cell, True, True, 0)
417
self.authors_column.add_attribute(cell, "text", treemodel.AUTHORS)
418
self.treeview.append_column(self.authors_column)
420
cell = Gtk.CellRendererText()
421
cell.set_property("width-chars", 20)
422
cell.set_property("ellipsize", Pango.EllipsizeMode.END)
423
self.date_column = Gtk.TreeViewColumn("Date")
424
self.date_column.set_visible(False)
425
self.date_column.set_resizable(True)
426
self.date_column.set_sizing(Gtk.TreeViewColumnSizing.FIXED)
427
self.date_column.set_fixed_width(130)
428
self.date_column.pack_start(cell, True, True, 0)
429
self.date_column.add_attribute(cell, "text", treemodel.TIMESTAMP)
430
self.treeview.append_column(self.date_column)
434
def _on_selection_changed(self, treeview):
435
"""callback for when the treeview changes."""
436
(path, focus) = treeview.get_cursor()
437
if (path is not None) and (path != self._prev_cursor_path):
438
self._prev_cursor_path = path # avoid emitting twice per click
440
self.emit('revision-selected')
442
def _on_revision_selected(self, widget, event):
443
from bzrlib.plugins.gtk.revisionmenu import RevisionMenu
444
if event.button == 3:
445
menu = RevisionMenu(self.branch.repository,
446
[self.get_revision().revision_id],
448
menu.connect('tag-added', lambda w, t, r: self.add_tag(t, r))
449
menu.popup(None, None, None, event.button, event.get_time())
451
def _on_revision_activated(self, widget, path, col):
452
self.emit('revision-activated', path, col)