man/curs_initscr.3x

   1 .\"***************************************************************************
   2 .\" Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
   3 .\"                                                                          *
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   5 .\" copy of this software and associated documentation files (the            *
   6 .\" "Software"), to deal in the Software without restriction, including      *
   7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
   9 .\" copies of the Software, and to permit persons to whom the Software is    *
  10 .\" furnished to do so, subject to the following conditions:                 *
  11 .\"                                                                          *
  12 .\" The above copyright notice and this permission notice shall be included  *
  13 .\" in all copies or substantial portions of the Software.                   *
  14 .\"                                                                          *
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22 .\"                                                                          *
  23 .\" Except as contained in this notice, the name(s) of the above copyright   *
  24 .\" holders shall not be used in advertising or otherwise to promote the     *
  25 .\" sale, use or other dealings in this Software without prior written       *
  26 .\" authorization.                                                           *
  27 .\"***************************************************************************
  28 .\"
  29 .\" $Id: curs_initscr.3x,v 1.30 2018/04/07 20:54:12 tom Exp $
  30 .TH curs_initscr 3X ""
  31 .de bP
  32 .ie n  .IP \(bu 4
  33 .el    .IP \(bu 2
  34 ..
  35 .ie \n(.g .ds `` \(lq
  36 .el       .ds `` ``
  37 .ie \n(.g .ds '' \(rq
  38 .el       .ds '' ''
  39 .na
  40 .hy 0
  41 .SH NAME
  42 \fBinitscr\fR,
  43 \fBnewterm\fR,
  44 \fBendwin\fR,
  45 \fBisendwin\fR,
  46 \fBset_term\fR,
  47 \fBdelscreen\fR \- \fBcurses\fR screen initialization and manipulation routines
  48 .ad
  49 .hy
  50 .SH SYNOPSIS
  51 \fB#include <curses.h>\fR
  52 .sp
  53 \fBWINDOW *initscr(void);\fR
  54 .br
  55 \fBint endwin(void);\fR
  56 .br
  57 \fBbool isendwin(void);\fR
  58 .br
  59 \fBSCREEN *newterm(const char *\fP\fItype\fP\fB, FILE *\fP\fIoutfd\fP\fB, FILE *\fP\fIinfd\fP\fB);\fR
  60 .br
  61 \fBSCREEN *set_term(SCREEN *\fP\fInew\fP\fB);\fR
  62 .br
  63 \fBvoid delscreen(SCREEN* \fP\fIsp\fP\fB);\fR
  64 .br
  65 .SH DESCRIPTION
  66 .SS initscr
  67 \fBinitscr\fR is normally the first \fBcurses\fR routine to call when
  68 initializing a program.
  69 A few special routines sometimes need to be called before it;
  70 these are \fBslk_init\fR(3X), \fBfilter\fR, \fBripoffline\fR,
  71 \fBuse_env\fR.
  72 For multiple-terminal applications,
  73 \fBnewterm\fR may be called before \fBinitscr\fR.
  74 .PP
  75 The initscr code determines the terminal type and initializes all \fBcurses\fR
  76 data structures.
  77 \fBinitscr\fR also causes the first call to \fBrefresh\fR(3X) to clear the screen.
  78 If errors occur, \fBinitscr\fR writes an appropriate error
  79 message to standard error and exits;
  80 otherwise, a pointer is returned to \fBstdscr\fR.
  81 .SS newterm
  82 .PP
  83 A program that outputs to more than one terminal should use the \fBnewterm\fR
  84 routine for each terminal instead of \fBinitscr\fR.
  85 A program that needs to inspect capabilities,
  86 so it can continue to run in a line-oriented mode if the
  87 terminal cannot support a screen-oriented program, would also use
  88 \fBnewterm\fR.
  89 The routine \fBnewterm\fR should be called once for each terminal.
  90 It returns a variable of type \fBSCREEN *\fR which should be saved
  91 as a reference to that terminal.
  92 \fBnewterm\fP's arguments are
  93 .bP
  94 the \fItype\fR of the terminal to be used in place of \fB$TERM\fR,
  95 .bP
  96 a file pointer for output to the terminal, and
  97 .bP
  98 another file pointer for input from the terminal
  99 .PP
 100 If the \fItype\fR parameter is \fBNULL\fR, \fB$TERM\fR will be used.
 101 .SS endwin
 102 .PP
 103 The program must also call
 104 \fBendwin\fR for each terminal being used before exiting from \fBcurses\fR.
 105 If \fBnewterm\fR is called more than once for the same terminal, the first
 106 terminal referred to must be the last one for which \fBendwin\fR is called.
 107 .PP
 108 A program should always call \fBendwin\fR before exiting or escaping from
 109 \fBcurses\fR mode temporarily.
 110 This routine
 111 .bP
 112 resets colors to correspond with the default color pair 0,
 113 .bP
 114 moves the cursor to the lower left-hand corner of the screen,
 115 .bP
 116 clears the remainder of the line so that it uses the default colors,
 117 .bP
 118 sets the cursor to normal visibility (see \fBcurs_set\fP(3X)),
 119 .bP
 120 stops cursor-addressing mode using the \fIexit_ca_mode\fP terminal capability,
 121 .bP
 122 restores tty modes (see \fBreset_shell_mode\fP(3X)).
 123 .PP
 124 Calling \fBrefresh\fR(3X) or \fBdoupdate\fR(3X) after a
 125 temporary escape causes the program to resume visual mode.
 126 .SS isendwin
 127 .PP
 128 The \fBisendwin\fR routine returns \fBTRUE\fR if \fBendwin\fR has been
 129 called without any subsequent calls to \fBwrefresh\fR,
 130 and \fBFALSE\fR otherwise.
 131 .SS set_term
 132 .PP
 133 The \fBset_term\fR routine is used to switch between different terminals.
 134 The screen reference \fBnew\fR becomes the new current terminal.
 135 The previous terminal is returned by the routine.
 136 This is the only routine which manipulates \fBSCREEN\fR pointers;
 137 all other routines affect only the current terminal.
 138 .SS delscreen
 139 .PP
 140 The \fBdelscreen\fR routine frees storage associated with the
 141 \fBSCREEN\fR data structure.
 142 The \fBendwin\fR routine does not do
 143 this, so \fBdelscreen\fR should be called after \fBendwin\fR if a
 144 particular \fBSCREEN\fR is no longer needed.
 145 .SH RETURN VALUE
 146 \fBendwin\fR returns the integer \fBERR\fR upon failure and \fBOK\fR
 147 upon successful completion.
 148 .PP
 149 Routines that return pointers always return \fBNULL\fR on error.
 150 .PP
 151 X/Open defines no error conditions.
 152 In this implementation
 153 .bP
 154 \fBendwin\fP returns an error if the terminal was not initialized.
 155 .bP
 156 \fBnewterm\fP
 157 returns an error if it cannot allocate the data structures for the screen,
 158 or for the top-level windows within the screen,
 159 i.e.,
 160 \fBcurscr\fP, \fBnewscr\fP, or \fBstdscr\fP.
 161 .bP
 162 \fBset_term\fP
 163 returns no error.
 164 .SH PORTABILITY
 165 These functions were described in the XSI Curses standard, Issue 4.
 166 As of 2015, the current document is X/Open Curses, Issue 7.
 167 .SS Differences
 168 X/Open specifies that portable applications must not
 169 call \fBinitscr\fR more than once:
 170 .bP
 171 The portable way to use \fBinitscr\fP is once only,
 172 using \fBrefresh\fP (see curs_refresh(3X)) to restore the screen after \fBendwin\fP.
 173 .bP
 174 This implementation allows using \fBinitscr\fP after \fBendwin\fP.
 175 .PP
 176 Old versions of curses, e.g., BSD 4.4, may have returned a null pointer
 177 from \fBinitscr\fR when an error is detected, rather than exiting.
 178 It is safe but redundant to check the return value of \fBinitscr\fR
 179 in XSI Curses.
 180 .SS Unset TERM Variable
 181 .PP
 182 If the TERM variable is missing or empty, \fBinitscr\fP uses the
 183 value \*(``unknown\*('',
 184 which normally corresponds to a terminal entry with the \fIgeneric\fP
 185 (\fIgn\fP) capability.
 186 Generic entries are detected by \fBsetupterm\fP (see curs_terminfo(3X)) and cannot be
 187 used for full-screen operation.
 188 Other implementations may handle a missing/empty TERM variable differently.
 189 .SS Signal Handlers
 190 .PP
 191 Quoting from X/Open Curses, section 3.1.1:
 192 .RS 5
 193 .PP
 194 \fICurses implementations may provide for special handling of the \fBSIGINT\fP,
 195 \fBSIGQUIT\fP and \fBSIGTSTP\fP signals
 196 if their disposition is \fBSIG_DFL\fP at the time
 197 \fBinitscr\fP is called \fP...
 198 .PP
 199 \fIAny special handling for these signals may remain in effect for the
 200 life of the process or until the process changes the disposition of
 201 the signal.\fP
 202 .PP
 203 \fINone of the Curses functions are required to be safe with respect to signals \fP...
 204 .RE
 205 .PP
 206 This implementation establishes signal handlers during initialization,
 207 e.g., \fBinitscr\fP or \fBnewterm\fP.
 208 Applications which must handle these signals should set up the corresponding
 209 handlers \fIafter\fP initializing the library:
 210 .TP 5
 211 .B SIGINT
 212 The handler \fIattempts\fP to cleanup the screen on exit.
 213 Although it \fIusually\fP works as expected, there are limitations:
 214 .RS 5
 215 .bP
 216 Walking the \fBSCREEN\fP list is unsafe, since all list management
 217 is done without any signal blocking.
 218 .bP
 219 On systems which have \fBREENTRANT\fP turned on, \fBset_term\fP uses
 220 functions which could deadlock or misbehave in other ways.
 221 .bP
 222 \fBendwin\fP calls other functions, many of which use stdio or
 223 other library functions which are clearly unsafe.
 224 .RE
 225 .TP 5
 226 .B SIGTERM
 227 This uses the same handler as \fBSIGINT\fP, with the same limitations.
 228 It is not mentioned in X/Open Curses, but is more suitable for this
 229 purpose than \fBSIGQUIT\fP (which is used in debugging).
 230 .TP 5
 231 .B SIGTSTP
 232 This handles the \fIstop\fP signal, used in job control.
 233 When resuming the process, this implementation discards pending
 234 input with \fBflushinput\fP (see curs_util(3X)), and repaints the screen
 235 assuming that it has been completely altered.
 236 It also updates the saved terminal modes with \fBdef_shell_mode\fP (see curs_kernel(3X)).
 237 .TP 5
 238 .B SIGWINCH
 239 This handles the window-size changes which were ignored in
 240 the standardization efforts.
 241 The handler sets a (signal-safe) variable
 242 which is later tested in \fBwgetch\fP (see curs_getch(3X)).
 243 If \fBkeypad\fP has been enabled for the corresponding window,
 244 \fBwgetch\fP returns the key symbol \fBKEY_RESIZE\fP.
 245 At the same time, \fBwgetch\fP calls \fBresizeterm\fP to adjust the
 246 standard screen \fBstdscr\fP,
 247 and update other data such as \fBLINES\fP and \fBCOLS\fP.
 248 .SH SEE ALSO
 249 \fBcurses\fR(3X),
 250 \fBcurs_kernel\fR(3X),
 251 \fBcurs_refresh\fR(3X),
 252 \fBcurs_slk\fR(3X),
 253 \fBcurs_terminfo\fR(3X),
 254 \fBcurs_util\fR(3X),
 255 \fBcurs_variables\fR(3X).