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
|
# Copyright (C) 2009, 2010, 2011 Roman Zimbelmann <romanz@lavabit.com>
# This software is distributed under the terms of the GNU GPL version 3.
from ranger.core.shared import FileManagerAware, EnvironmentAware
from ranger.gui.curses_shortcuts import CursesShortcuts
class Displayable(EnvironmentAware, FileManagerAware, CursesShortcuts):
"""
Displayables are objects which are displayed on the screen.
This is just the abstract class, defining basic operations
such as resizing, printing, changing colors.
Subclasses of displayable can extend these methods:
draw() -- draw the object. Is only called if visible.
poke() -- is called just before draw(), even if not visible.
finalize() -- called after all objects finished drawing.
click(event) -- called with a MouseEvent. This is called on all
visible objects under the mouse, until one returns True.
press(key) -- called after a key press on focused objects.
destroy() -- called before destroying the displayable object
Additionally, there are these methods:
__contains__(item) -- is the item (y, x) inside the widget?
These attributes are set:
Modifiable:
focused -- Focused objects receive press() calls.
visible -- Visible objects receive draw() and finalize() calls
need_redraw -- Should the widget be redrawn? This variable may
be set at various places in the script and should eventually be
handled (and unset) in the draw() method.
Read-Only: (i.e. reccomended not to change manually)
win -- the own curses window object
parent -- the parent (DisplayableContainer) object or None
x, y, wid, hei -- absolute coordinates and boundaries
settings, fm, env -- inherited shared variables
"""
def __init__(self, win, env=None, fm=None, settings=None):
from ranger.gui.ui import UI
if env is not None:
self.env = env
if fm is not None:
self.fm = fm
if settings is not None:
self.settings = settings
self.need_redraw = True
self.focused = False
self.visible = True
self.x = 0
self.y = 0
self.wid = 0
self.hei = 0
self.paryx = (0, 0)
self.parent = None
self._old_visible = self.visible
if win is not None:
if isinstance(self, UI):
self.win = win
else:
self.win = win.derwin(1, 1, 0, 0)
def __nonzero__(self):
"""Always True"""
return True
__bool__ = __nonzero__
def __contains__(self, item):
"""
Is item inside the boundaries?
item can be an iterable like [y, x] or an object with x and y methods.
"""
try:
y, x = item.y, item.x
except AttributeError:
try:
y, x = item
except (ValueError, TypeError):
return False
return self.contains_point(y, x)
def draw(self):
"""
Draw the object. Called on every main iteration if visible.
Containers should call draw() on their contained objects here.
Override this!
"""
def destroy(self):
"""
Called when the object is destroyed.
Override this!
"""
def contains_point(self, y, x):
"""
Test whether the point (with absolute coordinates) lies
within the boundaries of this object.
"""
return (x >= self.x and x < self.x + self.wid) and \
(y >= self.y and y < self.y + self.hei)
def click(self, event):
"""
Called when a mouse key is pressed and self.focused is True.
Override this!
"""
pass
def press(self, key):
"""
Called when a key is pressed and self.focused is True.
Override this!
"""
pass
def poke(self):
"""Called before drawing, even if invisible"""
if self._old_visible != self.visible:
self._old_visible = self.visible
self.need_redraw = True
if not self.visible:
self.win.erase()
def finalize(self):
"""
Called after every displayable is done drawing.
Override this!
"""
pass
def resize(self, y, x, hei=None, wid=None):
"""Resize the widget"""
do_move = True
try:
maxy, maxx = self.env.termsize
except TypeError:
pass
else:
if hei is None:
hei = maxy - y
if wid is None:
wid = maxx - x
if x < 0 or y < 0:
raise ValueError("Starting point below zero!")
#if wid < 1 or hei < 1:
# raise OutOfBoundsException("WID and HEI must be >=1!")
if x + wid > maxx and y + hei > maxy:
raise ValueError("X and Y out of bounds!")
if x + wid > maxx:
raise ValueError("X out of bounds!")
if y + hei > maxy:
raise ValueError("Y out of bounds!")
window_is_cleared = False
if hei != self.hei or wid != self.wid:
#log("resizing " + str(self))
self.win.erase()
self.need_redraw = True
window_is_cleared = True
try:
self.win.resize(hei, wid)
except:
# Not enough space for resizing...
try:
self.win.mvderwin(0, 0)
do_move = True
self.win.resize(hei, wid)
except:
pass
#raise ValueError("Resizing Failed!")
self.hei, self.wid = self.win.getmaxyx()
if do_move or y != self.paryx[0] or x != self.paryx[1]:
if not window_is_cleared:
self.win.erase()
self.need_redraw = True
#log("moving " + str(self))
try:
self.win.mvderwin(y, x)
except:
pass
self.paryx = self.win.getparyx()
self.y, self.x = self.paryx
if self.parent:
self.y += self.parent.y
self.x += self.parent.x
def __str__(self):
return self.__class__.__name__
class DisplayableContainer(Displayable):
"""
DisplayableContainers are Displayables which contain other Displayables.
This is also an abstract class. The methods draw, poke, finalize,
click, press and destroy are extended here and will recursively
call the function on all contained objects.
New methods:
add_child(object) -- add the object to the container.
remove_child(object) -- remove the object from the container.
New attributes:
container -- a list with all contained objects (rw)
"""
def __init__(self, win, env=None, fm=None, settings=None):
if env is not None:
self.env = env
if fm is not None:
self.fm = fm
if settings is not None:
self.settings = settings
self.container = []
Displayable.__init__(self, win)
# ------------------------------------ extended or overidden methods
def poke(self):
"""Recursively called on objects in container"""
Displayable.poke(self)
for displayable in self.container:
displayable.poke()
def draw(self):
"""Recursively called on visible objects in container"""
for displayable in self.container:
if self.need_redraw:
displayable.need_redraw = True
if displayable.visible:
displayable.draw()
self.need_redraw = False
def finalize(self):
"""Recursively called on visible objects in container"""
for displayable in self.container:
if displayable.visible:
displayable.finalize()
def press(self, key):
"""Recursively called on objects in container"""
focused_obj = self._get_focused_obj()
if focused_obj:
focused_obj.press(key)
return True
return False
def click(self, event):
"""Recursively called on objects in container"""
focused_obj = self._get_focused_obj()
if focused_obj and focused_obj.click(event):
return True
for displayable in self.container:
if displayable.visible and event in displayable:
if displayable.click(event):
return True
return False
def destroy(self):
"""Recursively called on objects in container"""
for displayable in self.container:
displayable.destroy()
# ----------------------------------------------- new methods
def add_child(self, obj):
"""Add the objects to the container."""
if obj.parent:
obj.parent.remove_child(obj)
self.container.append(obj)
obj.parent = self
def remove_child(self, obj):
"""Remove the object from the container."""
try:
self.container.remove(obj)
except ValueError:
pass
else:
obj.parent = None
def _get_focused_obj(self):
# Finds a focused displayable object in the container.
for displayable in self.container:
if displayable.focused:
return displayable
try:
obj = displayable._get_focused_obj()
except AttributeError:
pass
else:
if obj is not None:
return obj
return None
|