1 /****************************************************************************
2 * Copyright 2018-2021,2022 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.314 2022/07/23 22:12: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
761 if (SP_PARM == CURRENT_SCREEN) {
763 #define SyncScreens(internal,exported) \
764 if (internal == 0) internal = exported; \
765 if (internal != exported) exported = internal
767 SyncScreens(CurScreen(SP_PARM), curscr);
768 SyncScreens(NewScreen(SP_PARM), newscr);
769 SyncScreens(StdScreen(SP_PARM), stdscr);
773 #endif /* !USE_REENTRANT */
775 if (CurScreen(SP_PARM) == 0
776 || NewScreen(SP_PARM) == 0
777 || StdScreen(SP_PARM) == 0) {
778 _nc_unlock_global(update);
782 if (USE_TRACEF(TRACE_UPDATE)) {
783 if (CurScreen(SP_PARM)->_clear)
784 _tracef("curscr is clear");
786 _tracedump("curscr", CurScreen(SP_PARM));
787 _tracedump("newscr", NewScreen(SP_PARM));
788 _nc_unlock_global(tracef);
792 _nc_signal_handler(FALSE);
794 if (SP_PARM->_fifohold)
795 SP_PARM->_fifohold--;
798 if ((SP_PARM->_endwin == ewSuspend)
799 || _nc_handle_sigwinch(SP_PARM)) {
801 * This is a transparent extension: XSI does not address it,
802 * and applications need not know that ncurses can do it.
804 * Check if the terminal size has changed while curses was off
805 * (this can happen in an xterm, for example), and resize the
806 * ncurses data structures accordingly.
808 _nc_update_screensize(SP_PARM);
812 if (SP_PARM->_endwin == ewSuspend) {
814 T(("coming back from shell mode"));
815 NCURSES_SP_NAME(reset_prog_mode) (NCURSES_SP_ARG);
817 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
818 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
819 SP_PARM->_mouse_resume(SP_PARM);
821 SP_PARM->_endwin = ewRunning;
824 /* zero the metering machinery */
826 (void) times(&before);
827 #endif /* USE_TRACE_TIMES */
830 * This is the support for magic-cookie terminals. The theory: we scan
831 * the virtual screen looking for attribute turnons. Where we find one,
832 * check to make sure it is realizable by seeing if the required number of
833 * un-attributed blanks are present before and after the attributed range;
834 * try to shift the range boundaries over blanks (not changing the screen
835 * display) so this becomes true. If it is, shift the beginning attribute
836 * change appropriately (the end one, if we've gotten this far, is
837 * guaranteed room for its cookie). If not, nuke the added attributes out
841 if (magic_cookie_glitch > 0) {
843 attr_t rattr = A_NORMAL;
845 for (i = 0; i < screen_lines(SP_PARM); i++) {
846 for (j = 0; j < screen_columns(SP_PARM); j++) {
848 NCURSES_CH_T *thisline = NewScreen(SP_PARM)->_line[i].text;
849 attr_t thisattr = AttrOf(thisline[j]) & SP_PARM->_xmc_triggers;
850 attr_t turnon = thisattr & ~rattr;
852 /* is an attribute turned on here? */
858 TR(TRACE_ATTRS, ("At (%d, %d): from %s...", i, j, _traceattr(rattr)));
859 TR(TRACE_ATTRS, ("...to %s", _traceattr(turnon)));
862 * If the attribute change location is a blank with a "safe"
863 * attribute, undo the attribute turnon. This may ensure
864 * there's enough room to set the attribute before the first
865 * non-blank in the run.
867 #define SAFE(scr,a) (!((a) & (scr)->_xmc_triggers))
868 if (ISBLANK(thisline[j]) && SAFE(SP_PARM, turnon)) {
869 RemAttr(thisline[j], turnon);
873 /* check that there's enough room at start of span */
874 for (k = 1; k <= magic_cookie_glitch; k++) {
876 || !ISBLANK(thisline[j - k])
877 || !SAFE(SP_PARM, AttrOf(thisline[j - k]))) {
879 TR(TRACE_ATTRS, ("No room at start in %d,%d%s%s",
881 (ISBLANK(thisline[j - k])
884 (SAFE(SP_PARM, AttrOf(thisline[j - k]))
891 bool end_onscreen = FALSE;
894 /* find end of span, if it is onscreen */
895 for (m = i; m < screen_lines(SP_PARM); m++) {
896 for (; n < screen_columns(SP_PARM); n++) {
898 AttrOf(NewScreen(SP_PARM)->_line[m].text[n]);
899 if ((testattr & SP_PARM->_xmc_triggers) == rattr) {
902 ("Range attributed with %s ends at (%d, %d)",
903 _traceattr(turnon), m, n));
910 ("Range attributed with %s ends offscreen",
911 _traceattr(turnon)));
915 NCURSES_CH_T *lastline =
916 NewScreen(SP_PARM)->_line[m].text;
919 * If there are safely-attributed blanks at the end of
920 * the range, shorten the range. This will help ensure
921 * that there is enough room at end of span.
924 && ISBLANK(lastline[n])
925 && SAFE(SP_PARM, AttrOf(lastline[n]))) {
926 RemAttr(lastline[n--], turnon);
929 /* check that there's enough room at end of span */
930 for (k = 1; k <= magic_cookie_glitch; k++) {
931 if (n + k >= screen_columns(SP_PARM)
932 || !ISBLANK(lastline[n + k])
933 || !SAFE(SP_PARM, AttrOf(lastline[n + k]))) {
936 ("No room at end in %d,%d%s%s",
938 (ISBLANK(lastline[n + k])
941 (SAFE(SP_PARM, AttrOf(lastline[n + k]))
954 ("Clearing %s beginning at (%d, %d)",
955 _traceattr(turnon), i, j));
957 /* turn off new attributes over span */
958 for (p = i; p < screen_lines(SP_PARM); p++) {
959 for (; q < screen_columns(SP_PARM); q++) {
960 attr_t testattr = AttrOf(newscr->_line[p].text[q]);
961 if ((testattr & SP_PARM->_xmc_triggers) == rattr)
963 RemAttr(NewScreen(SP_PARM)->_line[p].text[q], turnon);
970 ("Cookie space for %s found before (%d, %d)",
971 _traceattr(turnon), i, j));
974 * Back up the start of range so there's room for cookies
975 * before the first nonblank character.
977 for (k = 1; k <= magic_cookie_glitch; k++)
978 AddAttr(thisline[j - k], turnon);
986 /* show altered highlights after magic-cookie check */
987 if (USE_TRACEF(TRACE_UPDATE)) {
988 _tracef("After magic-cookie check...");
989 _tracedump("newscr", NewScreen(SP_PARM));
990 _nc_unlock_global(tracef);
994 #endif /* USE_XMC_SUPPORT */
997 if (CurScreen(SP_PARM)->_clear || NewScreen(SP_PARM)->_clear) { /* force refresh ? */
998 ClrUpdate(NCURSES_SP_ARG);
999 CurScreen(SP_PARM)->_clear = FALSE; /* reset flag */
1000 NewScreen(SP_PARM)->_clear = FALSE; /* reset flag */
1002 int changedlines = CHECK_INTERVAL;
1004 if (check_pending(NCURSES_SP_ARG))
1007 nonempty = min(screen_lines(SP_PARM), NewScreen(SP_PARM)->_maxy + 1);
1009 if (SP_PARM->_scrolling) {
1010 NCURSES_SP_NAME(_nc_scroll_optimize) (NCURSES_SP_ARG);
1013 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1015 TR(TRACE_UPDATE, ("Transforming lines, nonempty %d", nonempty));
1016 for (i = 0; i < nonempty; i++) {
1018 * Here is our line-breakout optimization.
1020 if (changedlines == CHECK_INTERVAL) {
1021 if (check_pending(NCURSES_SP_ARG))
1027 * newscr->line[i].firstchar is normally set
1028 * by wnoutrefresh. curscr->line[i].firstchar
1029 * is normally set by _nc_scroll_window in the
1030 * vertical-movement optimization code,
1032 if (NewScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE
1033 || CurScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE) {
1034 TransformLine(NCURSES_SP_ARGx i);
1038 /* mark line changed successfully */
1039 if (i <= NewScreen(SP_PARM)->_maxy) {
1040 MARK_NOCHANGE(NewScreen(SP_PARM), i);
1042 if (i <= CurScreen(SP_PARM)->_maxy) {
1043 MARK_NOCHANGE(CurScreen(SP_PARM), i);
1048 /* put everything back in sync */
1049 for (i = nonempty; i <= NewScreen(SP_PARM)->_maxy; i++) {
1050 MARK_NOCHANGE(NewScreen(SP_PARM), i);
1052 for (i = nonempty; i <= CurScreen(SP_PARM)->_maxy; i++) {
1053 MARK_NOCHANGE(CurScreen(SP_PARM), i);
1056 if (!NewScreen(SP_PARM)->_leaveok) {
1057 CurScreen(SP_PARM)->_curx = NewScreen(SP_PARM)->_curx;
1058 CurScreen(SP_PARM)->_cury = NewScreen(SP_PARM)->_cury;
1060 GoTo(NCURSES_SP_ARGx CurScreen(SP_PARM)->_cury, CurScreen(SP_PARM)->_curx);
1065 * We would like to keep the physical screen in normal mode in case we get
1066 * other processes writing to the screen. This goal cannot be met for
1067 * magic cookies since it interferes with attributes that may propagate
1068 * past the current position.
1071 if (magic_cookie_glitch != 0)
1073 UpdateAttrs(SP_PARM, normal);
1075 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1076 WINDOW_ATTRS(CurScreen(SP_PARM)) = WINDOW_ATTRS(NewScreen(SP_PARM));
1079 (void) times(&after);
1081 ("Update cost: %ld chars, %ld clocks system time, %ld clocks user time",
1083 (long) (after.tms_stime - before.tms_stime),
1084 (long) (after.tms_utime - before.tms_utime)));
1085 #endif /* USE_TRACE_TIMES */
1087 _nc_signal_handler(TRUE);
1089 _nc_unlock_global(update);
1093 #if NCURSES_SP_FUNCS && !defined(USE_TERM_DRIVER)
1097 return TINFO_DOUPDATE(CURRENT_SCREEN);
1104 * Returns the attributed character that corresponds to the "cleared"
1105 * screen. If the terminal has the back-color-erase feature, this will be
1106 * colored according to the wbkgd() call.
1108 * We treat 'curscr' specially because it isn't supposed to be set directly
1109 * in the wbkgd() call. Assume 'stdscr' for this case.
1111 #define BCE_ATTRS (A_NORMAL|A_COLOR)
1112 #define BCE_BKGD(sp,win) (((win) == CurScreen(sp) ? StdScreen(sp) : (win))->_nc_bkgd)
1114 static NCURSES_INLINE NCURSES_CH_T
1115 ClrBlank(NCURSES_SP_DCLx WINDOW *win)
1117 NCURSES_CH_T blank = blankchar;
1118 if (back_color_erase)
1119 AddAttr(blank, (AttrOf(BCE_BKGD(SP_PARM, win)) & BCE_ATTRS));
1126 ** Update by clearing and redrawing the entire screen.
1131 ClrUpdate(NCURSES_SP_DCL0)
1133 TR(TRACE_UPDATE, (T_CALLED("ClrUpdate")));
1136 NCURSES_CH_T blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1137 int nonempty = min(screen_lines(SP_PARM),
1138 NewScreen(SP_PARM)->_maxy + 1);
1140 ClearScreen(NCURSES_SP_ARGx blank);
1142 TR(TRACE_UPDATE, ("updating screen from scratch"));
1144 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1146 for (i = 0; i < nonempty; i++)
1147 TransformLine(NCURSES_SP_ARGx i);
1149 TR(TRACE_UPDATE, (T_RETURN("")));
1155 ** Clear to end of current line, starting at the cursor position
1159 ClrToEOL(NCURSES_SP_DCLx NCURSES_CH_T blank, int needclear)
1161 if (CurScreen(SP_PARM) != 0
1162 && SP_PARM->_cursrow >= 0) {
1165 for (j = SP_PARM->_curscol; j < screen_columns(SP_PARM); j++) {
1168 &(CurScreen(SP_PARM)->_line[SP_PARM->_cursrow].text[j]);
1170 if (!CharEq(*cp, blank)) {
1179 UpdateAttrs(SP_PARM, blank);
1180 if (clr_eol && SP_PARM->_el_cost <= (screen_columns(SP_PARM) - SP_PARM->_curscol)) {
1181 NCURSES_PUTP2("clr_eol", clr_eol);
1183 int count = (screen_columns(SP_PARM) - SP_PARM->_curscol);
1185 PutChar(NCURSES_SP_ARGx CHREF(blank));
1193 ** Clear to end of screen, starting at the cursor position
1197 ClrToEOS(NCURSES_SP_DCLx NCURSES_CH_T blank)
1201 row = SP_PARM->_cursrow;
1202 col = SP_PARM->_curscol;
1209 UpdateAttrs(SP_PARM, blank);
1210 TPUTS_TRACE("clr_eos");
1211 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1213 screen_lines(SP_PARM) - row,
1214 NCURSES_SP_NAME(_nc_outch));
1216 while (col < screen_columns(SP_PARM))
1217 CurScreen(SP_PARM)->_line[row].text[col++] = blank;
1219 for (row++; row < screen_lines(SP_PARM); row++) {
1220 for (col = 0; col < screen_columns(SP_PARM); col++)
1221 CurScreen(SP_PARM)->_line[row].text[col] = blank;
1228 * Test if clearing the end of the screen would satisfy part of the
1229 * screen-update. Do this by scanning backwards through the lines in the
1230 * screen, checking if each is blank, and one or more are changed.
1233 ClrBottom(NCURSES_SP_DCLx int total)
1236 int last = min(screen_columns(SP_PARM), NewScreen(SP_PARM)->_maxx + 1);
1237 NCURSES_CH_T blank = NewScreen(SP_PARM)->_line[total - 1].text[last - 1];
1239 if (clr_eos && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1242 for (row = total - 1; row >= 0; row--) {
1246 for (col = 0, ok = TRUE; ok && col < last; col++) {
1247 ok = (CharEq(NewScreen(SP_PARM)->_line[row].text[col], blank));
1252 for (col = 0; ok && col < last; col++) {
1253 ok = (CharEq(CurScreen(SP_PARM)->_line[row].text[col], blank));
1259 /* don't use clr_eos for just one line if clr_eol available */
1261 GoTo(NCURSES_SP_ARGx top, 0);
1262 ClrToEOS(NCURSES_SP_ARGx blank);
1263 if (SP_PARM->oldhash && SP_PARM->newhash) {
1264 for (row = top; row < screen_lines(SP_PARM); row++)
1265 SP_PARM->oldhash[row] = SP_PARM->newhash[row];
1273 #if USE_WIDEC_SUPPORT
1274 #define check_xmc_transition(sp, a, b) \
1275 ((((a)->attr ^ (b)->attr) & ~((a)->attr) & (sp)->_xmc_triggers) != 0)
1276 #define xmc_turn_on(sp,a,b) check_xmc_transition(sp,&(a), &(b))
1278 #define xmc_turn_on(sp,a,b) ((((a)^(b)) & ~(a) & (sp)->_xmc_triggers) != 0)
1281 #define xmc_new(sp,r,c) NewScreen(sp)->_line[r].text[c]
1282 #define xmc_turn_off(sp,a,b) xmc_turn_on(sp,b,a)
1283 #endif /* USE_XMC_SUPPORT */
1286 ** TransformLine(lineno)
1288 ** Transform the given line in curscr to the one in newscr, using
1289 ** Insert/Delete Character if idcok && has_ic().
1291 ** firstChar = position of first different character in line
1292 ** oLastChar = position of last different character in old line
1293 ** nLastChar = position of last different character in new line
1295 ** move to firstChar
1296 ** overwrite chars up to min(oLastChar, nLastChar)
1297 ** if oLastChar < nLastChar
1298 ** insert newLine[oLastChar+1..nLastChar]
1300 ** delete oLastChar - nLastChar spaces
1304 TransformLine(NCURSES_SP_DCLx int const lineno)
1306 int firstChar, oLastChar, nLastChar;
1307 NCURSES_CH_T *newLine = NewScreen(SP_PARM)->_line[lineno].text;
1308 NCURSES_CH_T *oldLine = CurScreen(SP_PARM)->_line[lineno].text;
1310 bool attrchanged = FALSE;
1312 TR(TRACE_UPDATE, (T_CALLED("TransformLine(%p, %d)"), (void *) SP_PARM, lineno));
1314 /* copy new hash value to old one */
1315 if (SP_PARM->oldhash && SP_PARM->newhash)
1316 SP_PARM->oldhash[lineno] = SP_PARM->newhash[lineno];
1319 * If we have colors, there is the possibility of having two color pairs
1320 * that display as the same colors. For instance, Lynx does this. Check
1321 * for this case, and update the old line with the new line's colors when
1322 * they are equivalent.
1324 if (SP_PARM->_coloron) {
1328 for (n = 0; n < screen_columns(SP_PARM); n++) {
1329 if (!CharEq(newLine[n], oldLine[n])) {
1330 oldPair = GetPair(oldLine[n]);
1331 newPair = GetPair(newLine[n]);
1332 if (oldPair != newPair
1333 && unColor(oldLine[n]) == unColor(newLine[n])) {
1334 if (oldPair < SP_PARM->_pair_alloc
1335 && newPair < SP_PARM->_pair_alloc
1336 && (isSamePair(SP_PARM->_color_pairs[oldPair],
1337 SP_PARM->_color_pairs[newPair]))) {
1338 SetPair(oldLine[n], GetPair(newLine[n]));
1345 if (ceol_standout_glitch && clr_eol) {
1347 while (firstChar < screen_columns(SP_PARM)) {
1348 if (!SameAttrOf(newLine[firstChar], oldLine[firstChar])) {
1358 if (attrchanged) { /* we may have to disregard the whole line */
1359 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1360 ClrToEOL(NCURSES_SP_ARGx
1361 ClrBlank(NCURSES_SP_ARGx
1362 CurScreen(SP_PARM)), FALSE);
1363 PutRange(NCURSES_SP_ARGx
1364 oldLine, newLine, lineno, 0,
1365 screen_columns(SP_PARM) - 1);
1369 * This is a very simple loop to paint characters which may have the
1370 * magic cookie glitch embedded. It doesn't know much about video
1371 * attributes which are continued from one line to the next. It
1372 * assumes that we have filtered out requests for attribute changes
1373 * that do not get mapped to blank positions.
1375 * FIXME: we are not keeping track of where we put the cookies, so this
1376 * will work properly only once, since we may overwrite a cookie in a
1377 * following operation.
1379 } else if (magic_cookie_glitch > 0) {
1380 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1381 for (n = 0; n < screen_columns(SP_PARM); n++) {
1382 int m = n + magic_cookie_glitch;
1384 /* check for turn-on:
1385 * If we are writing an attributed blank, where the
1386 * previous cell is not attributed.
1388 if (ISBLANK(newLine[n])
1390 && xmc_turn_on(SP_PARM, newLine[n - 1], newLine[n]))
1393 && xmc_turn_on(SP_PARM,
1394 xmc_new(SP_PARM, lineno - 1,
1395 screen_columns(SP_PARM) - 1),
1400 PutChar(NCURSES_SP_ARGx CHREF(newLine[n]));
1402 /* check for turn-off:
1403 * If we are writing an attributed non-blank, where the
1404 * next cell is blank, and not attributed.
1406 if (!ISBLANK(newLine[n])
1407 && ((n + 1 < screen_columns(SP_PARM)
1408 && xmc_turn_off(SP_PARM, newLine[n], newLine[n + 1]))
1409 || (n + 1 >= screen_columns(SP_PARM)
1410 && lineno + 1 < screen_lines(SP_PARM)
1411 && xmc_turn_off(SP_PARM,
1413 xmc_new(SP_PARM, lineno + 1, 0))))) {
1422 /* it may be cheap to clear leading whitespace with clr_bol */
1424 if (clr_bol && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1425 int oFirstChar, nFirstChar;
1427 for (oFirstChar = 0;
1428 oFirstChar < screen_columns(SP_PARM);
1430 if (!CharEq(oldLine[oFirstChar], blank))
1432 for (nFirstChar = 0;
1433 nFirstChar < screen_columns(SP_PARM);
1435 if (!CharEq(newLine[nFirstChar], blank))
1438 if (nFirstChar == oFirstChar) {
1439 firstChar = nFirstChar;
1440 /* find the first differing character */
1441 while (firstChar < screen_columns(SP_PARM)
1442 && CharEq(newLine[firstChar], oldLine[firstChar]))
1444 } else if (oFirstChar > nFirstChar) {
1445 firstChar = nFirstChar;
1446 } else { /* oFirstChar < nFirstChar */
1447 firstChar = oFirstChar;
1448 if (SP_PARM->_el1_cost < nFirstChar - oFirstChar) {
1449 if (nFirstChar >= screen_columns(SP_PARM)
1450 && SP_PARM->_el_cost <= SP_PARM->_el1_cost) {
1451 GoTo(NCURSES_SP_ARGx lineno, 0);
1452 UpdateAttrs(SP_PARM, blank);
1453 NCURSES_PUTP2("clr_eol", clr_eol);
1455 GoTo(NCURSES_SP_ARGx lineno, nFirstChar - 1);
1456 UpdateAttrs(SP_PARM, blank);
1457 NCURSES_PUTP2("clr_bol", clr_bol);
1460 while (firstChar < nFirstChar)
1461 oldLine[firstChar++] = blank;
1465 /* find the first differing character */
1466 while (firstChar < screen_columns(SP_PARM)
1467 && CharEq(newLine[firstChar], oldLine[firstChar]))
1470 /* if there wasn't one, we're done */
1471 if (firstChar >= screen_columns(SP_PARM)) {
1472 TR(TRACE_UPDATE, (T_RETURN("")));
1476 blank = newLine[screen_columns(SP_PARM) - 1];
1478 if (!can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1479 /* find the last differing character */
1480 nLastChar = screen_columns(SP_PARM) - 1;
1482 while (nLastChar > firstChar
1483 && CharEq(newLine[nLastChar], oldLine[nLastChar]))
1486 if (nLastChar >= firstChar) {
1487 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1488 PutRange(NCURSES_SP_ARGx
1494 memcpy(oldLine + firstChar,
1495 newLine + firstChar,
1496 (unsigned) (nLastChar - firstChar + 1) * sizeof(NCURSES_CH_T));
1498 TR(TRACE_UPDATE, (T_RETURN("")));
1502 /* find last non-blank character on old line */
1503 oLastChar = screen_columns(SP_PARM) - 1;
1504 while (oLastChar > firstChar && CharEq(oldLine[oLastChar], blank))
1507 /* find last non-blank character on new line */
1508 nLastChar = screen_columns(SP_PARM) - 1;
1509 while (nLastChar > firstChar && CharEq(newLine[nLastChar], blank))
1512 if ((nLastChar == firstChar)
1513 && (SP_PARM->_el_cost < (oLastChar - nLastChar))) {
1514 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1515 if (!CharEq(newLine[firstChar], blank))
1516 PutChar(NCURSES_SP_ARGx CHREF(newLine[firstChar]));
1517 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1518 } else if ((nLastChar != oLastChar)
1519 && (!CharEq(newLine[nLastChar], oldLine[oLastChar])
1520 || !(SP_PARM->_nc_sp_idcok
1521 && NCURSES_SP_NAME(has_ic) (NCURSES_SP_ARG)))) {
1522 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1523 if ((oLastChar - nLastChar) > SP_PARM->_el_cost) {
1524 if (PutRange(NCURSES_SP_ARGx
1530 GoTo(NCURSES_SP_ARGx lineno, nLastChar + 1);
1532 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1534 n = max(nLastChar, oLastChar);
1535 PutRange(NCURSES_SP_ARGx
1543 int nLastNonblank = nLastChar;
1544 int oLastNonblank = oLastChar;
1546 /* find the last characters that really differ */
1547 /* can be -1 if no characters differ */
1548 while (CharEq(newLine[nLastChar], oldLine[oLastChar])) {
1549 /* don't split a wide char */
1550 if (isWidecExt(newLine[nLastChar]) &&
1551 !CharEq(newLine[nLastChar - 1], oldLine[oLastChar - 1]))
1555 if (nLastChar == -1 || oLastChar == -1)
1559 n = min(oLastChar, nLastChar);
1560 if (n >= firstChar) {
1561 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1562 PutRange(NCURSES_SP_ARGx
1570 if (oLastChar < nLastChar) {
1571 int m = max(nLastNonblank, oLastNonblank);
1572 #if USE_WIDEC_SUPPORT
1574 while (isWidecExt(newLine[n + 1]) && n) {
1576 --oLastChar; /* increase cost */
1578 } else if (n >= firstChar &&
1579 isWidecBase(newLine[n])) {
1580 while (isWidecExt(newLine[n + 1])) {
1582 ++oLastChar; /* decrease cost */
1586 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1587 if ((nLastChar < nLastNonblank)
1588 || InsCharCost(SP_PARM, nLastChar - oLastChar) > (m - n)) {
1589 PutRange(NCURSES_SP_ARGx
1596 InsStr(NCURSES_SP_ARGx &newLine[n + 1], nLastChar - oLastChar);
1598 } else if (oLastChar > nLastChar) {
1599 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1600 if (DelCharCost(SP_PARM, oLastChar - nLastChar)
1601 > SP_PARM->_el_cost + nLastNonblank - (n + 1)) {
1602 if (PutRange(NCURSES_SP_ARGx oldLine, newLine, lineno,
1603 n + 1, nLastNonblank)) {
1604 GoTo(NCURSES_SP_ARGx lineno, nLastNonblank + 1);
1606 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1609 * The delete-char sequence will
1610 * effectively shift in blanks from the
1611 * right margin of the screen. Ensure
1612 * that they are the right color by
1613 * setting the video attributes from
1614 * the last character on the row.
1616 UpdateAttrs(SP_PARM, blank);
1617 DelChar(NCURSES_SP_ARGx oLastChar - nLastChar);
1623 /* update the code's internal representation */
1624 if (screen_columns(SP_PARM) > firstChar)
1625 memcpy(oldLine + firstChar,
1626 newLine + firstChar,
1627 (unsigned) (screen_columns(SP_PARM) - firstChar) * sizeof(NCURSES_CH_T));
1628 TR(TRACE_UPDATE, (T_RETURN("")));
1633 ** ClearScreen(blank)
1635 ** Clear the physical screen and put cursor at home
1640 ClearScreen(NCURSES_SP_DCLx NCURSES_CH_T blank)
1643 bool fast_clear = (clear_screen || clr_eos || clr_eol);
1645 TR(TRACE_UPDATE, ("ClearScreen() called"));
1647 #if NCURSES_EXT_FUNCS
1648 if (SP_PARM->_coloron
1649 && !SP_PARM->_default_color) {
1650 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
1651 (short) GET_SCREEN_PAIR(SP_PARM),
1654 NCURSES_SP_NAME(_nc_outch));
1655 if (!back_color_erase) {
1663 UpdateAttrs(SP_PARM, blank);
1664 NCURSES_PUTP2("clear_screen", clear_screen);
1665 SP_PARM->_cursrow = SP_PARM->_curscol = 0;
1666 position_check(NCURSES_SP_ARGx
1670 } else if (clr_eos) {
1671 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1672 GoTo(NCURSES_SP_ARGx 0, 0);
1673 UpdateAttrs(SP_PARM, blank);
1674 TPUTS_TRACE("clr_eos");
1675 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1677 screen_lines(SP_PARM),
1678 NCURSES_SP_NAME(_nc_outch));
1679 } else if (clr_eol) {
1680 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1681 UpdateAttrs(SP_PARM, blank);
1682 for (i = 0; i < screen_lines(SP_PARM); i++) {
1683 GoTo(NCURSES_SP_ARGx i, 0);
1684 NCURSES_PUTP2("clr_eol", clr_eol);
1686 GoTo(NCURSES_SP_ARGx 0, 0);
1689 UpdateAttrs(SP_PARM, blank);
1690 for (i = 0; i < screen_lines(SP_PARM); i++) {
1691 GoTo(NCURSES_SP_ARGx i, 0);
1692 for (j = 0; j < screen_columns(SP_PARM); j++)
1693 PutChar(NCURSES_SP_ARGx CHREF(blank));
1695 GoTo(NCURSES_SP_ARGx 0, 0);
1698 for (i = 0; i < screen_lines(SP_PARM); i++) {
1699 for (j = 0; j < screen_columns(SP_PARM); j++)
1700 CurScreen(SP_PARM)->_line[i].text[j] = blank;
1703 TR(TRACE_UPDATE, ("screen cleared"));
1707 ** InsStr(line, count)
1709 ** Insert the count characters pointed to by line.
1714 InsStr(NCURSES_SP_DCLx NCURSES_CH_T *line, int count)
1716 TR(TRACE_UPDATE, ("InsStr(%p, %p,%d) called",
1718 (void *) line, count));
1720 /* Prefer parm_ich as it has the smallest cost - no need to shift
1721 * the whole line on each character. */
1722 /* The order must match that of InsCharCost. */
1724 TPUTS_TRACE("parm_ich");
1725 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1726 TIPARM_1(parm_ich, count),
1728 NCURSES_SP_NAME(_nc_outch));
1730 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1734 } else if (enter_insert_mode && exit_insert_mode) {
1735 NCURSES_PUTP2("enter_insert_mode", enter_insert_mode);
1737 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1738 if (insert_padding) {
1739 NCURSES_PUTP2("insert_padding", insert_padding);
1744 NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
1747 NCURSES_PUTP2("insert_character", insert_character);
1748 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1749 if (insert_padding) {
1750 NCURSES_PUTP2("insert_padding", insert_padding);
1756 position_check(NCURSES_SP_ARGx
1758 SP_PARM->_curscol, "InsStr");
1764 ** Delete count characters at current position
1769 DelChar(NCURSES_SP_DCLx int count)
1771 TR(TRACE_UPDATE, ("DelChar(%p, %d) called, position = (%ld,%ld)",
1772 (void *) SP_PARM, count,
1773 (long) NewScreen(SP_PARM)->_cury,
1774 (long) NewScreen(SP_PARM)->_curx));
1777 TPUTS_TRACE("parm_dch");
1778 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1779 TIPARM_1(parm_dch, count),
1781 NCURSES_SP_NAME(_nc_outch));
1785 for (n = 0; n < count; n++) {
1786 NCURSES_PUTP2("delete_character", delete_character);
1792 * Physical-scrolling support
1794 * This code was adapted from Keith Bostic's hardware scrolling
1795 * support for 4.4BSD curses. I (esr) translated it to use terminfo
1796 * capabilities, narrowed the call interface slightly, and cleaned
1797 * up some convoluted tests. I also added support for the memory_above
1798 * memory_below, and non_dest_scroll_region capabilities.
1800 * For this code to work, we must have either
1801 * change_scroll_region and scroll forward/reverse commands, or
1802 * insert and delete line capabilities.
1803 * When the scrolling region has been set, the cursor has to
1804 * be at the last line of the region to make the scroll up
1805 * happen, or on the first line of region to scroll down.
1807 * This code makes one aesthetic decision in the opposite way from
1808 * BSD curses. BSD curses preferred pairs of il/dl operations
1809 * over scrolls, allegedly because il/dl looked faster. We, on
1810 * the other hand, prefer scrolls because (a) they're just as fast
1811 * on many terminals and (b) using them avoids bouncing an
1812 * unchanged bottom section of the screen up and down, which is
1815 * (lav): added more cases, used dl/il when bot==maxy and in csr case.
1817 * I used assumption that capabilities il/il1/dl/dl1 work inside
1818 * changed scroll region not shifting screen contents outside of it.
1819 * If there are any terminals behaving different way, it would be
1820 * necessary to add some conditions to scroll_csr_forward/backward.
1823 /* Try to scroll up assuming given csr (miny, maxy). Returns ERR on failure */
1825 scroll_csr_forward(NCURSES_SP_DCLx
1835 if (n == 1 && scroll_forward && top == miny && bot == maxy) {
1836 GoTo(NCURSES_SP_ARGx bot, 0);
1837 UpdateAttrs(SP_PARM, blank);
1838 NCURSES_PUTP2("scroll_forward", scroll_forward);
1839 } else if (n == 1 && delete_line && bot == maxy) {
1840 GoTo(NCURSES_SP_ARGx top, 0);
1841 UpdateAttrs(SP_PARM, blank);
1842 NCURSES_PUTP2("delete_line", delete_line);
1843 } else if (parm_index && top == miny && bot == maxy) {
1844 GoTo(NCURSES_SP_ARGx bot, 0);
1845 UpdateAttrs(SP_PARM, blank);
1846 TPUTS_TRACE("parm_index");
1847 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1848 TIPARM_1(parm_index, n),
1850 NCURSES_SP_NAME(_nc_outch));
1851 } else if (parm_delete_line && bot == maxy) {
1852 GoTo(NCURSES_SP_ARGx top, 0);
1853 UpdateAttrs(SP_PARM, blank);
1854 TPUTS_TRACE("parm_delete_line");
1855 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1856 TIPARM_1(parm_delete_line, n),
1858 NCURSES_SP_NAME(_nc_outch));
1859 } else if (scroll_forward && top == miny && bot == maxy) {
1860 GoTo(NCURSES_SP_ARGx bot, 0);
1861 UpdateAttrs(SP_PARM, blank);
1862 for (i = 0; i < n; i++) {
1863 NCURSES_PUTP2("scroll_forward", scroll_forward);
1865 } else if (delete_line && bot == maxy) {
1866 GoTo(NCURSES_SP_ARGx top, 0);
1867 UpdateAttrs(SP_PARM, blank);
1868 for (i = 0; i < n; i++) {
1869 NCURSES_PUTP2("delete_line", delete_line);
1874 #if NCURSES_EXT_FUNCS
1875 if (FILL_BCE(SP_PARM)) {
1877 for (i = 0; i < n; i++) {
1878 GoTo(NCURSES_SP_ARGx bot - i, 0);
1879 for (j = 0; j < screen_columns(SP_PARM); j++)
1880 PutChar(NCURSES_SP_ARGx CHREF(blank));
1887 /* Try to scroll down assuming given csr (miny, maxy). Returns ERR on failure */
1890 scroll_csr_backward(NCURSES_SP_DCLx
1900 if (n == 1 && scroll_reverse && top == miny && bot == maxy) {
1901 GoTo(NCURSES_SP_ARGx top, 0);
1902 UpdateAttrs(SP_PARM, blank);
1903 NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1904 } else if (n == 1 && insert_line && bot == maxy) {
1905 GoTo(NCURSES_SP_ARGx top, 0);
1906 UpdateAttrs(SP_PARM, blank);
1907 NCURSES_PUTP2("insert_line", insert_line);
1908 } else if (parm_rindex && top == miny && bot == maxy) {
1909 GoTo(NCURSES_SP_ARGx top, 0);
1910 UpdateAttrs(SP_PARM, blank);
1911 TPUTS_TRACE("parm_rindex");
1912 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1913 TIPARM_1(parm_rindex, n),
1915 NCURSES_SP_NAME(_nc_outch));
1916 } else if (parm_insert_line && bot == maxy) {
1917 GoTo(NCURSES_SP_ARGx top, 0);
1918 UpdateAttrs(SP_PARM, blank);
1919 TPUTS_TRACE("parm_insert_line");
1920 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1921 TIPARM_1(parm_insert_line, n),
1923 NCURSES_SP_NAME(_nc_outch));
1924 } else if (scroll_reverse && top == miny && bot == maxy) {
1925 GoTo(NCURSES_SP_ARGx top, 0);
1926 UpdateAttrs(SP_PARM, blank);
1927 for (i = 0; i < n; i++) {
1928 NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1930 } else if (insert_line && bot == maxy) {
1931 GoTo(NCURSES_SP_ARGx top, 0);
1932 UpdateAttrs(SP_PARM, blank);
1933 for (i = 0; i < n; i++) {
1934 NCURSES_PUTP2("insert_line", insert_line);
1939 #if NCURSES_EXT_FUNCS
1940 if (FILL_BCE(SP_PARM)) {
1942 for (i = 0; i < n; i++) {
1943 GoTo(NCURSES_SP_ARGx top + i, 0);
1944 for (j = 0; j < screen_columns(SP_PARM); j++)
1945 PutChar(NCURSES_SP_ARGx CHREF(blank));
1952 /* scroll by using delete_line at del and insert_line at ins */
1955 scroll_idl(NCURSES_SP_DCLx int n, int del, int ins, NCURSES_CH_T blank)
1959 if (!((parm_delete_line || delete_line) && (parm_insert_line || insert_line)))
1962 GoTo(NCURSES_SP_ARGx del, 0);
1963 UpdateAttrs(SP_PARM, blank);
1964 if (n == 1 && delete_line) {
1965 NCURSES_PUTP2("delete_line", delete_line);
1966 } else if (parm_delete_line) {
1967 TPUTS_TRACE("parm_delete_line");
1968 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1969 TIPARM_1(parm_delete_line, n),
1971 NCURSES_SP_NAME(_nc_outch));
1972 } else { /* if (delete_line) */
1973 for (i = 0; i < n; i++) {
1974 NCURSES_PUTP2("delete_line", delete_line);
1978 GoTo(NCURSES_SP_ARGx ins, 0);
1979 UpdateAttrs(SP_PARM, blank);
1980 if (n == 1 && insert_line) {
1981 NCURSES_PUTP2("insert_line", insert_line);
1982 } else if (parm_insert_line) {
1983 TPUTS_TRACE("parm_insert_line");
1984 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1985 TIPARM_1(parm_insert_line, n),
1987 NCURSES_SP_NAME(_nc_outch));
1988 } else { /* if (insert_line) */
1989 for (i = 0; i < n; i++) {
1990 NCURSES_PUTP2("insert_line", insert_line);
1998 * Note: some terminals require the cursor to be within the scrolling margins
1999 * before setting them. Generally, the cursor must be at the appropriate end
2000 * of the scrolling margins when issuing an indexing operation (it is not
2001 * apparent whether it must also be at the left margin; we do this just to be
2002 * safe). To make the related cursor movement a little faster, we use the
2003 * save/restore cursor capabilities if the terminal has them.
2006 NCURSES_SP_NAME(_nc_scrolln) (NCURSES_SP_DCLx
2011 /* scroll region from top to bot by n lines */
2015 bool cursor_saved = FALSE;
2018 TR(TRACE_MOVE, ("_nc_scrolln(%p, %d, %d, %d, %d)",
2019 (void *) SP_PARM, n, top, bot, maxy));
2021 if (!IsValidScreen(SP_PARM))
2024 blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
2028 * If we scroll, we might remove a cookie.
2030 if (magic_cookie_glitch > 0) {
2035 if (n > 0) { /* scroll up (forward) */
2037 * Explicitly clear if stuff pushed off top of region might
2038 * be saved by the terminal.
2040 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, 0, maxy, blank);
2042 if (res == ERR && change_scroll_region) {
2043 if ((((n == 1 && scroll_forward) || parm_index)
2044 && (SP_PARM->_cursrow == bot || SP_PARM->_cursrow == bot - 1))
2045 && save_cursor && restore_cursor) {
2046 cursor_saved = TRUE;
2047 NCURSES_PUTP2("save_cursor", save_cursor);
2049 NCURSES_PUTP2("change_scroll_region",
2050 TIPARM_2(change_scroll_region, top, bot));
2052 NCURSES_PUTP2("restore_cursor", restore_cursor);
2054 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2057 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, top, bot, blank);
2059 NCURSES_PUTP2("change_scroll_region",
2060 TIPARM_2(change_scroll_region, 0, maxy));
2061 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2064 if (res == ERR && SP_PARM->_nc_sp_idlok)
2065 res = scroll_idl(NCURSES_SP_ARGx n, top, bot - n + 1, blank);
2068 * Clear the newly shifted-in text.
2071 && (non_dest_scroll_region || (memory_below && bot == maxy))) {
2072 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2073 if (bot == maxy && clr_eos) {
2074 GoTo(NCURSES_SP_ARGx bot - n + 1, 0);
2075 ClrToEOS(NCURSES_SP_ARGx blank2);
2077 for (i = 0; i < n; i++) {
2078 GoTo(NCURSES_SP_ARGx bot - i, 0);
2079 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2084 } else { /* (n < 0) - scroll down (backward) */
2085 res = scroll_csr_backward(NCURSES_SP_ARGx -n, top, bot, 0, maxy, blank);
2087 if (res == ERR && change_scroll_region) {
2089 && (SP_PARM->_cursrow == top ||
2090 SP_PARM->_cursrow == top - 1)
2091 && save_cursor && restore_cursor) {
2092 cursor_saved = TRUE;
2093 NCURSES_PUTP2("save_cursor", save_cursor);
2095 NCURSES_PUTP2("change_scroll_region",
2096 TIPARM_2(change_scroll_region, top, bot));
2098 NCURSES_PUTP2("restore_cursor", restore_cursor);
2100 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2103 res = scroll_csr_backward(NCURSES_SP_ARGx
2104 -n, top, bot, top, bot, blank);
2106 NCURSES_PUTP2("change_scroll_region",
2107 TIPARM_2(change_scroll_region, 0, maxy));
2108 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2111 if (res == ERR && SP_PARM->_nc_sp_idlok)
2112 res = scroll_idl(NCURSES_SP_ARGx -n, bot + n + 1, top, blank);
2115 * Clear the newly shifted-in text.
2118 && (non_dest_scroll_region || (memory_above && top == 0))) {
2119 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2120 for (i = 0; i < -n; i++) {
2121 GoTo(NCURSES_SP_ARGx i + top, 0);
2122 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2130 _nc_scroll_window(CurScreen(SP_PARM), n,
2131 (NCURSES_SIZE_T) top,
2132 (NCURSES_SIZE_T) bot,
2135 /* shift hash values too - they can be reused */
2136 NCURSES_SP_NAME(_nc_scroll_oldhash) (NCURSES_SP_ARGx n, top, bot);
2141 #if NCURSES_SP_FUNCS
2143 _nc_scrolln(int n, int top, int bot, int maxy)
2145 return NCURSES_SP_NAME(_nc_scrolln) (CURRENT_SCREEN, n, top, bot, maxy);
2149 NCURSES_EXPORT(void)
2150 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_DCL0)
2154 /* make sure terminal is in a sane known state */
2155 SetAttr(SCREEN_ATTRS(SP_PARM), A_NORMAL);
2156 NewScreen(SP_PARM)->_clear = TRUE;
2158 /* reset color pairs and definitions */
2159 if (SP_PARM->_coloron || SP_PARM->_color_defs)
2160 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2162 /* restore user-defined colors, if any */
2163 if (SP_PARM->_color_defs < 0 && !SP_PARM->_direct_color.value) {
2165 SP_PARM->_color_defs = -(SP_PARM->_color_defs);
2166 for (n = 0; n < SP_PARM->_color_defs; ++n) {
2167 if (SP_PARM->_color_table[n].init) {
2168 _nc_init_color(SP_PARM,
2170 SP_PARM->_color_table[n].r,
2171 SP_PARM->_color_table[n].g,
2172 SP_PARM->_color_table[n].b);
2177 if (exit_attribute_mode)
2178 NCURSES_PUTP2("exit_attribute_mode", exit_attribute_mode);
2180 /* turn off attributes */
2181 if (exit_alt_charset_mode)
2182 NCURSES_PUTP2("exit_alt_charset_mode", exit_alt_charset_mode);
2183 if (exit_standout_mode)
2184 NCURSES_PUTP2("exit_standout_mode", exit_standout_mode);
2185 if (exit_underline_mode)
2186 NCURSES_PUTP2("exit_underline_mode", exit_underline_mode);
2188 if (exit_insert_mode)
2189 NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
2190 if (enter_am_mode && exit_am_mode) {
2191 if (auto_right_margin) {
2192 NCURSES_PUTP2("enter_am_mode", enter_am_mode);
2194 NCURSES_PUTP2("exit_am_mode", exit_am_mode);
2199 #if NCURSES_SP_FUNCS
2200 NCURSES_EXPORT(void)
2201 _nc_screen_resume(void)
2203 NCURSES_SP_NAME(_nc_screen_resume) (CURRENT_SCREEN);
2207 NCURSES_EXPORT(void)
2208 NCURSES_SP_NAME(_nc_screen_init) (NCURSES_SP_DCL0)
2210 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
2213 #if NCURSES_SP_FUNCS
2214 NCURSES_EXPORT(void)
2215 _nc_screen_init(void)
2217 NCURSES_SP_NAME(_nc_screen_init) (CURRENT_SCREEN);
2221 /* wrap up screen handling */
2222 NCURSES_EXPORT(void)
2223 NCURSES_SP_NAME(_nc_screen_wrap) (NCURSES_SP_DCL0)
2227 UpdateAttrs(SP_PARM, normal);
2228 #if NCURSES_EXT_FUNCS
2229 if (SP_PARM->_coloron
2230 && !SP_PARM->_default_color) {
2231 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
2232 SP_PARM->_default_color = TRUE;
2233 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
2237 NCURSES_SP_NAME(_nc_outch));
2238 SP_PARM->_default_color = FALSE;
2240 TINFO_MVCUR(NCURSES_SP_ARGx
2243 screen_lines(SP_PARM) - 1,
2246 ClrToEOL(NCURSES_SP_ARGx blank, TRUE);
2249 if (SP_PARM->_color_defs) {
2250 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2255 #if NCURSES_SP_FUNCS
2256 NCURSES_EXPORT(void)
2257 _nc_screen_wrap(void)
2259 NCURSES_SP_NAME(_nc_screen_wrap) (CURRENT_SCREEN);
2264 NCURSES_EXPORT(void)
2265 NCURSES_SP_NAME(_nc_do_xmc_glitch) (NCURSES_SP_DCLx attr_t previous)
2268 attr_t chg = XMC_CHANGES(previous ^ AttrOf(SCREEN_ATTRS(SP_PARM)));
2272 SP_PARM->_curscol += magic_cookie_glitch;
2273 if (SP_PARM->_curscol >= SP_PARM->_columns)
2274 wrap_cursor(NCURSES_SP_ARG);
2275 TR(TRACE_UPDATE, ("bumped to %d,%d after cookie",
2276 SP_PARM->_cursrow, SP_PARM->_curscol));
2283 #if NCURSES_SP_FUNCS
2284 NCURSES_EXPORT(void)
2285 _nc_do_xmc_glitch(attr_t previous)
2287 NCURSES_SP_NAME(_nc_do_xmc_glitch) (CURRENT_SCREEN, previous);
2291 #endif /* USE_XMC_SUPPORT */