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