X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_add_wch.3x.html;h=b71fc03f50351364d9254c79d4f532e0e1604fab;hp=3891f83ccf57bd19f2d46f89baa68eba8f9f7049;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280 diff --git a/doc/html/man/curs_add_wch.3x.html b/doc/html/man/curs_add_wch.3x.html index 3891f83c..b71fc03f 100644 --- a/doc/html/man/curs_add_wch.3x.html +++ b/doc/html/man/curs_add_wch.3x.html @@ -1,4 +1,4 @@ - @@ -59,6 +59,7 @@ int wadd_wch( WINDOW *win, const cchar_t *wch ); int mvadd_wch( int y, int x, const cchar_t *wch ); int mvwadd_wch( WINDOW *win, int y, int x, const cchar_t *wch ); + int echo_wchar( const cchar_t *wch ); int wecho_wchar( WINDOW *win, const cchar_t *wch ); @@ -66,20 +67,20 @@
- The add_wch, wadd_wch, mvadd_wch, and mvwadd_wch functions put the com- - plex character wch into the given window at its current position, which - is then advanced. These functions perform wrapping and special-charac- - ter processing as follows: + The add_wch, wadd_wch, mvadd_wch, and mvwadd_wch functions put the + complex character wch into the given window at its current position, + which is then advanced. These functions perform wrapping and special- + character processing as follows: o If wch refers to a spacing character, then any previous character at that location is removed. A new character specified by wch is - placed at that location with rendition specified by wch. The cur- - sor then advances to the next spacing character on the screen. + placed at that location with rendition specified by wch. The + cursor then advances to the next spacing character on the screen. o If wch refers to a non-spacing character, all previous characters at that location are preserved. The non-spacing characters of wch - are added to the spacing complex character, and the rendition spec- - ified by wch is ignored. + are added to the spacing complex character, and the rendition + specified by wch is ignored. o If the character part of wch is a tab, newline, backspace or other control character, the window is updated and the cursor moves as if @@ -88,18 +89,18 @@
The echo_wchar function is functionally equivalent to a call to add_wch - followed by a call to refresh(3x). Similarly, the wecho_wchar is func- - tionally equivalent to a call to wadd_wch followed by a call to wre- - fresh. The knowledge that only a single character is being output is - taken into consideration and, for non-control characters, a consider- - able performance gain might be seen by using the *echo* functions - instead of their equivalents. + followed by a call to refresh(3x). Similarly, the wecho_wchar is + functionally equivalent to a call to wadd_wch followed by a call to + wrefresh. The knowledge that only a single character is being output + is taken into consideration and, for non-control characters, a + considerable performance gain might be seen by using the *echo* + functions instead of their equivalents.
Like addch(3x), addch_wch accepts symbols which make it simple to draw - lines and other frequently used special characters. These symbols cor- - respond to the same VT100 line-drawing set as addch(3x). + lines and other frequently used special characters. These symbols + correspond to the same VT100 line-drawing set as addch(3x). ACS Unicode ASCII acsc Glyph Name Default Default char Name @@ -111,8 +112,8 @@ WACS_CKBOARD 0x2592 : a checker board (stipple) WACS_DARROW 0x2193 v . arrow pointing down WACS_DEGREE 0x00b0 ' f degree symbol - WACS_DIAMOND 0x25c6 + ` diamond + WACS_DIAMOND 0x25c6 + ` diamond WACS_GEQUAL 0x2265 > > greater-than-or-equal-to WACS_HLINE 0x2500 - q horizontal line WACS_LANTERN 0x2603 # i lantern symbol @@ -188,7 +189,24 @@
All routines return the integer ERR upon failure and OK on success. - Functions with a "mv" prefix first perform a cursor movement using + X/Open does not define any error conditions. This implementation + returns an error + + o if the window pointer is null or + + o if it is not possible to add a complete character in the window. + + The latter may be due to different causes: + + o If scrollok is not enabled, writing a character at the lower right + margin succeeds. However, an error is returned because it is not + possible to wrap to a new line + + o If an error is detected when converting a multibyte character to a + sequence of bytes, or if it is not possible to add all of the + resulting bytes in the window, an error is returned. + + Functions with a "mv" prefix first perform a cursor movement using wmove, and return an error if the position is outside the window, or if the window pointer is null. @@ -198,77 +216,77 @@
- All of these functions are described in the XSI Curses standard, Issue - 4. The defaults specified for line-drawing characters apply in the + All of these functions are described in the XSI Curses standard, Issue + 4. The defaults specified for line-drawing characters apply in the POSIX locale. - X/Open Curses makes it clear that the WACS_ symbols should be defined + X/Open Curses makes it clear that the WACS_ symbols should be defined as a pointer to cchar_t data, e.g., in the discussion of border_set. A few implementations are problematic: o NetBSD curses defines the symbols as a wchar_t within a cchar_t. o HPUX curses equates some of the ACS_ symbols to the analogous WACS_ - symbols as if the ACS_ symbols were wide characters. The misde- - fined symbols are the arrows and other symbols which are not used - for line-drawing. + symbols as if the ACS_ symbols were wide characters. The + misdefined symbols are the arrows and other symbols which are not + used for line-drawing. X/Open Curses does not define symbols for thick- or double-lines. SVr4 - curses implementations defined their line-drawing symbols in terms of - intermediate symbols. This implementation extends those symbols, pro- - viding new definitions which are not in the SVr4 implementations. - - Not all Unicode-capable terminals provide support for VT100-style - alternate character sets (i.e., the acsc capability), with their corre- - sponding line-drawing characters. X/Open Curses did not address the - aspect of integrating Unicode with line-drawing characters. Existing - implementations of Unix curses (AIX, HPUX, Solaris) use only the acsc - character-mapping to provide this feature. As a result, those imple- - mentations can only use single-byte line-drawing characters. Ncurses - 5.3 (2002) provided a table of Unicode values to solve these problems. - NetBSD curses incorporated that table in 2010. - - In this implementation, the Unicode values are used instead of the ter- - minal description's acsc mapping as discussed in ncurses(3x) for the - environment variable NCURSES_NO_UTF8_ACS. In contrast, for the same + curses implementations defined their line-drawing symbols in terms of + intermediate symbols. This implementation extends those symbols, + providing new definitions which are not in the SVr4 implementations. + + Not all Unicode-capable terminals provide support for VT100-style + alternate character sets (i.e., the acsc capability), with their + corresponding line-drawing characters. X/Open Curses did not address + the aspect of integrating Unicode with line-drawing characters. + Existing implementations of Unix curses (AIX, HPUX, Solaris) use only + the acsc character-mapping to provide this feature. As a result, those + implementations can only use single-byte line-drawing characters. + Ncurses 5.3 (2002) provided a table of Unicode values to solve these + problems. NetBSD curses incorporated that table in 2010. + + In this implementation, the Unicode values are used instead of the + terminal description's acsc mapping as discussed in ncurses(3x) for the + environment variable NCURSES_NO_UTF8_ACS. In contrast, for the same cases, the line-drawing characters described in curs_addch(3x) will use only the ASCII default values. - Having Unicode available does not solve all of the problems with line- + Having Unicode available does not solve all of the problems with line- drawing for curses: - o The closest Unicode equivalents to the VT100 graphics S1, S3, S7 - and S9 frequently are not displayed at the regular intervals which + o The closest Unicode equivalents to the VT100 graphics S1, S3, S7 + and S9 frequently are not displayed at the regular intervals which the terminal used. - o The lantern is a special case. It originated with the AT&T 4410 - terminal in the early 1980s. There is no accessible documentation + o The lantern is a special case. It originated with the AT&T 4410 + terminal in the early 1980s. There is no accessible documentation depicting the lantern symbol on the AT&T terminal. Lacking documentation, most readers assume that a storm lantern was intended. But there are several possibilities, all with problems. - Unicode 6.0 (2010) does provide two lantern symbols: U+1F383 and - U+1F3EE. Those were not available in 2002, and are irrelevant - since they lie outside the BMP and as a result are not generally + Unicode 6.0 (2010) does provide two lantern symbols: U+1F383 and + U+1F3EE. Those were not available in 2002, and are irrelevant + since they lie outside the BMP and as a result are not generally available in terminals. They are not storm lanterns, in any case. Most storm lanterns have a tapering glass chimney (to guard against tipping); some have a wire grid protecting the chimney. - For the tapering appearance, U+2603 was adequate. In use on a + For the tapering appearance, U+2603 was adequate. In use on a terminal, no one can tell what the image represents. Unicode calls it a snowman. - Others have suggested these alternatives: S U+00A7 (section mark), - O U+0398 (theta), O U+03A6 (phi), d U+03B4 (delta), U+2327 (x in a - rectangle), U+256C (forms double vertical and horizontal), and - U+2612 (ballot box with x). + Others have suggested these alternatives: <section> U+00A7 (section + mark), <Theta> U+0398 (theta), <Phi> U+03A6 (phi), <delta> U+03B4 + (delta), U+2327 (x in a rectangle), U+256C (forms double vertical + and horizontal), and U+2612 (ballot box with x).
- curses(3x), curs_addch(3x), curs_attr(3x), curs_clear(3x), curs_out- - opts(3x), curs_refresh(3x), putwc(3) + curses(3x), curs_addch(3x), curs_attr(3x), curs_clear(3x), + curs_outopts(3x), curs_refresh(3x), putwc(3)