+<!--
+ ****************************************************************************
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: curs_kernel.3x,v 1.29 2020/10/17 23:22:35 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_kernel 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1 class="no-header">curs_kernel 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B> <B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>def_prog_mode</B>, <B>def_shell_mode</B>, <B>reset_prog_mode</B>,
- <B>reset_shell_mode</B>, <B>resetty</B>, <B>savetty</B>, <B>getsyx</B>, <B>setsyx</B>, <B>ripof-</B>
- <B>fline</B>, <B>curs_set</B>, <B>napms</B> - low-level <B>curses</B> routines
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>def_prog_mode</B>, <B>def_shell_mode</B>, <B>reset_prog_mode</B>, <B>reset_shell_mode</B>,
+ <B>resetty</B>, <B>savetty</B>, <B>getsyx</B>, <B>setsyx</B>, <B>ripoffline</B>, <B>curs_set</B>, <B>napms</B> - low-
+ level <B>curses</B> routines
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<B>#include</B> <B><curses.h></B>
<B>int</B> <B>def_prog_mode(void);</B>
<B>int</B> <B>def_shell_mode(void);</B>
+
<B>int</B> <B>reset_prog_mode(void);</B>
<B>int</B> <B>reset_shell_mode(void);</B>
+
<B>int</B> <B>resetty(void);</B>
<B>int</B> <B>savetty(void);</B>
- <B>void</B> <B>getsyx(int</B> <B>y,</B> <B>int</B> <B>x);</B>
- <B>void</B> <B>setsyx(int</B> <B>y,</B> <B>int</B> <B>x);</B>
- <B>int</B> <B>ripoffline(int</B> <B>line,</B> <B>int</B> <B>(*init)(WINDOW</B> <B>*,</B> <B>int));</B>
- <B>int</B> <B>curs_set(int</B> <B>visibility);</B>
- <B>int</B> <B>napms(int</B> <B>ms);</B>
+ <B>void</B> <B>getsyx(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
+ <B>void</B> <B>setsyx(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- The following routines give low-level access to various
- <B>curses</B> capabilities. Theses routines typically are used
- inside library routines.
-
- The <B>def_prog_mode</B> and <B>def_shell_mode</B> routines save the
- current terminal modes as the "program" (in <B>curses</B>) or
- "shell" (not in <B>curses</B>) state for use by the
- <B>reset_prog_mode</B> and <B>reset_shell_mode</B> routines. This is
- done automatically by <B>initscr</B>. There is one such save
- area for each screen context allocated by <B>newterm()</B>.
-
- The <B>reset_prog_mode</B> and <B>reset_shell_mode</B> routines restore
- the terminal to "program" (in <B>curses</B>) or "shell" (out of
- <B>curses</B>) state. These are done automatically by <B>endwin</B>
- and, after an <B>endwin</B>, by <B>doupdate</B>, so they normally are
- not called.
-
- The <B>resetty</B> and <B>savetty</B> routines save and restore the
- state of the terminal modes. <B>savetty</B> saves the current
- state in a buffer and <B>resetty</B> restores the state to what
- it was at the last call to <B>savetty</B>.
-
- The <B>getsyx</B> routine returns the current coordinates of the
- virtual screen cursor in <I>y</I> and <I>x</I>. If <B>leaveok</B> is currently
- <B>TRUE</B>, then <B>-1</B>,<B>-1</B> is returned. If lines have been removed
- from the top of the screen, using <B>ripoffline</B>, <I>y</I> and <I>x</I>
- include these lines; therefore, <I>y</I> and <I>x</I> should be used
- only as arguments for <B>setsyx</B>.
-
- The <B>setsyx</B> routine sets the virtual screen cursor to <I>y</I>, <I>x</I>.
- If <I>y</I> and <I>x</I> are both <B>-1</B>, then <B>leaveok</B> is set. The two rou-
- tines <B>getsyx</B> and <B>setsyx</B> are designed to be used by a
- library routine, which manipulates <B>curses</B> windows but does
- not want to change the current position of the program's
- cursor. The library routine would call <B>getsyx</B> at the
- beginning, do its manipulation of its own windows, do a
- <B>wnoutrefresh</B> on its windows, call <B>setsyx</B>, and then call
- <B>doupdate</B>.
-
- The <B>ripoffline</B> routine provides access to the same facil-
- ity that <B>slk_init</B> [see <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>] uses to reduce the
- size of the screen. <B>ripoffline</B> must be called before
- <B>initscr</B> or <B>newterm</B> is called. If <I>line</I> is positive, a line
- is removed from the top of <B>stdscr</B>; if <I>line</I> is negative, a
- line is removed from the bottom. When this is done inside
- <B>initscr</B>, the routine <B>init</B> (supplied by the user) is called
- with two arguments: a window pointer to the one-line win-
- dow that has been allocated and an integer with the number
- of columns in the window. Inside this initialization rou-
- tine, the integer variables <B>LINES</B> and <B>COLS</B> (defined in
- <B><curses.h></B>) are not guaranteed to be accurate and <B>wrefresh</B>
- or <B>doupdate</B> must not be called. It is allowable to call
- <B>wnoutrefresh</B> during the initialization routine.
-
- <B>ripoffline</B> can be called up to five times before calling
- <B>initscr</B> or <B>newterm</B>.
-
- The <B>curs_set</B> routine sets the cursor state is set to
- invisible, normal, or very visible for <B>visibility</B> equal to
- <B>0</B>, <B>1</B>, or <B>2</B> respectively. If the terminal supports the
- <I>visibility</I> requested, the previous <I>cursor</I> state is
- returned; otherwise, <B>ERR</B> is returned.
+ <B>int</B> <B>ripoffline(int</B> <I>line</I><B>,</B> <B>int</B> <B>(*</B><I>init</I><B>)(WINDOW</B> <B>*,</B> <B>int));</B>
+ <B>int</B> <B>curs_set(int</B> <I>visibility</I><B>);</B>
+ <B>int</B> <B>napms(int</B> <I>ms</I><B>);</B>
- The <B>napms</B> routine is used to sleep for <I>ms</I> milliseconds.
-
-
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- Except for <B>curs_set</B>, these routines always return <B>OK</B>.
- <B>curs_set</B> returns the previous cursor state, or <B>ERR</B> if the
- requested <I>visibility</I> is not supported.
-
-
-</PRE>
-<H2>NOTES</H2><PRE>
- Note that <B>getsyx</B> is a macro, so <B>&</B> is not necessary before
- the variables <I>y</I> and <I>x</I>.
-
- Older SVr4 man pages warn that the return value of
- <B>curs_set</B> "is currently incorrect". This implementation
- gets it right, but it may be unwise to count on the cor-
- rectness of the return value anywhere else.
-
- Both ncurses and SVr4 will call <B>curs_set</B> in <B>endwin</B> if
- <B>curs_set</B> has been called to make the cursor other than
- normal, i.e., either visible or very visible. There is no
- way for ncurses to determine the initial cursor state to
- restore that.
-
-
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- The functions <B>setsyx</B> and <B>getsyx</B> are not described in the
- XSI Curses standard, Issue 4. All other functions are as
- described in XSI Curses.
-
- The SVr4 documentation describes <B>setsyx</B> and <B>getsyx</B> as hav-
- ing return type int. This is misleading, as they are
- macros with no documented semantics for the return value.
-
-
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>,
- <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B>, <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ The following routines give low-level access to various <B>curses</B> capabil-
+ ities. These routines typically are used inside library routines.
+</PRE><H3><a name="h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></H3><PRE>
+ The <B>def_prog_mode</B> and <B>def_shell_mode</B> routines save the current terminal
+ modes as the "program" (in <B>curses</B>) or "shell" (not in <B>curses</B>) state for
+ use by the <B>reset_prog_mode</B> and <B>reset_shell_mode</B> routines. This is done
+ automatically by <B>initscr</B>. There is one such save area for each screen
+ context allocated by <B>newterm</B>.
+</PRE><H3><a name="h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></H3><PRE>
+ The <B>reset_prog_mode</B> and <B>reset_shell_mode</B> routines restore the terminal
+ to "program" (in <B>curses</B>) or "shell" (out of <B>curses</B>) state. These are
+ done automatically by <B><A HREF="curs_initscr.3X.html">endwin(3X)</A></B> and, after an <B>endwin</B>, by <B>doupdate</B>, so
+ they normally are not called.
+</PRE><H3><a name="h3-resetty_-savetty">resetty, savetty</a></H3><PRE>
+ The <B>resetty</B> and <B>savetty</B> routines save and restore the state of the ter-
+ minal modes. <B>savetty</B> saves the current state in a buffer and <B>resetty</B>
+ restores the state to what it was at the last call to <B>savetty</B>.
+</PRE><H3><a name="h3-getsyx">getsyx</a></H3><PRE>
+ The <B>getsyx</B> routine returns the current coordinates of the <I>virtual</I>
+ <I>screen</I> cursor in <I>y</I> and <I>x</I>. If <B>leaveok</B> is currently <B>TRUE</B>, then <B>-1</B>,<B>-1</B> is
+ returned. If lines have been removed from the top of the screen, using
+ <B>ripoffline</B>, <I>y</I> and <I>x</I> include these lines; therefore, <I>y</I> and <I>x</I> should be
+ used only as arguments for <B>setsyx</B>.
+ Few applications will use this feature, most use <B>getyx</B> instead.
+</PRE><H3><a name="h3-setsyx">setsyx</a></H3><PRE>
+ The <B>setsyx</B> routine sets the <I>virtual</I> <I>screen</I> cursor to <I>y</I>, <I>x</I>. If <I>y</I> and <I>x</I>
+ are both <B>-1</B>, then <B>leaveok</B> is set. The two routines <B>getsyx</B> and <B>setsyx</B>
+ are designed to be used by a library routine, which manipulates <B>curses</B>
+ windows but does not want to change the current position of the pro-
+ gram's cursor. The library routine would call <B>getsyx</B> at the beginning,
+ do its manipulation of its own windows, do a <B>wnoutrefresh</B> on its win-
+ dows, call <B>setsyx</B>, and then call <B>doupdate</B>.
+ Few applications will use this feature, most use <B>wmove</B> instead.
+</PRE><H3><a name="h3-ripoffline">ripoffline</a></H3><PRE>
+ The <B>ripoffline</B> routine provides access to the same facility that
+ <B>slk_init</B> [see <B><A HREF="curs_slk.3X.html">curs_slk(3X)</A></B>] uses to reduce the size of the screen.
+ <B>ripoffline</B> must be called before <B>initscr</B> or <B>newterm</B> is called, to pre-
+ pare these initial actions:
+ <B>o</B> If <I>line</I> is positive, a line is removed from the top of <B>stdscr</B>.
+ <B>o</B> if <I>line</I> is negative, a line is removed from the bottom.
+ When the resulting initialization is done inside <B>initscr</B>, the routine
+ <B>init</B> (supplied by the user) is called with two arguments:
+ <B>o</B> a window pointer to the one-line window that has been allocated and
+ <B>o</B> an integer with the number of columns in the window.
+ Inside this initialization routine, the integer variables <B>LINES</B> and
+ <B>COLS</B> (defined in <B><curses.h></B>) are not guaranteed to be accurate and <B>wre-</B>
+ <B>fresh</B> or <B>doupdate</B> must not be called. It is allowable to call <B>wnoutre-</B>
+ <B>fresh</B> during the initialization routine.
+ <B>ripoffline</B> can be called up to five times before calling <B>initscr</B> or
+ <B>newterm</B>.
+</PRE><H3><a name="h3-curs_set">curs_set</a></H3><PRE>
+ The <B>curs_set</B> routine sets the cursor state to invisible, normal, or
+ very visible for <B>visibility</B> equal to <B>0</B>, <B>1</B>, or <B>2</B> respectively. If the
+ terminal supports the <I>visibility</I> requested, the previous <I>cursor</I> state
+ is returned; otherwise, <B>ERR</B> is returned.
+</PRE><H3><a name="h3-napms">napms</a></H3><PRE>
+ The <B>napms</B> routine is used to sleep for <I>ms</I> milliseconds.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Except for <B>curs_set</B>, these routines always return <B>OK</B>.
+ <B>curs_set</B> returns the previous cursor state, or <B>ERR</B> if the requested
+ <I>visibility</I> is not supported.
+ X/Open defines no error conditions. In this implementation
+ <B>def_prog_mode</B>, <B>def_shell_mode</B>, <B>reset_prog_mode</B>, <B>reset_shell_mode</B>
+ return an error if the terminal was not initialized, or if the I/O
+ call to obtain the terminal settings fails.
+ <B>ripoffline</B>
+ returns an error if the maximum number of ripped-off lines exceeds
+ the maximum (NRIPS = 5).
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ Note that <B>getsyx</B> is a macro, so <B>&</B> is not necessary before the variables
+ <I>y</I> and <I>x</I>.
+ Older SVr4 man pages warn that the return value of <B>curs_set</B> "is cur-
+ rently incorrect". This implementation gets it right, but it may be
+ unwise to count on the correctness of the return value anywhere else.
+ Both ncurses and SVr4 will call <B>curs_set</B> in <B>endwin</B> if <B>curs_set</B> has been
+ called to make the cursor other than normal, i.e., either invisible or
+ very visible. There is no way for ncurses to determine the initial
+ cursor state to restore that.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ The <I>virtual</I> <I>screen</I> functions <B>setsyx</B> and <B>getsyx</B> are not described in the
+ XSI Curses standard, Issue 4. All other functions are as described in
+ XSI Curses.
+ The SVr4 documentation describes <B>setsyx</B> and <B>getsyx</B> as having return
+ type int. This is misleading, as they are macros with no documented
+ semantics for the return value.
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_initscr.3X.html">curs_initscr(3X)</A></B>, <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>, <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>,
+ <B><A HREF="curs_scr_dump.3X.html">curs_scr_dump(3X)</A></B>, <B><A HREF="curs_slk.3X.html">curs_slk(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>.
+ <B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></li>
+<li><a href="#h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></li>
+<li><a href="#h3-resetty_-savetty">resetty, savetty</a></li>
+<li><a href="#h3-getsyx">getsyx</a></li>
+<li><a href="#h3-setsyx">setsyx</a></li>
+<li><a href="#h3-ripoffline">ripoffline</a></li>
+<li><a href="#h3-curs_set">curs_set</a></li>
+<li><a href="#h3-napms">napms</a></li>
+</ul>
+</li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff