2 ****************************************************************************
3 * Copyright 2019,2020 Thomas E. Dickey *
4 * Copyright 2001-2015,2017 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_add_wch.3x,v 1.28 2020/10/17 23:10:38 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_add_wch 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_add_wch 3x</H1>
44 <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>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <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
51 a complex character and rendition to a <STRONG>curses</STRONG> window, then advance the
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 <STRONG>int</STRONG> <STRONG>add_wch(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
59 <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>
60 <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>
61 <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>
63 <STRONG>int</STRONG> <STRONG>echo_wchar(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
64 <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>
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 </PRE><H3><a name="h3-add_wch">add_wch</a></H3><PRE>
70 The <STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, and <STRONG>mvwadd_wch</STRONG> functions put the
71 complex character <EM>wch</EM> into the given window at its current position,
72 which is then advanced. These functions perform wrapping and special-
73 character processing as follows:
75 <STRONG>o</STRONG> If <EM>wch</EM> refers to a spacing character, then any previous character
76 at that location is removed. A new character specified by <EM>wch</EM> is
77 placed at that location with rendition specified by <EM>wch</EM>. The
78 cursor then advances to the next spacing character on the screen.
80 <STRONG>o</STRONG> If <EM>wch</EM> refers to a non-spacing character, all previous characters
81 at that location are preserved. The non-spacing characters of <EM>wch</EM>
82 are added to the spacing complex character, and the rendition
83 specified by <EM>wch</EM> is ignored.
85 <STRONG>o</STRONG> If the character part of <EM>wch</EM> is a tab, newline, backspace or other
86 control character, the window is updated and the cursor moves as if
87 <STRONG>addch</STRONG> were called.
90 </PRE><H3><a name="h3-echo_wchar">echo_wchar</a></H3><PRE>
91 The <STRONG>echo_wchar</STRONG> function is functionally equivalent to a call to <STRONG>add_wch</STRONG>
92 followed by a call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>. Similarly, the <STRONG>wecho_wchar</STRONG> is
93 functionally equivalent to a call to <STRONG>wadd_wch</STRONG> followed by a call to
94 <STRONG>wrefresh</STRONG>. The knowledge that only a single character is being output
95 is taken into consideration and, for non-control characters, a
96 considerable performance gain might be seen by using the *<STRONG>echo</STRONG>*
97 functions instead of their equivalents.
100 </PRE><H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
101 Like <STRONG><A HREF="curs_addch.3x.html">addch(3x)</A></STRONG>, <STRONG>addch_wch</STRONG> accepts symbols which make it simple to draw
102 lines and other frequently used special characters. These symbols
103 correspond to the same VT100 line-drawing set as <STRONG><A HREF="curs_addch.3x.html">addch(3x)</A></STRONG>.
105 <STRONG>ACS</STRONG> <STRONG>Unicode</STRONG> <STRONG>ASCII</STRONG> <STRONG>acsc</STRONG> <STRONG>Glyph</STRONG>
106 <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Default</STRONG> <STRONG>char</STRONG> <STRONG>Name</STRONG>
107 ------------------------------------------------------------------------
108 WACS_BLOCK 0x25ae # 0 solid square block
109 WACS_BOARD 0x2592 # h board of squares
110 WACS_BTEE 0x2534 + v bottom tee
111 WACS_BULLET 0x00b7 o ~ bullet
112 WACS_CKBOARD 0x2592 : a checker board (stipple)
113 WACS_DARROW 0x2193 v . arrow pointing down
114 WACS_DEGREE 0x00b0 ' f degree symbol
116 WACS_DIAMOND 0x25c6 + ` diamond
117 WACS_GEQUAL 0x2265 > > greater-than-or-equal-to
118 WACS_HLINE 0x2500 - q horizontal line
119 WACS_LANTERN 0x2603 # i lantern symbol
120 WACS_LARROW 0x2190 < , arrow pointing left
121 WACS_LEQUAL 0x2264 < y less-than-or-equal-to
122 WACS_LLCORNER 0x2514 + m lower left-hand corner
123 WACS_LRCORNER 0x2518 + j lower right-hand corner
124 WACS_LTEE 0x2524 + t left tee
125 WACS_NEQUAL 0x2260 ! | not-equal
126 WACS_PI 0x03c0 * { greek pi
127 WACS_PLMINUS 0x00b1 # g plus/minus
128 WACS_PLUS 0x253c + n plus
129 WACS_RARROW 0x2192 > + arrow pointing right
130 WACS_RTEE 0x251c + u right tee
131 WACS_S1 0x23ba - o scan line 1
132 WACS_S3 0x23bb - p scan line 3
133 WACS_S7 0x23bc - r scan line 7
134 WACS_S9 0x23bd _ s scan line 9
135 WACS_STERLING 0x00a3 f } pound-sterling symbol
136 WACS_TTEE 0x252c + w top tee
137 WACS_UARROW 0x2191 ^ - arrow pointing up
138 WACS_ULCORNER 0x250c + l upper left-hand corner
139 WACS_URCORNER 0x2510 + k upper right-hand corner
140 WACS_VLINE 0x2502 | x vertical line
142 The wide-character configuration of ncurses also defines symbols for
143 thick lines (<STRONG>acsc</STRONG> "J" to "V"):
145 <STRONG>ACS</STRONG> <STRONG>Unicode</STRONG> <STRONG>ASCII</STRONG> <STRONG>acsc</STRONG> <STRONG>Glyph</STRONG>
146 <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Default</STRONG> <STRONG>char</STRONG> <STRONG>Name</STRONG>
147 -----------------------------------------------------------------------
148 WACS_T_BTEE 0x253b + V thick tee pointing up
149 WACS_T_HLINE 0x2501 - Q thick horizontal line
150 WACS_T_LLCORNER 0x2517 + M thick lower left corner
151 WACS_T_LRCORNER 0x251b + J thick lower right corner
152 WACS_T_LTEE 0x252b + T thick tee pointing right
153 WACS_T_PLUS 0x254b + N thick large plus
154 WACS_T_RTEE 0x2523 + U thick tee pointing left
155 WACS_T_TTEE 0x2533 + W thick tee pointing down
156 WACS_T_ULCORNER 0x250f + L thick upper left corner
157 WACS_T_URCORNER 0x2513 + K thick upper right corner
158 WACS_T_VLINE 0x2503 | X thick vertical line
160 and for double-lines (<STRONG>acsc</STRONG> "A" to "I"):
162 <STRONG>ACS</STRONG> <STRONG>Unicode</STRONG> <STRONG>ASCII</STRONG> <STRONG>acsc</STRONG> <STRONG>Glyph</STRONG>
163 <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Default</STRONG> <STRONG>char</STRONG> <STRONG>Name</STRONG>
164 ------------------------------------------------------------------------
165 WACS_D_BTEE 0x2569 + H double tee pointing up
166 WACS_D_HLINE 0x2550 - R double horizontal line
167 WACS_D_LLCORNER 0x255a + D double lower left corner
168 WACS_D_LRCORNER 0x255d + A double lower right corner
169 WACS_D_LTEE 0x2560 + F double tee pointing right
170 WACS_D_PLUS 0x256c + E double large plus
171 WACS_D_RTEE 0x2563 + G double tee pointing left
172 WACS_D_TTEE 0x2566 + I double tee pointing down
173 WACS_D_ULCORNER 0x2554 + C double upper left corner
174 WACS_D_URCORNER 0x2557 + B double upper right corner
175 WACS_D_VLINE 0x2551 | Y double vertical line
177 Unicode's descriptions for these characters differs slightly from
178 ncurses, by introducing the term "light" (along with less important
179 details). Here are its descriptions for the normal, thick, and double
182 <STRONG>o</STRONG> U+2500 BOX DRAWINGS LIGHT HORIZONTAL
184 <STRONG>o</STRONG> U+2501 BOX DRAWINGS HEAVY HORIZONTAL
186 <STRONG>o</STRONG> U+2550 BOX DRAWINGS DOUBLE HORIZONTAL
189 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
190 All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on success.
192 X/Open does not define any error conditions. This implementation
195 <STRONG>o</STRONG> if the window pointer is null or
197 <STRONG>o</STRONG> if it is not possible to add a complete character in the window.
199 The latter may be due to different causes:
201 <STRONG>o</STRONG> If <STRONG>scrollok</STRONG> is not enabled, writing a character at the lower right
202 margin succeeds. However, an error is returned because it is not
203 possible to wrap to a new line
205 <STRONG>o</STRONG> If an error is detected when converting a multibyte character to a
206 sequence of bytes, or if it is not possible to add all of the
207 resulting bytes in the window, an error is returned.
209 Functions with a "mv" prefix first perform a cursor movement using
210 <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
211 the window pointer is null.
214 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
215 Note that <STRONG>add_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>, and <STRONG>echo_wchar</STRONG> may be macros.
218 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
219 All of these functions are described in the XSI Curses standard, Issue
220 4. The defaults specified for line-drawing characters apply in the
223 X/Open Curses makes it clear that the WACS_ symbols should be defined
224 as a pointer to <STRONG>cchar_t</STRONG> data, e.g., in the discussion of <STRONG>border_set</STRONG>. A
225 few implementations are problematic:
227 <STRONG>o</STRONG> NetBSD curses defines the symbols as a <STRONG>wchar_t</STRONG> within a <STRONG>cchar_t</STRONG>.
229 <STRONG>o</STRONG> HPUX curses equates some of the <EM>ACS</EM><STRONG>_</STRONG> symbols to the analogous <EM>WACS</EM><STRONG>_</STRONG>
230 symbols as if the <EM>ACS</EM><STRONG>_</STRONG> symbols were wide characters. The
231 misdefined symbols are the arrows and other symbols which are not
232 used for line-drawing.
234 X/Open Curses does not define symbols for thick- or double-lines. SVr4
235 curses implementations defined their line-drawing symbols in terms of
236 intermediate symbols. This implementation extends those symbols,
237 providing new definitions which are not in the SVr4 implementations.
239 Not all Unicode-capable terminals provide support for VT100-style
240 alternate character sets (i.e., the <STRONG>acsc</STRONG> capability), with their
241 corresponding line-drawing characters. X/Open Curses did not address
242 the aspect of integrating Unicode with line-drawing characters.
243 Existing implementations of Unix curses (AIX, HPUX, Solaris) use only
244 the <STRONG>acsc</STRONG> character-mapping to provide this feature. As a result, those
245 implementations can only use single-byte line-drawing characters.
246 Ncurses 5.3 (2002) provided a table of Unicode values to solve these
247 problems. NetBSD curses incorporated that table in 2010.
249 In this implementation, the Unicode values are used instead of the
250 terminal description's <STRONG>acsc</STRONG> mapping as discussed in <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> for the
251 environment variable <STRONG>NCURSES_NO_UTF8_ACS</STRONG>. In contrast, for the same
252 cases, the line-drawing characters described in <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> will use
253 only the ASCII default values.
255 Having Unicode available does not solve all of the problems with line-
258 <STRONG>o</STRONG> The closest Unicode equivalents to the VT100 graphics <EM>S1</EM>, <EM>S3</EM>, <EM>S7</EM>
259 and <EM>S9</EM> frequently are not displayed at the regular intervals which
262 <STRONG>o</STRONG> The <EM>lantern</EM> is a special case. It originated with the AT&T 4410
263 terminal in the early 1980s. There is no accessible documentation
264 depicting the lantern symbol on the AT&T terminal.
266 Lacking documentation, most readers assume that a <EM>storm</EM> <EM>lantern</EM> was
267 intended. But there are several possibilities, all with problems.
269 Unicode 6.0 (2010) does provide two lantern symbols: U+1F383 and
270 U+1F3EE. Those were not available in 2002, and are irrelevant
271 since they lie outside the BMP and as a result are not generally
272 available in terminals. They are not storm lanterns, in any case.
274 Most <EM>storm</EM> <EM>lanterns</EM> have a tapering glass chimney (to guard against
275 tipping); some have a wire grid protecting the chimney.
277 For the tapering appearance, U+2603 was adequate. In use on a
278 terminal, no one can tell what the image represents. Unicode calls
281 Others have suggested these alternatives: <section> U+00A7 (section
282 mark), <Theta> U+0398 (theta), <Phi> U+03A6 (phi), <delta> U+03B4
283 (delta), U+2327 (x in a rectangle), U+256C (forms double vertical
284 and horizontal), and U+2612 (ballot box with x).
287 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
288 <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>,
289 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>putwc(3)</STRONG>
293 <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
297 <li><a href="#h2-NAME">NAME</a></li>
298 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
299 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
301 <li><a href="#h3-add_wch">add_wch</a></li>
302 <li><a href="#h3-echo_wchar">echo_wchar</a></li>
303 <li><a href="#h3-Line-Graphics">Line Graphics</a></li>
306 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
307 <li><a href="#h2-NOTES">NOTES</a></li>
308 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
309 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>