1
# -*- coding: UTF-8 -*-
4
This module contains the code to manage the diff window which shows
5
the changes made between two revisions on a branch.
8
__copyright__ = "Copyright © 2005 Canonical Ltd."
9
__author__ = "Scott James Remnant <scott@ubuntu.com>"
12
from cStringIO import StringIO
24
have_gtksourceview = True
26
have_gtksourceview = False
33
from bzrlib import merge as _mod_merge, osutils, progress, workingtree
34
from bzrlib.diff import show_diff_trees, internal_diff
35
from bzrlib.errors import NoSuchFile
36
from bzrlib.patches import parse_patches
37
from bzrlib.trace import warning
38
from bzrlib.plugins.gtk.window import Window
39
from dialog import error_dialog, info_dialog, warning_dialog
42
class SelectCancelled(Exception):
47
class DiffFileView(gtk.ScrolledWindow):
50
gtk.ScrolledWindow.__init__(self)
55
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
56
self.set_shadow_type(gtk.SHADOW_IN)
58
if have_gtksourceview:
59
self.buffer = gtksourceview.SourceBuffer()
60
slm = gtksourceview.SourceLanguagesManager()
61
gsl = slm.get_language_from_mime_type("text/x-patch")
63
self.apply_gedit_colors(gsl)
64
self.apply_colordiff_colors(gsl)
65
self.buffer.set_language(gsl)
66
self.buffer.set_highlight(True)
68
sourceview = gtksourceview.SourceView(self.buffer)
70
self.buffer = gtk.TextBuffer()
71
sourceview = gtk.TextView(self.buffer)
73
sourceview.set_editable(False)
74
sourceview.modify_font(pango.FontDescription("Monospace"))
79
def apply_gedit_colors(lang):
80
"""Set style for lang to that specified in gedit configuration.
82
This method needs the gconf module.
84
:param lang: a gtksourceview.SourceLanguage object.
86
GEDIT_SYNTAX_PATH = '/apps/gedit-2/preferences/syntax_highlighting'
87
GEDIT_LANG_PATH = GEDIT_SYNTAX_PATH + '/' + lang.get_id()
89
client = gconf.client_get_default()
90
client.add_dir(GEDIT_LANG_PATH, gconf.CLIENT_PRELOAD_NONE)
92
for tag in lang.get_tags():
94
gconf_key = GEDIT_LANG_PATH + '/' + tag_id
95
style_string = client.get_string(gconf_key)
97
if style_string is None:
100
# function to get a bool from a string that's either '0' or '1'
101
string_bool = lambda x: bool(int(x))
103
# style_string is a string like "2/#FFCCAA/#000000/0/1/0/0"
104
# values are: mask, fg, bg, italic, bold, underline, strike
105
# this packs them into (str_value, attr_name, conv_func) tuples
106
items = zip(style_string.split('/'), ['mask', 'foreground',
107
'background', 'italic', 'bold', 'underline', 'strikethrough' ],
108
[ int, gtk.gdk.color_parse, gtk.gdk.color_parse, string_bool,
109
string_bool, string_bool, string_bool ]
112
style = gtksourceview.SourceTagStyle()
114
# XXX The mask attribute controls whether the present values of
115
# foreground and background color should in fact be used. Ideally
116
# (and that's what gedit does), one could set all three attributes,
117
# and let the TagStyle object figure out which colors to use.
118
# However, in the GtkSourceview python bindings, the mask attribute
119
# is read-only, and it's derived instead from the colors being
120
# set or not. This means that we have to sometimes refrain from
121
# setting fg or bg colors, depending on the value of the mask.
122
# This code could go away if mask were writable.
123
mask = int(items[0][0])
124
if not (mask & 1): # GTK_SOURCE_TAG_STYLE_USE_BACKGROUND
126
if not (mask & 2): # GTK_SOURCE_TAG_STYLE_USE_FOREGROUND
128
items[0:1] = [] # skip the mask unconditionally
130
for value, attr, func in items:
134
warning('gconf key %s contains an invalid value: %s'
137
setattr(style, attr, value)
139
lang.set_tag_style(tag_id, style)
142
def apply_colordiff_colors(klass, lang):
143
"""Set style colors for lang using the colordiff configuration file.
145
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
147
:param lang: a "Diff" gtksourceview.SourceLanguage object.
151
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
152
f = os.path.expanduser(f)
153
if os.path.exists(f):
157
warning('could not open file %s: %s' % (f, str(e)))
159
colors.update(klass.parse_colordiffrc(f))
163
# ~/.colordiffrc does not exist
167
# map GtkSourceView tags to colordiff names
168
# since GSV is richer, accept new names for extra bits,
169
# defaulting to old names if they're not present
170
'Added@32@line': ['newtext'],
171
'Removed@32@line': ['oldtext'],
172
'Location': ['location', 'diffstuff'],
173
'Diff@32@file': ['file', 'diffstuff'],
174
'Special@32@case': ['specialcase', 'diffstuff'],
177
for tag in lang.get_tags():
178
tag_id = tag.get_id()
179
keys = mapping.get(tag_id, [])
183
color = colors.get(key, None)
184
if color is not None:
190
style = gtksourceview.SourceTagStyle()
192
style.foreground = gtk.gdk.color_parse(color)
194
warning('not a valid color: %s' % color)
196
lang.set_tag_style(tag_id, style)
199
def parse_colordiffrc(fileobj):
200
"""Parse fileobj as a colordiff configuration file.
202
:return: A dict with the key -> value pairs.
206
if re.match(r'^\s*#', line):
210
key, val = line.split('=', 1)
211
colors[key.strip()] = val.strip()
214
def set_trees(self, rev_tree, parent_tree):
215
self.rev_tree = rev_tree
216
self.parent_tree = parent_tree
217
# self._build_delta()
219
# def _build_delta(self):
220
# self.parent_tree.lock_read()
221
# self.rev_tree.lock_read()
223
# self.delta = _iter_changes_to_status(self.parent_tree, self.rev_tree)
224
# self.path_to_status = {}
225
# self.path_to_diff = {}
226
# source_inv = self.parent_tree.inventory
227
# target_inv = self.rev_tree.inventory
228
# for (file_id, real_path, change_type, display_path) in self.delta:
229
# self.path_to_status[real_path] = u'=== %s %s' % (change_type, display_path)
230
# if change_type in ('modified', 'renamed and modified'):
231
# source_ie = source_inv[file_id]
232
# target_ie = target_inv[file_id]
234
# source_ie.diff(internal_diff, *old path, *old_tree,
235
# *new_path, target_ie, self.rev_tree,
237
# self.path_to_diff[real_path] =
240
# self.rev_tree.unlock()
241
# self.parent_tree.unlock()
243
def show_diff(self, specific_files):
245
if specific_files is None:
246
self.buffer.set_text(self._diffs[None])
248
for specific_file in specific_files:
249
sections.append(self._diffs[specific_file])
250
self.buffer.set_text(''.join(sections))
253
class DiffView(DiffFileView):
254
"""This is the soft and chewy filling for a DiffWindow."""
257
DiffFileView.__init__(self)
259
self.parent_tree = None
261
def show_diff(self, specific_files):
263
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
264
old_label='', new_label='',
265
# path_encoding=sys.getdefaultencoding()
266
# The default is utf-8, but we interpret the file
267
# contents as getdefaultencoding(), so we should
268
# probably try to make the paths in the same encoding.
270
# str.decode(encoding, 'replace') doesn't do anything. Because if a
271
# character is not valid in 'encoding' there is nothing to replace, the
272
# 'replace' is for 'str.encode()'
274
decoded = s.getvalue().decode(sys.getdefaultencoding())
275
except UnicodeDecodeError:
277
decoded = s.getvalue().decode('UTF-8')
278
except UnicodeDecodeError:
279
decoded = s.getvalue().decode('iso-8859-1')
280
# This always works, because every byte has a valid
281
# mapping from iso-8859-1 to Unicode
282
# TextBuffer must contain pure UTF-8 data
283
self.buffer.set_text(decoded.encode('UTF-8'))
286
class DiffWidget(gtk.HPaned):
291
super(DiffWidget, self).__init__()
293
# The file hierarchy: a scrollable treeview
294
scrollwin = gtk.ScrolledWindow()
295
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
296
scrollwin.set_shadow_type(gtk.SHADOW_IN)
297
self.pack1(scrollwin)
300
self.model = gtk.TreeStore(str, str)
301
self.treeview = gtk.TreeView(self.model)
302
self.treeview.set_headers_visible(False)
303
self.treeview.set_search_column(1)
304
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
305
scrollwin.add(self.treeview)
308
cell = gtk.CellRendererText()
309
cell.set_property("width-chars", 20)
310
column = gtk.TreeViewColumn()
311
column.pack_start(cell, expand=True)
312
column.add_attribute(cell, "text", 0)
313
self.treeview.append_column(column)
315
def set_diff_text(self, lines):
316
# The diffs of the selected file: a scrollable source or
318
self.diff_view = DiffFileView()
319
self.diff_view.show()
320
self.pack2(self.diff_view)
321
self.model.append(None, [ "Complete Diff", "" ])
322
self.diff_view._diffs[None] = ''.join(lines)
323
for patch in parse_patches(lines):
324
oldname = patch.oldname.split('\t')[0]
325
newname = patch.newname.split('\t')[0]
326
self.model.append(None, [oldname, newname])
327
self.diff_view._diffs[newname] = str(patch)
328
self.diff_view.show_diff(None)
330
def set_diff(self, rev_tree, parent_tree):
331
"""Set the differences showed by this window.
333
Compares the two trees and populates the window with the
336
self.diff_view = DiffView()
337
self.pack2(self.diff_view)
338
self.diff_view.show()
339
self.diff_view.set_trees(rev_tree, parent_tree)
340
self.rev_tree = rev_tree
341
self.parent_tree = parent_tree
344
delta = self.rev_tree.changes_from(self.parent_tree)
346
self.model.append(None, [ "Complete Diff", "" ])
349
titer = self.model.append(None, [ "Added", None ])
350
for path, id, kind in delta.added:
351
self.model.append(titer, [ path, path ])
353
if len(delta.removed):
354
titer = self.model.append(None, [ "Removed", None ])
355
for path, id, kind in delta.removed:
356
self.model.append(titer, [ path, path ])
358
if len(delta.renamed):
359
titer = self.model.append(None, [ "Renamed", None ])
360
for oldpath, newpath, id, kind, text_modified, meta_modified \
362
self.model.append(titer, [ oldpath, newpath ])
364
if len(delta.modified):
365
titer = self.model.append(None, [ "Modified", None ])
366
for path, id, kind, text_modified, meta_modified in delta.modified:
367
self.model.append(titer, [ path, path ])
369
self.treeview.expand_all()
371
def set_file(self, file_path):
373
for data in self.model:
374
for child in data.iterchildren():
375
if child[0] == file_path or child[1] == file_path:
379
raise NoSuchFile(file_path)
380
self.treeview.set_cursor(tv_path)
381
self.treeview.scroll_to_cell(tv_path)
383
def _treeview_cursor_cb(self, *args):
384
"""Callback for when the treeview cursor changes."""
385
(path, col) = self.treeview.get_cursor()
386
specific_files = [ self.model[path][1] ]
387
if specific_files == [ None ]:
389
elif specific_files == [ "" ]:
390
specific_files = None
392
self.diff_view.show_diff(specific_files)
395
class DiffWindow(Window):
398
This object represents and manages a single window containing the
399
differences between two revisions on a branch.
402
def __init__(self, parent=None):
403
Window.__init__(self, parent)
404
self.set_border_width(0)
405
self.set_title("bzrk diff")
407
# Use two thirds of the screen by default
408
screen = self.get_screen()
409
monitor = screen.get_monitor_geometry(0)
410
width = int(monitor.width * 0.66)
411
height = int(monitor.height * 0.66)
412
self.set_default_size(width, height)
417
"""Construct the window contents."""
418
self.vbox = gtk.VBox()
421
hbox = self._get_button_bar()
423
self.vbox.pack_start(hbox, expand=False, fill=True)
424
self.diff = DiffWidget()
425
self.vbox.add(self.diff)
428
def _get_button_bar(self):
431
def set_diff_text(self, description, lines):
432
self.diff.set_diff_text(lines)
433
self.set_title(description + " - bzrk diff")
435
def set_diff(self, description, rev_tree, parent_tree):
436
"""Set the differences showed by this window.
438
Compares the two trees and populates the window with the
441
self.diff.set_diff(rev_tree, parent_tree)
442
self.set_title(description + " - bzrk diff")
444
def set_file(self, file_path):
445
self.diff.set_file(file_path)
448
class MergeDirectiveWindow(DiffWindow):
450
def __init__(self, directive, parent=None):
451
DiffWindow.__init__(self, parent)
452
self._merge_target = None
453
self.directive = directive
455
def _get_button_bar(self):
456
merge_button = gtk.Button('Merge')
458
merge_button.set_relief(gtk.RELIEF_NONE)
459
merge_button.connect("clicked", self.perform_merge)
461
hbox = gtk.HButtonBox()
462
hbox.set_layout(gtk.BUTTONBOX_START)
463
hbox.pack_start(merge_button, expand=False, fill=True)
467
def perform_merge(self, window):
469
tree = self._get_merge_target()
470
except SelectCancelled:
475
merger, verified = _mod_merge.Merger.from_mergeable(tree,
476
self.directive, progress.DummyProgress())
477
merger.check_basis(True)
478
merger.merge_type = _mod_merge.Merge3Merger
479
conflict_count = merger.do_merge()
481
if conflict_count == 0:
482
# No conflicts found.
483
info_dialog(_('Merge successful'),
484
_('All changes applied successfully.'))
486
# There are conflicts to be resolved.
487
warning_dialog(_('Conflicts encountered'),
488
_('Please resolve the conflicts manually'
489
' before committing.'))
492
error_dialog('Error', str(e))
496
def _get_merge_target(self):
497
if self._merge_target is not None:
498
return self._merge_target
499
d = gtk.FileChooserDialog('Merge branch', self,
500
gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER,
501
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
503
gtk.RESPONSE_CANCEL,))
506
if result == gtk.RESPONSE_OK:
507
uri = d.get_current_folder_uri()
508
return workingtree.WorkingTree.open(uri)
510
raise SelectCancelled()
515
def _iter_changes_to_status(source, target):
516
"""Determine the differences between trees.
518
This is a wrapper around _iter_changes which just yields more
519
understandable results.
521
:param source: The source tree (basis tree)
522
:param target: The target tree
523
:return: A list of (file_id, real_path, change_type, display_path)
528
renamed_and_modified = 'renamed and modified'
529
modified = 'modified'
530
kind_changed = 'kind changed'
532
# TODO: Handle metadata changes
539
for (file_id, paths, changed_content, versioned, parent_ids, names,
540
kinds, executables) in target._iter_changes(source):
542
# Skip the root entry if it isn't very interesting
543
if parent_ids == (None, None):
550
source_marker = osutils.kind_marker(kinds[0])
552
assert kinds[0] is not None
553
marker = osutils.kind_marker(kinds[0])
555
marker = osutils.kind_marker(kinds[1])
558
if real_path is None:
560
assert real_path is not None
561
display_path = real_path + marker
563
present_source = versioned[0] and kinds[0] is not None
564
present_target = versioned[1] and kinds[1] is not None
566
if present_source != present_target:
570
assert present_source
571
change_type = removed
572
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
574
if changed_content or executables[0] != executables[1]:
576
change_type = renamed_and_modified
578
change_type = renamed
579
display_path = (paths[0] + source_marker
580
+ ' => ' + paths[1] + marker)
581
elif kinds[0] != kinds[1]:
582
change_type = kind_changed
583
display_path = (paths[0] + source_marker
584
+ ' => ' + paths[1] + marker)
585
elif changed_content is True or executables[0] != executables[1]:
586
change_type = modified
588
assert False, "How did we get here?"
590
status.append((file_id, real_path, change_type, display_path))