1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 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.257 2009/06/06 20:26:16 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_SP_NAME(putp) (NCURSES_SP_ARGx "\033[6n"); /* only works on ANSI-compatibles */
149 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
152 int ask = sizeof(buf) - 1 - (s - buf);
153 int got = read(0, s, ask);
157 } while (strchr(buf, 'R') == 0);
158 _tracef("probe returned %s", _nc_visbuf(buf));
160 /* try to interpret as a position report */
161 if (sscanf(buf, "\033[%d;%dR", &y, &x) != 2) {
162 _tracef("position probe failed in %s", legend);
168 if (y - 1 != expected_y || x - 1 != expected_x) {
169 NCURSES_SP_NAME(beep) (NCURSES_SP_ARG);
170 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
174 1, NCURSES_SP_NAME(_nc_outch));
175 _tracef("position seen (%d, %d) doesn't match expected one (%d, %d) in %s",
176 y - 1, x - 1, expected_y, expected_x, legend);
178 _tracef("position matches OK in %s", legend);
183 #define position_check(sp, expected_y, expected_x, legend) /* nothing */
184 #endif /* POSITION_DEBUG */
186 /****************************************************************************
188 * Optimized update code
190 ****************************************************************************/
192 static NCURSES_INLINE void
193 GoTo(NCURSES_SP_DCLx int const row, int const col)
195 TR(TRACE_MOVE, ("GoTo(%p, %d, %d) from (%d, %d)",
196 SP_PARM, row, col, SP_PARM->_cursrow, SP_PARM->_curscol));
198 position_check(SP_PARM, SP_PARM->_cursrow, SP_PARM->_curscol, "GoTo");
200 NCURSES_SP_NAME(mvcur) (NCURSES_SP_ARGx SP_PARM->_cursrow,
201 SP_PARM->_curscol, row, col);
202 position_check(SP_PARM, SP_PARM->_cursrow, SP_PARM->_curscol, "GoTo2");
205 static NCURSES_INLINE void
206 PutAttrChar(NCURSES_SP_DCLx CARG_CH_T ch)
212 NCURSES_CH_T attr = CHDEREF(ch);
214 TR(TRACE_CHARPUT, ("PutAttrChar(%s) at (%d, %d)",
216 SP_PARM->_cursrow, SP_PARM->_curscol));
217 #if USE_WIDEC_SUPPORT
219 * If this is not a valid character, there is nothing more to do.
221 if (isWidecExt(CHDEREF(ch))) {
222 TR(TRACE_CHARPUT, ("...skip"));
226 * Determine the number of character cells which the 'ch' value will use
227 * on the screen. It should be at least one.
229 if ((chlen = wcwidth(CharOf(CHDEREF(ch)))) <= 0) {
230 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
233 * If the character falls into any of these special cases, do
234 * not force the result to a blank:
236 * a) it is printable (this works around a bug in wcwidth()).
237 * b) use_legacy_coding() has been called to modify the treatment
239 * c) the acs_map[] has been initialized to allow codes 0-31
240 * to be rendered. This supports Linux console's "PC"
241 * characters. Codes 128-255 are allowed though this is
244 if (is8bits(CharOf(CHDEREF(ch)))
245 && (isprint(CharOf(CHDEREF(ch)))
246 || (SP_PARM->_legacy_coding > 0 && CharOf(CHDEREF(ch)) >= 160)
247 || (SP_PARM->_legacy_coding > 1 && CharOf(CHDEREF(ch)) >= 128)
248 || (AttrOf(attr) & A_ALTCHARSET
249 && ((CharOfD(ch) < ACS_LEN
250 && SP_PARM->_acs_map != 0
251 && SP_PARM->_acs_map[CharOfD(ch)] != 0)
252 || (CharOfD(ch) >= 128))))) {
256 TR(TRACE_CHARPUT, ("forced to blank"));
262 if ((AttrOf(attr) & A_ALTCHARSET)
263 && SP_PARM->_acs_map != 0
264 && CharOfD(ch) < ACS_LEN) {
265 my_ch = CHDEREF(ch); /* work around const param */
266 #if USE_WIDEC_SUPPORT
268 * This is crude & ugly, but works most of the time. It checks if the
269 * acs_chars string specified that we have a mapping for this
270 * character, and uses the wide-character mapping when we expect the
271 * normal one to be broken (by mis-design ;-).
273 if (SP_PARM->_screen_acs_fix
274 && SP_PARM->_screen_acs_map[CharOf(my_ch)]) {
275 RemAttr(attr, A_ALTCHARSET);
276 my_ch = _nc_wacs[CharOf(my_ch)];
280 * If we (still) have alternate character set, it is the normal 8bit
281 * flavor. The _screen_acs_map[] array tells if the character was
282 * really in acs_chars, needed because of the way wide/normal line
283 * drawing flavors are integrated.
285 if (AttrOf(attr) & A_ALTCHARSET) {
287 chtype temp = UChar(SP_PARM->_acs_map[j]);
289 if (!(SP_PARM->_screen_acs_map[j])) {
290 RemAttr(attr, A_ALTCHARSET);
295 SetChar(my_ch, temp, AttrOf(attr));
299 if (tilde_glitch && (CharOfD(ch) == L('~'))) {
300 SetChar(tilde, L('`'), AttrOf(attr));
304 UpdateAttrs(SP_PARM, attr);
305 #if !USE_WIDEC_SUPPORT
306 /* FIXME - we do this special case for signal handling, should see how to
307 * make it work for wide characters.
309 if (SP_PARM->_outch != 0) {
310 SP_PARM->_outch(NCURSES_SP_ARGx UChar(ch));
314 PUTC(CHDEREF(ch), SP_PARM->_ofp); /* macro's fastest... */
317 SP_PARM->_curscol += chlen;
319 TPUTS_TRACE("char_padding");
320 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx char_padding);
325 check_pending(NCURSES_SP_DCL0)
326 /* check for pending input */
328 bool have_pending = FALSE;
331 * Only carry out this check when the flag is zero, otherwise we'll
332 * have the refreshing slow down drastically (or stop) if there's an
333 * unread character available.
335 if (SP_PARM->_fifohold != 0)
338 if (SP_PARM->_checkfd >= 0) {
340 struct pollfd fds[1];
341 fds[0].fd = SP_PARM->_checkfd;
342 fds[0].events = POLLIN;
343 if (poll(fds, 1, 0) > 0) {
346 #elif defined(__BEOS__)
348 * BeOS's select() is declared in socket.h, so the configure script does
349 * not see it. That's just as well, since that function works only for
350 * sockets. This (using snooze and ioctl) was distilled from Be's patch
351 * for ncurses which uses a separate thread to simulate select().
353 * FIXME: the return values from the ioctl aren't very clear if we get
357 int howmany = ioctl(0, 'ichr', &n);
358 if (howmany >= 0 && n > 0) {
363 struct timeval ktimeout;
366 ktimeout.tv_usec = 0;
369 FD_SET(SP_PARM->_checkfd, &fdset);
370 if (select(SP_PARM->_checkfd + 1, &fdset, NULL, NULL, &ktimeout) != 0) {
376 SP_PARM->_fifohold = 5;
377 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
382 /* put char at lower right corner */
384 PutCharLR(NCURSES_SP_DCLx const ARG_CH_T ch)
386 if (!auto_right_margin) {
387 /* we can put the char directly */
388 PutAttrChar(NCURSES_SP_ARGx ch);
389 } else if (enter_am_mode && exit_am_mode) {
390 /* we can suppress automargin */
391 TPUTS_TRACE("exit_am_mode");
392 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_am_mode);
394 PutAttrChar(NCURSES_SP_ARGx ch);
396 position_check(SP_PARM,
401 TPUTS_TRACE("enter_am_mode");
402 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx 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(SP_PARM,
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(SP_PARM, SP_PARM->_cursrow, SP_PARM->_curscol, "PutChar");
480 * Check whether the given character can be output by clearing commands. This
481 * includes test for being a space and not including any 'bad' attributes, such
482 * as A_REVERSE. All attribute flags which don't affect appearance of a space
483 * or can be output by clearing (A_COLOR in case of bce-terminal) are excluded.
485 static NCURSES_INLINE bool
486 can_clear_with(NCURSES_SP_DCLx ARG_CH_T ch)
488 if (!back_color_erase && SP_PARM->_coloron) {
489 #if NCURSES_EXT_FUNCS
492 if (!SP_PARM->_default_color)
494 if (SP_PARM->_default_fg != C_MASK || SP_PARM->_default_bg != C_MASK)
496 if ((pair = GetPair(CHDEREF(ch))) != 0) {
498 NCURSES_SP_NAME(pair_content) (NCURSES_SP_ARGx pair, &fg, &bg);
499 if (fg != C_MASK || bg != C_MASK)
503 if (AttrOfD(ch) & A_COLOR)
507 return (ISBLANK(CHDEREF(ch)) &&
508 (AttrOfD(ch) & ~(NONBLANK_ATTR | A_COLOR)) == BLANK_ATTR);
512 * Issue a given span of characters from an array.
513 * Must be functionally equivalent to:
514 * for (i = 0; i < num; i++)
516 * but can leave the cursor positioned at the middle of the interval.
518 * Returns: 0 - cursor is at the end of interval
519 * 1 - cursor is somewhere in the middle
521 * This code is optimized using ech and rep.
524 EmitRange(NCURSES_SP_DCLx const NCURSES_CH_T * ntext, int num)
528 TR(TRACE_CHARPUT, ("EmitRange %d:%s", num, _nc_viscbuf(ntext, num)));
530 if (erase_chars || repeat_char) {
535 while (num > 1 && !CharEq(ntext[0], ntext[1])) {
536 PutChar(NCURSES_SP_ARGx CHREF(ntext[0]));
542 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
547 while (runcount < num && CharEq(ntext[runcount], ntext0))
551 * The cost expression in the middle isn't exactly right.
552 * _cup_ch_cost is an upper bound on the cost for moving to the
553 * end of the erased area, but not the cost itself (which we
554 * can't compute without emitting the move). This may result
555 * in erase_chars not getting used in some situations for
556 * which it would be marginally advantageous.
559 && runcount > SP_PARM->_ech_cost + SP_PARM->_cup_ch_cost
560 && can_clear_with(NCURSES_SP_ARGx CHREF(ntext0))) {
561 UpdateAttrs(SP_PARM, ntext0);
562 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
563 TPARM_1(erase_chars, runcount));
566 * If this is the last part of the given interval,
567 * don't bother moving cursor, since it can be the
568 * last update on the line.
570 if (runcount < num) {
573 SP_PARM->_curscol + runcount);
575 return 1; /* cursor stays in the middle */
577 } else if (repeat_char && runcount > SP_PARM->_rep_cost) {
578 bool wrap_possible = (SP_PARM->_curscol + runcount >=
579 screen_columns(SP_PARM));
580 int rep_count = runcount;
585 UpdateAttrs(SP_PARM, ntext0);
586 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
591 NCURSES_SP_NAME(_nc_outch));
592 SP_PARM->_curscol += rep_count;
595 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
597 for (i = 0; i < runcount; i++)
598 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
606 for (i = 0; i < num; i++)
607 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
612 * Output the line in the given range [first .. last]
614 * If there's a run of identical characters that's long enough to justify
615 * cursor movement, use that also.
617 * Returns: same as EmitRange
620 PutRange(NCURSES_SP_DCLx
621 const NCURSES_CH_T * otext,
622 const NCURSES_CH_T * ntext,
628 TR(TRACE_CHARPUT, ("PutRange(%p, %p, %p, %d, %d, %d)",
629 SP_PARM, otext, ntext, row, first, last));
632 && (last - first + 1) > SP_PARM->_inline_cost) {
633 for (j = first, same = 0; j <= last; j++) {
634 if (!same && isWidecExt(otext[j]))
636 if (CharEq(otext[j], ntext[j])) {
639 if (same > SP_PARM->_inline_cost) {
640 EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
641 GoTo(NCURSES_SP_ARGx row, first = j);
646 i = EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
648 * Always return 1 for the next GoTo() after a PutRange() if we found
649 * identical characters at end of interval
651 return (same == 0 ? i : 1);
653 return EmitRange(NCURSES_SP_ARGx ntext + first, last - first + 1);
656 /* leave unbracketed here so 'indent' works */
657 #define MARK_NOCHANGE(win,row) \
658 win->_line[row].firstchar = _NOCHANGE; \
659 win->_line[row].lastchar = _NOCHANGE; \
660 if_USE_SCROLL_HINTS(win->_line[row].oldindex = row)
663 NCURSES_SP_NAME(doupdate) (NCURSES_SP_DCL0)
668 struct tms before, after;
669 #endif /* USE_TRACE_TIMES */
671 T((T_CALLED("_nc_tinfo:doupdate(%p)"), SP_PARM));
675 * It is "legal" but unlikely that an application could assign a new
676 * value to one of the standard windows. Check for that possibility
677 * and try to recover.
679 * We do not allow applications to assign new values in the reentrant
682 #define SyncScreens(internal,exported) \
683 if (internal == 0) internal = exported; \
684 if (internal != exported) exported = internal
686 SyncScreens(CurScreen(SP_PARM), curscr);
687 SyncScreens(NewScreen(SP_PARM), newscr);
688 SyncScreens(StdScreen(SP_PARM), stdscr);
691 if (CurScreen(SP_PARM) == 0
692 || NewScreen(SP_PARM) == 0
693 || StdScreen(SP_PARM) == 0)
697 if (USE_TRACEF(TRACE_UPDATE)) {
698 if (CurScreen(SP_PARM)->_clear)
699 _tracef("curscr is clear");
701 _tracedump("curscr", CurScreen(SP_PARM));
702 _tracedump("newscr", NewScreen(SP_PARM));
703 _nc_unlock_global(tracef);
707 _nc_signal_handler(FALSE);
709 if (SP_PARM->_fifohold)
710 SP_PARM->_fifohold--;
713 if (SP_PARM->_endwin || _nc_handle_sigwinch(SP_PARM)) {
715 * This is a transparent extension: XSI does not address it,
716 * and applications need not know that ncurses can do it.
718 * Check if the terminal size has changed while curses was off
719 * (this can happen in an xterm, for example), and resize the
720 * ncurses data structures accordingly.
722 _nc_update_screensize(SP_PARM);
726 if (SP_PARM->_endwin) {
728 T(("coming back from shell mode"));
729 NCURSES_SP_NAME(reset_prog_mode) (NCURSES_SP_ARG);
731 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
732 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
733 SP_PARM->_mouse_resume(SP_PARM);
735 SP_PARM->_endwin = FALSE;
738 /* zero the metering machinery */
740 (void) times(&before);
741 #endif /* USE_TRACE_TIMES */
744 * This is the support for magic-cookie terminals. The theory: we scan
745 * the virtual screen looking for attribute turnons. Where we find one,
746 * check to make sure it's realizable by seeing if the required number of
747 * un-attributed blanks are present before and after the attributed range;
748 * try to shift the range boundaries over blanks (not changing the screen
749 * display) so this becomes true. If it is, shift the beginning attribute
750 * change appropriately (the end one, if we've gotten this far, is
751 * guaranteed room for its cookie). If not, nuke the added attributes out
755 if (magic_cookie_glitch > 0) {
757 attr_t rattr = A_NORMAL;
759 for (i = 0; i < screen_lines(SP_PARM); i++) {
760 for (j = 0; j < screen_columns(SP_PARM); j++) {
762 NCURSES_CH_T *thisline = NewScreen(SP_PARM)->_line[i].text;
763 attr_t thisattr = AttrOf(thisline[j]) & SP_PARM->_xmc_triggers;
764 attr_t turnon = thisattr & ~rattr;
766 /* is an attribute turned on here? */
772 TR(TRACE_ATTRS, ("At (%d, %d): from %s...", i, j, _traceattr(rattr)));
773 TR(TRACE_ATTRS, ("...to %s", _traceattr(turnon)));
776 * If the attribute change location is a blank with a "safe"
777 * attribute, undo the attribute turnon. This may ensure
778 * there's enough room to set the attribute before the first
779 * non-blank in the run.
781 #define SAFE(scr,a) (!((a) & (scr)->_xmc_triggers))
782 if (ISBLANK(thisline[j]) && SAFE(SP_PARM, turnon)) {
783 RemAttr(thisline[j], turnon);
787 /* check that there's enough room at start of span */
788 for (k = 1; k <= magic_cookie_glitch; k++) {
790 || !ISBLANK(thisline[j - k])
791 || !SAFE(SP_PARM, AttrOf(thisline[j - k]))) {
793 TR(TRACE_ATTRS, ("No room at start in %d,%d%s%s",
795 (ISBLANK(thisline[j - k])
798 (SAFE(SP_PARM, AttrOf(thisline[j - k]))
805 bool end_onscreen = FALSE;
808 /* find end of span, if it's onscreen */
809 for (m = i; m < screen_lines(SP_PARM); m++) {
810 for (; n < screen_columns(SP_PARM); n++) {
812 AttrOf(NewScreen(SP_PARM)->_line[m].text[n]);
813 if ((testattr & SP_PARM->_xmc_triggers) == rattr) {
816 ("Range attributed with %s ends at (%d, %d)",
817 _traceattr(turnon), m, n));
824 ("Range attributed with %s ends offscreen",
825 _traceattr(turnon)));
829 NCURSES_CH_T *lastline =
830 NewScreen(SP_PARM)->_line[m].text;
833 * If there are safely-attributed blanks at the end of
834 * the range, shorten the range. This will help ensure
835 * that there is enough room at end of span.
838 && ISBLANK(lastline[n])
839 && SAFE(SP_PARM, AttrOf(lastline[n]))) {
840 RemAttr(lastline[n--], turnon);
843 /* check that there's enough room at end of span */
844 for (k = 1; k <= magic_cookie_glitch; k++) {
845 if (n + k >= screen_columns(SP_PARM)
846 || !ISBLANK(lastline[n + k])
847 || !SAFE(SP_PARM, AttrOf(lastline[n + k]))) {
850 ("No room at end in %d,%d%s%s",
852 (ISBLANK(lastline[n + k])
855 (SAFE(SP_PARM, AttrOf(lastline[n + k]))
868 ("Clearing %s beginning at (%d, %d)",
869 _traceattr(turnon), i, j));
871 /* turn off new attributes over span */
872 for (p = i; p < screen_lines(SP_PARM); p++) {
873 for (; q < screen_columns(SP_PARM); q++) {
874 attr_t testattr = AttrOf(newscr->_line[p].text[q]);
875 if ((testattr & SP_PARM->_xmc_triggers) == rattr)
877 RemAttr(NewScreen(SP_PARM)->_line[p].text[q], turnon);
884 ("Cookie space for %s found before (%d, %d)",
885 _traceattr(turnon), i, j));
888 * Back up the start of range so there's room for cookies
889 * before the first nonblank character.
891 for (k = 1; k <= magic_cookie_glitch; k++)
892 AddAttr(thisline[j - k], turnon);
900 /* show altered highlights after magic-cookie check */
901 if (USE_TRACEF(TRACE_UPDATE)) {
902 _tracef("After magic-cookie check...");
903 _tracedump("newscr", NewScreen(SP_PARM));
904 _nc_unlock_global(tracef);
908 #endif /* USE_XMC_SUPPORT */
911 if (CurScreen(SP_PARM)->_clear || NewScreen(SP_PARM)->_clear) { /* force refresh ? */
912 ClrUpdate(NCURSES_SP_ARG);
913 CurScreen(SP_PARM)->_clear = FALSE; /* reset flag */
914 NewScreen(SP_PARM)->_clear = FALSE; /* reset flag */
916 int changedlines = CHECK_INTERVAL;
918 if (check_pending(NCURSES_SP_ARG))
921 nonempty = min(screen_lines(SP_PARM), NewScreen(SP_PARM)->_maxy + 1);
923 if (SP_PARM->_scrolling) {
924 NCURSES_SP_NAME(_nc_scroll_optimize) (NCURSES_SP_ARG);
927 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
929 TR(TRACE_UPDATE, ("Transforming lines, nonempty %d", nonempty));
930 for (i = 0; i < nonempty; i++) {
932 * Here is our line-breakout optimization.
934 if (changedlines == CHECK_INTERVAL) {
935 if (check_pending(NCURSES_SP_ARG))
941 * newscr->line[i].firstchar is normally set
942 * by wnoutrefresh. curscr->line[i].firstchar
943 * is normally set by _nc_scroll_window in the
944 * vertical-movement optimization code,
946 if (NewScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE
947 || CurScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE) {
948 TransformLine(NCURSES_SP_ARGx i);
952 /* mark line changed successfully */
953 if (i <= NewScreen(SP_PARM)->_maxy) {
954 MARK_NOCHANGE(NewScreen(SP_PARM), i);
956 if (i <= CurScreen(SP_PARM)->_maxy) {
957 MARK_NOCHANGE(CurScreen(SP_PARM), i);
962 /* put everything back in sync */
963 for (i = nonempty; i <= NewScreen(SP_PARM)->_maxy; i++) {
964 MARK_NOCHANGE(NewScreen(SP_PARM), i);
966 for (i = nonempty; i <= CurScreen(SP_PARM)->_maxy; i++) {
967 MARK_NOCHANGE(CurScreen(SP_PARM), i);
970 if (!NewScreen(SP_PARM)->_leaveok) {
971 CurScreen(SP_PARM)->_curx = NewScreen(SP_PARM)->_curx;
972 CurScreen(SP_PARM)->_cury = NewScreen(SP_PARM)->_cury;
974 GoTo(NCURSES_SP_ARGx CurScreen(SP_PARM)->_cury, CurScreen(SP_PARM)->_curx);
979 * We would like to keep the physical screen in normal mode in case we get
980 * other processes writing to the screen. This goal cannot be met for
981 * magic cookies since it interferes with attributes that may propagate
982 * past the current position.
985 if (magic_cookie_glitch != 0)
987 UpdateAttrs(SP_PARM, normal);
989 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
990 WINDOW_ATTRS(CurScreen(SP_PARM)) = WINDOW_ATTRS(NewScreen(SP_PARM));
993 (void) times(&after);
995 ("Update cost: %ld chars, %ld clocks system time, %ld clocks user time",
997 (long) (after.tms_stime - before.tms_stime),
998 (long) (after.tms_utime - before.tms_utime)));
999 #endif /* USE_TRACE_TIMES */
1001 _nc_signal_handler(TRUE);
1006 #if NCURSES_SP_FUNCS
1010 return NCURSES_SP_NAME(doupdate) (CURRENT_SCREEN);
1017 * Returns the attributed character that corresponds to the "cleared"
1018 * screen. If the terminal has the back-color-erase feature, this will be
1019 * colored according to the wbkgd() call.
1021 * We treat 'curscr' specially because it isn't supposed to be set directly
1022 * in the wbkgd() call. Assume 'stdscr' for this case.
1024 #define BCE_ATTRS (A_NORMAL|A_COLOR)
1025 #define BCE_BKGD(sp,win) (((win) == CurScreen(sp) ? StdScreen(sp) : (win))->_nc_bkgd)
1027 static NCURSES_INLINE NCURSES_CH_T
1028 ClrBlank(NCURSES_SP_DCLx WINDOW *win)
1030 NCURSES_CH_T blank = blankchar;
1031 if (back_color_erase)
1032 AddAttr(blank, (AttrOf(BCE_BKGD(SP_PARM, win)) & BCE_ATTRS));
1039 ** Update by clearing and redrawing the entire screen.
1044 ClrUpdate(NCURSES_SP_DCL0)
1046 TR(TRACE_UPDATE, (T_CALLED("ClrUpdate")));
1049 NCURSES_CH_T blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1050 int nonempty = min(screen_lines(SP_PARM),
1051 NewScreen(SP_PARM)->_maxy + 1);
1053 ClearScreen(NCURSES_SP_ARGx blank);
1055 TR(TRACE_UPDATE, ("updating screen from scratch"));
1057 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1059 for (i = 0; i < nonempty; i++)
1060 TransformLine(NCURSES_SP_ARGx i);
1062 TR(TRACE_UPDATE, (T_RETURN("")));
1068 ** Clear to end of current line, starting at the cursor position
1072 ClrToEOL(NCURSES_SP_DCLx NCURSES_CH_T blank, bool needclear)
1076 if (SP_PARM != 0 && CurScreen(SP_PARM) != 0
1077 && SP_PARM->_cursrow >= 0) {
1078 for (j = SP_PARM->_curscol; j < screen_columns(SP_PARM); j++) {
1081 &(CurScreen(SP_PARM)->_line[SP_PARM->_cursrow].text[j]);
1083 if (!CharEq(*cp, blank)) {
1094 UpdateAttrs(SP_PARM, blank);
1095 TPUTS_TRACE("clr_eol");
1096 if (clr_eol && SP_PARM->_el_cost <= (screen_columns(SP_PARM) - SP_PARM->_curscol)) {
1097 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clr_eol);
1099 int count = (screen_columns(SP_PARM) - SP_PARM->_curscol);
1101 PutChar(NCURSES_SP_ARGx CHREF(blank));
1109 ** Clear to end of screen, starting at the cursor position
1113 ClrToEOS(NCURSES_SP_DCLx NCURSES_CH_T blank)
1120 row = SP_PARM->_cursrow;
1121 col = SP_PARM->_curscol;
1123 UpdateAttrs(SP_PARM, blank);
1124 TPUTS_TRACE("clr_eos");
1125 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1127 screen_lines(SP_PARM) - row,
1128 NCURSES_SP_NAME(_nc_outch));
1130 while (col < screen_columns(SP_PARM))
1131 CurScreen(SP_PARM)->_line[row].text[col++] = blank;
1133 for (row++; row < screen_lines(SP_PARM); row++) {
1134 for (col = 0; col < screen_columns(SP_PARM); col++)
1135 CurScreen(SP_PARM)->_line[row].text[col] = blank;
1142 * Test if clearing the end of the screen would satisfy part of the
1143 * screen-update. Do this by scanning backwards through the lines in the
1144 * screen, checking if each is blank, and one or more are changed.
1147 ClrBottom(NCURSES_SP_DCLx int total)
1152 int last = min(screen_columns(SP_PARM), NewScreen(SP_PARM)->_maxx + 1);
1153 NCURSES_CH_T blank = NewScreen(SP_PARM)->_line[total - 1].text[last - 1];
1156 if (clr_eos && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1158 for (row = total - 1; row >= 0; row--) {
1159 for (col = 0, ok = TRUE; ok && col < last; col++) {
1160 ok = (CharEq(NewScreen(SP_PARM)->_line[row].text[col], blank));
1165 for (col = 0; ok && col < last; col++) {
1166 ok = (CharEq(CurScreen(SP_PARM)->_line[row].text[col], blank));
1172 /* don't use clr_eos for just one line if clr_eol available */
1174 GoTo(NCURSES_SP_ARGx top, 0);
1175 ClrToEOS(NCURSES_SP_ARGx blank);
1176 if (SP_PARM->oldhash && SP_PARM->newhash) {
1177 for (row = top; row < screen_lines(SP_PARM); row++)
1178 SP_PARM->oldhash[row] = SP_PARM->newhash[row];
1186 #if USE_WIDEC_SUPPORT
1187 #define check_xmc_transition(sp, a, b) \
1188 ((((a)->attr ^ (b)->attr) & ~((a)->attr) & (sp)->_xmc_triggers) != 0)
1189 #define xmc_turn_on(sp,a,b) check_xmc_transition(sp,&(a), &(b))
1191 #define xmc_turn_on(sp,a,b) ((((a)^(b)) & ~(a) & (sp)->_xmc_triggers) != 0)
1194 #define xmc_new(sp,r,c) NewScreen(sp)->_line[r].text[c]
1195 #define xmc_turn_off(sp,a,b) xmc_turn_on(sp,b,a)
1196 #endif /* USE_XMC_SUPPORT */
1199 ** TransformLine(lineno)
1201 ** Transform the given line in curscr to the one in newscr, using
1202 ** Insert/Delete Character if _nc_idcok && has_ic().
1204 ** firstChar = position of first different character in line
1205 ** oLastChar = position of last different character in old line
1206 ** nLastChar = position of last different character in new line
1208 ** move to firstChar
1209 ** overwrite chars up to min(oLastChar, nLastChar)
1210 ** if oLastChar < nLastChar
1211 ** insert newLine[oLastChar+1..nLastChar]
1213 ** delete oLastChar - nLastChar spaces
1217 TransformLine(NCURSES_SP_DCLx int const lineno)
1219 int firstChar, oLastChar, nLastChar;
1220 NCURSES_CH_T *newLine = NewScreen(SP_PARM)->_line[lineno].text;
1221 NCURSES_CH_T *oldLine = CurScreen(SP_PARM)->_line[lineno].text;
1223 bool attrchanged = FALSE;
1225 TR(TRACE_UPDATE, (T_CALLED("TransformLine(%p, %d)"), SP_PARM, lineno));
1227 /* copy new hash value to old one */
1228 if (SP_PARM->oldhash && SP_PARM->newhash)
1229 SP_PARM->oldhash[lineno] = SP_PARM->newhash[lineno];
1232 * If we have colors, there is the possibility of having two color pairs
1233 * that display as the same colors. For instance, Lynx does this. Check
1234 * for this case, and update the old line with the new line's colors when
1235 * they are equivalent.
1237 if (SP_PARM->_coloron) {
1241 for (n = 0; n < screen_columns(SP_PARM); n++) {
1242 if (!CharEq(newLine[n], oldLine[n])) {
1243 oldPair = GetPair(oldLine[n]);
1244 newPair = GetPair(newLine[n]);
1245 if (oldPair != newPair
1246 && unColor(oldLine[n]) == unColor(newLine[n])) {
1247 if (oldPair < SP_PARM->_pair_limit
1248 && newPair < SP_PARM->_pair_limit
1249 && (SP_PARM->_color_pairs[oldPair] ==
1250 SP_PARM->_color_pairs[newPair])) {
1251 SetPair(oldLine[n], GetPair(newLine[n]));
1258 if (ceol_standout_glitch && clr_eol) {
1260 while (firstChar < screen_columns(SP_PARM)) {
1261 if (!SameAttrOf(newLine[firstChar], oldLine[firstChar])) {
1271 if (attrchanged) { /* we may have to disregard the whole line */
1272 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1273 ClrToEOL(NCURSES_SP_ARGx
1274 ClrBlank(NCURSES_SP_ARGx
1275 CurScreen(SP_PARM)), FALSE);
1276 PutRange(NCURSES_SP_ARGx
1277 oldLine, newLine, lineno, 0,
1278 screen_columns(SP_PARM) - 1);
1282 * This is a very simple loop to paint characters which may have the
1283 * magic cookie glitch embedded. It doesn't know much about video
1284 * attributes which are continued from one line to the next. It
1285 * assumes that we have filtered out requests for attribute changes
1286 * that do not get mapped to blank positions.
1288 * FIXME: we are not keeping track of where we put the cookies, so this
1289 * will work properly only once, since we may overwrite a cookie in a
1290 * following operation.
1292 } else if (magic_cookie_glitch > 0) {
1293 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1294 for (n = 0; n < screen_columns(SP_PARM); n++) {
1295 int m = n + magic_cookie_glitch;
1297 /* check for turn-on:
1298 * If we are writing an attributed blank, where the
1299 * previous cell is not attributed.
1301 if (ISBLANK(newLine[n])
1303 && xmc_turn_on(SP_PARM, newLine[n - 1], newLine[n]))
1306 && xmc_turn_on(SP_PARM,
1307 xmc_new(SP_PARM, lineno - 1,
1308 screen_columns(SP_PARM) - 1),
1313 PutChar(NCURSES_SP_ARGx CHREF(newLine[n]));
1315 /* check for turn-off:
1316 * If we are writing an attributed non-blank, where the
1317 * next cell is blank, and not attributed.
1319 if (!ISBLANK(newLine[n])
1320 && ((n + 1 < screen_columns(SP_PARM)
1321 && xmc_turn_off(SP_PARM, newLine[n], newLine[n + 1]))
1322 || (n + 1 >= screen_columns(SP_PARM)
1323 && lineno + 1 < screen_lines(SP_PARM)
1324 && xmc_turn_off(SP_PARM,
1326 xmc_new(SP_PARM, lineno + 1, 0))))) {
1335 /* it may be cheap to clear leading whitespace with clr_bol */
1337 if (clr_bol && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1338 int oFirstChar, nFirstChar;
1340 for (oFirstChar = 0;
1341 oFirstChar < screen_columns(SP_PARM);
1343 if (!CharEq(oldLine[oFirstChar], blank))
1345 for (nFirstChar = 0;
1346 nFirstChar < screen_columns(SP_PARM);
1348 if (!CharEq(newLine[nFirstChar], blank))
1351 if (nFirstChar == oFirstChar) {
1352 firstChar = nFirstChar;
1353 /* find the first differing character */
1354 while (firstChar < screen_columns(SP_PARM)
1355 && CharEq(newLine[firstChar], oldLine[firstChar]))
1357 } else if (oFirstChar > nFirstChar) {
1358 firstChar = nFirstChar;
1359 } else { /* oFirstChar < nFirstChar */
1360 firstChar = oFirstChar;
1361 if (SP_PARM->_el1_cost < nFirstChar - oFirstChar) {
1362 if (nFirstChar >= screen_columns(SP_PARM)
1363 && SP_PARM->_el_cost <= SP_PARM->_el1_cost) {
1364 GoTo(NCURSES_SP_ARGx lineno, 0);
1365 UpdateAttrs(SP_PARM, blank);
1366 TPUTS_TRACE("clr_eol");
1367 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clr_eol);
1369 GoTo(NCURSES_SP_ARGx lineno, nFirstChar - 1);
1370 UpdateAttrs(SP_PARM, blank);
1371 TPUTS_TRACE("clr_bol");
1372 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clr_bol);
1375 while (firstChar < nFirstChar)
1376 oldLine[firstChar++] = blank;
1380 /* find the first differing character */
1381 while (firstChar < screen_columns(SP_PARM)
1382 && CharEq(newLine[firstChar], oldLine[firstChar]))
1385 /* if there wasn't one, we're done */
1386 if (firstChar >= screen_columns(SP_PARM)) {
1387 TR(TRACE_UPDATE, (T_RETURN("")));
1391 blank = newLine[screen_columns(SP_PARM) - 1];
1393 if (!can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1394 /* find the last differing character */
1395 nLastChar = screen_columns(SP_PARM) - 1;
1397 while (nLastChar > firstChar
1398 && CharEq(newLine[nLastChar], oldLine[nLastChar]))
1401 if (nLastChar >= firstChar) {
1402 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1403 PutRange(NCURSES_SP_ARGx
1409 memcpy(oldLine + firstChar,
1410 newLine + firstChar,
1411 (nLastChar - firstChar + 1) * sizeof(NCURSES_CH_T));
1413 TR(TRACE_UPDATE, (T_RETURN("")));
1417 /* find last non-blank character on old line */
1418 oLastChar = screen_columns(SP_PARM) - 1;
1419 while (oLastChar > firstChar && CharEq(oldLine[oLastChar], blank))
1422 /* find last non-blank character on new line */
1423 nLastChar = screen_columns(SP_PARM) - 1;
1424 while (nLastChar > firstChar && CharEq(newLine[nLastChar], blank))
1427 if ((nLastChar == firstChar)
1428 && (SP_PARM->_el_cost < (oLastChar - nLastChar))) {
1429 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1430 if (!CharEq(newLine[firstChar], blank))
1431 PutChar(NCURSES_SP_ARGx CHREF(newLine[firstChar]));
1432 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1433 } else if ((nLastChar != oLastChar)
1434 && (!CharEq(newLine[nLastChar], oldLine[oLastChar])
1435 || !(SP_PARM->_nc_sp_idcok
1436 && NCURSES_SP_NAME(has_ic) (NCURSES_SP_ARG)))) {
1437 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1438 if ((oLastChar - nLastChar) > SP_PARM->_el_cost) {
1439 if (PutRange(NCURSES_SP_ARGx
1445 GoTo(NCURSES_SP_ARGx lineno, nLastChar + 1);
1447 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1449 n = max(nLastChar, oLastChar);
1450 PutRange(NCURSES_SP_ARGx
1458 int nLastNonblank = nLastChar;
1459 int oLastNonblank = oLastChar;
1461 /* find the last characters that really differ */
1462 /* can be -1 if no characters differ */
1463 while (CharEq(newLine[nLastChar], oldLine[oLastChar])) {
1464 /* don't split a wide char */
1465 if (isWidecExt(newLine[nLastChar]) &&
1466 !CharEq(newLine[nLastChar - 1], oldLine[oLastChar - 1]))
1470 if (nLastChar == -1 || oLastChar == -1)
1474 n = min(oLastChar, nLastChar);
1475 if (n >= firstChar) {
1476 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1477 PutRange(NCURSES_SP_ARGx
1485 if (oLastChar < nLastChar) {
1486 int m = max(nLastNonblank, oLastNonblank);
1487 #if USE_WIDEC_SUPPORT
1488 while (isWidecExt(newLine[n + 1]) && n) {
1493 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1494 if ((nLastChar < nLastNonblank)
1495 || InsCharCost(SP_PARM, nLastChar - oLastChar) > (m - n)) {
1496 PutRange(NCURSES_SP_ARGx
1503 InsStr(NCURSES_SP_ARGx &newLine[n + 1], nLastChar - oLastChar);
1505 } else if (oLastChar > nLastChar) {
1506 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1507 if (DelCharCost(SP_PARM, oLastChar - nLastChar)
1508 > SP_PARM->_el_cost + nLastNonblank - (n + 1)) {
1509 if (PutRange(NCURSES_SP_ARGx oldLine, newLine, lineno,
1510 n + 1, nLastNonblank))
1511 GoTo(NCURSES_SP_ARGx lineno, nLastNonblank + 1);
1512 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1515 * The delete-char sequence will
1516 * effectively shift in blanks from the
1517 * right margin of the screen. Ensure
1518 * that they are the right color by
1519 * setting the video attributes from
1520 * the last character on the row.
1522 UpdateAttrs(SP_PARM, blank);
1523 DelChar(NCURSES_SP_ARGx oLastChar - nLastChar);
1529 /* update the code's internal representation */
1530 if (screen_columns(SP_PARM) > firstChar)
1531 memcpy(oldLine + firstChar,
1532 newLine + firstChar,
1533 (screen_columns(SP_PARM) - firstChar) * sizeof(NCURSES_CH_T));
1534 TR(TRACE_UPDATE, (T_RETURN("")));
1539 ** ClearScreen(blank)
1541 ** Clear the physical screen and put cursor at home
1546 ClearScreen(NCURSES_SP_DCLx NCURSES_CH_T blank)
1549 bool fast_clear = (clear_screen || clr_eos || clr_eol);
1551 TR(TRACE_UPDATE, ("ClearScreen() called"));
1553 #if NCURSES_EXT_FUNCS
1554 if (SP_PARM->_coloron
1555 && !SP_PARM->_default_color) {
1556 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
1557 GET_SCREEN_PAIR(SP_PARM),
1560 NCURSES_SP_NAME(_nc_outch));
1561 if (!back_color_erase) {
1569 UpdateAttrs(SP_PARM, blank);
1570 TPUTS_TRACE("clear_screen");
1571 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clear_screen);
1572 SP_PARM->_cursrow = SP_PARM->_curscol = 0;
1573 position_check(SP_PARM,
1577 } else if (clr_eos) {
1578 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1579 GoTo(NCURSES_SP_ARGx 0, 0);
1580 UpdateAttrs(SP_PARM, blank);
1581 TPUTS_TRACE("clr_eos");
1582 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1584 screen_lines(SP_PARM),
1585 NCURSES_SP_NAME(_nc_outch));
1586 } else if (clr_eol) {
1587 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1588 UpdateAttrs(SP_PARM, blank);
1589 for (i = 0; i < screen_lines(SP_PARM); i++) {
1590 GoTo(NCURSES_SP_ARGx i, 0);
1591 TPUTS_TRACE("clr_eol");
1592 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clr_eol);
1594 GoTo(NCURSES_SP_ARGx 0, 0);
1597 UpdateAttrs(SP_PARM, blank);
1598 for (i = 0; i < screen_lines(SP_PARM); i++) {
1599 GoTo(NCURSES_SP_ARGx i, 0);
1600 for (j = 0; j < screen_columns(SP_PARM); j++)
1601 PutChar(NCURSES_SP_ARGx CHREF(blank));
1603 GoTo(NCURSES_SP_ARGx 0, 0);
1606 for (i = 0; i < screen_lines(SP_PARM); i++) {
1607 for (j = 0; j < screen_columns(SP_PARM); j++)
1608 CurScreen(SP_PARM)->_line[i].text[j] = blank;
1611 TR(TRACE_UPDATE, ("screen cleared"));
1615 ** InsStr(line, count)
1617 ** Insert the count characters pointed to by line.
1622 InsStr(NCURSES_SP_DCLx NCURSES_CH_T * line, int count)
1624 TR(TRACE_UPDATE, ("InsStr(%p, %p,%d) called", SP_PARM, line, count));
1626 /* Prefer parm_ich as it has the smallest cost - no need to shift
1627 * the whole line on each character. */
1628 /* The order must match that of InsCharCost. */
1630 TPUTS_TRACE("parm_ich");
1631 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1632 TPARM_1(parm_ich, count),
1634 NCURSES_SP_NAME(_nc_outch));
1636 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1640 } else if (enter_insert_mode && exit_insert_mode) {
1641 TPUTS_TRACE("enter_insert_mode");
1642 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx enter_insert_mode);
1644 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1645 if (insert_padding) {
1646 TPUTS_TRACE("insert_padding");
1647 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_padding);
1652 TPUTS_TRACE("exit_insert_mode");
1653 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_insert_mode);
1656 TPUTS_TRACE("insert_character");
1657 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_character);
1658 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1659 if (insert_padding) {
1660 TPUTS_TRACE("insert_padding");
1661 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_padding);
1667 position_check(SP_PARM, SP_PARM->_cursrow, SP_PARM->_curscol, "InsStr");
1673 ** Delete count characters at current position
1678 DelChar(NCURSES_SP_DCLx int count)
1682 TR(TRACE_UPDATE, ("DelChar(%p, %d) called, position = (%ld,%ld)",
1684 (long) NewScreen(SP_PARM)->_cury,
1685 (long) NewScreen(SP_PARM)->_curx));
1688 TPUTS_TRACE("parm_dch");
1689 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1690 TPARM_1(parm_dch, count),
1692 NCURSES_SP_NAME(_nc_outch));
1694 for (n = 0; n < count; n++) {
1695 TPUTS_TRACE("delete_character");
1696 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_character);
1702 * Physical-scrolling support
1704 * This code was adapted from Keith Bostic's hardware scrolling
1705 * support for 4.4BSD curses. I (esr) translated it to use terminfo
1706 * capabilities, narrowed the call interface slightly, and cleaned
1707 * up some convoluted tests. I also added support for the memory_above
1708 * memory_below, and non_dest_scroll_region capabilities.
1710 * For this code to work, we must have either
1711 * change_scroll_region and scroll forward/reverse commands, or
1712 * insert and delete line capabilities.
1713 * When the scrolling region has been set, the cursor has to
1714 * be at the last line of the region to make the scroll up
1715 * happen, or on the first line of region to scroll down.
1717 * This code makes one aesthetic decision in the opposite way from
1718 * BSD curses. BSD curses preferred pairs of il/dl operations
1719 * over scrolls, allegedly because il/dl looked faster. We, on
1720 * the other hand, prefer scrolls because (a) they're just as fast
1721 * on many terminals and (b) using them avoids bouncing an
1722 * unchanged bottom section of the screen up and down, which is
1725 * (lav): added more cases, used dl/il when bot==maxy and in csr case.
1727 * I used assumption that capabilities il/il1/dl/dl1 work inside
1728 * changed scroll region not shifting screen contents outside of it.
1729 * If there are any terminals behaving different way, it would be
1730 * necessary to add some conditions to scroll_csr_forward/backward.
1733 /* Try to scroll up assuming given csr (miny, maxy). Returns ERR on failure */
1735 scroll_csr_forward(NCURSES_SP_DCLx
1745 if (n == 1 && scroll_forward && top == miny && bot == maxy) {
1746 GoTo(NCURSES_SP_ARGx bot, 0);
1747 UpdateAttrs(SP_PARM, blank);
1748 TPUTS_TRACE("scroll_forward");
1749 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx scroll_forward);
1750 } else if (n == 1 && delete_line && bot == maxy) {
1751 GoTo(NCURSES_SP_ARGx top, 0);
1752 UpdateAttrs(SP_PARM, blank);
1753 TPUTS_TRACE("delete_line");
1754 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1755 } else if (parm_index && top == miny && bot == maxy) {
1756 GoTo(NCURSES_SP_ARGx bot, 0);
1757 UpdateAttrs(SP_PARM, blank);
1758 TPUTS_TRACE("parm_index");
1759 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1760 TPARM_2(parm_index, n, 0),
1762 NCURSES_SP_NAME(_nc_outch));
1763 } else if (parm_delete_line && bot == maxy) {
1764 GoTo(NCURSES_SP_ARGx top, 0);
1765 UpdateAttrs(SP_PARM, blank);
1766 TPUTS_TRACE("parm_delete_line");
1767 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1768 TPARM_2(parm_delete_line, n, 0),
1770 NCURSES_SP_NAME(_nc_outch));
1771 } else if (scroll_forward && top == miny && bot == maxy) {
1772 GoTo(NCURSES_SP_ARGx bot, 0);
1773 UpdateAttrs(SP_PARM, blank);
1774 for (i = 0; i < n; i++) {
1775 TPUTS_TRACE("scroll_forward");
1776 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx 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 TPUTS_TRACE("delete_line");
1783 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1788 #if NCURSES_EXT_FUNCS
1789 if (FILL_BCE(SP_PARM)) {
1791 for (i = 0; i < n; i++) {
1792 GoTo(NCURSES_SP_ARGx bot - i, 0);
1793 for (j = 0; j < screen_columns(SP_PARM); j++)
1794 PutChar(NCURSES_SP_ARGx CHREF(blank));
1801 /* Try to scroll down assuming given csr (miny, maxy). Returns ERR on failure */
1804 scroll_csr_backward(NCURSES_SP_DCLx
1814 if (n == 1 && scroll_reverse && top == miny && bot == maxy) {
1815 GoTo(NCURSES_SP_ARGx top, 0);
1816 UpdateAttrs(SP_PARM, blank);
1817 TPUTS_TRACE("scroll_reverse");
1818 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx scroll_reverse);
1819 } else if (n == 1 && insert_line && bot == maxy) {
1820 GoTo(NCURSES_SP_ARGx top, 0);
1821 UpdateAttrs(SP_PARM, blank);
1822 TPUTS_TRACE("insert_line");
1823 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1824 } else if (parm_rindex && top == miny && bot == maxy) {
1825 GoTo(NCURSES_SP_ARGx top, 0);
1826 UpdateAttrs(SP_PARM, blank);
1827 TPUTS_TRACE("parm_rindex");
1828 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1829 TPARM_2(parm_rindex, n, 0),
1831 NCURSES_SP_NAME(_nc_outch));
1832 } else if (parm_insert_line && bot == maxy) {
1833 GoTo(NCURSES_SP_ARGx top, 0);
1834 UpdateAttrs(SP_PARM, blank);
1835 TPUTS_TRACE("parm_insert_line");
1836 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1837 TPARM_2(parm_insert_line, n, 0),
1839 NCURSES_SP_NAME(_nc_outch));
1840 } else if (scroll_reverse && top == miny && bot == maxy) {
1841 GoTo(NCURSES_SP_ARGx top, 0);
1842 UpdateAttrs(SP_PARM, blank);
1843 for (i = 0; i < n; i++) {
1844 TPUTS_TRACE("scroll_reverse");
1845 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx scroll_reverse);
1847 } else if (insert_line && bot == maxy) {
1848 GoTo(NCURSES_SP_ARGx top, 0);
1849 UpdateAttrs(SP_PARM, blank);
1850 for (i = 0; i < n; i++) {
1851 TPUTS_TRACE("insert_line");
1852 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1857 #if NCURSES_EXT_FUNCS
1858 if (FILL_BCE(SP_PARM)) {
1860 for (i = 0; i < n; i++) {
1861 GoTo(NCURSES_SP_ARGx top + i, 0);
1862 for (j = 0; j < screen_columns(SP_PARM); j++)
1863 PutChar(NCURSES_SP_ARGx CHREF(blank));
1870 /* scroll by using delete_line at del and insert_line at ins */
1873 scroll_idl(NCURSES_SP_DCLx int n, int del, int ins, NCURSES_CH_T blank)
1877 if (!((parm_delete_line || delete_line) && (parm_insert_line || insert_line)))
1880 GoTo(NCURSES_SP_ARGx del, 0);
1881 UpdateAttrs(SP_PARM, blank);
1882 if (n == 1 && delete_line) {
1883 TPUTS_TRACE("delete_line");
1884 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1885 } else if (parm_delete_line) {
1886 TPUTS_TRACE("parm_delete_line");
1887 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1888 TPARM_2(parm_delete_line, n, 0),
1890 NCURSES_SP_NAME(_nc_outch));
1891 } else { /* if (delete_line) */
1892 for (i = 0; i < n; i++) {
1893 TPUTS_TRACE("delete_line");
1894 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1898 GoTo(NCURSES_SP_ARGx ins, 0);
1899 UpdateAttrs(SP_PARM, blank);
1900 if (n == 1 && insert_line) {
1901 TPUTS_TRACE("insert_line");
1902 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1903 } else if (parm_insert_line) {
1904 TPUTS_TRACE("parm_insert_line");
1905 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1906 TPARM_2(parm_insert_line, n, 0),
1908 NCURSES_SP_NAME(_nc_outch));
1909 } else { /* if (insert_line) */
1910 for (i = 0; i < n; i++) {
1911 TPUTS_TRACE("insert_line");
1912 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1920 * Note: some terminals require the cursor to be within the scrolling margins
1921 * before setting them. Generally, the cursor must be at the appropriate end
1922 * of the scrolling margins when issuing an indexing operation (it is not
1923 * apparent whether it must also be at the left margin; we do this just to be
1924 * safe). To make the related cursor movement a little faster, we use the
1925 * save/restore cursor capabilities if the terminal has them.
1928 NCURSES_SP_NAME(_nc_scrolln) (NCURSES_SP_DCLx
1933 /* scroll region from top to bot by n lines */
1937 bool cursor_saved = FALSE;
1940 TR(TRACE_MOVE, ("_nc_scrolln(%p, %d, %d, %d, %d)", SP_PARM, n, top, bot, maxy));
1942 if (!IsValidScreen(SP_PARM))
1945 blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1949 * If we scroll, we might remove a cookie.
1951 if (magic_cookie_glitch > 0) {
1956 if (n > 0) { /* scroll up (forward) */
1958 * Explicitly clear if stuff pushed off top of region might
1959 * be saved by the terminal.
1961 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, 0, maxy, blank);
1963 if (res == ERR && change_scroll_region) {
1964 if ((((n == 1 && scroll_forward) || parm_index)
1965 && (SP_PARM->_cursrow == bot || SP_PARM->_cursrow == bot - 1))
1966 && save_cursor && restore_cursor) {
1967 cursor_saved = TRUE;
1968 TPUTS_TRACE("save_cursor");
1969 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx save_cursor);
1971 TPUTS_TRACE("change_scroll_region");
1972 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
1973 TPARM_2(change_scroll_region, top, bot));
1975 TPUTS_TRACE("restore_cursor");
1976 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx restore_cursor);
1978 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1981 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, top, bot, blank);
1983 TPUTS_TRACE("change_scroll_region");
1984 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
1985 TPARM_2(change_scroll_region, 0, maxy));
1986 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1989 if (res == ERR && SP_PARM->_nc_sp_idlok)
1990 res = scroll_idl(NCURSES_SP_ARGx n, top, bot - n + 1, blank);
1993 * Clear the newly shifted-in text.
1996 && (non_dest_scroll_region || (memory_below && bot == maxy))) {
1997 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
1998 if (bot == maxy && clr_eos) {
1999 GoTo(NCURSES_SP_ARGx bot - n + 1, 0);
2000 ClrToEOS(NCURSES_SP_ARGx blank2);
2002 for (i = 0; i < n; i++) {
2003 GoTo(NCURSES_SP_ARGx bot - i, 0);
2004 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2009 } else { /* (n < 0) - scroll down (backward) */
2010 res = scroll_csr_backward(NCURSES_SP_ARGx -n, top, bot, 0, maxy, blank);
2012 if (res == ERR && change_scroll_region) {
2014 && (SP_PARM->_cursrow == top ||
2015 SP_PARM->_cursrow == top - 1)
2016 && save_cursor && restore_cursor) {
2017 cursor_saved = TRUE;
2018 TPUTS_TRACE("save_cursor");
2019 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx save_cursor);
2021 TPUTS_TRACE("change_scroll_region");
2022 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
2023 TPARM_2(change_scroll_region, top, bot));
2025 TPUTS_TRACE("restore_cursor");
2026 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx restore_cursor);
2028 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2031 res = scroll_csr_backward(NCURSES_SP_ARGx
2032 -n, top, bot, top, bot, blank);
2034 TPUTS_TRACE("change_scroll_region");
2035 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
2036 TPARM_2(change_scroll_region, 0, maxy));
2037 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2040 if (res == ERR && SP_PARM->_nc_sp_idlok)
2041 res = scroll_idl(NCURSES_SP_ARGx -n, bot + n + 1, top, blank);
2044 * Clear the newly shifted-in text.
2047 && (non_dest_scroll_region || (memory_above && top == 0))) {
2048 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2049 for (i = 0; i < -n; i++) {
2050 GoTo(NCURSES_SP_ARGx i + top, 0);
2051 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2059 _nc_scroll_window(CurScreen(SP_PARM), n, top, bot, blank);
2061 /* shift hash values too - they can be reused */
2062 NCURSES_SP_NAME(_nc_scroll_oldhash) (NCURSES_SP_ARGx n, top, bot);
2067 #if NCURSES_SP_FUNCS
2069 _nc_scrolln(int n, int top, int bot, int maxy)
2071 return NCURSES_SP_NAME(_nc_scrolln) (CURRENT_SCREEN, n, top, bot, maxy);
2075 NCURSES_EXPORT(void)
2076 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_DCL0)
2080 /* make sure terminal is in a sane known state */
2081 SetAttr(SCREEN_ATTRS(SP_PARM), A_NORMAL);
2082 NewScreen(SP_PARM)->_clear = TRUE;
2084 /* reset color pairs and definitions */
2085 if (SP_PARM->_coloron || SP_PARM->_color_defs)
2086 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2088 /* restore user-defined colors, if any */
2089 if (SP_PARM->_color_defs < 0) {
2091 SP_PARM->_color_defs = -(SP_PARM->_color_defs);
2092 for (n = 0; n < SP_PARM->_color_defs; ++n) {
2093 if (SP_PARM->_color_table[n].init) {
2094 NCURSES_SP_NAME(init_color) (NCURSES_SP_ARGx n,
2095 SP_PARM->_color_table[n].r,
2096 SP_PARM->_color_table[n].g,
2097 SP_PARM->_color_table[n].b);
2102 if (exit_attribute_mode)
2103 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_attribute_mode);
2105 /* turn off attributes */
2106 if (exit_alt_charset_mode)
2107 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_alt_charset_mode);
2108 if (exit_standout_mode)
2109 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_standout_mode);
2110 if (exit_underline_mode)
2111 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_underline_mode);
2113 if (exit_insert_mode)
2114 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_insert_mode);
2115 if (enter_am_mode && exit_am_mode)
2116 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
2122 #if NCURSES_SP_FUNCS
2123 NCURSES_EXPORT(void)
2124 _nc_screen_resume(void)
2126 NCURSES_SP_NAME(_nc_screen_resume) (CURRENT_SCREEN);
2130 NCURSES_EXPORT(void)
2131 NCURSES_SP_NAME(_nc_screen_init) (NCURSES_SP_DCL0)
2133 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
2136 #if NCURSES_SP_FUNCS
2137 NCURSES_EXPORT(void)
2138 _nc_screen_init(void)
2140 NCURSES_SP_NAME(_nc_screen_init) (CURRENT_SCREEN);
2144 /* wrap up screen handling */
2145 NCURSES_EXPORT(void)
2146 NCURSES_SP_NAME(_nc_screen_wrap) (NCURSES_SP_DCL0)
2151 UpdateAttrs(SP_PARM, normal);
2152 #if NCURSES_EXT_FUNCS
2153 if (SP_PARM->_coloron
2154 && !SP_PARM->_default_color) {
2155 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
2156 SP_PARM->_default_color = TRUE;
2157 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
2161 NCURSES_SP_NAME(_nc_outch));
2162 SP_PARM->_default_color = FALSE;
2164 NCURSES_SP_NAME(mvcur) (NCURSES_SP_ARGx
2167 screen_lines(SP_PARM) - 1,
2170 ClrToEOL(NCURSES_SP_ARGx blank, TRUE);
2173 if (SP_PARM->_color_defs) {
2174 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2178 #if NCURSES_SP_FUNCS
2179 NCURSES_EXPORT(void)
2180 _nc_screen_wrap(void)
2182 NCURSES_SP_NAME(_nc_screen_wrap) (CURRENT_SCREEN);
2187 NCURSES_EXPORT(void)
2188 NCURSES_SP_NAME(_nc_do_xmc_glitch) (NCURSES_SP_DCLx attr_t previous)
2191 attr_t chg = XMC_CHANGES(previous ^ AttrOf(SCREEN_ATTRS(SP_PARM)));
2195 SP_PARM->_curscol += magic_cookie_glitch;
2196 if (SP_PARM->_curscol >= SP_PARM->_columns)
2197 wrap_cursor(NCURSES_SP_ARG);
2198 TR(TRACE_UPDATE, ("bumped to %d,%d after cookie",
2199 SP_PARM->_cursrow, SP_PARM->_curscol));
2206 #if NCURSES_SP_FUNCS
2207 NCURSES_EXPORT(void)
2208 _nc_do_xmc_glitch(attr_t previous)
2210 NCURSES_SP_NAME(_nc_do_xmc_glitch) (CURRENT_SCREEN, previous);
2214 #endif /* USE_XMC_SUPPORT */