]> ncurses.scripts.mit.edu Git - ncurses.git/blob - man/curs_add_wch.3x
ncurses 6.4 - patch 20230701
[ncurses.git] / man / curs_add_wch.3x
1 .\"***************************************************************************
2 .\" Copyright 2019-2021,2023 Thomas E. Dickey                                *
3 .\" Copyright 2001-2015,2017 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
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:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
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.                               *
23 .\"                                                                          *
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       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: curs_add_wch.3x,v 1.36 2023/07/01 14:23:04 tom Exp $
31 .TH curs_add_wch 3X 2023-07-01 "ncurses 6.4" "Library calls"
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .de bP
37 .ie n  .IP \(bu 4
38 .el    .IP \(bu 2
39 ..
40 .SH NAME
41 \fBadd_wch\fP,
42 \fBwadd_wch\fP,
43 \fBmvadd_wch\fP,
44 \fBmvwadd_wch\fP,
45 \fBecho_wchar\fP,
46 \fBwecho_wchar\fP \- add a complex character and rendition to a \fBcurses\fP window, then advance the cursor
47 .SH SYNOPSIS
48 \fB#include <curses.h>\fP
49 .sp
50 .B "int add_wch( const cchar_t *\fIwch\fB );"
51 .br
52 .B "int wadd_wch( WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB );"
53 .br
54 .B "int mvadd_wch( int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fB );"
55 .br
56 .B "int mvwadd_wch( WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fB );"
57 .sp
58 .B "int echo_wchar( const cchar_t *\fIwch\fB );"
59 .br
60 .B "int wecho_wchar( WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB );"
61 .SH DESCRIPTION
62 .SS add_wch
63 The
64 \fBadd_wch\fP,
65 \fBwadd_wch\fP,
66 \fBmvadd_wch\fP, and
67 \fBmvwadd_wch\fP
68 functions put the complex character \fIwch\fP into the given
69 window at its current position,
70 which is then advanced.
71 These functions perform
72 wrapping and special-character processing as follows:
73 .bP
74 If \fIwch\fP refers to a spacing character,
75 then any previous character at that location is removed.
76 A new character specified by \fIwch\fP is
77 placed at that location with rendition specified by \fIwch\fP.
78 The cursor then advances to
79 the next spacing character on the screen.
80 .bP
81 If \fIwch\fP refers to a non-spacing character,
82 all previous characters at that location are preserved.
83 The non-spacing characters of \fIwch\fP
84 are added to the spacing complex character,
85 and the rendition specified by \fIwch\fP is ignored.
86 .bP
87 If the character part of \fIwch\fP is
88 a tab, newline, backspace or other control character,
89 the window is updated and the cursor moves as if \fBaddch\fP were called.
90 .SS echo_wchar
91 The \fBecho_wchar\fP
92 function is functionally equivalent to a call to
93 \fBadd_wch\fP
94 followed by a call to
95 \fBrefresh\fP(3X).
96 Similarly, the
97 \fBwecho_wchar\fP
98 is functionally equivalent to a call to
99 \fBwadd_wch\fP
100 followed by a call to
101 \fBwrefresh\fP.
102 The knowledge
103 that only a single character is being output is taken into consideration and,
104 for non-control characters, a considerable performance gain might be seen
105 by using the *\fBecho\fP* functions instead of their equivalents.
106 .SS Line Graphics
107 Like \fBaddch\fP(3X),
108 \fBaddch_wch\fP accepts symbols which make it simple to draw lines and other
109 frequently used special characters.
110 These symbols correspond to the same VT100 line-drawing set as
111 \fBaddch\fP(3X).
112 .PP
113 .TS
114 l l l l l
115 l l l l l
116 _ _ _ _ _
117 lw(1.5i) lw5 lw5 lw5 lw20.
118 \fBACS\fP       \fBUnicode\fP   \fBASCII\fP     \fBacsc\fP      \fBGlyph\fP
119 \fBName\fP      \fBDefault\fP   \fBDefault\fP   \fBchar\fP      \fBName\fP
120 WACS_BLOCK      0x25ae  #       0       solid square block
121 WACS_BOARD      0x2592  #       h       board of squares
122 WACS_BTEE       0x2534  +       v       bottom tee
123 WACS_BULLET     0x00b7  o       ~       bullet
124 WACS_CKBOARD    0x2592  :       a       checker board (stipple)
125 WACS_DARROW     0x2193  v       .       arrow pointing down
126 WACS_DEGREE     0x00b0  '       f       degree symbol
127 WACS_DIAMOND    0x25c6  +       `       diamond
128 WACS_GEQUAL     0x2265  >       >       greater-than-or-equal-to
129 WACS_HLINE      0x2500  \-      q       horizontal line
130 WACS_LANTERN    0x2603  #       i       lantern symbol
131 WACS_LARROW     0x2190  <       ,       arrow pointing left
132 WACS_LEQUAL     0x2264  <       y       less-than-or-equal-to
133 WACS_LLCORNER   0x2514  +       m       lower left-hand corner
134 WACS_LRCORNER   0x2518  +       j       lower right-hand corner
135 WACS_LTEE       0x2524  +       t       left tee
136 WACS_NEQUAL     0x2260  !       |       not-equal
137 WACS_PI 0x03c0  *       {       greek pi
138 WACS_PLMINUS    0x00b1  #       g       plus/minus
139 WACS_PLUS       0x253c  +       n       plus
140 WACS_RARROW     0x2192  >       +       arrow pointing right
141 WACS_RTEE       0x251c  +       u       right tee
142 WACS_S1 0x23ba  \-      o       scan line 1
143 WACS_S3 0x23bb  \-      p       scan line 3
144 WACS_S7 0x23bc  \-      r       scan line 7
145 WACS_S9 0x23bd  \&_     s       scan line 9
146 WACS_STERLING   0x00a3  f       }       pound-sterling symbol
147 WACS_TTEE       0x252c  +       w       top tee
148 WACS_UARROW     0x2191          ^       \-      arrow pointing up
149 WACS_ULCORNER   0x250c  +       l       upper left-hand corner
150 WACS_URCORNER   0x2510  +       k       upper right-hand corner
151 WACS_VLINE      0x2502  |       x       vertical line
152 .TE
153 .PP
154 The wide-character configuration of ncurses also defines symbols
155 for thick lines (\fBacsc\fP \*(``J\*('' to \*(``V\*(''):
156 .TS
157 l l l l l
158 l l l l l
159 _ _ _ _ _
160 lw(1.5i) lw5 lw5 lw5 lw20.
161 \fBACS\fP       \fBUnicode\fP   \fBASCII\fP     \fBacsc\fP      \fBGlyph\fP
162 \fBName\fP      \fBDefault\fP   \fBDefault\fP   \fBchar\fP      \fBName\fP
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
174 .TE
175 .PP
176 and for double-lines (\fBacsc\fP \*(``A\*('' to \*(``I\*(''):
177 .PP
178 .TS
179 l l l l l
180 l l l l l
181 _ _ _ _ _
182 lw(1.5i) lw5 lw5 lw5 lw20.
183 \fBACS\fP       \fBUnicode\fP   \fBASCII\fP     \fBacsc\fP      \fBGlyph\fP
184 \fBName\fP      \fBDefault\fP   \fBDefault\fP   \fBchar\fP      \fBName\fP
185 WACS_D_BTEE     0x2569  +       H       double tee pointing up
186 WACS_D_HLINE    0x2550  -       R       double horizontal line
187 WACS_D_LLCORNER 0x255a  +       D       double lower left corner
188 WACS_D_LRCORNER 0x255d  +       A       double lower right corner
189 WACS_D_LTEE     0x2560  +       F       double tee pointing right
190 WACS_D_PLUS     0x256c  +       E       double large plus
191 WACS_D_RTEE     0x2563  +       G       double tee pointing left
192 WACS_D_TTEE     0x2566  +       I       double tee pointing down
193 WACS_D_ULCORNER 0x2554  +       C       double upper left corner
194 WACS_D_URCORNER 0x2557  +       B       double upper right corner
195 WACS_D_VLINE    0x2551  |       Y       double vertical line
196 .TE
197 .PP
198 Unicode's descriptions for these characters differs slightly from ncurses,
199 by introducing the term \*(``light\*('' (along with less important details).
200 Here are its descriptions for the normal, thick, and double horizontal lines:
201 .bP
202 U+2500 BOX DRAWINGS LIGHT HORIZONTAL
203 .bP
204 U+2501 BOX DRAWINGS HEAVY HORIZONTAL
205 .bP
206 U+2550 BOX DRAWINGS DOUBLE HORIZONTAL
207 .SH RETURN VALUE
208 All routines return the integer \fBERR\fP upon failure and \fBOK\fP on success.
209 .PP
210 X/Open does not define any error conditions.
211 This implementation returns an error
212 .bP
213 if the window pointer is null or
214 .bP
215 if it is not possible to add a complete character in the window.
216 .PP
217 The latter may be due to different causes:
218 .bP
219 If \fBscrollok\fP(3X) is not enabled,
220 writing a character at the lower right margin succeeds.
221 However, an error is returned because
222 it is not possible to wrap to a new line
223 .bP
224 If an error is detected when converting a multibyte character to a sequence
225 of bytes,
226 or if it is not possible to add all of the resulting bytes in the window,
227 an error is returned.
228 .PP
229 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
230 \fBwmove\fP, and return an error if the position is outside the window,
231 or if the window pointer is null.
232 .SH NOTES
233 Note that
234 \fBadd_wch\fP,
235 \fBmvadd_wch\fP,
236 \fBmvwadd_wch\fP, and
237 \fBecho_wchar\fP
238 may be macros.
239 .SH PORTABILITY
240 All of these functions are described in the XSI Curses standard, Issue 4.
241 The defaults specified for line-drawing characters apply in the POSIX locale.
242 .PP
243 X/Open Curses makes it clear that the WACS_ symbols should be defined as
244 a pointer to \fBcchar_t\fP data, e.g., in the discussion of \fBborder_set\fP.
245 A few implementations are problematic:
246 .bP
247 NetBSD curses defines the symbols as a \fBwchar_t\fP within a \fBcchar_t\fP.
248 .bP
249 HPUX curses equates some of the \fBACS_\fP symbols
250 to the analogous \fBWACS_\fP symbols as if the \fBACS_\fP symbols were
251 wide characters.
252 The misdefined symbols are the arrows
253 and other symbols which are not used for line-drawing.
254 .PP
255 X/Open Curses does not define symbols for thick- or double-lines.
256 SVr4 curses implementations defined their line-drawing symbols in
257 terms of intermediate symbols.
258 This implementation extends those symbols, providing new definitions
259 which are not in the SVr4 implementations.
260 .PP
261 Not all Unicode-capable terminals provide support for VT100-style
262 alternate character sets (i.e., the \fBacsc\fP capability),
263 with their corresponding line-drawing characters.
264 X/Open Curses did not address the aspect of integrating Unicode with
265 line-drawing characters.
266 Existing implementations of Unix curses (AIX, HPUX, Solaris)
267 use only the \fBacsc\fP character-mapping to provide this feature.
268 As a result, those implementations can only use single-byte line-drawing
269 characters.
270 Ncurses 5.3 (2002) provided a table of Unicode values to solve these problems.
271 NetBSD curses incorporated that table in 2010.
272 .PP
273 In this implementation, the Unicode values are used instead of the
274 terminal description's \fBacsc\fP mapping as discussed in ncurses(3X)
275 for the environment variable \fBNCURSES_NO_UTF8_ACS\fP.
276 In contrast, for the same cases, the line-drawing characters
277 described in \fBcurs_addch\fP(3X) will use only the ASCII default values.
278 .PP
279 Having Unicode available does not solve all of the problems with
280 line-drawing for curses:
281 .bP
282 The closest Unicode equivalents to the
283 VT100 graphics \fIS1\fP, \fIS3\fP, \fIS7\fP and \fIS9\fP
284 frequently are not displayed at
285 the regular intervals which the terminal used.
286 .bP
287 The \fIlantern\fP is a special case.
288 It originated with the AT&T 4410 terminal in the early 1980s.
289 There is no accessible documentation depicting the lantern symbol
290 on the AT&T terminal.
291 .IP
292 Lacking documentation, most readers assume that a \fIstorm lantern\fP
293 was intended.
294 But there are several possibilities, all with problems.
295 .IP
296 Unicode 6.0 (2010) does provide two lantern symbols: U+1F383 and U+1F3EE.
297 Those were not available in 2002, and are irrelevant since
298 they lie outside the BMP and as a result are not generally available
299 in terminals.
300 They are not storm lanterns, in any case.
301 .IP
302 Most \fIstorm lanterns\fP have a tapering glass chimney
303 (to guard against tipping);
304 some have a wire grid protecting the chimney.
305 .IP
306 For the tapering appearance, \[u2603] U+2603 was adequate.
307 In use on a terminal, no one can tell what the image represents.
308 Unicode calls it a snowman.
309 .IP
310 Others have suggested these alternatives:
311 \[sc] U+00A7 (section mark),
312 \[u0398] U+0398 (theta),
313 \[u03A6] U+03A6 (phi),
314 \[u03B4] U+03B4 (delta),
315 \[u2327] U+2327 (x in a rectangle),
316 \[u256C] U+256C (forms double vertical and horizontal), and
317 \[u2612] U+2612 (ballot box with x).
318 .SH SEE ALSO
319 .na
320 \fBcurses\fP(3X),
321 \fBcurs_addch\fP(3X),
322 \fBcurs_attr\fP(3X),
323 \fBcurs_clear\fP(3X),
324 \fBcurs_outopts\fP(3X),
325 \fBcurs_refresh\fP(3X),
326 \fBputwc\fP(3)