1
# -*- coding: UTF-8 -*-
1
2
"""Difference window.
3
4
This module contains the code to manage the diff window which shows
4
5
the changes made between two revisions on a branch.
7
__copyright__ = "Copyright 2005 Canonical Ltd."
8
__author__ = "Scott James Remnant <scott@ubuntu.com>"
8
__copyright__ = "Copyright © 2005 Canonical Ltd."
9
__author__ = "Scott James Remnant <scott@ubuntu.com>"
11
12
from cStringIO import StringIO
16
from gi.repository import Gtk
17
from gi.repository import Pango
19
from gi.repository import GtkSource
20
24
have_gtksourceview = True
21
25
except ImportError:
22
26
have_gtksourceview = False
31
from bzrlib.diff import show_diff_trees
32
from bzrlib.patches import parse_patches
33
from bzrlib.plugins.gtk.dialog import (
38
from bzrlib.plugins.gtk.i18n import _i18n
33
from bzrlib import osutils
34
from bzrlib.diff import show_diff_trees, internal_diff
35
from bzrlib.errors import NoSuchFile
36
from bzrlib.trace import warning
39
37
from bzrlib.plugins.gtk.window import Window
42
def fallback_guess_language(slm, content_type):
43
for lang_id in slm.get_language_ids():
44
lang = slm.get_language(lang_id)
45
if "text/x-patch" in lang.get_mime_types():
50
class SelectCancelled(Exception):
55
class DiffFileView(Gtk.ScrolledWindow):
56
"""Window for displaying diffs from a diff file"""
40
class DiffView(gtk.ScrolledWindow):
41
"""This is the soft and chewy filling for a DiffWindow."""
60
43
def __init__(self):
61
super(DiffFileView, self).__init__()
44
gtk.ScrolledWindow.__init__(self)
48
self.parent_tree = None
65
50
def construct(self):
66
self.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
67
self.set_shadow_type(Gtk.ShadowType.IN)
51
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
52
self.set_shadow_type(gtk.SHADOW_IN)
69
54
if have_gtksourceview:
70
self.buffer = GtkSource.Buffer()
71
lang_manager = GtkSource.LanguageManager.get_default()
72
language = lang_manager.guess_language(None, "text/x-patch")
73
self.buffer.set_language(language)
74
self.buffer.set_highlight_syntax(True)
75
self.sourceview = GtkSource.View(buffer=self.buffer)
55
self.buffer = gtksourceview.SourceBuffer()
56
slm = gtksourceview.SourceLanguagesManager()
57
gsl = slm.get_language_from_mime_type("text/x-patch")
59
self.apply_gedit_colors(gsl)
60
self.apply_colordiff_colors(gsl)
61
self.buffer.set_language(gsl)
62
self.buffer.set_highlight(True)
64
sourceview = gtksourceview.SourceView(self.buffer)
77
self.buffer = Gtk.TextBuffer()
78
self.sourceview = Gtk.TextView(self.buffer)
80
self.sourceview.set_editable(False)
81
self.sourceview.override_font(Pango.FontDescription("Monospace"))
82
self.add(self.sourceview)
84
self.sourceview.show()
66
self.buffer = gtk.TextBuffer()
67
sourceview = gtk.TextView(self.buffer)
69
sourceview.set_editable(False)
70
sourceview.modify_font(pango.FontDescription("Monospace"))
75
def apply_gedit_colors(lang):
76
"""Set style for lang to that specified in gedit configuration.
78
This method needs the gconf module.
80
:param lang: a gtksourceview.SourceLanguage object.
82
GEDIT_SYNTAX_PATH = '/apps/gedit-2/preferences/syntax_highlighting'
83
GEDIT_LANG_PATH = GEDIT_SYNTAX_PATH + '/' + lang.get_id()
85
client = gconf.client_get_default()
86
client.add_dir(GEDIT_LANG_PATH, gconf.CLIENT_PRELOAD_NONE)
88
for tag in lang.get_tags():
90
gconf_key = GEDIT_LANG_PATH + '/' + tag_id
91
style_string = client.get_string(gconf_key)
93
if style_string is None:
96
# function to get a bool from a string that's either '0' or '1'
97
string_bool = lambda x: bool(int(x))
99
# style_string is a string like "2/#FFCCAA/#000000/0/1/0/0"
100
# values are: mask, fg, bg, italic, bold, underline, strike
101
# this packs them into (str_value, attr_name, conv_func) tuples
102
items = zip(style_string.split('/'), ['mask', 'foreground',
103
'background', 'italic', 'bold', 'underline', 'strikethrough' ],
104
[ int, gtk.gdk.color_parse, gtk.gdk.color_parse, string_bool,
105
string_bool, string_bool, string_bool ]
108
style = gtksourceview.SourceTagStyle()
110
# XXX The mask attribute controls whether the present values of
111
# foreground and background color should in fact be used. Ideally
112
# (and that's what gedit does), one could set all three attributes,
113
# and let the TagStyle object figure out which colors to use.
114
# However, in the GtkSourceview python bindings, the mask attribute
115
# is read-only, and it's derived instead from the colors being
116
# set or not. This means that we have to sometimes refrain from
117
# setting fg or bg colors, depending on the value of the mask.
118
# This code could go away if mask were writable.
119
mask = int(items[0][0])
120
if not (mask & 1): # GTK_SOURCE_TAG_STYLE_USE_BACKGROUND
122
if not (mask & 2): # GTK_SOURCE_TAG_STYLE_USE_FOREGROUND
124
items[0:1] = [] # skip the mask unconditionally
126
for value, attr, func in items:
130
warning('gconf key %s contains an invalid value: %s'
133
setattr(style, attr, value)
135
lang.set_tag_style(tag_id, style)
138
def apply_colordiff_colors(lang):
139
"""Set style colors for lang using the colordiff configuration file.
141
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
143
:param lang: a "Diff" gtksourceview.SourceLanguage object.
147
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
148
f = os.path.expanduser(f)
149
if os.path.exists(f):
153
warning('could not open file %s: %s' % (f, str(e)))
155
colors.update(DiffView.parse_colordiffrc(f))
159
# ~/.colordiffrc does not exist
163
# map GtkSourceView tags to colordiff names
164
# since GSV is richer, accept new names for extra bits,
165
# defaulting to old names if they're not present
166
'Added@32@line': ['newtext'],
167
'Removed@32@line': ['oldtext'],
168
'Location': ['location', 'diffstuff'],
169
'Diff@32@file': ['file', 'diffstuff'],
170
'Special@32@case': ['specialcase', 'diffstuff'],
173
for tag in lang.get_tags():
174
tag_id = tag.get_id()
175
keys = mapping.get(tag_id, [])
179
color = colors.get(key, None)
180
if color is not None:
186
style = gtksourceview.SourceTagStyle()
188
style.foreground = gtk.gdk.color_parse(color)
190
warning('not a valid color: %s' % color)
192
lang.set_tag_style(tag_id, style)
195
def parse_colordiffrc(fileobj):
196
"""Parse fileobj as a colordiff configuration file.
198
:return: A dict with the key -> value pairs.
202
if re.match(r'^\s*#', line):
206
key, val = line.split('=', 1)
207
colors[key.strip()] = val.strip()
86
210
def set_trees(self, rev_tree, parent_tree):
87
211
self.rev_tree = rev_tree
158
261
self.buffer.set_text(decoded.encode('UTF-8'))
161
class DiffWidget(Gtk.HPaned):
264
class DiffWindow(Window):
267
This object represents and manages a single window containing the
268
differences between two revisions on a branch.
169
super(DiffWidget, self).__init__()
271
def __init__(self, parent=None):
272
Window.__init__(self, parent)
273
self.set_border_width(0)
274
self.set_title("bzrk diff")
276
# Use two thirds of the screen by default
277
screen = self.get_screen()
278
monitor = screen.get_monitor_geometry(0)
279
width = int(monitor.width * 0.66)
280
height = int(monitor.height * 0.66)
281
self.set_default_size(width, height)
286
"""Construct the window contents."""
287
# The window consists of a pane containing: the
288
# hierarchical list of files on the left, and the diff
289
# for the currently selected file on the right.
171
294
# The file hierarchy: a scrollable treeview
172
scrollwin = Gtk.ScrolledWindow()
173
scrollwin.set_policy(Gtk.PolicyType.NEVER, Gtk.PolicyType.AUTOMATIC)
174
scrollwin.set_shadow_type(Gtk.ShadowType.IN)
175
self.pack1(scrollwin)
176
if self.SHOW_WIDGETS:
295
scrollwin = gtk.ScrolledWindow()
296
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
297
scrollwin.set_shadow_type(gtk.SHADOW_IN)
298
pane.pack1(scrollwin)
179
self.model = Gtk.TreeStore(str, str)
180
self.treeview = Gtk.TreeView(model=self.model)
301
self.model = gtk.TreeStore(str, str)
302
self.treeview = gtk.TreeView(self.model)
181
303
self.treeview.set_headers_visible(False)
182
304
self.treeview.set_search_column(1)
183
305
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
184
306
scrollwin.add(self.treeview)
185
if self.SHOW_WIDGETS:
188
cell = Gtk.CellRendererText()
309
cell = gtk.CellRendererText()
189
310
cell.set_property("width-chars", 20)
190
column = Gtk.TreeViewColumn()
191
column.pack_start(cell, True)
311
column = gtk.TreeViewColumn()
312
column.pack_start(cell, expand=True)
192
313
column.add_attribute(cell, "text", 0)
193
314
self.treeview.append_column(column)
195
def set_diff_text(self, lines):
196
"""Set the current diff from a list of lines
198
:param lines: The diff to show, in unified diff format
200
316
# The diffs of the selected file: a scrollable source or
203
def set_diff_text_sections(self, sections):
204
if getattr(self, 'diff_view', None) is None:
205
self.diff_view = DiffFileView()
206
self.pack2(self.diff_view)
207
if self.SHOW_WIDGETS:
208
self.diff_view.show()
209
for oldname, newname, patch in sections:
210
self.diff_view._diffs[newname] = str(patch)
213
self.model.append(None, [oldname, newname])
214
self.diff_view.show_diff(None)
216
def set_diff(self, rev_tree, parent_tree):
318
self.diff_view = DiffView()
319
pane.pack2(self.diff_view)
320
self.diff_view.show()
322
def set_diff(self, description, rev_tree, parent_tree):
217
323
"""Set the differences showed by this window.
219
325
Compares the two trees and populates the window with the
222
if getattr(self, 'diff_view', None) is None:
223
self.diff_view = DiffView()
224
self.pack2(self.diff_view)
225
if self.SHOW_WIDGETS:
226
self.diff_view.show()
227
328
self.diff_view.set_trees(rev_tree, parent_tree)
228
329
self.rev_tree = rev_tree
229
330
self.parent_tree = parent_tree
231
332
self.model.clear()
232
333
delta = self.rev_tree.changes_from(self.parent_tree)
234
self.model.append(None, ["Complete Diff", ""])
335
self.model.append(None, [ "Complete Diff", "" ])
236
337
if len(delta.added):
237
titer = self.model.append(None, ["Added", None])
338
titer = self.model.append(None, [ "Added", None ])
238
339
for path, id, kind in delta.added:
239
self.model.append(titer, [path, path])
340
self.model.append(titer, [ path, path ])
241
342
if len(delta.removed):
242
titer = self.model.append(None, ["Removed", None])
343
titer = self.model.append(None, [ "Removed", None ])
243
344
for path, id, kind in delta.removed:
244
self.model.append(titer, [path, path])
345
self.model.append(titer, [ path, path ])
246
347
if len(delta.renamed):
247
titer = self.model.append(None, ["Renamed", None])
348
titer = self.model.append(None, [ "Renamed", None ])
248
349
for oldpath, newpath, id, kind, text_modified, meta_modified \
249
350
in delta.renamed:
250
self.model.append(titer, [oldpath, newpath])
351
self.model.append(titer, [ oldpath, newpath ])
252
353
if len(delta.modified):
253
titer = self.model.append(None, ["Modified", None])
354
titer = self.model.append(None, [ "Modified", None ])
254
355
for path, id, kind, text_modified, meta_modified in delta.modified:
255
self.model.append(titer, [path, path])
356
self.model.append(titer, [ path, path ])
257
358
self.treeview.expand_all()
258
self.diff_view.show_diff(None)
359
self.set_title(description + " - bzrk diff")
260
361
def set_file(self, file_path):
261
"""Select the current file to display"""
263
363
for data in self.model:
264
364
for child in data.iterchildren():
266
366
tv_path = child.path
268
368
if tv_path is None:
269
raise errors.NoSuchFile(file_path)
270
self.treeview.set_cursor(tv_path, None, False)
369
raise NoSuchFile(file_path)
370
self.treeview.set_cursor(tv_path)
271
371
self.treeview.scroll_to_cell(tv_path)
273
373
def _treeview_cursor_cb(self, *args):
274
374
"""Callback for when the treeview cursor changes."""
275
375
(path, col) = self.treeview.get_cursor()
278
specific_files = [self.model[path][1]]
279
if specific_files == [None]:
281
elif specific_files == [""]:
376
specific_files = [ self.model[path][1] ]
377
if specific_files == [ None ]:
379
elif specific_files == [ "" ]:
282
380
specific_files = None
284
382
self.diff_view.show_diff(specific_files)
286
def _on_wraplines_toggled(self, widget=None, wrap=False):
287
"""Callback for when the wrap lines checkbutton is toggled"""
288
if wrap or widget.get_active():
289
self.diff_view.sourceview.set_wrap_mode(Gtk.WrapMode.WORD)
291
self.diff_view.sourceview.set_wrap_mode(Gtk.WrapMode.NONE)
294
class DiffWindow(Window):
297
This object represents and manages a single window containing the
298
differences between two revisions on a branch.
303
def __init__(self, parent=None, operations=None):
304
super(DiffWindow, self).__init__(parent=parent)
305
self.set_border_width(0)
306
self.set_title("bzr diff")
308
# Use two thirds of the screen by default
309
screen = self.get_screen()
310
monitor = screen.get_monitor_geometry(0)
311
width = int(monitor.width * 0.66)
312
height = int(monitor.height * 0.66)
313
self.set_default_size(width, height)
314
self.construct(operations)
316
def construct(self, operations):
317
"""Construct the window contents."""
318
self.vbox = Gtk.VBox()
320
if self.SHOW_WIDGETS:
322
self.diff = DiffWidget()
323
self.vbox.pack_end(self.diff, True, True, 0)
324
if self.SHOW_WIDGETS:
326
# Build after DiffWidget to connect signals
327
menubar = self._get_menu_bar()
328
self.vbox.pack_start(menubar, False, False, 0)
329
hbox = self._get_button_bar(operations)
331
self.vbox.pack_start(hbox, False, True, 0)
333
def _get_menu_bar(self):
334
menubar = Gtk.MenuBar()
336
mb_view = Gtk.MenuItem.new_with_mnemonic(_i18n("_View"))
337
mb_view_menu = Gtk.Menu()
338
mb_view_wrapsource = Gtk.CheckMenuItem.new_with_mnemonic(
339
_i18n("Wrap _Long Lines"))
340
mb_view_wrapsource.connect('activate', self.diff._on_wraplines_toggled)
341
mb_view_menu.append(mb_view_wrapsource)
342
mb_view.set_submenu(mb_view_menu)
343
menubar.append(mb_view)
344
if self.SHOW_WIDGETS:
348
def _get_button_bar(self, operations):
349
"""Return a button bar to use.
351
:return: None, meaning that no button bar will be used.
353
if operations is None:
355
hbox = Gtk.HButtonBox()
356
hbox.set_layout(Gtk.ButtonBoxStyle.START)
357
for title, method in operations:
358
merge_button = Gtk.Button(title)
359
if self.SHOW_WIDGETS:
361
merge_button.set_relief(Gtk.ReliefStyle.NONE)
362
merge_button.connect("clicked", method)
363
hbox.pack_start(merge_button, False, True, 0)
364
if self.SHOW_WIDGETS:
368
def _get_merge_target(self):
369
d = Gtk.FileChooserDialog('Merge branch', self,
370
Gtk.FileChooserAction.SELECT_FOLDER,
371
buttons=(Gtk.STOCK_OK, Gtk.ResponseType.OK,
373
Gtk.ResponseType.CANCEL,))
376
if result != Gtk.ResponseType.OK:
377
raise SelectCancelled()
378
return d.get_current_folder_uri()
382
def _merge_successful(self):
383
# No conflicts found.
384
info_dialog(_i18n('Merge successful'),
385
_i18n('All changes applied successfully.'))
387
def _conflicts(self):
388
warning_dialog(_i18n('Conflicts encountered'),
389
_i18n('Please resolve the conflicts manually'
390
' before committing.'))
392
def _handle_error(self, e):
393
error_dialog('Error', str(e))
395
def _get_save_path(self, basename):
396
d = Gtk.FileChooserDialog('Save As', self,
397
Gtk.FileChooserAction.SAVE,
398
buttons=(Gtk.STOCK_OK, Gtk.ResponseType.OK,
400
Gtk.ResponseType.CANCEL,))
401
d.set_current_name(basename)
404
if result != Gtk.ResponseType.OK:
405
raise SelectCancelled()
406
return urlutils.local_path_from_url(d.get_uri())
410
def set_diff(self, description, rev_tree, parent_tree):
411
"""Set the differences showed by this window.
413
Compares the two trees and populates the window with the
416
self.diff.set_diff(rev_tree, parent_tree)
417
self.set_title(description + " - bzrk diff")
419
def set_file(self, file_path):
420
self.diff.set_file(file_path)
423
class DiffController(object):
425
def __init__(self, path, patch, window=None, allow_dirty=False):
428
self.allow_dirty = allow_dirty
430
window = DiffWindow(operations=self._provide_operations())
431
self.initialize_window(window)
434
def initialize_window(self, window):
435
window.diff.set_diff_text_sections(self.get_diff_sections())
436
window.set_title(self.path + " - diff")
438
def get_diff_sections(self):
439
yield "Complete Diff", None, ''.join(self.patch)
440
# allow_dirty was added to parse_patches in bzrlib 2.2b1
441
if 'allow_dirty' in inspect.getargspec(parse_patches).args:
442
patches = parse_patches(self.patch, allow_dirty=self.allow_dirty)
444
patches = parse_patches(self.patch)
445
for patch in patches:
446
oldname = patch.oldname.split('\t')[0]
447
newname = patch.newname.split('\t')[0]
448
yield oldname, newname, str(patch)
450
def perform_save(self, window):
452
save_path = self.window._get_save_path(osutils.basename(self.path))
453
except SelectCancelled:
455
source = open(self.path, 'rb')
457
target = open(save_path, 'wb')
459
osutils.pumpfile(source, target)
465
def _provide_operations(self):
466
return [('Save', self.perform_save)]
469
class MergeDirectiveController(DiffController):
471
def __init__(self, path, directive, window=None):
472
super(MergeDirectiveController, self).__init__(
473
path, directive.patch.splitlines(True), window)
474
self.directive = directive
475
self.merge_target = None
477
def _provide_operations(self):
478
return [('Merge', self.perform_merge), ('Save', self.perform_save)]
480
def perform_merge(self, window):
481
if self.merge_target is None:
483
self.merge_target = self.window._get_merge_target()
484
except SelectCancelled:
486
tree = workingtree.WorkingTree.open(self.merge_target)
490
if tree.has_changes():
491
raise errors.UncommittedChanges(tree)
492
merger, verified = _mod_merge.Merger.from_mergeable(
493
tree, self.directive, pb=None)
494
merger.merge_type = _mod_merge.Merge3Merger
495
conflict_count = merger.do_merge()
497
if conflict_count == 0:
498
self.window._merge_successful()
500
self.window._conflicts()
501
# There are conflicts to be resolved.
502
self.window.destroy()
504
self.window._handle_error(e)
509
def iter_changes_to_status(source, target):
385
def _iter_changes_to_status(source, target):
510
386
"""Determine the differences between trees.
512
This is a wrapper around iter_changes which just yields more
388
This is a wrapper around _iter_changes which just yields more
513
389
understandable results.
515
391
:param source: The source tree (basis tree)