1 /****************************************************************************
2 * Copyright 2018-2020,2021 Thomas E. Dickey *
3 * Copyright 1998-2016,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 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 * and: Juergen Pfeifer 2009 *
35 ****************************************************************************/
37 /*-----------------------------------------------------------------
41 * The routine doupdate() and its dependents.
42 * All physical output is concentrated here (except _nc_outch()
45 *-----------------------------------------------------------------*/
47 #define NEW_PAIR_INTERNAL 1
49 #include <curses.priv.h>
52 #define CUR SP_TERMTYPE
55 #if defined __HAIKU__ && defined __BEOS__
65 #if defined(TRACE) && HAVE_SYS_TIMES_H && HAVE_TIMES
66 #define USE_TRACE_TIMES 1
68 #define USE_TRACE_TIMES 0
71 #if HAVE_SYS_TIME_H && HAVE_SYS_TIME_SELECT
76 #include <sys/times.h>
82 #include <sys/select.h>
88 MODULE_ID("$Id: tty_update.c,v 1.312 2021/09/04 10:29:59 tom Exp $")
91 * This define controls the line-breakout optimization. Every once in a
92 * while during screen refresh, we want to check for input and abort the
93 * update if there's some waiting. CHECK_INTERVAL controls the number of
94 * changed lines to be emitted between input checks.
96 * Note: Input-check-and-abort is no longer done if the screen is being
97 * updated from scratch. This is a feature, not a bug.
99 #define CHECK_INTERVAL 5
101 #define FILL_BCE(sp) (sp->_coloron && !sp->_default_color && !back_color_erase)
103 static const NCURSES_CH_T blankchar = NewChar(BLANK_TEXT);
104 static NCURSES_CH_T normal = NewChar(BLANK_TEXT);
107 * Enable checking to see if doupdate and friends are tracking the true
108 * cursor position correctly. NOTE: this is a debugging hack which will
109 * work ONLY on ANSI-compatible terminals!
111 /* #define POSITION_DEBUG */
113 static NCURSES_INLINE NCURSES_CH_T ClrBlank(NCURSES_SP_DCLx WINDOW *win);
116 static int ClrBottom(SCREEN *, int total);
117 static void ClearScreen(SCREEN *, NCURSES_CH_T blank);
118 static void ClrUpdate(SCREEN *);
119 static void DelChar(SCREEN *, int count);
120 static void InsStr(SCREEN *, NCURSES_CH_T *line, int count);
121 static void TransformLine(SCREEN *, int const lineno);
123 static int ClrBottom(int total);
124 static void ClearScreen(NCURSES_CH_T blank);
125 static void ClrUpdate(void);
126 static void DelChar(int count);
127 static void InsStr(NCURSES_CH_T *line, int count);
128 static void TransformLine(int const lineno);
131 #ifdef POSITION_DEBUG
132 /****************************************************************************
134 * Debugging code. Only works on ANSI-standard terminals.
136 ****************************************************************************/
139 position_check(NCURSES_SP_DCLx int expected_y, int expected_x, const char *legend)
140 /* check to see if the real cursor position matches the virtual */
146 if (!_nc_tracing || (expected_y < 0 && expected_x < 0))
149 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
150 memset(buf, '\0', sizeof(buf));
151 NCURSES_PUTP2_FLUSH("cpr", "\033[6n"); /* only works on ANSI-compatibles */
154 int ask = sizeof(buf) - 1 - (s - buf);
155 int got = read(0, s, ask);
159 } while (strchr(buf, 'R') == 0);
160 _tracef("probe returned %s", _nc_visbuf(buf));
162 /* try to interpret as a position report */
163 if (sscanf(buf, "\033[%d;%dR", &y, &x) != 2) {
164 _tracef("position probe failed in %s", legend);
170 if (y - 1 != expected_y || x - 1 != expected_x) {
171 NCURSES_SP_NAME(beep) (NCURSES_SP_ARG);
172 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
173 TIPARM_2("\033[%d;%dH",
176 1, NCURSES_SP_NAME(_nc_outch));
177 _tracef("position seen (%d, %d) doesn't match expected one (%d, %d) in %s",
178 y - 1, x - 1, expected_y, expected_x, legend);
180 _tracef("position matches OK in %s", legend);
185 #define position_check(expected_y, expected_x, legend) /* nothing */
186 #endif /* POSITION_DEBUG */
188 /****************************************************************************
190 * Optimized update code
192 ****************************************************************************/
194 static NCURSES_INLINE void
195 GoTo(NCURSES_SP_DCLx int const row, int const col)
197 TR(TRACE_MOVE, ("GoTo(%p, %d, %d) from (%d, %d)",
198 (void *) SP_PARM, row, col, SP_PARM->_cursrow, SP_PARM->_curscol));
200 position_check(NCURSES_SP_ARGx
202 SP_PARM->_curscol, "GoTo");
204 TINFO_MVCUR(NCURSES_SP_ARGx
208 position_check(NCURSES_SP_ARGx
210 SP_PARM->_curscol, "GoTo2");
213 #if !NCURSES_WCWIDTH_GRAPHICS
214 #define is_wacs_value(ch) (_nc_wacs_width(ch) == 1 && wcwidth(ch) > 1)
215 #endif /* !NCURSES_WCWIDTH_GRAPHICS */
217 static NCURSES_INLINE void
218 PutAttrChar(NCURSES_SP_DCLx CARG_CH_T ch)
222 #if USE_WIDEC_SUPPORT
226 NCURSES_CH_T attr = CHDEREF(ch);
228 TR(TRACE_CHARPUT, ("PutAttrChar(%s) at (%d, %d)",
230 SP_PARM->_cursrow, SP_PARM->_curscol));
231 #if USE_WIDEC_SUPPORT
233 * If this is not a valid character, there is nothing more to do.
235 if (isWidecExt(CHDEREF(ch))) {
236 TR(TRACE_CHARPUT, ("...skip"));
240 * Determine the number of character cells which the 'ch' value will use
241 * on the screen. It should be at least one.
243 if ((chlen = _nc_wacs_width(CharOf(CHDEREF(ch)))) <= 0) {
244 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
247 * If the character falls into any of these special cases, do
248 * not force the result to a blank:
250 * a) it is printable (this works around a bug in wcwidth()).
251 * b) use_legacy_coding() has been called to modify the treatment
253 * c) the acs_map[] has been initialized to allow codes 0-31
254 * to be rendered. This supports Linux console's "PC"
255 * characters. Codes 128-255 are allowed though this is
258 if (is8bits(CharOf(CHDEREF(ch)))
259 && (isprint(CharOf(CHDEREF(ch)))
260 || (SP_PARM->_legacy_coding > 0 && CharOf(CHDEREF(ch)) >= 160)
261 || (SP_PARM->_legacy_coding > 1 && CharOf(CHDEREF(ch)) >= 128)
262 || (AttrOf(attr) & A_ALTCHARSET
263 && ((CharOfD(ch) < ACS_LEN
264 && SP_PARM->_acs_map != 0
265 && SP_PARM->_acs_map[CharOfD(ch)] != 0)
266 || (CharOfD(ch) >= 128))))) {
270 TR(TRACE_CHARPUT, ("forced to blank"));
276 if ((AttrOf(attr) & A_ALTCHARSET)
277 && SP_PARM->_acs_map != 0
278 && ((CharOfD(ch) < ACS_LEN)
279 #if !NCURSES_WCWIDTH_GRAPHICS
280 || is_wacs_value(CharOfD(ch))
284 my_ch = CHDEREF(ch); /* work around const param */
286 #if USE_WIDEC_SUPPORT
288 * This is crude & ugly, but works most of the time. It checks if the
289 * acs_chars string specified that we have a mapping for this
290 * character, and uses the wide-character mapping when we expect the
291 * normal one to be broken (by mis-design ;-).
293 if (SP_PARM->_screen_unicode
294 && _nc_wacs[CharOf(my_ch)].chars[0]) {
295 if (SP_PARM->_screen_acs_map[CharOf(my_ch)]) {
296 if (SP_PARM->_screen_acs_fix) {
297 RemAttr(attr, A_ALTCHARSET);
298 my_ch = _nc_wacs[CharOf(my_ch)];
301 RemAttr(attr, A_ALTCHARSET);
302 my_ch = _nc_wacs[CharOf(my_ch)];
304 #if !NCURSES_WCWIDTH_GRAPHICS
305 if (!(AttrOf(attr) & A_ALTCHARSET)) {
308 #endif /* !NCURSES_WCWIDTH_GRAPHICS */
311 if (!SP_PARM->_screen_acs_map[c8]) {
313 * If we found no mapping for a given alternate-character set item
314 * in the terminal description, attempt to use the ASCII fallback
315 * code which is populated in the _acs_map[] array. If that did
316 * not correspond to a line-drawing, etc., graphics character, the
317 * array entry would be empty.
319 chtype temp = UChar(SP_PARM->_acs_map[c8]);
321 RemAttr(attr, A_ALTCHARSET);
322 SetChar(my_ch, temp, AttrOf(attr));
327 * If we (still) have alternate character set, it is the normal 8bit
328 * flavor. The _screen_acs_map[] array tells if the character was
329 * really in acs_chars, needed because of the way wide/normal line
330 * drawing flavors are integrated.
332 if (AttrOf(attr) & A_ALTCHARSET) {
334 chtype temp = UChar(SP_PARM->_acs_map[j]);
337 SetChar(my_ch, temp, AttrOf(attr));
340 RemAttr(attr, A_ALTCHARSET);
345 #if USE_WIDEC_SUPPORT && !NCURSES_WCWIDTH_GRAPHICS
346 else if (chlen > 1 && is_wacs_value(CharOfD(ch))) {
350 if (tilde_glitch && (CharOfD(ch) == L('~'))) {
351 SetChar(tilde, L('`'), AttrOf(attr));
355 UpdateAttrs(SP_PARM, attr);
357 #if !USE_WIDEC_SUPPORT
360 SP_PARM->_curscol += chlen;
362 NCURSES_PUTP2("char_padding", char_padding);
367 check_pending(NCURSES_SP_DCL0)
368 /* check for pending input */
370 bool have_pending = FALSE;
373 * Only carry out this check when the flag is zero, otherwise we'll
374 * have the refreshing slow down drastically (or stop) if there's an
375 * unread character available.
377 if (SP_PARM->_fifohold != 0)
380 if (SP_PARM->_checkfd >= 0) {
382 struct pollfd fds[1];
383 fds[0].fd = SP_PARM->_checkfd;
384 fds[0].events = POLLIN;
385 if (poll(fds, (size_t) 1, 0) > 0) {
388 #elif defined(__BEOS__)
390 * BeOS's select() is declared in socket.h, so the configure script does
391 * not see it. That's just as well, since that function works only for
392 * sockets. This (using snooze and ioctl) was distilled from Be's patch
393 * for ncurses which uses a separate thread to simulate select().
395 * FIXME: the return values from the ioctl aren't very clear if we get
399 int howmany = ioctl(0, 'ichr', &n);
400 if (howmany >= 0 && n > 0) {
405 struct timeval ktimeout;
408 ktimeout.tv_usec = 0;
411 FD_SET(SP_PARM->_checkfd, &fdset);
412 if (select(SP_PARM->_checkfd + 1, &fdset, NULL, NULL, &ktimeout) != 0) {
418 SP_PARM->_fifohold = 5;
419 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
424 /* put char at lower right corner */
426 PutCharLR(NCURSES_SP_DCLx const ARG_CH_T ch)
428 if (!auto_right_margin) {
429 /* we can put the char directly */
430 PutAttrChar(NCURSES_SP_ARGx ch);
431 } else if (enter_am_mode && exit_am_mode) {
432 int oldcol = SP_PARM->_curscol;
433 /* we can suppress automargin */
434 NCURSES_PUTP2("exit_am_mode", exit_am_mode);
436 PutAttrChar(NCURSES_SP_ARGx ch);
437 SP_PARM->_curscol = oldcol;
438 position_check(NCURSES_SP_ARGx
443 NCURSES_PUTP2("enter_am_mode", enter_am_mode);
444 } else if ((enter_insert_mode && exit_insert_mode)
445 || insert_character || parm_ich) {
447 screen_lines(SP_PARM) - 1,
448 screen_columns(SP_PARM) - 2);
449 PutAttrChar(NCURSES_SP_ARGx ch);
451 screen_lines(SP_PARM) - 1,
452 screen_columns(SP_PARM) - 2);
453 InsStr(NCURSES_SP_ARGx
454 NewScreen(SP_PARM)->_line[screen_lines(SP_PARM) - 1].text +
455 screen_columns(SP_PARM) - 2, 1);
460 * Wrap the cursor position, i.e., advance to the beginning of the next line.
463 wrap_cursor(NCURSES_SP_DCL0)
465 if (eat_newline_glitch) {
467 * xenl can manifest two different ways. The vt100 way is that, when
468 * you'd expect the cursor to wrap, it stays hung at the right margin
469 * (on top of the character just emitted) and doesn't wrap until the
470 * *next* graphic char is emitted. The c100 way is to ignore LF
471 * received just after an am wrap.
473 * An aggressive way to handle this would be to emit CR/LF after the
474 * char and then assume the wrap is done, you're on the first position
475 * of the next line, and the terminal out of its weird state. Here
476 * it is safe to just tell the code that the cursor is in hyperspace and
477 * let the next mvcur() call straighten things out.
479 SP_PARM->_curscol = -1;
480 SP_PARM->_cursrow = -1;
481 } else if (auto_right_margin) {
482 SP_PARM->_curscol = 0;
485 * We've actually moved - but may have to work around problems with
486 * video attributes not working.
488 if (!move_standout_mode && AttrOf(SCREEN_ATTRS(SP_PARM))) {
489 TR(TRACE_CHARPUT, ("turning off (%#lx) %s before wrapping",
490 (unsigned long) AttrOf(SCREEN_ATTRS(SP_PARM)),
491 _traceattr(AttrOf(SCREEN_ATTRS(SP_PARM)))));
492 VIDPUTS(SP_PARM, A_NORMAL, 0);
497 position_check(NCURSES_SP_ARGx
503 static NCURSES_INLINE void
504 PutChar(NCURSES_SP_DCLx const ARG_CH_T ch)
505 /* insert character, handling automargin stuff */
507 if (SP_PARM->_cursrow == screen_lines(SP_PARM) - 1 &&
508 SP_PARM->_curscol == screen_columns(SP_PARM) - 1) {
509 PutCharLR(NCURSES_SP_ARGx ch);
511 PutAttrChar(NCURSES_SP_ARGx ch);
514 if (SP_PARM->_curscol >= screen_columns(SP_PARM))
515 wrap_cursor(NCURSES_SP_ARG);
517 position_check(NCURSES_SP_ARGx
519 SP_PARM->_curscol, "PutChar");
523 * Check whether the given character can be output by clearing commands. This
524 * includes test for being a space and not including any 'bad' attributes, such
525 * as A_REVERSE. All attribute flags which don't affect appearance of a space
526 * or can be output by clearing (A_COLOR in case of bce-terminal) are excluded.
528 static NCURSES_INLINE bool
529 can_clear_with(NCURSES_SP_DCLx ARG_CH_T ch)
531 if (!back_color_erase && SP_PARM->_coloron) {
532 #if NCURSES_EXT_FUNCS
535 if (!SP_PARM->_default_color)
537 if (!(isDefaultColor(SP_PARM->_default_fg) &&
538 isDefaultColor(SP_PARM->_default_bg)))
540 if ((pair = GetPair(CHDEREF(ch))) != 0) {
541 NCURSES_COLOR_T fg, bg;
542 if (NCURSES_SP_NAME(pair_content) (NCURSES_SP_ARGx
545 || !(isDefaultColor(fg) && isDefaultColor(bg))) {
550 if (AttrOfD(ch) & A_COLOR)
554 return (ISBLANK(CHDEREF(ch)) &&
555 (AttrOfD(ch) & ~(NONBLANK_ATTR | A_COLOR)) == BLANK_ATTR);
559 * Issue a given span of characters from an array.
560 * Must be functionally equivalent to:
561 * for (i = 0; i < num; i++)
563 * but can leave the cursor positioned at the middle of the interval.
565 * Returns: 0 - cursor is at the end of interval
566 * 1 - cursor is somewhere in the middle
568 * This code is optimized using ech and rep.
571 EmitRange(NCURSES_SP_DCLx const NCURSES_CH_T *ntext, int num)
575 TR(TRACE_CHARPUT, ("EmitRange %d:%s", num, _nc_viscbuf(ntext, num)));
577 if (erase_chars || repeat_char) {
582 while (num > 1 && !CharEq(ntext[0], ntext[1])) {
583 PutChar(NCURSES_SP_ARGx CHREF(ntext[0]));
589 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
594 while (runcount < num && CharEq(ntext[runcount], ntext0))
598 * The cost expression in the middle isn't exactly right.
599 * _cup_ch_cost is an upper bound on the cost for moving to the
600 * end of the erased area, but not the cost itself (which we
601 * can't compute without emitting the move). This may result
602 * in erase_chars not getting used in some situations for
603 * which it would be marginally advantageous.
606 && runcount > SP_PARM->_ech_cost + SP_PARM->_cup_ch_cost
607 && can_clear_with(NCURSES_SP_ARGx CHREF(ntext0))) {
608 UpdateAttrs(SP_PARM, ntext0);
609 NCURSES_PUTP2("erase_chars", TIPARM_1(erase_chars, runcount));
612 * If this is the last part of the given interval,
613 * don't bother moving cursor, since it can be the
614 * last update on the line.
616 if (runcount < num) {
619 SP_PARM->_curscol + runcount);
621 return 1; /* cursor stays in the middle */
623 } else if (repeat_char != 0 &&
625 !isdigit(UChar(CharOf(ntext0))) &&
627 #if USE_WIDEC_SUPPORT
628 (!SP_PARM->_screen_unicode &&
629 (CharOf(ntext0) < ((AttrOf(ntext0) & A_ALTCHARSET)
633 runcount > SP_PARM->_rep_cost) {
635 bool wrap_possible = (SP_PARM->_curscol + runcount >=
636 screen_columns(SP_PARM));
637 int rep_count = runcount;
642 UpdateAttrs(SP_PARM, ntext0);
644 if ((AttrOf(temp) & A_ALTCHARSET) &&
645 SP_PARM->_acs_map != 0 &&
646 (SP_PARM->_acs_map[CharOf(temp)] & A_CHARTEXT) != 0) {
648 (SP_PARM->_acs_map[CharOf(ntext0)] & A_CHARTEXT),
649 AttrOf(ntext0) | A_ALTCHARSET);
651 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
652 TIPARM_2(repeat_char,
656 NCURSES_SP_NAME(_nc_outch));
657 SP_PARM->_curscol += rep_count;
660 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
662 for (i = 0; i < runcount; i++)
663 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
671 for (i = 0; i < num; i++)
672 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
677 * Output the line in the given range [first .. last]
679 * If there's a run of identical characters that's long enough to justify
680 * cursor movement, use that also.
682 * Returns: same as EmitRange
685 PutRange(NCURSES_SP_DCLx
686 const NCURSES_CH_T *otext,
687 const NCURSES_CH_T *ntext,
693 TR(TRACE_CHARPUT, ("PutRange(%p, %p, %p, %d, %d, %d)",
695 (const void *) otext,
696 (const void *) ntext,
700 && (last - first + 1) > SP_PARM->_inline_cost) {
703 for (j = first, same = 0; j <= last; j++) {
704 if (!same && isWidecExt(otext[j]))
706 if (CharEq(otext[j], ntext[j])) {
709 if (same > SP_PARM->_inline_cost) {
710 EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
711 GoTo(NCURSES_SP_ARGx row, first = j);
716 i = EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
718 * Always return 1 for the next GoTo() after a PutRange() if we found
719 * identical characters at end of interval
721 rc = (same == 0 ? i : 1);
723 rc = EmitRange(NCURSES_SP_ARGx ntext + first, last - first + 1);
728 /* leave unbracketed here so 'indent' works */
729 #define MARK_NOCHANGE(win,row) \
730 win->_line[row].firstchar = _NOCHANGE; \
731 win->_line[row].lastchar = _NOCHANGE; \
732 if_USE_SCROLL_HINTS(win->_line[row].oldindex = row)
735 TINFO_DOUPDATE(NCURSES_SP_DCL0)
740 struct tms before, after;
741 #endif /* USE_TRACE_TIMES */
743 T((T_CALLED("_nc_tinfo:doupdate(%p)"), (void *) SP_PARM));
745 _nc_lock_global(update);
748 _nc_unlock_global(update);
753 * It is "legal" but unlikely that an application could assign a new
754 * value to one of the standard windows. Check for that possibility
755 * and try to recover.
757 * We do not allow applications to assign new values in the reentrant
760 #define SyncScreens(internal,exported) \
761 if (internal == 0) internal = exported; \
762 if (internal != exported) exported = internal
764 SyncScreens(CurScreen(SP_PARM), curscr);
765 SyncScreens(NewScreen(SP_PARM), newscr);
766 SyncScreens(StdScreen(SP_PARM), stdscr);
769 if (CurScreen(SP_PARM) == 0
770 || NewScreen(SP_PARM) == 0
771 || StdScreen(SP_PARM) == 0) {
772 _nc_unlock_global(update);
776 if (USE_TRACEF(TRACE_UPDATE)) {
777 if (CurScreen(SP_PARM)->_clear)
778 _tracef("curscr is clear");
780 _tracedump("curscr", CurScreen(SP_PARM));
781 _tracedump("newscr", NewScreen(SP_PARM));
782 _nc_unlock_global(tracef);
786 _nc_signal_handler(FALSE);
788 if (SP_PARM->_fifohold)
789 SP_PARM->_fifohold--;
792 if ((SP_PARM->_endwin == ewSuspend)
793 || _nc_handle_sigwinch(SP_PARM)) {
795 * This is a transparent extension: XSI does not address it,
796 * and applications need not know that ncurses can do it.
798 * Check if the terminal size has changed while curses was off
799 * (this can happen in an xterm, for example), and resize the
800 * ncurses data structures accordingly.
802 _nc_update_screensize(SP_PARM);
806 if (SP_PARM->_endwin == ewSuspend) {
808 T(("coming back from shell mode"));
809 NCURSES_SP_NAME(reset_prog_mode) (NCURSES_SP_ARG);
811 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
812 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
813 SP_PARM->_mouse_resume(SP_PARM);
815 SP_PARM->_endwin = ewRunning;
818 /* zero the metering machinery */
820 (void) times(&before);
821 #endif /* USE_TRACE_TIMES */
824 * This is the support for magic-cookie terminals. The theory: we scan
825 * the virtual screen looking for attribute turnons. Where we find one,
826 * check to make sure it is realizable by seeing if the required number of
827 * un-attributed blanks are present before and after the attributed range;
828 * try to shift the range boundaries over blanks (not changing the screen
829 * display) so this becomes true. If it is, shift the beginning attribute
830 * change appropriately (the end one, if we've gotten this far, is
831 * guaranteed room for its cookie). If not, nuke the added attributes out
835 if (magic_cookie_glitch > 0) {
837 attr_t rattr = A_NORMAL;
839 for (i = 0; i < screen_lines(SP_PARM); i++) {
840 for (j = 0; j < screen_columns(SP_PARM); j++) {
842 NCURSES_CH_T *thisline = NewScreen(SP_PARM)->_line[i].text;
843 attr_t thisattr = AttrOf(thisline[j]) & SP_PARM->_xmc_triggers;
844 attr_t turnon = thisattr & ~rattr;
846 /* is an attribute turned on here? */
852 TR(TRACE_ATTRS, ("At (%d, %d): from %s...", i, j, _traceattr(rattr)));
853 TR(TRACE_ATTRS, ("...to %s", _traceattr(turnon)));
856 * If the attribute change location is a blank with a "safe"
857 * attribute, undo the attribute turnon. This may ensure
858 * there's enough room to set the attribute before the first
859 * non-blank in the run.
861 #define SAFE(scr,a) (!((a) & (scr)->_xmc_triggers))
862 if (ISBLANK(thisline[j]) && SAFE(SP_PARM, turnon)) {
863 RemAttr(thisline[j], turnon);
867 /* check that there's enough room at start of span */
868 for (k = 1; k <= magic_cookie_glitch; k++) {
870 || !ISBLANK(thisline[j - k])
871 || !SAFE(SP_PARM, AttrOf(thisline[j - k]))) {
873 TR(TRACE_ATTRS, ("No room at start in %d,%d%s%s",
875 (ISBLANK(thisline[j - k])
878 (SAFE(SP_PARM, AttrOf(thisline[j - k]))
885 bool end_onscreen = FALSE;
888 /* find end of span, if it is onscreen */
889 for (m = i; m < screen_lines(SP_PARM); m++) {
890 for (; n < screen_columns(SP_PARM); n++) {
892 AttrOf(NewScreen(SP_PARM)->_line[m].text[n]);
893 if ((testattr & SP_PARM->_xmc_triggers) == rattr) {
896 ("Range attributed with %s ends at (%d, %d)",
897 _traceattr(turnon), m, n));
904 ("Range attributed with %s ends offscreen",
905 _traceattr(turnon)));
909 NCURSES_CH_T *lastline =
910 NewScreen(SP_PARM)->_line[m].text;
913 * If there are safely-attributed blanks at the end of
914 * the range, shorten the range. This will help ensure
915 * that there is enough room at end of span.
918 && ISBLANK(lastline[n])
919 && SAFE(SP_PARM, AttrOf(lastline[n]))) {
920 RemAttr(lastline[n--], turnon);
923 /* check that there's enough room at end of span */
924 for (k = 1; k <= magic_cookie_glitch; k++) {
925 if (n + k >= screen_columns(SP_PARM)
926 || !ISBLANK(lastline[n + k])
927 || !SAFE(SP_PARM, AttrOf(lastline[n + k]))) {
930 ("No room at end in %d,%d%s%s",
932 (ISBLANK(lastline[n + k])
935 (SAFE(SP_PARM, AttrOf(lastline[n + k]))
948 ("Clearing %s beginning at (%d, %d)",
949 _traceattr(turnon), i, j));
951 /* turn off new attributes over span */
952 for (p = i; p < screen_lines(SP_PARM); p++) {
953 for (; q < screen_columns(SP_PARM); q++) {
954 attr_t testattr = AttrOf(newscr->_line[p].text[q]);
955 if ((testattr & SP_PARM->_xmc_triggers) == rattr)
957 RemAttr(NewScreen(SP_PARM)->_line[p].text[q], turnon);
964 ("Cookie space for %s found before (%d, %d)",
965 _traceattr(turnon), i, j));
968 * Back up the start of range so there's room for cookies
969 * before the first nonblank character.
971 for (k = 1; k <= magic_cookie_glitch; k++)
972 AddAttr(thisline[j - k], turnon);
980 /* show altered highlights after magic-cookie check */
981 if (USE_TRACEF(TRACE_UPDATE)) {
982 _tracef("After magic-cookie check...");
983 _tracedump("newscr", NewScreen(SP_PARM));
984 _nc_unlock_global(tracef);
988 #endif /* USE_XMC_SUPPORT */
991 if (CurScreen(SP_PARM)->_clear || NewScreen(SP_PARM)->_clear) { /* force refresh ? */
992 ClrUpdate(NCURSES_SP_ARG);
993 CurScreen(SP_PARM)->_clear = FALSE; /* reset flag */
994 NewScreen(SP_PARM)->_clear = FALSE; /* reset flag */
996 int changedlines = CHECK_INTERVAL;
998 if (check_pending(NCURSES_SP_ARG))
1001 nonempty = min(screen_lines(SP_PARM), NewScreen(SP_PARM)->_maxy + 1);
1003 if (SP_PARM->_scrolling) {
1004 NCURSES_SP_NAME(_nc_scroll_optimize) (NCURSES_SP_ARG);
1007 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1009 TR(TRACE_UPDATE, ("Transforming lines, nonempty %d", nonempty));
1010 for (i = 0; i < nonempty; i++) {
1012 * Here is our line-breakout optimization.
1014 if (changedlines == CHECK_INTERVAL) {
1015 if (check_pending(NCURSES_SP_ARG))
1021 * newscr->line[i].firstchar is normally set
1022 * by wnoutrefresh. curscr->line[i].firstchar
1023 * is normally set by _nc_scroll_window in the
1024 * vertical-movement optimization code,
1026 if (NewScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE
1027 || CurScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE) {
1028 TransformLine(NCURSES_SP_ARGx i);
1032 /* mark line changed successfully */
1033 if (i <= NewScreen(SP_PARM)->_maxy) {
1034 MARK_NOCHANGE(NewScreen(SP_PARM), i);
1036 if (i <= CurScreen(SP_PARM)->_maxy) {
1037 MARK_NOCHANGE(CurScreen(SP_PARM), i);
1042 /* put everything back in sync */
1043 for (i = nonempty; i <= NewScreen(SP_PARM)->_maxy; i++) {
1044 MARK_NOCHANGE(NewScreen(SP_PARM), i);
1046 for (i = nonempty; i <= CurScreen(SP_PARM)->_maxy; i++) {
1047 MARK_NOCHANGE(CurScreen(SP_PARM), i);
1050 if (!NewScreen(SP_PARM)->_leaveok) {
1051 CurScreen(SP_PARM)->_curx = NewScreen(SP_PARM)->_curx;
1052 CurScreen(SP_PARM)->_cury = NewScreen(SP_PARM)->_cury;
1054 GoTo(NCURSES_SP_ARGx CurScreen(SP_PARM)->_cury, CurScreen(SP_PARM)->_curx);
1059 * We would like to keep the physical screen in normal mode in case we get
1060 * other processes writing to the screen. This goal cannot be met for
1061 * magic cookies since it interferes with attributes that may propagate
1062 * past the current position.
1065 if (magic_cookie_glitch != 0)
1067 UpdateAttrs(SP_PARM, normal);
1069 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1070 WINDOW_ATTRS(CurScreen(SP_PARM)) = WINDOW_ATTRS(NewScreen(SP_PARM));
1073 (void) times(&after);
1075 ("Update cost: %ld chars, %ld clocks system time, %ld clocks user time",
1077 (long) (after.tms_stime - before.tms_stime),
1078 (long) (after.tms_utime - before.tms_utime)));
1079 #endif /* USE_TRACE_TIMES */
1081 _nc_signal_handler(TRUE);
1083 _nc_unlock_global(update);
1087 #if NCURSES_SP_FUNCS && !defined(USE_TERM_DRIVER)
1091 return TINFO_DOUPDATE(CURRENT_SCREEN);
1098 * Returns the attributed character that corresponds to the "cleared"
1099 * screen. If the terminal has the back-color-erase feature, this will be
1100 * colored according to the wbkgd() call.
1102 * We treat 'curscr' specially because it isn't supposed to be set directly
1103 * in the wbkgd() call. Assume 'stdscr' for this case.
1105 #define BCE_ATTRS (A_NORMAL|A_COLOR)
1106 #define BCE_BKGD(sp,win) (((win) == CurScreen(sp) ? StdScreen(sp) : (win))->_nc_bkgd)
1108 static NCURSES_INLINE NCURSES_CH_T
1109 ClrBlank(NCURSES_SP_DCLx WINDOW *win)
1111 NCURSES_CH_T blank = blankchar;
1112 if (back_color_erase)
1113 AddAttr(blank, (AttrOf(BCE_BKGD(SP_PARM, win)) & BCE_ATTRS));
1120 ** Update by clearing and redrawing the entire screen.
1125 ClrUpdate(NCURSES_SP_DCL0)
1127 TR(TRACE_UPDATE, (T_CALLED("ClrUpdate")));
1130 NCURSES_CH_T blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1131 int nonempty = min(screen_lines(SP_PARM),
1132 NewScreen(SP_PARM)->_maxy + 1);
1134 ClearScreen(NCURSES_SP_ARGx blank);
1136 TR(TRACE_UPDATE, ("updating screen from scratch"));
1138 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1140 for (i = 0; i < nonempty; i++)
1141 TransformLine(NCURSES_SP_ARGx i);
1143 TR(TRACE_UPDATE, (T_RETURN("")));
1149 ** Clear to end of current line, starting at the cursor position
1153 ClrToEOL(NCURSES_SP_DCLx NCURSES_CH_T blank, int needclear)
1155 if (CurScreen(SP_PARM) != 0
1156 && SP_PARM->_cursrow >= 0) {
1159 for (j = SP_PARM->_curscol; j < screen_columns(SP_PARM); j++) {
1162 &(CurScreen(SP_PARM)->_line[SP_PARM->_cursrow].text[j]);
1164 if (!CharEq(*cp, blank)) {
1173 UpdateAttrs(SP_PARM, blank);
1174 if (clr_eol && SP_PARM->_el_cost <= (screen_columns(SP_PARM) - SP_PARM->_curscol)) {
1175 NCURSES_PUTP2("clr_eol", clr_eol);
1177 int count = (screen_columns(SP_PARM) - SP_PARM->_curscol);
1179 PutChar(NCURSES_SP_ARGx CHREF(blank));
1187 ** Clear to end of screen, starting at the cursor position
1191 ClrToEOS(NCURSES_SP_DCLx NCURSES_CH_T blank)
1195 row = SP_PARM->_cursrow;
1196 col = SP_PARM->_curscol;
1203 UpdateAttrs(SP_PARM, blank);
1204 TPUTS_TRACE("clr_eos");
1205 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1207 screen_lines(SP_PARM) - row,
1208 NCURSES_SP_NAME(_nc_outch));
1210 while (col < screen_columns(SP_PARM))
1211 CurScreen(SP_PARM)->_line[row].text[col++] = blank;
1213 for (row++; row < screen_lines(SP_PARM); row++) {
1214 for (col = 0; col < screen_columns(SP_PARM); col++)
1215 CurScreen(SP_PARM)->_line[row].text[col] = blank;
1222 * Test if clearing the end of the screen would satisfy part of the
1223 * screen-update. Do this by scanning backwards through the lines in the
1224 * screen, checking if each is blank, and one or more are changed.
1227 ClrBottom(NCURSES_SP_DCLx int total)
1230 int last = min(screen_columns(SP_PARM), NewScreen(SP_PARM)->_maxx + 1);
1231 NCURSES_CH_T blank = NewScreen(SP_PARM)->_line[total - 1].text[last - 1];
1233 if (clr_eos && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1236 for (row = total - 1; row >= 0; row--) {
1240 for (col = 0, ok = TRUE; ok && col < last; col++) {
1241 ok = (CharEq(NewScreen(SP_PARM)->_line[row].text[col], blank));
1246 for (col = 0; ok && col < last; col++) {
1247 ok = (CharEq(CurScreen(SP_PARM)->_line[row].text[col], blank));
1253 /* don't use clr_eos for just one line if clr_eol available */
1255 GoTo(NCURSES_SP_ARGx top, 0);
1256 ClrToEOS(NCURSES_SP_ARGx blank);
1257 if (SP_PARM->oldhash && SP_PARM->newhash) {
1258 for (row = top; row < screen_lines(SP_PARM); row++)
1259 SP_PARM->oldhash[row] = SP_PARM->newhash[row];
1267 #if USE_WIDEC_SUPPORT
1268 #define check_xmc_transition(sp, a, b) \
1269 ((((a)->attr ^ (b)->attr) & ~((a)->attr) & (sp)->_xmc_triggers) != 0)
1270 #define xmc_turn_on(sp,a,b) check_xmc_transition(sp,&(a), &(b))
1272 #define xmc_turn_on(sp,a,b) ((((a)^(b)) & ~(a) & (sp)->_xmc_triggers) != 0)
1275 #define xmc_new(sp,r,c) NewScreen(sp)->_line[r].text[c]
1276 #define xmc_turn_off(sp,a,b) xmc_turn_on(sp,b,a)
1277 #endif /* USE_XMC_SUPPORT */
1280 ** TransformLine(lineno)
1282 ** Transform the given line in curscr to the one in newscr, using
1283 ** Insert/Delete Character if idcok && has_ic().
1285 ** firstChar = position of first different character in line
1286 ** oLastChar = position of last different character in old line
1287 ** nLastChar = position of last different character in new line
1289 ** move to firstChar
1290 ** overwrite chars up to min(oLastChar, nLastChar)
1291 ** if oLastChar < nLastChar
1292 ** insert newLine[oLastChar+1..nLastChar]
1294 ** delete oLastChar - nLastChar spaces
1298 TransformLine(NCURSES_SP_DCLx int const lineno)
1300 int firstChar, oLastChar, nLastChar;
1301 NCURSES_CH_T *newLine = NewScreen(SP_PARM)->_line[lineno].text;
1302 NCURSES_CH_T *oldLine = CurScreen(SP_PARM)->_line[lineno].text;
1304 bool attrchanged = FALSE;
1306 TR(TRACE_UPDATE, (T_CALLED("TransformLine(%p, %d)"), (void *) SP_PARM, lineno));
1308 /* copy new hash value to old one */
1309 if (SP_PARM->oldhash && SP_PARM->newhash)
1310 SP_PARM->oldhash[lineno] = SP_PARM->newhash[lineno];
1313 * If we have colors, there is the possibility of having two color pairs
1314 * that display as the same colors. For instance, Lynx does this. Check
1315 * for this case, and update the old line with the new line's colors when
1316 * they are equivalent.
1318 if (SP_PARM->_coloron) {
1322 for (n = 0; n < screen_columns(SP_PARM); n++) {
1323 if (!CharEq(newLine[n], oldLine[n])) {
1324 oldPair = GetPair(oldLine[n]);
1325 newPair = GetPair(newLine[n]);
1326 if (oldPair != newPair
1327 && unColor(oldLine[n]) == unColor(newLine[n])) {
1328 if (oldPair < SP_PARM->_pair_alloc
1329 && newPair < SP_PARM->_pair_alloc
1330 && (isSamePair(SP_PARM->_color_pairs[oldPair],
1331 SP_PARM->_color_pairs[newPair]))) {
1332 SetPair(oldLine[n], GetPair(newLine[n]));
1339 if (ceol_standout_glitch && clr_eol) {
1341 while (firstChar < screen_columns(SP_PARM)) {
1342 if (!SameAttrOf(newLine[firstChar], oldLine[firstChar])) {
1352 if (attrchanged) { /* we may have to disregard the whole line */
1353 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1354 ClrToEOL(NCURSES_SP_ARGx
1355 ClrBlank(NCURSES_SP_ARGx
1356 CurScreen(SP_PARM)), FALSE);
1357 PutRange(NCURSES_SP_ARGx
1358 oldLine, newLine, lineno, 0,
1359 screen_columns(SP_PARM) - 1);
1363 * This is a very simple loop to paint characters which may have the
1364 * magic cookie glitch embedded. It doesn't know much about video
1365 * attributes which are continued from one line to the next. It
1366 * assumes that we have filtered out requests for attribute changes
1367 * that do not get mapped to blank positions.
1369 * FIXME: we are not keeping track of where we put the cookies, so this
1370 * will work properly only once, since we may overwrite a cookie in a
1371 * following operation.
1373 } else if (magic_cookie_glitch > 0) {
1374 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1375 for (n = 0; n < screen_columns(SP_PARM); n++) {
1376 int m = n + magic_cookie_glitch;
1378 /* check for turn-on:
1379 * If we are writing an attributed blank, where the
1380 * previous cell is not attributed.
1382 if (ISBLANK(newLine[n])
1384 && xmc_turn_on(SP_PARM, newLine[n - 1], newLine[n]))
1387 && xmc_turn_on(SP_PARM,
1388 xmc_new(SP_PARM, lineno - 1,
1389 screen_columns(SP_PARM) - 1),
1394 PutChar(NCURSES_SP_ARGx CHREF(newLine[n]));
1396 /* check for turn-off:
1397 * If we are writing an attributed non-blank, where the
1398 * next cell is blank, and not attributed.
1400 if (!ISBLANK(newLine[n])
1401 && ((n + 1 < screen_columns(SP_PARM)
1402 && xmc_turn_off(SP_PARM, newLine[n], newLine[n + 1]))
1403 || (n + 1 >= screen_columns(SP_PARM)
1404 && lineno + 1 < screen_lines(SP_PARM)
1405 && xmc_turn_off(SP_PARM,
1407 xmc_new(SP_PARM, lineno + 1, 0))))) {
1416 /* it may be cheap to clear leading whitespace with clr_bol */
1418 if (clr_bol && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1419 int oFirstChar, nFirstChar;
1421 for (oFirstChar = 0;
1422 oFirstChar < screen_columns(SP_PARM);
1424 if (!CharEq(oldLine[oFirstChar], blank))
1426 for (nFirstChar = 0;
1427 nFirstChar < screen_columns(SP_PARM);
1429 if (!CharEq(newLine[nFirstChar], blank))
1432 if (nFirstChar == oFirstChar) {
1433 firstChar = nFirstChar;
1434 /* find the first differing character */
1435 while (firstChar < screen_columns(SP_PARM)
1436 && CharEq(newLine[firstChar], oldLine[firstChar]))
1438 } else if (oFirstChar > nFirstChar) {
1439 firstChar = nFirstChar;
1440 } else { /* oFirstChar < nFirstChar */
1441 firstChar = oFirstChar;
1442 if (SP_PARM->_el1_cost < nFirstChar - oFirstChar) {
1443 if (nFirstChar >= screen_columns(SP_PARM)
1444 && SP_PARM->_el_cost <= SP_PARM->_el1_cost) {
1445 GoTo(NCURSES_SP_ARGx lineno, 0);
1446 UpdateAttrs(SP_PARM, blank);
1447 NCURSES_PUTP2("clr_eol", clr_eol);
1449 GoTo(NCURSES_SP_ARGx lineno, nFirstChar - 1);
1450 UpdateAttrs(SP_PARM, blank);
1451 NCURSES_PUTP2("clr_bol", clr_bol);
1454 while (firstChar < nFirstChar)
1455 oldLine[firstChar++] = blank;
1459 /* find the first differing character */
1460 while (firstChar < screen_columns(SP_PARM)
1461 && CharEq(newLine[firstChar], oldLine[firstChar]))
1464 /* if there wasn't one, we're done */
1465 if (firstChar >= screen_columns(SP_PARM)) {
1466 TR(TRACE_UPDATE, (T_RETURN("")));
1470 blank = newLine[screen_columns(SP_PARM) - 1];
1472 if (!can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1473 /* find the last differing character */
1474 nLastChar = screen_columns(SP_PARM) - 1;
1476 while (nLastChar > firstChar
1477 && CharEq(newLine[nLastChar], oldLine[nLastChar]))
1480 if (nLastChar >= firstChar) {
1481 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1482 PutRange(NCURSES_SP_ARGx
1488 memcpy(oldLine + firstChar,
1489 newLine + firstChar,
1490 (unsigned) (nLastChar - firstChar + 1) * sizeof(NCURSES_CH_T));
1492 TR(TRACE_UPDATE, (T_RETURN("")));
1496 /* find last non-blank character on old line */
1497 oLastChar = screen_columns(SP_PARM) - 1;
1498 while (oLastChar > firstChar && CharEq(oldLine[oLastChar], blank))
1501 /* find last non-blank character on new line */
1502 nLastChar = screen_columns(SP_PARM) - 1;
1503 while (nLastChar > firstChar && CharEq(newLine[nLastChar], blank))
1506 if ((nLastChar == firstChar)
1507 && (SP_PARM->_el_cost < (oLastChar - nLastChar))) {
1508 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1509 if (!CharEq(newLine[firstChar], blank))
1510 PutChar(NCURSES_SP_ARGx CHREF(newLine[firstChar]));
1511 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1512 } else if ((nLastChar != oLastChar)
1513 && (!CharEq(newLine[nLastChar], oldLine[oLastChar])
1514 || !(SP_PARM->_nc_sp_idcok
1515 && NCURSES_SP_NAME(has_ic) (NCURSES_SP_ARG)))) {
1516 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1517 if ((oLastChar - nLastChar) > SP_PARM->_el_cost) {
1518 if (PutRange(NCURSES_SP_ARGx
1524 GoTo(NCURSES_SP_ARGx lineno, nLastChar + 1);
1526 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1528 n = max(nLastChar, oLastChar);
1529 PutRange(NCURSES_SP_ARGx
1537 int nLastNonblank = nLastChar;
1538 int oLastNonblank = oLastChar;
1540 /* find the last characters that really differ */
1541 /* can be -1 if no characters differ */
1542 while (CharEq(newLine[nLastChar], oldLine[oLastChar])) {
1543 /* don't split a wide char */
1544 if (isWidecExt(newLine[nLastChar]) &&
1545 !CharEq(newLine[nLastChar - 1], oldLine[oLastChar - 1]))
1549 if (nLastChar == -1 || oLastChar == -1)
1553 n = min(oLastChar, nLastChar);
1554 if (n >= firstChar) {
1555 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1556 PutRange(NCURSES_SP_ARGx
1564 if (oLastChar < nLastChar) {
1565 int m = max(nLastNonblank, oLastNonblank);
1566 #if USE_WIDEC_SUPPORT
1568 while (isWidecExt(newLine[n + 1]) && n) {
1570 --oLastChar; /* increase cost */
1572 } else if (n >= firstChar &&
1573 isWidecBase(newLine[n])) {
1574 while (isWidecExt(newLine[n + 1])) {
1576 ++oLastChar; /* decrease cost */
1580 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1581 if ((nLastChar < nLastNonblank)
1582 || InsCharCost(SP_PARM, nLastChar - oLastChar) > (m - n)) {
1583 PutRange(NCURSES_SP_ARGx
1590 InsStr(NCURSES_SP_ARGx &newLine[n + 1], nLastChar - oLastChar);
1592 } else if (oLastChar > nLastChar) {
1593 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1594 if (DelCharCost(SP_PARM, oLastChar - nLastChar)
1595 > SP_PARM->_el_cost + nLastNonblank - (n + 1)) {
1596 if (PutRange(NCURSES_SP_ARGx oldLine, newLine, lineno,
1597 n + 1, nLastNonblank)) {
1598 GoTo(NCURSES_SP_ARGx lineno, nLastNonblank + 1);
1600 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1603 * The delete-char sequence will
1604 * effectively shift in blanks from the
1605 * right margin of the screen. Ensure
1606 * that they are the right color by
1607 * setting the video attributes from
1608 * the last character on the row.
1610 UpdateAttrs(SP_PARM, blank);
1611 DelChar(NCURSES_SP_ARGx oLastChar - nLastChar);
1617 /* update the code's internal representation */
1618 if (screen_columns(SP_PARM) > firstChar)
1619 memcpy(oldLine + firstChar,
1620 newLine + firstChar,
1621 (unsigned) (screen_columns(SP_PARM) - firstChar) * sizeof(NCURSES_CH_T));
1622 TR(TRACE_UPDATE, (T_RETURN("")));
1627 ** ClearScreen(blank)
1629 ** Clear the physical screen and put cursor at home
1634 ClearScreen(NCURSES_SP_DCLx NCURSES_CH_T blank)
1637 bool fast_clear = (clear_screen || clr_eos || clr_eol);
1639 TR(TRACE_UPDATE, ("ClearScreen() called"));
1641 #if NCURSES_EXT_FUNCS
1642 if (SP_PARM->_coloron
1643 && !SP_PARM->_default_color) {
1644 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
1645 (short) GET_SCREEN_PAIR(SP_PARM),
1648 NCURSES_SP_NAME(_nc_outch));
1649 if (!back_color_erase) {
1657 UpdateAttrs(SP_PARM, blank);
1658 NCURSES_PUTP2("clear_screen", clear_screen);
1659 SP_PARM->_cursrow = SP_PARM->_curscol = 0;
1660 position_check(NCURSES_SP_ARGx
1664 } else if (clr_eos) {
1665 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1666 GoTo(NCURSES_SP_ARGx 0, 0);
1667 UpdateAttrs(SP_PARM, blank);
1668 TPUTS_TRACE("clr_eos");
1669 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1671 screen_lines(SP_PARM),
1672 NCURSES_SP_NAME(_nc_outch));
1673 } else if (clr_eol) {
1674 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1675 UpdateAttrs(SP_PARM, blank);
1676 for (i = 0; i < screen_lines(SP_PARM); i++) {
1677 GoTo(NCURSES_SP_ARGx i, 0);
1678 NCURSES_PUTP2("clr_eol", clr_eol);
1680 GoTo(NCURSES_SP_ARGx 0, 0);
1683 UpdateAttrs(SP_PARM, blank);
1684 for (i = 0; i < screen_lines(SP_PARM); i++) {
1685 GoTo(NCURSES_SP_ARGx i, 0);
1686 for (j = 0; j < screen_columns(SP_PARM); j++)
1687 PutChar(NCURSES_SP_ARGx CHREF(blank));
1689 GoTo(NCURSES_SP_ARGx 0, 0);
1692 for (i = 0; i < screen_lines(SP_PARM); i++) {
1693 for (j = 0; j < screen_columns(SP_PARM); j++)
1694 CurScreen(SP_PARM)->_line[i].text[j] = blank;
1697 TR(TRACE_UPDATE, ("screen cleared"));
1701 ** InsStr(line, count)
1703 ** Insert the count characters pointed to by line.
1708 InsStr(NCURSES_SP_DCLx NCURSES_CH_T *line, int count)
1710 TR(TRACE_UPDATE, ("InsStr(%p, %p,%d) called",
1712 (void *) line, count));
1714 /* Prefer parm_ich as it has the smallest cost - no need to shift
1715 * the whole line on each character. */
1716 /* The order must match that of InsCharCost. */
1718 TPUTS_TRACE("parm_ich");
1719 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1720 TIPARM_1(parm_ich, count),
1722 NCURSES_SP_NAME(_nc_outch));
1724 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1728 } else if (enter_insert_mode && exit_insert_mode) {
1729 NCURSES_PUTP2("enter_insert_mode", enter_insert_mode);
1731 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1732 if (insert_padding) {
1733 NCURSES_PUTP2("insert_padding", insert_padding);
1738 NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
1741 NCURSES_PUTP2("insert_character", insert_character);
1742 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1743 if (insert_padding) {
1744 NCURSES_PUTP2("insert_padding", insert_padding);
1750 position_check(NCURSES_SP_ARGx
1752 SP_PARM->_curscol, "InsStr");
1758 ** Delete count characters at current position
1763 DelChar(NCURSES_SP_DCLx int count)
1765 TR(TRACE_UPDATE, ("DelChar(%p, %d) called, position = (%ld,%ld)",
1766 (void *) SP_PARM, count,
1767 (long) NewScreen(SP_PARM)->_cury,
1768 (long) NewScreen(SP_PARM)->_curx));
1771 TPUTS_TRACE("parm_dch");
1772 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1773 TIPARM_1(parm_dch, count),
1775 NCURSES_SP_NAME(_nc_outch));
1779 for (n = 0; n < count; n++) {
1780 NCURSES_PUTP2("delete_character", delete_character);
1786 * Physical-scrolling support
1788 * This code was adapted from Keith Bostic's hardware scrolling
1789 * support for 4.4BSD curses. I (esr) translated it to use terminfo
1790 * capabilities, narrowed the call interface slightly, and cleaned
1791 * up some convoluted tests. I also added support for the memory_above
1792 * memory_below, and non_dest_scroll_region capabilities.
1794 * For this code to work, we must have either
1795 * change_scroll_region and scroll forward/reverse commands, or
1796 * insert and delete line capabilities.
1797 * When the scrolling region has been set, the cursor has to
1798 * be at the last line of the region to make the scroll up
1799 * happen, or on the first line of region to scroll down.
1801 * This code makes one aesthetic decision in the opposite way from
1802 * BSD curses. BSD curses preferred pairs of il/dl operations
1803 * over scrolls, allegedly because il/dl looked faster. We, on
1804 * the other hand, prefer scrolls because (a) they're just as fast
1805 * on many terminals and (b) using them avoids bouncing an
1806 * unchanged bottom section of the screen up and down, which is
1809 * (lav): added more cases, used dl/il when bot==maxy and in csr case.
1811 * I used assumption that capabilities il/il1/dl/dl1 work inside
1812 * changed scroll region not shifting screen contents outside of it.
1813 * If there are any terminals behaving different way, it would be
1814 * necessary to add some conditions to scroll_csr_forward/backward.
1817 /* Try to scroll up assuming given csr (miny, maxy). Returns ERR on failure */
1819 scroll_csr_forward(NCURSES_SP_DCLx
1829 if (n == 1 && scroll_forward && top == miny && bot == maxy) {
1830 GoTo(NCURSES_SP_ARGx bot, 0);
1831 UpdateAttrs(SP_PARM, blank);
1832 NCURSES_PUTP2("scroll_forward", scroll_forward);
1833 } else if (n == 1 && delete_line && bot == maxy) {
1834 GoTo(NCURSES_SP_ARGx top, 0);
1835 UpdateAttrs(SP_PARM, blank);
1836 NCURSES_PUTP2("delete_line", delete_line);
1837 } else if (parm_index && top == miny && bot == maxy) {
1838 GoTo(NCURSES_SP_ARGx bot, 0);
1839 UpdateAttrs(SP_PARM, blank);
1840 TPUTS_TRACE("parm_index");
1841 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1842 TIPARM_1(parm_index, n),
1844 NCURSES_SP_NAME(_nc_outch));
1845 } else if (parm_delete_line && bot == maxy) {
1846 GoTo(NCURSES_SP_ARGx top, 0);
1847 UpdateAttrs(SP_PARM, blank);
1848 TPUTS_TRACE("parm_delete_line");
1849 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1850 TIPARM_1(parm_delete_line, n),
1852 NCURSES_SP_NAME(_nc_outch));
1853 } else if (scroll_forward && top == miny && bot == maxy) {
1854 GoTo(NCURSES_SP_ARGx bot, 0);
1855 UpdateAttrs(SP_PARM, blank);
1856 for (i = 0; i < n; i++) {
1857 NCURSES_PUTP2("scroll_forward", scroll_forward);
1859 } else if (delete_line && bot == maxy) {
1860 GoTo(NCURSES_SP_ARGx top, 0);
1861 UpdateAttrs(SP_PARM, blank);
1862 for (i = 0; i < n; i++) {
1863 NCURSES_PUTP2("delete_line", delete_line);
1868 #if NCURSES_EXT_FUNCS
1869 if (FILL_BCE(SP_PARM)) {
1871 for (i = 0; i < n; i++) {
1872 GoTo(NCURSES_SP_ARGx bot - i, 0);
1873 for (j = 0; j < screen_columns(SP_PARM); j++)
1874 PutChar(NCURSES_SP_ARGx CHREF(blank));
1881 /* Try to scroll down assuming given csr (miny, maxy). Returns ERR on failure */
1884 scroll_csr_backward(NCURSES_SP_DCLx
1894 if (n == 1 && scroll_reverse && top == miny && bot == maxy) {
1895 GoTo(NCURSES_SP_ARGx top, 0);
1896 UpdateAttrs(SP_PARM, blank);
1897 NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1898 } else if (n == 1 && insert_line && bot == maxy) {
1899 GoTo(NCURSES_SP_ARGx top, 0);
1900 UpdateAttrs(SP_PARM, blank);
1901 NCURSES_PUTP2("insert_line", insert_line);
1902 } else if (parm_rindex && top == miny && bot == maxy) {
1903 GoTo(NCURSES_SP_ARGx top, 0);
1904 UpdateAttrs(SP_PARM, blank);
1905 TPUTS_TRACE("parm_rindex");
1906 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1907 TIPARM_1(parm_rindex, n),
1909 NCURSES_SP_NAME(_nc_outch));
1910 } else if (parm_insert_line && bot == maxy) {
1911 GoTo(NCURSES_SP_ARGx top, 0);
1912 UpdateAttrs(SP_PARM, blank);
1913 TPUTS_TRACE("parm_insert_line");
1914 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1915 TIPARM_1(parm_insert_line, n),
1917 NCURSES_SP_NAME(_nc_outch));
1918 } else if (scroll_reverse && top == miny && bot == maxy) {
1919 GoTo(NCURSES_SP_ARGx top, 0);
1920 UpdateAttrs(SP_PARM, blank);
1921 for (i = 0; i < n; i++) {
1922 NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1924 } else if (insert_line && bot == maxy) {
1925 GoTo(NCURSES_SP_ARGx top, 0);
1926 UpdateAttrs(SP_PARM, blank);
1927 for (i = 0; i < n; i++) {
1928 NCURSES_PUTP2("insert_line", insert_line);
1933 #if NCURSES_EXT_FUNCS
1934 if (FILL_BCE(SP_PARM)) {
1936 for (i = 0; i < n; i++) {
1937 GoTo(NCURSES_SP_ARGx top + i, 0);
1938 for (j = 0; j < screen_columns(SP_PARM); j++)
1939 PutChar(NCURSES_SP_ARGx CHREF(blank));
1946 /* scroll by using delete_line at del and insert_line at ins */
1949 scroll_idl(NCURSES_SP_DCLx int n, int del, int ins, NCURSES_CH_T blank)
1953 if (!((parm_delete_line || delete_line) && (parm_insert_line || insert_line)))
1956 GoTo(NCURSES_SP_ARGx del, 0);
1957 UpdateAttrs(SP_PARM, blank);
1958 if (n == 1 && delete_line) {
1959 NCURSES_PUTP2("delete_line", delete_line);
1960 } else if (parm_delete_line) {
1961 TPUTS_TRACE("parm_delete_line");
1962 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1963 TIPARM_1(parm_delete_line, n),
1965 NCURSES_SP_NAME(_nc_outch));
1966 } else { /* if (delete_line) */
1967 for (i = 0; i < n; i++) {
1968 NCURSES_PUTP2("delete_line", delete_line);
1972 GoTo(NCURSES_SP_ARGx ins, 0);
1973 UpdateAttrs(SP_PARM, blank);
1974 if (n == 1 && insert_line) {
1975 NCURSES_PUTP2("insert_line", insert_line);
1976 } else if (parm_insert_line) {
1977 TPUTS_TRACE("parm_insert_line");
1978 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1979 TIPARM_1(parm_insert_line, n),
1981 NCURSES_SP_NAME(_nc_outch));
1982 } else { /* if (insert_line) */
1983 for (i = 0; i < n; i++) {
1984 NCURSES_PUTP2("insert_line", insert_line);
1992 * Note: some terminals require the cursor to be within the scrolling margins
1993 * before setting them. Generally, the cursor must be at the appropriate end
1994 * of the scrolling margins when issuing an indexing operation (it is not
1995 * apparent whether it must also be at the left margin; we do this just to be
1996 * safe). To make the related cursor movement a little faster, we use the
1997 * save/restore cursor capabilities if the terminal has them.
2000 NCURSES_SP_NAME(_nc_scrolln) (NCURSES_SP_DCLx
2005 /* scroll region from top to bot by n lines */
2009 bool cursor_saved = FALSE;
2012 TR(TRACE_MOVE, ("_nc_scrolln(%p, %d, %d, %d, %d)",
2013 (void *) SP_PARM, n, top, bot, maxy));
2015 if (!IsValidScreen(SP_PARM))
2018 blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
2022 * If we scroll, we might remove a cookie.
2024 if (magic_cookie_glitch > 0) {
2029 if (n > 0) { /* scroll up (forward) */
2031 * Explicitly clear if stuff pushed off top of region might
2032 * be saved by the terminal.
2034 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, 0, maxy, blank);
2036 if (res == ERR && change_scroll_region) {
2037 if ((((n == 1 && scroll_forward) || parm_index)
2038 && (SP_PARM->_cursrow == bot || SP_PARM->_cursrow == bot - 1))
2039 && save_cursor && restore_cursor) {
2040 cursor_saved = TRUE;
2041 NCURSES_PUTP2("save_cursor", save_cursor);
2043 NCURSES_PUTP2("change_scroll_region",
2044 TIPARM_2(change_scroll_region, top, bot));
2046 NCURSES_PUTP2("restore_cursor", restore_cursor);
2048 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2051 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, top, bot, blank);
2053 NCURSES_PUTP2("change_scroll_region",
2054 TIPARM_2(change_scroll_region, 0, maxy));
2055 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2058 if (res == ERR && SP_PARM->_nc_sp_idlok)
2059 res = scroll_idl(NCURSES_SP_ARGx n, top, bot - n + 1, blank);
2062 * Clear the newly shifted-in text.
2065 && (non_dest_scroll_region || (memory_below && bot == maxy))) {
2066 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2067 if (bot == maxy && clr_eos) {
2068 GoTo(NCURSES_SP_ARGx bot - n + 1, 0);
2069 ClrToEOS(NCURSES_SP_ARGx blank2);
2071 for (i = 0; i < n; i++) {
2072 GoTo(NCURSES_SP_ARGx bot - i, 0);
2073 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2078 } else { /* (n < 0) - scroll down (backward) */
2079 res = scroll_csr_backward(NCURSES_SP_ARGx -n, top, bot, 0, maxy, blank);
2081 if (res == ERR && change_scroll_region) {
2083 && (SP_PARM->_cursrow == top ||
2084 SP_PARM->_cursrow == top - 1)
2085 && save_cursor && restore_cursor) {
2086 cursor_saved = TRUE;
2087 NCURSES_PUTP2("save_cursor", save_cursor);
2089 NCURSES_PUTP2("change_scroll_region",
2090 TIPARM_2(change_scroll_region, top, bot));
2092 NCURSES_PUTP2("restore_cursor", restore_cursor);
2094 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2097 res = scroll_csr_backward(NCURSES_SP_ARGx
2098 -n, top, bot, top, bot, blank);
2100 NCURSES_PUTP2("change_scroll_region",
2101 TIPARM_2(change_scroll_region, 0, maxy));
2102 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2105 if (res == ERR && SP_PARM->_nc_sp_idlok)
2106 res = scroll_idl(NCURSES_SP_ARGx -n, bot + n + 1, top, blank);
2109 * Clear the newly shifted-in text.
2112 && (non_dest_scroll_region || (memory_above && top == 0))) {
2113 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2114 for (i = 0; i < -n; i++) {
2115 GoTo(NCURSES_SP_ARGx i + top, 0);
2116 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2124 _nc_scroll_window(CurScreen(SP_PARM), n,
2125 (NCURSES_SIZE_T) top,
2126 (NCURSES_SIZE_T) bot,
2129 /* shift hash values too - they can be reused */
2130 NCURSES_SP_NAME(_nc_scroll_oldhash) (NCURSES_SP_ARGx n, top, bot);
2135 #if NCURSES_SP_FUNCS
2137 _nc_scrolln(int n, int top, int bot, int maxy)
2139 return NCURSES_SP_NAME(_nc_scrolln) (CURRENT_SCREEN, n, top, bot, maxy);
2143 NCURSES_EXPORT(void)
2144 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_DCL0)
2148 /* make sure terminal is in a sane known state */
2149 SetAttr(SCREEN_ATTRS(SP_PARM), A_NORMAL);
2150 NewScreen(SP_PARM)->_clear = TRUE;
2152 /* reset color pairs and definitions */
2153 if (SP_PARM->_coloron || SP_PARM->_color_defs)
2154 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2156 /* restore user-defined colors, if any */
2157 if (SP_PARM->_color_defs < 0 && !SP_PARM->_direct_color.value) {
2159 SP_PARM->_color_defs = -(SP_PARM->_color_defs);
2160 for (n = 0; n < SP_PARM->_color_defs; ++n) {
2161 if (SP_PARM->_color_table[n].init) {
2162 _nc_init_color(SP_PARM,
2164 SP_PARM->_color_table[n].r,
2165 SP_PARM->_color_table[n].g,
2166 SP_PARM->_color_table[n].b);
2171 if (exit_attribute_mode)
2172 NCURSES_PUTP2("exit_attribute_mode", exit_attribute_mode);
2174 /* turn off attributes */
2175 if (exit_alt_charset_mode)
2176 NCURSES_PUTP2("exit_alt_charset_mode", exit_alt_charset_mode);
2177 if (exit_standout_mode)
2178 NCURSES_PUTP2("exit_standout_mode", exit_standout_mode);
2179 if (exit_underline_mode)
2180 NCURSES_PUTP2("exit_underline_mode", exit_underline_mode);
2182 if (exit_insert_mode)
2183 NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
2184 if (enter_am_mode && exit_am_mode) {
2185 if (auto_right_margin) {
2186 NCURSES_PUTP2("enter_am_mode", enter_am_mode);
2188 NCURSES_PUTP2("exit_am_mode", exit_am_mode);
2193 #if NCURSES_SP_FUNCS
2194 NCURSES_EXPORT(void)
2195 _nc_screen_resume(void)
2197 NCURSES_SP_NAME(_nc_screen_resume) (CURRENT_SCREEN);
2201 NCURSES_EXPORT(void)
2202 NCURSES_SP_NAME(_nc_screen_init) (NCURSES_SP_DCL0)
2204 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
2207 #if NCURSES_SP_FUNCS
2208 NCURSES_EXPORT(void)
2209 _nc_screen_init(void)
2211 NCURSES_SP_NAME(_nc_screen_init) (CURRENT_SCREEN);
2215 /* wrap up screen handling */
2216 NCURSES_EXPORT(void)
2217 NCURSES_SP_NAME(_nc_screen_wrap) (NCURSES_SP_DCL0)
2221 UpdateAttrs(SP_PARM, normal);
2222 #if NCURSES_EXT_FUNCS
2223 if (SP_PARM->_coloron
2224 && !SP_PARM->_default_color) {
2225 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
2226 SP_PARM->_default_color = TRUE;
2227 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
2231 NCURSES_SP_NAME(_nc_outch));
2232 SP_PARM->_default_color = FALSE;
2234 TINFO_MVCUR(NCURSES_SP_ARGx
2237 screen_lines(SP_PARM) - 1,
2240 ClrToEOL(NCURSES_SP_ARGx blank, TRUE);
2243 if (SP_PARM->_color_defs) {
2244 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2249 #if NCURSES_SP_FUNCS
2250 NCURSES_EXPORT(void)
2251 _nc_screen_wrap(void)
2253 NCURSES_SP_NAME(_nc_screen_wrap) (CURRENT_SCREEN);
2258 NCURSES_EXPORT(void)
2259 NCURSES_SP_NAME(_nc_do_xmc_glitch) (NCURSES_SP_DCLx attr_t previous)
2262 attr_t chg = XMC_CHANGES(previous ^ AttrOf(SCREEN_ATTRS(SP_PARM)));
2266 SP_PARM->_curscol += magic_cookie_glitch;
2267 if (SP_PARM->_curscol >= SP_PARM->_columns)
2268 wrap_cursor(NCURSES_SP_ARG);
2269 TR(TRACE_UPDATE, ("bumped to %d,%d after cookie",
2270 SP_PARM->_cursrow, SP_PARM->_curscol));
2277 #if NCURSES_SP_FUNCS
2278 NCURSES_EXPORT(void)
2279 _nc_do_xmc_glitch(attr_t previous)
2281 NCURSES_SP_NAME(_nc_do_xmc_glitch) (CURRENT_SCREEN, previous);
2285 #endif /* USE_XMC_SUPPORT */