2d5d6fda785ff4e910afac7cc7ec8c1d347510ad
[ncurses.git] / man / curs_getch.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: curs_getch.3x,v 1.36 2011/01/22 19:38:51 tom Exp $
31 .TH curs_getch 3X ""
32 .na
33 .hy 0
34 .de bP
35 .IP \(bu 4
36 ..
37 .SH NAME
38 \fBgetch\fR,
39 \fBwgetch\fR,
40 \fBmvgetch\fR,
41 \fBmvwgetch\fR,
42 \fBungetch\fR,
43 \fBhas_key\fR \- get (or push back) characters from \fBcurses\fR terminal keyboard
44 .ad
45 .hy
46 .SH SYNOPSIS
47 \fB#include <curses.h>\fR
48 .PP
49 \fBint getch(void);\fR
50 .br
51 \fBint wgetch(WINDOW *win);\fR
52 .br
53 \fBint mvgetch(int y, int x);\fR
54 .br
55 \fBint mvwgetch(WINDOW *win, int y, int x);\fR
56 .br
57 \fBint ungetch(int ch);\fR
58 .br
59 \fBint has_key(int ch);\fR
60 .br
61 .SH DESCRIPTION
62 The \fBgetch\fR, \fBwgetch\fR, \fBmvgetch\fR and \fBmvwgetch\fR, routines read
63 a character from the window.
64 In no-delay mode, if no input is waiting, the value \fBERR\fR is returned.
65 In delay mode, the program waits until the system
66 passes text through to the program.
67 Depending on the setting of \fBcbreak\fR,
68 this is after one character (cbreak mode),
69 or after the first newline (nocbreak mode).
70 In half-delay mode,
71 the program waits until a character is typed or the
72 specified timeout has been reached.
73 .PP
74 Unless \fBnoecho\fR has been set,
75 then the character will also be echoed into the
76 designated window according to the following rules:
77 if the character is the current erase character, left arrow, or backspace,
78 the cursor is moved one space to the left and that screen position is erased
79 as if \fBdelch\fR had been called.
80 If the character value is any other \fBKEY_\fR define, the user is alerted
81 with a \fBbeep\fR call.
82 Otherwise the character is simply output to the screen.
83 .PP
84 If the window is not a pad, and it has been moved or modified since the last
85 call to \fBwrefresh\fR, \fBwrefresh\fR will be called before another character
86 is read.
87 .PP
88 If \fBkeypad\fR is \fBTRUE\fR, and a function key is pressed, the token for
89 that function key is returned instead of the raw characters.
90 Possible function
91 keys are defined in \fB<curses.h>\fR as macros with values outside the range
92 of 8-bit characters whose names begin with \fBKEY_\fR. Thus, a variable
93 intended to hold the return value of a function key must be of short size or
94 larger.
95 .PP
96 When a character that could be the beginning of a function key is received
97 (which, on modern terminals, means an escape character),
98 \fBcurses\fR sets a timer.
99 If the remainder of the sequence does not come in within the designated
100 time, the character is passed through;
101 otherwise, the function key value is returned.
102 For this reason, many terminals experience a delay between the time
103 a user presses the escape key and the escape is returned to the program.
104 .PP
105 The \fBungetch\fR routine places \fIch\fR back onto the input queue to be
106 returned by the next call to \fBwgetch\fR.
107 There is just one input queue for all windows.
108 .PP
109 .SS Function Keys
110 The following function keys, defined in \fB<curses.h>\fR, might be returned by
111 \fBgetch\fR if \fBkeypad\fR has been enabled.
112 Note that not all of these are
113 necessarily supported on any particular terminal.
114 .sp
115 .TS
116 center tab(/) ;
117 l l
118 l l .
119 \fIName\fR/\fIKey\fR \fIname\fR
120 KEY_BREAK/Break key
121 KEY_DOWN/The four arrow keys ...
122 KEY_UP
123 KEY_LEFT
124 KEY_RIGHT
125 KEY_HOME/Home key (upward+left arrow)
126 KEY_BACKSPACE/Backspace
127 KEY_F0/T{
128 Function keys; space for 64 keys is reserved.
129 T}
130 KEY_F(\fIn\fR)/T{
131 For 0 \(<= \fIn\fR \(<= 63
132 T}
133 KEY_DL/Delete line
134 KEY_IL/Insert line
135 KEY_DC/Delete character
136 KEY_IC/Insert char or enter insert mode
137 KEY_EIC/Exit insert char mode
138 KEY_CLEAR/Clear screen
139 KEY_EOS/Clear to end of screen
140 KEY_EOL/Clear to end of line
141 KEY_SF/Scroll 1 line forward
142 KEY_SR/Scroll 1 line backward (reverse)
143 KEY_NPAGE/Next page
144 KEY_PPAGE/Previous page
145 KEY_STAB/Set tab
146 KEY_CTAB/Clear tab
147 KEY_CATAB/Clear all tabs
148 KEY_ENTER/Enter or send
149 KEY_SRESET/Soft (partial) reset
150 KEY_RESET/Reset or hard reset
151 KEY_PRINT/Print or copy
152 KEY_LL/Home down or bottom (lower left)
153 KEY_A1/Upper left of keypad
154 KEY_A3/Upper right of keypad
155 KEY_B2/Center of keypad
156 KEY_C1/Lower left of keypad
157 KEY_C3/Lower right of keypad
158 KEY_BTAB/Back tab key
159 KEY_BEG/Beg(inning) key
160 KEY_CANCEL/Cancel key
161 KEY_CLOSE/Close key
162 KEY_COMMAND/Cmd (command) key
163 KEY_COPY/Copy key
164 KEY_CREATE/Create key
165 KEY_END/End key
166 KEY_EXIT/Exit key
167 KEY_FIND/Find key
168 KEY_HELP/Help key
169 KEY_MARK/Mark key
170 KEY_MESSAGE/Message key
171 KEY_MOUSE/Mouse event read
172 KEY_MOVE/Move key
173 KEY_NEXT/Next object key
174 KEY_OPEN/Open key
175 KEY_OPTIONS/Options key
176 KEY_PREVIOUS/Previous object key
177 KEY_REDO/Redo key
178 KEY_REFERENCE/Ref(erence) key
179 KEY_REFRESH/Refresh key
180 KEY_REPLACE/Replace key
181 KEY_RESIZE/Screen resized
182 KEY_RESTART/Restart key
183 KEY_RESUME/Resume key
184 KEY_SAVE/Save key
185 KEY_SBEG/Shifted beginning key
186 KEY_SCANCEL/Shifted cancel key
187 KEY_SCOMMAND/Shifted command key
188 KEY_SCOPY/Shifted copy key
189 KEY_SCREATE/Shifted create key
190 KEY_SDC/Shifted delete char key
191 KEY_SDL/Shifted delete line key
192 KEY_SELECT/Select key
193 KEY_SEND/Shifted end key
194 KEY_SEOL/Shifted clear line key
195 KEY_SEXIT/Shifted exit key
196 KEY_SFIND/Shifted find key
197 KEY_SHELP/Shifted help key
198 KEY_SHOME/Shifted home key
199 KEY_SIC/Shifted input key
200 KEY_SLEFT/Shifted left arrow key
201 KEY_SMESSAGE/Shifted message key
202 KEY_SMOVE/Shifted move key
203 KEY_SNEXT/Shifted next key
204 KEY_SOPTIONS/Shifted options key
205 KEY_SPREVIOUS/Shifted prev key
206 KEY_SPRINT/Shifted print key
207 KEY_SREDO/Shifted redo key
208 KEY_SREPLACE/Shifted replace key
209 KEY_SRIGHT/Shifted right arrow
210 KEY_SRSUME/Shifted resume key
211 KEY_SSAVE/Shifted save key
212 KEY_SSUSPEND/Shifted suspend key
213 KEY_SUNDO/Shifted undo key
214 KEY_SUSPEND/Suspend key
215 KEY_UNDO/Undo key
216 .TE
217 .PP
218 Keypad is arranged like this:
219 .sp
220 .TS
221 center allbox tab(/) ;
222 c c c .
223 \fBA1\fR/\fBup\fR/\fBA3\fR
224 \fBleft\fR/\fBB2\fR/\fBright\fR
225 \fBC1\fR/\fBdown\fR/\fBC3\fR
226 .TE
227 .sp
228 The \fBhas_key\fR routine takes a key value from the above list, and
229 returns TRUE or FALSE according to whether
230 the current terminal type recognizes a key with that value.
231 Note that a few values do not correspond to a real key,
232 e.g., \fBKEY_RESIZE\fP and \fBKEY_MOUSE\fP.
233 See \fBresizeterm\fR(3X) for more details about \fBKEY_RESIZE\fP, and
234 \fBcurs_mouse\fR(3X) for a discussion of \fBKEY_MOUSE\fP.
235 .PP
236 .SH RETURN VALUE
237 All routines return the integer \fBERR\fR upon failure and an integer value
238 other than \fBERR\fR (\fBOK\fR in the case of ungetch()) upon successful
239 completion.
240 .RS
241 .TP 5
242 \fBungetch\fP
243 returns an error
244 if there is no more room in the FIFO.
245 .TP 5
246 \fBwgetch\fP
247 returns an error
248 if the window pointer is null, or
249 if its timeout expires without having any data.
250 .RE
251 .PP
252 Functions with a "mv" prefix first perform a cursor movement using
253 \fBwmove\fP, and return an error if the position is outside the window,
254 or if the window pointer is null.
255 .SH NOTES
256 Use of the escape key by a programmer for a single character function is
257 discouraged, as it will cause a delay of up to one second while the
258 keypad code looks for a following function-key sequence.
259 .PP
260 Note that some keys may be the same as commonly used control
261 keys, e.g., \fBKEY_ENTER\fP versus control/M, \fBKEY_BACKSPACE\fP versus control/H.
262 Some curses implementations may differ according to whether they
263 treat these control keys specially (and ignore the terminfo), or
264 use the terminfo definitions.
265 \fBNcurses\fR uses the terminfo definition.
266 If it says that \fBKEY_ENTER\fP is control/M,
267 \fBgetch\fR will return \fBKEY_ENTER\fP
268 when you press control/M.
269 .PP
270 Generally, \fBKEY_ENTER\fP denotes the character(s) sent by the \fIEnter\fP
271 key on the numeric keypad:
272 .bP
273 the terminal description lists the most useful keys,
274 .bP
275 the \fIEnter\fP key on the regular keyboard is already handled by
276 the standard ASCII characters for carriage-return and line-feed,
277 .bP
278 depending on whether \fBnl\fP or \fBnonl\fP was called,
279 pressing "Enter" on the regular keyboard may return either a carriage-return
280 or line-feed, and finally
281 .bP
282 "Enter or send" is the standard description for this key.
283 .PP
284 When using \fBgetch\fR, \fBwgetch\fR, \fBmvgetch\fR, or
285 \fBmvwgetch\fR, nocbreak mode (\fBnocbreak\fR) and echo mode
286 (\fBecho\fR) should not be used at the same time.
287 Depending on the
288 state of the tty driver when each character is typed, the program may
289 produce undesirable results.
290 .PP
291 Note that \fBgetch\fR, \fBmvgetch\fR, and \fBmvwgetch\fR may be macros.
292 .PP
293 Historically, the set of keypad macros was largely defined by the extremely
294 function-key-rich keyboard of the AT&T 7300, aka 3B1, aka Safari 4.
295 Modern
296 personal computers usually have only a small subset of these.
297 IBM PC-style
298 consoles typically support little more than \fBKEY_UP\fR, \fBKEY_DOWN\fR,
299 \fBKEY_LEFT\fR, \fBKEY_RIGHT\fR, \fBKEY_HOME\fR, \fBKEY_END\fR,
300 \fBKEY_NPAGE\fR, \fBKEY_PPAGE\fR, and function keys 1 through 12.
301 The Ins key
302 is usually mapped to \fBKEY_IC\fR.
303 .SH PORTABILITY
304 The *get* functions are described in the XSI Curses standard, Issue 4.
305 They
306 read single-byte characters only.
307 The standard specifies that they return
308 \fBERR\fR on failure, but specifies no error conditions.
309 .PP
310 The echo behavior of these functions on input of \fBKEY_\fR or backspace
311 characters was not specified in the SVr4 documentation.
312 This description is
313 adopted from the XSI Curses standard.
314 .PP
315 The behavior of \fBgetch\fR and friends in the presence of handled signals is
316 unspecified in the SVr4 and XSI Curses documentation.
317 Under historical curses
318 implementations, it varied depending on whether the operating system's
319 implementation of handled signal receipt interrupts a \fBread\fR(2) call in
320 progress or not, and also (in some implementations) depending on whether an
321 input timeout or non-blocking mode has been set.
322 .PP
323 Programmers concerned about portability should be prepared for either of two
324 cases: (a) signal receipt does not interrupt \fBgetch\fR; (b) signal receipt
325 interrupts \fBgetch\fR and causes it to return ERR with \fBerrno\fR set to
326 \fBEINTR\fR.
327 Under the \fBncurses\fR implementation, handled signals never
328 interrupt \fBgetch\fR.
329 .PP
330 The \fBhas_key\fR function is unique to \fBncurses\fR.
331 We recommend that
332 any code using it be conditionalized on the \fBNCURSES_VERSION\fR feature macro.
333 .SH SEE ALSO
334 \fBcurses\fR(3X),
335 \fBcurs_inopts\fR(3X),
336 \fBcurs_outopts\fR(3X),
337 \fBcurs_mouse\fR(3X),
338 \fBcurs_move\fR(3X),
339 \fBcurs_refresh\fR(3X),
340 \fBresizeterm\fR(3X).
341 .PP
342 Comparable functions in the wide-character (ncursesw) library are
343 described in
344 \fBcurs_get_wch\fR(3X).