ncurses 5.3
[ncurses.git] / doc / html / man / curs_util.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998-2001,2002 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_util.3x,v 1.9 2002/09/01 19:44:37 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
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">
37 </HEAD>
38 <BODY>
39 <H1>curs_util 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>delay_output</STRONG>, <STRONG>filter</STRONG>, <STRONG>flushinp</STRONG>, <STRONG>getwin</STRONG>, <STRONG>key_name</STRONG>, <STRONG>keyname</STRONG>,
47        <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>wunctrl</STRONG>  -  miscellaneous  <STRONG>curses</STRONG>
48        utility routines
49
50
51 </PRE>
52 <H2>SYNOPSIS</H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55        <STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG>
56        <STRONG>char</STRONG> <STRONG>*wunctrl(wchar_t</STRONG> <STRONG>w);</STRONG>
57        <STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <STRONG>c);</STRONG>
58        <STRONG>char</STRONG> <STRONG>*key_name(wchar_t</STRONG> <STRONG>w);</STRONG>
59        <STRONG>void</STRONG> <STRONG>filter(void);</STRONG>
60        <STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <STRONG>f);</STRONG>
61        <STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>FILE</STRONG> <STRONG>*filep);</STRONG>
62        <STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*filep);</STRONG>
63        <STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <STRONG>ms);</STRONG>
64        <STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
65
66
67 </PRE>
68 <H2>DESCRIPTION</H2><PRE>
69        The  <STRONG>unctrl</STRONG>  routine returns a character string which is a
70        printable representation  of  the  character  <EM>c</EM>,  ignoring
71        attributes.   Control  characters  are displayed in the <STRONG>^</STRONG><EM>X</EM>
72        notation.  Printing characters are displayed as  is.   The
73        corresponding  <STRONG>wunctrl</STRONG>  returns a printable representation
74        of a wide-character.
75
76        The <STRONG>keyname</STRONG> routine returns a character string correspond-
77        ing to the key <EM>c</EM>.  Control characters are displayed in the
78        <STRONG>^</STRONG><EM>X</EM> notation.  Values above 128 are either meta characters,
79        shown  in the <STRONG>M-</STRONG><EM>X</EM> notation, or the names of function keys,
80        or null.  The corresponding <STRONG>key_name</STRONG> returns  a  character
81        string  corresponding  to the wide-character value <EM>w</EM>.  The
82        two functions do not return the same set of  strings;  the
83        latter  returns null where the former would display a meta
84        character.
85
86        The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
87        or  <STRONG>newterm</STRONG>  are called.  The effect is that, during those
88        calls, <STRONG>LINES</STRONG> is set to 1;  the  capabilities  <STRONG>clear</STRONG>,  <STRONG>cup</STRONG>,
89        <STRONG>cud</STRONG>,  <STRONG>cud1</STRONG>,  <STRONG>cuu1</STRONG>,  <STRONG>cuu</STRONG>,  <STRONG>vpa</STRONG>  are  disabled; and the <STRONG>home</STRONG>
90        string is set to the value of <STRONG>cr</STRONG>.
91
92        The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG>  or
93        <STRONG>newterm</STRONG>  are  called.   When called with <STRONG>FALSE</STRONG> as an argu-
94        ment, the values of <STRONG>lines</STRONG> and  <STRONG>columns</STRONG>  specified  in  the
95        <EM>terminfo</EM>  database will be used, even if environment vari-
96        ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set,  or  if
97        <STRONG>curses</STRONG>  is  running  in  a  window  (in which case default
98        behavior would be to use the  window  size  if  <STRONG>LINES</STRONG>  and
99        <STRONG>COLUMNS</STRONG> are not set).
100
101        The  <STRONG>putwin</STRONG> routine writes all data associated with window
102        <EM>win</EM> into the file to which <EM>filep</EM> points.  This information
103        can be later retrieved using the <STRONG>getwin</STRONG> function.
104
105        The <STRONG>getwin</STRONG> routine reads window related data stored in the
106        file by <STRONG>putwin</STRONG>.  The routine then creates and  initializes
107        a new window using that data.  It returns a pointer to the
108        new window.
109
110        The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM>  millisecond  pause
111        in  output.   This  routine should not be used extensively
112        because padding characters are  used  rather  than  a  CPU
113        pause.
114
115        The  <STRONG>flushinp</STRONG>  routine  throws away any typeahead that has
116        been typed by the user and has not yet been  read  by  the
117        program.
118
119
120 </PRE>
121 <H2>RETURN VALUE</H2><PRE>
122        Except  for  <STRONG>flushinp</STRONG>,  routines  that  return  an integer
123        return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4  specifies  only  "an
124        integer value other than <STRONG>ERR</STRONG>") upon successful completion.
125
126        <STRONG>flushinp</STRONG> always returns <STRONG>OK</STRONG>.
127
128        Routines that return pointers return <STRONG>NULL</STRONG> on error.
129
130
131 </PRE>
132 <H2>PORTABILITY</H2><PRE>
133        The XSI Curses standard, Issue  4  describes  these  func-
134        tions.   It  states  that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a
135        null pointer if unsuccessful,  but  does  not  define  any
136        error conditions.
137
138        The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
139        in the vaguest terms.  The  description  here  is  adapted
140        from  the  XSI Curses standard (which erroneously fails to
141        describe the disabling of <STRONG>cuu</STRONG>).
142
143
144 </PRE>
145 <H2>SEE ALSO</H2><PRE>
146        <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_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>.
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163 </PRE>
164 <HR>
165 <ADDRESS>
166 Man(1) output converted with
167 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
168 </ADDRESS>
169 </BODY>
170 </HTML>