3
This module contains the code to manage the diff window which shows
4
the changes made between two revisions on a branch.
7
__copyright__ = "Copyright 2005 Canonical Ltd."
8
__author__ = "Scott James Remnant <scott@ubuntu.com>"
11
from cStringIO import StringIO
21
from xml.etree.ElementTree import Element, SubElement, tostring
23
from elementtree.ElementTree import Element, SubElement, tostring
27
have_gtksourceview = True
29
have_gtksourceview = False
43
from bzrlib.diff import show_diff_trees, internal_diff
44
from bzrlib.patches import parse_patches
45
from bzrlib.trace import warning
46
from bzrlib.plugins.gtk import _i18n
47
from bzrlib.plugins.gtk.window import Window
48
from dialog import error_dialog, info_dialog, warning_dialog
51
def fallback_guess_language(slm, content_type):
52
for lang_id in slm.get_language_ids():
53
lang = slm.get_language(lang_id)
54
if "text/x-patch" in lang.get_mime_types():
59
class SelectCancelled(Exception):
64
class DiffFileView(gtk.ScrolledWindow):
65
"""Window for displaying diffs from a diff file"""
68
gtk.ScrolledWindow.__init__(self)
73
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
74
self.set_shadow_type(gtk.SHADOW_IN)
76
if have_gtksourceview:
77
self.buffer = gtksourceview2.Buffer()
78
slm = gtksourceview2.LanguageManager()
79
guess_language = getattr(gtksourceview2.LanguageManager,
80
"guess_language", fallback_guess_language)
81
gsl = guess_language(slm, content_type="text/x-patch")
83
self.apply_gedit_colors(self.buffer)
84
self.apply_colordiff_colors(self.buffer)
85
self.buffer.set_language(gsl)
86
self.buffer.set_highlight_syntax(True)
88
self.sourceview = gtksourceview2.View(self.buffer)
90
self.buffer = gtk.TextBuffer()
91
self.sourceview = gtk.TextView(self.buffer)
93
self.sourceview.set_editable(False)
94
self.sourceview.modify_font(pango.FontDescription("Monospace"))
95
self.add(self.sourceview)
96
self.sourceview.show()
99
def apply_gedit_colors(buf):
100
"""Set style to that specified in gedit configuration.
102
This method needs the gconf module.
104
:param buf: a gtksourceview2.Buffer object.
106
GEDIT_SCHEME_PATH = '/apps/gedit-2/preferences/editor/colors/scheme'
108
client = gconf.client_get_default()
109
style_scheme_name = client.get_string(GEDIT_SCHEME_PATH)
110
if style_scheme_name is not None:
111
style_scheme = gtksourceview2.StyleSchemeManager().get_scheme(style_scheme_name)
113
buf.set_style_scheme(style_scheme)
116
def apply_colordiff_colors(klass, buf):
117
"""Set style colors for lang using the colordiff configuration file.
119
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
121
:param buf: a "Diff" gtksourceview2.Buffer object.
123
scheme_manager = gtksourceview2.StyleSchemeManager()
124
style_scheme = scheme_manager.get_scheme('colordiff')
126
# if style scheme not found, we'll generate it from colordiffrc
127
# TODO: reload if colordiffrc has changed.
128
if style_scheme is None:
131
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
132
f = os.path.expanduser(f)
133
if os.path.exists(f):
137
warning('could not open file %s: %s' % (f, str(e)))
139
colors.update(klass.parse_colordiffrc(f))
143
# ~/.colordiffrc does not exist
147
# map GtkSourceView2 scheme styles to colordiff names
148
# since GSV is richer, accept new names for extra bits,
149
# defaulting to old names if they're not present
150
'diff:added-line': ['newtext'],
151
'diff:removed-line': ['oldtext'],
152
'diff:location': ['location', 'diffstuff'],
153
'diff:file': ['file', 'diffstuff'],
154
'diff:special-case': ['specialcase', 'diffstuff'],
157
converted_colors = {}
158
for name, values in mapping.items():
161
color = colors.get(value, None)
162
if color is not None:
166
converted_colors[name] = color
168
# some xml magic to produce needed style scheme description
169
e_style_scheme = Element('style-scheme')
170
e_style_scheme.set('id', 'colordiff')
171
e_style_scheme.set('_name', 'ColorDiff')
172
e_style_scheme.set('version', '1.0')
173
for name, color in converted_colors.items():
174
style = SubElement(e_style_scheme, 'style')
175
style.set('name', name)
176
style.set('foreground', '#%s' % color)
178
scheme_xml = tostring(e_style_scheme, 'UTF-8')
179
if not os.path.exists(os.path.expanduser('~/.local/share/gtksourceview-2.0/styles')):
180
os.makedirs(os.path.expanduser('~/.local/share/gtksourceview-2.0/styles'))
181
file(os.path.expanduser('~/.local/share/gtksourceview-2.0/styles/colordiff.xml'), 'w').write(scheme_xml)
183
scheme_manager.force_rescan()
184
style_scheme = scheme_manager.get_scheme('colordiff')
186
buf.set_style_scheme(style_scheme)
189
def parse_colordiffrc(fileobj):
190
"""Parse fileobj as a colordiff configuration file.
192
:return: A dict with the key -> value pairs.
196
if re.match(r'^\s*#', line):
200
key, val = line.split('=', 1)
201
colors[key.strip()] = val.strip()
204
def set_trees(self, rev_tree, parent_tree):
205
self.rev_tree = rev_tree
206
self.parent_tree = parent_tree
207
# self._build_delta()
209
# def _build_delta(self):
210
# self.parent_tree.lock_read()
211
# self.rev_tree.lock_read()
213
# self.delta = iter_changes_to_status(self.parent_tree, self.rev_tree)
214
# self.path_to_status = {}
215
# self.path_to_diff = {}
216
# source_inv = self.parent_tree.inventory
217
# target_inv = self.rev_tree.inventory
218
# for (file_id, real_path, change_type, display_path) in self.delta:
219
# self.path_to_status[real_path] = u'=== %s %s' % (change_type, display_path)
220
# if change_type in ('modified', 'renamed and modified'):
221
# source_ie = source_inv[file_id]
222
# target_ie = target_inv[file_id]
224
# source_ie.diff(internal_diff, *old path, *old_tree,
225
# *new_path, target_ie, self.rev_tree,
227
# self.path_to_diff[real_path] =
230
# self.rev_tree.unlock()
231
# self.parent_tree.unlock()
233
def show_diff(self, specific_files):
235
if specific_files is None:
236
self.buffer.set_text(self._diffs[None])
238
for specific_file in specific_files:
239
sections.append(self._diffs[specific_file])
240
self.buffer.set_text(''.join(sections))
243
class DiffView(DiffFileView):
244
"""This is the soft and chewy filling for a DiffWindow."""
247
DiffFileView.__init__(self)
249
self.parent_tree = None
251
def show_diff(self, specific_files):
252
"""Show the diff for the specified files"""
254
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
255
old_label='', new_label='',
256
# path_encoding=sys.getdefaultencoding()
257
# The default is utf-8, but we interpret the file
258
# contents as getdefaultencoding(), so we should
259
# probably try to make the paths in the same encoding.
261
# str.decode(encoding, 'replace') doesn't do anything. Because if a
262
# character is not valid in 'encoding' there is nothing to replace, the
263
# 'replace' is for 'str.encode()'
265
decoded = s.getvalue().decode(sys.getdefaultencoding())
266
except UnicodeDecodeError:
268
decoded = s.getvalue().decode('UTF-8')
269
except UnicodeDecodeError:
270
decoded = s.getvalue().decode('iso-8859-1')
271
# This always works, because every byte has a valid
272
# mapping from iso-8859-1 to Unicode
273
# TextBuffer must contain pure UTF-8 data
274
self.buffer.set_text(decoded.encode('UTF-8'))
277
class DiffWidget(gtk.HPaned):
282
super(DiffWidget, self).__init__()
284
# The file hierarchy: a scrollable treeview
285
scrollwin = gtk.ScrolledWindow()
286
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
287
scrollwin.set_shadow_type(gtk.SHADOW_IN)
288
self.pack1(scrollwin)
291
self.model = gtk.TreeStore(str, str)
292
self.treeview = gtk.TreeView(self.model)
293
self.treeview.set_headers_visible(False)
294
self.treeview.set_search_column(1)
295
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
296
scrollwin.add(self.treeview)
299
cell = gtk.CellRendererText()
300
cell.set_property("width-chars", 20)
301
column = gtk.TreeViewColumn()
302
column.pack_start(cell, expand=True)
303
column.add_attribute(cell, "text", 0)
304
self.treeview.append_column(column)
306
def set_diff_text(self, lines):
307
"""Set the current diff from a list of lines
309
:param lines: The diff to show, in unified diff format
311
# The diffs of the selected file: a scrollable source or
314
def set_diff_text_sections(self, sections):
315
if getattr(self, 'diff_view', None) is None:
316
self.diff_view = DiffFileView()
317
self.pack2(self.diff_view)
318
self.diff_view.show()
319
for oldname, newname, patch in sections:
320
self.diff_view._diffs[newname] = str(patch)
323
self.model.append(None, [oldname, newname])
324
self.diff_view.show_diff(None)
326
def set_diff(self, rev_tree, parent_tree):
327
"""Set the differences showed by this window.
329
Compares the two trees and populates the window with the
332
if getattr(self, 'diff_view', None) is None:
333
self.diff_view = DiffView()
334
self.pack2(self.diff_view)
335
self.diff_view.show()
336
self.diff_view.set_trees(rev_tree, parent_tree)
337
self.rev_tree = rev_tree
338
self.parent_tree = parent_tree
341
delta = self.rev_tree.changes_from(self.parent_tree)
343
self.model.append(None, [ "Complete Diff", "" ])
346
titer = self.model.append(None, [ "Added", None ])
347
for path, id, kind in delta.added:
348
self.model.append(titer, [ path, path ])
350
if len(delta.removed):
351
titer = self.model.append(None, [ "Removed", None ])
352
for path, id, kind in delta.removed:
353
self.model.append(titer, [ path, path ])
355
if len(delta.renamed):
356
titer = self.model.append(None, [ "Renamed", None ])
357
for oldpath, newpath, id, kind, text_modified, meta_modified \
359
self.model.append(titer, [ oldpath, newpath ])
361
if len(delta.modified):
362
titer = self.model.append(None, [ "Modified", None ])
363
for path, id, kind, text_modified, meta_modified in delta.modified:
364
self.model.append(titer, [ path, path ])
366
self.treeview.expand_all()
367
self.diff_view.show_diff(None)
369
def set_file(self, file_path):
370
"""Select the current file to display"""
372
for data in self.model:
373
for child in data.iterchildren():
374
if child[0] == file_path or child[1] == file_path:
378
raise errors.NoSuchFile(file_path)
379
self.treeview.set_cursor(tv_path)
380
self.treeview.scroll_to_cell(tv_path)
382
def _treeview_cursor_cb(self, *args):
383
"""Callback for when the treeview cursor changes."""
384
(path, col) = self.treeview.get_cursor()
385
specific_files = [ self.model[path][1] ]
386
if specific_files == [ None ]:
388
elif specific_files == [ "" ]:
389
specific_files = None
391
self.diff_view.show_diff(specific_files)
393
def _on_wraplines_toggled(self, widget=None, wrap=False):
394
"""Callback for when the wrap lines checkbutton is toggled"""
395
if wrap or widget.get_active():
396
self.diff_view.sourceview.set_wrap_mode(gtk.WRAP_WORD)
398
self.diff_view.sourceview.set_wrap_mode(gtk.WRAP_NONE)
400
class DiffWindow(Window):
403
This object represents and manages a single window containing the
404
differences between two revisions on a branch.
407
def __init__(self, parent=None, operations=None):
408
Window.__init__(self, parent)
409
self.set_border_width(0)
410
self.set_title("bzrk diff")
412
# Use two thirds of the screen by default
413
screen = self.get_screen()
414
monitor = screen.get_monitor_geometry(0)
415
width = int(monitor.width * 0.66)
416
height = int(monitor.height * 0.66)
417
self.set_default_size(width, height)
418
self.construct(operations)
420
def construct(self, operations):
421
"""Construct the window contents."""
422
self.vbox = gtk.VBox()
425
self.diff = DiffWidget()
426
self.vbox.pack_end(self.diff, True, True, 0)
428
# Build after DiffWidget to connect signals
429
menubar = self._get_menu_bar()
430
self.vbox.pack_start(menubar, False, False, 0)
431
hbox = self._get_button_bar(operations)
433
self.vbox.pack_start(hbox, False, True, 0)
436
def _get_menu_bar(self):
437
menubar = gtk.MenuBar()
439
mb_view = gtk.MenuItem(_i18n("_View"))
440
mb_view_menu = gtk.Menu()
441
mb_view_wrapsource = gtk.CheckMenuItem(_i18n("Wrap _Long Lines"))
442
mb_view_wrapsource.connect('activate', self.diff._on_wraplines_toggled)
443
mb_view_wrapsource.show()
444
mb_view_menu.append(mb_view_wrapsource)
446
mb_view.set_submenu(mb_view_menu)
448
menubar.append(mb_view)
452
def _get_button_bar(self, operations):
453
"""Return a button bar to use.
455
:return: None, meaning that no button bar will be used.
457
if operations is None:
459
hbox = gtk.HButtonBox()
460
hbox.set_layout(gtk.BUTTONBOX_START)
461
for title, method in operations:
462
merge_button = gtk.Button(title)
464
merge_button.set_relief(gtk.RELIEF_NONE)
465
merge_button.connect("clicked", method)
466
hbox.pack_start(merge_button, expand=False, fill=True)
470
def _get_merge_target(self):
471
d = gtk.FileChooserDialog('Merge branch', self,
472
gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER,
473
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
475
gtk.RESPONSE_CANCEL,))
478
if result != gtk.RESPONSE_OK:
479
raise SelectCancelled()
480
return d.get_current_folder_uri()
484
def _merge_successful(self):
485
# No conflicts found.
486
info_dialog(_i18n('Merge successful'),
487
_i18n('All changes applied successfully.'))
489
def _conflicts(self):
490
warning_dialog(_i18n('Conflicts encountered'),
491
_i18n('Please resolve the conflicts manually'
492
' before committing.'))
494
def _handle_error(self, e):
495
error_dialog('Error', str(e))
497
def _get_save_path(self, basename):
498
d = gtk.FileChooserDialog('Save As', self,
499
gtk.FILE_CHOOSER_ACTION_SAVE,
500
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
502
gtk.RESPONSE_CANCEL,))
503
d.set_current_name(basename)
506
if result != gtk.RESPONSE_OK:
507
raise SelectCancelled()
508
return urlutils.local_path_from_url(d.get_uri())
512
def set_diff(self, description, rev_tree, parent_tree):
513
"""Set the differences showed by this window.
515
Compares the two trees and populates the window with the
518
self.diff.set_diff(rev_tree, parent_tree)
519
self.set_title(description + " - bzrk diff")
521
def set_file(self, file_path):
522
self.diff.set_file(file_path)
525
class DiffController(object):
527
def __init__(self, path, patch, window=None):
531
window = DiffWindow(operations=self._provide_operations())
532
self.initialize_window(window)
535
def initialize_window(self, window):
536
window.diff.set_diff_text_sections(self.get_diff_sections())
537
window.set_title(self.path + " - diff")
539
def get_diff_sections(self):
540
yield "Complete Diff", None, ''.join(self.patch)
541
for patch in parse_patches(self.patch):
542
oldname = patch.oldname.split('\t')[0]
543
newname = patch.newname.split('\t')[0]
544
yield oldname, newname, str(patch)
546
def perform_save(self, window):
548
save_path = self.window._get_save_path(osutils.basename(self.path))
549
except SelectCancelled:
551
source = open(self.path, 'rb')
553
target = open(save_path, 'wb')
555
osutils.pumpfile(source, target)
561
def _provide_operations(self):
562
return [('Save', self.perform_save)]
565
class MergeDirectiveController(DiffController):
567
def __init__(self, path, directive, window=None):
568
DiffController.__init__(self, path, directive.patch.splitlines(True),
570
self.directive = directive
571
self.merge_target = None
573
def _provide_operations(self):
574
return [('Merge', self.perform_merge), ('Save', self.perform_save)]
576
def perform_merge(self, window):
577
if self.merge_target is None:
579
self.merge_target = self.window._get_merge_target()
580
except SelectCancelled:
582
tree = workingtree.WorkingTree.open(self.merge_target)
586
if tree.has_changes():
587
raise errors.UncommittedChanges(tree)
588
merger, verified = _mod_merge.Merger.from_mergeable(
589
tree, self.directive, pb=None)
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))