2 ****************************************************************************
3 * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * @Id: curs_kernel.3x,v 1.23 2017/11/18 23:47:37 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_kernel 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">curs_kernel 3x</H1>
43 <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, <STRONG>reset_shell_mode</STRONG>,
50 <STRONG>resetty</STRONG>, <STRONG>savetty</STRONG>, <STRONG>getsyx</STRONG>, <STRONG>setsyx</STRONG>, <STRONG>ripoffline</STRONG>, <STRONG>curs_set</STRONG>, <STRONG>napms</STRONG> - low-
51 level <STRONG>curses</STRONG> routines
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>def_prog_mode(void);</STRONG>
58 <STRONG>int</STRONG> <STRONG>def_shell_mode(void);</STRONG>
59 <STRONG>int</STRONG> <STRONG>reset_prog_mode(void);</STRONG>
60 <STRONG>int</STRONG> <STRONG>reset_shell_mode(void);</STRONG>
61 <STRONG>int</STRONG> <STRONG>resetty(void);</STRONG>
62 <STRONG>int</STRONG> <STRONG>savetty(void);</STRONG>
63 <STRONG>void</STRONG> <STRONG>getsyx(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
64 <STRONG>void</STRONG> <STRONG>setsyx(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
65 <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>
66 <STRONG>int</STRONG> <STRONG>curs_set(int</STRONG> <EM>visibility</EM><STRONG>);</STRONG>
67 <STRONG>int</STRONG> <STRONG>napms(int</STRONG> <EM>ms</EM><STRONG>);</STRONG>
70 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
71 The following routines give low-level access to various <STRONG>curses</STRONG> capabil-
72 ities. These routines typically are used inside library routines.
75 </PRE><H3><a name="h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></H3><PRE>
76 The <STRONG>def_prog_mode</STRONG> and <STRONG>def_shell_mode</STRONG> routines save the current terminal
77 modes as the "program" (in <STRONG>curses</STRONG>) or "shell" (not in <STRONG>curses</STRONG>) state for
78 use by the <STRONG>reset_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines. This is done
79 automatically by <STRONG>initscr</STRONG>. There is one such save area for each screen
80 context allocated by <STRONG>newterm</STRONG>.
83 </PRE><H3><a name="h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></H3><PRE>
84 The <STRONG>reset_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines restore the terminal
85 to "program" (in <STRONG>curses</STRONG>) or "shell" (out of <STRONG>curses</STRONG>) state. These are
86 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
87 they normally are not called.
90 </PRE><H3><a name="h3-resetty_-savetty">resetty, savetty</a></H3><PRE>
91 The <STRONG>resetty</STRONG> and <STRONG>savetty</STRONG> routines save and restore the state of the ter-
92 minal modes. <STRONG>savetty</STRONG> saves the current state in a buffer and <STRONG>resetty</STRONG>
93 restores the state to what it was at the last call to <STRONG>savetty</STRONG>.
96 </PRE><H3><a name="h3-getsyx">getsyx</a></H3><PRE>
97 The <STRONG>getsyx</STRONG> routine returns the current coordinates of the virtual
98 screen 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
99 returned. If lines have been removed from the top of the screen, using
100 <STRONG>ripoffline</STRONG>, <EM>y</EM> and <EM>x</EM> include these lines; therefore, <EM>y</EM> and <EM>x</EM> should be
101 used only as arguments for <STRONG>setsyx</STRONG>.
104 </PRE><H3><a name="h3-setsyx">setsyx</a></H3><PRE>
105 The <STRONG>setsyx</STRONG> routine sets the virtual screen cursor to <EM>y</EM>, <EM>x</EM>. If <EM>y</EM> and <EM>x</EM>
106 are both <STRONG>-1</STRONG>, then <STRONG>leaveok</STRONG> is set. The two routines <STRONG>getsyx</STRONG> and <STRONG>setsyx</STRONG>
107 are designed to be used by a library routine, which manipulates <STRONG>curses</STRONG>
108 windows but does not want to change the current position of the pro-
109 gram's cursor. The library routine would call <STRONG>getsyx</STRONG> at the beginning,
110 do its manipulation of its own windows, do a <STRONG>wnoutrefresh</STRONG> on its win-
111 dows, call <STRONG>setsyx</STRONG>, and then call <STRONG>doupdate</STRONG>.
114 </PRE><H3><a name="h3-ripoffline">ripoffline</a></H3><PRE>
115 The <STRONG>ripoffline</STRONG> routine provides access to the same facility that
116 <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.
117 <STRONG>ripoffline</STRONG> must be called before <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> is called, to pre-
118 pare these initial actions:
120 <STRONG>o</STRONG> If <EM>line</EM> is positive, a line is removed from the top of <STRONG>stdscr</STRONG>.
122 <STRONG>o</STRONG> if <EM>line</EM> is negative, a line is removed from the bottom.
124 When the resulting initialization is done inside <STRONG>initscr</STRONG>, the routine
125 <STRONG>init</STRONG> (supplied by the user) is called with two arguments:
127 <STRONG>o</STRONG> a window pointer to the one-line window that has been allocated and
129 <STRONG>o</STRONG> an integer with the number of columns in the window.
131 Inside this initialization routine, the integer variables <STRONG>LINES</STRONG> and
132 <STRONG>COLS</STRONG> (defined in <STRONG><curses.h></STRONG>) are not guaranteed to be accurate and <STRONG>wre-</STRONG>
133 <STRONG>fresh</STRONG> or <STRONG>doupdate</STRONG> must not be called. It is allowable to call <STRONG>wnoutre-</STRONG>
134 <STRONG>fresh</STRONG> during the initialization routine.
136 <STRONG>ripoffline</STRONG> can be called up to five times before calling <STRONG>initscr</STRONG> or
137 <STRONG>newterm</STRONG>.
140 </PRE><H3><a name="h3-curs_set">curs_set</a></H3><PRE>
141 The <STRONG>curs_set</STRONG> routine sets the cursor state to invisible, normal, or
142 very visible for <STRONG>visibility</STRONG> equal to <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG> respectively. If the
143 terminal supports the <EM>visibility</EM> requested, the previous <EM>cursor</EM> state
144 is returned; otherwise, <STRONG>ERR</STRONG> is returned.
147 </PRE><H3><a name="h3-napms">napms</a></H3><PRE>
148 The <STRONG>napms</STRONG> routine is used to sleep for <EM>ms</EM> milliseconds.
151 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
152 Except for <STRONG>curs_set</STRONG>, these routines always return <STRONG>OK</STRONG>.
154 <STRONG>curs_set</STRONG> returns the previous cursor state, or <STRONG>ERR</STRONG> if the requested
155 <EM>visibility</EM> is not supported.
157 X/Open defines no error conditions. In this implementation
159 <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, <STRONG>reset_shell_mode</STRONG>
160 return an error if the terminal was not initialized, or if the I/O
161 call to obtain the terminal settings fails.
163 <STRONG>ripoffline</STRONG>
164 returns an error if the maximum number of ripped-off lines exceeds
165 the maximum (NRIPS = 5).
168 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
169 Note that <STRONG>getsyx</STRONG> is a macro, so <STRONG>&</STRONG> is not necessary before the variables
170 <EM>y</EM> and <EM>x</EM>.
172 Older SVr4 man pages warn that the return value of <STRONG>curs_set</STRONG> "is cur-
173 rently incorrect". This implementation gets it right, but it may be
174 unwise to count on the correctness of the return value anywhere else.
176 Both ncurses and SVr4 will call <STRONG>curs_set</STRONG> in <STRONG>endwin</STRONG> if <STRONG>curs_set</STRONG> has been
177 called to make the cursor other than normal, i.e., either invisible or
178 very visible. There is no way for ncurses to determine the initial
179 cursor state to restore that.
182 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
183 The functions <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> are not described in the XSI Curses
184 standard, Issue 4. All other functions are as described in XSI Curses.
186 The SVr4 documentation describes <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> as having return
187 type int. This is misleading, as they are macros with no documented se-
188 mantics for the return value.
191 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
192 <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>,
193 <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>.
197 <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
201 <li><a href="#h2-NAME">NAME</a></li>
202 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
203 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
205 <li><a href="#h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></li>
206 <li><a href="#h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></li>
207 <li><a href="#h3-resetty_-savetty">resetty, savetty</a></li>
208 <li><a href="#h3-getsyx">getsyx</a></li>
209 <li><a href="#h3-setsyx">setsyx</a></li>
210 <li><a href="#h3-ripoffline">ripoffline</a></li>
211 <li><a href="#h3-curs_set">curs_set</a></li>
212 <li><a href="#h3-napms">napms</a></li>
215 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
216 <li><a href="#h2-NOTES">NOTES</a></li>
217 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
218 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>