blob: 53352041e9a62c0724e0338ace49877c69d920e7 [file] [log] [blame]
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +00001"""curses.wrapper
2
3Contains one function, wrapper(), which runs another function which
4should be the rest of your curses-based application. If the
5application raises an exception, wrapper() will restore the terminal
6to a sane state so you can read the resulting traceback.
7
8"""
9
10import sys, curses
11
Michael W. Hudson09ad2352004-08-07 15:18:07 +000012def wrapper(func, *args, **kwds):
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +000013 """Wrapper function that initializes curses and calls another function,
14 restoring normal keyboard/screen behavior on error.
15 The callable object 'func' is then passed the main window 'stdscr'
16 as its first argument, followed by any other arguments passed to
17 wrapper().
18 """
Guido van Rossumbffa52f2002-09-29 00:25:51 +000019
Andrew M. Kuchling8f790fe2000-06-27 00:50:40 +000020 res = None
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +000021 try:
Guido van Rossumbffa52f2002-09-29 00:25:51 +000022 # Initialize curses
Jeremy Hylton2ea17fa2000-07-07 21:02:22 +000023 stdscr=curses.initscr()
Guido van Rossumbffa52f2002-09-29 00:25:51 +000024
25 # Turn off echoing of keys, and enter cbreak mode,
26 # where no buffering is performed on keyboard input
Jeremy Hylton2ea17fa2000-07-07 21:02:22 +000027 curses.noecho()
28 curses.cbreak()
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +000029
Guido van Rossumbffa52f2002-09-29 00:25:51 +000030 # In keypad mode, escape sequences for special keys
31 # (like the cursor keys) will be interpreted and
32 # a special value like curses.KEY_LEFT will be returned
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +000033 stdscr.keypad(1)
34
Eric S. Raymond1ebd3f62000-08-09 21:11:07 +000035 # Start color, too. Harmless if the terminal doesn't have
36 # color; user can test with has_color() later on. The try/catch
37 # works around a minor bit of over-conscientiousness in the curses
38 # module -- the error return from C start_color() is ignorable.
39 try:
40 curses.start_color()
41 except:
42 pass
43
Michael W. Hudson3fdd43e2004-08-07 15:20:15 +000044 return func(stdscr, *args, **kwds)
Michael W. Hudson09ad2352004-08-07 15:18:07 +000045 finally:
Guido van Rossumbffa52f2002-09-29 00:25:51 +000046 # Set everything back to normal
Jeremy Hylton2ea17fa2000-07-07 21:02:22 +000047 stdscr.keypad(0)
48 curses.echo()
49 curses.nocbreak()
Michael W. Hudson09ad2352004-08-07 15:18:07 +000050 curses.endwin()