1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_util.3x,v 1.11 2003/07/19 19:59:56 tom Exp @
34 <TITLE>curs_util 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
50 <STRONG>delay_output</STRONG>, <STRONG>filter</STRONG>, <STRONG>flushinp</STRONG>, <STRONG>getwin</STRONG>, <STRONG>key_name</STRONG>, <STRONG>keyname</STRONG>,
51 <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>wunctrl</STRONG> - miscellaneous <STRONG>curses</STRONG>
56 <H2>SYNOPSIS</H2><PRE>
57 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
59 <STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG>
60 <STRONG>char</STRONG> <STRONG>*wunctrl(cchar_t</STRONG> <STRONG>*c);</STRONG>
61 <STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <STRONG>c);</STRONG>
62 <STRONG>char</STRONG> <STRONG>*key_name(wchar_t</STRONG> <STRONG>w);</STRONG>
63 <STRONG>void</STRONG> <STRONG>filter(void);</STRONG>
64 <STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <STRONG>f);</STRONG>
65 <STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>FILE</STRONG> <STRONG>*filep);</STRONG>
66 <STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*filep);</STRONG>
67 <STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <STRONG>ms);</STRONG>
68 <STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
72 <H2>DESCRIPTION</H2><PRE>
73 The <STRONG>unctrl</STRONG> routine returns a character string which is a
74 printable representation of the character <EM>c</EM>, ignoring
75 attributes. Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM>
76 notation. Printing characters are displayed as is. The
77 corresponding <STRONG>wunctrl</STRONG> returns a printable representation
80 The <STRONG>keyname</STRONG> routine returns a character string correspond-
81 ing to the key <EM>c</EM>. Control characters are displayed in the
82 <STRONG>^</STRONG><EM>X</EM> notation. Values above 128 are either meta characters,
83 shown in the <STRONG>M-</STRONG><EM>X</EM> notation, or the names of function keys,
84 or null. The corresponding <STRONG>key_name</STRONG> returns a character
85 string corresponding to the wide-character value <EM>w</EM>. The
86 two functions do not return the same set of strings; the
87 latter returns null where the former would display a meta
90 The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
91 or <STRONG>newterm</STRONG> are called. The effect is that, during those
92 calls, <STRONG>LINES</STRONG> is set to 1; the capabilities <STRONG>clear</STRONG>, <STRONG>cup</STRONG>,
93 <STRONG>cud</STRONG>, <STRONG>cud1</STRONG>, <STRONG>cuu1</STRONG>, <STRONG>cuu</STRONG>, <STRONG>vpa</STRONG> are disabled; and the <STRONG>home</STRONG>
94 string is set to the value of <STRONG>cr</STRONG>.
96 The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG> or
97 <STRONG>newterm</STRONG> are called. When called with <STRONG>FALSE</STRONG> as an argu-
98 ment, the values of <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the
99 <EM>terminfo</EM> database will be used, even if environment vari-
100 ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set, or if
101 <STRONG>curses</STRONG> is running in a window (in which case default
102 behavior would be to use the window size if <STRONG>LINES</STRONG> and
103 <STRONG>COLUMNS</STRONG> are not set).
105 The <STRONG>putwin</STRONG> routine writes all data associated with window
106 <EM>win</EM> into the file to which <EM>filep</EM> points. This information
107 can be later retrieved using the <STRONG>getwin</STRONG> function.
109 The <STRONG>getwin</STRONG> routine reads window related data stored in the
110 file by <STRONG>putwin</STRONG>. The routine then creates and initializes
111 a new window using that data. It returns a pointer to the
114 The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM> millisecond pause
115 in output. This routine should not be used extensively
116 because padding characters are used rather than a CPU
117 pause. If no padding character is specified, this uses
118 <STRONG>napms</STRONG> to perform the delay.
120 The <STRONG>flushinp</STRONG> routine throws away any typeahead that has
121 been typed by the user and has not yet been read by the
126 <H2>RETURN VALUE</H2><PRE>
127 Except for <STRONG>flushinp</STRONG>, routines that return an integer
128 return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an
129 integer value other than <STRONG>ERR</STRONG>") upon successful completion.
131 <STRONG>flushinp</STRONG> always returns <STRONG>OK</STRONG>.
133 Routines that return pointers return <STRONG>NULL</STRONG> on error.
137 <H2>PORTABILITY</H2><PRE>
138 The XSI Curses standard, Issue 4 describes these func-
139 tions. It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a
140 null pointer if unsuccessful, but does not define any
143 The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
144 in the vaguest terms. The description here is adapted
145 from the XSI Curses standard (which erroneously fails to
146 describe the disabling of <STRONG>cuu</STRONG>).
150 <H2>SEE ALSO</H2><PRE>
151 <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_kernel.3x.html">curs_kernel(3x)</A></STRONG>,
152 <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>.
156 <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
160 Man(1) output converted with
161 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>