ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_kernel.3x.html
1 <!-- 
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   * @Id: curs_kernel.3x,v 1.28 2020/02/02 23:34:34 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_kernel 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_kernel 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>                                                <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, <STRONG>reset_shell_mode</STRONG>,
51        <STRONG>resetty</STRONG>, <STRONG>savetty</STRONG>, <STRONG>getsyx</STRONG>, <STRONG>setsyx</STRONG>, <STRONG>ripoffline</STRONG>, <STRONG>curs_set</STRONG>, <STRONG>napms</STRONG> - low-
52        level <STRONG>curses</STRONG> routines
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>def_prog_mode(void);</STRONG>
59        <STRONG>int</STRONG> <STRONG>def_shell_mode(void);</STRONG>
60        <STRONG>int</STRONG> <STRONG>reset_prog_mode(void);</STRONG>
61        <STRONG>int</STRONG> <STRONG>reset_shell_mode(void);</STRONG>
62        <STRONG>int</STRONG> <STRONG>resetty(void);</STRONG>
63        <STRONG>int</STRONG> <STRONG>savetty(void);</STRONG>
64        <STRONG>void</STRONG> <STRONG>getsyx(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
65        <STRONG>void</STRONG> <STRONG>setsyx(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
66        <STRONG>int</STRONG> <STRONG>ripoffline(int</STRONG> <EM>line</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>init</EM><STRONG>)(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int));</STRONG>
67        <STRONG>int</STRONG> <STRONG>curs_set(int</STRONG> <EM>visibility</EM><STRONG>);</STRONG>
68        <STRONG>int</STRONG> <STRONG>napms(int</STRONG> <EM>ms</EM><STRONG>);</STRONG>
69
70
71 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
72        The following routines give low-level access to various <STRONG>curses</STRONG> capabil-
73        ities.  These routines typically are used inside library routines.
74
75
76 </PRE><H3><a name="h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></H3><PRE>
77        The <STRONG>def_prog_mode</STRONG> and <STRONG>def_shell_mode</STRONG> routines save the current terminal
78        modes as the "program" (in <STRONG>curses</STRONG>) or "shell" (not in <STRONG>curses</STRONG>) state for
79        use by the <STRONG>reset_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines.  This is done
80        automatically  by <STRONG>initscr</STRONG>.  There is one such save area for each screen
81        context allocated by <STRONG>newterm</STRONG>.
82
83
84 </PRE><H3><a name="h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></H3><PRE>
85        The <STRONG>reset_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines restore the  terminal
86        to  "program"  (in <STRONG>curses</STRONG>) or "shell" (out of <STRONG>curses</STRONG>) state.  These are
87        done automatically by <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> and, after an <STRONG>endwin</STRONG>, by <STRONG>doupdate</STRONG>,  so
88        they normally are not called.
89
90
91 </PRE><H3><a name="h3-resetty_-savetty">resetty, savetty</a></H3><PRE>
92        The <STRONG>resetty</STRONG> and <STRONG>savetty</STRONG> routines save and restore the state of the ter-
93        minal modes.  <STRONG>savetty</STRONG> saves the current state in a buffer  and  <STRONG>resetty</STRONG>
94        restores the state to what it was at the last call to <STRONG>savetty</STRONG>.
95
96
97 </PRE><H3><a name="h3-getsyx">getsyx</a></H3><PRE>
98        The  <STRONG>getsyx</STRONG>  routine  returns  the  current  coordinates of the <EM>virtual</EM>
99        <EM>screen</EM> cursor in <EM>y</EM> and <EM>x</EM>.  If <STRONG>leaveok</STRONG> is currently <STRONG>TRUE</STRONG>, then <STRONG>-1</STRONG>,<STRONG>-1</STRONG>  is
100        returned.  If lines have been removed from the top of the screen, using
101        <STRONG>ripoffline</STRONG>, <EM>y</EM> and <EM>x</EM> include these lines; therefore, <EM>y</EM> and <EM>x</EM>  should  be
102        used only as arguments for <STRONG>setsyx</STRONG>.
103
104        Few applications will use this feature, most use <STRONG>getyx</STRONG> instead.
105
106
107 </PRE><H3><a name="h3-setsyx">setsyx</a></H3><PRE>
108        The  <STRONG>setsyx</STRONG> routine sets the <EM>virtual</EM> <EM>screen</EM> cursor to <EM>y</EM>, <EM>x</EM>.  If <EM>y</EM> and <EM>x</EM>
109        are both <STRONG>-1</STRONG>, then <STRONG>leaveok</STRONG> is set.  The two routines <STRONG>getsyx</STRONG>  and  <STRONG>setsyx</STRONG>
110        are  designed to be used by a library routine, which manipulates <STRONG>curses</STRONG>
111        windows but does not want to change the current position  of  the  pro-
112        gram's cursor.  The library routine would call <STRONG>getsyx</STRONG> at the beginning,
113        do its manipulation of its own windows, do a <STRONG>wnoutrefresh</STRONG> on  its  win-
114        dows, call <STRONG>setsyx</STRONG>, and then call <STRONG>doupdate</STRONG>.
115
116        Few applications will use this feature, most use <STRONG>wmove</STRONG> instead.
117
118
119 </PRE><H3><a name="h3-ripoffline">ripoffline</a></H3><PRE>
120        The  <STRONG>ripoffline</STRONG>  routine  provides  access  to  the  same facility that
121        <STRONG>slk_init</STRONG> [see <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>] uses to reduce  the  size  of  the  screen.
122        <STRONG>ripoffline</STRONG>  must be called before <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> is called, to pre-
123        pare these initial actions:
124
125        <STRONG>o</STRONG>   If <EM>line</EM> is positive, a line is removed from the top of <STRONG>stdscr</STRONG>.
126
127        <STRONG>o</STRONG>   if <EM>line</EM> is negative, a line is removed from the bottom.
128
129        When the resulting initialization is done inside <STRONG>initscr</STRONG>,  the  routine
130        <STRONG>init</STRONG> (supplied by the user) is called with two arguments:
131
132        <STRONG>o</STRONG>   a window pointer to the one-line window that has been allocated and
133
134        <STRONG>o</STRONG>   an integer with the number of columns in the window.
135
136        Inside  this  initialization  routine,  the integer variables <STRONG>LINES</STRONG> and
137        <STRONG>COLS</STRONG> (defined in <STRONG>&lt;curses.h&gt;</STRONG>) are not guaranteed to be accurate and <STRONG>wre-</STRONG>
138        <STRONG>fresh</STRONG> or <STRONG>doupdate</STRONG> must not be called.  It is allowable to call <STRONG>wnoutre-</STRONG>
139        <STRONG>fresh</STRONG> during the initialization routine.
140
141        <STRONG>ripoffline</STRONG> can be called up to five times  before  calling  <STRONG>initscr</STRONG>  or
142        <STRONG>newterm</STRONG>.
143
144
145 </PRE><H3><a name="h3-curs_set">curs_set</a></H3><PRE>
146        The  <STRONG>curs_set</STRONG>  routine  sets  the cursor state to invisible, normal, or
147        very visible for <STRONG>visibility</STRONG> equal to <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG> respectively.   If  the
148        terminal  supports  the <EM>visibility</EM> requested, the previous <EM>cursor</EM> state
149        is returned; otherwise, <STRONG>ERR</STRONG> is returned.
150
151
152 </PRE><H3><a name="h3-napms">napms</a></H3><PRE>
153        The <STRONG>napms</STRONG> routine is used to sleep for <EM>ms</EM> milliseconds.
154
155
156 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
157        Except for <STRONG>curs_set</STRONG>, these routines always return <STRONG>OK</STRONG>.
158
159        <STRONG>curs_set</STRONG> returns the previous cursor state, or  <STRONG>ERR</STRONG>  if  the  requested
160        <EM>visibility</EM> is not supported.
161
162        X/Open defines no error conditions.  In this implementation
163
164        <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, <STRONG>reset_shell_mode</STRONG>
165             return an error if the terminal was not initialized, or if the I/O
166             call to obtain the terminal settings fails.
167
168        <STRONG>ripoffline</STRONG>
169             returns an error if the maximum number of ripped-off lines exceeds
170             the maximum (NRIPS = 5).
171
172
173 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
174        Note that <STRONG>getsyx</STRONG> is a macro, so <STRONG>&amp;</STRONG> is not necessary before the variables
175        <EM>y</EM> and <EM>x</EM>.
176
177        Older SVr4 man pages warn that the return value of  <STRONG>curs_set</STRONG>  "is  cur-
178        rently  incorrect".   This  implementation gets it right, but it may be
179        unwise to count on the correctness of the return value anywhere else.
180
181        Both ncurses and SVr4 will call <STRONG>curs_set</STRONG> in <STRONG>endwin</STRONG> if <STRONG>curs_set</STRONG> has been
182        called  to make the cursor other than normal, i.e., either invisible or
183        very visible.  There is no way for ncurses  to  determine  the  initial
184        cursor state to restore that.
185
186
187 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
188        The <EM>virtual</EM> <EM>screen</EM> functions <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> are not described in the
189        XSI Curses standard, Issue 4.  All other functions are as described  in
190        XSI Curses.
191
192        The  SVr4  documentation  describes  <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> as having return
193        type int.  This is misleading, as they are macros  with  no  documented
194        semantics for the return value.
195
196
197 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
198        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,   <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,   <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>,   <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
199        <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
200
201
202
203                                                                <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
204 </PRE>
205 <div class="nav">
206 <ul>
207 <li><a href="#h2-NAME">NAME</a></li>
208 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
209 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
210 <ul>
211 <li><a href="#h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></li>
212 <li><a href="#h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></li>
213 <li><a href="#h3-resetty_-savetty">resetty, savetty</a></li>
214 <li><a href="#h3-getsyx">getsyx</a></li>
215 <li><a href="#h3-setsyx">setsyx</a></li>
216 <li><a href="#h3-ripoffline">ripoffline</a></li>
217 <li><a href="#h3-curs_set">curs_set</a></li>
218 <li><a href="#h3-napms">napms</a></li>
219 </ul>
220 </li>
221 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
222 <li><a href="#h2-NOTES">NOTES</a></li>
223 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
224 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
225 </ul>
226 </div>
227 </BODY>
228 </HTML>