File: dialog.py

package info (click to toggle)
urwid 0.9.7.1-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 768 kB
  • ctags: 1,569
  • sloc: python: 10,622; makefile: 18
file content (373 lines) | stat: -rwxr-xr-x 9,607 bytes parent folder | download
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
369
370
371
372
373
#!/usr/bin/python
#
# Urwid example similar to dialog(1) program
#    Copyright (C) 2004-2006  Ian Ward
#
#    This library is free software; you can redistribute it and/or
#    modify it under the terms of the GNU Lesser General Public
#    License as published by the Free Software Foundation; either
#    version 2.1 of the License, or (at your option) any later version.
#
#    This library 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
#    Lesser General Public License for more details.
#
#    You should have received a copy of the GNU Lesser General Public
#    License along with this library; if not, write to the Free Software
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# Urwid web site: http://excess.org/urwid/

"""
Urwid example similar to dialog(1) program

"""

import sys

import urwid
import urwid.raw_display

try: True # old python?
except: False, True = 0, 1


class DialogExit(Exception):
	pass


class DialogDisplay:
	palette = [
		('body','black','light gray', 'standout'),
		('border','black','dark blue'),
		('shadow','white','black'),
		('selectable','black', 'dark cyan'),
		('focus','white','dark blue','bold'),
		('focustext','light gray','dark blue'),
		]
		
	def __init__(self, text, height, width, body=None):
		width = int(width)
		if width <= 0:
			width = ('relative', 80)
		height = int(height)
		if height <= 0:
			height = ('relative', 80)
	
		self.body = body
		if body is None:
			# fill space with nothing
			body = urwid.Filler(urwid.Divider(),'top')

		self.frame = urwid.Frame( body, focus_part='footer')
		if text is not None:
			self.frame.header = urwid.Pile( [urwid.Text(text),
				urwid.Divider()] )
		w = self.frame
		
		# pad area around listbox
		w = urwid.Padding(w, ('fixed left',2), ('fixed right',2))
		w = urwid.Filler(w, ('fixed top',1), ('fixed bottom',1))
		w = urwid.AttrWrap(w, 'body')
		
		# "shadow" effect
		w = urwid.Columns( [w,('fixed', 2, urwid.AttrWrap(
			urwid.Filler(urwid.Text(('border','  ')), "top")
			,'shadow'))])
		w = urwid.Frame( w, footer = 
			urwid.AttrWrap(urwid.Text(('border','  ')),'shadow'))

		# outermost border area
		w = urwid.Padding(w, 'center', width )
		w = urwid.Filler(w, 'middle', height )
		w = urwid.AttrWrap( w, 'border' )
		
		self.view = w


	def add_buttons(self, buttons):
		l = []
		for name, exitcode in buttons:
			b = urwid.Button( name, self.button_press )
			b.exitcode = exitcode
			b = urwid.AttrWrap( b, 'selectable','focus' )
			l.append( b )
		self.buttons = urwid.GridFlow(l, 10, 3, 1, 'center')
		self.frame.footer = urwid.Pile( [ urwid.Divider(),
			self.buttons ], focus_item = 1)

	def button_press(self, button):
		raise DialogExit(button.exitcode)

	def main(self):
		self.ui = urwid.raw_display.Screen()
		self.ui.register_palette( self.palette )
		return self.ui.run_wrapper( self.run )

	def run(self):
		self.ui.set_mouse_tracking()
		size = self.ui.get_cols_rows()
		try:
			while True:
				canvas = self.view.render( size, focus=True )
				self.ui.draw_screen( size, canvas )
				keys = None
				while not keys: 
					keys = self.ui.get_input()
				for k in keys:
					if urwid.is_mouse_event(k):
						event, button, col, row = k
						self.view.mouse_event( size, 
							event, button, col, row,
							focus=True)
					if k == 'window resize':
						size = self.ui.get_cols_rows()
					k = self.view.keypress( size, k )

					if k:
						self.unhandled_key( size, k)
		except DialogExit, e:
			return self.on_exit( e.args[0] )
		
	def on_exit(self, exitcode):
		return exitcode, ""

	def unhandled_key(self, size, key):
		pass
		


class InputDialogDisplay(DialogDisplay):
	def __init__(self, text, height, width):
		self.edit = urwid.Edit()
		body = urwid.ListBox([self.edit])
		body = urwid.AttrWrap(body, 'selectable','focustext')
		
		DialogDisplay.__init__(self, text, height, width, body)
		
		self.frame.set_focus('body')
	
	def unhandled_key(self, size, k):
		if k in ('up','page up'):
			self.frame.set_focus('body')
		if k in ('down','page down'):
			self.frame.set_focus('footer')
		if k == 'enter':
			# pass enter to the "ok" button
			self.frame.set_focus('footer')
			self.view.keypress( size, k )
	
	def on_exit(self, exitcode):
		return exitcode, self.edit.get_edit_text()

	
class TextDialogDisplay(DialogDisplay):
	def __init__(self, file, height, width):
		l = []
		# read the whole file (being slow, not lazy this time)
		for line in open(file).readlines():
			l.append( urwid.Text( line.rstrip() ))
		body = urwid.ListBox(l)
		body = urwid.AttrWrap(body, 'selectable','focustext')

		DialogDisplay.__init__(self, None, height, width, body)


	def unhandled_key(self, size, k):
		if k in ('up','page up','down','page down'):
			self.frame.set_focus('body')
			self.view.keypress( size, k )
			self.frame.set_focus('footer')


