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
22
have_gtksourceview = True
24
have_gtksourceview = False
33
from bzrlib.diff import show_diff_trees
34
from bzrlib.errors import NoSuchFile
35
from bzrlib.trace import warning
38
class DiffWindow(gtk.Window):
41
This object represents and manages a single window containing the
42
differences between two revisions on a branch.
46
gtk.Window.__init__(self, gtk.WINDOW_TOPLEVEL)
47
self.set_border_width(0)
48
self.set_title("bzrk diff")
50
# Use two thirds of the screen by default
51
screen = self.get_screen()
52
monitor = screen.get_monitor_geometry(0)
53
width = int(monitor.width * 0.66)
54
height = int(monitor.height * 0.66)
55
self.set_default_size(width, height)
60
"""Construct the window contents."""
61
# The window consists of a pane containing: the
62
# hierarchical list of files on the left, and the diff
63
# for the currently selected file on the right.
68
# The file hierarchy: a scrollable treeview
69
scrollwin = gtk.ScrolledWindow()
70
scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
71
scrollwin.set_shadow_type(gtk.SHADOW_IN)
75
self.model = gtk.TreeStore(str, str)
76
self.treeview = gtk.TreeView(self.model)
77
self.treeview.set_headers_visible(False)
78
self.treeview.set_search_column(1)
79
self.treeview.connect("cursor-changed", self._treeview_cursor_cb)
80
scrollwin.add(self.treeview)
83
cell = gtk.CellRendererText()
84
cell.set_property("width-chars", 20)
85
column = gtk.TreeViewColumn()
86
column.pack_start(cell, expand=True)
87
column.add_attribute(cell, "text", 0)
88
self.treeview.append_column(column)
90
# The diffs of the selected file: a scrollable source or
92
scrollwin = gtk.ScrolledWindow()
93
scrollwin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
94
scrollwin.set_shadow_type(gtk.SHADOW_IN)
98
if have_gtksourceview:
99
self.buffer = gtksourceview.SourceBuffer()
100
slm = gtksourceview.SourceLanguagesManager()
101
gsl = slm.get_language_from_mime_type("text/x-patch")
103
self.apply_gedit_colors(gsl)
104
self.apply_colordiff_colors(gsl)
105
self.buffer.set_language(gsl)
106
self.buffer.set_highlight(True)
108
sourceview = gtksourceview.SourceView(self.buffer)
110
self.buffer = gtk.TextBuffer()
111
sourceview = gtk.TextView(self.buffer)
113
sourceview.set_editable(False)
114
sourceview.modify_font(pango.FontDescription("Monospace"))
115
scrollwin.add(sourceview)
118
def set_diff(self, description, rev_tree, parent_tree):
119
"""Set the differences showed by this window.
121
Compares the two trees and populates the window with the
124
self.rev_tree = rev_tree
125
self.parent_tree = parent_tree
128
delta = self.rev_tree.changes_from(self.parent_tree)
130
self.model.append(None, [ "Complete Diff", "" ])
133
titer = self.model.append(None, [ "Added", None ])
134
for path, id, kind in delta.added:
135
self.model.append(titer, [ path, path ])
137
if len(delta.removed):
138
titer = self.model.append(None, [ "Removed", None ])
139
for path, id, kind in delta.removed:
140
self.model.append(titer, [ path, path ])
142
if len(delta.renamed):
143
titer = self.model.append(None, [ "Renamed", None ])
144
for oldpath, newpath, id, kind, text_modified, meta_modified \
146
self.model.append(titer, [ oldpath, newpath ])
148
if len(delta.modified):
149
titer = self.model.append(None, [ "Modified", None ])
150
for path, id, kind, text_modified, meta_modified in delta.modified:
151
self.model.append(titer, [ path, path ])
153
self.treeview.expand_all()
154
self.set_title(description + " - bzrk diff")
156
def set_file(self, file_path):
158
for data in self.model:
159
for child in data.iterchildren():
160
if child[0] == file_path or child[1] == file_path:
164
raise NoSuchFile(file_path)
165
self.treeview.set_cursor(tv_path)
166
self.treeview.scroll_to_cell(tv_path)
168
def _treeview_cursor_cb(self, *args):
169
"""Callback for when the treeview cursor changes."""
170
(path, col) = self.treeview.get_cursor()
171
specific_files = [ self.model[path][1] ]
172
if specific_files == [ None ]:
174
elif specific_files == [ "" ]:
178
show_diff_trees(self.parent_tree, self.rev_tree, s, specific_files)
179
self.buffer.set_text(s.getvalue().decode(sys.getdefaultencoding(), 'replace'))
182
def apply_gedit_colors(lang):
183
"""Set style for lang to that specified in gedit configuration.
185
This method needs the gconf module.
187
:param lang: a gtksourceview.SourceLanguage object.
189
GEDIT_SYNTAX_PATH = '/apps/gedit-2/preferences/syntax_highlighting'
190
GEDIT_LANG_PATH = GEDIT_SYNTAX_PATH + '/' + lang.get_id()
192
client = gconf.client_get_default()
193
client.add_dir(GEDIT_LANG_PATH, gconf.CLIENT_PRELOAD_NONE)
195
for tag in lang.get_tags():
196
tag_id = tag.get_id()
197
gconf_key = GEDIT_LANG_PATH + '/' + tag_id
198
style_string = client.get_string(gconf_key)
200
if style_string is None:
203
# function to get a bool from a string that's either '0' or '1'
204
string_bool = lambda x: bool(int(x))
206
# style_string is a string like "2/#FFCCAA/#000000/0/1/0/0"
207
# values are: mask, fg, bg, italic, bold, underline, strike
208
# this packs them into (str_value, attr_name, conv_func) tuples
209
items = zip(style_string.split('/'), ['mask', 'foreground',
210
'background', 'italic', 'bold', 'underline', 'strikethrough' ],
211
[ int, gtk.gdk.color_parse, gtk.gdk.color_parse, string_bool,
212
string_bool, string_bool, string_bool ]
215
style = gtksourceview.SourceTagStyle()
217
# XXX The mask attribute controls whether the present values of
218
# foreground and background color should in fact be used. Ideally
219
# (and that's what gedit does), one could set all three attributes,
220
# and let the TagStyle object figure out which colors to use.
221
# However, in the GtkSourceview python bindings, the mask attribute
222
# is read-only, and it's derived instead from the colors being
223
# set or not. This means that we have to sometimes refrain from
224
# setting fg or bg colors, depending on the value of the mask.
225
# This code could go away if mask were writable.
226
mask = int(items[0][0])
227
if not (mask & 1): # GTK_SOURCE_TAG_STYLE_USE_BACKGROUND
229
if not (mask & 2): # GTK_SOURCE_TAG_STYLE_USE_FOREGROUND
231
items[0:1] = [] # skip the mask unconditionally
233
for value, attr, func in items:
237
warning('gconf key %s contains an invalid value: %s'
240
setattr(style, attr, value)
242
lang.set_tag_style(tag_id, style)
245
def apply_colordiff_colors(lang):
246
"""Set style colors for lang using the colordiff configuration file.
248
Both ~/.colordiffrc and ~/.colordiffrc.bzr-gtk are read.
250
:param lang: a "Diff" gtksourceview.SourceLanguage object.
254
for f in ('~/.colordiffrc', '~/.colordiffrc.bzr-gtk'):
255
f = os.path.expanduser(f)
256
if os.path.exists(f):
260
warning('could not open file %s: %s' % (f, str(e)))
262
colors.update(DiffWindow.parse_colordiffrc(f))
266
# ~/.colordiffrc does not exist
270
# map GtkSourceView tags to colordiff names
271
# since GSV is richer, accept new names for extra bits,
272
# defaulting to old names if they're not present
273
'Added@32@line': ['newtext'],
274
'Removed@32@line': ['oldtext'],
275
'Location': ['location', 'diffstuff'],
276
'Diff@32@file': ['file', 'diffstuff'],
277
'Special@32@case': ['specialcase', 'diffstuff'],
280
for tag in lang.get_tags():
281
tag_id = tag.get_id()
282
keys = mapping.get(tag_id, [])
286
color = colors.get(key, None)
287
if color is not None:
293
style = gtksourceview.SourceTagStyle()
295
style.foreground = gtk.gdk.color_parse(color)
297
warning('not a valid color: %s' % color)
299
lang.set_tag_style(tag_id, style)
302
def parse_colordiffrc(fileobj):
303
"""Parse fileobj as a colordiff configuration file.
305
:return: A dict with the key -> value pairs.
309
if re.match(r'^\s*#', line):
313
key, val = line.split('=', 1)
314
colors[key.strip()] = val.strip()