man/curs_getch.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2022,2023 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.75 2023/10/07 21:19:07 tom Exp $
  32 .TH curs_getch 3X 2023-10-07 "ncurses 6.4" "Library calls"
  33 .ie \n(.g \{\
  34 .ds `` \(lq
  35 .ds '' \(rq
  36 .\}
  37 .el \{\
  38 .ie t .ds `` ``
  39 .el   .ds `` ""
  40 .ie t .ds '' ''
  41 .el   .ds '' ""
  42 .\}
  43 .
  44 .de bP
  45 .ie n  .IP \(bu 4
  46 .el    .IP \(bu 2
  47 ..
  48 .SH NAME
  49 \fB\%getch\fP,
  50 \fB\%wgetch\fP,
  51 \fB\%mvgetch\fP,
  52 \fB\%mvwgetch\fP,
  53 \fB\%ungetch\fP,
  54 \fB\%has_key\fP \-
  55 get (or push back) characters from \fIcurses\fR terminal keyboard
  56 .SH SYNOPSIS
  57 .nf
  58 .B #include <curses.h>
  59 .PP
  60 .B int getch(void);
  61 .B int wgetch(WINDOW *\fIwin\fP);
  62 .PP
  63 .B int mvgetch(int \fIy\fP, int \fIx\fP);
  64 .B int mvwgetch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
  65 .PP
  66 .B int ungetch(int \fIch\fP);
  67 .PP
  68 \fI/* extension */\fP
  69 .B int has_key(int \fIch\fP);
  70 .fi
  71 .SH DESCRIPTION
  72 .SS Reading characters
  73 The \fBgetch\fP, \fBwgetch\fP, \fBmvgetch\fP and \fBmvwgetch\fP, routines read
  74 a character from the window.
  75 In no-delay mode, if no input is waiting, the value \fBERR\fP is returned.
  76 In delay mode, the program waits until the system
  77 passes text through to the program.
  78 Depending on the setting of \fBcbreak\fP,
  79 this is after one character (cbreak mode),
  80 or after the first newline (nocbreak mode).
  81 In half-delay mode,
  82 the program waits until a character is typed or the
  83 specified timeout has been reached.
  84 .PP
  85 If \fBecho\fP is enabled, and the window is not a pad,
  86 then the character will also be echoed into the
  87 designated window according to the following rules:
  88 .bP
  89 If the character is the current erase character, left arrow, or backspace,
  90 the cursor is moved one space to the left and that screen position is erased
  91 as if \fBdelch\fP had been called.
  92 .bP
  93 If the character value is any other \fBKEY_\fP define, the user is alerted
  94 with a \fBbeep\fP call.
  95 .bP
  96 If the character is a carriage-return,
  97 and if \fBnl\fP is enabled,
  98 it is translated to a line-feed after echoing.
  99 .bP
 100 Otherwise the character is simply output to the screen.
 101 .PP
 102 If the window is not a pad, and it has been moved or modified since the last
 103 call to \fBwrefresh\fP, \fBwrefresh\fP will be called before another character
 104 is read.
 105 .SS Keypad mode
 106 If \fBkeypad\fP is \fBTRUE\fP, and a function key is pressed, the token for
 107 that function key is returned instead of the raw characters:
 108 .bP
 109 The predefined function
 110 keys are listed in \fB<curses.h>\fP as macros with values outside the range
 111 of 8-bit characters.
 112 Their names begin with \fBKEY_\fP.
 113 .bP
 114 Other (user-defined) function keys which may be defined
 115 using \fBdefine_key\fP(3X)
 116 have no names, but also are expected to have values outside the range of
 117 8-bit characters.
 118 .PP
 119 Thus, a variable
 120 intended to hold the return value of a function key must be of short size or
 121 larger.
 122 .PP
 123 When a character that could be the beginning of a function key is received
 124 (which, on modern terminals, means an escape character),
 125 \fBcurses\fP sets a timer.
 126 If the remainder of the sequence does not come in within the designated
 127 time, the character is passed through;
 128 otherwise, the function key value is returned.
 129 For this reason, many terminals experience a delay between the time
 130 a user presses the escape key and the escape is returned to the program.
 131 .PP
 132 In \fBncurses\fP, the timer normally expires after
 133 the value in \fBESCDELAY\fP (see \fBcurs_variables\fP(3X)).
 134 If \fBnotimeout\fP is \fBTRUE\fP, the timer does not expire;
 135 it is an infinite (or very large) value.
 136 Because function keys usually begin with an escape character,
 137 the terminal may appear to hang in notimeout mode after pressing the escape key
 138 until another key is pressed.
 139 .SS Ungetting characters
 140 The \fBungetch\fP routine places \fIch\fP back onto the input queue to be
 141 returned by the next call to \fBwgetch\fP.
 142 There is just one input queue for all windows.
 143 .SS Predefined key-codes
 144 The following special keys are defined in \fB<curses.h>\fP.
 145 .bP
 146 Except for the special case \fBKEY_RESIZE\fP,
 147 it is necessary to enable \fBkeypad\fP for \fBgetch\fP to return these codes.
 148 .bP
 149 Not all of these are necessarily supported on any particular terminal.
 150 .bP
 151 The naming convention may seem obscure, with some apparent
 152 misspellings (such as \*(``RSUME\*('' for \*(``resume\*('').
 153 The names correspond to the long terminfo capability names for the keys,
 154 and were defined long ago, in the 1980s.
 155 .PP
 156 .RS
 157 .TS
 158 tab(/) ;
 159 l l .
 160 \fBName\fP/\fBKey\fP \fBname\fP
 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\fP)/T{
 173 For 0 \(<= \fIn\fP \(<= 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 occurred
 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 insert 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 key
 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 .RE
 260 .PP
 261 Keypad is arranged like this:
 262 .PP
 263 .RS
 264 .TS
 265 allbox tab(/) ;
 266 c c c .
 267 \fBA1\fP/\fBup\fP/\fBA3\fP
 268 \fBleft\fP/\fBB2\fP/\fBright\fP
 269 \fBC1\fP/\fBdown\fP/\fBC3\fP
 270 .TE
 271 .RE
 272 .sp
 273 A few of these predefined values do \fInot\fP correspond to a real key:
 274 .bP
 275 .B KEY_RESIZE
 276 is returned when the \fBSIGWINCH\fP signal has been detected
 277 (see \fBinitscr\fP(3X) and \fBresizeterm\fP(3X)).
 278 This code is returned whether or not \fBkeypad\fP has been enabled.
 279 .bP
 280 .B KEY_MOUSE
 281 is returned for mouse-events (see \fBcurs_mouse\fP(3X)).
 282 This code relies upon whether or not \fBkeypad\fP(3X) has been enabled,
 283 because (e.g., with \fBxterm\fP(1) mouse prototocol) ncurses must
 284 read escape sequences,
 285 just like a function key.
 286 .SS Testing key-codes
 287 The \fBhas_key\fP routine takes a key-code value from the above list, and
 288 returns \fBTRUE\fP or \fBFALSE\fP according to whether
 289 the current terminal type recognizes a key with that value.
 290 .PP
 291 The library also supports these extensions:
 292 .RS 3
 293 .TP 5
 294 .B define_key
 295 defines a key-code for a given string (see \fBdefine_key\fP(3X)).
 296 .TP 5
 297 .B key_defined
 298 checks if there is a key-code defined for a given
 299 string (see \fBkey_defined\fP(3X)).
 300 .RE
 301 .SH RETURN VALUE
 302 All routines return the integer \fBERR\fP upon failure and an integer value
 303 other than \fBERR\fP (\fBOK\fP in the case of \fBungetch\fP) upon successful
 304 completion.
 305 .RS 3
 306 .TP 5
 307 \fBungetch\fP
 308 returns \fBERR\fP
 309 if there is no more room in the FIFO.
 310 .TP
 311 \fBwgetch\fP
 312 returns \fBERR\fP
 313 if the window pointer is null, or
 314 if its timeout expires without having any data, or
 315 if the execution was interrupted by a signal (\fBerrno\fP will be set to
 316 \fBEINTR\fP).
 317 .RE
 318 .PP
 319 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
 320 \fBwmove\fP, and return an error if the position is outside the window,
 321 or if the window pointer is null.
 322 .SH NOTES
 323 Use of the escape key by a programmer for a single character function is
 324 discouraged, as it will cause a delay of up to one second while the
 325 keypad code looks for a following function-key sequence.
 326 .PP
 327 Some keys may be the same as commonly used control
 328 keys, e.g.,
 329 \fBKEY_ENTER\fP versus control/M,
 330 \fBKEY_BACKSPACE\fP versus control/H.
 331 Some curses implementations may differ according to whether they
 332 treat these control keys specially (and ignore the terminfo), or
 333 use the terminfo definitions.
 334 \fBNcurses\fP uses the terminfo definition.
 335 If it says that \fBKEY_ENTER\fP is control/M,
 336 \fBgetch\fP will return \fBKEY_ENTER\fP
 337 when you press control/M.
 338 .PP
 339 Generally, \fBKEY_ENTER\fP denotes the character(s) sent by the \fIEnter\fP
 340 key on the numeric keypad:
 341 .bP
 342 the terminal description lists the most useful keys,
 343 .bP
 344 the \fIEnter\fP key on the regular keyboard is already handled by
 345 the standard ASCII characters for carriage-return and line-feed,
 346 .bP
 347 depending on whether \fBnl\fP or \fBnonl\fP was called,
 348 pressing \*(``Enter\*('' on the regular keyboard
 349 may return either a carriage-return or line-feed, and finally
 350 .bP
 351 \*(``Enter or send\*('' is the standard description for this key.
 352 .PP
 353 When using \fBgetch\fP, \fBwgetch\fP, \fBmvgetch\fP, or
 354 \fBmvwgetch\fP, nocbreak mode (\fBnocbreak\fP) and echo mode
 355 (\fBecho\fP) should not be used at the same time.
 356 Depending on the
 357 state of the tty driver when each character is typed, the program may
 358 produce undesirable results.
 359 .PP
 360 Note that \fBgetch\fP, \fBmvgetch\fP, and \fBmvwgetch\fP may be macros.
 361 .PP
 362 Historically, the set of keypad macros was largely defined by the extremely
 363 function-key-rich keyboard of the AT&T 7300, aka 3B1, aka Safari 4.
 364 Modern
 365 personal computers usually have only a small subset of these.
 366 IBM PC-style
 367 consoles typically support little more than \fBKEY_UP\fP, \fBKEY_DOWN\fP,
 368 \fBKEY_LEFT\fP, \fBKEY_RIGHT\fP, \fBKEY_HOME\fP, \fBKEY_END\fP,
 369 \fBKEY_NPAGE\fP, \fBKEY_PPAGE\fP, and function keys 1 through 12.
 370 The Ins key
 371 is usually mapped to \fBKEY_IC\fP.
 372 .SH PORTABILITY
 373 The *get* functions are described in the XSI Curses standard, Issue 4.
 374 They
 375 read single-byte characters only.
 376 The standard specifies that they return
 377 \fBERR\fP on failure, but specifies no error conditions.
 378 .PP
 379 The echo behavior of these functions on input of \fBKEY_\fP or backspace
 380 characters was not specified in the SVr4 documentation.
 381 This description is
 382 adopted from the XSI Curses standard.
 383 .PP
 384 The behavior of \fBgetch\fP and friends in the presence of handled signals is
 385 unspecified in the SVr4 and XSI Curses documentation.
 386 Under historical curses
 387 implementations, it varied depending on whether the operating system's
 388 implementation of handled signal receipt interrupts a \fBread\fP(2) call in
 389 progress or not, and also (in some implementations) depending on whether an
 390 input timeout or non-blocking mode has been set.
 391 .PP
 392 \fBKEY_MOUSE\fP is mentioned in XSI Curses, along with a few related
 393 terminfo capabilities, but no higher-level functions use the feature.
 394 The implementation in ncurses is an extension.
 395 .PP
 396 \fBKEY_RESIZE\fP is an extension first implemented for ncurses.
 397 NetBSD curses later added this extension.
 398 .PP
 399 Programmers concerned about portability should be prepared for either of two
 400 cases: (a) signal receipt does not interrupt \fBgetch\fP; (b) signal receipt
 401 interrupts \fBgetch\fP and causes it to return \fBERR\fP with \fBerrno\fP set to
 402 \fBEINTR\fP.
 403 .PP
 404 The \fBhas_key\fP function is unique to \fBncurses\fP.
 405 We recommend that
 406 any code using it be conditionalized on the \fBNCURSES_VERSION\fP feature macro.
 407 .SH SEE ALSO
 408 \fB\%curses\fP(3X),
 409 \fB\%curs_inopts\fP(3X),
 410 \fB\%curs_mouse\fP(3X),
 411 \fB\%curs_move\fP(3X),
 412 \fB\%curs_outopts\fP(3X),
 413 \fB\%curs_refresh\fP(3X),
 414 \fB\%curs_variables\fP(3X),
 415 \fB\%resizeterm\fP(3X)
 416 .PP
 417 Comparable functions in the wide-character (ncursesw) library are
 418 described in
 419 \fB\%curs_get_wch\fP(3X).