2
# -*- coding: UTF-8 -*-
1
3
"""Difference window.
3
5
This module contains the code to manage the diff window which shows
4
6
the changes made between two revisions on a branch.
7
__copyright__ = "Copyright 2005 Canonical Ltd."
8
__author__ = "Scott James Remnant <scott@ubuntu.com>"
9
__copyright__ = "Copyright © 2005 Canonical Ltd."
10
__author__ = "Scott James Remnant <scott@ubuntu.com>"
11
13
from cStringIO import StringIO
18
from xml.etree.ElementTree import (
23
Element, SubElement, tostring # Hush PEP8 redefinition.
25
from elementtree.ElementTree import (
31
from gi.repository import Gtk
32
from gi.repository import Pango
34
from gi.repository import GtkSource
35
21
have_gtksourceview = True
36
22
except ImportError:
37
23
have_gtksourceview = False
39
from gi.repository import GConf
51
27
from bzrlib.diff import show_diff_trees
52
from bzrlib.patches import parse_patches
53
from bzrlib.trace import warning
54
from bzrlib.plugins.gtk.dialog import (
59
from bzrlib.plugins.gtk.i18n import _i18n
60
from bzrlib.plugins.gtk.window import Window
63
def fallback_guess_language(slm, content_type):
64
for lang_id in slm.get_language_ids():
65
lang = slm.get_language(lang_id)
66
if "text/x-patch" in lang.get_mime_types():
71
class SelectCancelled(Exception):
76
class DiffFileView(Gtk.ScrolledWindow):
77
"""Window for displaying diffs from a diff file"""
28
from bzrlib.errors import NoSuchFile
31
class DiffWindow(gtk.Window):
34
This object represents and manages a single window containing the
35
differences between two revisions on a branch.
79
38
def __init__(self):
80
super(DiffFileView, self).__init__()
39
gtk.Window.__init__(self, gtk.WINDOW_TOPLEVEL)
40
self.set_border_width(0)
41
self.set_title("bzrk diff")
43
# Use two thirds of the screen by default
44
screen = self.get_screen()
45
monitor = screen.get_monitor_geometry(0)
46
width = int(monitor.width * 0.66)
47
height = int(monitor.height * 0.66)
48
self.set_default_size(width, height)
84
52
def construct(self):
85
self.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
86
self.set_shadow_type(Gtk.ShadowType.IN)
88
if have_gtksourceview:
89
self.buffer = GtkSource.Buffer()
90
lang_manager = GtkSource.LanguageManager.get_default()
91
language = lang_manager.guess_language(None, "text/x-patch")
93
self.apply_gedit_colors(self.buffer)
94
self.apply_colordiff_colors(self.buffer)
95
self.buffer.set_language(language)
96
self.buffer.set_highlight_syntax(True)
98
self.sourceview = GtkSource.View(buffer=self.buffer)
100
self.buffer = Gtk.TextBuffer()
101
self.sourceview = Gtk.TextView(self.buffer)
103
self.sourceview.set_editable(False)
104
self.sourceview.modify_font(Pango.FontDescription("Monospace"))
105
self.add(self.sourceview)
106
self.sourceview.show()
109
def apply_gedit_colors(buf):
110
"""Set style to that specified in gedit configuration.
112
This method needs the gconf module.
114
:param buf: a GtkSource.Buffer object.
116
GEDIT_SCHEME_PATH = '/apps/gedit-2/preferences/editor/colors/scheme'
117
GEDIT_USER_STYLES_PATH = os.path.expanduser('~/.gnome2/gedit/styles')
119
client = GConf.Client.get_default()
120
style_scheme_name = client.get_string(GEDIT_SCHEME_PATH)
121
if style_scheme_name is not None:
122
style_scheme_mgr = GtkSource.StyleSchemeManager()
123
style_scheme_mgr.append_search_path(GEDIT_USER_STYLES_PATH)
125
style_scheme = style_scheme_mgr.get_scheme(style_scheme_name)
127
if style_scheme is not None:
128
buf.set_style_scheme(style_scheme)
131
def apply_colordiff_colors(klass, buf):
132
"""Set style colors for lang using the colordiff configuration file.
134
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
136
:param buf: a "Diff" GtkSource.Buffer object.
138
scheme_manager = GtkSource.StyleSchemeManager()
139
style_scheme = scheme_manager.get_scheme('colordiff')
141
# if style scheme not found, we'll generate it from colordiffrc
142
# TODO: reload if colordiffrc has changed.
143
if style_scheme is None:
146
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
147
f = os.path.expanduser(f)
148
if os.path.exists(f):
152
warning('could not open file %s: %s' % (f, str(e)))
154
colors.update(klass.parse_colordiffrc(f))
158
# ~/.colordiffrc does not exist
162
# map GtkSourceView2 scheme styles to colordiff names
163
# since GSV is richer, accept new names for extra bits,
164
# defaulting to old names if they're not present
165
'diff:added-line': ['newtext'],
166
'diff:removed-line': ['oldtext'],
167
'diff:location': ['location', 'diffstuff'],
168
'diff:file': ['file', 'diffstuff'],
169
'diff:special-case': ['specialcase', 'diffstuff'],
172
converted_colors = {}
173
for name, values in mapping.items():
176
color = colors.get(value, None)
177
if color is not None:
181
converted_colors[name] = color
183
# some xml magic to produce needed style scheme description
184
e_style_scheme = Element('style-scheme')
185
e_style_scheme.set('id', 'colordiff')
186
e_style_scheme.set('_name', 'ColorDiff')
187
e_style_scheme.set('version', '1.0')
188
for name, color in converted_colors.items():
189
style = SubElement(e_style_scheme, 'style')
190
style.set('name', name)
191
style.set('foreground', '#%s' % color)
193
scheme_xml = tostring(e_style_scheme, 'UTF-8')
194
if not os.path.exists(os.path.expanduser(
195
'~/.local/share/gtksourceview-2.0/styles')):
196
os.makedirs(os.path.expanduser(
197
'~/.local/share/gtksourceview-2.0/styles'))
198
file(os.path.expanduser(
199
'~/.local/share/gtksourceview-2.0/styles/colordiff.xml'),
200
'w').write(scheme_xml)
202
scheme_manager.force_rescan()
203
style_scheme = scheme_manager.get_scheme('colordiff')
205
buf.set_style_scheme(style_scheme)
208
def parse_colordiffrc(fileobj):
209
"""Parse fileobj as a colordiff configuration file.
211
:return: A dict with the key -> value pairs.
215
if re.match(r'^\s*#', line):
219
key, val = line.split('=', 1)
220
colors[key.strip()] = val.strip()
223
def set_trees(self, rev_tree, parent_tree):
224
self.rev_tree = rev_tree
225
self.parent_tree = parent_tree
226
# self._build_delta()
228
# def _build_delta(self):
229
# self.parent_tree.lock_read()
230
# self.rev_tree.lock_read()
232
# self.delta = iter_changes_to_status(
233
# self.parent_tree, self.rev_tree)
234
# self.path_to_status = {}
235
# self.path_to_diff = {}
236
# source_inv = self.parent_tree.inventory
237
# target_inv = self.rev_tree.inventory
238
# for (file_id, real_path, change_type, display_path) in self.delta:
239
# self.path_to_status[real_path] = u'=== %s %s' % (
240
# change_type, display_path)
241
# if change_type in ('modified', 'renamed and modified'):
242
# source_ie = source_inv[file_id]
243
# target_ie = target_inv[file_id]
245
# source_ie.diff(internal_diff, *old path, *old_tree,
246
# *new_path, target_ie, self.rev_tree,
248
# self.path_to_diff[real_path] =
251
# self.rev_tree.unlock()
252
# self.parent_tree.unlock()
254
def show_diff(self, specific_files):
256
if specific_files is None:
257
self.buffer.set_text(self._diffs[None])
259
for specific_file in specific_files:
260
sections.append(self._diffs[specific_file])
261
self.buffer.set_text(''.join(sections))
264
class DiffView(DiffFileView):
265
"""This is the soft and chewy filling for a DiffWindow."""
268
super(DiffView, self).__init__()
270
self.parent_tree = None
272
def show_diff(self, specific_files):
273
"""Show the diff for the specified files"""
275
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
276
old_label='', new_label='',
277
# path_encoding=sys.getdefaultencoding()
278
# The default is utf-8, but we interpret the file
279
# contents as getdefaultencoding(), so we should
280
# probably try to make the paths in the same encoding.
282
# str.decode(encoding, 'replace') doesn't do anything. Because if a
283
# character is not valid in 'encoding' there is nothing to replace, the
284
# 'replace' is for 'str.encode()'
286
decoded = s.getvalue().decode(sys.getdefaultencoding())
287
except UnicodeDecodeError:
289
decoded = s.getvalue().decode('UTF-8')
290
except UnicodeDecodeError:
291
decoded = s.getvalue().decode('iso-8859-1')
292
# This always works, because every byte has a valid
293
# mapping from iso-8859-1 to Unicode
294
# TextBuffer must contain pure UTF-8 data
295
self.buffer.set_text(decoded.encode('UTF-8'))
298
class DiffWidget(Gtk.HPaned):
306
super(DiffWidget, self).__init__()
53
"""Construct the window contents."""
54
# The window consists of a pane containing: the
55
# hierarchical list of files on the left, and the diff
56
# for the currently selected file on the right.
308
61
# The file hierarchy: a scrollable treeview
309
scrollwin = Gtk.ScrolledWindow()
310
scrollwin.set_policy(Gtk.PolicyType.NEVER, Gtk.PolicyType.AUTOMATIC)
311
scrollwin.set_shadow_type(Gtk.ShadowType.IN)
312
self.pack1(scrollwin)
313
if self.SHOW_WIDGETS:
62
scrollwin = gtk.ScrolledWindow()
63
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
64
scrollwin.set_shadow_type(gtk.SHADOW_IN)
316
self.model = Gtk.TreeStore(str, str)
317
self.treeview = Gtk.TreeView(model=self.model)
68
self.model = gtk.TreeStore(str, str)
69
self.treeview = gtk.TreeView(self.model)
318
70
self.treeview.set_headers_visible(False)
319
71
self.treeview.set_search_column(1)
320
72
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
321
73
scrollwin.add(self.treeview)
322
if self.SHOW_WIDGETS:
325
cell = Gtk.CellRendererText()
76
cell = gtk.CellRendererText()
326
77
cell.set_property("width-chars", 20)
327
column = Gtk.TreeViewColumn()
328
column.pack_start(cell, True)
78
column = gtk.TreeViewColumn()
79
column.pack_start(cell, expand=True)
329
80
column.add_attribute(cell, "text", 0)
330
81
self.treeview.append_column(column)
332
def set_diff_text(self, lines):
333
"""Set the current diff from a list of lines
335
:param lines: The diff to show, in unified diff format
337
83
# The diffs of the selected file: a scrollable source or
340
def set_diff_text_sections(self, sections):
341
if getattr(self, 'diff_view', None) is None:
342
self.diff_view = DiffFileView()
343
self.pack2(self.diff_view)
344
if self.SHOW_WIDGETS:
345
self.diff_view.show()
346
for oldname, newname, patch in sections:
347
self.diff_view._diffs[newname] = str(patch)
350
self.model.append(None, [oldname, newname])
351
self.diff_view.show_diff(None)
353
def set_diff(self, rev_tree, parent_tree):
85
scrollwin = gtk.ScrolledWindow()
86
scrollwin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
87
scrollwin.set_shadow_type(gtk.SHADOW_IN)
91
if have_gtksourceview:
92
self.buffer = gtksourceview.SourceBuffer()
93
slm = gtksourceview.SourceLanguagesManager()
94
gsl = slm.get_language_from_mime_type("text/x-patch")
95
self.buffer.set_language(gsl)
96
self.buffer.set_highlight(True)
98
sourceview = gtksourceview.SourceView(self.buffer)
100
self.buffer = gtk.TextBuffer()
101
sourceview = gtk.TextView(self.buffer)
103
sourceview.set_editable(False)
104
sourceview.modify_font(pango.FontDescription("Monospace"))
105
scrollwin.add(sourceview)
108
def set_diff(self, description, rev_tree, parent_tree):
354
109
"""Set the differences showed by this window.
356
111
Compares the two trees and populates the window with the
359
if getattr(self, 'diff_view', None) is None:
360
self.diff_view = DiffView()
361
self.pack2(self.diff_view)
362
if self.SHOW_WIDGETS:
363
self.diff_view.show()
364
self.diff_view.set_trees(rev_tree, parent_tree)
365
114
self.rev_tree = rev_tree
366
115
self.parent_tree = parent_tree
368
117
self.model.clear()
369
118
delta = self.rev_tree.changes_from(self.parent_tree)
371
self.model.append(None, ["Complete Diff", ""])
120
self.model.append(None, [ "Complete Diff", "" ])
373
122
if len(delta.added):
374
titer = self.model.append(None, ["Added", None])
123
titer = self.model.append(None, [ "Added", None ])
375
124
for path, id, kind in delta.added:
376
self.model.append(titer, [path, path])
125
self.model.append(titer, [ path, path ])
378
127
if len(delta.removed):
379
titer = self.model.append(None, ["Removed", None])
128
titer = self.model.append(None, [ "Removed", None ])
380
129
for path, id, kind in delta.removed:
381
self.model.append(titer, [path, path])
130
self.model.append(titer, [ path, path ])
383
132
if len(delta.renamed):
384
titer = self.model.append(None, ["Renamed", None])
133
titer = self.model.append(None, [ "Renamed", None ])
385
134
for oldpath, newpath, id, kind, text_modified, meta_modified \
386
135
in delta.renamed:
387
self.model.append(titer, [oldpath, newpath])
136
self.model.append(titer, [ oldpath, newpath ])
389
138
if len(delta.modified):
390
titer = self.model.append(None, ["Modified", None])
139
titer = self.model.append(None, [ "Modified", None ])
391
140
for path, id, kind, text_modified, meta_modified in delta.modified:
392
self.model.append(titer, [path, path])
141
self.model.append(titer, [ path, path ])
394
143
self.treeview.expand_all()
395
self.diff_view.show_diff(None)
144
self.set_title(description + " - bzrk diff")
397
146
def set_file(self, file_path):
398
"""Select the current file to display"""
400
148
for data in self.model:
401
149
for child in data.iterchildren():
403
151
tv_path = child.path
405
153
if tv_path is None:
406
raise errors.NoSuchFile(file_path)
407
self.treeview.set_cursor(tv_path, None, False)
154
raise NoSuchFile(file_path)
155
self.treeview.set_cursor(tv_path)
408
156
self.treeview.scroll_to_cell(tv_path)
410
158
def _treeview_cursor_cb(self, *args):
411
159
"""Callback for when the treeview cursor changes."""
412
160
(path, col) = self.treeview.get_cursor()
415
specific_files = [self.model[path][1]]
416
if specific_files == [None]:
418
elif specific_files == [""]:
419
specific_files = None
421
self.diff_view.show_diff(specific_files)
423
def _on_wraplines_toggled(self, widget=None, wrap=False):
424
"""Callback for when the wrap lines checkbutton is toggled"""
425
if wrap or widget.get_active():
426
self.diff_view.sourceview.set_wrap_mode(Gtk.WrapMode.WORD)
428
self.diff_view.sourceview.set_wrap_mode(Gtk.WrapMode.NONE)
431
class DiffWindow(Window):
434
This object represents and manages a single window containing the
435
differences between two revisions on a branch.
438
def __init__(self, parent=None, operations=None):
439
super(DiffWindow, self).__init__(parent=parent)
440
self.set_border_width(0)
441
self.set_title("bzrk diff")
443
# Use two thirds of the screen by default
444
screen = self.get_screen()
445
monitor = screen.get_monitor_geometry(0)
446
width = int(monitor.width * 0.66)
447
height = int(monitor.height * 0.66)
448
self.set_default_size(width, height)
449
self.construct(operations)
451
def construct(self, operations):
452
"""Construct the window contents."""
453
self.vbox = Gtk.VBox()
456
self.diff = DiffWidget()
457
self.vbox.pack_end(self.diff, True, True, 0)
459
# Build after DiffWidget to connect signals
460
menubar = self._get_menu_bar()
461
self.vbox.pack_start(menubar, False, False, 0)
462
hbox = self._get_button_bar(operations)
464
self.vbox.pack_start(hbox, False, True, 0)
466
def _get_menu_bar(self):
467
menubar = Gtk.MenuBar()
469
mb_view = Gtk.MenuItem.new_with_mnemonic(_i18n("_View"))
470
mb_view_menu = Gtk.Menu()
471
mb_view_wrapsource = Gtk.CheckMenuItem.new_with_mnemonic(
472
_i18n("Wrap _Long Lines"))
473
mb_view_wrapsource.connect('activate', self.diff._on_wraplines_toggled)
474
mb_view_wrapsource.show()
475
mb_view_menu.append(mb_view_wrapsource)
477
mb_view.set_submenu(mb_view_menu)
479
menubar.append(mb_view)
483
def _get_button_bar(self, operations):
484
"""Return a button bar to use.
486
:return: None, meaning that no button bar will be used.
488
if operations is None:
490
hbox = Gtk.HButtonBox()
491
hbox.set_layout(Gtk.ButtonBoxStyle.START)
492
for title, method in operations:
493
merge_button = Gtk.Button(title)
495
merge_button.set_relief(Gtk.ReliefStyle.NONE)
496
merge_button.connect("clicked", method)
497
hbox.pack_start(merge_button, expand=False, fill=True)
501
def _get_merge_target(self):
502
d = Gtk.FileChooserDialog('Merge branch', self,
503
Gtk.FileChooserAction.SELECT_FOLDER,
504
buttons=(Gtk.STOCK_OK, Gtk.ResponseType.OK,
506
Gtk.ResponseType.CANCEL,))
509
if result != Gtk.ResponseType.OK:
510
raise SelectCancelled()
511
return d.get_current_folder_uri()
515
def _merge_successful(self):
516
# No conflicts found.
517
info_dialog(_i18n('Merge successful'),
518
_i18n('All changes applied successfully.'))
520
def _conflicts(self):
521
warning_dialog(_i18n('Conflicts encountered'),
522
_i18n('Please resolve the conflicts manually'
523
' before committing.'))
525
def _handle_error(self, e):
526
error_dialog('Error', str(e))
528
def _get_save_path(self, basename):
529
d = Gtk.FileChooserDialog('Save As', self,
530
Gtk.FileChooserAction.SAVE,
531
buttons=(Gtk.STOCK_OK, Gtk.ResponseType.OK,
533
Gtk.ResponseType.CANCEL,))
534
d.set_current_name(basename)
537
if result != Gtk.ResponseType.OK:
538
raise SelectCancelled()
539
return urlutils.local_path_from_url(d.get_uri())
543
def set_diff(self, description, rev_tree, parent_tree):
544
"""Set the differences showed by this window.
546
Compares the two trees and populates the window with the
549
self.diff.set_diff(rev_tree, parent_tree)
550
self.set_title(description + " - bzrk diff")
552
def set_file(self, file_path):
553
self.diff.set_file(file_path)
556
class DiffController(object):
558
def __init__(self, path, patch, window=None, allow_dirty=False):
561
self.allow_dirty = allow_dirty
563
window = DiffWindow(operations=self._provide_operations())
564
self.initialize_window(window)
567
def initialize_window(self, window):
568
window.diff.set_diff_text_sections(self.get_diff_sections())
569
window.set_title(self.path + " - diff")
571
def get_diff_sections(self):
572
yield "Complete Diff", None, ''.join(self.patch)
573
# allow_dirty was added to parse_patches in bzrlib 2.2b1
574
if 'allow_dirty' in inspect.getargspec(parse_patches).args:
575
patches = parse_patches(self.patch, allow_dirty=self.allow_dirty)
577
patches = parse_patches(self.patch)
578
for patch in patches:
579
oldname = patch.oldname.split('\t')[0]
580
newname = patch.newname.split('\t')[0]
581
yield oldname, newname, str(patch)
583
def perform_save(self, window):
585
save_path = self.window._get_save_path(osutils.basename(self.path))
586
except SelectCancelled:
588
source = open(self.path, 'rb')
590
target = open(save_path, 'wb')
592
osutils.pumpfile(source, target)
598
def _provide_operations(self):
599
return [('Save', self.perform_save)]
602
class MergeDirectiveController(DiffController):
604
def __init__(self, path, directive, window=None):
605
super(MergeDirectiveController, self).__init__(
606
path, directive.patch.splitlines(True), window)
607
self.directive = directive
608
self.merge_target = None
610
def _provide_operations(self):
611
return [('Merge', self.perform_merge), ('Save', self.perform_save)]
613
def perform_merge(self, window):
614
if self.merge_target is None:
616
self.merge_target = self.window._get_merge_target()
617
except SelectCancelled:
619
tree = workingtree.WorkingTree.open(self.merge_target)
623
if tree.has_changes():
624
raise errors.UncommittedChanges(tree)
625
merger, verified = _mod_merge.Merger.from_mergeable(
626
tree, self.directive, pb=None)
627
merger.merge_type = _mod_merge.Merge3Merger
628
conflict_count = merger.do_merge()
630
if conflict_count == 0:
631
self.window._merge_successful()
633
self.window._conflicts()
634
# There are conflicts to be resolved.
635
self.window.destroy()
637
self.window._handle_error(e)
642
def iter_changes_to_status(source, target):
643
"""Determine the differences between trees.
645
This is a wrapper around iter_changes which just yields more
646
understandable results.
648
:param source: The source tree (basis tree)
649
:param target: The target tree
650
:return: A list of (file_id, real_path, change_type, display_path)
655
renamed_and_modified = 'renamed and modified'
656
modified = 'modified'
657
kind_changed = 'kind changed'
660
# TODO: Handle metadata changes
667
for (file_id, paths, changed_content, versioned, parent_ids, names,
668
kinds, executables) in target.iter_changes(source):
670
# Skip the root entry if it isn't very interesting
671
if parent_ids == (None, None):
678
source_marker = osutils.kind_marker(kinds[0])
682
# We assume bzr will flag only files in that case,
683
# there may be a bzr bug there as only files seems to
684
# not receive any kind.
685
marker = osutils.kind_marker('file')
687
marker = osutils.kind_marker(kinds[0])
689
marker = osutils.kind_marker(kinds[1])
692
if real_path is None:
694
assert real_path is not None
696
present_source = versioned[0] and kinds[0] is not None
697
present_target = versioned[1] and kinds[1] is not None
699
if kinds[0] is None and kinds[1] is None:
700
change_type = missing
701
display_path = real_path + marker
702
elif present_source != present_target:
706
assert present_source
707
change_type = removed
708
display_path = real_path + marker
709
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
711
if changed_content or executables[0] != executables[1]:
713
change_type = renamed_and_modified
715
change_type = renamed
716
display_path = (paths[0] + source_marker
717
+ ' => ' + paths[1] + marker)
718
elif kinds[0] != kinds[1]:
719
change_type = kind_changed
720
display_path = (paths[0] + source_marker
721
+ ' => ' + paths[1] + marker)
722
elif changed_content or executables[0] != executables[1]:
723
change_type = modified
724
display_path = real_path + marker
726
assert False, "How did we get here?"
728
status.append((file_id, real_path, change_type, display_path))
161
specific_files = [ self.model[path][1] ]
162
if specific_files == [ None ]:
164
elif specific_files == [ "" ]:
168
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files)
169
self.buffer.set_text(s.getvalue().decode(sys.getdefaultencoding(), 'replace'))