ncurses 6.0 - patch 20160514
[ncurses.git] / man / curs_getch.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2015,2016 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.45 2016/05/15 01:05:18 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 *\fP\fIwin);\fR
52 .br
53 \fBint mvgetch(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
54 .br
55 \fBint mvwgetch(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
56 .br
57 \fBint ungetch(int \fP\fIch\fP\fB);\fR
58 .br
59 \fBint has_key(int \fP\fIch\fP\fB);\fR
60 .br
61 .SH DESCRIPTION
62 .SS Reading characters
63 The \fBgetch\fR, \fBwgetch\fR, \fBmvgetch\fR and \fBmvwgetch\fR, routines read
64 a character from the window.
65 In no-delay mode, if no input is waiting, the value \fBERR\fR is returned.
66 In delay mode, the program waits until the system
67 passes text through to the program.
68 Depending on the setting of \fBcbreak\fR,
69 this is after one character (cbreak mode),
70 or after the first newline (nocbreak mode).
71 In half-delay mode,
72 the program waits until a character is typed or the
73 specified timeout has been reached.
74 .PP
75 If \fBecho\fR is enabled, and the window is not a pad,
76 then the character will also be echoed into the
77 designated window according to the following rules:
78 .bP
79 If the character is the current erase character, left arrow, or backspace,
80 the cursor is moved one space to the left and that screen position is erased
81 as if \fBdelch\fR had been called.
82 .bP
83 If the character value is any other \fBKEY_\fR define, the user is alerted
84 with a \fBbeep\fR call.
85 .bP
86 If the character is a carriage-return,
87 and if \fBnl\fP is enabled,
88 it is translated to a line-feed after echoing.
89 .bP
90 Otherwise the character is simply output to the screen.
91 .PP
92 If the window is not a pad, and it has been moved or modified since the last
93 call to \fBwrefresh\fR, \fBwrefresh\fR will be called before another character
94 is read.
95 .SS Keypad mode
96 .PP
97 If \fBkeypad\fR is \fBTRUE\fR, and a function key is pressed, the token for
98 that function key is returned instead of the raw characters:
99 .bP
100 The predefined function
101 keys are listed in \fB<curses.h>\fR as macros with values outside the range
102 of 8-bit characters.
103 Their names begin with \fBKEY_\fR.
104 .bP
105 Other (user-defined) function keys which may be defined using \fBdefine_key\fP(3X)
106 have no names, but also are expected to have values outside the range of
107 8-bit characters.
108 .PP
109 Thus, a variable
110 intended to hold the return value of a function key must be of short size or
111 larger.
112 .PP
113 When a character that could be the beginning of a function key is received
114 (which, on modern terminals, means an escape character),
115 \fBcurses\fR sets a timer.
116 If the remainder of the sequence does not come in within the designated
117 time, the character is passed through;
118 otherwise, the function key value is returned.
119 For this reason, many terminals experience a delay between the time
120 a user presses the escape key and the escape is returned to the program.
121 .SS Ungetting characters
122 .PP
123 The \fBungetch\fR routine places \fIch\fR back onto the input queue to be
124 returned by the next call to \fBwgetch\fR.
125 There is just one input queue for all windows.
126 .PP
127 .SS Predefined key-codes
128 The following special keys are defined in \fB<curses.h>\fR.
129 .bP
130 Except for the special case \fBKEY_RESIZE\fP,
131 it is necessary to enable \fBkeypad\fR for \fBgetch\fP to return these codes.
132 .bP
133 Not all of these are necessarily supported on any particular terminal.
134 .bP
135 The naming convention may seem obscure, with some apparent
136 misspellings (such as "RSUME" for "resume").
137 The names correspond to the long terminfo capability names for the keys,
138 and were defined long ago, in the 1980s.
139 .PP
140 .TS
141 center tab(/) ;
142 l l .
143 \fIName\fR/\fIKey\fR \fIname\fR
144 _
145 KEY_BREAK/Break key
146 KEY_DOWN/The four arrow keys ...
147 KEY_UP
148 KEY_LEFT
149 KEY_RIGHT
150 KEY_HOME/Home key (upward+left arrow)
151 KEY_BACKSPACE/Backspace
152 KEY_F0/T{
153 Function keys; space for 64 keys is reserved.
154 T}
155 KEY_F(\fIn\fR)/T{
156 For 0 \(<= \fIn\fR \(<= 63
157 T}
158 KEY_DL/Delete line
159 KEY_IL/Insert line
160 KEY_DC/Delete character
161 KEY_IC/Insert char or enter insert mode
162 KEY_EIC/Exit insert char mode
163 KEY_CLEAR/Clear screen
164 KEY_EOS/Clear to end of screen
165 KEY_EOL/Clear to end of line
166 KEY_SF/Scroll 1 line forward
167 KEY_SR/Scroll 1 line backward (reverse)
168 KEY_NPAGE/Next page
169 KEY_PPAGE/Previous page
170 KEY_STAB/Set tab
171 KEY_CTAB/Clear tab
172 KEY_CATAB/Clear all tabs
173 KEY_ENTER/Enter or send
174 KEY_SRESET/Soft (partial) reset
175 KEY_RESET/Reset or hard reset
176 KEY_PRINT/Print or copy
177 KEY_LL/Home down or bottom (lower left)
178 KEY_A1/Upper left of keypad
179 KEY_A3/Upper right of keypad
180 KEY_B2/Center of keypad
181 KEY_C1/Lower left of keypad
182 KEY_C3/Lower right of keypad
183 KEY_BTAB/Back tab key
184 KEY_BEG/Beg(inning) key
185 KEY_CANCEL/Cancel key
186 KEY_CLOSE/Close key
187 KEY_COMMAND/Cmd (command) key
188 KEY_COPY/Copy key
189 KEY_CREATE/Create key
190 KEY_END/End key
191 KEY_EXIT/Exit key
192 KEY_FIND/Find key
193 KEY_HELP/Help key
194 KEY_MARK/Mark key
195 KEY_MESSAGE/Message key
196 KEY_MOUSE/Mouse event read
197 KEY_MOVE/Move key
198 KEY_NEXT/Next object key
199 KEY_OPEN/Open key
200 KEY_OPTIONS/Options key
201 KEY_PREVIOUS/Previous object key
202 KEY_REDO/Redo key
203 KEY_REFERENCE/Ref(erence) key
204 KEY_REFRESH/Refresh key
205 KEY_REPLACE/Replace key
206 KEY_RESIZE/Screen resized
207 KEY_RESTART/Restart key
208 KEY_RESUME/Resume key
209 KEY_SAVE/Save key
210 KEY_SBEG/Shifted beginning key
211 KEY_SCANCEL/Shifted cancel key
212 KEY_SCOMMAND/Shifted command key
213 KEY_SCOPY/Shifted copy key
214 KEY_SCREATE/Shifted create key
215 KEY_SDC/Shifted delete char key
216 KEY_SDL/Shifted delete line key
217 KEY_SELECT/Select key
218 KEY_SEND/Shifted end key
219 KEY_SEOL/Shifted clear line key
220 KEY_SEXIT/Shifted exit key
221 KEY_SFIND/Shifted find key
222 KEY_SHELP/Shifted help key
223 KEY_SHOME/Shifted home key
224 KEY_SIC/Shifted input key
225 KEY_SLEFT/Shifted left arrow key
226 KEY_SMESSAGE/Shifted message key
227 KEY_SMOVE/Shifted move key
228 KEY_SNEXT/Shifted next key
229 KEY_SOPTIONS/Shifted options key
230 KEY_SPREVIOUS/Shifted prev key
231 KEY_SPRINT/Shifted print key
232 KEY_SREDO/Shifted redo key
233 KEY_SREPLACE/Shifted replace key
234 KEY_SRIGHT/Shifted right arrow
235 KEY_SRSUME/Shifted resume key
236 KEY_SSAVE/Shifted save key
237 KEY_SSUSPEND/Shifted suspend key
238 KEY_SUNDO/Shifted undo key
239 KEY_SUSPEND/Suspend key
240 KEY_UNDO/Undo key
241 .TE
242 .PP
243 Keypad is arranged like this:
244 .br
245 .TS
246 center allbox tab(/) ;
247 c c c .
248 \fBA1\fR/\fBup\fR/\fBA3\fR
249 \fBleft\fR/\fBB2\fR/\fBright\fR
250 \fBC1\fR/\fBdown\fR/\fBC3\fR
251 .TE
252 .sp
253 A few of these predefined values do \fInot\fP correspond to a real key:
254 .bP
255 .B KEY_RESIZE
256 is returned when the \fBSIGWINCH\fP signal has been detected
257 (see \fBinitscr\fP(3X) and \fBresizeterm\fR(3X)).
258 This code is returned whether or not \fBkeypad\fP has been enabled.
259 .bP
260 .B KEY_MOUSE
261 is returned for mouse-events (see \fBcurs_mouse\fR(3X)).
262 This code relies upon whether or not \fBkeypad\fP(3X) has been enabled,
263 because (e.g., with \fIxterm\fP mouse prototocol) ncurses must
264 read escape sequences,
265 just like a function key.
266 .SS Testing key-codes
267 .PP
268 The \fBhas_key\fR routine takes a key-code value from the above list, and
269 returns \fBTRUE\fP or \fBFALSE\fP according to whether
270 the current terminal type recognizes a key with that value.
271 .PP
272 The library also supports these extensions:
273 .RS 3
274 .TP 5
275 .B define_key
276 defines a key-code for a given string (see \fBdefine_key\fP(3X)).
277 .TP 5
278 .B key_defined
279 checks if there is a key-code defined for a given
280 string (see \fBkey_defined\fP(3X)).
281 .RE
282 .PP
283 .SH RETURN VALUE
284 All routines return the integer \fBERR\fR upon failure and an integer value
285 other than \fBERR\fR (\fBOK\fR in the case of ungetch()) upon successful
286 completion.
287 .RS 3
288 .TP 5
289 \fBungetch\fP
290 returns ERR
291 if there is no more room in the FIFO.
292 .TP
293 \fBwgetch\fP
294 returns ERR
295 if the window pointer is null, or
296 if its timeout expires without having any data.
297 .RE
298 .PP
299 Functions with a "mv" prefix first perform a cursor movement using
300 \fBwmove\fP, and return an error if the position is outside the window,
301 or if the window pointer is null.
302 .SH NOTES
303 Use of the escape key by a programmer for a single character function is
304 discouraged, as it will cause a delay of up to one second while the
305 keypad code looks for a following function-key sequence.
306 .PP
307 Some keys may be the same as commonly used control
308 keys, e.g., \fBKEY_ENTER\fP versus control/M, \fBKEY_BACKSPACE\fP versus control/H.
309 Some curses implementations may differ according to whether they
310 treat these control keys specially (and ignore the terminfo), or
311 use the terminfo definitions.
312 \fBNcurses\fR uses the terminfo definition.
313 If it says that \fBKEY_ENTER\fP is control/M,
314 \fBgetch\fR will return \fBKEY_ENTER\fP
315 when you press control/M.
316 .PP
317 Generally, \fBKEY_ENTER\fP denotes the character(s) sent by the \fIEnter\fP
318 key on the numeric keypad:
319 .bP
320 the terminal description lists the most useful keys,
321 .bP
322 the \fIEnter\fP key on the regular keyboard is already handled by
323 the standard ASCII characters for carriage-return and line-feed,
324 .bP
325 depending on whether \fBnl\fP or \fBnonl\fP was called,
326 pressing "Enter" on the regular keyboard may return either a carriage-return
327 or line-feed, and finally
328 .bP
329 "Enter or send" is the standard description for this key.
330 .PP
331 When using \fBgetch\fR, \fBwgetch\fR, \fBmvgetch\fR, or
332 \fBmvwgetch\fR, nocbreak mode (\fBnocbreak\fR) and echo mode
333 (\fBecho\fR) should not be used at the same time.
334 Depending on the
335 state of the tty driver when each character is typed, the program may
336 produce undesirable results.
337 .PP
338 Note that \fBgetch\fR, \fBmvgetch\fR, and \fBmvwgetch\fR may be macros.
339 .PP
340 Historically, the set of keypad macros was largely defined by the extremely
341 function-key-rich keyboard of the AT&T 7300, aka 3B1, aka Safari 4.
342 Modern
343 personal computers usually have only a small subset of these.
344 IBM PC-style
345 consoles typically support little more than \fBKEY_UP\fR, \fBKEY_DOWN\fR,
346 \fBKEY_LEFT\fR, \fBKEY_RIGHT\fR, \fBKEY_HOME\fR, \fBKEY_END\fR,
347 \fBKEY_NPAGE\fR, \fBKEY_PPAGE\fR, and function keys 1 through 12.
348 The Ins key
349 is usually mapped to \fBKEY_IC\fR.
350 .SH PORTABILITY
351 The *get* functions are described in the XSI Curses standard, Issue 4.
352 They
353 read single-byte characters only.
354 The standard specifies that they return
355 \fBERR\fR on failure, but specifies no error conditions.
356 .PP
357 The echo behavior of these functions on input of \fBKEY_\fR or backspace
358 characters was not specified in the SVr4 documentation.
359 This description is
360 adopted from the XSI Curses standard.
361 .PP
362 The behavior of \fBgetch\fR and friends in the presence of handled signals is
363 unspecified in the SVr4 and XSI Curses documentation.
364 Under historical curses
365 implementations, it varied depending on whether the operating system's
366 implementation of handled signal receipt interrupts a \fBread\fR(2) call in
367 progress or not, and also (in some implementations) depending on whether an
368 input timeout or non-blocking mode has been set.
369 .PP
370 \fBKEY_MOUSE\fP is mentioned in XSI Curses, along with a few related
371 terminfo capabilities, but no higher-level functions use the feature.
372 The implementation in ncurses is an extension.
373 .PP
374 \fBKEY_RESIZE\fP is an extension first implemented for ncurses. 
375 NetBSD curses later added this extension.
376 .PP
377 Programmers concerned about portability should be prepared for either of two
378 cases: (a) signal receipt does not interrupt \fBgetch\fR; (b) signal receipt
379 interrupts \fBgetch\fR and causes it to return ERR with \fBerrno\fR set to
380 \fBEINTR\fR.
381 Under the \fBncurses\fR implementation, handled signals never
382 interrupt \fBgetch\fR.
383 .PP
384 The \fBhas_key\fR function is unique to \fBncurses\fR.
385 We recommend that
386 any code using it be conditionalized on the \fBNCURSES_VERSION\fR feature macro.
387 .SH SEE ALSO
388 \fBcurses\fR(3X),
389 \fBcurs_inopts\fR(3X),
390 \fBcurs_outopts\fR(3X),
391 \fBcurs_mouse\fR(3X),
392 \fBcurs_move\fR(3X),
393 \fBcurs_refresh\fR(3X),
394 \fBresizeterm\fR(3X).
395 .PP
396 Comparable functions in the wide-character (ncursesw) library are
397 described in
398 \fBcurs_get_wch\fR(3X).