ncurses 5.6 - patch 20080621
[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-2006,2007 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.25 2007/05/26 21:44:42 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>nofilter</STRONG>, <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>wunctrl</STRONG> - miscellaneous
52        <STRONG>curses</STRONG> 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>wchar_t</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>nofilter(void);</STRONG>
65        <STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <STRONG>f);</STRONG>
66        <STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>FILE</STRONG> <STRONG>*filep);</STRONG>
67        <STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*filep);</STRONG>
68        <STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <STRONG>ms);</STRONG>
69        <STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
70
71
72 </PRE>
73 <H2>DESCRIPTION</H2><PRE>
74        The  <STRONG>unctrl</STRONG>  routine returns a character string which is a
75        printable representation of the character <EM>c</EM>, ignoring  at-
76        tributes.   Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no-
77        tation.  Printing characters are  displayed  as  is.   The
78        corresponding  <STRONG>wunctrl</STRONG>  returns a printable representation
79        of a wide-character.
80
81        The <STRONG>keyname</STRONG> routine returns a character string correspond-
82        ing to the key <EM>c</EM>.  Control characters are displayed in the
83        <STRONG>^</STRONG><EM>X</EM> notation.  Values above 128 are either meta characters,
84        shown  in the <STRONG>M-</STRONG><EM>X</EM> notation, or the names of function keys,
85        or null.  The corresponding <STRONG>key_name</STRONG> returns  a  character
86        string  corresponding  to the wide-character value <EM>w</EM>.  The
87        two functions do not return the same set of  strings;  the
88        latter  returns null where the former would display a meta
89        character.
90
91        The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
92        or  <STRONG>newterm</STRONG>  are called.  The effect is that, during those
93        calls, <STRONG>LINES</STRONG> is set to 1;  the  capabilities  <STRONG>clear</STRONG>,  <STRONG>cup</STRONG>,
94        <STRONG>cud</STRONG>,  <STRONG>cud1</STRONG>,  <STRONG>cuu1</STRONG>,  <STRONG>cuu</STRONG>,  <STRONG>vpa</STRONG>  are  disabled; and the <STRONG>home</STRONG>
95        string is set to the value of <STRONG>cr</STRONG>.
96
97        The <STRONG>nofilter</STRONG> routine cancels the  effect  of  a  preceding
98        <STRONG>filter</STRONG>  call.   That  allows  the  caller  to initialize a
99        screen on a different device, using a different  value  of
100        <STRONG>$TERM</STRONG>.   The  limitation arises because the <STRONG>filter</STRONG> routine
101        modifies the in-memory copy of the terminal information.
102
103        The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG>  or
104        <STRONG>newterm</STRONG>  are  called.   When called with <STRONG>FALSE</STRONG> as an argu-
105        ment, the values of <STRONG>lines</STRONG> and  <STRONG>columns</STRONG>  specified  in  the
106        <EM>terminfo</EM>  database will be used, even if environment vari-
107        ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set,  or  if
108        <STRONG>curses</STRONG>  is  running in a window (in which case default be-
109        havior would be to  use  the  window  size  if  <STRONG>LINES</STRONG>  and
110        <STRONG>COLUMNS</STRONG>  are not set).  Note that setting <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG>
111        overrides the corresponding size  which  may  be  obtained
112        from the operating system.
113
114        The  <STRONG>putwin</STRONG> routine writes all data associated with window
115        <EM>win</EM> into the file to which <EM>filep</EM> points.  This information
116        can be later retrieved using the <STRONG>getwin</STRONG> function.
117
118        The <STRONG>getwin</STRONG> routine reads window related data stored in the
119        file by <STRONG>putwin</STRONG>.  The routine then creates and  initializes
120        a new window using that data.  It returns a pointer to the
121        new window.
122
123        The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM>  millisecond  pause
124        in  output.   This  routine should not be used extensively
125        because padding characters are  used  rather  than  a  CPU
126        pause.   If  no  padding character is specified, this uses
127        <STRONG>napms</STRONG> to perform the delay.
128
129        The <STRONG>flushinp</STRONG> routine throws away any  typeahead  that  has
130        been  typed  by  the user and has not yet been read by the
131        program.
132
133
134 </PRE>
135 <H2>RETURN VALUE</H2><PRE>
136        Except for <STRONG>flushinp</STRONG>, routines that return an  integer  re-
137        turn  <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an in-
138        teger value other than <STRONG>ERR</STRONG>") upon successful completion.
139
140        Routines that return pointers return <STRONG>NULL</STRONG> on error.
141
142        X/Open does not define any error conditions.  In this  im-
143        plementation
144
145               <STRONG>flushinp</STRONG>
146                    returns  an error if the terminal was not ini-
147                    tialized.
148
149               <STRONG>putwin</STRONG>
150                    returns an  error  if  the  associated  <STRONG>fwrite</STRONG>
151                    calls return an error.
152
153
154 </PRE>
155 <H2>PORTABILITY</H2><PRE>
156        The  XSI  Curses  standard,  Issue 4 describes these func-
157        tions.  It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG>  will  return  a
158        null  pointer if unsuccessful, but does not define any er-
159        ror conditions.  This implementation checks for three cas-
160        es:
161
162               -    the  parameter is a 7-bit US-ASCII code.  This
163                    is the case that X/Open Curses documented.
164
165               -    the parameter is in the range 128-159, i.e., a
166                    C1  control  code.   If  <STRONG>use_legacy_coding</STRONG> has
167                    been called with a <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns
168                    the  parameter,  i.e.,  a one-character string
169                    with the parameter  as  the  first  character.
170                    Otherwise,  it  returns  ``~@'', ``~A'', etc.,
171                    analogous to ``^@'', ``^A'', C0 controls.
172
173                    X/Open Curses does not document whether <STRONG>unctrl</STRONG>
174                    can  be  called  before  initializing  curses.
175                    This implementation permits that, and  returns
176                    the ``~@'', etc., values in that case.
177
178               -    parameter  values  outside the 0 to 255 range.
179                    <STRONG>unctrl</STRONG> returns a null pointer.
180
181        The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
182        in  the  vaguest  terms.   The description here is adapted
183        from the XSI Curses standard (which erroneously  fails  to
184        describe the disabling of <STRONG>cuu</STRONG>).
185
186        The  strings returned by <STRONG>unctrl</STRONG> in this implementation are
187        determined at compile time, showing C1 controls  from  the
188        upper-128  codes with a `~' prefix rather than `^'.  Other
189        implementations have different conventions.  For  example,
190        they  may  show  both sets of control characters with `^',
191        and strip the parameter to 7 bits.  Or they may ignore  C1
192        controls  and  treat  all of the upper-128 codes as print-
193        able.  This implementation uses 8 bits but does not modify
194        the string to reflect locale.  The <STRONG>use_legacy_coding</STRONG> func-
195        tion allows the caller to change the output of <STRONG>unctrl</STRONG>.
196
197        Likewise, the <STRONG>meta</STRONG> function allows the  caller  to  change
198        the  output of <STRONG>keyname</STRONG>, i.e., it determines whether to use
199        the `M-' prefix for ``meta'' keys (codes in the range  128
200        to 255).  Both <STRONG>use_legacy_coding</STRONG> and <STRONG>meta</STRONG> succeed only af-
201        ter curses is initialized.  X/Open Curses does  not  docu-
202        ment  the  treatment  of  codes 128 to 159.  When treating
203        them as ``meta'' keys (or if <STRONG>keyname</STRONG> is called before ini-
204        tializing  curses),  this  implementation  returns strings
205        ``M-^@'', ``M-^A'', etc.
206
207        The <STRONG>keyname</STRONG> function may return the names of  user-defined
208        string  capabilities which are defined in the terminfo en-
209        try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>.  This  implementation  auto-
210        matically  assigns  at  run-time  keycodes to user-defined
211        strings which begin  with  "k".   The  keycodes  start  at
212        KEY_MAX,  but  are not guaranteed to be the same value for
213        different runs because user-defined codes are merged  from
214        all terminal descriptions which have been loaded.
215
216        The  <STRONG>nofilter</STRONG>  routine is specific to ncurses.  It was not
217        supported on Version 7, BSD or System  V  implementations.
218        It  is  recommended that any code depending on ncurses ex-
219        tensions be conditioned using NCURSES_VERSION.
220
221
222 </PRE>
223 <H2>SEE ALSO</H2><PRE>
224        <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG>curs_ker-</STRONG>
225        <STRONG><A HREF="curs_kernel.3x.html">nel(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>.
226
227
228
229                                                           <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
230 </PRE>
231 <HR>
232 <ADDRESS>
233 Man(1) output converted with
234 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
235 </ADDRESS>
236 </BODY>
237 </HTML>