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