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
16
from gi.repository import Gtk
17
from gi.repository import Pango
19
from gi.repository import GtkSource
20
have_gtksourceview = True
22
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
39
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"""
61
super(DiffFileView, self).__init__()
66
self.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
67
self.set_shadow_type(Gtk.ShadowType.IN)
69
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)
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()
86
def set_trees(self, rev_tree, parent_tree):
87
self.rev_tree = rev_tree
88
self.parent_tree = parent_tree
91
# def _build_delta(self):
92
# self.parent_tree.lock_read()
93
# self.rev_tree.lock_read()
95
# self.delta = iter_changes_to_status(
96
# self.parent_tree, self.rev_tree)
97
# self.path_to_status = {}
98
# self.path_to_diff = {}
99
# source_inv = self.parent_tree.inventory
100
# target_inv = self.rev_tree.inventory
101
# for (file_id, real_path, change_type, display_path) in self.delta:
102
# self.path_to_status[real_path] = u'=== %s %s' % (
103
# change_type, display_path)
104
# if change_type in ('modified', 'renamed and modified'):
105
# source_ie = source_inv[file_id]
106
# target_ie = target_inv[file_id]
108
# source_ie.diff(internal_diff, *old path, *old_tree,
109
# *new_path, target_ie, self.rev_tree,
111
# self.path_to_diff[real_path] =
114
# self.rev_tree.unlock()
115
# self.parent_tree.unlock()
117
def show_diff(self, specific_files):
119
if specific_files is None:
120
self.buffer.set_text(self._diffs[None])
122
for specific_file in specific_files:
123
sections.append(self._diffs[specific_file])
124
self.buffer.set_text(''.join(sections))
127
class DiffView(DiffFileView):
128
"""This is the soft and chewy filling for a DiffWindow."""
131
super(DiffView, self).__init__()
133
self.parent_tree = None
135
def show_diff(self, specific_files):
136
"""Show the diff for the specified files"""
138
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
139
old_label='', new_label='',
140
# path_encoding=sys.getdefaultencoding()
141
# The default is utf-8, but we interpret the file
142
# contents as getdefaultencoding(), so we should
143
# probably try to make the paths in the same encoding.
145
# str.decode(encoding, 'replace') doesn't do anything. Because if a
146
# character is not valid in 'encoding' there is nothing to replace, the
147
# 'replace' is for 'str.encode()'
149
decoded = s.getvalue().decode(sys.getdefaultencoding())
150
except UnicodeDecodeError:
152
decoded = s.getvalue().decode('UTF-8')
153
except UnicodeDecodeError:
154
decoded = s.getvalue().decode('iso-8859-1')
155
# This always works, because every byte has a valid
156
# mapping from iso-8859-1 to Unicode
157
# TextBuffer must contain pure UTF-8 data
158
self.buffer.set_text(decoded.encode('UTF-8'))
161
class DiffWidget(Gtk.HPaned):
169
super(DiffWidget, self).__init__()
171
# 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:
179
self.model = Gtk.TreeStore(str, str)
180
self.treeview = Gtk.TreeView(model=self.model)
181
self.treeview.set_headers_visible(False)
182
self.treeview.set_search_column(1)
183
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
184
scrollwin.add(self.treeview)
185
if self.SHOW_WIDGETS:
188
cell = Gtk.CellRendererText()
189
cell.set_property("width-chars", 20)
190
column = Gtk.TreeViewColumn()
191
column.pack_start(cell, True)
192
column.add_attribute(cell, "text", 0)
193
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
# 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):
217
"""Set the differences showed by this window.
219
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
self.diff_view.set_trees(rev_tree, parent_tree)
228
self.rev_tree = rev_tree
229
self.parent_tree = parent_tree
232
delta = self.rev_tree.changes_from(self.parent_tree)
234
self.model.append(None, ["Complete Diff", ""])
237
titer = self.model.append(None, ["Added", None])
238
for path, id, kind in delta.added:
239
self.model.append(titer, [path, path])
241
if len(delta.removed):
242
titer = self.model.append(None, ["Removed", None])
243
for path, id, kind in delta.removed:
244
self.model.append(titer, [path, path])
246
if len(delta.renamed):
247
titer = self.model.append(None, ["Renamed", None])
248
for oldpath, newpath, id, kind, text_modified, meta_modified \
250
self.model.append(titer, [oldpath, newpath])
252
if len(delta.modified):
253
titer = self.model.append(None, ["Modified", None])
254
for path, id, kind, text_modified, meta_modified in delta.modified:
255
self.model.append(titer, [path, path])
257
self.treeview.expand_all()
258
self.diff_view.show_diff(None)
260
def set_file(self, file_path):
261
"""Select the current file to display"""
263
for data in self.model:
264
for child in data.iterchildren():
265
if child[0] == file_path or child[1] == file_path:
269
raise errors.NoSuchFile(file_path)
270
self.treeview.set_cursor(tv_path, None, False)
271
self.treeview.scroll_to_cell(tv_path)
273
def _treeview_cursor_cb(self, *args):
274
"""Callback for when the treeview cursor changes."""
275
(path, col) = self.treeview.get_cursor()
278
specific_files = [self.model[path][1]]
279
if specific_files == [None]:
281
elif specific_files == [""]:
282
specific_files = None
284
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):
510
"""Determine the differences between trees.
512
This is a wrapper around iter_changes which just yields more
513
understandable results.
515
:param source: The source tree (basis tree)
516
:param target: The target tree
517
:return: A list of (file_id, real_path, change_type, display_path)
522
renamed_and_modified = 'renamed and modified'
523
modified = 'modified'
524
kind_changed = 'kind changed'
527
# TODO: Handle metadata changes
534
for (file_id, paths, changed_content, versioned, parent_ids, names,
535
kinds, executables) in target.iter_changes(source):
537
# Skip the root entry if it isn't very interesting
538
if parent_ids == (None, None):
545
source_marker = osutils.kind_marker(kinds[0])
549
# We assume bzr will flag only files in that case,
550
# there may be a bzr bug there as only files seems to
551
# not receive any kind.
552
marker = osutils.kind_marker('file')
554
marker = osutils.kind_marker(kinds[0])
556
marker = osutils.kind_marker(kinds[1])
559
if real_path is None:
561
assert real_path is not None
563
present_source = versioned[0] and kinds[0] is not None
564
present_target = versioned[1] and kinds[1] is not None
566
if kinds[0] is None and kinds[1] is None:
567
change_type = missing
568
display_path = real_path + marker
569
elif present_source != present_target:
573
assert present_source
574
change_type = removed
575
display_path = real_path + marker
576
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
578
if changed_content or executables[0] != executables[1]:
580
change_type = renamed_and_modified
582
change_type = renamed
583
display_path = (paths[0] + source_marker
584
+ ' => ' + paths[1] + marker)
585
elif kinds[0] != kinds[1]:
586
change_type = kind_changed
587
display_path = (paths[0] + source_marker
588
+ ' => ' + paths[1] + marker)
589
elif changed_content or executables[0] != executables[1]:
590
change_type = modified
591
display_path = real_path + marker
593
assert False, "How did we get here?"
595
status.append((file_id, real_path, change_type, display_path))
added
removed
diff.py
