1 /****************************************************************************
2 * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
32 ** The routine waddch().
36 #include <curses.priv.h>
39 MODULE_ID("$Id: lib_addch.c,v 1.131 2017/07/29 20:42:02 tom Exp $")
41 static const NCURSES_CH_T blankchar = NewChar(BLANK_TEXT);
44 * Ugly microtweaking alert. Everything from here to end of module is
45 * likely to be speed-critical -- profiling data sure says it is!
46 * Most of the important screen-painting functions are shells around
47 * waddch(). So we make every effort to reduce function-call overhead
48 * by inlining stuff, even at the cost of making wrapped copies for
49 * export. Also we supply some internal versions that don't call the
50 * window sync hook, for use by string-put functions.
53 /* Return bit mask for clearing color pair number if given ch has color */
54 #define COLOR_MASK(ch) (~(attr_t)(((ch) & A_COLOR) ? A_COLOR : 0))
56 static NCURSES_INLINE NCURSES_CH_T
57 render_char(WINDOW *win, NCURSES_CH_T ch)
58 /* compute a rendition of the given char correct for the current context */
60 attr_t a = WINDOW_ATTRS(win);
61 int pair = GetPair(ch);
64 && AttrOf(ch) == A_NORMAL
66 /* color/pair in attrs has precedence over bkgrnd */
68 SetAttr(ch, a | AttrOf(win->_nc_bkgd));
69 if ((pair = GET_WINDOW_PAIR(win)) == 0)
70 pair = GetPair(win->_nc_bkgd);
73 /* color in attrs has precedence over bkgrnd */
74 a |= AttrOf(win->_nc_bkgd) & COLOR_MASK(a);
75 /* color in ch has precedence */
77 if ((pair = GET_WINDOW_PAIR(win)) == 0)
78 pair = GetPair(win->_nc_bkgd);
80 AddAttr(ch, (a & COLOR_MASK(AttrOf(ch))));
85 ("render_char bkg %s (%d), attrs %s (%d) -> ch %s (%d)",
86 _tracech_t2(1, CHREF(win->_nc_bkgd)),
87 GetPair(win->_nc_bkgd),
88 _traceattr(WINDOW_ATTRS(win)),
90 _tracech_t2(3, CHREF(ch)),
96 NCURSES_EXPORT(NCURSES_CH_T)
97 _nc_render(WINDOW *win, NCURSES_CH_T ch)
98 /* make render_char() visible while still allowing us to inline it below */
100 return render_char(win, ch);
103 /* check if position is legal; if not, return error */
104 #ifndef NDEBUG /* treat this like an assertion */
105 #define CHECK_POSITION(win, x, y) \
110 TR(TRACE_VIRTPUT, ("Alert! Win=%p _curx = %d, _cury = %d " \
111 "(_maxx = %d, _maxy = %d)", win, x, y, \
112 win->_maxx, win->_maxy)); \
116 #define CHECK_POSITION(win, x, y) /* nothing */
120 newline_forces_scroll(WINDOW *win, NCURSES_SIZE_T *ypos)
124 if (*ypos >= win->_regtop && *ypos <= win->_regbottom) {
125 if (*ypos == win->_regbottom) {
126 *ypos = win->_regbottom;
129 *ypos = (NCURSES_SIZE_T) (*ypos + 1);
131 } else if (*ypos < win->_maxy) {
132 *ypos = (NCURSES_SIZE_T) (*ypos + 1);
138 * The _WRAPPED flag is useful only for telling an application that we've just
139 * wrapped the cursor. We don't do anything with this flag except set it when
140 * wrapping, and clear it whenever we move the cursor. If we try to wrap at
141 * the lower-right corner of a window, we cannot move the cursor (since that
142 * wouldn't be legal). So we return an error (which is what SVr4 does).
143 * Unlike SVr4, we can successfully add a character to the lower-right corner
144 * (Solaris 2.6 does this also, however).
147 wrap_to_next_line(WINDOW *win)
149 win->_flags |= _WRAPPED;
150 if (newline_forces_scroll(win, &(win->_cury))) {
151 win->_curx = win->_maxx;
160 #if USE_WIDEC_SUPPORT
161 static int waddch_literal(WINDOW *, NCURSES_CH_T);
163 * Fill the given number of cells with blanks using the current background
164 * rendition. This saves/restores the current x-position.
167 fill_cells(WINDOW *win, int count)
169 NCURSES_CH_T blank = blankchar;
170 int save_x = win->_curx;
171 int save_y = win->_cury;
173 while (count-- > 0) {
174 if (waddch_literal(win, blank) == ERR)
177 win->_curx = (NCURSES_SIZE_T) save_x;
178 win->_cury = (NCURSES_SIZE_T) save_y;
183 * Build up the bytes for a multibyte character, returning the length when
184 * complete (a positive number), -1 for error and -2 for incomplete.
186 #if USE_WIDEC_SUPPORT
188 _nc_build_wch(WINDOW *win, ARG_CH_T ch)
190 char *buffer = WINDOW_EXT(win, addch_work);
197 if ((WINDOW_EXT(win, addch_used) != 0) &&
198 (WINDOW_EXT(win, addch_x) != x ||
199 WINDOW_EXT(win, addch_y) != y)) {
200 /* discard the incomplete multibyte character */
201 WINDOW_EXT(win, addch_used) = 0;
203 ("Alert discarded multibyte on move (%d,%d) -> (%d,%d)",
204 WINDOW_EXT(win, addch_y), WINDOW_EXT(win, addch_x),
207 WINDOW_EXT(win, addch_x) = x;
208 WINDOW_EXT(win, addch_y) = y;
211 buffer[WINDOW_EXT(win, addch_used)] = (char) CharOf(CHDEREF(ch));
212 WINDOW_EXT(win, addch_used) += 1;
213 buffer[WINDOW_EXT(win, addch_used)] = '\0';
214 if ((len = (int) mbrtowc(&result,
216 (size_t) WINDOW_EXT(win, addch_used),
218 attr_t attrs = AttrOf(CHDEREF(ch));
219 if_EXT_COLORS(int pair = GetPair(CHDEREF(ch)));
220 SetChar(CHDEREF(ch), result, attrs);
221 if_EXT_COLORS(SetPair(CHDEREF(ch), pair));
222 WINDOW_EXT(win, addch_used) = 0;
223 } else if (len == -1) {
225 * An error occurred. We could either discard everything,
226 * or assume that the error was in the previous input.
229 TR(TRACE_VIRTPUT, ("Alert! mbrtowc returns error"));
230 /* handle this with unctrl() */
231 WINDOW_EXT(win, addch_used) = 0;
235 #endif /* USE_WIDEC_SUPPORT */
238 #if !USE_WIDEC_SUPPORT /* cannot be inline if it is recursive */
242 waddch_literal(WINDOW *win, NCURSES_CH_T ch)
251 CHECK_POSITION(win, x, y);
253 ch = render_char(win, ch);
255 line = win->_line + y;
257 CHANGED_CELL(line, x);
260 * Build up multibyte characters until we have a wide-character.
263 #define DeriveSP() SCREEN *sp = _nc_screen_of(win);
265 #define DeriveSP() /*nothing */
269 if (WINDOW_EXT(win, addch_used) != 0 || !Charable(ch)) {
270 int len = _nc_build_wch(win, CHREF(ch));
273 attr_t attr = AttrOf(ch);
275 /* handle EILSEQ (i.e., when len >= -1) */
276 if (len == -1 && is8bits(CharOf(ch))) {
277 const char *s = NCURSES_SP_NAME(unctrl)
278 (NCURSES_SP_ARGx (chtype) CharOf(ch));
283 rc = waddch(win, UChar(*s) | attr);
292 return waddch(win, ' ' | attr);
300 * Non-spacing characters are added to the current cell.
302 * Spacing characters that are wider than one column require some display
306 int len = wcwidth(CharOf(ch));
311 if (len == 0) { /* non-spacing */
312 if ((x > 0 && y >= 0)
313 || (win->_maxx >= 0 && win->_cury >= 1)) {
315 chars = (win->_line[y].text[x - 1].chars);
317 chars = (win->_line[y - 1].text[win->_maxx].chars);
318 for (i = 0; i < CCHARW_MAX; ++i) {
321 ("added non-spacing %d: %x",
322 x, (int) CharOf(ch)));
323 chars[i] = CharOf(ch);
329 } else if (len > 1) { /* multi-column characters */
331 * Check if the character will fit on the current line. If it does
332 * not fit, fill in the remainder of the line with blanks. and
333 * move to the next line.
335 if (len > win->_maxx + 1) {
336 TR(TRACE_VIRTPUT, ("character will not fit"));
338 } else if (x + len > win->_maxx + 1) {
339 int count = win->_maxx + 1 - x;
340 TR(TRACE_VIRTPUT, ("fill %d remaining cells", count));
341 fill_cells(win, count);
342 if (wrap_to_next_line(win) == ERR)
346 line = win->_line + y;
349 * Check for cells which are orphaned by adding this character, set
352 * FIXME: this actually could fill j-i cells, more complicated to
355 for (i = 0; i < len; ++i) {
356 if (isWidecBase(win->_line[y].text[x + i])) {
358 } else if (isWidecExt(win->_line[y].text[x + i])) {
359 for (j = i; x + j <= win->_maxx; ++j) {
360 if (!isWidecExt(win->_line[y].text[x + j])) {
361 TR(TRACE_VIRTPUT, ("fill %d orphan cells", j));
370 * Finally, add the cells for this character.
372 for (i = 0; i < len; ++i) {
373 NCURSES_CH_T value = ch;
374 SetWidecExt(value, i);
375 TR(TRACE_VIRTPUT, ("multicolumn %d:%d (%d,%d)",
377 win->_begy + y, win->_begx + x));
378 line->text[x] = value;
379 CHANGED_CELL(line, x);
387 * Single-column characters.
389 line->text[x++] = ch;
391 * This label is used only for wide-characters.
397 TR(TRACE_VIRTPUT, ("cell (%ld, %ld..%d) = %s",
398 (long) win->_cury, (long) win->_curx, x - 1,
399 _tracech_t(CHREF(ch))));
401 if (x > win->_maxx) {
402 return wrap_to_next_line(win);
404 win->_curx = (NCURSES_SIZE_T) x;
408 static NCURSES_INLINE int
409 waddch_nosync(WINDOW *win, const NCURSES_CH_T ch)
410 /* the workhorse function -- add a character to the given window */
413 chtype t = (chtype) CharOf(ch);
414 #if USE_WIDEC_SUPPORT || NCURSES_SP_FUNCS || USE_REENTRANT
415 SCREEN *sp = _nc_screen_of(win);
417 const char *s = NCURSES_SP_NAME(unctrl) (NCURSES_SP_ARGx t);
421 * If we are using the alternate character set, forget about locale.
422 * Otherwise, if unctrl() returns a single-character or the locale
423 * claims the code is printable (and not also a control character),
426 if ((AttrOf(ch) & A_ALTCHARSET)
428 #if USE_WIDEC_SUPPORT
429 (sp != 0 && sp->_legacy_coding) &&
434 (isprint((int) t) && !iscntrl((int) t))
435 #if USE_WIDEC_SUPPORT
436 || ((sp == 0 || !sp->_legacy_coding) &&
437 (WINDOW_EXT(win, addch_used)
438 || !_nc_is_charable(CharOf(ch))))
441 return waddch_literal(win, ch);
445 * Handle carriage control and other codes that are not printable, or are
446 * known to expand to more than one character according to unctrl().
454 tabsize = *ptrTabsize(sp);
458 x = (NCURSES_SIZE_T) (x + (tabsize - (x % tabsize)));
460 * Space-fill the tab on the bottom line so that we'll get the
461 * "correct" cursor position.
463 if ((!win->_scroll && (y == win->_regbottom))
464 || (x <= win->_maxx)) {
465 NCURSES_CH_T blank = blankchar;
466 AddAttr(blank, AttrOf(ch));
467 while (win->_curx < x) {
468 if (waddch_literal(win, blank) == ERR)
474 win->_flags |= _WRAPPED;
475 if (newline_forces_scroll(win, &y)) {
488 if (newline_forces_scroll(win, &y)) {
497 win->_flags &= ~_WRAPPED;
503 win->_flags &= ~_WRAPPED;
508 SetChar(sch, UChar(*s++), AttrOf(ch));
509 if_EXT_COLORS(SetPair(sch, GetPair(ch)));
510 if (waddch_literal(win, sch) == ERR)
523 _nc_waddch_nosync(WINDOW *win, const NCURSES_CH_T c)
524 /* export copy of waddch_nosync() so the string-put functions can use it */
526 return (waddch_nosync(win, c));
530 * The versions below call _nc_synchook(). We wanted to avoid this in the
531 * version exported for string puts; they'll call _nc_synchook once at end
535 /* These are actual entry points */
538 waddch(WINDOW *win, const chtype ch)
544 TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_CALLED("waddch(%p, %s)"), (void *) win,
547 if (win && (waddch_nosync(win, wch) != ERR)) {
552 TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_RETURN("%d"), code));
557 wechochar(WINDOW *win, const chtype ch)
563 TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_CALLED("wechochar(%p, %s)"),
567 if (win && (waddch_nosync(win, wch) != ERR)) {
568 bool save_immed = win->_immed;
571 win->_immed = save_immed;
574 TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_RETURN("%d"), code));