9ae2f4195439220585b578e0585e81cf9311abc6
[ncurses.git] / doc / html / man / curs_util.3x.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc.              *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: curs_util.3x,v 1.36 2012/07/21 18:51:10 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>curs_util 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>curs_util 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>                                             <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>delay_output</STRONG>, <STRONG>filter</STRONG>, <STRONG>flushinp</STRONG>, <STRONG>getwin</STRONG>, <STRONG>key_name</STRONG>, <STRONG>keyname</STRONG>,
52        <STRONG>nofilter</STRONG>, <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>use_tioctl</STRONG>, <STRONG>wunctrl</STRONG> -
53        miscellaneous <STRONG>curses</STRONG> utility routines
54
55
56 </PRE>
57 <H2>SYNOPSIS</H2><PRE>
58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
59
60        <STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG>
61        <STRONG>wchar_t</STRONG> <STRONG>*wunctrl(cchar_t</STRONG> <STRONG>*c);</STRONG>
62        <STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <STRONG>c);</STRONG>
63        <STRONG>char</STRONG> <STRONG>*key_name(wchar_t</STRONG> <STRONG>w);</STRONG>
64        <STRONG>void</STRONG> <STRONG>filter(void);</STRONG>
65        <STRONG>void</STRONG> <STRONG>nofilter(void);</STRONG>
66        <STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <STRONG>f);</STRONG>
67        <STRONG>void</STRONG> <STRONG>use_tioctl(bool</STRONG> <STRONG>f);</STRONG>
68        <STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>FILE</STRONG> <STRONG>*filep);</STRONG>
69        <STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*filep);</STRONG>
70        <STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <STRONG>ms);</STRONG>
71        <STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
72
73
74 </PRE>
75 <H2>DESCRIPTION</H2><PRE>
76        The  <STRONG>unctrl</STRONG>  routine returns a character string which is a
77        printable representation of the character <EM>c</EM>, ignoring  at-
78        tributes.   Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no-
79        tation.  Printing characters are  displayed  as  is.   The
80        corresponding  <STRONG>wunctrl</STRONG>  returns a printable representation
81        of a wide character.
82
83        The <STRONG>keyname</STRONG> routine returns a character string correspond-
84        ing to the key <EM>c</EM>:
85
86           <STRONG>o</STRONG>   Printable  characters  are displayed as themselves,
87               e.g., a one-character string containing the key.
88
89           <STRONG>o</STRONG>   Control characters are displayed in  the  <STRONG>^</STRONG><EM>X</EM>  nota-
90               tion.
91
92           <STRONG>o</STRONG>   DEL (character 127) is displayed as <STRONG>^?</STRONG>.
93
94           <STRONG>o</STRONG>   Values above 128 are either meta characters (if the
95               screen has not been initialized,  or  if  <STRONG>meta</STRONG>  has
96               been  called  with  a TRUE parameter), shown in the
97               <STRONG>M-</STRONG><EM>X</EM> notation, or are displayed as  themselves.   In
98               the  latter  case, the values may not be printable;
99               this follows the X/Open specification.
100
101           <STRONG>o</STRONG>   Values above 256 may be the names of the  names  of
102               function keys.
103
104           <STRONG>o</STRONG>   Otherwise  (if  there is no corresponding name) the
105               function returns null, to denote an error.   X/Open
106               also  lists  an  "UNKNOWN  KEY" return value, which
107               some implementations return rather than null.
108
109        The corresponding <STRONG>key_name</STRONG> returns a character string cor-
110        responding  to  the wide-character value <EM>w</EM>.  The two func-
111        tions do not return the same set of  strings;  the  latter
112        returns null where the former would display a meta charac-
113        ter.
114
115        The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
116        or  <STRONG>newterm</STRONG>  are called.  The effect is that, during those
117        calls, <STRONG>LINES</STRONG> is set to 1;  the  capabilities  <STRONG>clear</STRONG>,  <STRONG>cup</STRONG>,
118        <STRONG>cud</STRONG>,  <STRONG>cud1</STRONG>,  <STRONG>cuu1</STRONG>,  <STRONG>cuu</STRONG>,  <STRONG>vpa</STRONG>  are  disabled; and the <STRONG>home</STRONG>
119        string is set to the value of <STRONG>cr</STRONG>.
120
121        The <STRONG>nofilter</STRONG> routine cancels the  effect  of  a  preceding
122        <STRONG>filter</STRONG>  call.   That  allows  the  caller  to initialize a
123        screen on a different device, using a different  value  of
124        <STRONG>$TERM</STRONG>.   The  limitation arises because the <STRONG>filter</STRONG> routine
125        modifies the in-memory copy of the terminal information.
126
127        The <STRONG>use_env</STRONG> routine, if  used,  should  be  called  before
128        <STRONG>initscr</STRONG>  or  <STRONG>newterm</STRONG> are called (because those compute the
129        screen size).  It modifies the way <STRONG>ncurses</STRONG> treats environ-
130        ment variables when determining the screen size.
131
132        <STRONG>o</STRONG>   Normally  ncurses looks first at the terminal database
133            for the screen size.
134
135            If <STRONG>use_env</STRONG> was called with  <STRONG>FALSE</STRONG>  for  parameter,  it
136            stops  here  unless If <STRONG>use_tioctl</STRONG> was also called with
137            <STRONG>TRUE</STRONG> for parameter.
138
139        <STRONG>o</STRONG>   Then it asks for the screen size via operating  system
140            calls.   If  successful,  it overrides the values from
141            the terminal database.
142
143        <STRONG>o</STRONG>   Finally (unless <STRONG>use_env</STRONG> was called with <STRONG>FALSE</STRONG>  parame-
144            ter),  ncurses  examines the <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> environ-
145            ment variables, using a value in those to override the
146            results  from  the  operating system or terminal data-
147            base.
148
149            Ncurses also updates the screen size  in  response  to
150            SIGWINCH,  unless  overridden  by the <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG>
151            environment variables,
152
153        The <STRONG>use_tioctl</STRONG> routine, if used, should be  called  before
154        <STRONG>initscr</STRONG>  or  <STRONG>newterm</STRONG> are called (because those compute the
155        screen size).  After <STRONG>use_tioctl</STRONG> is called with <STRONG>TRUE</STRONG> as  an
156        argument,  ncurses  modifies the last step in its computa-
157        tion of screen size as follows:
158
159        <STRONG>o</STRONG>   checks if the <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> environment  variables
160            are set to a number greater than zero.
161
162        <STRONG>o</STRONG>   for  each,  ncurses updates the corresponding environ-
163            ment variable with the value that it has obtained  via
164            operating system call or from the terminal database.
165
166        <STRONG>o</STRONG>   ncurses  re-fetches the value of the environment vari-
167            ables so that it is still  the  environment  variables
168            which set the screen size.
169
170        The  <STRONG>use_env</STRONG> and <STRONG>use_tioctl</STRONG> routines combine as summarized
171        here:
172
173      <EM>use</EM><STRONG>_</STRONG><EM>env</EM>   <EM>use</EM><STRONG>_</STRONG><EM>tioctl</EM>   <EM>Summary</EM>
174      ----------------------------------------------------------------
175      TRUE      FALSE        This is the default  behavior.   ncurses
176                             uses operating system calls unless over-
177                             ridden by $LINES or $COLUMNS environment
178                             variables.
179      TRUE      TRUE         ncurses   updates  $LINES  and  $COLUMNS
180                             based on operating system calls.
181
182      FALSE     TRUE         ncurses ignores $LINES and $COLUMNS, us-
183                             es  operating  system  calls  to  obtain
184                             size.
185      FALSE     FALSE        ncurses relies on the terminal  database
186                             to determine size.
187
188        The  <STRONG>putwin</STRONG> routine writes all data associated with window
189        <EM>win</EM> into the file to which <EM>filep</EM> points.  This information
190        can be later retrieved using the <STRONG>getwin</STRONG> function.
191
192        The <STRONG>getwin</STRONG> routine reads window related data stored in the
193        file by <STRONG>putwin</STRONG>.  The routine then creates and  initializes
194        a new window using that data.  It returns a pointer to the
195        new window.
196
197        The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM>  millisecond  pause
198        in  output.   This  routine should not be used extensively
199        because padding characters are  used  rather  than  a  CPU
200        pause.   If  no  padding character is specified, this uses
201        <STRONG>napms</STRONG> to perform the delay.
202
203        The <STRONG>flushinp</STRONG> routine throws away any  typeahead  that  has
204        been  typed  by  the user and has not yet been read by the
205        program.
206
207
208 </PRE>
209 <H2>RETURN VALUE</H2><PRE>
210        Except for <STRONG>flushinp</STRONG>, routines that return an  integer  re-
211        turn  <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an in-
212        teger value other than <STRONG>ERR</STRONG>") upon successful completion.
213
214        Routines that return pointers return <STRONG>NULL</STRONG> on error.
215
216        X/Open does not define any error conditions.  In this  im-
217        plementation
218
219           <STRONG>flushinp</STRONG>
220                returns  an error if the terminal was not initial-
221                ized.
222
223           <STRONG>meta</STRONG> returns an error if the terminal was not  initial-
224                ized.
225
226           <STRONG>putwin</STRONG>
227                returns  an  error  if the associated <STRONG>fwrite</STRONG> calls
228                return an error.
229
230
231 </PRE>
232 <H2>PORTABILITY</H2><PRE>
233        The XSI Curses standard, Issue  4  describes  these  func-
234        tions.   It  states  that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a
235        null pointer if unsuccessful, but does not define any  er-
236        ror conditions.  This implementation checks for three cas-
237        es:
238
239           <STRONG>o</STRONG>   the parameter is a 7-bit US-ASCII  code.   This  is
240               the case that X/Open Curses documented.
241
242           <STRONG>o</STRONG>   the  parameter  is in the range 128-159, i.e., a C1
243               control code.  If <STRONG>use_legacy_coding</STRONG> has been called
244               with  a  <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns the parameter,
245               i.e., a one-character string with the parameter  as
246               the first character.  Otherwise, it returns ``~@'',
247               ``~A'', etc., analogous to ``^@'', ``^A'', C0  con-
248               trols.
249
250               X/Open  Curses does not document whether <STRONG>unctrl</STRONG> can
251               be called before initializing curses.  This  imple-
252               mentation  permits  that,  and  returns the ``~@'',
253               etc., values in that case.
254
255           <STRONG>o</STRONG>   parameter values outside the 0 to 255 range.   <STRONG>unc-</STRONG>
256               <STRONG>trl</STRONG> returns a null pointer.
257
258        The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
259        in the vaguest terms.  The  description  here  is  adapted
260        from  the  XSI Curses standard (which erroneously fails to
261        describe the disabling of <STRONG>cuu</STRONG>).
262
263        The strings returned by <STRONG>unctrl</STRONG> in this implementation  are
264        determined  at  compile time, showing C1 controls from the
265        upper-128 codes with a `~' prefix rather than `^'.   Other
266        implementations  have different conventions.  For example,
267        they may show both sets of control  characters  with  `^',
268        and  strip the parameter to 7 bits.  Or they may ignore C1
269        controls and treat all of the upper-128  codes  as  print-
270        able.  This implementation uses 8 bits but does not modify
271        the string to reflect locale.  The <STRONG>use_legacy_coding</STRONG> func-
272        tion allows the caller to change the output of <STRONG>unctrl</STRONG>.
273
274        Likewise,  the  <STRONG>meta</STRONG>  function allows the caller to change
275        the output of <STRONG>keyname</STRONG>, i.e., it determines whether to  use
276        the  `M-' prefix for ``meta'' keys (codes in the range 128
277        to 255).  Both <STRONG>use_legacy_coding</STRONG> and <STRONG>meta</STRONG> succeed only af-
278        ter  curses  is initialized.  X/Open Curses does not docu-
279        ment the treatment of codes 128  to  159.   When  treating
280        them as ``meta'' keys (or if <STRONG>keyname</STRONG> is called before ini-
281        tializing curses),  this  implementation  returns  strings
282        ``M-^@'', ``M-^A'', etc.
283
284        The  <STRONG>keyname</STRONG> function may return the names of user-defined
285        string capabilities which are defined in the terminfo  en-
286        try  via  the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>.  This implementation auto-
287        matically assigns at  run-time  keycodes  to  user-defined
288        strings  which  begin  with  "k".   The  keycodes start at
289        KEY_MAX, but are not guaranteed to be the same  value  for
290        different  runs because user-defined codes are merged from
291        all terminal descriptions which  have  been  loaded.   The
292        <STRONG>use_extended_names</STRONG>  function controls whether this data is
293        loaded when the terminal description is read  by  the  li-
294        brary.
295
296        The  <STRONG>nofilter</STRONG>  and  <STRONG>use_tioctl</STRONG>  routines  are  specific to
297        ncurses.  They were not supported on  Version  7,  BSD  or
298        System V implementations.  It is recommended that any code
299        depending  on  ncurses  extensions  be  conditioned  using
300        NCURSES_VERSION.
301
302
303 </PRE>
304 <H2>SEE ALSO</H2><PRE>
305        <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>
306        <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="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,   <STRONG>lega-</STRONG>
307        <STRONG><A HREF="legacy_coding.3x.html">cy_coding(3x)</A></STRONG>.
308
309
310
311                                                           <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
312 </PRE>
313 <HR>
314 <ADDRESS>
315 Man(1) output converted with
316 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
317 </ADDRESS>
318 </BODY>
319 </HTML>