1 /****************************************************************************
2 * Copyright (c) 1998-2013,2014 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 * and: Juergen Pfeifer 2009 *
34 ****************************************************************************/
36 /*-----------------------------------------------------------------
40 * The routine doupdate() and its dependents.
41 * All physical output is concentrated here (except _nc_outch()
44 *-----------------------------------------------------------------*/
46 #include <curses.priv.h>
49 #define CUR SP_TERMTYPE
52 #if defined __HAIKU__ && defined __BEOS__
62 #if defined(TRACE) && HAVE_SYS_TIMES_H && HAVE_TIMES
63 #define USE_TRACE_TIMES 1
65 #define USE_TRACE_TIMES 0
68 #if HAVE_SYS_TIME_H && HAVE_SYS_TIME_SELECT
73 #include <sys/times.h>
79 #include <sys/select.h>
85 MODULE_ID("$Id: tty_update.c,v 1.279 2014/07/12 23:16:30 tom Exp $")
88 * This define controls the line-breakout optimization. Every once in a
89 * while during screen refresh, we want to check for input and abort the
90 * update if there's some waiting. CHECK_INTERVAL controls the number of
91 * changed lines to be emitted between input checks.
93 * Note: Input-check-and-abort is no longer done if the screen is being
94 * updated from scratch. This is a feature, not a bug.
96 #define CHECK_INTERVAL 5
98 #define FILL_BCE(sp) (sp->_coloron && !sp->_default_color && !back_color_erase)
100 static const NCURSES_CH_T blankchar = NewChar(BLANK_TEXT);
101 static NCURSES_CH_T normal = NewChar(BLANK_TEXT);
104 * Enable checking to see if doupdate and friends are tracking the true
105 * cursor position correctly. NOTE: this is a debugging hack which will
106 * work ONLY on ANSI-compatible terminals!
108 /* #define POSITION_DEBUG */
110 static NCURSES_INLINE NCURSES_CH_T ClrBlank(NCURSES_SP_DCLx WINDOW *win);
113 static int ClrBottom(SCREEN *, int total);
114 static void ClearScreen(SCREEN *, NCURSES_CH_T blank);
115 static void ClrUpdate(SCREEN *);
116 static void DelChar(SCREEN *, int count);
117 static void InsStr(SCREEN *, NCURSES_CH_T * line, int count);
118 static void TransformLine(SCREEN *, int const lineno);
120 static int ClrBottom(int total);
121 static void ClearScreen(NCURSES_CH_T blank);
122 static void ClrUpdate(void);
123 static void DelChar(int count);
124 static void InsStr(NCURSES_CH_T * line, int count);
125 static void TransformLine(int const lineno);
128 #ifdef POSITION_DEBUG
129 /****************************************************************************
131 * Debugging code. Only works on ANSI-standard terminals.
133 ****************************************************************************/
136 position_check(NCURSES_SP_DCLx int expected_y, int expected_x, char *legend)
137 /* check to see if the real cursor position matches the virtual */
143 if (!_nc_tracing || (expected_y < 0 && expected_x < 0))
146 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
147 memset(buf, '\0', sizeof(buf));
148 NCURSES_PUTP2_FLUSH("cpr", "\033[6n"); /* only works on ANSI-compatibles */
151 int ask = sizeof(buf) - 1 - (s - buf);
152 int got = read(0, s, ask);
156 } while (strchr(buf, 'R') == 0);
157 _tracef("probe returned %s", _nc_visbuf(buf));
159 /* try to interpret as a position report */
160 if (sscanf(buf, "\033[%d;%dR", &y, &x) != 2) {
161 _tracef("position probe failed in %s", legend);
167 if (y - 1 != expected_y || x - 1 != expected_x) {
168 NCURSES_SP_NAME(beep) (NCURSES_SP_ARG);
169 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
173 1, NCURSES_SP_NAME(_nc_outch));
174 _tracef("position seen (%d, %d) doesn't match expected one (%d, %d) in %s",
175 y - 1, x - 1, expected_y, expected_x, legend);
177 _tracef("position matches OK in %s", legend);
182 #define position_check(expected_y, expected_x, legend) /* nothing */
183 #endif /* POSITION_DEBUG */
185 /****************************************************************************
187 * Optimized update code
189 ****************************************************************************/
191 static NCURSES_INLINE void
192 GoTo(NCURSES_SP_DCLx int const row, int const col)
194 TR(TRACE_MOVE, ("GoTo(%p, %d, %d) from (%d, %d)",
195 (void *) SP_PARM, row, col, SP_PARM->_cursrow, SP_PARM->_curscol));
197 position_check(NCURSES_SP_ARGx
199 SP_PARM->_curscol, "GoTo");
201 TINFO_MVCUR(NCURSES_SP_ARGx
205 position_check(NCURSES_SP_ARGx
207 SP_PARM->_curscol, "GoTo2");
210 static NCURSES_INLINE void
211 PutAttrChar(NCURSES_SP_DCLx CARG_CH_T ch)
215 #if USE_WIDEC_SUPPORT
219 NCURSES_CH_T attr = CHDEREF(ch);
221 TR(TRACE_CHARPUT, ("PutAttrChar(%s) at (%d, %d)",
223 SP_PARM->_cursrow, SP_PARM->_curscol));
224 #if USE_WIDEC_SUPPORT
226 * If this is not a valid character, there is nothing more to do.
228 if (isWidecExt(CHDEREF(ch))) {
229 TR(TRACE_CHARPUT, ("...skip"));
233 * Determine the number of character cells which the 'ch' value will use
234 * on the screen. It should be at least one.
236 if ((chlen = wcwidth(CharOf(CHDEREF(ch)))) <= 0) {
237 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
240 * If the character falls into any of these special cases, do
241 * not force the result to a blank:
243 * a) it is printable (this works around a bug in wcwidth()).
244 * b) use_legacy_coding() has been called to modify the treatment
246 * c) the acs_map[] has been initialized to allow codes 0-31
247 * to be rendered. This supports Linux console's "PC"
248 * characters. Codes 128-255 are allowed though this is
251 if (is8bits(CharOf(CHDEREF(ch)))
252 && (isprint(CharOf(CHDEREF(ch)))
253 || (SP_PARM->_legacy_coding > 0 && CharOf(CHDEREF(ch)) >= 160)
254 || (SP_PARM->_legacy_coding > 1 && CharOf(CHDEREF(ch)) >= 128)
255 || (AttrOf(attr) & A_ALTCHARSET
256 && ((CharOfD(ch) < ACS_LEN
257 && SP_PARM->_acs_map != 0
258 && SP_PARM->_acs_map[CharOfD(ch)] != 0)
259 || (CharOfD(ch) >= 128))))) {
263 TR(TRACE_CHARPUT, ("forced to blank"));
269 if ((AttrOf(attr) & A_ALTCHARSET)
270 && SP_PARM->_acs_map != 0
271 && CharOfD(ch) < ACS_LEN) {
272 my_ch = CHDEREF(ch); /* work around const param */
273 #if USE_WIDEC_SUPPORT
275 * This is crude & ugly, but works most of the time. It checks if the
276 * acs_chars string specified that we have a mapping for this
277 * character, and uses the wide-character mapping when we expect the
278 * normal one to be broken (by mis-design ;-).
280 if (SP_PARM->_screen_acs_fix
281 && SP_PARM->_screen_acs_map[CharOf(my_ch)]) {
282 RemAttr(attr, A_ALTCHARSET);
283 my_ch = _nc_wacs[CharOf(my_ch)];
284 } else if (SP_PARM->_screen_unicode
285 && !SP_PARM->_screen_acs_map[CharOf(my_ch)]
286 && _nc_wacs[CharOf(my_ch)].chars[0]) {
287 RemAttr(attr, A_ALTCHARSET);
288 my_ch = _nc_wacs[CharOf(my_ch)];
292 * If we (still) have alternate character set, it is the normal 8bit
293 * flavor. The _screen_acs_map[] array tells if the character was
294 * really in acs_chars, needed because of the way wide/normal line
295 * drawing flavors are integrated.
297 if (AttrOf(attr) & A_ALTCHARSET) {
299 chtype temp = UChar(SP_PARM->_acs_map[j]);
302 SetChar(my_ch, temp, AttrOf(attr));
305 RemAttr(attr, A_ALTCHARSET);
310 if (tilde_glitch && (CharOfD(ch) == L('~'))) {
311 SetChar(tilde, L('`'), AttrOf(attr));
315 UpdateAttrs(SP_PARM, attr);
317 #if !USE_WIDEC_SUPPORT
320 SP_PARM->_curscol += chlen;
322 NCURSES_PUTP2("char_padding", char_padding);
327 check_pending(NCURSES_SP_DCL0)
328 /* check for pending input */
330 bool have_pending = FALSE;
333 * Only carry out this check when the flag is zero, otherwise we'll
334 * have the refreshing slow down drastically (or stop) if there's an
335 * unread character available.
337 if (SP_PARM->_fifohold != 0)
340 if (SP_PARM->_checkfd >= 0) {
342 struct pollfd fds[1];
343 fds[0].fd = SP_PARM->_checkfd;
344 fds[0].events = POLLIN;
345 if (poll(fds, (size_t) 1, 0) > 0) {
348 #elif defined(__BEOS__)
350 * BeOS's select() is declared in socket.h, so the configure script does
351 * not see it. That's just as well, since that function works only for
352 * sockets. This (using snooze and ioctl) was distilled from Be's patch
353 * for ncurses which uses a separate thread to simulate select().
355 * FIXME: the return values from the ioctl aren't very clear if we get
359 int howmany = ioctl(0, 'ichr', &n);
360 if (howmany >= 0 && n > 0) {
365 struct timeval ktimeout;
368 ktimeout.tv_usec = 0;
371 FD_SET(SP_PARM->_checkfd, &fdset);
372 if (select(SP_PARM->_checkfd + 1, &fdset, NULL, NULL, &ktimeout) != 0) {
378 SP_PARM->_fifohold = 5;
379 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
384 /* put char at lower right corner */
386 PutCharLR(NCURSES_SP_DCLx const ARG_CH_T ch)
388 if (!auto_right_margin) {
389 /* we can put the char directly */
390 PutAttrChar(NCURSES_SP_ARGx ch);
391 } else if (enter_am_mode && exit_am_mode) {
392 /* we can suppress automargin */
393 NCURSES_PUTP2("exit_am_mode", exit_am_mode);
395 PutAttrChar(NCURSES_SP_ARGx ch);
397 position_check(NCURSES_SP_ARGx
402 NCURSES_PUTP2("enter_am_mode", enter_am_mode);
403 } else if ((enter_insert_mode && exit_insert_mode)
404 || insert_character || parm_ich) {
406 screen_lines(SP_PARM) - 1,
407 screen_columns(SP_PARM) - 2);
408 PutAttrChar(NCURSES_SP_ARGx ch);
410 screen_lines(SP_PARM) - 1,
411 screen_columns(SP_PARM) - 2);
412 InsStr(NCURSES_SP_ARGx
413 NewScreen(SP_PARM)->_line[screen_lines(SP_PARM) - 1].text +
414 screen_columns(SP_PARM) - 2, 1);
419 * Wrap the cursor position, i.e., advance to the beginning of the next line.
422 wrap_cursor(NCURSES_SP_DCL0)
424 if (eat_newline_glitch) {
426 * xenl can manifest two different ways. The vt100 way is that, when
427 * you'd expect the cursor to wrap, it stays hung at the right margin
428 * (on top of the character just emitted) and doesn't wrap until the
429 * *next* graphic char is emitted. The c100 way is to ignore LF
430 * received just after an am wrap.
432 * An aggressive way to handle this would be to emit CR/LF after the
433 * char and then assume the wrap is done, you're on the first position
434 * of the next line, and the terminal out of its weird state. Here
435 * it's safe to just tell the code that the cursor is in hyperspace and
436 * let the next mvcur() call straighten things out.
438 SP_PARM->_curscol = -1;
439 SP_PARM->_cursrow = -1;
440 } else if (auto_right_margin) {
441 SP_PARM->_curscol = 0;
444 * We've actually moved - but may have to work around problems with
445 * video attributes not working.
447 if (!move_standout_mode && AttrOf(SCREEN_ATTRS(SP_PARM))) {
448 TR(TRACE_CHARPUT, ("turning off (%#lx) %s before wrapping",
449 (unsigned long) AttrOf(SCREEN_ATTRS(SP_PARM)),
450 _traceattr(AttrOf(SCREEN_ATTRS(SP_PARM)))));
451 (void) VIDATTR(SP_PARM, A_NORMAL, 0);
456 position_check(NCURSES_SP_ARGx
462 static NCURSES_INLINE void
463 PutChar(NCURSES_SP_DCLx const ARG_CH_T ch)
464 /* insert character, handling automargin stuff */
466 if (SP_PARM->_cursrow == screen_lines(SP_PARM) - 1 &&
467 SP_PARM->_curscol == screen_columns(SP_PARM) - 1) {
468 PutCharLR(NCURSES_SP_ARGx ch);
470 PutAttrChar(NCURSES_SP_ARGx ch);
473 if (SP_PARM->_curscol >= screen_columns(SP_PARM))
474 wrap_cursor(NCURSES_SP_ARG);
476 position_check(NCURSES_SP_ARGx
478 SP_PARM->_curscol, "PutChar");
482 * Check whether the given character can be output by clearing commands. This
483 * includes test for being a space and not including any 'bad' attributes, such
484 * as A_REVERSE. All attribute flags which don't affect appearance of a space
485 * or can be output by clearing (A_COLOR in case of bce-terminal) are excluded.
487 static NCURSES_INLINE bool
488 can_clear_with(NCURSES_SP_DCLx ARG_CH_T ch)
490 if (!back_color_erase && SP_PARM->_coloron) {
491 #if NCURSES_EXT_FUNCS
494 if (!SP_PARM->_default_color)
496 if (SP_PARM->_default_fg != C_MASK || SP_PARM->_default_bg != C_MASK)
498 if ((pair = GetPair(CHDEREF(ch))) != 0) {
499 NCURSES_COLOR_T fg, bg;
500 if (NCURSES_SP_NAME(pair_content) (NCURSES_SP_ARGx
503 || (fg != C_MASK || bg != C_MASK)) {
508 if (AttrOfD(ch) & A_COLOR)
512 return (ISBLANK(CHDEREF(ch)) &&
513 (AttrOfD(ch) & ~(NONBLANK_ATTR | A_COLOR)) == BLANK_ATTR);
517 * Issue a given span of characters from an array.
518 * Must be functionally equivalent to:
519 * for (i = 0; i < num; i++)
521 * but can leave the cursor positioned at the middle of the interval.
523 * Returns: 0 - cursor is at the end of interval
524 * 1 - cursor is somewhere in the middle
526 * This code is optimized using ech and rep.
529 EmitRange(NCURSES_SP_DCLx const NCURSES_CH_T * ntext, int num)
533 TR(TRACE_CHARPUT, ("EmitRange %d:%s", num, _nc_viscbuf(ntext, num)));
535 if (erase_chars || repeat_char) {
540 while (num > 1 && !CharEq(ntext[0], ntext[1])) {
541 PutChar(NCURSES_SP_ARGx CHREF(ntext[0]));
547 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
552 while (runcount < num && CharEq(ntext[runcount], ntext0))
556 * The cost expression in the middle isn't exactly right.
557 * _cup_ch_cost is an upper bound on the cost for moving to the
558 * end of the erased area, but not the cost itself (which we
559 * can't compute without emitting the move). This may result
560 * in erase_chars not getting used in some situations for
561 * which it would be marginally advantageous.
564 && runcount > SP_PARM->_ech_cost + SP_PARM->_cup_ch_cost
565 && can_clear_with(NCURSES_SP_ARGx CHREF(ntext0))) {
566 UpdateAttrs(SP_PARM, ntext0);
567 NCURSES_PUTP2("erase_chars", TPARM_1(erase_chars, runcount));
570 * If this is the last part of the given interval,
571 * don't bother moving cursor, since it can be the
572 * last update on the line.
574 if (runcount < num) {
577 SP_PARM->_curscol + runcount);
579 return 1; /* cursor stays in the middle */
581 } else if (repeat_char && runcount > SP_PARM->_rep_cost) {
582 bool wrap_possible = (SP_PARM->_curscol + runcount >=
583 screen_columns(SP_PARM));
584 int rep_count = runcount;
589 UpdateAttrs(SP_PARM, ntext0);
590 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
595 NCURSES_SP_NAME(_nc_outch));
596 SP_PARM->_curscol += rep_count;
599 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
601 for (i = 0; i < runcount; i++)
602 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
610 for (i = 0; i < num; i++)
611 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
616 * Output the line in the given range [first .. last]
618 * If there's a run of identical characters that's long enough to justify
619 * cursor movement, use that also.
621 * Returns: same as EmitRange
624 PutRange(NCURSES_SP_DCLx
625 const NCURSES_CH_T * otext,
626 const NCURSES_CH_T * ntext,
632 TR(TRACE_CHARPUT, ("PutRange(%p, %p, %p, %d, %d, %d)",
634 (const void *) otext,
635 (const void *) ntext,
639 && (last - first + 1) > SP_PARM->_inline_cost) {
640 for (j = first, same = 0; j <= last; j++) {
641 if (!same && isWidecExt(otext[j]))
643 if (CharEq(otext[j], ntext[j])) {
646 if (same > SP_PARM->_inline_cost) {
647 EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
648 GoTo(NCURSES_SP_ARGx row, first = j);
653 i = EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
655 * Always return 1 for the next GoTo() after a PutRange() if we found
656 * identical characters at end of interval
658 return (same == 0 ? i : 1);
660 return EmitRange(NCURSES_SP_ARGx ntext + first, last - first + 1);
663 /* leave unbracketed here so 'indent' works */
664 #define MARK_NOCHANGE(win,row) \
665 win->_line[row].firstchar = _NOCHANGE; \
666 win->_line[row].lastchar = _NOCHANGE; \
667 if_USE_SCROLL_HINTS(win->_line[row].oldindex = row)
670 TINFO_DOUPDATE(NCURSES_SP_DCL0)
675 struct tms before, after;
676 #endif /* USE_TRACE_TIMES */
678 T((T_CALLED("_nc_tinfo:doupdate(%p)"), (void *) SP_PARM));
685 * It is "legal" but unlikely that an application could assign a new
686 * value to one of the standard windows. Check for that possibility
687 * and try to recover.
689 * We do not allow applications to assign new values in the reentrant
692 #define SyncScreens(internal,exported) \
693 if (internal == 0) internal = exported; \
694 if (internal != exported) exported = internal
696 SyncScreens(CurScreen(SP_PARM), curscr);
697 SyncScreens(NewScreen(SP_PARM), newscr);
698 SyncScreens(StdScreen(SP_PARM), stdscr);
701 if (CurScreen(SP_PARM) == 0
702 || NewScreen(SP_PARM) == 0
703 || StdScreen(SP_PARM) == 0)
707 if (USE_TRACEF(TRACE_UPDATE)) {
708 if (CurScreen(SP_PARM)->_clear)
709 _tracef("curscr is clear");
711 _tracedump("curscr", CurScreen(SP_PARM));
712 _tracedump("newscr", NewScreen(SP_PARM));
713 _nc_unlock_global(tracef);
717 _nc_signal_handler(FALSE);
719 if (SP_PARM->_fifohold)
720 SP_PARM->_fifohold--;
723 if (SP_PARM->_endwin || _nc_handle_sigwinch(SP_PARM)) {
725 * This is a transparent extension: XSI does not address it,
726 * and applications need not know that ncurses can do it.
728 * Check if the terminal size has changed while curses was off
729 * (this can happen in an xterm, for example), and resize the
730 * ncurses data structures accordingly.
732 _nc_update_screensize(SP_PARM);
736 if (SP_PARM->_endwin) {
738 T(("coming back from shell mode"));
739 NCURSES_SP_NAME(reset_prog_mode) (NCURSES_SP_ARG);
741 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
742 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
743 SP_PARM->_mouse_resume(SP_PARM);
745 SP_PARM->_endwin = FALSE;
748 /* zero the metering machinery */
750 (void) times(&before);
751 #endif /* USE_TRACE_TIMES */
754 * This is the support for magic-cookie terminals. The theory: we scan
755 * the virtual screen looking for attribute turnons. Where we find one,
756 * check to make sure it's realizable by seeing if the required number of
757 * un-attributed blanks are present before and after the attributed range;
758 * try to shift the range boundaries over blanks (not changing the screen
759 * display) so this becomes true. If it is, shift the beginning attribute
760 * change appropriately (the end one, if we've gotten this far, is
761 * guaranteed room for its cookie). If not, nuke the added attributes out
765 if (magic_cookie_glitch > 0) {
767 attr_t rattr = A_NORMAL;
769 for (i = 0; i < screen_lines(SP_PARM); i++) {
770 for (j = 0; j < screen_columns(SP_PARM); j++) {
772 NCURSES_CH_T *thisline = NewScreen(SP_PARM)->_line[i].text;
773 attr_t thisattr = AttrOf(thisline[j]) & SP_PARM->_xmc_triggers;
774 attr_t turnon = thisattr & ~rattr;
776 /* is an attribute turned on here? */
782 TR(TRACE_ATTRS, ("At (%d, %d): from %s...", i, j, _traceattr(rattr)));
783 TR(TRACE_ATTRS, ("...to %s", _traceattr(turnon)));
786 * If the attribute change location is a blank with a "safe"
787 * attribute, undo the attribute turnon. This may ensure
788 * there's enough room to set the attribute before the first
789 * non-blank in the run.
791 #define SAFE(scr,a) (!((a) & (scr)->_xmc_triggers))
792 if (ISBLANK(thisline[j]) && SAFE(SP_PARM, turnon)) {
793 RemAttr(thisline[j], turnon);
797 /* check that there's enough room at start of span */
798 for (k = 1; k <= magic_cookie_glitch; k++) {
800 || !ISBLANK(thisline[j - k])
801 || !SAFE(SP_PARM, AttrOf(thisline[j - k]))) {
803 TR(TRACE_ATTRS, ("No room at start in %d,%d%s%s",
805 (ISBLANK(thisline[j - k])
808 (SAFE(SP_PARM, AttrOf(thisline[j - k]))
815 bool end_onscreen = FALSE;
818 /* find end of span, if it's onscreen */
819 for (m = i; m < screen_lines(SP_PARM); m++) {
820 for (; n < screen_columns(SP_PARM); n++) {
822 AttrOf(NewScreen(SP_PARM)->_line[m].text[n]);
823 if ((testattr & SP_PARM->_xmc_triggers) == rattr) {
826 ("Range attributed with %s ends at (%d, %d)",
827 _traceattr(turnon), m, n));
834 ("Range attributed with %s ends offscreen",
835 _traceattr(turnon)));
839 NCURSES_CH_T *lastline =
840 NewScreen(SP_PARM)->_line[m].text;
843 * If there are safely-attributed blanks at the end of
844 * the range, shorten the range. This will help ensure
845 * that there is enough room at end of span.
848 && ISBLANK(lastline[n])
849 && SAFE(SP_PARM, AttrOf(lastline[n]))) {
850 RemAttr(lastline[n--], turnon);
853 /* check that there's enough room at end of span */
854 for (k = 1; k <= magic_cookie_glitch; k++) {
855 if (n + k >= screen_columns(SP_PARM)
856 || !ISBLANK(lastline[n + k])
857 || !SAFE(SP_PARM, AttrOf(lastline[n + k]))) {
860 ("No room at end in %d,%d%s%s",
862 (ISBLANK(lastline[n + k])
865 (SAFE(SP_PARM, AttrOf(lastline[n + k]))
878 ("Clearing %s beginning at (%d, %d)",
879 _traceattr(turnon), i, j));
881 /* turn off new attributes over span */
882 for (p = i; p < screen_lines(SP_PARM); p++) {
883 for (; q < screen_columns(SP_PARM); q++) {
884 attr_t testattr = AttrOf(newscr->_line[p].text[q]);
885 if ((testattr & SP_PARM->_xmc_triggers) == rattr)
887 RemAttr(NewScreen(SP_PARM)->_line[p].text[q], turnon);
894 ("Cookie space for %s found before (%d, %d)",
895 _traceattr(turnon), i, j));
898 * Back up the start of range so there's room for cookies
899 * before the first nonblank character.
901 for (k = 1; k <= magic_cookie_glitch; k++)
902 AddAttr(thisline[j - k], turnon);
910 /* show altered highlights after magic-cookie check */
911 if (USE_TRACEF(TRACE_UPDATE)) {
912 _tracef("After magic-cookie check...");
913 _tracedump("newscr", NewScreen(SP_PARM));
914 _nc_unlock_global(tracef);
918 #endif /* USE_XMC_SUPPORT */
921 if (CurScreen(SP_PARM)->_clear || NewScreen(SP_PARM)->_clear) { /* force refresh ? */
922 ClrUpdate(NCURSES_SP_ARG);
923 CurScreen(SP_PARM)->_clear = FALSE; /* reset flag */
924 NewScreen(SP_PARM)->_clear = FALSE; /* reset flag */
926 int changedlines = CHECK_INTERVAL;
928 if (check_pending(NCURSES_SP_ARG))
931 nonempty = min(screen_lines(SP_PARM), NewScreen(SP_PARM)->_maxy + 1);
933 if (SP_PARM->_scrolling) {
934 NCURSES_SP_NAME(_nc_scroll_optimize) (NCURSES_SP_ARG);
937 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
939 TR(TRACE_UPDATE, ("Transforming lines, nonempty %d", nonempty));
940 for (i = 0; i < nonempty; i++) {
942 * Here is our line-breakout optimization.
944 if (changedlines == CHECK_INTERVAL) {
945 if (check_pending(NCURSES_SP_ARG))
951 * newscr->line[i].firstchar is normally set
952 * by wnoutrefresh. curscr->line[i].firstchar
953 * is normally set by _nc_scroll_window in the
954 * vertical-movement optimization code,
956 if (NewScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE
957 || CurScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE) {
958 TransformLine(NCURSES_SP_ARGx i);
962 /* mark line changed successfully */
963 if (i <= NewScreen(SP_PARM)->_maxy) {
964 MARK_NOCHANGE(NewScreen(SP_PARM), i);
966 if (i <= CurScreen(SP_PARM)->_maxy) {
967 MARK_NOCHANGE(CurScreen(SP_PARM), i);
972 /* put everything back in sync */
973 for (i = nonempty; i <= NewScreen(SP_PARM)->_maxy; i++) {
974 MARK_NOCHANGE(NewScreen(SP_PARM), i);
976 for (i = nonempty; i <= CurScreen(SP_PARM)->_maxy; i++) {
977 MARK_NOCHANGE(CurScreen(SP_PARM), i);
980 if (!NewScreen(SP_PARM)->_leaveok) {
981 CurScreen(SP_PARM)->_curx = NewScreen(SP_PARM)->_curx;
982 CurScreen(SP_PARM)->_cury = NewScreen(SP_PARM)->_cury;
984 GoTo(NCURSES_SP_ARGx CurScreen(SP_PARM)->_cury, CurScreen(SP_PARM)->_curx);
989 * We would like to keep the physical screen in normal mode in case we get
990 * other processes writing to the screen. This goal cannot be met for
991 * magic cookies since it interferes with attributes that may propagate
992 * past the current position.
995 if (magic_cookie_glitch != 0)
997 UpdateAttrs(SP_PARM, normal);
999 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1000 WINDOW_ATTRS(CurScreen(SP_PARM)) = WINDOW_ATTRS(NewScreen(SP_PARM));
1003 (void) times(&after);
1005 ("Update cost: %ld chars, %ld clocks system time, %ld clocks user time",
1007 (long) (after.tms_stime - before.tms_stime),
1008 (long) (after.tms_utime - before.tms_utime)));
1009 #endif /* USE_TRACE_TIMES */
1011 _nc_signal_handler(TRUE);
1016 #if NCURSES_SP_FUNCS && !defined(USE_TERM_DRIVER)
1020 return TINFO_DOUPDATE(CURRENT_SCREEN);
1027 * Returns the attributed character that corresponds to the "cleared"
1028 * screen. If the terminal has the back-color-erase feature, this will be
1029 * colored according to the wbkgd() call.
1031 * We treat 'curscr' specially because it isn't supposed to be set directly
1032 * in the wbkgd() call. Assume 'stdscr' for this case.
1034 #define BCE_ATTRS (A_NORMAL|A_COLOR)
1035 #define BCE_BKGD(sp,win) (((win) == CurScreen(sp) ? StdScreen(sp) : (win))->_nc_bkgd)
1037 static NCURSES_INLINE NCURSES_CH_T
1038 ClrBlank(NCURSES_SP_DCLx WINDOW *win)
1040 NCURSES_CH_T blank = blankchar;
1041 if (back_color_erase)
1042 AddAttr(blank, (AttrOf(BCE_BKGD(SP_PARM, win)) & BCE_ATTRS));
1049 ** Update by clearing and redrawing the entire screen.
1054 ClrUpdate(NCURSES_SP_DCL0)
1056 TR(TRACE_UPDATE, (T_CALLED("ClrUpdate")));
1059 NCURSES_CH_T blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1060 int nonempty = min(screen_lines(SP_PARM),
1061 NewScreen(SP_PARM)->_maxy + 1);
1063 ClearScreen(NCURSES_SP_ARGx blank);
1065 TR(TRACE_UPDATE, ("updating screen from scratch"));
1067 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1069 for (i = 0; i < nonempty; i++)
1070 TransformLine(NCURSES_SP_ARGx i);
1072 TR(TRACE_UPDATE, (T_RETURN("")));
1078 ** Clear to end of current line, starting at the cursor position
1082 ClrToEOL(NCURSES_SP_DCLx NCURSES_CH_T blank, int needclear)
1086 if (CurScreen(SP_PARM) != 0
1087 && SP_PARM->_cursrow >= 0) {
1088 for (j = SP_PARM->_curscol; j < screen_columns(SP_PARM); j++) {
1091 &(CurScreen(SP_PARM)->_line[SP_PARM->_cursrow].text[j]);
1093 if (!CharEq(*cp, blank)) {
1102 UpdateAttrs(SP_PARM, blank);
1103 if (clr_eol && SP_PARM->_el_cost <= (screen_columns(SP_PARM) - SP_PARM->_curscol)) {
1104 NCURSES_PUTP2("clr_eol", clr_eol);
1106 int count = (screen_columns(SP_PARM) - SP_PARM->_curscol);
1108 PutChar(NCURSES_SP_ARGx CHREF(blank));
1116 ** Clear to end of screen, starting at the cursor position
1120 ClrToEOS(NCURSES_SP_DCLx NCURSES_CH_T blank)
1124 row = SP_PARM->_cursrow;
1125 col = SP_PARM->_curscol;
1132 UpdateAttrs(SP_PARM, blank);
1133 TPUTS_TRACE("clr_eos");
1134 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1136 screen_lines(SP_PARM) - row,
1137 NCURSES_SP_NAME(_nc_outch));
1139 while (col < screen_columns(SP_PARM))
1140 CurScreen(SP_PARM)->_line[row].text[col++] = blank;
1142 for (row++; row < screen_lines(SP_PARM); row++) {
1143 for (col = 0; col < screen_columns(SP_PARM); col++)
1144 CurScreen(SP_PARM)->_line[row].text[col] = blank;
1151 * Test if clearing the end of the screen would satisfy part of the
1152 * screen-update. Do this by scanning backwards through the lines in the
1153 * screen, checking if each is blank, and one or more are changed.
1156 ClrBottom(NCURSES_SP_DCLx int total)
1161 int last = min(screen_columns(SP_PARM), NewScreen(SP_PARM)->_maxx + 1);
1162 NCURSES_CH_T blank = NewScreen(SP_PARM)->_line[total - 1].text[last - 1];
1165 if (clr_eos && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1167 for (row = total - 1; row >= 0; row--) {
1168 for (col = 0, ok = TRUE; ok && col < last; col++) {
1169 ok = (CharEq(NewScreen(SP_PARM)->_line[row].text[col], blank));
1174 for (col = 0; ok && col < last; col++) {
1175 ok = (CharEq(CurScreen(SP_PARM)->_line[row].text[col], blank));
1181 /* don't use clr_eos for just one line if clr_eol available */
1183 GoTo(NCURSES_SP_ARGx top, 0);
1184 ClrToEOS(NCURSES_SP_ARGx blank);
1185 if (SP_PARM->oldhash && SP_PARM->newhash) {
1186 for (row = top; row < screen_lines(SP_PARM); row++)
1187 SP_PARM->oldhash[row] = SP_PARM->newhash[row];
1195 #if USE_WIDEC_SUPPORT
1196 #define check_xmc_transition(sp, a, b) \
1197 ((((a)->attr ^ (b)->attr) & ~((a)->attr) & (sp)->_xmc_triggers) != 0)
1198 #define xmc_turn_on(sp,a,b) check_xmc_transition(sp,&(a), &(b))
1200 #define xmc_turn_on(sp,a,b) ((((a)^(b)) & ~(a) & (sp)->_xmc_triggers) != 0)
1203 #define xmc_new(sp,r,c) NewScreen(sp)->_line[r].text[c]
1204 #define xmc_turn_off(sp,a,b) xmc_turn_on(sp,b,a)
1205 #endif /* USE_XMC_SUPPORT */
1208 ** TransformLine(lineno)
1210 ** Transform the given line in curscr to the one in newscr, using
1211 ** Insert/Delete Character if idcok && has_ic().
1213 ** firstChar = position of first different character in line
1214 ** oLastChar = position of last different character in old line
1215 ** nLastChar = position of last different character in new line
1217 ** move to firstChar
1218 ** overwrite chars up to min(oLastChar, nLastChar)
1219 ** if oLastChar < nLastChar
1220 ** insert newLine[oLastChar+1..nLastChar]
1222 ** delete oLastChar - nLastChar spaces
1226 TransformLine(NCURSES_SP_DCLx int const lineno)
1228 int firstChar, oLastChar, nLastChar;
1229 NCURSES_CH_T *newLine = NewScreen(SP_PARM)->_line[lineno].text;
1230 NCURSES_CH_T *oldLine = CurScreen(SP_PARM)->_line[lineno].text;
1232 bool attrchanged = FALSE;
1234 TR(TRACE_UPDATE, (T_CALLED("TransformLine(%p, %d)"), (void *) SP_PARM, lineno));
1236 /* copy new hash value to old one */
1237 if (SP_PARM->oldhash && SP_PARM->newhash)
1238 SP_PARM->oldhash[lineno] = SP_PARM->newhash[lineno];
1241 * If we have colors, there is the possibility of having two color pairs
1242 * that display as the same colors. For instance, Lynx does this. Check
1243 * for this case, and update the old line with the new line's colors when
1244 * they are equivalent.
1246 if (SP_PARM->_coloron) {
1250 for (n = 0; n < screen_columns(SP_PARM); n++) {
1251 if (!CharEq(newLine[n], oldLine[n])) {
1252 oldPair = GetPair(oldLine[n]);
1253 newPair = GetPair(newLine[n]);
1254 if (oldPair != newPair
1255 && unColor(oldLine[n]) == unColor(newLine[n])) {
1256 if (oldPair < SP_PARM->_pair_limit
1257 && newPair < SP_PARM->_pair_limit
1258 && (SP_PARM->_color_pairs[oldPair] ==
1259 SP_PARM->_color_pairs[newPair])) {
1260 SetPair(oldLine[n], GetPair(newLine[n]));
1267 if (ceol_standout_glitch && clr_eol) {
1269 while (firstChar < screen_columns(SP_PARM)) {
1270 if (!SameAttrOf(newLine[firstChar], oldLine[firstChar])) {
1280 if (attrchanged) { /* we may have to disregard the whole line */
1281 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1282 ClrToEOL(NCURSES_SP_ARGx
1283 ClrBlank(NCURSES_SP_ARGx
1284 CurScreen(SP_PARM)), FALSE);
1285 PutRange(NCURSES_SP_ARGx
1286 oldLine, newLine, lineno, 0,
1287 screen_columns(SP_PARM) - 1);
1291 * This is a very simple loop to paint characters which may have the
1292 * magic cookie glitch embedded. It doesn't know much about video
1293 * attributes which are continued from one line to the next. It
1294 * assumes that we have filtered out requests for attribute changes
1295 * that do not get mapped to blank positions.
1297 * FIXME: we are not keeping track of where we put the cookies, so this
1298 * will work properly only once, since we may overwrite a cookie in a
1299 * following operation.
1301 } else if (magic_cookie_glitch > 0) {
1302 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1303 for (n = 0; n < screen_columns(SP_PARM); n++) {
1304 int m = n + magic_cookie_glitch;
1306 /* check for turn-on:
1307 * If we are writing an attributed blank, where the
1308 * previous cell is not attributed.
1310 if (ISBLANK(newLine[n])
1312 && xmc_turn_on(SP_PARM, newLine[n - 1], newLine[n]))
1315 && xmc_turn_on(SP_PARM,
1316 xmc_new(SP_PARM, lineno - 1,
1317 screen_columns(SP_PARM) - 1),
1322 PutChar(NCURSES_SP_ARGx CHREF(newLine[n]));
1324 /* check for turn-off:
1325 * If we are writing an attributed non-blank, where the
1326 * next cell is blank, and not attributed.
1328 if (!ISBLANK(newLine[n])
1329 && ((n + 1 < screen_columns(SP_PARM)
1330 && xmc_turn_off(SP_PARM, newLine[n], newLine[n + 1]))
1331 || (n + 1 >= screen_columns(SP_PARM)
1332 && lineno + 1 < screen_lines(SP_PARM)
1333 && xmc_turn_off(SP_PARM,
1335 xmc_new(SP_PARM, lineno + 1, 0))))) {
1344 /* it may be cheap to clear leading whitespace with clr_bol */
1346 if (clr_bol && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1347 int oFirstChar, nFirstChar;
1349 for (oFirstChar = 0;
1350 oFirstChar < screen_columns(SP_PARM);
1352 if (!CharEq(oldLine[oFirstChar], blank))
1354 for (nFirstChar = 0;
1355 nFirstChar < screen_columns(SP_PARM);
1357 if (!CharEq(newLine[nFirstChar], blank))
1360 if (nFirstChar == oFirstChar) {
1361 firstChar = nFirstChar;
1362 /* find the first differing character */
1363 while (firstChar < screen_columns(SP_PARM)
1364 && CharEq(newLine[firstChar], oldLine[firstChar]))
1366 } else if (oFirstChar > nFirstChar) {
1367 firstChar = nFirstChar;
1368 } else { /* oFirstChar < nFirstChar */
1369 firstChar = oFirstChar;
1370 if (SP_PARM->_el1_cost < nFirstChar - oFirstChar) {
1371 if (nFirstChar >= screen_columns(SP_PARM)
1372 && SP_PARM->_el_cost <= SP_PARM->_el1_cost) {
1373 GoTo(NCURSES_SP_ARGx lineno, 0);
1374 UpdateAttrs(SP_PARM, blank);
1375 NCURSES_PUTP2("clr_eol", clr_eol);
1377 GoTo(NCURSES_SP_ARGx lineno, nFirstChar - 1);
1378 UpdateAttrs(SP_PARM, blank);
1379 NCURSES_PUTP2("clr_bol", clr_bol);
1382 while (firstChar < nFirstChar)
1383 oldLine[firstChar++] = blank;
1387 /* find the first differing character */
1388 while (firstChar < screen_columns(SP_PARM)
1389 && CharEq(newLine[firstChar], oldLine[firstChar]))
1392 /* if there wasn't one, we're done */
1393 if (firstChar >= screen_columns(SP_PARM)) {
1394 TR(TRACE_UPDATE, (T_RETURN("")));
1398 blank = newLine[screen_columns(SP_PARM) - 1];
1400 if (!can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1401 /* find the last differing character */
1402 nLastChar = screen_columns(SP_PARM) - 1;
1404 while (nLastChar > firstChar
1405 && CharEq(newLine[nLastChar], oldLine[nLastChar]))
1408 if (nLastChar >= firstChar) {
1409 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1410 PutRange(NCURSES_SP_ARGx
1416 memcpy(oldLine + firstChar,
1417 newLine + firstChar,
1418 (unsigned) (nLastChar - firstChar + 1) * sizeof(NCURSES_CH_T));
1420 TR(TRACE_UPDATE, (T_RETURN("")));
1424 /* find last non-blank character on old line */
1425 oLastChar = screen_columns(SP_PARM) - 1;
1426 while (oLastChar > firstChar && CharEq(oldLine[oLastChar], blank))
1429 /* find last non-blank character on new line */
1430 nLastChar = screen_columns(SP_PARM) - 1;
1431 while (nLastChar > firstChar && CharEq(newLine[nLastChar], blank))
1434 if ((nLastChar == firstChar)
1435 && (SP_PARM->_el_cost < (oLastChar - nLastChar))) {
1436 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1437 if (!CharEq(newLine[firstChar], blank))
1438 PutChar(NCURSES_SP_ARGx CHREF(newLine[firstChar]));
1439 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1440 } else if ((nLastChar != oLastChar)
1441 && (!CharEq(newLine[nLastChar], oldLine[oLastChar])
1442 || !(SP_PARM->_nc_sp_idcok
1443 && NCURSES_SP_NAME(has_ic) (NCURSES_SP_ARG)))) {
1444 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1445 if ((oLastChar - nLastChar) > SP_PARM->_el_cost) {
1446 if (PutRange(NCURSES_SP_ARGx
1452 GoTo(NCURSES_SP_ARGx lineno, nLastChar + 1);
1454 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1456 n = max(nLastChar, oLastChar);
1457 PutRange(NCURSES_SP_ARGx
1465 int nLastNonblank = nLastChar;
1466 int oLastNonblank = oLastChar;
1468 /* find the last characters that really differ */
1469 /* can be -1 if no characters differ */
1470 while (CharEq(newLine[nLastChar], oldLine[oLastChar])) {
1471 /* don't split a wide char */
1472 if (isWidecExt(newLine[nLastChar]) &&
1473 !CharEq(newLine[nLastChar - 1], oldLine[oLastChar - 1]))
1477 if (nLastChar == -1 || oLastChar == -1)
1481 n = min(oLastChar, nLastChar);
1482 if (n >= firstChar) {
1483 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1484 PutRange(NCURSES_SP_ARGx
1492 if (oLastChar < nLastChar) {
1493 int m = max(nLastNonblank, oLastNonblank);
1494 #if USE_WIDEC_SUPPORT
1495 while (isWidecExt(newLine[n + 1]) && n) {
1500 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1501 if ((nLastChar < nLastNonblank)
1502 || InsCharCost(SP_PARM, nLastChar - oLastChar) > (m - n)) {
1503 PutRange(NCURSES_SP_ARGx
1510 InsStr(NCURSES_SP_ARGx &newLine[n + 1], nLastChar - oLastChar);
1512 } else if (oLastChar > nLastChar) {
1513 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1514 if (DelCharCost(SP_PARM, oLastChar - nLastChar)
1515 > SP_PARM->_el_cost + nLastNonblank - (n + 1)) {
1516 if (PutRange(NCURSES_SP_ARGx oldLine, newLine, lineno,
1517 n + 1, nLastNonblank))
1518 GoTo(NCURSES_SP_ARGx lineno, nLastNonblank + 1);
1519 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1522 * The delete-char sequence will
1523 * effectively shift in blanks from the
1524 * right margin of the screen. Ensure
1525 * that they are the right color by
1526 * setting the video attributes from
1527 * the last character on the row.
1529 UpdateAttrs(SP_PARM, blank);
1530 DelChar(NCURSES_SP_ARGx oLastChar - nLastChar);
1536 /* update the code's internal representation */
1537 if (screen_columns(SP_PARM) > firstChar)
1538 memcpy(oldLine + firstChar,
1539 newLine + firstChar,
1540 (unsigned) (screen_columns(SP_PARM) - firstChar) * sizeof(NCURSES_CH_T));
1541 TR(TRACE_UPDATE, (T_RETURN("")));
1546 ** ClearScreen(blank)
1548 ** Clear the physical screen and put cursor at home
1553 ClearScreen(NCURSES_SP_DCLx NCURSES_CH_T blank)
1556 bool fast_clear = (clear_screen || clr_eos || clr_eol);
1558 TR(TRACE_UPDATE, ("ClearScreen() called"));
1560 #if NCURSES_EXT_FUNCS
1561 if (SP_PARM->_coloron
1562 && !SP_PARM->_default_color) {
1563 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
1564 (short) GET_SCREEN_PAIR(SP_PARM),
1567 NCURSES_SP_NAME(_nc_outch));
1568 if (!back_color_erase) {
1576 UpdateAttrs(SP_PARM, blank);
1577 NCURSES_PUTP2("clear_screen", clear_screen);
1578 SP_PARM->_cursrow = SP_PARM->_curscol = 0;
1579 position_check(NCURSES_SP_ARGx
1583 } else if (clr_eos) {
1584 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1585 GoTo(NCURSES_SP_ARGx 0, 0);
1586 UpdateAttrs(SP_PARM, blank);
1587 TPUTS_TRACE("clr_eos");
1588 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1590 screen_lines(SP_PARM),
1591 NCURSES_SP_NAME(_nc_outch));
1592 } else if (clr_eol) {
1593 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1594 UpdateAttrs(SP_PARM, blank);
1595 for (i = 0; i < screen_lines(SP_PARM); i++) {
1596 GoTo(NCURSES_SP_ARGx i, 0);
1597 NCURSES_PUTP2("clr_eol", clr_eol);
1599 GoTo(NCURSES_SP_ARGx 0, 0);
1602 UpdateAttrs(SP_PARM, blank);
1603 for (i = 0; i < screen_lines(SP_PARM); i++) {
1604 GoTo(NCURSES_SP_ARGx i, 0);
1605 for (j = 0; j < screen_columns(SP_PARM); j++)
1606 PutChar(NCURSES_SP_ARGx CHREF(blank));
1608 GoTo(NCURSES_SP_ARGx 0, 0);
1611 for (i = 0; i < screen_lines(SP_PARM); i++) {
1612 for (j = 0; j < screen_columns(SP_PARM); j++)
1613 CurScreen(SP_PARM)->_line[i].text[j] = blank;
1616 TR(TRACE_UPDATE, ("screen cleared"));
1620 ** InsStr(line, count)
1622 ** Insert the count characters pointed to by line.
1627 InsStr(NCURSES_SP_DCLx NCURSES_CH_T * line, int count)
1629 TR(TRACE_UPDATE, ("InsStr(%p, %p,%d) called",
1631 (void *) line, count));
1633 /* Prefer parm_ich as it has the smallest cost - no need to shift
1634 * the whole line on each character. */
1635 /* The order must match that of InsCharCost. */
1637 TPUTS_TRACE("parm_ich");
1638 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1639 TPARM_1(parm_ich, count),
1641 NCURSES_SP_NAME(_nc_outch));
1643 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1647 } else if (enter_insert_mode && exit_insert_mode) {
1648 NCURSES_PUTP2("enter_insert_mode", enter_insert_mode);
1650 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1651 if (insert_padding) {
1652 NCURSES_PUTP2("insert_padding", insert_padding);
1657 NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
1660 NCURSES_PUTP2("insert_character", insert_character);
1661 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1662 if (insert_padding) {
1663 NCURSES_PUTP2("insert_padding", insert_padding);
1669 position_check(NCURSES_SP_ARGx
1671 SP_PARM->_curscol, "InsStr");
1677 ** Delete count characters at current position
1682 DelChar(NCURSES_SP_DCLx int count)
1686 TR(TRACE_UPDATE, ("DelChar(%p, %d) called, position = (%ld,%ld)",
1687 (void *) SP_PARM, count,
1688 (long) NewScreen(SP_PARM)->_cury,
1689 (long) NewScreen(SP_PARM)->_curx));
1692 TPUTS_TRACE("parm_dch");
1693 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1694 TPARM_1(parm_dch, count),
1696 NCURSES_SP_NAME(_nc_outch));
1698 for (n = 0; n < count; n++) {
1699 NCURSES_PUTP2("delete_character", delete_character);
1705 * Physical-scrolling support
1707 * This code was adapted from Keith Bostic's hardware scrolling
1708 * support for 4.4BSD curses. I (esr) translated it to use terminfo
1709 * capabilities, narrowed the call interface slightly, and cleaned
1710 * up some convoluted tests. I also added support for the memory_above
1711 * memory_below, and non_dest_scroll_region capabilities.
1713 * For this code to work, we must have either
1714 * change_scroll_region and scroll forward/reverse commands, or
1715 * insert and delete line capabilities.
1716 * When the scrolling region has been set, the cursor has to
1717 * be at the last line of the region to make the scroll up
1718 * happen, or on the first line of region to scroll down.
1720 * This code makes one aesthetic decision in the opposite way from
1721 * BSD curses. BSD curses preferred pairs of il/dl operations
1722 * over scrolls, allegedly because il/dl looked faster. We, on
1723 * the other hand, prefer scrolls because (a) they're just as fast
1724 * on many terminals and (b) using them avoids bouncing an
1725 * unchanged bottom section of the screen up and down, which is
1728 * (lav): added more cases, used dl/il when bot==maxy and in csr case.
1730 * I used assumption that capabilities il/il1/dl/dl1 work inside
1731 * changed scroll region not shifting screen contents outside of it.
1732 * If there are any terminals behaving different way, it would be
1733 * necessary to add some conditions to scroll_csr_forward/backward.
1736 /* Try to scroll up assuming given csr (miny, maxy). Returns ERR on failure */
1738 scroll_csr_forward(NCURSES_SP_DCLx
1748 if (n == 1 && scroll_forward && top == miny && bot == maxy) {
1749 GoTo(NCURSES_SP_ARGx bot, 0);
1750 UpdateAttrs(SP_PARM, blank);
1751 NCURSES_PUTP2("scroll_forward", scroll_forward);
1752 } else if (n == 1 && delete_line && bot == maxy) {
1753 GoTo(NCURSES_SP_ARGx top, 0);
1754 UpdateAttrs(SP_PARM, blank);
1755 NCURSES_PUTP2("delete_line", delete_line);
1756 } else if (parm_index && top == miny && bot == maxy) {
1757 GoTo(NCURSES_SP_ARGx bot, 0);
1758 UpdateAttrs(SP_PARM, blank);
1759 TPUTS_TRACE("parm_index");
1760 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1761 TPARM_2(parm_index, n, 0),
1763 NCURSES_SP_NAME(_nc_outch));
1764 } else if (parm_delete_line && bot == maxy) {
1765 GoTo(NCURSES_SP_ARGx top, 0);
1766 UpdateAttrs(SP_PARM, blank);
1767 TPUTS_TRACE("parm_delete_line");
1768 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1769 TPARM_2(parm_delete_line, n, 0),
1771 NCURSES_SP_NAME(_nc_outch));
1772 } else if (scroll_forward && top == miny && bot == maxy) {
1773 GoTo(NCURSES_SP_ARGx bot, 0);
1774 UpdateAttrs(SP_PARM, blank);
1775 for (i = 0; i < n; i++) {
1776 NCURSES_PUTP2("scroll_forward", scroll_forward);
1778 } else if (delete_line && bot == maxy) {
1779 GoTo(NCURSES_SP_ARGx top, 0);
1780 UpdateAttrs(SP_PARM, blank);
1781 for (i = 0; i < n; i++) {
1782 NCURSES_PUTP2("delete_line", delete_line);
1787 #if NCURSES_EXT_FUNCS
1788 if (FILL_BCE(SP_PARM)) {
1790 for (i = 0; i < n; i++) {
1791 GoTo(NCURSES_SP_ARGx bot - i, 0);
1792 for (j = 0; j < screen_columns(SP_PARM); j++)
1793 PutChar(NCURSES_SP_ARGx CHREF(blank));
1800 /* Try to scroll down assuming given csr (miny, maxy). Returns ERR on failure */
1803 scroll_csr_backward(NCURSES_SP_DCLx
1813 if (n == 1 && scroll_reverse && top == miny && bot == maxy) {
1814 GoTo(NCURSES_SP_ARGx top, 0);
1815 UpdateAttrs(SP_PARM, blank);
1816 NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1817 } else if (n == 1 && insert_line && bot == maxy) {
1818 GoTo(NCURSES_SP_ARGx top, 0);
1819 UpdateAttrs(SP_PARM, blank);
1820 NCURSES_PUTP2("insert_line", insert_line);
1821 } else if (parm_rindex && top == miny && bot == maxy) {
1822 GoTo(NCURSES_SP_ARGx top, 0);
1823 UpdateAttrs(SP_PARM, blank);
1824 TPUTS_TRACE("parm_rindex");
1825 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1826 TPARM_2(parm_rindex, n, 0),
1828 NCURSES_SP_NAME(_nc_outch));
1829 } else if (parm_insert_line && bot == maxy) {
1830 GoTo(NCURSES_SP_ARGx top, 0);
1831 UpdateAttrs(SP_PARM, blank);
1832 TPUTS_TRACE("parm_insert_line");
1833 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1834 TPARM_2(parm_insert_line, n, 0),
1836 NCURSES_SP_NAME(_nc_outch));
1837 } else if (scroll_reverse && top == miny && bot == maxy) {
1838 GoTo(NCURSES_SP_ARGx top, 0);
1839 UpdateAttrs(SP_PARM, blank);
1840 for (i = 0; i < n; i++) {
1841 NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1843 } else if (insert_line && bot == maxy) {
1844 GoTo(NCURSES_SP_ARGx top, 0);
1845 UpdateAttrs(SP_PARM, blank);
1846 for (i = 0; i < n; i++) {
1847 NCURSES_PUTP2("insert_line", insert_line);
1852 #if NCURSES_EXT_FUNCS
1853 if (FILL_BCE(SP_PARM)) {
1855 for (i = 0; i < n; i++) {
1856 GoTo(NCURSES_SP_ARGx top + i, 0);
1857 for (j = 0; j < screen_columns(SP_PARM); j++)
1858 PutChar(NCURSES_SP_ARGx CHREF(blank));
1865 /* scroll by using delete_line at del and insert_line at ins */
1868 scroll_idl(NCURSES_SP_DCLx int n, int del, int ins, NCURSES_CH_T blank)
1872 if (!((parm_delete_line || delete_line) && (parm_insert_line || insert_line)))
1875 GoTo(NCURSES_SP_ARGx del, 0);
1876 UpdateAttrs(SP_PARM, blank);
1877 if (n == 1 && delete_line) {
1878 NCURSES_PUTP2("delete_line", delete_line);
1879 } else if (parm_delete_line) {
1880 TPUTS_TRACE("parm_delete_line");
1881 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1882 TPARM_2(parm_delete_line, n, 0),
1884 NCURSES_SP_NAME(_nc_outch));
1885 } else { /* if (delete_line) */
1886 for (i = 0; i < n; i++) {
1887 NCURSES_PUTP2("delete_line", delete_line);
1891 GoTo(NCURSES_SP_ARGx ins, 0);
1892 UpdateAttrs(SP_PARM, blank);
1893 if (n == 1 && insert_line) {
1894 NCURSES_PUTP2("insert_line", insert_line);
1895 } else if (parm_insert_line) {
1896 TPUTS_TRACE("parm_insert_line");
1897 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1898 TPARM_2(parm_insert_line, n, 0),
1900 NCURSES_SP_NAME(_nc_outch));
1901 } else { /* if (insert_line) */
1902 for (i = 0; i < n; i++) {
1903 NCURSES_PUTP2("insert_line", insert_line);
1911 * Note: some terminals require the cursor to be within the scrolling margins
1912 * before setting them. Generally, the cursor must be at the appropriate end
1913 * of the scrolling margins when issuing an indexing operation (it is not
1914 * apparent whether it must also be at the left margin; we do this just to be
1915 * safe). To make the related cursor movement a little faster, we use the
1916 * save/restore cursor capabilities if the terminal has them.
1919 NCURSES_SP_NAME(_nc_scrolln) (NCURSES_SP_DCLx
1924 /* scroll region from top to bot by n lines */
1928 bool cursor_saved = FALSE;
1931 TR(TRACE_MOVE, ("_nc_scrolln(%p, %d, %d, %d, %d)",
1932 (void *) SP_PARM, n, top, bot, maxy));
1934 if (!IsValidScreen(SP_PARM))
1937 blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1941 * If we scroll, we might remove a cookie.
1943 if (magic_cookie_glitch > 0) {
1948 if (n > 0) { /* scroll up (forward) */
1950 * Explicitly clear if stuff pushed off top of region might
1951 * be saved by the terminal.
1953 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, 0, maxy, blank);
1955 if (res == ERR && change_scroll_region) {
1956 if ((((n == 1 && scroll_forward) || parm_index)
1957 && (SP_PARM->_cursrow == bot || SP_PARM->_cursrow == bot - 1))
1958 && save_cursor && restore_cursor) {
1959 cursor_saved = TRUE;
1960 NCURSES_PUTP2("save_cursor", save_cursor);
1962 NCURSES_PUTP2("change_scroll_region",
1963 TPARM_2(change_scroll_region, top, bot));
1965 NCURSES_PUTP2("restore_cursor", restore_cursor);
1967 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1970 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, top, bot, blank);
1972 NCURSES_PUTP2("change_scroll_region",
1973 TPARM_2(change_scroll_region, 0, maxy));
1974 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1977 if (res == ERR && SP_PARM->_nc_sp_idlok)
1978 res = scroll_idl(NCURSES_SP_ARGx n, top, bot - n + 1, blank);
1981 * Clear the newly shifted-in text.
1984 && (non_dest_scroll_region || (memory_below && bot == maxy))) {
1985 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
1986 if (bot == maxy && clr_eos) {
1987 GoTo(NCURSES_SP_ARGx bot - n + 1, 0);
1988 ClrToEOS(NCURSES_SP_ARGx blank2);
1990 for (i = 0; i < n; i++) {
1991 GoTo(NCURSES_SP_ARGx bot - i, 0);
1992 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
1997 } else { /* (n < 0) - scroll down (backward) */
1998 res = scroll_csr_backward(NCURSES_SP_ARGx -n, top, bot, 0, maxy, blank);
2000 if (res == ERR && change_scroll_region) {
2002 && (SP_PARM->_cursrow == top ||
2003 SP_PARM->_cursrow == top - 1)
2004 && save_cursor && restore_cursor) {
2005 cursor_saved = TRUE;
2006 NCURSES_PUTP2("save_cursor", save_cursor);
2008 NCURSES_PUTP2("change_scroll_region",
2009 TPARM_2(change_scroll_region, top, bot));
2011 NCURSES_PUTP2("restore_cursor", restore_cursor);
2013 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2016 res = scroll_csr_backward(NCURSES_SP_ARGx
2017 -n, top, bot, top, bot, blank);
2019 NCURSES_PUTP2("change_scroll_region",
2020 TPARM_2(change_scroll_region, 0, maxy));
2021 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2024 if (res == ERR && SP_PARM->_nc_sp_idlok)
2025 res = scroll_idl(NCURSES_SP_ARGx -n, bot + n + 1, top, blank);
2028 * Clear the newly shifted-in text.
2031 && (non_dest_scroll_region || (memory_above && top == 0))) {
2032 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2033 for (i = 0; i < -n; i++) {
2034 GoTo(NCURSES_SP_ARGx i + top, 0);
2035 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2043 _nc_scroll_window(CurScreen(SP_PARM), n,
2044 (NCURSES_SIZE_T) top,
2045 (NCURSES_SIZE_T) bot,
2048 /* shift hash values too - they can be reused */
2049 NCURSES_SP_NAME(_nc_scroll_oldhash) (NCURSES_SP_ARGx n, top, bot);
2054 #if NCURSES_SP_FUNCS
2056 _nc_scrolln(int n, int top, int bot, int maxy)
2058 return NCURSES_SP_NAME(_nc_scrolln) (CURRENT_SCREEN, n, top, bot, maxy);
2062 NCURSES_EXPORT(void)
2063 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_DCL0)
2067 /* make sure terminal is in a sane known state */
2068 SetAttr(SCREEN_ATTRS(SP_PARM), A_NORMAL);
2069 NewScreen(SP_PARM)->_clear = TRUE;
2071 /* reset color pairs and definitions */
2072 if (SP_PARM->_coloron || SP_PARM->_color_defs)
2073 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2075 /* restore user-defined colors, if any */
2076 if (SP_PARM->_color_defs < 0) {
2078 SP_PARM->_color_defs = -(SP_PARM->_color_defs);
2079 for (n = 0; n < SP_PARM->_color_defs; ++n) {
2080 if (SP_PARM->_color_table[n].init) {
2081 NCURSES_SP_NAME(init_color) (NCURSES_SP_ARGx
2083 SP_PARM->_color_table[n].r,
2084 SP_PARM->_color_table[n].g,
2085 SP_PARM->_color_table[n].b);
2090 if (exit_attribute_mode)
2091 NCURSES_PUTP2("exit_attribute_mode", exit_attribute_mode);
2093 /* turn off attributes */
2094 if (exit_alt_charset_mode)
2095 NCURSES_PUTP2("exit_alt_charset_mode", exit_alt_charset_mode);
2096 if (exit_standout_mode)
2097 NCURSES_PUTP2("exit_standout_mode", exit_standout_mode);
2098 if (exit_underline_mode)
2099 NCURSES_PUTP2("exit_underline_mode", exit_underline_mode);
2101 if (exit_insert_mode)
2102 NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
2103 if (enter_am_mode && exit_am_mode) {
2104 if (auto_right_margin) {
2105 NCURSES_PUTP2("enter_am_mode", enter_am_mode);
2107 NCURSES_PUTP2("exit_am_mode", exit_am_mode);
2112 #if NCURSES_SP_FUNCS
2113 NCURSES_EXPORT(void)
2114 _nc_screen_resume(void)
2116 NCURSES_SP_NAME(_nc_screen_resume) (CURRENT_SCREEN);
2120 NCURSES_EXPORT(void)
2121 NCURSES_SP_NAME(_nc_screen_init) (NCURSES_SP_DCL0)
2123 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
2126 #if NCURSES_SP_FUNCS
2127 NCURSES_EXPORT(void)
2128 _nc_screen_init(void)
2130 NCURSES_SP_NAME(_nc_screen_init) (CURRENT_SCREEN);
2134 /* wrap up screen handling */
2135 NCURSES_EXPORT(void)
2136 NCURSES_SP_NAME(_nc_screen_wrap) (NCURSES_SP_DCL0)
2140 UpdateAttrs(SP_PARM, normal);
2141 #if NCURSES_EXT_FUNCS
2142 if (SP_PARM->_coloron
2143 && !SP_PARM->_default_color) {
2144 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
2145 SP_PARM->_default_color = TRUE;
2146 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
2150 NCURSES_SP_NAME(_nc_outch));
2151 SP_PARM->_default_color = FALSE;
2153 TINFO_MVCUR(NCURSES_SP_ARGx
2156 screen_lines(SP_PARM) - 1,
2159 ClrToEOL(NCURSES_SP_ARGx blank, TRUE);
2162 if (SP_PARM->_color_defs) {
2163 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2168 #if NCURSES_SP_FUNCS
2169 NCURSES_EXPORT(void)
2170 _nc_screen_wrap(void)
2172 NCURSES_SP_NAME(_nc_screen_wrap) (CURRENT_SCREEN);
2177 NCURSES_EXPORT(void)
2178 NCURSES_SP_NAME(_nc_do_xmc_glitch) (NCURSES_SP_DCLx attr_t previous)
2181 attr_t chg = XMC_CHANGES(previous ^ AttrOf(SCREEN_ATTRS(SP_PARM)));
2185 SP_PARM->_curscol += magic_cookie_glitch;
2186 if (SP_PARM->_curscol >= SP_PARM->_columns)
2187 wrap_cursor(NCURSES_SP_ARG);
2188 TR(TRACE_UPDATE, ("bumped to %d,%d after cookie",
2189 SP_PARM->_cursrow, SP_PARM->_curscol));
2196 #if NCURSES_SP_FUNCS
2197 NCURSES_EXPORT(void)
2198 _nc_do_xmc_glitch(attr_t previous)
2200 NCURSES_SP_NAME(_nc_do_xmc_glitch) (CURRENT_SCREEN, previous);
2204 #endif /* USE_XMC_SUPPORT */