class ListDialogDisplay(DialogDisplay):
	def __init__(self, text, height, width, constr, items, has_default):
		j = []
		if has_default:	
			k, tail = 3, ()
		else:	
			k, tail = 2, ("no",)
		while items:
			j.append( items[:k] + tail )
			items = items[k:]
					
		l = []
		self.items = []
		for tag, item, default in j:
			w = constr( tag, default=="on" )
			self.items.append(w)
			w = urwid.Columns( [('fixed', 12, w), 
				urwid.Text(item)], 2 )
			w = urwid.AttrWrap(w, 'selectable','focus')
			l.append(w)

		lb = urwid.ListBox(l)
		lb = urwid.AttrWrap( lb, "selectable" )
		DialogDisplay.__init__(self, text, height, width, lb )
		
		self.frame.set_focus('body')
	
	def unhandled_key(self, size, k):
		if k in ('up','page up'):
			self.frame.set_focus('body')
		if k in ('down','page down'):
			self.frame.set_focus('footer')
		if k == 'enter':
			# pass enter to the "ok" button
			self.frame.set_focus('footer')
			self.buttons.set_focus(0)
			self.view.keypress( size, k )

	def on_exit(self, exitcode):
		"""Print the tag of the item selected."""
		if exitcode != 0:
			return exitcode, ""
		s = ""
		for i in self.items:
			if i.get_state():
				s = i.get_label()
				break
		return exitcode, s
		
	
	

class CheckListDialogDisplay(ListDialogDisplay):
	def on_exit(self, exitcode):
		"""
		Mimick dialog(1)'s --checklist exit. 
		Put each checked item in double quotes with a trailing space.
		"""
		if exitcode != 0:
			return exitcode, ""
		l = []
		for i in self.items:
			if i.get_state():
				l.append(i.get_label())
		return exitcode, "".join(['"'+tag+'" ' for tag in l])




class MenuItem(urwid.Text):
	"""A custom widget for the --menu option"""
	def __init__(self, label):
		urwid.Text.__init__(self, label)
		self.state = False
	def selectable(self):
		return True
	def keypress(self,size,key):
		if key == "enter":
			self.state = True
			raise DialogExit, 0
		return key
	def mouse_event(self,size,event,button,col,row,focus):
		if event=='mouse release':
			self.state = True
			raise DialogExit, 0
		return False
	def get_state(self):
		return self.state
	def get_label(self):
		text, attr = self.get_text()
		return text


def do_checklist(text, height, width, list_height, *items):
	def constr(tag, state):
		return urwid.CheckBox(tag, state)
	d = CheckListDialogDisplay( text, height, width, constr, items, True)
	d.add_buttons([	("OK", 0), ("Cancel", 1) ])
	return d
	
def do_inputbox(text, height, width):
	d = InputDialogDisplay( text, height, width )
	d.add_buttons([	("Exit", 0) ])
	return d

def do_menu(text, height, width, menu_height, *items):
	def constr(tag, state ):
		return MenuItem(tag)
	d = ListDialogDisplay(text, height, width, constr, items, False)
	d.add_buttons([	("OK", 0), ("Cancel", 1) ])
	return d

def do_msgbox(text, height, width):
	d = DialogDisplay( text, height, width )
	d.add_buttons([	("OK", 0) ])
	return d

def do_radiolist(text, height, width, list_height, *items):
	radiolist = []
	def constr(tag, state, radiolist=radiolist):
		return urwid.RadioButton(radiolist, tag, state)
	d = ListDialogDisplay( text, height, width, constr, items, True )
	d.add_buttons([	("OK", 0), ("Cancel", 1) ])
	return d

def do_textbox(file, height, width):
	d = TextDialogDisplay( file, height, width )
	d.add_buttons([	("Exit", 0) ])
	return d

def do_yesno(text, height, width):
	d = DialogDisplay( text, height, width )
	d.add_buttons([	("Yes", 0), ("No", 1) ])
	return d

MODES={	'--checklist':	(do_checklist, 
		"text height width list-height [ tag item status ] ..."),
	'--inputbox':	(do_inputbox, 
		"text height width"),
	'--menu':	(do_menu, 
		"text height width menu-height [ tag item ] ..."),
	'--msgbox':	(do_msgbox, 
		"text height width"),
	'--radiolist':	(do_radiolist, 
		"text height width list-height [ tag item status ] ..."),
	'--textbox':	(do_textbox,
		"file height width"),
	'--yesno':	(do_yesno, 
		"text height width"),
	}
	

def show_usage():
	"""
	Display a helpful usage message.
	"""
	modelist = [(mode, help) for (mode, (fn, help)) in MODES.items()]
	modelist.sort()
	sys.stdout.write(
		__doc__ + 
		"\n".join(["%-15s %s"%(mode,help) for (mode,help) in modelist])
		+ """

height and width may be set to 0 to auto-size.
list-height and menu-height are currently ignored.
status may be either on or off.
""" )


def main():
	if len(sys.argv) < 2 or not MODES.has_key(sys.argv[1]):
		show_usage()
		return
	
	# Create a DialogDisplay instance
	fn, help = MODES[sys.argv[1]]
	d = fn( * sys.argv[2:] )
	
	# Run it
	exitcode, exitstring = d.main()
	
	# Exit
	if exitstring:
		sys.stderr.write(exitstring)
	
	sys.exit(exitcode)
		

if __name__=="__main__": 
	main()