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):
48
"""Window for displaying diffs from a diff file"""
51
gtk.ScrolledWindow.__init__(self)
56
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
57
self.set_shadow_type(gtk.SHADOW_IN)
59
if have_gtksourceview:
60
self.buffer = gtksourceview.SourceBuffer()
61
slm = gtksourceview.SourceLanguagesManager()
62
gsl = slm.get_language_from_mime_type("text/x-patch")
64
self.apply_gedit_colors(gsl)
65
self.apply_colordiff_colors(gsl)
66
self.buffer.set_language(gsl)
67
self.buffer.set_highlight(True)
69
sourceview = gtksourceview.SourceView(self.buffer)
71
self.buffer = gtk.TextBuffer()
72
sourceview = gtk.TextView(self.buffer)
74
sourceview.set_editable(False)
75
sourceview.modify_font(pango.FontDescription("Monospace"))
80
def apply_gedit_colors(lang):
81
"""Set style for lang to that specified in gedit configuration.
83
This method needs the gconf module.
85
:param lang: a gtksourceview.SourceLanguage object.
87
GEDIT_SYNTAX_PATH = '/apps/gedit-2/preferences/syntax_highlighting'
88
GEDIT_LANG_PATH = GEDIT_SYNTAX_PATH + '/' + lang.get_id()
90
client = gconf.client_get_default()
91
client.add_dir(GEDIT_LANG_PATH, gconf.CLIENT_PRELOAD_NONE)
93
for tag in lang.get_tags():
95
gconf_key = GEDIT_LANG_PATH + '/' + tag_id
96
style_string = client.get_string(gconf_key)
98
if style_string is None:
101
# function to get a bool from a string that's either '0' or '1'
102
string_bool = lambda x: bool(int(x))
104
# style_string is a string like "2/#FFCCAA/#000000/0/1/0/0"
105
# values are: mask, fg, bg, italic, bold, underline, strike
106
# this packs them into (str_value, attr_name, conv_func) tuples
107
items = zip(style_string.split('/'), ['mask', 'foreground',
108
'background', 'italic', 'bold', 'underline', 'strikethrough' ],
109
[ int, gtk.gdk.color_parse, gtk.gdk.color_parse, string_bool,
110
string_bool, string_bool, string_bool ]
113
style = gtksourceview.SourceTagStyle()
115
# XXX The mask attribute controls whether the present values of
116
# foreground and background color should in fact be used. Ideally
117
# (and that's what gedit does), one could set all three attributes,
118
# and let the TagStyle object figure out which colors to use.
119
# However, in the GtkSourceview python bindings, the mask attribute
120
# is read-only, and it's derived instead from the colors being
121
# set or not. This means that we have to sometimes refrain from
122
# setting fg or bg colors, depending on the value of the mask.
123
# This code could go away if mask were writable.
124
mask = int(items[0][0])
125
if not (mask & 1): # GTK_SOURCE_TAG_STYLE_USE_BACKGROUND
127
if not (mask & 2): # GTK_SOURCE_TAG_STYLE_USE_FOREGROUND
129
items[0:1] = [] # skip the mask unconditionally
131
for value, attr, func in items:
135
warning('gconf key %s contains an invalid value: %s'
138
setattr(style, attr, value)
140
lang.set_tag_style(tag_id, style)
143
def apply_colordiff_colors(klass, lang):
144
"""Set style colors for lang using the colordiff configuration file.
146
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
148
:param lang: a "Diff" gtksourceview.SourceLanguage object.
152
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
153
f = os.path.expanduser(f)
154
if os.path.exists(f):
158
warning('could not open file %s: %s' % (f, str(e)))
160
colors.update(klass.parse_colordiffrc(f))
164
# ~/.colordiffrc does not exist
168
# map GtkSourceView tags to colordiff names
169
# since GSV is richer, accept new names for extra bits,
170
# defaulting to old names if they're not present
171
'Added@32@line': ['newtext'],
172
'Removed@32@line': ['oldtext'],
173
'Location': ['location', 'diffstuff'],
174
'Diff@32@file': ['file', 'diffstuff'],
175
'Special@32@case': ['specialcase', 'diffstuff'],
178
for tag in lang.get_tags():
179
tag_id = tag.get_id()
180
keys = mapping.get(tag_id, [])
184
color = colors.get(key, None)
185
if color is not None:
191
style = gtksourceview.SourceTagStyle()
193
style.foreground = gtk.gdk.color_parse(color)
195
warning('not a valid color: %s' % color)
197
lang.set_tag_style(tag_id, style)
200
def parse_colordiffrc(fileobj):
201
"""Parse fileobj as a colordiff configuration file.
203
:return: A dict with the key -> value pairs.
207
if re.match(r'^\s*#', line):
211
key, val = line.split('=', 1)
212
colors[key.strip()] = val.strip()
215
def set_trees(self, rev_tree, parent_tree):
216
self.rev_tree = rev_tree
217
self.parent_tree = parent_tree
218
# self._build_delta()
220
# def _build_delta(self):
221
# self.parent_tree.lock_read()
222
# self.rev_tree.lock_read()
224
# self.delta = _iter_changes_to_status(self.parent_tree, self.rev_tree)
225
# self.path_to_status = {}
226
# self.path_to_diff = {}
227
# source_inv = self.parent_tree.inventory
228
# target_inv = self.rev_tree.inventory
229
# for (file_id, real_path, change_type, display_path) in self.delta:
230
# self.path_to_status[real_path] = u'=== %s %s' % (change_type, display_path)
231
# if change_type in ('modified', 'renamed and modified'):
232
# source_ie = source_inv[file_id]
233
# target_ie = target_inv[file_id]
235
# source_ie.diff(internal_diff, *old path, *old_tree,
236
# *new_path, target_ie, self.rev_tree,
238
# self.path_to_diff[real_path] =
241
# self.rev_tree.unlock()
242
# self.parent_tree.unlock()
244
def show_diff(self, specific_files):
246
if specific_files is None:
247
self.buffer.set_text(self._diffs[None])
249
for specific_file in specific_files:
250
sections.append(self._diffs[specific_file])
251
self.buffer.set_text(''.join(sections))
254
class DiffView(DiffFileView):
255
"""This is the soft and chewy filling for a DiffWindow."""
258
DiffFileView.__init__(self)
260
self.parent_tree = None
262
def show_diff(self, specific_files):
263
"""Show the diff for the specified files"""
265
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
266
old_label='', new_label='',
267
# path_encoding=sys.getdefaultencoding()
268
# The default is utf-8, but we interpret the file
269
# contents as getdefaultencoding(), so we should
270
# probably try to make the paths in the same encoding.
272
# str.decode(encoding, 'replace') doesn't do anything. Because if a
273
# character is not valid in 'encoding' there is nothing to replace, the
274
# 'replace' is for 'str.encode()'
276
decoded = s.getvalue().decode(sys.getdefaultencoding())
277
except UnicodeDecodeError:
279
decoded = s.getvalue().decode('UTF-8')
280
except UnicodeDecodeError:
281
decoded = s.getvalue().decode('iso-8859-1')
282
# This always works, because every byte has a valid
283
# mapping from iso-8859-1 to Unicode
284
# TextBuffer must contain pure UTF-8 data
285
self.buffer.set_text(decoded.encode('UTF-8'))
288
class DiffWidget(gtk.HPaned):
293
super(DiffWidget, self).__init__()
295
# The file hierarchy: a scrollable treeview
296
scrollwin = gtk.ScrolledWindow()
297
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
298
scrollwin.set_shadow_type(gtk.SHADOW_IN)
299
self.pack1(scrollwin)
302
self.model = gtk.TreeStore(str, str)
303
self.treeview = gtk.TreeView(self.model)
304
self.treeview.set_headers_visible(False)
305
self.treeview.set_search_column(1)
306
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
307
scrollwin.add(self.treeview)
310
cell = gtk.CellRendererText()
311
cell.set_property("width-chars", 20)
312
column = gtk.TreeViewColumn()
313
column.pack_start(cell, expand=True)
314
column.add_attribute(cell, "text", 0)
315
self.treeview.append_column(column)
317
def set_diff_text(self, lines):
318
"""Set the current diff from a list of lines
320
:param lines: The diff to show, in unified diff format
322
# The diffs of the selected file: a scrollable source or
324
self.diff_view = DiffFileView()
325
self.diff_view.show()
326
self.pack2(self.diff_view)
327
self.model.append(None, [ "Complete Diff", "" ])
328
self.diff_view._diffs[None] = ''.join(lines)
329
for patch in parse_patches(lines):
330
oldname = patch.oldname.split('\t')[0]
331
newname = patch.newname.split('\t')[0]
332
self.model.append(None, [oldname, newname])
333
self.diff_view._diffs[newname] = str(patch)
334
self.diff_view.show_diff(None)
336
def set_diff(self, rev_tree, parent_tree):
337
"""Set the differences showed by this window.
339
Compares the two trees and populates the window with the
342
self.diff_view = DiffView()
343
self.pack2(self.diff_view)
344
self.diff_view.show()
345
self.diff_view.set_trees(rev_tree, parent_tree)
346
self.rev_tree = rev_tree
347
self.parent_tree = parent_tree
350
delta = self.rev_tree.changes_from(self.parent_tree)
352
self.model.append(None, [ "Complete Diff", "" ])
355
titer = self.model.append(None, [ "Added", None ])
356
for path, id, kind in delta.added:
357
self.model.append(titer, [ path, path ])
359
if len(delta.removed):
360
titer = self.model.append(None, [ "Removed", None ])
361
for path, id, kind in delta.removed:
362
self.model.append(titer, [ path, path ])
364
if len(delta.renamed):
365
titer = self.model.append(None, [ "Renamed", None ])
366
for oldpath, newpath, id, kind, text_modified, meta_modified \
368
self.model.append(titer, [ oldpath, newpath ])
370
if len(delta.modified):
371
titer = self.model.append(None, [ "Modified", None ])
372
for path, id, kind, text_modified, meta_modified in delta.modified:
373
self.model.append(titer, [ path, path ])
375
self.treeview.expand_all()
377
def set_file(self, file_path):
378
"""Select the current file to display"""
380
for data in self.model:
381
for child in data.iterchildren():
382
if child[0] == file_path or child[1] == file_path:
386
raise NoSuchFile(file_path)
387
self.treeview.set_cursor(tv_path)
388
self.treeview.scroll_to_cell(tv_path)
390
def _treeview_cursor_cb(self, *args):
391
"""Callback for when the treeview cursor changes."""
392
(path, col) = self.treeview.get_cursor()
393
specific_files = [ self.model[path][1] ]
394
if specific_files == [ None ]:
396
elif specific_files == [ "" ]:
397
specific_files = None
399
self.diff_view.show_diff(specific_files)
402
class DiffWindow(Window):
405
This object represents and manages a single window containing the
406
differences between two revisions on a branch.
409
def __init__(self, parent=None):
410
Window.__init__(self, parent)
411
self.set_border_width(0)
412
self.set_title("bzrk diff")
414
# Use two thirds of the screen by default
415
screen = self.get_screen()
416
monitor = screen.get_monitor_geometry(0)
417
width = int(monitor.width * 0.66)
418
height = int(monitor.height * 0.66)
419
self.set_default_size(width, height)
424
"""Construct the window contents."""
425
self.vbox = gtk.VBox()
428
hbox = self._get_button_bar()
430
self.vbox.pack_start(hbox, expand=False, fill=True)
431
self.diff = DiffWidget()
432
self.vbox.add(self.diff)
435
def _get_button_bar(self):
436
"""Return a button bar to use.
438
:return: None, meaning that no button bar will be used.
442
def set_diff_text(self, description, lines):
443
"""Set the diff from a text.
445
The diff must be in unified diff format, and will be parsed to
448
self.diff.set_diff_text(lines)
449
self.set_title(description + " - bzrk diff")
451
def set_diff(self, description, rev_tree, parent_tree):
452
"""Set the differences showed by this window.
454
Compares the two trees and populates the window with the
457
self.diff.set_diff(rev_tree, parent_tree)
458
self.set_title(description + " - bzrk diff")
460
def set_file(self, file_path):
461
self.diff.set_file(file_path)
464
class MergeDirectiveWindow(DiffWindow):
466
def __init__(self, directive, parent=None):
467
DiffWindow.__init__(self, parent)
468
self._merge_target = None
469
self.directive = directive
471
def _get_button_bar(self):
472
"""The button bar has only the Merge button"""
473
merge_button = gtk.Button('Merge')
475
merge_button.set_relief(gtk.RELIEF_NONE)
476
merge_button.connect("clicked", self.perform_merge)
478
hbox = gtk.HButtonBox()
479
hbox.set_layout(gtk.BUTTONBOX_START)
480
hbox.pack_start(merge_button, expand=False, fill=True)
484
def perform_merge(self, window):
486
tree = self._get_merge_target()
487
except SelectCancelled:
492
merger, verified = _mod_merge.Merger.from_mergeable(tree,
493
self.directive, progress.DummyProgress())
494
merger.check_basis(True)
495
merger.merge_type = _mod_merge.Merge3Merger
496
conflict_count = merger.do_merge()
498
if conflict_count == 0:
499
# No conflicts found.
500
info_dialog(_('Merge successful'),
501
_('All changes applied successfully.'))
503
# There are conflicts to be resolved.
504
warning_dialog(_('Conflicts encountered'),
505
_('Please resolve the conflicts manually'
506
' before committing.'))
509
error_dialog('Error', str(e))
513
def _get_merge_target(self):
514
if self._merge_target is not None:
515
return self._merge_target
516
d = gtk.FileChooserDialog('Merge branch', self,
517
gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER,
518
buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
520
gtk.RESPONSE_CANCEL,))
523
if result != gtk.RESPONSE_OK:
524
raise SelectCancelled()
525
uri = d.get_current_folder_uri()
528
return workingtree.WorkingTree.open(uri)
531
def _iter_changes_to_status(source, target):
532
"""Determine the differences between trees.
534
This is a wrapper around _iter_changes which just yields more
535
understandable results.
537
:param source: The source tree (basis tree)
538
:param target: The target tree
539
:return: A list of (file_id, real_path, change_type, display_path)
544
renamed_and_modified = 'renamed and modified'
545
modified = 'modified'
546
kind_changed = 'kind changed'
548
# TODO: Handle metadata changes
555
for (file_id, paths, changed_content, versioned, parent_ids, names,
556
kinds, executables) in target._iter_changes(source):
558
# Skip the root entry if it isn't very interesting
559
if parent_ids == (None, None):
566
source_marker = osutils.kind_marker(kinds[0])
568
assert kinds[0] is not None
569
marker = osutils.kind_marker(kinds[0])
571
marker = osutils.kind_marker(kinds[1])
574
if real_path is None:
576
assert real_path is not None
577
display_path = real_path + marker
579
present_source = versioned[0] and kinds[0] is not None
580
present_target = versioned[1] and kinds[1] is not None
582
if present_source != present_target:
586
assert present_source
587
change_type = removed
588
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
590
if changed_content or executables[0] != executables[1]:
592
change_type = renamed_and_modified
594
change_type = renamed
595
display_path = (paths[0] + source_marker
596
+ ' => ' + paths[1] + marker)
597
elif kinds[0] != kinds[1]:
598
change_type = kind_changed
599
display_path = (paths[0] + source_marker
600
+ ' => ' + paths[1] + marker)
601
elif changed_content is True or executables[0] != executables[1]:
602
change_type = modified
604
assert False, "How did we get here?"
606
status.append((file_id, real_path, change_type, display_path))