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 osutils
34
from bzrlib.diff import show_diff_trees, internal_diff
35
from bzrlib.errors import NoSuchFile
36
from bzrlib.trace import warning
37
from bzrlib.plugins.gtk.window import Window
40
class DiffView(gtk.ScrolledWindow):
41
"""This is the soft and chewy filling for a DiffWindow."""
44
gtk.ScrolledWindow.__init__(self)
48
self.parent_tree = None
51
self.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
52
self.set_shadow_type(gtk.SHADOW_IN)
54
if have_gtksourceview:
55
self.buffer = gtksourceview.SourceBuffer()
56
slm = gtksourceview.SourceLanguagesManager()
57
gsl = slm.get_language_from_mime_type("text/x-patch")
59
self.apply_gedit_colors(gsl)
60
self.apply_colordiff_colors(gsl)
61
self.buffer.set_language(gsl)
62
self.buffer.set_highlight(True)
64
sourceview = gtksourceview.SourceView(self.buffer)
66
self.buffer = gtk.TextBuffer()
67
sourceview = gtk.TextView(self.buffer)
69
sourceview.set_editable(False)
70
sourceview.modify_font(pango.FontDescription("Monospace"))
75
def apply_gedit_colors(lang):
76
"""Set style for lang to that specified in gedit configuration.
78
This method needs the gconf module.
80
:param lang: a gtksourceview.SourceLanguage object.
82
GEDIT_SYNTAX_PATH = '/apps/gedit-2/preferences/syntax_highlighting'
83
GEDIT_LANG_PATH = GEDIT_SYNTAX_PATH + '/' + lang.get_id()
85
client = gconf.client_get_default()
86
client.add_dir(GEDIT_LANG_PATH, gconf.CLIENT_PRELOAD_NONE)
88
for tag in lang.get_tags():
90
gconf_key = GEDIT_LANG_PATH + '/' + tag_id
91
style_string = client.get_string(gconf_key)
93
if style_string is None:
96
# function to get a bool from a string that's either '0' or '1'
97
string_bool = lambda x: bool(int(x))
99
# style_string is a string like "2/#FFCCAA/#000000/0/1/0/0"
100
# values are: mask, fg, bg, italic, bold, underline, strike
101
# this packs them into (str_value, attr_name, conv_func) tuples
102
items = zip(style_string.split('/'), ['mask', 'foreground',
103
'background', 'italic', 'bold', 'underline', 'strikethrough' ],
104
[ int, gtk.gdk.color_parse, gtk.gdk.color_parse, string_bool,
105
string_bool, string_bool, string_bool ]
108
style = gtksourceview.SourceTagStyle()
110
# XXX The mask attribute controls whether the present values of
111
# foreground and background color should in fact be used. Ideally
112
# (and that's what gedit does), one could set all three attributes,
113
# and let the TagStyle object figure out which colors to use.
114
# However, in the GtkSourceview python bindings, the mask attribute
115
# is read-only, and it's derived instead from the colors being
116
# set or not. This means that we have to sometimes refrain from
117
# setting fg or bg colors, depending on the value of the mask.
118
# This code could go away if mask were writable.
119
mask = int(items[0][0])
120
if not (mask & 1): # GTK_SOURCE_TAG_STYLE_USE_BACKGROUND
122
if not (mask & 2): # GTK_SOURCE_TAG_STYLE_USE_FOREGROUND
124
items[0:1] = [] # skip the mask unconditionally
126
for value, attr, func in items:
130
warning('gconf key %s contains an invalid value: %s'
133
setattr(style, attr, value)
135
lang.set_tag_style(tag_id, style)
138
def apply_colordiff_colors(lang):
139
"""Set style colors for lang using the colordiff configuration file.
141
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
143
:param lang: a "Diff" gtksourceview.SourceLanguage object.
147
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
148
f = os.path.expanduser(f)
149
if os.path.exists(f):
153
warning('could not open file %s: %s' % (f, str(e)))
155
colors.update(DiffView.parse_colordiffrc(f))
159
# ~/.colordiffrc does not exist
163
# map GtkSourceView tags to colordiff names
164
# since GSV is richer, accept new names for extra bits,
165
# defaulting to old names if they're not present
166
'Added@32@line': ['newtext'],
167
'Removed@32@line': ['oldtext'],
168
'Location': ['location', 'diffstuff'],
169
'Diff@32@file': ['file', 'diffstuff'],
170
'Special@32@case': ['specialcase', 'diffstuff'],
173
for tag in lang.get_tags():
174
tag_id = tag.get_id()
175
keys = mapping.get(tag_id, [])
179
color = colors.get(key, None)
180
if color is not None:
186
style = gtksourceview.SourceTagStyle()
188
style.foreground = gtk.gdk.color_parse(color)
190
warning('not a valid color: %s' % color)
192
lang.set_tag_style(tag_id, style)
195
def parse_colordiffrc(fileobj):
196
"""Parse fileobj as a colordiff configuration file.
198
:return: A dict with the key -> value pairs.
202
if re.match(r'^\s*#', line):
206
key, val = line.split('=', 1)
207
colors[key.strip()] = val.strip()
210
def set_trees(self, rev_tree, parent_tree):
211
self.rev_tree = rev_tree
212
self.parent_tree = parent_tree
213
# self._build_delta()
215
# def _build_delta(self):
216
# self.parent_tree.lock_read()
217
# self.rev_tree.lock_read()
219
# self.delta = _iter_changes_to_status(self.parent_tree, self.rev_tree)
220
# self.path_to_status = {}
221
# self.path_to_diff = {}
222
# source_inv = self.parent_tree.inventory
223
# target_inv = self.rev_tree.inventory
224
# for (file_id, real_path, change_type, display_path) in self.delta:
225
# self.path_to_status[real_path] = u'=== %s %s' % (change_type, display_path)
226
# if change_type in ('modified', 'renamed and modified'):
227
# source_ie = source_inv[file_id]
228
# target_ie = target_inv[file_id]
230
# source_ie.diff(internal_diff, *old path, *old_tree,
231
# *new_path, target_ie, self.rev_tree,
233
# self.path_to_diff[real_path] =
236
# self.rev_tree.unlock()
237
# self.parent_tree.unlock()
239
def show_diff(self, specific_files):
241
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files,
242
old_label='', new_label='',
243
# path_encoding=sys.getdefaultencoding()
244
# The default is utf-8, but we interpret the file
245
# contents as getdefaultencoding(), so we should
246
# probably try to make the paths in the same encoding.
248
# str.decode(encoding, 'replace') doesn't do anything. Because if a
249
# character is not valid in 'encoding' there is nothing to replace, the
250
# 'replace' is for 'str.encode()'
252
decoded = s.getvalue().decode(sys.getdefaultencoding())
253
except UnicodeDecodeError:
255
decoded = s.getvalue().decode('UTF-8')
256
except UnicodeDecodeError:
257
decoded = s.getvalue().decode('iso-8859-1')
258
# This always works, because every byte has a valid
259
# mapping from iso-8859-1 to Unicode
260
# TextBuffer must contain pure UTF-8 data
261
self.buffer.set_text(decoded.encode('UTF-8'))
264
class DiffWidget(gtk.HPaned):
269
super(DiffWidget, self).__init__()
271
# The file hierarchy: a scrollable treeview
272
scrollwin = gtk.ScrolledWindow()
273
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
274
scrollwin.set_shadow_type(gtk.SHADOW_IN)
275
self.pack1(scrollwin)
278
self.model = gtk.TreeStore(str, str)
279
self.treeview = gtk.TreeView(self.model)
280
self.treeview.set_headers_visible(False)
281
self.treeview.set_search_column(1)
282
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
283
scrollwin.add(self.treeview)
286
cell = gtk.CellRendererText()
287
cell.set_property("width-chars", 20)
288
column = gtk.TreeViewColumn()
289
column.pack_start(cell, expand=True)
290
column.add_attribute(cell, "text", 0)
291
self.treeview.append_column(column)
293
# The diffs of the selected file: a scrollable source or
295
self.diff_view = DiffView()
296
self.pack2(self.diff_view)
297
self.diff_view.show()
299
def set_diff(self, rev_tree, parent_tree):
300
"""Set the differences showed by this window.
302
Compares the two trees and populates the window with the
305
self.diff_view.set_trees(rev_tree, parent_tree)
306
self.rev_tree = rev_tree
307
self.parent_tree = parent_tree
310
delta = self.rev_tree.changes_from(self.parent_tree)
312
self.model.append(None, [ "Complete Diff", "" ])
315
titer = self.model.append(None, [ "Added", None ])
316
for path, id, kind in delta.added:
317
self.model.append(titer, [ path, path ])
319
if len(delta.removed):
320
titer = self.model.append(None, [ "Removed", None ])
321
for path, id, kind in delta.removed:
322
self.model.append(titer, [ path, path ])
324
if len(delta.renamed):
325
titer = self.model.append(None, [ "Renamed", None ])
326
for oldpath, newpath, id, kind, text_modified, meta_modified \
328
self.model.append(titer, [ oldpath, newpath ])
330
if len(delta.modified):
331
titer = self.model.append(None, [ "Modified", None ])
332
for path, id, kind, text_modified, meta_modified in delta.modified:
333
self.model.append(titer, [ path, path ])
335
self.treeview.expand_all()
337
def set_file(self, file_path):
339
for data in self.model:
340
for child in data.iterchildren():
341
if child[0] == file_path or child[1] == file_path:
345
raise NoSuchFile(file_path)
346
self.treeview.set_cursor(tv_path)
347
self.treeview.scroll_to_cell(tv_path)
349
def _treeview_cursor_cb(self, *args):
350
"""Callback for when the treeview cursor changes."""
351
(path, col) = self.treeview.get_cursor()
352
specific_files = [ self.model[path][1] ]
353
if specific_files == [ None ]:
355
elif specific_files == [ "" ]:
356
specific_files = None
358
self.diff_view.show_diff(specific_files)
361
class DiffWindow(Window):
364
This object represents and manages a single window containing the
365
differences between two revisions on a branch.
368
def __init__(self, parent=None):
369
Window.__init__(self, parent)
370
self.set_border_width(0)
371
self.set_title("bzrk diff")
373
# Use two thirds of the screen by default
374
screen = self.get_screen()
375
monitor = screen.get_monitor_geometry(0)
376
width = int(monitor.width * 0.66)
377
height = int(monitor.height * 0.66)
378
self.set_default_size(width, height)
383
"""Construct the window contents."""
384
self.diff = DiffWidget()
388
def set_diff(self, description, rev_tree, parent_tree):
389
"""Set the differences showed by this window.
391
Compares the two trees and populates the window with the
394
self.diff.set_diff(rev_tree, parent_tree)
395
self.set_title(description + " - bzrk diff")
397
def set_file(self, file_path):
398
self.diff.set_file(file_path)
401
def _iter_changes_to_status(source, target):
402
"""Determine the differences between trees.
404
This is a wrapper around _iter_changes which just yields more
405
understandable results.
407
:param source: The source tree (basis tree)
408
:param target: The target tree
409
:return: A list of (file_id, real_path, change_type, display_path)
414
renamed_and_modified = 'renamed and modified'
415
modified = 'modified'
416
kind_changed = 'kind changed'
418
# TODO: Handle metadata changes
425
for (file_id, paths, changed_content, versioned, parent_ids, names,
426
kinds, executables) in target._iter_changes(source):
428
# Skip the root entry if it isn't very interesting
429
if parent_ids == (None, None):
436
source_marker = osutils.kind_marker(kinds[0])
438
assert kinds[0] is not None
439
marker = osutils.kind_marker(kinds[0])
441
marker = osutils.kind_marker(kinds[1])
444
if real_path is None:
446
assert real_path is not None
447
display_path = real_path + marker
449
present_source = versioned[0] and kinds[0] is not None
450
present_target = versioned[1] and kinds[1] is not None
452
if present_source != present_target:
456
assert present_source
457
change_type = removed
458
elif names[0] != names[1] or parent_ids[0] != parent_ids[1]:
460
if changed_content or executables[0] != executables[1]:
462
change_type = renamed_and_modified
464
change_type = renamed
465
display_path = (paths[0] + source_marker
466
+ ' => ' + paths[1] + marker)
467
elif kinds[0] != kinds[1]:
468
change_type = kind_changed
469
display_path = (paths[0] + source_marker
470
+ ' => ' + paths[1] + marker)
471
elif changed_content is True or executables[0] != executables[1]:
472
change_type = modified
474
assert False, "How did we get here?"
476
status.append((file_id, real_path, change_type, display_path))
added
removed
diff.py
