2 ****************************************************************************
3 * Copyright (c) 2001-2015,2017 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * @Id: curs_add_wch.3x,v 1.24 2017/11/18 23:47:37 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_add_wch 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">curs_add_wch 3x</H1>
43 <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>, <STRONG>echo_wchar</STRONG>, <STRONG>wecho_wchar</STRONG> - add
50 a complex character and rendition to a <STRONG>curses</STRONG> window, then advance the
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>add_wch(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>wadd_wch(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>mvadd_wch(</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>mvwadd_wch(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>echo_wchar(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>wecho_wchar(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67 </PRE><H3><a name="h3-add_wch">add_wch</a></H3><PRE>
68 The <STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, and <STRONG>mvwadd_wch</STRONG> functions put the com-
69 plex character <EM>wch</EM> into the given window at its current position, which
70 is then advanced. These functions perform wrapping and special-charac-
71 ter processing as follows:
73 <STRONG>o</STRONG> If <EM>wch</EM> refers to a spacing character, then any previous character
74 at that location is removed. A new character specified by <EM>wch</EM> is
75 placed at that location with rendition specified by <EM>wch</EM>. The cur-
76 sor then advances to the next spacing character on the screen.
78 <STRONG>o</STRONG> If <EM>wch</EM> refers to a non-spacing character, all previous characters
79 at that location are preserved. The non-spacing characters of <EM>wch</EM>
80 are added to the spacing complex character, and the rendition spec-
81 ified by <EM>wch</EM> is ignored.
83 <STRONG>o</STRONG> If the character part of <EM>wch</EM> is a tab, newline, backspace or other
84 control character, the window is updated and the cursor moves as if
85 <STRONG>addch</STRONG> were called.
88 </PRE><H3><a name="h3-echo_wchar">echo_wchar</a></H3><PRE>
89 The <STRONG>echo_wchar</STRONG> function is functionally equivalent to a call to <STRONG>add_wch</STRONG>
90 followed by a call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>. Similarly, the <STRONG>wecho_wchar</STRONG> is func-
91 tionally equivalent to a call to <STRONG>wadd_wch</STRONG> followed by a call to <STRONG>wre-</STRONG>
92 <STRONG>fresh</STRONG>. The knowledge that only a single character is being output is
93 taken into consideration and, for non-control characters, a consider-
94 able performance gain might be seen by using the *<STRONG>echo</STRONG>* functions
95 instead of their equivalents.
98 </PRE><H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
99 Like <STRONG><A HREF="curs_addch.3x.html">addch(3x)</A></STRONG>, <STRONG>addch_wch</STRONG> accepts symbols which make it simple to draw
100 lines and other frequently used special characters. These symbols cor-
101 respond to the same VT100 line-drawing set as <STRONG><A HREF="curs_addch.3x.html">addch(3x)</A></STRONG>.
103 <STRONG>ACS</STRONG> <STRONG>Unicode</STRONG> <STRONG>ASCII</STRONG> <STRONG>acsc</STRONG> <STRONG>Glyph</STRONG>
104 <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Default</STRONG> <STRONG>char</STRONG> <STRONG>Name</STRONG>
105 ------------------------------------------------------------------------
106 WACS_BLOCK 0x25ae # 0 solid square block
107 WACS_BOARD 0x2592 # h board of squares
108 WACS_BTEE 0x2534 + v bottom tee
109 WACS_BULLET 0x00b7 o ~ bullet
110 WACS_CKBOARD 0x2592 : a checker board (stipple)
111 WACS_DARROW 0x2193 v . arrow pointing down
112 WACS_DEGREE 0x00b0 ' f degree symbol
113 WACS_DIAMOND 0x25c6 + ` diamond
115 WACS_GEQUAL 0x2265 > > greater-than-or-equal-to
116 WACS_HLINE 0x2500 - q horizontal line
117 WACS_LANTERN 0x2603 # i lantern symbol
118 WACS_LARROW 0x2190 < , arrow pointing left
119 WACS_LEQUAL 0x2264 < y less-than-or-equal-to
120 WACS_LLCORNER 0x2514 + m lower left-hand corner
121 WACS_LRCORNER 0x2518 + j lower right-hand corner
122 WACS_LTEE 0x2524 + t left tee
123 WACS_NEQUAL 0x2260 ! | not-equal
124 WACS_PI 0x03c0 * { greek pi
125 WACS_PLMINUS 0x00b1 # g plus/minus
126 WACS_PLUS 0x253c + n plus
127 WACS_RARROW 0x2192 > + arrow pointing right
128 WACS_RTEE 0x251c + u right tee
129 WACS_S1 0x23ba - o scan line 1
130 WACS_S3 0x23bb - p scan line 3
131 WACS_S7 0x23bc - r scan line 7
132 WACS_S9 0x23bd _ s scan line 9
133 WACS_STERLING 0x00a3 f } pound-sterling symbol
134 WACS_TTEE 0x252c + w top tee
135 WACS_UARROW 0x2191 ^ - arrow pointing up
136 WACS_ULCORNER 0x250c + l upper left-hand corner
137 WACS_URCORNER 0x2510 + k upper right-hand corner
138 WACS_VLINE 0x2502 | x vertical line
140 The wide-character configuration of ncurses also defines symbols for
143 <STRONG>ACS</STRONG> <STRONG>Unicode</STRONG> <STRONG>ASCII</STRONG> <STRONG>acsc</STRONG> <STRONG>Glyph</STRONG>
144 <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Default</STRONG> <STRONG>char</STRONG> <STRONG>Name</STRONG>
145 ------------------------------------------------------------------------
146 WACS_D_BTEE 0x2569 + H double tee pointing up
147 WACS_D_HLINE 0x2550 - R double horizontal line
148 WACS_D_LLCORNER 0x255a + D double lower left corner
149 WACS_D_LRCORNER 0x255d + A double lower right corner
150 WACS_D_LTEE 0x2560 + F double tee pointing right
151 WACS_D_PLUS 0x256c + E double large plus
152 WACS_D_RTEE 0x2563 + G double tee pointing left
153 WACS_D_TTEE 0x2566 + I double tee pointing down
154 WACS_D_ULCORNER 0x2554 + C double upper left corner
155 WACS_D_URCORNER 0x2557 + B double upper right corner
156 WACS_D_VLINE 0x2551 | Y double vertical line
160 <STRONG>ACS</STRONG> <STRONG>Unicode</STRONG> <STRONG>ASCII</STRONG> <STRONG>acsc</STRONG> <STRONG>Glyph</STRONG>
161 <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Default</STRONG> <STRONG>char</STRONG> <STRONG>Name</STRONG>
162 -----------------------------------------------------------------------
163 WACS_T_BTEE 0x253b + V thick tee pointing up
164 WACS_T_HLINE 0x2501 - Q thick horizontal line
165 WACS_T_LLCORNER 0x2517 + M thick lower left corner
166 WACS_T_LRCORNER 0x251b + J thick lower right corner
167 WACS_T_LTEE 0x252b + T thick tee pointing right
168 WACS_T_PLUS 0x254b + N thick large plus
169 WACS_T_RTEE 0x2523 + U thick tee pointing left
170 WACS_T_TTEE 0x2533 + W thick tee pointing down
171 WACS_T_ULCORNER 0x250f + L thick upper left corner
172 WACS_T_URCORNER 0x2513 + K thick upper right corner
173 WACS_T_VLINE 0x2503 | X thick vertical line
176 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
177 All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on success.
179 Functions with a "mv" prefix first perform a cursor movement using
180 <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
181 the window pointer is null.
184 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
185 Note that <STRONG>add_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>, and <STRONG>echo_wchar</STRONG> may be macros.
188 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
189 All of these functions are described in the XSI Curses standard, Issue
190 4. The defaults specified for line-drawing characters apply in the
193 X/Open Curses makes it clear that the WACS_ symbols should be defined
194 as a pointer to <STRONG>cchar_t</STRONG> data, e.g., in the discussion of <STRONG>border_set</STRONG>. A
195 few implementations are problematic:
197 <STRONG>o</STRONG> NetBSD curses defines the symbols as a <STRONG>wchar_t</STRONG> within a <STRONG>cchar_t</STRONG>.
199 <STRONG>o</STRONG> HPUX curses equates some of the <EM>ACS</EM><STRONG>_</STRONG> symbols to the analogous <EM>WACS</EM><STRONG>_</STRONG>
200 symbols as if the <EM>ACS</EM><STRONG>_</STRONG> symbols were wide characters. The misde-
201 fined symbols are the arrows and other symbols which are not used
204 X/Open Curses does not define symbols for thick- or double-lines. SVr4
205 curses implementations defined their line-drawing symbols in terms of
206 intermediate symbols. This implementation extends those symbols, pro-
207 viding new definitions which are not in the SVr4 implementations.
209 Not all Unicode-capable terminals provide support for VT100-style
210 alternate character sets (i.e., the <STRONG>acsc</STRONG> capability), with their corre-
211 sponding line-drawing characters. X/Open Curses did not address the
212 aspect of integrating Unicode with line-drawing characters. Existing
213 implementations of Unix curses (AIX, HPUX, Solaris) use only the <STRONG>acsc</STRONG>
214 character-mapping to provide this feature. As a result, those imple-
215 mentations can only use single-byte line-drawing characters. Ncurses
216 5.3 (2002) provided a table of Unicode values to solve these problems.
217 NetBSD curses incorporated that table in 2010.
219 In this implementation, the Unicode values are used instead of the ter-
220 minal description's <STRONG>acsc</STRONG> mapping as discussed in <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> for the
221 environment variable <STRONG>NCURSES_NO_UTF8_ACS</STRONG>. In contrast, for the same
222 cases, the line-drawing characters described in <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> will use
223 only the ASCII default values.
225 Having Unicode available does not solve all of the problems with line-
228 <STRONG>o</STRONG> The closest Unicode equivalents to the VT100 graphics <EM>S1</EM>, <EM>S3</EM>, <EM>S7</EM>
229 and <EM>S9</EM> frequently are not displayed at the regular intervals which
232 <STRONG>o</STRONG> The <EM>lantern</EM> is a special case. It originated with the AT&T 4410
233 terminal in the early 1980s. There is no accessible documentation
234 depicting the lantern symbol on the AT&T terminal.
236 Lacking documentation, most readers assume that a <EM>storm</EM> <EM>lantern</EM> was
237 intended. But there are several possibilities, all with problems.
239 Unicode 6.0 (2010) does provide two lantern symbols: U+1F383 and
240 U+1F3EE. Those were not available in 2002, and are irrelevant
241 since they lie outside the BMP and as a result are not generally
242 available in terminals. They are not storm lanterns, in any case.
244 Most <EM>storm</EM> <EM>lanterns</EM> have a tapering glass chimney (to guard against
245 tipping); some have a wire grid protecting the chimney.
247 For the tapering appearance, U+2603 was adequate. In use on a
248 terminal, no one can tell what the image represents. Unicode calls
251 Others have suggested these alternatives: S U+00A7 (section mark),
252 <STRONG>O</STRONG> U+0398 (theta), <STRONG>O</STRONG> U+03A6 (phi), d U+03B4 (delta), U+2327 (x in a
253 rectangle), U+256C (forms double vertical and horizontal), and
254 U+2612 (ballot box with x).
257 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
258 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG>curs_out-</STRONG>
259 <STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>putwc(3)</STRONG>
263 <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
267 <li><a href="#h2-NAME">NAME</a></li>
268 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
269 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
271 <li><a href="#h3-add_wch">add_wch</a></li>
272 <li><a href="#h3-echo_wchar">echo_wchar</a></li>
273 <li><a href="#h3-Line-Graphics">Line Graphics</a></li>
276 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
277 <li><a href="#h2-NOTES">NOTES</a></li>
278 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
279 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>