-
Notifications
You must be signed in to change notification settings - Fork 20
/
drawspaces.py
368 lines (298 loc) · 12.3 KB
/
drawspaces.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# -*- coding: utf-8 -*-
#
# drawspaces.py - Draw Spaces Plugin for gedit
#
# Copyright (C) 2006 - Paolo Borelli
# Copyright (C) 2007 - Steve Frécinaux
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330,
# Boston, MA 02111-1307, USA.
import gtk
import gtk.glade
import gedit
import gconf
import os
import gettext
from math import pi
try:
from gpdefs import *
gettext.bindtextdomain(GETTEXT_PACKAGE, GP_LOCALEDIR)
_ = lambda s: gettext.dgettext(GETTEXT_PACKAGE, s)
except:
_ = lambda s: s
GCONF_KEY_BASE = '/apps/gedit-2/plugins/drawspaces'
GCONF_KEY_ENABLE = '/apps/gedit-2/plugins/drawspaces/enable'
GCONF_KEY_COLOR = '/apps/gedit-2/plugins/drawspaces/color'
GCONF_KEY_DRAW_TABS = '/apps/gedit-2/plugins/drawspaces/draw_tabs'
GCONF_KEY_DRAW_SPACES = '/apps/gedit-2/plugins/drawspaces/draw_spaces'
GCONF_KEY_DRAW_NBSP = '/apps/gedit-2/plugins/drawspaces/draw_nbsp'
ui_str = """
<ui>
<menubar name="MenuBar">
<menu name="ViewMenu" action="View">
<separator />
<menuitem name="DrawSpacesMenu" action="DrawSpaces"/>
</menu>
</menubar>
</ui>
"""
def is_tab(c):
return c == '\t';
# There are probably more ...
def is_space(c):
return c == '\040' or \
c == '\342\200\200' or \
c == '\342\200\201' or \
c == '\342\200\202' or \
c == '\342\200\203' or \
c == '\342\200\204' or \
c == '\342\200\205' or \
c == '\342\200\206' or \
c == '\342\200\207' or \
c == '\342\200\210' or \
c == '\342\200\211' or \
c == '\342\200\212' or \
c == '\343\200\200'
def is_nbsp(c):
return c == '\302\240'
class DrawSpacesViewHelper(object):
def __init__(self, plugin, view):
self._plugin = plugin
self._view = view
self._handler_id = view.connect('event-after', self.on_event_after)
def deactivate(self):
if self._handler_id is not None:
self._view.disconnect(self._handler_id)
def enable_draw_spaces(self, enable):
if enable and self._handler_id is None:
self._handler_id = self._view.connect('event-after',
self.on_event_after)
elif not enable and self._handler_id is not None:
self._view.disconnect(self._handler_id)
self._handler_id = None
def on_event_after(self, view, event):
if event.type != gtk.gdk.EXPOSE or \
event.window != view.get_window(gtk.TEXT_WINDOW_TEXT):
return
y = view.window_to_buffer_coords(gtk.TEXT_WINDOW_TEXT, event.area.x, event.area.y)[1]
start = view.get_line_at_y(y)[0]
end = view.get_line_at_y(y + event.area.height)[0]
end.forward_to_line_end()
self.draw_tabs_and_spaces(event, start, end)
def draw_space_at_iter(self, cr, iter):
if not self._plugin._draw_spaces:
return
rect = self._view.get_iter_location(iter)
x, y = self._view.buffer_to_window_coords(gtk.TEXT_WINDOW_TEXT,
rect.x + rect.width / 2,
rect.y + rect.height * 2 / 3)
cr.save()
cr.move_to(x, y)
cr.arc(x, y, 0.8, 0, 2 * pi)
cr.restore()
def draw_nbsp_at_iter(self, cr, iter):
if not self._plugin._draw_nbsp:
return
rect = self._view.get_iter_location(iter)
x, y = self._view.buffer_to_window_coords(gtk.TEXT_WINDOW_TEXT,
rect.x,
rect.y + rect.height / 2)
cr.save()
cr.move_to(x + 2, y - 2)
cr.rel_line_to(+7,0)
cr.rel_line_to(-3.5,+6.06)
cr.rel_line_to(-3.5,-6.06)
cr.restore()
def draw_tab_at_iter(self, cr, iter):
if not self._plugin._draw_tabs:
return
rect = self._view.get_iter_location(iter)
x, y = self._view.buffer_to_window_coords(gtk.TEXT_WINDOW_TEXT,
rect.x,
rect.y + rect.height * 2 / 3)
cr.save()
cr.move_to(x + 4, y)
cr.rel_line_to(rect.width - 8, 0)
cr.rel_line_to(-3,-3)
cr.rel_move_to(+3,+3)
cr.rel_line_to(-3,+3)
cr.restore()
def draw_tabs_and_spaces(self, event, iter, end):
cr = event.window.cairo_create()
cr.set_source_color(self._plugin._color)
cr.set_line_width(0.8)
while iter.compare(end) <= 0:
c = iter.get_char()
if is_tab(c):
self.draw_tab_at_iter(cr, iter)
elif is_space(c):
self.draw_space_at_iter(cr, iter)
elif is_nbsp(c):
self.draw_nbsp_at_iter(cr, iter)
if not iter.forward_char():
break
cr.stroke()
class DrawSpacesWindowHelper(object):
def __init__(self, plugin, window):
self._window = window
self._plugin = plugin
self.insert_menu()
def deactivate(self):
self.set_tab_added_handler(None)
self.remove_menu()
self._window = None
self._plugin = None
def set_tab_added_handler(self, handler):
if handler:
self._handler_id = self._window.connect("tab-added", handler)
elif self._handler_id:
self._window.disconnect(self._handler_id)
def on_active_toggled(self, checkbox):
gconf_set_bool(GCONF_KEY_ENABLE, checkbox.get_active())
def insert_menu(self):
manager = self._window.get_ui_manager()
self._action_group = gtk.ActionGroup("DrawSpacesPluginActions")
self._action_group.add_toggle_actions([("DrawSpaces", None,
_("Show White Space"), None,
_("Show spaces and tabs"),
self.on_active_toggled,
self._plugin._enable)])
manager.insert_action_group(self._action_group, -1)
self._ui_id = manager.add_ui_from_string(ui_str)
def remove_menu(self):
manager = self._window.get_ui_manager()
manager.remove_ui(self._ui_id)
manager.remove_action_group(self._action_group)
manager.ensure_update()
def sync_menu(self):
self._action_group.get_action("DrawSpaces").set_active(self._plugin._enable)
class DrawSpacesConfigDialog(object):
GLADE_FILE = os.path.join(os.path.dirname(__file__), "drawspaces.glade")
def __init__(self, plugin):
object.__init__(self)
self._plugin = plugin
self.ui = gtk.glade.XML(self.GLADE_FILE, 'config-dialog', domain=GETTEXT_PACKAGE)
self.dialog = self.ui.get_widget('config-dialog')
self['draw-spaces'].set_active(plugin._draw_spaces)
self['draw-nbsp'].set_active(plugin._draw_nbsp)
self['draw-tabs'].set_active(plugin._draw_tabs)
self['color'].set_color(plugin._color)
handlers = {
'on_color_color_set': self.on_color_color_set,
'on_draw_spaces_toggled': self.on_draw_spaces_toggled,
'on_draw_nbsp_toggled': self.on_draw_nbsp_toggled,
'on_draw_tabs_toggled': self.on_draw_tabs_toggled
}
self.ui.signal_autoconnect(handlers)
self.dialog.connect('response', self.on_response)
def __getitem__(self, item):
return self.ui.get_widget(item)
def __del__(self):
self.__class__._instance = None
def on_response(self, dialog, response_id):
self.dialog.destroy()
def on_color_color_set(self, colorbutton):
color = colorbutton.get_color()
value = "#%04x%04x%04x" % (color.red, color.green, color.blue)
gconf_set_str(GCONF_KEY_COLOR, value)
def on_draw_spaces_toggled(self, checkbox):
value = checkbox.get_active()
gconf_set_bool(GCONF_KEY_DRAW_SPACES, value)
def on_draw_nbsp_toggled(self, checkbox):
value = checkbox.get_active()
gconf_set_bool(GCONF_KEY_DRAW_NBSP, value)
def on_draw_tabs_toggled(self, checkbox):
value = checkbox.get_active()
gconf_set_bool(GCONF_KEY_DRAW_TABS, value)
class DrawSpacesPlugin(gedit.Plugin):
WINDOW_DATA_KEY = "DrawSpacesPluginWindowData"
VIEW_DATA_KEY = "DrawSpacesPluginViewData"
def __init__(self):
gedit.Plugin.__init__(self)
self._enable = gconf_get_bool(GCONF_KEY_ENABLE, True)
# TODO: there should be a GUI to config those
self._color = gtk.gdk.color_parse(gconf_get_str(GCONF_KEY_COLOR, '#CCCCCC'))
self._draw_tabs = gconf_get_bool(GCONF_KEY_DRAW_TABS, True)
self._draw_spaces = gconf_get_bool(GCONF_KEY_DRAW_SPACES, True)
self._draw_nbsp = gconf_get_bool(GCONF_KEY_DRAW_NBSP, True)
gconf.client_get_default().notify_add(GCONF_KEY_BASE, self.on_gconf_notify)
def enable_draw_spaces(self, enable):
if (self._enable != enable):
self._enable = enable
for window in gedit.app_get_default().get_windows():
whelper = window.get_data(self.WINDOW_DATA_KEY)
whelper.sync_menu()
for view in window.get_views():
helper = view.get_data(self.VIEW_DATA_KEY)
helper.enable_draw_spaces(enable)
def on_gconf_notify(self, client, id, entry, data):
key = entry.get_key()
if key == GCONF_KEY_ENABLE:
self.enable_draw_spaces(entry.get_value().get_bool())
elif key == GCONF_KEY_COLOR:
self._color = gtk.gdk.color_parse(entry.get_value().get_string())
elif key == GCONF_KEY_DRAW_TABS:
self._draw_tabs = entry.get_value().get_bool()
elif key == GCONF_KEY_DRAW_SPACES:
self._draw_spaces = entry.get_value().get_bool()
elif key == GCONF_KEY_DRAW_NBSP:
self._draw_nbsp = entry.get_value().get_bool()
# redraw as needed
for window in gedit.app_get_default().get_windows():
window.get_active_view().queue_draw()
def add_view_helper(self, view):
helper = DrawSpacesViewHelper(self, view)
helper.enable_draw_spaces(self._enable)
view.set_data(self.VIEW_DATA_KEY, helper)
def remove_view_helper(self, view):
view.get_data(self.VIEW_DATA_KEY).deactivate()
view.set_data(self.VIEW_DATA_KEY, None)
def activate(self, window):
whelper = DrawSpacesWindowHelper(self, window)
window.set_data(self.WINDOW_DATA_KEY, whelper)
for view in window.get_views():
self.add_view_helper(view)
whelper.set_tab_added_handler(lambda w, t: self.add_view_helper(t.get_view()))
def deactivate(self, window):
whelper = window.get_data(self.WINDOW_DATA_KEY)
whelper.deactivate()
window.set_data(self.WINDOW_DATA_KEY, None)
for view in window.get_views():
self.remove_view_helper(view)
def update_ui(self, window):
pass
def create_configure_dialog(self):
return DrawSpacesConfigDialog(self).dialog
def gconf_get_bool(key, default = False):
val = gconf.client_get_default().get(key)
if val is not None and val.type == gconf.VALUE_BOOL:
return val.get_bool()
else:
return default
def gconf_set_bool(key, value):
v = gconf.Value(gconf.VALUE_BOOL)
v.set_bool(value)
gconf.client_get_default().set(key, v)
def gconf_get_str(key, default = ''):
val = gconf.client_get_default().get(key)
if val is not None and val.type == gconf.VALUE_STRING:
return val.get_string()
else:
return default
def gconf_set_str(key, value):
v = gconf.Value(gconf.VALUE_STRING)
v.set_string(value)
gconf.client_get_default().set(key, v)
# ex:ts=4:et: