1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
* Copyright (c) 1998-2001,2002 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
* @Id: curs_util.3x,v 1.9 2002/09/01 19:44:37 tom Exp @
-->
<HTML>
<HEAD>
<TITLE>curs_util 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<H1>curs_util 3x</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
</PRE>
<H2>NAME</H2><PRE>
<STRONG>delay_output</STRONG>, <STRONG>filter</STRONG>, <STRONG>flushinp</STRONG>, <STRONG>getwin</STRONG>, <STRONG>key_name</STRONG>, <STRONG>keyname</STRONG>,
<STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>wunctrl</STRONG> - miscellaneous <STRONG>curses</STRONG>
utility routines
</PRE>
<H2>SYNOPSIS</H2><PRE>
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
<STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG>
<STRONG>char</STRONG> <STRONG>*wunctrl(wchar_t</STRONG> <STRONG>w);</STRONG>
<STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <STRONG>c);</STRONG>
<STRONG>char</STRONG> <STRONG>*key_name(wchar_t</STRONG> <STRONG>w);</STRONG>
<STRONG>void</STRONG> <STRONG>filter(void);</STRONG>
<STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <STRONG>f);</STRONG>
<STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>FILE</STRONG> <STRONG>*filep);</STRONG>
<STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*filep);</STRONG>
<STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <STRONG>ms);</STRONG>
<STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
</PRE>
<H2>DESCRIPTION</H2><PRE>
The <STRONG>unctrl</STRONG> routine returns a character string which is a
printable representation of the character <EM>c</EM>, ignoring
attributes. Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM>
notation. Printing characters are displayed as is. The
corresponding <STRONG>wunctrl</STRONG> returns a printable representation
of a wide-character.
The <STRONG>keyname</STRONG> routine returns a character string correspond-
ing to the key <EM>c</EM>. Control characters are displayed in the
<STRONG>^</STRONG><EM>X</EM> notation. Values above 128 are either meta characters,
shown in the <STRONG>M-</STRONG><EM>X</EM> notation, or the names of function keys,
or null. The corresponding <STRONG>key_name</STRONG> returns a character
string corresponding to the wide-character value <EM>w</EM>. The
two functions do not return the same set of strings; the
latter returns null where the former would display a meta
character.
The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
or <STRONG>newterm</STRONG> are called. The effect is that, during those
calls, <STRONG>LINES</STRONG> is set to 1; the capabilities <STRONG>clear</STRONG>, <STRONG>cup</STRONG>,
<STRONG>cud</STRONG>, <STRONG>cud1</STRONG>, <STRONG>cuu1</STRONG>, <STRONG>cuu</STRONG>, <STRONG>vpa</STRONG> are disabled; and the <STRONG>home</STRONG>
string is set to the value of <STRONG>cr</STRONG>.
The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG> or
<STRONG>newterm</STRONG> are called. When called with <STRONG>FALSE</STRONG> as an argu-
ment, the values of <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the
<EM>terminfo</EM> database will be used, even if environment vari-
ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set, or if
<STRONG>curses</STRONG> is running in a window (in which case default
behavior would be to use the window size if <STRONG>LINES</STRONG> and
<STRONG>COLUMNS</STRONG> are not set).
The <STRONG>putwin</STRONG> routine writes all data associated with window
<EM>win</EM> into the file to which <EM>filep</EM> points. This information
can be later retrieved using the <STRONG>getwin</STRONG> function.
The <STRONG>getwin</STRONG> routine reads window related data stored in the
file by <STRONG>putwin</STRONG>. The routine then creates and initializes
a new window using that data. It returns a pointer to the
new window.
The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM> millisecond pause
in output. This routine should not be used extensively
because padding characters are used rather than a CPU
pause.
The <STRONG>flushinp</STRONG> routine throws away any typeahead that has
been typed by the user and has not yet been read by the
program.
</PRE>
<H2>RETURN VALUE</H2><PRE>
Except for <STRONG>flushinp</STRONG>, routines that return an integer
return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an
integer value other than <STRONG>ERR</STRONG>") upon successful completion.
<STRONG>flushinp</STRONG> always returns <STRONG>OK</STRONG>.
Routines that return pointers return <STRONG>NULL</STRONG> on error.
</PRE>
<H2>PORTABILITY</H2><PRE>
The XSI Curses standard, Issue 4 describes these func-
tions. It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a
null pointer if unsuccessful, but does not define any
error conditions.
The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
in the vaguest terms. The description here is adapted
from the XSI Curses standard (which erroneously fails to
describe the disabling of <STRONG>cuu</STRONG>).
</PRE>
<H2>SEE ALSO</H2><PRE>
<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>.
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
|