ncurses 5.5
[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-2004,2005 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.17 2005/06/25 21:51: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 <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>                                             <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2>NAME</H2><PRE>
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>
52        utility routines
53
54
55 </PRE>
56 <H2>SYNOPSIS</H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
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>
69
70
71 </PRE>
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  at-
75        tributes.   Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no-
76        tation.  Printing characters are  displayed  as  is.   The
77        corresponding  <STRONG>wunctrl</STRONG>  returns a printable representation
78        of a wide-character.
79
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
88        character.
89
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>.
95
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 be-
102        havior would be to  use  the  window  size  if  <STRONG>LINES</STRONG>  and
103        <STRONG>COLUMNS</STRONG>  are not set).  Note that setting <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG>
104        overrides the corresponding size  which  may  be  obtained
105        from the operating system.
106
107        The  <STRONG>putwin</STRONG> routine writes all data associated with window
108        <EM>win</EM> into the file to which <EM>filep</EM> points.  This information
109        can be later retrieved using the <STRONG>getwin</STRONG> function.
110
111        The <STRONG>getwin</STRONG> routine reads window related data stored in the
112        file by <STRONG>putwin</STRONG>.  The routine then creates and  initializes
113        a new window using that data.  It returns a pointer to the
114        new window.
115
116        The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM>  millisecond  pause
117        in  output.   This  routine should not be used extensively
118        because padding characters are  used  rather  than  a  CPU
119        pause.   If  no  padding character is specified, this uses
120        <STRONG>napms</STRONG> to perform the delay.
121
122        The <STRONG>flushinp</STRONG> routine throws away any  typeahead  that  has
123        been  typed  by  the user and has not yet been read by the
124        program.
125
126
127 </PRE>
128 <H2>RETURN VALUE</H2><PRE>
129        Except for <STRONG>flushinp</STRONG>, routines that return an  integer  re-
130        turn  <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an in-
131        teger value other than <STRONG>ERR</STRONG>") upon successful completion.
132
133        Routines that return pointers return <STRONG>NULL</STRONG> on error.
134
135        X/Open does not define any error conditions.  In this  im-
136        plementation
137
138               <STRONG>flushinp</STRONG>
139                    returns  an error if the terminal was not ini-
140                    tialized.
141
142               <STRONG>putwin</STRONG>
143                    returns an  error  if  the  associated  <STRONG>fwrite</STRONG>
144                    calls return an error.
145
146
147 </PRE>
148 <H2>PORTABILITY</H2><PRE>
149        The  XSI  Curses  standard,  Issue 4 describes these func-
150        tions.  It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG>  will  return  a
151        null  pointer if unsuccessful, but does not define any er-
152        ror conditions.
153
154        The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
155        in  the  vaguest  terms.   The description here is adapted
156        from the XSI Curses standard (which erroneously  fails  to
157        describe the disabling of <STRONG>cuu</STRONG>).
158
159        The  strings returned by <STRONG>unctrl</STRONG> in this implementation are
160        determined at compile time, showing C1 controls  from  the
161        upper-128  codes with a `~' prefix rather than `^'.  Other
162        implementations typically show both sets of control  char-
163        acters  with  `^',  and may strip the parameter to 7 bits.
164        This implementation uses 8 bits but does  not  modify  the
165        string to reflect locale.
166
167        The  <STRONG>keyname</STRONG> function may return the names of user-defined
168        string capabilities which are defined in the terminfo  en-
169        try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>.
170
171
172 </PRE>
173 <H2>SEE ALSO</H2><PRE>
174        <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>,
175        <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>.
176
177
178
179                                                           <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
180 </PRE>
181 <HR>
182 <ADDRESS>
183 Man(1) output converted with
184 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
185 </ADDRESS>
186 </BODY>
187 </HTML>