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