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."
9
__copyright__ = "Copyright © 2005 Canonical Ltd."
8
10
__author__ = "Scott James Remnant <scott@ubuntu.com>"
11
13
from cStringIO import StringIO
21
from xml.etree.ElementTree import Element, SubElement, tostring
23
from elementtree.ElementTree import Element, SubElement, tostring
27
21
have_gtksourceview = True
28
22
except ImportError:
29
23
have_gtksourceview = False
43
from bzrlib.diff import show_diff_trees, internal_diff
27
from bzrlib.diff import show_diff_trees
44
28
from bzrlib.errors import NoSuchFile
45
from bzrlib.patches import parse_patches
46
from bzrlib.trace import warning
47
from bzrlib.plugins.gtk import _i18n
48
from bzrlib.plugins.gtk.window import Window
49
from dialog import error_dialog, info_dialog, warning_dialog
52
def fallback_guess_language(slm, content_type):
53
for lang_id in slm.get_language_ids():
54
lang = slm.get_language(lang_id)
55
if "text/x-patch" in lang.get_mime_types():
60
class SelectCancelled(Exception):
65
class DiffFileView(gtk.ScrolledWindow):
66
"""Window for displaying diffs from a diff file"""
31
class DiffWindow(gtk.Window):
34
This object represents and manages a single window containing the
35
differences between two revisions on a branch.
68
38
def __init__(self):
69
gtk.ScrolledWindow.__init__(self)
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)
73
52
def construct(self):
74
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
75
self.set_shadow_type(gtk.SHADOW_IN)
77
if have_gtksourceview:
78
self.buffer = gtksourceview2.Buffer()
79
slm = gtksourceview2.LanguageManager()
80
guess_language = getattr(gtksourceview2.LanguageManager,
81
"guess_language", fallback_guess_language)
82
gsl = guess_language(slm, content_type="text/x-patch")
84
self.apply_gedit_colors(self.buffer)
85
self.apply_colordiff_colors(self.buffer)
86
self.buffer.set_language(gsl)
87
self.buffer.set_highlight_syntax(True)
89
self.sourceview = gtksourceview2.View(self.buffer)
91
self.buffer = gtk.TextBuffer()
92
self.sourceview = gtk.TextView(self.buffer)
94
self.sourceview.set_editable(False)
95
self.sourceview.modify_font(pango.FontDescription("Monospace"))
96
self.add(self.sourceview)
97
self.sourceview.show()
100
def apply_gedit_colors(buf):
101
"""Set style to that specified in gedit configuration.
103
This method needs the gconf module.
105
:param buf: a gtksourceview2.Buffer object.
107
GEDIT_SCHEME_PATH = '/apps/gedit-2/preferences/editor/colors/scheme'
109
client = gconf.client_get_default()
110
style_scheme_name = client.get_string(GEDIT_SCHEME_PATH)
111
if style_scheme_name is not None:
112
style_scheme = gtksourceview2.StyleSchemeManager().get_scheme(style_scheme_name)
114
buf.set_style_scheme(style_scheme)
117
def apply_colordiff_colors(klass, buf):
118
"""Set style colors for lang using the colordiff configuration file.
120
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
122
:param buf: a "Diff" gtksourceview2.Buffer object.
124
scheme_manager = gtksourceview2.StyleSchemeManager()
125
style_scheme = scheme_manager.get_scheme('colordiff')
127
# if style scheme not found, we'll generate it from colordiffrc
128
# TODO: reload if colordiffrc has changed.
129
if style_scheme is None:
132
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
133
f = os.path.expanduser(f)
134
if os.path.exists(f):
138
warning('could not open file %s: %s' % (f, str(e)))
140
colors.update(klass.parse_colordiffrc(f))
144
# ~/.colordiffrc does not exist
148
# map GtkSourceView2 scheme styles to colordiff names
149
# since GSV is richer, accept new names for extra bits,
150
# defaulting to old names if they're not present
151
'diff:added-line': ['newtext'],
152
'diff:removed-line': ['oldtext'],
153
'diff:location': ['location', 'diffstuff'],
154
'diff:file': ['file', 'diffstuff'],
155
'diff:special-case': ['specialcase', 'diffstuff'],
158
converted_colors = {}
159
for name, values in mapping.items():
162
color = colors.get(value, None)
163
if color is not None:
167
converted_colors[name] = color
169
# some xml magic to produce needed style scheme description
170
e_style_scheme = Element('style-scheme')
171
e_style_scheme.set('id', 'colordiff')
172
e_style_scheme.set('_name', 'ColorDiff')
173
e_style_scheme.set('version', '1.0')
174
for name, color in converted_colors.items():
175
style = SubElement(e_style_scheme, 'style')
176
style.set('name', name)
177
style.set('foreground', '#%s' % color)
179
scheme_xml = tostring(e_style_scheme, 'UTF-8')
180
if not os.path.exists(os.path.expanduser('~/.local/share/gtksourceview-2.0/styles')):
181
os.makedirs(os.path.expanduser('~/.local/share/gtksourceview-2.0/styles'))
182
file(os.path.expanduser('~/.local/share/gtksourceview-2.0/styles/colordiff.xml'), 'w').write(scheme_xml)
184
scheme_manager.force_rescan()
185
style_scheme = scheme_manager.get_scheme('colordiff')
187
buf.set_style_scheme(style_scheme)
190
def parse_colordiffrc(fileobj):
191
"""Parse fileobj as a colordiff configuration file.
193
:return: A dict with the key -> value pairs.
197
if re.match(r'^\s*#', line):
201
key, val = line.split('=', 1)
202
colors[key.strip()] = val.strip()
205
def set_trees(self, rev_tree, parent_tree):
206
self.rev_tree = rev_tree
207
self.parent_tree = parent_tree
208
# self._build_delta()
210
# def _build_delta(self):
211
# self.parent_tree.lock_read()
212
# self.rev_tree.lock_read()
214
# self.delta = iter_changes_to_status(self.parent_tree, self.rev_tree)
215
# self.path_to_status = {}
216
# self.path_to_diff = {}
217
# source_inv = self.parent_tree.inventory
218
# target_inv = self.rev_tree.inventory
219
# for (file_id, real_path, change_type, display_path) in self.delta:
220
# self.path_to_status[real_path] = u'=== %s %s' % (change_type, display_path)
221
# if change_type in ('modified', 'renamed and modified'):
222
# source_ie = source_inv[file_id]
223
# target_ie = target_inv[file_id]
225
# source_ie.diff(internal_diff, *old path, *old_tree,
226
# *new_path, target_ie, self.rev_tree,
228
# self.path_to_diff[real_path] =
231
# self.rev_tree.unlock()
232
# self.parent_tree.unlock()
234
def show_diff(self, specific_files):
236
if specific_files is None:
237
self.buffer.set_text(self._diffs[None])
239
for specific_file in specific_files:
240
sections.append(self._diffs[specific_file])
241
self.buffer.set_text(''.join(sections))
244
class DiffView(DiffFileView):
245
"""This is the soft and chewy filling for a DiffWindow."""
248
DiffFileView.__init__(self)
250
self.parent_tree = None
252
def show_diff(self, specific_files):
253
"""Show the diff for the specified files"""
255
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
256
old_label='', new_label='',
257
# path_encoding=sys.getdefaultencoding()
258
# The default is utf-8, but we interpret the file
259
# contents as getdefaultencoding(), so we should
260
# probably try to make the paths in the same encoding.
262
# str.decode(encoding, 'replace') doesn't do anything. Because if a
263
# character is not valid in 'encoding' there is nothing to replace, the
264
# 'replace' is for 'str.encode()'
266
decoded = s.getvalue().decode(sys.getdefaultencoding())
267
except UnicodeDecodeError:
269
decoded = s.getvalue().decode('UTF-8')
270
except UnicodeDecodeError:
271
decoded = s.getvalue().decode('iso-8859-1')
272
# This always works, because every byte has a valid
273
# mapping from iso-8859-1 to Unicode
274
# TextBuffer must contain pure UTF-8 data
275
self.buffer.set_text(decoded.encode('UTF-8'))
278
class DiffWidget(gtk.HPaned):
283
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.
285
61
# The file hierarchy: a scrollable treeview
286
62
scrollwin = gtk.ScrolledWindow()
287
63
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
288
64
scrollwin.set_shadow_type(gtk.SHADOW_IN)
289
self.pack1(scrollwin)
292
68
self.model = gtk.TreeStore(str, str)
293
69
self.treeview = gtk.TreeView(self.model)
294
70
self.treeview.set_headers_visible(False)
304
80
column.add_attribute(cell, "text", 0)
305
81
self.treeview.append_column(column)
307
def set_diff_text(self, lines):
308
"""Set the current diff from a list of lines
310
:param lines: The diff to show, in unified diff format
312
83
# The diffs of the selected file: a scrollable source or
315
def set_diff_text_sections(self, sections):
316
if getattr(self, 'diff_view', None) is None:
317
self.diff_view = DiffFileView()
318
self.pack2(self.diff_view)
319
self.diff_view.show()
320
for oldname, newname, patch in sections:
321
self.diff_view._diffs[newname] = str(patch)
324
self.model.append(None, [oldname, newname])
325
self.diff_view.show_diff(None)
327
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):
328
109
"""Set the differences showed by this window.
330
111
Compares the two trees and populates the window with the
333
if getattr(self, 'diff_view', None) is None:
334
self.diff_view = DiffView()
335
self.pack2(self.diff_view)
336
self.diff_view.show()
337
self.diff_view.set_trees(rev_tree, parent_tree)
338
114
self.rev_tree = rev_tree
339
115
self.parent_tree = parent_tree
387
162
if specific_files == [ None ]:
389
164
elif specific_files == [ "" ]:
390
specific_files = None
392
self.diff_view.show_diff(specific_files)
394
def _on_wraplines_toggled(self, widget=None, wrap=False):
395
"""Callback for when the wrap lines checkbutton is toggled"""
396
if wrap or widget.get_active():
397
self.diff_view.sourceview.set_wrap_mode(gtk.WRAP_WORD)
399
self.diff_view.sourceview.set_wrap_mode(gtk.WRAP_NONE)
401
class DiffWindow(Window):
404
This object represents and manages a single window containing the
405
differences between two revisions on a branch.
408
def __init__(self, parent=None, operations=None):
409
Window.__init__(self, parent)
410
self.set_border_width(0)
411
self.set_title("bzrk diff")
413
# Use two thirds of the screen by default
414
screen = self.get_screen()
415
monitor = screen.get_monitor_geometry(0)
416
width = int(monitor.width * 0.66)
417
height = int(monitor.height * 0.66)
418
self.set_default_size(width, height)
419
self.construct(operations)
421
def construct(self, operations):
422
"""Construct the window contents."""
423
self.vbox = gtk.VBox()
426
self.diff = DiffWidget()
427
self.vbox.pack_end(self.diff, True, True, 0)
429
# Build after DiffWidget to connect signals
430
menubar = self._get_menu_bar()
431
self.vbox.pack_start(menubar, False, False, 0)
432
hbox = self._get_button_bar(operations)
434
self.vbox.pack_start(hbox, False, True, 0)
437
def _get_menu_bar(self):
438
menubar = gtk.MenuBar()
440
mb_view = gtk.MenuItem(_i18n("_View"))
441
mb_view_menu = gtk.Menu()
442
mb_view_wrapsource = gtk.CheckMenuItem(_i18n("Wrap _Long Lines"))
443
mb_view_wrapsource.connect('activate', self.diff._on_wraplines_toggled)
444
mb_view_wrapsource.show()
445
mb_view_menu.append(mb_view_wrapsource)
447
mb_view.set_submenu(mb_view_menu)
449
menubar.append(mb_view)
453
def _get_button_bar(self, operations):
454
"""Return a button bar to use.
456
:return: None, meaning that no button bar will be used.
458
if operations is None:
460
hbox = gtk.HButtonBox()
461
hbox.set_layout(gtk.BUTTONBOX_START)
462
for title, method in operations:
463
merge_button = gtk.Button(title)
465
merge_button.set_relief(gtk.RELIEF_NONE)
466
merge_button.connect("clicked", method)
467
hbox.pack_start(merge_button, expand=False, fill=True)
471
def _get_merge_target(self):
472
d = gtk.FileChooserDialog('Merge branch', self,
473
gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER,
474
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
476
gtk.RESPONSE_CANCEL,))
479
if result != gtk.RESPONSE_OK:
480
raise SelectCancelled()
481
return d.get_current_folder_uri()
485
def _merge_successful(self):
486
# No conflicts found.
487
info_dialog(_i18n('Merge successful'),
488
_i18n('All changes applied successfully.'))
490
def _conflicts(self):
491
warning_dialog(_i18n('Conflicts encountered'),
492
_i18n('Please resolve the conflicts manually'
493
' before committing.'))
495
def _handle_error(self, e):
496
error_dialog('Error', str(e))
498
def _get_save_path(self, basename):
499
d = gtk.FileChooserDialog('Save As', self,
500
gtk.FILE_CHOOSER_ACTION_SAVE,
501
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
503
gtk.RESPONSE_CANCEL,))
504
d.set_current_name(basename)
507
if result != gtk.RESPONSE_OK:
508
raise SelectCancelled()
509
return urlutils.local_path_from_url(d.get_uri())
513
def set_diff(self, description, rev_tree, parent_tree):
514
"""Set the differences showed by this window.
516
Compares the two trees and populates the window with the
519
self.diff.set_diff(rev_tree, parent_tree)
520
self.set_title(description + " - bzrk diff")
522
def set_file(self, file_path):
523
self.diff.set_file(file_path)
526
class DiffController(object):
528
def __init__(self, path, patch, window=None):
532
window = DiffWindow(operations=self._provide_operations())
533
self.initialize_window(window)
536
def initialize_window(self, window):
537
window.diff.set_diff_text_sections(self.get_diff_sections())
538
window.set_title(self.path + " - diff")
540
def get_diff_sections(self):
541
yield "Complete Diff", None, ''.join(self.patch)
542
for patch in parse_patches(self.patch):
543
oldname = patch.oldname.split('\t')[0]
544
newname = patch.newname.split('\t')[0]
545
yield oldname, newname, str(patch)
547
def perform_save(self, window):
549
save_path = self.window._get_save_path(osutils.basename(self.path))
550
except SelectCancelled:
552
source = open(self.path, 'rb')
554
target = open(save_path, 'wb')
556
osutils.pumpfile(source, target)
562
def _provide_operations(self):
563
return [('Save', self.perform_save)]
566
class MergeDirectiveController(DiffController):
568
def __init__(self, path, directive, window=None):
569
DiffController.__init__(self, path, directive.patch.splitlines(True),
571
self.directive = directive
572
self.merge_target = None
574
def _provide_operations(self):
575
return [('Merge', self.perform_merge), ('Save', self.perform_save)]
577
def perform_merge(self, window):
578
if self.merge_target is None:
580
self.merge_target = self.window._get_merge_target()
581
except SelectCancelled:
583
tree = workingtree.WorkingTree.open(self.merge_target)
587
merger, verified = _mod_merge.Merger.from_mergeable(tree,
588
self.directive, progress.DummyProgress())
589
merger.check_basis(True)
590
merger.merge_type = _mod_merge.Merge3Merger
591
conflict_count = merger.do_merge()
593
if conflict_count == 0:
594
self.window._merge_successful()
596
self.window._conflicts()
597
# There are conflicts to be resolved.
598
self.window.destroy()
600
self.window._handle_error(e)
605
def iter_changes_to_status(source, target):
606
"""Determine the differences between trees.
608
This is a wrapper around iter_changes which just yields more
609
understandable results.
611
:param source: The source tree (basis tree)
612
:param target: The target tree
613
:return: A list of (file_id, real_path, change_type, display_path)
618
renamed_and_modified = 'renamed and modified'
619
modified = 'modified'
620
kind_changed = 'kind changed'
623
# TODO: Handle metadata changes
630
for (file_id, paths, changed_content, versioned, parent_ids, names,
631
kinds, executables) in target.iter_changes(source):
633
# Skip the root entry if it isn't very interesting
634
if parent_ids == (None, None):
641
source_marker = osutils.kind_marker(kinds[0])
645
# We assume bzr will flag only files in that case,
646
# there may be a bzr bug there as only files seems to
647
# not receive any kind.
648
marker = osutils.kind_marker('file')
650
marker = osutils.kind_marker(kinds[0])
652
marker = osutils.kind_marker(kinds[1])
655
if real_path is None:
657
assert real_path is not None
659
present_source = versioned[0] and kinds[0] is not None
660
present_target = versioned[1] and kinds[1] is not None
662
if kinds[0] is None and kinds[1] is None:
663
change_type = missing
664
display_path = real_path + marker
665
elif present_source != present_target:
669
assert present_source
670
change_type = removed
671
display_path = real_path + marker
672
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
674
if changed_content or executables[0] != executables[1]:
676
change_type = renamed_and_modified
678
change_type = renamed
679
display_path = (paths[0] + source_marker
680
+ ' => ' + paths[1] + marker)
681
elif kinds[0] != kinds[1]:
682
change_type = kind_changed
683
display_path = (paths[0] + source_marker
684
+ ' => ' + paths[1] + marker)
685
elif changed_content or executables[0] != executables[1]:
686
change_type = modified
687
display_path = real_path + marker
689
assert False, "How did we get here?"
691
status.append((file_id, real_path, change_type, display_path))
168
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files)
169
self.buffer.set_text(s.getvalue().decode(sys.getdefaultencoding(), 'replace'))