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
40
from bzrlib.diff import show_diff_trees, internal_diff
41
from bzrlib.errors import NoSuchFile
42
from bzrlib.patches import parse_patches
43
from bzrlib.trace import warning
44
from bzrlib.plugins.gtk.window import Window
45
from dialog import error_dialog, info_dialog, warning_dialog
48
class SelectCancelled(Exception):
53
class DiffFileView(gtk.ScrolledWindow):
54
"""Window for displaying diffs from a diff file"""
57
gtk.ScrolledWindow.__init__(self)
62
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
63
self.set_shadow_type(gtk.SHADOW_IN)
65
if have_gtksourceview:
66
self.buffer = gtksourceview.SourceBuffer()
67
slm = gtksourceview.SourceLanguagesManager()
68
gsl = slm.get_language_from_mime_type("text/x-patch")
70
self.apply_gedit_colors(gsl)
71
self.apply_colordiff_colors(gsl)
72
self.buffer.set_language(gsl)
73
self.buffer.set_highlight(True)
75
sourceview = gtksourceview.SourceView(self.buffer)
77
self.buffer = gtk.TextBuffer()
78
sourceview = gtk.TextView(self.buffer)
80
sourceview.set_editable(False)
81
sourceview.modify_font(pango.FontDescription("Monospace"))
86
def apply_gedit_colors(lang):
87
"""Set style for lang to that specified in gedit configuration.
89
This method needs the gconf module.
91
:param lang: a gtksourceview.SourceLanguage object.
93
GEDIT_SYNTAX_PATH = '/apps/gedit-2/preferences/syntax_highlighting'
94
GEDIT_LANG_PATH = GEDIT_SYNTAX_PATH + '/' + lang.get_id()
96
client = gconf.client_get_default()
97
client.add_dir(GEDIT_LANG_PATH, gconf.CLIENT_PRELOAD_NONE)
99
for tag in lang.get_tags():
100
tag_id = tag.get_id()
101
gconf_key = GEDIT_LANG_PATH + '/' + tag_id
102
style_string = client.get_string(gconf_key)
104
if style_string is None:
107
# function to get a bool from a string that's either '0' or '1'
108
string_bool = lambda x: bool(int(x))
110
# style_string is a string like "2/#FFCCAA/#000000/0/1/0/0"
111
# values are: mask, fg, bg, italic, bold, underline, strike
112
# this packs them into (str_value, attr_name, conv_func) tuples
113
items = zip(style_string.split('/'), ['mask', 'foreground',
114
'background', 'italic', 'bold', 'underline', 'strikethrough' ],
115
[ int, gtk.gdk.color_parse, gtk.gdk.color_parse, string_bool,
116
string_bool, string_bool, string_bool ]
119
style = gtksourceview.SourceTagStyle()
121
# XXX The mask attribute controls whether the present values of
122
# foreground and background color should in fact be used. Ideally
123
# (and that's what gedit does), one could set all three attributes,
124
# and let the TagStyle object figure out which colors to use.
125
# However, in the GtkSourceview python bindings, the mask attribute
126
# is read-only, and it's derived instead from the colors being
127
# set or not. This means that we have to sometimes refrain from
128
# setting fg or bg colors, depending on the value of the mask.
129
# This code could go away if mask were writable.
130
mask = int(items[0][0])
131
if not (mask & 1): # GTK_SOURCE_TAG_STYLE_USE_BACKGROUND
133
if not (mask & 2): # GTK_SOURCE_TAG_STYLE_USE_FOREGROUND
135
items[0:1] = [] # skip the mask unconditionally
137
for value, attr, func in items:
141
warning('gconf key %s contains an invalid value: %s'
144
setattr(style, attr, value)
146
lang.set_tag_style(tag_id, style)
149
def apply_colordiff_colors(klass, lang):
150
"""Set style colors for lang using the colordiff configuration file.
152
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
154
:param lang: a "Diff" gtksourceview.SourceLanguage object.
158
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
159
f = os.path.expanduser(f)
160
if os.path.exists(f):
164
warning('could not open file %s: %s' % (f, str(e)))
166
colors.update(klass.parse_colordiffrc(f))
170
# ~/.colordiffrc does not exist
174
# map GtkSourceView tags to colordiff names
175
# since GSV is richer, accept new names for extra bits,
176
# defaulting to old names if they're not present
177
'Added@32@line': ['newtext'],
178
'Removed@32@line': ['oldtext'],
179
'Location': ['location', 'diffstuff'],
180
'Diff@32@file': ['file', 'diffstuff'],
181
'Special@32@case': ['specialcase', 'diffstuff'],
184
for tag in lang.get_tags():
185
tag_id = tag.get_id()
186
keys = mapping.get(tag_id, [])
190
color = colors.get(key, None)
191
if color is not None:
197
style = gtksourceview.SourceTagStyle()
199
style.foreground = gtk.gdk.color_parse(color)
201
warning('not a valid color: %s' % color)
203
lang.set_tag_style(tag_id, style)
206
def parse_colordiffrc(fileobj):
207
"""Parse fileobj as a colordiff configuration file.
209
:return: A dict with the key -> value pairs.
213
if re.match(r'^\s*#', line):
217
key, val = line.split('=', 1)
218
colors[key.strip()] = val.strip()
221
def set_trees(self, rev_tree, parent_tree):
222
self.rev_tree = rev_tree
223
self.parent_tree = parent_tree
224
# self._build_delta()
226
# def _build_delta(self):
227
# self.parent_tree.lock_read()
228
# self.rev_tree.lock_read()
230
# self.delta = iter_changes_to_status(self.parent_tree, self.rev_tree)
231
# self.path_to_status = {}
232
# self.path_to_diff = {}
233
# source_inv = self.parent_tree.inventory
234
# target_inv = self.rev_tree.inventory
235
# for (file_id, real_path, change_type, display_path) in self.delta:
236
# self.path_to_status[real_path] = u'=== %s %s' % (change_type, display_path)
237
# if change_type in ('modified', 'renamed and modified'):
238
# source_ie = source_inv[file_id]
239
# target_ie = target_inv[file_id]
241
# source_ie.diff(internal_diff, *old path, *old_tree,
242
# *new_path, target_ie, self.rev_tree,
244
# self.path_to_diff[real_path] =
247
# self.rev_tree.unlock()
248
# self.parent_tree.unlock()
250
def show_diff(self, specific_files):
252
if specific_files is None:
253
self.buffer.set_text(self._diffs[None])
255
for specific_file in specific_files:
256
sections.append(self._diffs[specific_file])
257
self.buffer.set_text(''.join(sections))
260
class DiffView(DiffFileView):
261
"""This is the soft and chewy filling for a DiffWindow."""
264
DiffFileView.__init__(self)
266
self.parent_tree = None
268
def show_diff(self, specific_files):
269
"""Show the diff for the specified files"""
271
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
272
old_label='', new_label='',
273
# path_encoding=sys.getdefaultencoding()
274
# The default is utf-8, but we interpret the file
275
# contents as getdefaultencoding(), so we should
276
# probably try to make the paths in the same encoding.
278
# str.decode(encoding, 'replace') doesn't do anything. Because if a
279
# character is not valid in 'encoding' there is nothing to replace, the
280
# 'replace' is for 'str.encode()'
282
decoded = s.getvalue().decode(sys.getdefaultencoding())
283
except UnicodeDecodeError:
285
decoded = s.getvalue().decode('UTF-8')
286
except UnicodeDecodeError:
287
decoded = s.getvalue().decode('iso-8859-1')
288
# This always works, because every byte has a valid
289
# mapping from iso-8859-1 to Unicode
290
# TextBuffer must contain pure UTF-8 data
291
self.buffer.set_text(decoded.encode('UTF-8'))
294
class DiffWidget(gtk.HPaned):
299
super(DiffWidget, self).__init__()
301
# The file hierarchy: a scrollable treeview
302
scrollwin = gtk.ScrolledWindow()
303
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
304
scrollwin.set_shadow_type(gtk.SHADOW_IN)
305
self.pack1(scrollwin)
308
self.model = gtk.TreeStore(str, str)
309
self.treeview = gtk.TreeView(self.model)
310
self.treeview.set_headers_visible(False)
311
self.treeview.set_search_column(1)
312
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
313
scrollwin.add(self.treeview)
316
cell = gtk.CellRendererText()
317
cell.set_property("width-chars", 20)
318
column = gtk.TreeViewColumn()
319
column.pack_start(cell, expand=True)
320
column.add_attribute(cell, "text", 0)
321
self.treeview.append_column(column)
323
def set_diff_text(self, lines):
324
"""Set the current diff from a list of lines
326
:param lines: The diff to show, in unified diff format
328
# The diffs of the selected file: a scrollable source or
330
self.diff_view = DiffFileView()
331
self.diff_view.show()
332
self.pack2(self.diff_view)
333
self.model.append(None, [ "Complete Diff", "" ])
334
self.diff_view._diffs[None] = ''.join(lines)
335
for patch in parse_patches(lines):
336
oldname = patch.oldname.split('\t')[0]
337
newname = patch.newname.split('\t')[0]
338
self.model.append(None, [oldname, newname])
339
self.diff_view._diffs[newname] = str(patch)
340
self.diff_view.show_diff(None)
342
def set_diff(self, rev_tree, parent_tree):
343
"""Set the differences showed by this window.
345
Compares the two trees and populates the window with the
348
self.diff_view = DiffView()
349
self.pack2(self.diff_view)
350
self.diff_view.show()
351
self.diff_view.set_trees(rev_tree, parent_tree)
352
self.rev_tree = rev_tree
353
self.parent_tree = parent_tree
356
delta = self.rev_tree.changes_from(self.parent_tree)
358
self.model.append(None, [ "Complete Diff", "" ])
361
titer = self.model.append(None, [ "Added", None ])
362
for path, id, kind in delta.added:
363
self.model.append(titer, [ path, path ])
365
if len(delta.removed):
366
titer = self.model.append(None, [ "Removed", None ])
367
for path, id, kind in delta.removed:
368
self.model.append(titer, [ path, path ])
370
if len(delta.renamed):
371
titer = self.model.append(None, [ "Renamed", None ])
372
for oldpath, newpath, id, kind, text_modified, meta_modified \
374
self.model.append(titer, [ oldpath, newpath ])
376
if len(delta.modified):
377
titer = self.model.append(None, [ "Modified", None ])
378
for path, id, kind, text_modified, meta_modified in delta.modified:
379
self.model.append(titer, [ path, path ])
381
self.treeview.expand_all()
383
def set_file(self, file_path):
384
"""Select the current file to display"""
386
for data in self.model:
387
for child in data.iterchildren():
388
if child[0] == file_path or child[1] == file_path:
392
raise NoSuchFile(file_path)
393
self.treeview.set_cursor(tv_path)
394
self.treeview.scroll_to_cell(tv_path)
396
def _treeview_cursor_cb(self, *args):
397
"""Callback for when the treeview cursor changes."""
398
(path, col) = self.treeview.get_cursor()
399
specific_files = [ self.model[path][1] ]
400
if specific_files == [ None ]:
402
elif specific_files == [ "" ]:
403
specific_files = None
405
self.diff_view.show_diff(specific_files)
408
class DiffWindow(Window):
411
This object represents and manages a single window containing the
412
differences between two revisions on a branch.
415
def __init__(self, parent=None):
416
Window.__init__(self, parent)
417
self.set_border_width(0)
418
self.set_title("bzrk diff")
420
# Use two thirds of the screen by default
421
screen = self.get_screen()
422
monitor = screen.get_monitor_geometry(0)
423
width = int(monitor.width * 0.66)
424
height = int(monitor.height * 0.66)
425
self.set_default_size(width, height)
430
"""Construct the window contents."""
431
self.vbox = gtk.VBox()
434
hbox = self._get_button_bar()
436
self.vbox.pack_start(hbox, expand=False, fill=True)
437
self.diff = DiffWidget()
438
self.vbox.add(self.diff)
441
def _get_button_bar(self):
442
"""Return a button bar to use.
444
:return: None, meaning that no button bar will be used.
448
def set_diff_text(self, description, lines):
449
"""Set the diff from a text.
451
The diff must be in unified diff format, and will be parsed to
454
self.diff.set_diff_text(lines)
455
self.set_title(description + " - bzrk diff")
457
def set_diff(self, description, rev_tree, parent_tree):
458
"""Set the differences showed by this window.
460
Compares the two trees and populates the window with the
463
self.diff.set_diff(rev_tree, parent_tree)
464
self.set_title(description + " - bzrk diff")
466
def set_file(self, file_path):
467
self.diff.set_file(file_path)
470
class MergeDirectiveWindow(DiffWindow):
472
def __init__(self, directive, path):
473
DiffWindow.__init__(self, None)
474
self._merge_target = None
475
self.directive = directive
478
def _get_button_bar(self):
479
"""The button bar has only the Merge button"""
480
merge_button = gtk.Button('Merge')
482
merge_button.set_relief(gtk.RELIEF_NONE)
483
merge_button.connect("clicked", self.perform_merge)
485
save_button = gtk.Button('Save')
487
save_button.set_relief(gtk.RELIEF_NONE)
488
save_button.connect("clicked", self.perform_save)
490
hbox = gtk.HButtonBox()
491
hbox.set_layout(gtk.BUTTONBOX_START)
492
hbox.pack_start(merge_button, expand=False, fill=True)
493
hbox.pack_start(save_button, expand=False, fill=True)
497
def perform_merge(self, window):
499
tree = self._get_merge_target()
500
except SelectCancelled:
505
merger, verified = _mod_merge.Merger.from_mergeable(tree,
506
self.directive, progress.DummyProgress())
507
merger.check_basis(True)
508
merger.merge_type = _mod_merge.Merge3Merger
509
conflict_count = merger.do_merge()
511
if conflict_count == 0:
512
# No conflicts found.
513
info_dialog(_('Merge successful'),
514
_('All changes applied successfully.'))
516
# There are conflicts to be resolved.
517
warning_dialog(_('Conflicts encountered'),
518
_('Please resolve the conflicts manually'
519
' before committing.'))
522
error_dialog('Error', str(e))
526
def _get_merge_target(self):
527
if self._merge_target is not None:
528
return self._merge_target
529
d = gtk.FileChooserDialog('Merge branch', self,
530
gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER,
531
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
533
gtk.RESPONSE_CANCEL,))
536
if result != gtk.RESPONSE_OK:
537
raise SelectCancelled()
538
uri = d.get_current_folder_uri()
541
return workingtree.WorkingTree.open(uri)
543
def perform_save(self, window):
544
d = gtk.FileChooserDialog('Save As', self,
545
gtk.FILE_CHOOSER_ACTION_SAVE,
546
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
548
gtk.RESPONSE_CANCEL,))
549
d.set_current_name(osutils.basename(self.path))
553
if result != gtk.RESPONSE_OK:
554
raise SelectCancelled()
558
except SelectCancelled:
560
source = open(self.path, 'rb')
562
target = open(urlutils.local_path_from_url(uri), 'wb')
564
target.write(source.read())
571
def iter_changes_to_status(source, target):
572
"""Determine the differences between trees.
574
This is a wrapper around iter_changes which just yields more
575
understandable results.
577
:param source: The source tree (basis tree)
578
:param target: The target tree
579
:return: A list of (file_id, real_path, change_type, display_path)
584
renamed_and_modified = 'renamed and modified'
585
modified = 'modified'
586
kind_changed = 'kind changed'
588
# TODO: Handle metadata changes
595
for (file_id, paths, changed_content, versioned, parent_ids, names,
596
kinds, executables) in target.iter_changes(source):
598
# Skip the root entry if it isn't very interesting
599
if parent_ids == (None, None):
606
source_marker = osutils.kind_marker(kinds[0])
608
assert kinds[0] is not None
609
marker = osutils.kind_marker(kinds[0])
611
marker = osutils.kind_marker(kinds[1])
614
if real_path is None:
616
assert real_path is not None
617
display_path = real_path + marker
619
present_source = versioned[0] and kinds[0] is not None
620
present_target = versioned[1] and kinds[1] is not None
622
if present_source != present_target:
626
assert present_source
627
change_type = removed
628
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
630
if changed_content or executables[0] != executables[1]:
632
change_type = renamed_and_modified
634
change_type = renamed
635
display_path = (paths[0] + source_marker
636
+ ' => ' + paths[1] + marker)
637
elif kinds[0] != kinds[1]:
638
change_type = kind_changed
639
display_path = (paths[0] + source_marker
640
+ ' => ' + paths[1] + marker)
641
elif changed_content is True or executables[0] != executables[1]:
642
change_type = modified
644
assert False, "How did we get here?"
646
status.append((file_id, real_path, change_type, display_path))