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 import _i18n
45
from bzrlib.plugins.gtk.window import Window
46
from dialog import error_dialog, info_dialog, warning_dialog
49
class SelectCancelled(Exception):
54
class DiffFileView(gtk.ScrolledWindow):
55
"""Window for displaying diffs from a diff file"""
58
gtk.ScrolledWindow.__init__(self)
63
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
64
self.set_shadow_type(gtk.SHADOW_IN)
66
if have_gtksourceview:
67
self.buffer = gtksourceview.SourceBuffer()
68
slm = gtksourceview.SourceLanguagesManager()
69
gsl = slm.get_language_from_mime_type("text/x-patch")
71
self.apply_gedit_colors(gsl)
72
self.apply_colordiff_colors(gsl)
73
self.buffer.set_language(gsl)
74
self.buffer.set_highlight(True)
76
sourceview = gtksourceview.SourceView(self.buffer)
78
self.buffer = gtk.TextBuffer()
79
sourceview = gtk.TextView(self.buffer)
81
sourceview.set_editable(False)
82
sourceview.modify_font(pango.FontDescription("Monospace"))
87
def apply_gedit_colors(lang):
88
"""Set style for lang to that specified in gedit configuration.
90
This method needs the gconf module.
92
:param lang: a gtksourceview.SourceLanguage object.
94
GEDIT_SYNTAX_PATH = '/apps/gedit-2/preferences/syntax_highlighting'
95
GEDIT_LANG_PATH = GEDIT_SYNTAX_PATH + '/' + lang.get_id()
97
client = gconf.client_get_default()
98
client.add_dir(GEDIT_LANG_PATH, gconf.CLIENT_PRELOAD_NONE)
100
for tag in lang.get_tags():
101
tag_id = tag.get_id()
102
gconf_key = GEDIT_LANG_PATH + '/' + tag_id
103
style_string = client.get_string(gconf_key)
105
if style_string is None:
108
# function to get a bool from a string that's either '0' or '1'
109
string_bool = lambda x: bool(int(x))
111
# style_string is a string like "2/#FFCCAA/#000000/0/1/0/0"
112
# values are: mask, fg, bg, italic, bold, underline, strike
113
# this packs them into (str_value, attr_name, conv_func) tuples
114
items = zip(style_string.split('/'), ['mask', 'foreground',
115
'background', 'italic', 'bold', 'underline', 'strikethrough' ],
116
[ int, gtk.gdk.color_parse, gtk.gdk.color_parse, string_bool,
117
string_bool, string_bool, string_bool ]
120
style = gtksourceview.SourceTagStyle()
122
# XXX The mask attribute controls whether the present values of
123
# foreground and background color should in fact be used. Ideally
124
# (and that's what gedit does), one could set all three attributes,
125
# and let the TagStyle object figure out which colors to use.
126
# However, in the GtkSourceview python bindings, the mask attribute
127
# is read-only, and it's derived instead from the colors being
128
# set or not. This means that we have to sometimes refrain from
129
# setting fg or bg colors, depending on the value of the mask.
130
# This code could go away if mask were writable.
131
mask = int(items[0][0])
132
if not (mask & 1): # GTK_SOURCE_TAG_STYLE_USE_BACKGROUND
134
if not (mask & 2): # GTK_SOURCE_TAG_STYLE_USE_FOREGROUND
136
items[0:1] = [] # skip the mask unconditionally
138
for value, attr, func in items:
142
warning('gconf key %s contains an invalid value: %s'
145
setattr(style, attr, value)
147
lang.set_tag_style(tag_id, style)
150
def apply_colordiff_colors(klass, lang):
151
"""Set style colors for lang using the colordiff configuration file.
153
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
155
:param lang: a "Diff" gtksourceview.SourceLanguage object.
159
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
160
f = os.path.expanduser(f)
161
if os.path.exists(f):
165
warning('could not open file %s: %s' % (f, str(e)))
167
colors.update(klass.parse_colordiffrc(f))
171
# ~/.colordiffrc does not exist
175
# map GtkSourceView tags to colordiff names
176
# since GSV is richer, accept new names for extra bits,
177
# defaulting to old names if they're not present
178
'Added@32@line': ['newtext'],
179
'Removed@32@line': ['oldtext'],
180
'Location': ['location', 'diffstuff'],
181
'Diff@32@file': ['file', 'diffstuff'],
182
'Special@32@case': ['specialcase', 'diffstuff'],
185
for tag in lang.get_tags():
186
tag_id = tag.get_id()
187
keys = mapping.get(tag_id, [])
191
color = colors.get(key, None)
192
if color is not None:
198
style = gtksourceview.SourceTagStyle()
200
style.foreground = gtk.gdk.color_parse(color)
202
warning('not a valid color: %s' % color)
204
lang.set_tag_style(tag_id, style)
207
def parse_colordiffrc(fileobj):
208
"""Parse fileobj as a colordiff configuration file.
210
:return: A dict with the key -> value pairs.
214
if re.match(r'^\s*#', line):
218
key, val = line.split('=', 1)
219
colors[key.strip()] = val.strip()
222
def set_trees(self, rev_tree, parent_tree):
223
self.rev_tree = rev_tree
224
self.parent_tree = parent_tree
225
# self._build_delta()
227
# def _build_delta(self):
228
# self.parent_tree.lock_read()
229
# self.rev_tree.lock_read()
231
# self.delta = iter_changes_to_status(self.parent_tree, self.rev_tree)
232
# self.path_to_status = {}
233
# self.path_to_diff = {}
234
# source_inv = self.parent_tree.inventory
235
# target_inv = self.rev_tree.inventory
236
# for (file_id, real_path, change_type, display_path) in self.delta:
237
# self.path_to_status[real_path] = u'=== %s %s' % (change_type, display_path)
238
# if change_type in ('modified', 'renamed and modified'):
239
# source_ie = source_inv[file_id]
240
# target_ie = target_inv[file_id]
242
# source_ie.diff(internal_diff, *old path, *old_tree,
243
# *new_path, target_ie, self.rev_tree,
245
# self.path_to_diff[real_path] =
248
# self.rev_tree.unlock()
249
# self.parent_tree.unlock()
251
def show_diff(self, specific_files):
253
if specific_files is None:
254
self.buffer.set_text(self._diffs[None])
256
for specific_file in specific_files:
257
sections.append(self._diffs[specific_file])
258
self.buffer.set_text(''.join(sections))
261
class DiffView(DiffFileView):
262
"""This is the soft and chewy filling for a DiffWindow."""
265
DiffFileView.__init__(self)
267
self.parent_tree = None
269
def show_diff(self, specific_files):
270
"""Show the diff for the specified files"""
272
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
273
old_label='', new_label='',
274
# path_encoding=sys.getdefaultencoding()
275
# The default is utf-8, but we interpret the file
276
# contents as getdefaultencoding(), so we should
277
# probably try to make the paths in the same encoding.
279
# str.decode(encoding, 'replace') doesn't do anything. Because if a
280
# character is not valid in 'encoding' there is nothing to replace, the
281
# 'replace' is for 'str.encode()'
283
decoded = s.getvalue().decode(sys.getdefaultencoding())
284
except UnicodeDecodeError:
286
decoded = s.getvalue().decode('UTF-8')
287
except UnicodeDecodeError:
288
decoded = s.getvalue().decode('iso-8859-1')
289
# This always works, because every byte has a valid
290
# mapping from iso-8859-1 to Unicode
291
# TextBuffer must contain pure UTF-8 data
292
self.buffer.set_text(decoded.encode('UTF-8'))
295
class DiffWidget(gtk.HPaned):
300
super(DiffWidget, self).__init__()
302
# The file hierarchy: a scrollable treeview
303
scrollwin = gtk.ScrolledWindow()
304
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
305
scrollwin.set_shadow_type(gtk.SHADOW_IN)
306
self.pack1(scrollwin)
309
self.model = gtk.TreeStore(str, str)
310
self.treeview = gtk.TreeView(self.model)
311
self.treeview.set_headers_visible(False)
312
self.treeview.set_search_column(1)
313
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
314
scrollwin.add(self.treeview)
317
cell = gtk.CellRendererText()
318
cell.set_property("width-chars", 20)
319
column = gtk.TreeViewColumn()
320
column.pack_start(cell, expand=True)
321
column.add_attribute(cell, "text", 0)
322
self.treeview.append_column(column)
324
def set_diff_text(self, lines):
325
"""Set the current diff from a list of lines
327
:param lines: The diff to show, in unified diff format
329
# The diffs of the selected file: a scrollable source or
331
self.diff_view = DiffFileView()
332
self.diff_view.show()
333
self.pack2(self.diff_view)
334
self.model.append(None, [ "Complete Diff", "" ])
335
self.diff_view._diffs[None] = ''.join(lines)
336
for patch in parse_patches(lines):
337
oldname = patch.oldname.split('\t')[0]
338
newname = patch.newname.split('\t')[0]
339
self.model.append(None, [oldname, newname])
340
self.diff_view._diffs[newname] = str(patch)
341
self.diff_view.show_diff(None)
343
def set_diff(self, rev_tree, parent_tree):
344
"""Set the differences showed by this window.
346
Compares the two trees and populates the window with the
349
self.diff_view = DiffView()
350
self.pack2(self.diff_view)
351
self.diff_view.show()
352
self.diff_view.set_trees(rev_tree, parent_tree)
353
self.rev_tree = rev_tree
354
self.parent_tree = parent_tree
357
delta = self.rev_tree.changes_from(self.parent_tree)
359
self.model.append(None, [ "Complete Diff", "" ])
362
titer = self.model.append(None, [ "Added", None ])
363
for path, id, kind in delta.added:
364
self.model.append(titer, [ path, path ])
366
if len(delta.removed):
367
titer = self.model.append(None, [ "Removed", None ])
368
for path, id, kind in delta.removed:
369
self.model.append(titer, [ path, path ])
371
if len(delta.renamed):
372
titer = self.model.append(None, [ "Renamed", None ])
373
for oldpath, newpath, id, kind, text_modified, meta_modified \
375
self.model.append(titer, [ oldpath, newpath ])
377
if len(delta.modified):
378
titer = self.model.append(None, [ "Modified", None ])
379
for path, id, kind, text_modified, meta_modified in delta.modified:
380
self.model.append(titer, [ path, path ])
382
self.treeview.expand_all()
384
def set_file(self, file_path):
385
"""Select the current file to display"""
387
for data in self.model:
388
for child in data.iterchildren():
389
if child[0] == file_path or child[1] == file_path:
393
raise NoSuchFile(file_path)
394
self.treeview.set_cursor(tv_path)
395
self.treeview.scroll_to_cell(tv_path)
397
def _treeview_cursor_cb(self, *args):
398
"""Callback for when the treeview cursor changes."""
399
(path, col) = self.treeview.get_cursor()
400
specific_files = [ self.model[path][1] ]
401
if specific_files == [ None ]:
403
elif specific_files == [ "" ]:
404
specific_files = None
406
self.diff_view.show_diff(specific_files)
409
class DiffWindow(Window):
412
This object represents and manages a single window containing the
413
differences between two revisions on a branch.
416
def __init__(self, parent=None):
417
Window.__init__(self, parent)
418
self.set_border_width(0)
419
self.set_title("bzrk diff")
421
# Use two thirds of the screen by default
422
screen = self.get_screen()
423
monitor = screen.get_monitor_geometry(0)
424
width = int(monitor.width * 0.66)
425
height = int(monitor.height * 0.66)
426
self.set_default_size(width, height)
431
"""Construct the window contents."""
432
self.vbox = gtk.VBox()
435
hbox = self._get_button_bar()
437
self.vbox.pack_start(hbox, expand=False, fill=True)
438
self.diff = DiffWidget()
439
self.vbox.add(self.diff)
442
def _get_button_bar(self):
443
"""Return a button bar to use.
445
:return: None, meaning that no button bar will be used.
449
def set_diff_text(self, description, lines):
450
"""Set the diff from a text.
452
The diff must be in unified diff format, and will be parsed to
455
self.diff.set_diff_text(lines)
456
self.set_title(description + " - bzrk diff")
458
def set_diff(self, description, rev_tree, parent_tree):
459
"""Set the differences showed by this window.
461
Compares the two trees and populates the window with the
464
self.diff.set_diff(rev_tree, parent_tree)
465
self.set_title(description + " - bzrk diff")
467
def set_file(self, file_path):
468
self.diff.set_file(file_path)
471
class MergeDirectiveWindow(DiffWindow):
473
def __init__(self, directive, path):
474
DiffWindow.__init__(self, None)
475
self._merge_target = None
476
self.directive = directive
479
def _get_button_bar(self):
480
"""The button bar has only the Merge button"""
481
merge_button = gtk.Button('Merge')
483
merge_button.set_relief(gtk.RELIEF_NONE)
484
merge_button.connect("clicked", self.perform_merge)
486
save_button = gtk.Button('Save')
488
save_button.set_relief(gtk.RELIEF_NONE)
489
save_button.connect("clicked", self.perform_save)
491
hbox = gtk.HButtonBox()
492
hbox.set_layout(gtk.BUTTONBOX_START)
493
hbox.pack_start(merge_button, expand=False, fill=True)
494
hbox.pack_start(save_button, expand=False, fill=True)
498
def perform_merge(self, window):
500
tree = self._get_merge_target()
501
except SelectCancelled:
506
merger, verified = _mod_merge.Merger.from_mergeable(tree,
507
self.directive, progress.DummyProgress())
508
merger.check_basis(True)
509
merger.merge_type = _mod_merge.Merge3Merger
510
conflict_count = merger.do_merge()
512
if conflict_count == 0:
513
# No conflicts found.
514
info_dialog(_i18n('Merge successful'),
515
_i18n('All changes applied successfully.'))
517
# There are conflicts to be resolved.
518
warning_dialog(_i18n('Conflicts encountered'),
519
_i18n('Please resolve the conflicts manually'
520
' before committing.'))
523
error_dialog('Error', str(e))
527
def _get_merge_target(self):
528
if self._merge_target is not None:
529
return self._merge_target
530
d = gtk.FileChooserDialog('Merge branch', self,
531
gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER,
532
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
534
gtk.RESPONSE_CANCEL,))
537
if result != gtk.RESPONSE_OK:
538
raise SelectCancelled()
539
uri = d.get_current_folder_uri()
542
return workingtree.WorkingTree.open(uri)
544
def perform_save(self, window):
545
d = gtk.FileChooserDialog('Save As', self,
546
gtk.FILE_CHOOSER_ACTION_SAVE,
547
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
549
gtk.RESPONSE_CANCEL,))
550
d.set_current_name(osutils.basename(self.path))
554
if result != gtk.RESPONSE_OK:
555
raise SelectCancelled()
559
except SelectCancelled:
561
source = open(self.path, 'rb')
563
target = open(urlutils.local_path_from_url(uri), 'wb')
565
target.write(source.read())
572
def iter_changes_to_status(source, target):
573
"""Determine the differences between trees.
575
This is a wrapper around iter_changes which just yields more
576
understandable results.
578
:param source: The source tree (basis tree)
579
:param target: The target tree
580
:return: A list of (file_id, real_path, change_type, display_path)
585
renamed_and_modified = 'renamed and modified'
586
modified = 'modified'
587
kind_changed = 'kind changed'
589
# TODO: Handle metadata changes
596
for (file_id, paths, changed_content, versioned, parent_ids, names,
597
kinds, executables) in target.iter_changes(source):
599
# Skip the root entry if it isn't very interesting
600
if parent_ids == (None, None):
607
source_marker = osutils.kind_marker(kinds[0])
609
assert kinds[0] is not None
610
marker = osutils.kind_marker(kinds[0])
612
marker = osutils.kind_marker(kinds[1])
615
if real_path is None:
617
assert real_path is not None
618
display_path = real_path + marker
620
present_source = versioned[0] and kinds[0] is not None
621
present_target = versioned[1] and kinds[1] is not None
623
if present_source != present_target:
627
assert present_source
628
change_type = removed
629
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
631
if changed_content or executables[0] != executables[1]:
633
change_type = renamed_and_modified
635
change_type = renamed
636
display_path = (paths[0] + source_marker
637
+ ' => ' + paths[1] + marker)
638
elif kinds[0] != kinds[1]:
639
change_type = kind_changed
640
display_path = (paths[0] + source_marker
641
+ ' => ' + paths[1] + marker)
642
elif changed_content is True or executables[0] != executables[1]:
643
change_type = modified
645
assert False, "How did we get here?"
647
status.append((file_id, real_path, change_type, display_path))
added
removed
diff.py
