man/curs_util.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4 .\" Copyright 1998-2015,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_util.3x,v 1.106 2024/06/01 22:28:18 tom Exp $
  32 .TH curs_util 3X 2024-06-01 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "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\%delay_output\fP,
  50 \fB\%filter\fP,
  51 \fB\%flushinp\fP,
  52 \fB\%getwin\fP,
  53 \fB\%key_name\fP,
  54 \fB\%keyname\fP,
  55 \fB\%nofilter\fP,
  56 \fB\%putwin\fP,
  57 \fB\%unctrl\fP,
  58 \fB\%use_env\fP,
  59 \fB\%use_tioctl\fP,
  60 \fB\%wunctrl\fP \-
  61 miscellaneous \fIcurses\fR utility routines
  62 .SH SYNOPSIS
  63 .nf
  64 \fB#include <curses.h>
  65 .PP
  66 \fBconst char *unctrl(chtype \fIch\fP);
  67 \fBwchar_t *wunctrl(cchar_t *\fIwch\fP);
  68 .PP
  69 \fBconst char *keyname(int \fIc\fP);
  70 \fBconst char *key_name(wchar_t \fIwc\fP);
  71 .PP
  72 \fBvoid filter(void);
  73 .PP
  74 \fBvoid use_env(bool \fIbf\fP);
  75 .PP
  76 \fBint putwin(WINDOW *\fIwin\fP, FILE *\fIfilep\fP);
  77 \fBWINDOW *getwin(FILE *\fIfilep\fP);
  78 .PP
  79 \fBint delay_output(int \fIms\fP);
  80 \fBint flushinp(void);
  81 .PP
  82 \fI/* extensions */
  83 \fBvoid nofilter(void);
  84 \fBvoid use_tioctl(bool \fIbf\fP);
  85 .fi
  86 .SH DESCRIPTION
  87 .SS unctrl
  88 The \fBunctrl\fP routine returns a character string which is a printable
  89 representation of the character \fIch\fP:
  90 .bP
  91 Printable characters are displayed as themselves,
  92 e.g., a one-character string containing the key.
  93 .bP
  94 Control characters are displayed in the \fB^\fIX\fR notation.
  95 .bP
  96 Printing characters are displayed as is.
  97 .bP
  98 DEL (character 127) is displayed as \fB^?\fP.
  99 .bP
 100 Values above 128 are either meta characters
 101 (if the screen has not been initialized,
 102 or if \fBmeta\fP(3X) has been called with a \fBTRUE\fP parameter),
 103 shown in the \fBM\-\fIX\fR notation,
 104 or are displayed as themselves.
 105 In the latter case, the values may not be printable;
 106 this follows the X/Open specification.
 107 .PP
 108 The corresponding \fBwunctrl\fP returns a printable representation of
 109 a complex character \fIwch\fP.
 110 .PP
 111 In both \fBunctrl\fP and \fBwunctrl\fP the attributes and color associated
 112 with the character parameter are ignored.
 113 .SS "keyname, key_name"
 114 The \fBkeyname\fP routine returns a character string
 115 corresponding to the key \fIc\fP.
 116 Key codes are different from character codes.
 117 .bP
 118 Key codes below 256 are characters.
 119 They are displayed using \fBunctrl\fP.
 120 .bP
 121 Values above 256 may be the codes for function keys.
 122 The function key name is displayed.
 123 .bP
 124 Otherwise (if there is no corresponding name and the key is not a character)
 125 the function returns null, to denote an error.
 126 X/Open also lists an \*(``UNKNOWN KEY\*('' return value,
 127 which some implementations return rather than null.
 128 .LP
 129 The corresponding \fBkey_name\fP returns
 130 a multibyte character string corresponding
 131 to the wide-character value \fIwc\fP.
 132 The two functions (\fBkeyname\fP and \fBkey_name\fP)
 133 do not return the same set of strings:
 134 .bP
 135 \fBkeyname\fP returns null where \fBkey_name\fP would display a meta character.
 136 .bP
 137 \fBkey_name\fP does not return the name of a function key.
 138 .SS "filter, nofilter"
 139 The \fBfilter\fP routine, if used, must be called before \fBinitscr\fP or
 140 \fBnewterm\fP are called.
 141 Calling \fBfilter\fP causes these changes in initialization:
 142 .bP
 143 \fBLINES\fP is set to 1;
 144 .bP
 145 the capabilities
 146 \fBclear\fP,
 147 \fBcud1\fP,
 148 \fBcud\fP,
 149 \fBcup\fP,
 150 \fBcuu1\fP,
 151 \fBcuu\fP,
 152 \fBvpa\fP
 153 are disabled;
 154 .bP
 155 the capability \fBed\fP is disabled if \fBbce\fP is set;
 156 .bP
 157 and the \fBhome\fP string is set to the value of \fBcr\fP.
 158 .PP
 159 The \fBnofilter\fP routine cancels the effect of a preceding \fBfilter\fP
 160 call.
 161 That allows the caller to initialize a screen on a different device,
 162 using a different value of \fB$TERM\fP.
 163 The limitation arises because the \fBfilter\fP routine modifies the
 164 in-memory copy of the terminal information.
 165 .SS use_env
 166 The \fBuse_env\fP routine, if used,
 167 should be called before \fBinitscr\fP or
 168 \fBnewterm\fP are called
 169 (because those compute the screen size).
 170 It modifies the way \fI\%ncurses\fP treats environment variables
 171 when determining the screen size.
 172 .bP
 173 Normally \fI\%ncurses\fP looks first at the terminal database for the
 174 screen size.
 175 .IP
 176 If \fBuse_env\fP was called with \fBFALSE\fP for parameter,
 177 it stops here unless
 178 \fBuse_tioctl\fP was also called with \fBTRUE\fP for parameter.
 179 .bP
 180 Then it asks for the screen size via operating system calls.
 181 If successful,
 182 it overrides the values from the terminal database.
 183 .bP
 184 Finally (unless \fBuse_env\fP was called with \fBFALSE\fP parameter),
 185 \fI\%ncurses\fP examines the \fILINES\fP or \fI\%COLUMNS\fP environment
 186 variables,
 187 using a value in those to override the results
 188 from the operating system or terminal database.
 189 .IP
 190 \fI\%curses\fP also updates the screen size in response to
 191 \fBSIGWINCH\fP,
 192 unless overridden by the \fILINES\fP or \fI\%COLUMNS\fP environment
 193 variables,
 194 .SS use_tioctl
 195 The \fBuse_tioctl\fP routine, if used,
 196 should be called before \fBinitscr\fP or \fBnewterm\fP are called
 197 (because those compute the screen size).
 198 After \fBuse_tioctl\fP is called with \fBTRUE\fP as an argument,
 199 \fI\%ncurses\fP modifies the last step in its computation
 200 of screen size as follows:
 201 .bP
 202 checks if the \fILINES\fP and \fI\%COLUMNS\fP environment variables
 203 are set to a number greater than zero.
 204 .bP
 205 for each, \fI\%ncurses\fP updates the corresponding environment variable
 206 with the value that it has obtained via operating system call
 207 or from the terminal database.
 208 .bP
 209 \fI\%ncurses\fP re-fetches the value of the environment variables so
 210 that it is still the environment variables which set the screen size.
 211 .PP
 212 The \fB\%use_env\fP and \fB\%use_tioctl\fP routines combine as follows.
 213 .IP
 214 .TS
 215 lB lB lB
 216 lB lB lx.
 217 use_env use_tioctl      Summary
 218 _
 219 TRUE    FALSE   T{
 220 \fI\%ncurses\fP uses operating system calls
 221 unless overridden by \fILINES\fP or \fI\%COLUMNS\fP environment
 222 variables;
 223 default.
 224 T}
 225 TRUE    TRUE    T{
 226 \fI\%ncurses\fP updates \fILINES\fP and \fI\%COLUMNS\fP based on
 227 operating system calls.
 228 T}
 229 FALSE   TRUE    T{
 230 \fI\%ncurses\fP ignores \fILINES\fP and \fI\%COLUMNS\fP,
 231 using operating system calls to obtain size.
 232 T}
 233 .TE
 234 .SS "putwin, getwin"
 235 The \fBputwin\fP routine writes all data associated
 236 with window (or pad) \fIwin\fP into
 237 the file to which \fIfilep\fP points.
 238 This information can be later retrieved
 239 using the \fBgetwin\fP function.
 240 .PP
 241 The \fBgetwin\fP routine reads window related data stored in the file by
 242 \fBputwin\fP.
 243 The routine then creates and initializes a new window using that
 244 data.
 245 It returns a pointer to the new window.
 246 There are a few caveats:
 247 .bP
 248 the data written is a copy of the \fI\%WINDOW\fP structure,
 249 and its associated character cells.
 250 The format differs between the wide-character (\fI\%ncursesw\fP) and
 251 non-wide (\fI\%ncurses\fP) libraries.
 252 You can transfer data between the two, however.
 253 .bP
 254 the retrieved window is always created as a top-level window (or pad),
 255 rather than a subwindow.
 256 .bP
 257 the window's character cells contain the color pair \fIvalue\fP,
 258 but not the actual color \fInumbers\fP.
 259 If cells in the retrieved window use color pairs which have not been
 260 created in the application using \fBinit_pair\fP,
 261 they will not be colored when the window is refreshed.
 262 .SS delay_output
 263 The \fBdelay_output\fP routine inserts an \fIms\fP millisecond pause
 264 in output.
 265 Employ this function judiciously when terminal output uses padding,
 266 because \fI\%ncurses\fP transmits null characters
 267 (consuming CPU and I/O resources)
 268 instead of sleeping and requesting resumption from the operating system.
 269 Padding is used unless:
 270 .bP
 271 the terminal description has \fBnpc\fP (\fBno_pad_char\fP) capability, or
 272 .bP
 273 the environment variable \fB\%NCURSES_NO_PADDING\fP is set.
 274 .PP
 275 If padding is not in use,
 276 \fI\%ncurses\fP uses \fBnapms\fP to perform the delay.
 277 If the value of \fIms\fP exceeds 30,000
 278 (thirty seconds),
 279 it is capped at that value.
 280 .SS flushinp
 281 The \fBflushinp\fP routine throws away any typeahead that has been typed by the
 282 user and has not yet been read by the program.
 283 .SH RETURN VALUE
 284 Except for \fBflushinp\fP, routines that return an integer return \fBERR\fP
 285 upon failure and \fBOK\fP (SVr4 specifies only "an integer value other than
 286 \fBERR\fP") upon successful completion.
 287 .PP
 288 Routines that return pointers return \fBNULL\fP on error.
 289 .PP
 290 X/Open Curses does not specify any error conditions.
 291 In this implementation
 292 .RS 3
 293 .TP 5
 294 \fBflushinp\fP
 295 returns
 296 .B ERR
 297 if the terminal was not initialized.
 298 .TP 5
 299 \fBputwin\fP
 300 returns
 301 .B ERR
 302 if the associated \fBfwrite\fP calls return
 303 .BR ERR "."
 304 .RE
 305 .SH PORTABILITY
 306 .SS filter
 307 The SVr4 documentation describes the action of \fBfilter\fP only in the vaguest
 308 terms.
 309 The description here is adapted from X/Open Curses (which
 310 erroneously fails to describe the disabling of \fBcuu\fP).
 311 .SS "delay_output padding"
 312 The limitation to 30 seconds
 313 and the use of \fBnapms\fP
 314 differ from other implementations.
 315 .bP
 316 SVr4 curses does not delay if no padding character is available.
 317 .bP
 318 NetBSD curses uses \fBnapms\fP when no padding character is available,
 319 but does not take timing into account when using the padding character.
 320 .PP
 321 Neither limits the delay.
 322 .SS keyname
 323 The \fBkeyname\fP function may return the names of user-defined
 324 string capabilities which are defined in the terminfo entry via the \fB\-x\fP
 325 option of \fB@TIC@\fP.
 326 This implementation automatically assigns at run-time key codes to
 327 user-defined strings which begin with \*(``k\*(''.
 328 The key codes start at KEY_MAX, but are not guaranteed to be
 329 the same value for different runs because user-defined codes are
 330 merged from all terminal descriptions which have been loaded.
 331 The \fBuse_extended_names\fP(3X) function controls whether this data is
 332 loaded when the terminal description is read by the library.
 333 .SS "nofilter, use_tioctl"
 334 The \fBnofilter\fP and \fBuse_tioctl\fP routines are specific to
 335 \fI\%ncurses\fP.
 336 They were not supported on Version 7, BSD or System V implementations.
 337 It is recommended that any code depending on \fI\%ncurses\fP extensions
 338 be conditioned using \fBNCURSES_VERSION\fP.
 339 .SS "putwin/getwin file-format"
 340 The \fBputwin\fP and \fBgetwin\fP functions have several issues with
 341 portability:
 342 .bP
 343 The files written and read by these functions
 344 use an implementation-specific format.
 345 Although the format is an obvious target for standardization,
 346 it has been overlooked.
 347 .IP
 348 Interestingly enough, according to the copyright dates in Solaris source,
 349 the functions (along with \fBscr_init\fP, etc.) originated with
 350 the University of California, Berkeley (in 1982)
 351 and were later (in 1988) incorporated into SVr4.
 352 Oddly, there are no such functions in the 4.3BSD curses sources.
 353 .bP
 354 Most implementations simply dump the binary \fI\%WINDOW\fP structure
 355 to the file.
 356 These include SVr4 curses, NetBSD and PDCurses,
 357 as well as older \fI\%ncurses\fP versions.
 358 This implementation
 359 (as well as the X/Open variant of Solaris curses, dated 1995)
 360 uses textual dumps.
 361 .IP
 362 The implementations which use binary dumps use block-I/O
 363 (the \fBfwrite\fP and \fBfread\fP functions).
 364 Those that use textual dumps use buffered-I/O.
 365 A few applications may happen to write extra data in the file using
 366 these functions.
 367 Doing that can run into problems mixing block- and buffered-I/O.
 368 This implementation reduces the problem on writes by flushing the output.
 369 However, reading from a file written using mixed schemes may not be successful.
 370 .SS "unctrl, wunctrl"
 371 X/Open Curses, Issue 4 describes these functions.
 372 It states that \fBunctrl\fP and \fBwunctrl\fP will return a null pointer if
 373 unsuccessful, but does not define any error conditions.
 374 This implementation checks for three cases:
 375 .bP
 376 the parameter is a 7-bit US\-ASCII code.
 377 This is the case that X/Open Curses documented.
 378 .bP
 379 the parameter is in the range 128\-159, i.e., a C1 control code.
 380 If \fBuse_legacy_coding\fP(3X) has been called with a \fB2\fP parameter,
 381 \fBunctrl\fP returns the parameter, i.e., a one-character string with
 382 the parameter as the first character.
 383 Otherwise, it returns \*(``~@\*('', \*(``~A\*('', etc.,
 384 analogous to \*(``^@\*('', \*(``^A\*('', C0 controls.
 385 .IP
 386 X/Open Curses does not document whether \fBunctrl\fP can be called before
 387 initializing curses.
 388 This implementation permits that,
 389 and returns the \*(``~@\*('', etc., values in that case.
 390 .bP
 391 parameter values outside the 0 to 255 range.
 392 \fBunctrl\fP returns a null pointer.
 393 .PP
 394 The strings returned by \fBunctrl\fP in this implementation are determined
 395 at compile time,
 396 showing C1 controls from the upper-128 codes
 397 with a \*(``~\*('' prefix rather than \*(``^\*(''.
 398 Other implementations have different conventions.
 399 For example, they may show both sets of control characters with \*(``^\*('',
 400 and strip the parameter to 7 bits.
 401 Or they may ignore C1 controls and treat all of the upper-128 codes as
 402 printable.
 403 This implementation uses 8 bits but does not modify the string to reflect
 404 locale.
 405 The \fBuse_legacy_coding\fP(3X) function allows the caller to
 406 change the output of \fBunctrl\fP.
 407 .PP
 408 Likewise, the \fBmeta\fP(3X) function allows the caller to change the
 409 output of \fBkeyname\fP, i.e.,
 410 it determines whether to use the \*(``M\-\*('' prefix
 411 for \*(``meta\*('' keys (codes in the range 128 to 255).
 412 Both \fBuse_legacy_coding\fP(3X) and \fBmeta\fP(3X) succeed only after
 413 curses is initialized.
 414 X/Open Curses does not document the treatment of codes 128 to 159.
 415 When treating them as \*(``meta\*('' keys
 416 (or if \fBkeyname\fP is called before initializing curses),
 417 this implementation returns strings \*(``M\-^@\*('', \*(``M\-^A\*('', etc.
 418 .PP
 419 X/Open Curses documents \fBunctrl\fP as declared in \fB<unctrl.h>\fP,
 420 which \fI\%ncurses\fP does.
 421 However, \fI\%ncurses\fP' \fB<curses.h>\fP includes \fB<unctrl.h>\fP,
 422 matching the behavior of SVr4 curses.
 423 Other implementations may not do that.
 424 .SS "use_env, use_tioctl"
 425 If \fI\%ncurses\fP is configured to provide the sp-functions extension,
 426 the state of \fBuse_env\fP and \fBuse_tioctl\fP may be updated before
 427 creating each \fIscreen\fP rather than once only
 428 (\fBcurs_sp_funcs\fP(3X)).
 429 This feature of \fBuse_env\fP
 430 is not provided by other implementations of curses.
 431 .SH SEE ALSO
 432 \fB\%curses\fP(3X),
 433 \fB\%curs_initscr\fP(3X),
 434 \fB\%curs_inopts\fP(3X),
 435 \fB\%curs_kernel\fP(3X),
 436 \fB\%curs_scr_dump\fP(3X),
 437 \fB\%curs_sp_funcs\fP(3X),
 438 \fB\%curs_variables\fP(3X),
 439 \fB\%legacy_coding\fP(3X)