annotate Lib/curses/textpad.py @ 79675:c0a2294de787 2.7

Issue #16199: Backport 2to3 typo fix from 3.2.
author Chris Jerdonek <chris.jerdonek@gmail.com>
date Thu, 11 Oct 2012 16:15:46 -0700
parents 45b672367b1f
children 787b969d37f0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13530
ed565b0fe648 Docstring changes.
Andrew M. Kuchling <amk@amk.ca>
parents: 13028
diff changeset
1 """Simple textbox editing widget with Emacs-like keybindings."""
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
2
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
3 import curses
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
4 import curses.ascii
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
5
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
6 def rectangle(win, uly, ulx, lry, lrx):
33793
223d82260452 Make magic coordinates more readable
Andrew M. Kuchling <amk@amk.ca>
parents: 25479
diff changeset
7 """Draw a rectangle with corners at the provided upper-left
223d82260452 Make magic coordinates more readable
Andrew M. Kuchling <amk@amk.ca>
parents: 25479
diff changeset
8 and lower-right coordinates.
223d82260452 Make magic coordinates more readable
Andrew M. Kuchling <amk@amk.ca>
parents: 25479
diff changeset
9 """
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
10 win.vline(uly+1, ulx, curses.ACS_VLINE, lry - uly - 1)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
11 win.hline(uly, ulx+1, curses.ACS_HLINE, lrx - ulx - 1)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
12 win.hline(lry, ulx+1, curses.ACS_HLINE, lrx - ulx - 1)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
13 win.vline(uly+1, lrx, curses.ACS_VLINE, lry - uly - 1)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
14 win.addch(uly, ulx, curses.ACS_ULCORNER)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
15 win.addch(uly, lrx, curses.ACS_URCORNER)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
16 win.addch(lry, lrx, curses.ACS_LRCORNER)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
17 win.addch(lry, ulx, curses.ACS_LLCORNER)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
18
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
19 class Textbox:
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
20 """Editing widget using the interior of a window object.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
21 Supports the following Emacs-like key bindings:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
22
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
23 Ctrl-A Go to left edge of window.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
24 Ctrl-B Cursor left, wrapping to previous line if appropriate.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
25 Ctrl-D Delete character under cursor.
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
26 Ctrl-E Go to right edge (stripspaces off) or end of line (stripspaces on).
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
27 Ctrl-F Cursor right, wrapping to next line when appropriate.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
28 Ctrl-G Terminate, returning the window contents.
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
29 Ctrl-H Delete character backward.
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
30 Ctrl-J Terminate if the window is 1 line, otherwise insert newline.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
31 Ctrl-K If line is blank, delete it, otherwise clear to end of line.
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
32 Ctrl-L Refresh screen.
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
33 Ctrl-N Cursor down; move down one line.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
34 Ctrl-O Insert a blank line at cursor location.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
35 Ctrl-P Cursor up; move up one line.
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
36
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
37 Move operations do nothing if the cursor is at an edge where the movement
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
38 is not possible. The following synonyms are supported where possible:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
39
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
40 KEY_LEFT = Ctrl-B, KEY_RIGHT = Ctrl-F, KEY_UP = Ctrl-P, KEY_DOWN = Ctrl-N
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
41 KEY_BACKSPACE = Ctrl-h
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
42 """
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
43 def __init__(self, win, insert_mode=False):
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
44 self.win = win
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
45 self.insert_mode = insert_mode
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
46 (self.maxy, self.maxx) = win.getmaxyx()
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
47 self.maxy = self.maxy - 1
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
48 self.maxx = self.maxx - 1
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
49 self.stripspaces = 1
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
50 self.lastcmd = None
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
51 win.keypad(1)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
52
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
53 def _end_of_line(self, y):
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
54 """Go to the location of the first blank on the given line,
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
55 returning the index of the last non-blank character."""
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
56 last = self.maxx
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
57 while True:
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
58 if curses.ascii.ascii(self.win.inch(y, last)) != curses.ascii.SP:
34988
c095888fc543 [Bug #1152762] Ensure _end_of_line() returns an x-coordinate that's within the text box
Andrew M. Kuchling <amk@amk.ca>
parents: 33796
diff changeset
59 last = min(self.maxx, last+1)
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
60 break
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
61 elif last == 0:
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
62 break
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
63 last = last - 1
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
64 return last
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
65
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
66 def _insert_printable_char(self, ch):
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
67 (y, x) = self.win.getyx()
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
68 if y < self.maxy or x < self.maxx:
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
69 if self.insert_mode:
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
70 oldch = self.win.inch()
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
71 # The try-catch ignores the error we trigger from some curses
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
72 # versions by trying to write into the lowest-rightmost spot
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
73 # in the window.
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
74 try:
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
75 self.win.addch(ch)
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
76 except curses.error:
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
77 pass
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
78 if self.insert_mode:
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
79 (backy, backx) = self.win.getyx()
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
80 if curses.ascii.isprint(oldch):
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
81 self._insert_printable_char(oldch)
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
82 self.win.move(backy, backx)
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
83
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
84 def do_command(self, ch):
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
85 "Process a single editing command."
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
86 (y, x) = self.win.getyx()
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
87 self.lastcmd = ch
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
88 if curses.ascii.isprint(ch):
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
89 if y < self.maxy or x < self.maxx:
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
90 self._insert_printable_char(ch)
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
91 elif ch == curses.ascii.SOH: # ^a
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
92 self.win.move(y, 0)
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
93 elif ch in (curses.ascii.STX,curses.KEY_LEFT, curses.ascii.BS,curses.KEY_BACKSPACE):
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
94 if x > 0:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
95 self.win.move(y, x-1)
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
96 elif y == 0:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
97 pass
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
98 elif self.stripspaces:
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
99 self.win.move(y-1, self._end_of_line(y-1))
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
100 else:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
101 self.win.move(y-1, self.maxx)
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
102 if ch in (curses.ascii.BS, curses.KEY_BACKSPACE):
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
103 self.win.delch()
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
104 elif ch == curses.ascii.EOT: # ^d
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
105 self.win.delch()
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
106 elif ch == curses.ascii.ENQ: # ^e
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
107 if self.stripspaces:
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
108 self.win.move(y, self._end_of_line(y))
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
109 else:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
110 self.win.move(y, self.maxx)
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
111 elif ch in (curses.ascii.ACK, curses.KEY_RIGHT): # ^f
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
112 if x < self.maxx:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
113 self.win.move(y, x+1)
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
114 elif y == self.maxy:
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
115 pass
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
116 else:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
117 self.win.move(y+1, 0)
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
118 elif ch == curses.ascii.BEL: # ^g
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
119 return 0
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
120 elif ch == curses.ascii.NL: # ^j
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
121 if self.maxy == 0:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
122 return 0
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
123 elif y < self.maxy:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
124 self.win.move(y+1, 0)
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
125 elif ch == curses.ascii.VT: # ^k
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
126 if x == 0 and self._end_of_line(y) == 0:
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
127 self.win.deleteln()
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
128 else:
33794
a2243d66d40b [Bug #1048816] Fix bug when you do Ctrl-K at the start of a line; fix from Stefan Heimann
Andrew M. Kuchling <amk@amk.ca>
parents: 33793
diff changeset
129 # first undo the effect of self._end_of_line
a2243d66d40b [Bug #1048816] Fix bug when you do Ctrl-K at the start of a line; fix from Stefan Heimann
Andrew M. Kuchling <amk@amk.ca>
parents: 33793
diff changeset
130 self.win.move(y, x)
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
131 self.win.clrtoeol()
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
132 elif ch == curses.ascii.FF: # ^l
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
133 self.win.refresh()
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
134 elif ch in (curses.ascii.SO, curses.KEY_DOWN): # ^n
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
135 if y < self.maxy:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
136 self.win.move(y+1, x)
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
137 if x > self._end_of_line(y+1):
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
138 self.win.move(y+1, self._end_of_line(y+1))
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
139 elif ch == curses.ascii.SI: # ^o
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
140 self.win.insertln()
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
141 elif ch in (curses.ascii.DLE, curses.KEY_UP): # ^p
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
142 if y > 0:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
143 self.win.move(y-1, x)
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
144 if x > self._end_of_line(y-1):
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
145 self.win.move(y-1, self._end_of_line(y-1))
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
146 return 1
25479
bbf8cf5ee9f9 Whitespace normalization (get rid of tabs).
Guido van Rossum <guido@python.org>
parents: 22009
diff changeset
147
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
148 def gather(self):
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
149 "Collect and return the contents of the window."
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
150 result = ""
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
151 for y in range(self.maxy+1):
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
152 self.win.move(y, 0)
13850
348a7c18e0e6 Corrected a bug in handling of ^N and ^P with stripspaces on.
Eric S. Raymond <esr@thyrsus.com>
parents: 13564
diff changeset
153 stop = self._end_of_line(y)
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
154 if stop == 0 and self.stripspaces:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
155 continue
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
156 for x in range(self.maxx+1):
44805
1e5614567a6e Patch #1048820 from Stefan Wehr: add insert-mode editing to Textbox.
Andrew M. Kuchling <amk@amk.ca>
parents: 34988
diff changeset
157 if self.stripspaces and x > stop:
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
158 break
47896
45b672367b1f Issue #3239. Differentiate the ascii call from the curses one and
Facundo Batista <facundobatista@gmail.com>
parents: 44805
diff changeset
159 result = result + chr(curses.ascii.ascii(self.win.inch(y, x)))
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
160 if self.maxy > 0:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
161 result = result + "\n"
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
162 return result
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
163
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
164 def edit(self, validate=None):
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
165 "Edit in the widget window and collect the results."
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
166 while 1:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
167 ch = self.win.getch()
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
168 if validate:
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
169 ch = validate(ch)
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
170 if not ch:
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
171 continue
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
172 if not self.do_command(ch):
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
173 break
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
174 self.win.refresh()
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
175 return self.gather()
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
176
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
177 if __name__ == '__main__':
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
178 def test_editbox(stdscr):
33793
223d82260452 Make magic coordinates more readable
Andrew M. Kuchling <amk@amk.ca>
parents: 25479
diff changeset
179 ncols, nlines = 9, 4
223d82260452 Make magic coordinates more readable
Andrew M. Kuchling <amk@amk.ca>
parents: 25479
diff changeset
180 uly, ulx = 15, 20
33796
6819ba023667 Display helpful message; print repr() of return value so the whitespace is clearer
Andrew M. Kuchling <amk@amk.ca>
parents: 33794
diff changeset
181 stdscr.addstr(uly-2, ulx, "Use Ctrl-G to end editing.")
33793
223d82260452 Make magic coordinates more readable
Andrew M. Kuchling <amk@amk.ca>
parents: 25479
diff changeset
182 win = curses.newwin(nlines, ncols, uly, ulx)
223d82260452 Make magic coordinates more readable
Andrew M. Kuchling <amk@amk.ca>
parents: 25479
diff changeset
183 rectangle(stdscr, uly-1, ulx-1, uly + nlines, ulx + ncols)
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
184 stdscr.refresh()
13028
97481d7ac548 Sync to ESR's current version
Andrew M. Kuchling <amk@amk.ca>
parents: 13023
diff changeset
185 return Textbox(win).edit()
13023
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
186
4102f7ede8e9 Added two modules for ASCII characters and a simple editing form (ESR)
Andrew M. Kuchling <amk@amk.ca>
parents:
diff changeset
187 str = curses.wrapper(test_editbox)
33796
6819ba023667 Display helpful message; print repr() of return value so the whitespace is clearer
Andrew M. Kuchling <amk@amk.ca>
parents: 33794
diff changeset
188 print 'Contents of text box:', repr(str)