1 /****************************************************************************
2 * Copyright (c) 1998-2009,2010 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.263 2010/05/01 20:44:34 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 (void *) SP_PARM, row, col, SP_PARM->_cursrow, SP_PARM->_curscol));
198 position_check(SP_PARM, SP_PARM->_cursrow, SP_PARM->_curscol, "GoTo");
200 TINFO_MVCUR(NCURSES_SP_ARGx
204 position_check(SP_PARM, SP_PARM->_cursrow, SP_PARM->_curscol, "GoTo2");
207 static NCURSES_INLINE void
208 PutAttrChar(NCURSES_SP_DCLx CARG_CH_T ch)
214 NCURSES_CH_T attr = CHDEREF(ch);
216 TR(TRACE_CHARPUT, ("PutAttrChar(%s) at (%d, %d)",
218 SP_PARM->_cursrow, SP_PARM->_curscol));
219 #if USE_WIDEC_SUPPORT
221 * If this is not a valid character, there is nothing more to do.
223 if (isWidecExt(CHDEREF(ch))) {
224 TR(TRACE_CHARPUT, ("...skip"));
228 * Determine the number of character cells which the 'ch' value will use
229 * on the screen. It should be at least one.
231 if ((chlen = wcwidth(CharOf(CHDEREF(ch)))) <= 0) {
232 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
235 * If the character falls into any of these special cases, do
236 * not force the result to a blank:
238 * a) it is printable (this works around a bug in wcwidth()).
239 * b) use_legacy_coding() has been called to modify the treatment
241 * c) the acs_map[] has been initialized to allow codes 0-31
242 * to be rendered. This supports Linux console's "PC"
243 * characters. Codes 128-255 are allowed though this is
246 if (is8bits(CharOf(CHDEREF(ch)))
247 && (isprint(CharOf(CHDEREF(ch)))
248 || (SP_PARM->_legacy_coding > 0 && CharOf(CHDEREF(ch)) >= 160)
249 || (SP_PARM->_legacy_coding > 1 && CharOf(CHDEREF(ch)) >= 128)
250 || (AttrOf(attr) & A_ALTCHARSET
251 && ((CharOfD(ch) < ACS_LEN
252 && SP_PARM->_acs_map != 0
253 && SP_PARM->_acs_map[CharOfD(ch)] != 0)
254 || (CharOfD(ch) >= 128))))) {
258 TR(TRACE_CHARPUT, ("forced to blank"));
264 if ((AttrOf(attr) & A_ALTCHARSET)
265 && SP_PARM->_acs_map != 0
266 && CharOfD(ch) < ACS_LEN) {
267 my_ch = CHDEREF(ch); /* work around const param */
268 #if USE_WIDEC_SUPPORT
270 * This is crude & ugly, but works most of the time. It checks if the
271 * acs_chars string specified that we have a mapping for this
272 * character, and uses the wide-character mapping when we expect the
273 * normal one to be broken (by mis-design ;-).
275 if (SP_PARM->_screen_acs_fix
276 && SP_PARM->_screen_acs_map[CharOf(my_ch)]) {
277 RemAttr(attr, A_ALTCHARSET);
278 my_ch = _nc_wacs[CharOf(my_ch)];
282 * If we (still) have alternate character set, it is the normal 8bit
283 * flavor. The _screen_acs_map[] array tells if the character was
284 * really in acs_chars, needed because of the way wide/normal line
285 * drawing flavors are integrated.
287 if (AttrOf(attr) & A_ALTCHARSET) {
289 chtype temp = UChar(SP_PARM->_acs_map[j]);
291 if (!(SP_PARM->_screen_acs_map[j])) {
292 RemAttr(attr, A_ALTCHARSET);
297 SetChar(my_ch, temp, AttrOf(attr));
301 if (tilde_glitch && (CharOfD(ch) == L('~'))) {
302 SetChar(tilde, L('`'), AttrOf(attr));
306 UpdateAttrs(SP_PARM, attr);
307 #if !USE_WIDEC_SUPPORT
308 /* FIXME - we do this special case for signal handling, should see how to
309 * make it work for wide characters.
311 if (SP_PARM->_outch != 0) {
312 SP_PARM->_outch(NCURSES_SP_ARGx UChar(ch));
316 PUTC(CHDEREF(ch), SP_PARM->_ofp); /* macro's fastest... */
319 SP_PARM->_curscol += chlen;
321 TPUTS_TRACE("char_padding");
322 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx 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, 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 TPUTS_TRACE("exit_am_mode");
394 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_am_mode);
396 PutAttrChar(NCURSES_SP_ARGx ch);
398 position_check(SP_PARM,
403 TPUTS_TRACE("enter_am_mode");
404 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx enter_am_mode);
405 } else if ((enter_insert_mode && exit_insert_mode)
406 || insert_character || parm_ich) {
408 screen_lines(SP_PARM) - 1,
409 screen_columns(SP_PARM) - 2);
410 PutAttrChar(NCURSES_SP_ARGx ch);
412 screen_lines(SP_PARM) - 1,
413 screen_columns(SP_PARM) - 2);
414 InsStr(NCURSES_SP_ARGx
415 NewScreen(SP_PARM)->_line[screen_lines(SP_PARM) - 1].text +
416 screen_columns(SP_PARM) - 2, 1);
421 * Wrap the cursor position, i.e., advance to the beginning of the next line.
424 wrap_cursor(NCURSES_SP_DCL0)
426 if (eat_newline_glitch) {
428 * xenl can manifest two different ways. The vt100 way is that, when
429 * you'd expect the cursor to wrap, it stays hung at the right margin
430 * (on top of the character just emitted) and doesn't wrap until the
431 * *next* graphic char is emitted. The c100 way is to ignore LF
432 * received just after an am wrap.
434 * An aggressive way to handle this would be to emit CR/LF after the
435 * char and then assume the wrap is done, you're on the first position
436 * of the next line, and the terminal out of its weird state. Here
437 * it's safe to just tell the code that the cursor is in hyperspace and
438 * let the next mvcur() call straighten things out.
440 SP_PARM->_curscol = -1;
441 SP_PARM->_cursrow = -1;
442 } else if (auto_right_margin) {
443 SP_PARM->_curscol = 0;
446 * We've actually moved - but may have to work around problems with
447 * video attributes not working.
449 if (!move_standout_mode && AttrOf(SCREEN_ATTRS(SP_PARM))) {
450 TR(TRACE_CHARPUT, ("turning off (%#lx) %s before wrapping",
451 (unsigned long) AttrOf(SCREEN_ATTRS(SP_PARM)),
452 _traceattr(AttrOf(SCREEN_ATTRS(SP_PARM)))));
453 (void) VIDATTR(SP_PARM, A_NORMAL, 0);
458 position_check(SP_PARM,
464 static NCURSES_INLINE void
465 PutChar(NCURSES_SP_DCLx const ARG_CH_T ch)
466 /* insert character, handling automargin stuff */
468 if (SP_PARM->_cursrow == screen_lines(SP_PARM) - 1 &&
469 SP_PARM->_curscol == screen_columns(SP_PARM) - 1) {
470 PutCharLR(NCURSES_SP_ARGx ch);
472 PutAttrChar(NCURSES_SP_ARGx ch);
475 if (SP_PARM->_curscol >= screen_columns(SP_PARM))
476 wrap_cursor(NCURSES_SP_ARG);
478 position_check(SP_PARM, SP_PARM->_cursrow, 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) {
500 NCURSES_SP_NAME(pair_content) (NCURSES_SP_ARGx pair, &fg, &bg);
501 if (fg != C_MASK || bg != C_MASK)
505 if (AttrOfD(ch) & A_COLOR)
509 return (ISBLANK(CHDEREF(ch)) &&
510 (AttrOfD(ch) & ~(NONBLANK_ATTR | A_COLOR)) == BLANK_ATTR);
514 * Issue a given span of characters from an array.
515 * Must be functionally equivalent to:
516 * for (i = 0; i < num; i++)
518 * but can leave the cursor positioned at the middle of the interval.
520 * Returns: 0 - cursor is at the end of interval
521 * 1 - cursor is somewhere in the middle
523 * This code is optimized using ech and rep.
526 EmitRange(NCURSES_SP_DCLx const NCURSES_CH_T * ntext, int num)
530 TR(TRACE_CHARPUT, ("EmitRange %d:%s", num, _nc_viscbuf(ntext, num)));
532 if (erase_chars || repeat_char) {
537 while (num > 1 && !CharEq(ntext[0], ntext[1])) {
538 PutChar(NCURSES_SP_ARGx CHREF(ntext[0]));
544 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
549 while (runcount < num && CharEq(ntext[runcount], ntext0))
553 * The cost expression in the middle isn't exactly right.
554 * _cup_ch_cost is an upper bound on the cost for moving to the
555 * end of the erased area, but not the cost itself (which we
556 * can't compute without emitting the move). This may result
557 * in erase_chars not getting used in some situations for
558 * which it would be marginally advantageous.
561 && runcount > SP_PARM->_ech_cost + SP_PARM->_cup_ch_cost
562 && can_clear_with(NCURSES_SP_ARGx CHREF(ntext0))) {
563 UpdateAttrs(SP_PARM, ntext0);
564 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
565 TPARM_1(erase_chars, runcount));
568 * If this is the last part of the given interval,
569 * don't bother moving cursor, since it can be the
570 * last update on the line.
572 if (runcount < num) {
575 SP_PARM->_curscol + runcount);
577 return 1; /* cursor stays in the middle */
579 } else if (repeat_char && runcount > SP_PARM->_rep_cost) {
580 bool wrap_possible = (SP_PARM->_curscol + runcount >=
581 screen_columns(SP_PARM));
582 int rep_count = runcount;
587 UpdateAttrs(SP_PARM, ntext0);
588 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
593 NCURSES_SP_NAME(_nc_outch));
594 SP_PARM->_curscol += rep_count;
597 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
599 for (i = 0; i < runcount; i++)
600 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
608 for (i = 0; i < num; i++)
609 PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
614 * Output the line in the given range [first .. last]
616 * If there's a run of identical characters that's long enough to justify
617 * cursor movement, use that also.
619 * Returns: same as EmitRange
622 PutRange(NCURSES_SP_DCLx
623 const NCURSES_CH_T * otext,
624 const NCURSES_CH_T * ntext,
630 TR(TRACE_CHARPUT, ("PutRange(%p, %p, %p, %d, %d, %d)",
632 (const void *) otext,
633 (const void *) ntext,
637 && (last - first + 1) > SP_PARM->_inline_cost) {
638 for (j = first, same = 0; j <= last; j++) {
639 if (!same && isWidecExt(otext[j]))
641 if (CharEq(otext[j], ntext[j])) {
644 if (same > SP_PARM->_inline_cost) {
645 EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
646 GoTo(NCURSES_SP_ARGx row, first = j);
651 i = EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
653 * Always return 1 for the next GoTo() after a PutRange() if we found
654 * identical characters at end of interval
656 return (same == 0 ? i : 1);
658 return EmitRange(NCURSES_SP_ARGx ntext + first, last - first + 1);
661 /* leave unbracketed here so 'indent' works */
662 #define MARK_NOCHANGE(win,row) \
663 win->_line[row].firstchar = _NOCHANGE; \
664 win->_line[row].lastchar = _NOCHANGE; \
665 if_USE_SCROLL_HINTS(win->_line[row].oldindex = row)
668 TINFO_DOUPDATE(NCURSES_SP_DCL0)
673 struct tms before, after;
674 #endif /* USE_TRACE_TIMES */
676 T((T_CALLED("_nc_tinfo:doupdate(%p)"), (void *) SP_PARM));
680 * It is "legal" but unlikely that an application could assign a new
681 * value to one of the standard windows. Check for that possibility
682 * and try to recover.
684 * We do not allow applications to assign new values in the reentrant
687 #define SyncScreens(internal,exported) \
688 if (internal == 0) internal = exported; \
689 if (internal != exported) exported = internal
691 SyncScreens(CurScreen(SP_PARM), curscr);
692 SyncScreens(NewScreen(SP_PARM), newscr);
693 SyncScreens(StdScreen(SP_PARM), stdscr);
696 if (CurScreen(SP_PARM) == 0
697 || NewScreen(SP_PARM) == 0
698 || StdScreen(SP_PARM) == 0)
702 if (USE_TRACEF(TRACE_UPDATE)) {
703 if (CurScreen(SP_PARM)->_clear)
704 _tracef("curscr is clear");
706 _tracedump("curscr", CurScreen(SP_PARM));
707 _tracedump("newscr", NewScreen(SP_PARM));
708 _nc_unlock_global(tracef);
712 _nc_signal_handler(FALSE);
714 if (SP_PARM->_fifohold)
715 SP_PARM->_fifohold--;
718 if (SP_PARM->_endwin || _nc_handle_sigwinch(SP_PARM)) {
720 * This is a transparent extension: XSI does not address it,
721 * and applications need not know that ncurses can do it.
723 * Check if the terminal size has changed while curses was off
724 * (this can happen in an xterm, for example), and resize the
725 * ncurses data structures accordingly.
727 _nc_update_screensize(SP_PARM);
731 if (SP_PARM->_endwin) {
733 T(("coming back from shell mode"));
734 NCURSES_SP_NAME(reset_prog_mode) (NCURSES_SP_ARG);
736 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
737 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
738 SP_PARM->_mouse_resume(SP_PARM);
740 SP_PARM->_endwin = FALSE;
743 /* zero the metering machinery */
745 (void) times(&before);
746 #endif /* USE_TRACE_TIMES */
749 * This is the support for magic-cookie terminals. The theory: we scan
750 * the virtual screen looking for attribute turnons. Where we find one,
751 * check to make sure it's realizable by seeing if the required number of
752 * un-attributed blanks are present before and after the attributed range;
753 * try to shift the range boundaries over blanks (not changing the screen
754 * display) so this becomes true. If it is, shift the beginning attribute
755 * change appropriately (the end one, if we've gotten this far, is
756 * guaranteed room for its cookie). If not, nuke the added attributes out
760 if (magic_cookie_glitch > 0) {
762 attr_t rattr = A_NORMAL;
764 for (i = 0; i < screen_lines(SP_PARM); i++) {
765 for (j = 0; j < screen_columns(SP_PARM); j++) {
767 NCURSES_CH_T *thisline = NewScreen(SP_PARM)->_line[i].text;
768 attr_t thisattr = AttrOf(thisline[j]) & SP_PARM->_xmc_triggers;
769 attr_t turnon = thisattr & ~rattr;
771 /* is an attribute turned on here? */
777 TR(TRACE_ATTRS, ("At (%d, %d): from %s...", i, j, _traceattr(rattr)));
778 TR(TRACE_ATTRS, ("...to %s", _traceattr(turnon)));
781 * If the attribute change location is a blank with a "safe"
782 * attribute, undo the attribute turnon. This may ensure
783 * there's enough room to set the attribute before the first
784 * non-blank in the run.
786 #define SAFE(scr,a) (!((a) & (scr)->_xmc_triggers))
787 if (ISBLANK(thisline[j]) && SAFE(SP_PARM, turnon)) {
788 RemAttr(thisline[j], turnon);
792 /* check that there's enough room at start of span */
793 for (k = 1; k <= magic_cookie_glitch; k++) {
795 || !ISBLANK(thisline[j - k])
796 || !SAFE(SP_PARM, AttrOf(thisline[j - k]))) {
798 TR(TRACE_ATTRS, ("No room at start in %d,%d%s%s",
800 (ISBLANK(thisline[j - k])
803 (SAFE(SP_PARM, AttrOf(thisline[j - k]))
810 bool end_onscreen = FALSE;
813 /* find end of span, if it's onscreen */
814 for (m = i; m < screen_lines(SP_PARM); m++) {
815 for (; n < screen_columns(SP_PARM); n++) {
817 AttrOf(NewScreen(SP_PARM)->_line[m].text[n]);
818 if ((testattr & SP_PARM->_xmc_triggers) == rattr) {
821 ("Range attributed with %s ends at (%d, %d)",
822 _traceattr(turnon), m, n));
829 ("Range attributed with %s ends offscreen",
830 _traceattr(turnon)));
834 NCURSES_CH_T *lastline =
835 NewScreen(SP_PARM)->_line[m].text;
838 * If there are safely-attributed blanks at the end of
839 * the range, shorten the range. This will help ensure
840 * that there is enough room at end of span.
843 && ISBLANK(lastline[n])
844 && SAFE(SP_PARM, AttrOf(lastline[n]))) {
845 RemAttr(lastline[n--], turnon);
848 /* check that there's enough room at end of span */
849 for (k = 1; k <= magic_cookie_glitch; k++) {
850 if (n + k >= screen_columns(SP_PARM)
851 || !ISBLANK(lastline[n + k])
852 || !SAFE(SP_PARM, AttrOf(lastline[n + k]))) {
855 ("No room at end in %d,%d%s%s",
857 (ISBLANK(lastline[n + k])
860 (SAFE(SP_PARM, AttrOf(lastline[n + k]))
873 ("Clearing %s beginning at (%d, %d)",
874 _traceattr(turnon), i, j));
876 /* turn off new attributes over span */
877 for (p = i; p < screen_lines(SP_PARM); p++) {
878 for (; q < screen_columns(SP_PARM); q++) {
879 attr_t testattr = AttrOf(newscr->_line[p].text[q]);
880 if ((testattr & SP_PARM->_xmc_triggers) == rattr)
882 RemAttr(NewScreen(SP_PARM)->_line[p].text[q], turnon);
889 ("Cookie space for %s found before (%d, %d)",
890 _traceattr(turnon), i, j));
893 * Back up the start of range so there's room for cookies
894 * before the first nonblank character.
896 for (k = 1; k <= magic_cookie_glitch; k++)
897 AddAttr(thisline[j - k], turnon);
905 /* show altered highlights after magic-cookie check */
906 if (USE_TRACEF(TRACE_UPDATE)) {
907 _tracef("After magic-cookie check...");
908 _tracedump("newscr", NewScreen(SP_PARM));
909 _nc_unlock_global(tracef);
913 #endif /* USE_XMC_SUPPORT */
916 if (CurScreen(SP_PARM)->_clear || NewScreen(SP_PARM)->_clear) { /* force refresh ? */
917 ClrUpdate(NCURSES_SP_ARG);
918 CurScreen(SP_PARM)->_clear = FALSE; /* reset flag */
919 NewScreen(SP_PARM)->_clear = FALSE; /* reset flag */
921 int changedlines = CHECK_INTERVAL;
923 if (check_pending(NCURSES_SP_ARG))
926 nonempty = min(screen_lines(SP_PARM), NewScreen(SP_PARM)->_maxy + 1);
928 if (SP_PARM->_scrolling) {
929 NCURSES_SP_NAME(_nc_scroll_optimize) (NCURSES_SP_ARG);
932 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
934 TR(TRACE_UPDATE, ("Transforming lines, nonempty %d", nonempty));
935 for (i = 0; i < nonempty; i++) {
937 * Here is our line-breakout optimization.
939 if (changedlines == CHECK_INTERVAL) {
940 if (check_pending(NCURSES_SP_ARG))
946 * newscr->line[i].firstchar is normally set
947 * by wnoutrefresh. curscr->line[i].firstchar
948 * is normally set by _nc_scroll_window in the
949 * vertical-movement optimization code,
951 if (NewScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE
952 || CurScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE) {
953 TransformLine(NCURSES_SP_ARGx i);
957 /* mark line changed successfully */
958 if (i <= NewScreen(SP_PARM)->_maxy) {
959 MARK_NOCHANGE(NewScreen(SP_PARM), i);
961 if (i <= CurScreen(SP_PARM)->_maxy) {
962 MARK_NOCHANGE(CurScreen(SP_PARM), i);
967 /* put everything back in sync */
968 for (i = nonempty; i <= NewScreen(SP_PARM)->_maxy; i++) {
969 MARK_NOCHANGE(NewScreen(SP_PARM), i);
971 for (i = nonempty; i <= CurScreen(SP_PARM)->_maxy; i++) {
972 MARK_NOCHANGE(CurScreen(SP_PARM), i);
975 if (!NewScreen(SP_PARM)->_leaveok) {
976 CurScreen(SP_PARM)->_curx = NewScreen(SP_PARM)->_curx;
977 CurScreen(SP_PARM)->_cury = NewScreen(SP_PARM)->_cury;
979 GoTo(NCURSES_SP_ARGx CurScreen(SP_PARM)->_cury, CurScreen(SP_PARM)->_curx);
984 * We would like to keep the physical screen in normal mode in case we get
985 * other processes writing to the screen. This goal cannot be met for
986 * magic cookies since it interferes with attributes that may propagate
987 * past the current position.
990 if (magic_cookie_glitch != 0)
992 UpdateAttrs(SP_PARM, normal);
994 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
995 WINDOW_ATTRS(CurScreen(SP_PARM)) = WINDOW_ATTRS(NewScreen(SP_PARM));
998 (void) times(&after);
1000 ("Update cost: %ld chars, %ld clocks system time, %ld clocks user time",
1002 (long) (after.tms_stime - before.tms_stime),
1003 (long) (after.tms_utime - before.tms_utime)));
1004 #endif /* USE_TRACE_TIMES */
1006 _nc_signal_handler(TRUE);
1011 #if NCURSES_SP_FUNCS && !defined(USE_TERM_DRIVER)
1015 return TINFO_DOUPDATE(CURRENT_SCREEN);
1022 * Returns the attributed character that corresponds to the "cleared"
1023 * screen. If the terminal has the back-color-erase feature, this will be
1024 * colored according to the wbkgd() call.
1026 * We treat 'curscr' specially because it isn't supposed to be set directly
1027 * in the wbkgd() call. Assume 'stdscr' for this case.
1029 #define BCE_ATTRS (A_NORMAL|A_COLOR)
1030 #define BCE_BKGD(sp,win) (((win) == CurScreen(sp) ? StdScreen(sp) : (win))->_nc_bkgd)
1032 static NCURSES_INLINE NCURSES_CH_T
1033 ClrBlank(NCURSES_SP_DCLx WINDOW *win)
1035 NCURSES_CH_T blank = blankchar;
1036 if (back_color_erase)
1037 AddAttr(blank, (AttrOf(BCE_BKGD(SP_PARM, win)) & BCE_ATTRS));
1044 ** Update by clearing and redrawing the entire screen.
1049 ClrUpdate(NCURSES_SP_DCL0)
1051 TR(TRACE_UPDATE, (T_CALLED("ClrUpdate")));
1054 NCURSES_CH_T blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1055 int nonempty = min(screen_lines(SP_PARM),
1056 NewScreen(SP_PARM)->_maxy + 1);
1058 ClearScreen(NCURSES_SP_ARGx blank);
1060 TR(TRACE_UPDATE, ("updating screen from scratch"));
1062 nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1064 for (i = 0; i < nonempty; i++)
1065 TransformLine(NCURSES_SP_ARGx i);
1067 TR(TRACE_UPDATE, (T_RETURN("")));
1073 ** Clear to end of current line, starting at the cursor position
1077 ClrToEOL(NCURSES_SP_DCLx NCURSES_CH_T blank, bool needclear)
1082 if (CurScreen(SP_PARM) != 0
1083 && SP_PARM->_cursrow >= 0) {
1084 for (j = SP_PARM->_curscol; j < screen_columns(SP_PARM); j++) {
1087 &(CurScreen(SP_PARM)->_line[SP_PARM->_cursrow].text[j]);
1089 if (!CharEq(*cp, blank)) {
1098 if (needclear && (SP_PARM != 0)) {
1099 UpdateAttrs(SP_PARM, blank);
1100 TPUTS_TRACE("clr_eol");
1101 if (clr_eol && SP_PARM->_el_cost <= (screen_columns(SP_PARM) - SP_PARM->_curscol)) {
1102 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clr_eol);
1104 int count = (screen_columns(SP_PARM) - SP_PARM->_curscol);
1106 PutChar(NCURSES_SP_ARGx CHREF(blank));
1114 ** Clear to end of screen, starting at the cursor position
1118 ClrToEOS(NCURSES_SP_DCLx NCURSES_CH_T blank)
1125 row = SP_PARM->_cursrow;
1126 col = SP_PARM->_curscol;
1128 UpdateAttrs(SP_PARM, blank);
1129 TPUTS_TRACE("clr_eos");
1130 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1132 screen_lines(SP_PARM) - row,
1133 NCURSES_SP_NAME(_nc_outch));
1135 while (col < screen_columns(SP_PARM))
1136 CurScreen(SP_PARM)->_line[row].text[col++] = blank;
1138 for (row++; row < screen_lines(SP_PARM); row++) {
1139 for (col = 0; col < screen_columns(SP_PARM); col++)
1140 CurScreen(SP_PARM)->_line[row].text[col] = blank;
1147 * Test if clearing the end of the screen would satisfy part of the
1148 * screen-update. Do this by scanning backwards through the lines in the
1149 * screen, checking if each is blank, and one or more are changed.
1152 ClrBottom(NCURSES_SP_DCLx int total)
1157 int last = min(screen_columns(SP_PARM), NewScreen(SP_PARM)->_maxx + 1);
1158 NCURSES_CH_T blank = NewScreen(SP_PARM)->_line[total - 1].text[last - 1];
1161 if (clr_eos && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1163 for (row = total - 1; row >= 0; row--) {
1164 for (col = 0, ok = TRUE; ok && col < last; col++) {
1165 ok = (CharEq(NewScreen(SP_PARM)->_line[row].text[col], blank));
1170 for (col = 0; ok && col < last; col++) {
1171 ok = (CharEq(CurScreen(SP_PARM)->_line[row].text[col], blank));
1177 /* don't use clr_eos for just one line if clr_eol available */
1179 GoTo(NCURSES_SP_ARGx top, 0);
1180 ClrToEOS(NCURSES_SP_ARGx blank);
1181 if (SP_PARM->oldhash && SP_PARM->newhash) {
1182 for (row = top; row < screen_lines(SP_PARM); row++)
1183 SP_PARM->oldhash[row] = SP_PARM->newhash[row];
1191 #if USE_WIDEC_SUPPORT
1192 #define check_xmc_transition(sp, a, b) \
1193 ((((a)->attr ^ (b)->attr) & ~((a)->attr) & (sp)->_xmc_triggers) != 0)
1194 #define xmc_turn_on(sp,a,b) check_xmc_transition(sp,&(a), &(b))
1196 #define xmc_turn_on(sp,a,b) ((((a)^(b)) & ~(a) & (sp)->_xmc_triggers) != 0)
1199 #define xmc_new(sp,r,c) NewScreen(sp)->_line[r].text[c]
1200 #define xmc_turn_off(sp,a,b) xmc_turn_on(sp,b,a)
1201 #endif /* USE_XMC_SUPPORT */
1204 ** TransformLine(lineno)
1206 ** Transform the given line in curscr to the one in newscr, using
1207 ** Insert/Delete Character if idcok && has_ic().
1209 ** firstChar = position of first different character in line
1210 ** oLastChar = position of last different character in old line
1211 ** nLastChar = position of last different character in new line
1213 ** move to firstChar
1214 ** overwrite chars up to min(oLastChar, nLastChar)
1215 ** if oLastChar < nLastChar
1216 ** insert newLine[oLastChar+1..nLastChar]
1218 ** delete oLastChar - nLastChar spaces
1222 TransformLine(NCURSES_SP_DCLx int const lineno)
1224 int firstChar, oLastChar, nLastChar;
1225 NCURSES_CH_T *newLine = NewScreen(SP_PARM)->_line[lineno].text;
1226 NCURSES_CH_T *oldLine = CurScreen(SP_PARM)->_line[lineno].text;
1228 bool attrchanged = FALSE;
1230 TR(TRACE_UPDATE, (T_CALLED("TransformLine(%p, %d)"), (void *) SP_PARM, lineno));
1232 /* copy new hash value to old one */
1233 if (SP_PARM->oldhash && SP_PARM->newhash)
1234 SP_PARM->oldhash[lineno] = SP_PARM->newhash[lineno];
1237 * If we have colors, there is the possibility of having two color pairs
1238 * that display as the same colors. For instance, Lynx does this. Check
1239 * for this case, and update the old line with the new line's colors when
1240 * they are equivalent.
1242 if (SP_PARM->_coloron) {
1246 for (n = 0; n < screen_columns(SP_PARM); n++) {
1247 if (!CharEq(newLine[n], oldLine[n])) {
1248 oldPair = GetPair(oldLine[n]);
1249 newPair = GetPair(newLine[n]);
1250 if (oldPair != newPair
1251 && unColor(oldLine[n]) == unColor(newLine[n])) {
1252 if (oldPair < SP_PARM->_pair_limit
1253 && newPair < SP_PARM->_pair_limit
1254 && (SP_PARM->_color_pairs[oldPair] ==
1255 SP_PARM->_color_pairs[newPair])) {
1256 SetPair(oldLine[n], GetPair(newLine[n]));
1263 if (ceol_standout_glitch && clr_eol) {
1265 while (firstChar < screen_columns(SP_PARM)) {
1266 if (!SameAttrOf(newLine[firstChar], oldLine[firstChar])) {
1276 if (attrchanged) { /* we may have to disregard the whole line */
1277 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1278 ClrToEOL(NCURSES_SP_ARGx
1279 ClrBlank(NCURSES_SP_ARGx
1280 CurScreen(SP_PARM)), FALSE);
1281 PutRange(NCURSES_SP_ARGx
1282 oldLine, newLine, lineno, 0,
1283 screen_columns(SP_PARM) - 1);
1287 * This is a very simple loop to paint characters which may have the
1288 * magic cookie glitch embedded. It doesn't know much about video
1289 * attributes which are continued from one line to the next. It
1290 * assumes that we have filtered out requests for attribute changes
1291 * that do not get mapped to blank positions.
1293 * FIXME: we are not keeping track of where we put the cookies, so this
1294 * will work properly only once, since we may overwrite a cookie in a
1295 * following operation.
1297 } else if (magic_cookie_glitch > 0) {
1298 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1299 for (n = 0; n < screen_columns(SP_PARM); n++) {
1300 int m = n + magic_cookie_glitch;
1302 /* check for turn-on:
1303 * If we are writing an attributed blank, where the
1304 * previous cell is not attributed.
1306 if (ISBLANK(newLine[n])
1308 && xmc_turn_on(SP_PARM, newLine[n - 1], newLine[n]))
1311 && xmc_turn_on(SP_PARM,
1312 xmc_new(SP_PARM, lineno - 1,
1313 screen_columns(SP_PARM) - 1),
1318 PutChar(NCURSES_SP_ARGx CHREF(newLine[n]));
1320 /* check for turn-off:
1321 * If we are writing an attributed non-blank, where the
1322 * next cell is blank, and not attributed.
1324 if (!ISBLANK(newLine[n])
1325 && ((n + 1 < screen_columns(SP_PARM)
1326 && xmc_turn_off(SP_PARM, newLine[n], newLine[n + 1]))
1327 || (n + 1 >= screen_columns(SP_PARM)
1328 && lineno + 1 < screen_lines(SP_PARM)
1329 && xmc_turn_off(SP_PARM,
1331 xmc_new(SP_PARM, lineno + 1, 0))))) {
1340 /* it may be cheap to clear leading whitespace with clr_bol */
1342 if (clr_bol && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1343 int oFirstChar, nFirstChar;
1345 for (oFirstChar = 0;
1346 oFirstChar < screen_columns(SP_PARM);
1348 if (!CharEq(oldLine[oFirstChar], blank))
1350 for (nFirstChar = 0;
1351 nFirstChar < screen_columns(SP_PARM);
1353 if (!CharEq(newLine[nFirstChar], blank))
1356 if (nFirstChar == oFirstChar) {
1357 firstChar = nFirstChar;
1358 /* find the first differing character */
1359 while (firstChar < screen_columns(SP_PARM)
1360 && CharEq(newLine[firstChar], oldLine[firstChar]))
1362 } else if (oFirstChar > nFirstChar) {
1363 firstChar = nFirstChar;
1364 } else { /* oFirstChar < nFirstChar */
1365 firstChar = oFirstChar;
1366 if (SP_PARM->_el1_cost < nFirstChar - oFirstChar) {
1367 if (nFirstChar >= screen_columns(SP_PARM)
1368 && SP_PARM->_el_cost <= SP_PARM->_el1_cost) {
1369 GoTo(NCURSES_SP_ARGx lineno, 0);
1370 UpdateAttrs(SP_PARM, blank);
1371 TPUTS_TRACE("clr_eol");
1372 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clr_eol);
1374 GoTo(NCURSES_SP_ARGx lineno, nFirstChar - 1);
1375 UpdateAttrs(SP_PARM, blank);
1376 TPUTS_TRACE("clr_bol");
1377 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clr_bol);
1380 while (firstChar < nFirstChar)
1381 oldLine[firstChar++] = blank;
1385 /* find the first differing character */
1386 while (firstChar < screen_columns(SP_PARM)
1387 && CharEq(newLine[firstChar], oldLine[firstChar]))
1390 /* if there wasn't one, we're done */
1391 if (firstChar >= screen_columns(SP_PARM)) {
1392 TR(TRACE_UPDATE, (T_RETURN("")));
1396 blank = newLine[screen_columns(SP_PARM) - 1];
1398 if (!can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1399 /* find the last differing character */
1400 nLastChar = screen_columns(SP_PARM) - 1;
1402 while (nLastChar > firstChar
1403 && CharEq(newLine[nLastChar], oldLine[nLastChar]))
1406 if (nLastChar >= firstChar) {
1407 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1408 PutRange(NCURSES_SP_ARGx
1414 memcpy(oldLine + firstChar,
1415 newLine + firstChar,
1416 (nLastChar - firstChar + 1) * sizeof(NCURSES_CH_T));
1418 TR(TRACE_UPDATE, (T_RETURN("")));
1422 /* find last non-blank character on old line */
1423 oLastChar = screen_columns(SP_PARM) - 1;
1424 while (oLastChar > firstChar && CharEq(oldLine[oLastChar], blank))
1427 /* find last non-blank character on new line */
1428 nLastChar = screen_columns(SP_PARM) - 1;
1429 while (nLastChar > firstChar && CharEq(newLine[nLastChar], blank))
1432 if ((nLastChar == firstChar)
1433 && (SP_PARM->_el_cost < (oLastChar - nLastChar))) {
1434 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1435 if (!CharEq(newLine[firstChar], blank))
1436 PutChar(NCURSES_SP_ARGx CHREF(newLine[firstChar]));
1437 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1438 } else if ((nLastChar != oLastChar)
1439 && (!CharEq(newLine[nLastChar], oldLine[oLastChar])
1440 || !(SP_PARM->_nc_sp_idcok
1441 && NCURSES_SP_NAME(has_ic) (NCURSES_SP_ARG)))) {
1442 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1443 if ((oLastChar - nLastChar) > SP_PARM->_el_cost) {
1444 if (PutRange(NCURSES_SP_ARGx
1450 GoTo(NCURSES_SP_ARGx lineno, nLastChar + 1);
1452 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1454 n = max(nLastChar, oLastChar);
1455 PutRange(NCURSES_SP_ARGx
1463 int nLastNonblank = nLastChar;
1464 int oLastNonblank = oLastChar;
1466 /* find the last characters that really differ */
1467 /* can be -1 if no characters differ */
1468 while (CharEq(newLine[nLastChar], oldLine[oLastChar])) {
1469 /* don't split a wide char */
1470 if (isWidecExt(newLine[nLastChar]) &&
1471 !CharEq(newLine[nLastChar - 1], oldLine[oLastChar - 1]))
1475 if (nLastChar == -1 || oLastChar == -1)
1479 n = min(oLastChar, nLastChar);
1480 if (n >= firstChar) {
1481 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1482 PutRange(NCURSES_SP_ARGx
1490 if (oLastChar < nLastChar) {
1491 int m = max(nLastNonblank, oLastNonblank);
1492 #if USE_WIDEC_SUPPORT
1493 while (isWidecExt(newLine[n + 1]) && n) {
1498 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1499 if ((nLastChar < nLastNonblank)
1500 || InsCharCost(SP_PARM, nLastChar - oLastChar) > (m - n)) {
1501 PutRange(NCURSES_SP_ARGx
1508 InsStr(NCURSES_SP_ARGx &newLine[n + 1], nLastChar - oLastChar);
1510 } else if (oLastChar > nLastChar) {
1511 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1512 if (DelCharCost(SP_PARM, oLastChar - nLastChar)
1513 > SP_PARM->_el_cost + nLastNonblank - (n + 1)) {
1514 if (PutRange(NCURSES_SP_ARGx oldLine, newLine, lineno,
1515 n + 1, nLastNonblank))
1516 GoTo(NCURSES_SP_ARGx lineno, nLastNonblank + 1);
1517 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1520 * The delete-char sequence will
1521 * effectively shift in blanks from the
1522 * right margin of the screen. Ensure
1523 * that they are the right color by
1524 * setting the video attributes from
1525 * the last character on the row.
1527 UpdateAttrs(SP_PARM, blank);
1528 DelChar(NCURSES_SP_ARGx oLastChar - nLastChar);
1534 /* update the code's internal representation */
1535 if (screen_columns(SP_PARM) > firstChar)
1536 memcpy(oldLine + firstChar,
1537 newLine + firstChar,
1538 (screen_columns(SP_PARM) - firstChar) * sizeof(NCURSES_CH_T));
1539 TR(TRACE_UPDATE, (T_RETURN("")));
1544 ** ClearScreen(blank)
1546 ** Clear the physical screen and put cursor at home
1551 ClearScreen(NCURSES_SP_DCLx NCURSES_CH_T blank)
1554 bool fast_clear = (clear_screen || clr_eos || clr_eol);
1556 TR(TRACE_UPDATE, ("ClearScreen() called"));
1558 #if NCURSES_EXT_FUNCS
1559 if (SP_PARM->_coloron
1560 && !SP_PARM->_default_color) {
1561 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
1562 GET_SCREEN_PAIR(SP_PARM),
1565 NCURSES_SP_NAME(_nc_outch));
1566 if (!back_color_erase) {
1574 UpdateAttrs(SP_PARM, blank);
1575 TPUTS_TRACE("clear_screen");
1576 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx clear_screen);
1577 SP_PARM->_cursrow = SP_PARM->_curscol = 0;
1578 position_check(SP_PARM,
1582 } else if (clr_eos) {
1583 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1584 GoTo(NCURSES_SP_ARGx 0, 0);
1585 UpdateAttrs(SP_PARM, blank);
1586 TPUTS_TRACE("clr_eos");
1587 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1589 screen_lines(SP_PARM),
1590 NCURSES_SP_NAME(_nc_outch));
1591 } else if (clr_eol) {
1592 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1593 UpdateAttrs(SP_PARM, blank);
1594 for (i = 0; i < screen_lines(SP_PARM); i++) {
1595 GoTo(NCURSES_SP_ARGx i, 0);
1596 TPUTS_TRACE("clr_eol");
1597 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx 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 TPUTS_TRACE("enter_insert_mode");
1649 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx enter_insert_mode);
1651 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1652 if (insert_padding) {
1653 TPUTS_TRACE("insert_padding");
1654 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_padding);
1659 TPUTS_TRACE("exit_insert_mode");
1660 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_insert_mode);
1663 TPUTS_TRACE("insert_character");
1664 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_character);
1665 PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1666 if (insert_padding) {
1667 TPUTS_TRACE("insert_padding");
1668 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_padding);
1674 position_check(SP_PARM, SP_PARM->_cursrow, SP_PARM->_curscol, "InsStr");
1680 ** Delete count characters at current position
1685 DelChar(NCURSES_SP_DCLx int count)
1689 TR(TRACE_UPDATE, ("DelChar(%p, %d) called, position = (%ld,%ld)",
1690 (void *) SP_PARM, count,
1691 (long) NewScreen(SP_PARM)->_cury,
1692 (long) NewScreen(SP_PARM)->_curx));
1695 TPUTS_TRACE("parm_dch");
1696 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1697 TPARM_1(parm_dch, count),
1699 NCURSES_SP_NAME(_nc_outch));
1701 for (n = 0; n < count; n++) {
1702 TPUTS_TRACE("delete_character");
1703 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_character);
1709 * Physical-scrolling support
1711 * This code was adapted from Keith Bostic's hardware scrolling
1712 * support for 4.4BSD curses. I (esr) translated it to use terminfo
1713 * capabilities, narrowed the call interface slightly, and cleaned
1714 * up some convoluted tests. I also added support for the memory_above
1715 * memory_below, and non_dest_scroll_region capabilities.
1717 * For this code to work, we must have either
1718 * change_scroll_region and scroll forward/reverse commands, or
1719 * insert and delete line capabilities.
1720 * When the scrolling region has been set, the cursor has to
1721 * be at the last line of the region to make the scroll up
1722 * happen, or on the first line of region to scroll down.
1724 * This code makes one aesthetic decision in the opposite way from
1725 * BSD curses. BSD curses preferred pairs of il/dl operations
1726 * over scrolls, allegedly because il/dl looked faster. We, on
1727 * the other hand, prefer scrolls because (a) they're just as fast
1728 * on many terminals and (b) using them avoids bouncing an
1729 * unchanged bottom section of the screen up and down, which is
1732 * (lav): added more cases, used dl/il when bot==maxy and in csr case.
1734 * I used assumption that capabilities il/il1/dl/dl1 work inside
1735 * changed scroll region not shifting screen contents outside of it.
1736 * If there are any terminals behaving different way, it would be
1737 * necessary to add some conditions to scroll_csr_forward/backward.
1740 /* Try to scroll up assuming given csr (miny, maxy). Returns ERR on failure */
1742 scroll_csr_forward(NCURSES_SP_DCLx
1752 if (n == 1 && scroll_forward && top == miny && bot == maxy) {
1753 GoTo(NCURSES_SP_ARGx bot, 0);
1754 UpdateAttrs(SP_PARM, blank);
1755 TPUTS_TRACE("scroll_forward");
1756 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx scroll_forward);
1757 } else if (n == 1 && delete_line && bot == maxy) {
1758 GoTo(NCURSES_SP_ARGx top, 0);
1759 UpdateAttrs(SP_PARM, blank);
1760 TPUTS_TRACE("delete_line");
1761 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1762 } else if (parm_index && top == miny && bot == maxy) {
1763 GoTo(NCURSES_SP_ARGx bot, 0);
1764 UpdateAttrs(SP_PARM, blank);
1765 TPUTS_TRACE("parm_index");
1766 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1767 TPARM_2(parm_index, n, 0),
1769 NCURSES_SP_NAME(_nc_outch));
1770 } else if (parm_delete_line && bot == maxy) {
1771 GoTo(NCURSES_SP_ARGx top, 0);
1772 UpdateAttrs(SP_PARM, blank);
1773 TPUTS_TRACE("parm_delete_line");
1774 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1775 TPARM_2(parm_delete_line, n, 0),
1777 NCURSES_SP_NAME(_nc_outch));
1778 } else if (scroll_forward && top == miny && bot == maxy) {
1779 GoTo(NCURSES_SP_ARGx bot, 0);
1780 UpdateAttrs(SP_PARM, blank);
1781 for (i = 0; i < n; i++) {
1782 TPUTS_TRACE("scroll_forward");
1783 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx scroll_forward);
1785 } else if (delete_line && bot == maxy) {
1786 GoTo(NCURSES_SP_ARGx top, 0);
1787 UpdateAttrs(SP_PARM, blank);
1788 for (i = 0; i < n; i++) {
1789 TPUTS_TRACE("delete_line");
1790 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1795 #if NCURSES_EXT_FUNCS
1796 if (FILL_BCE(SP_PARM)) {
1798 for (i = 0; i < n; i++) {
1799 GoTo(NCURSES_SP_ARGx bot - i, 0);
1800 for (j = 0; j < screen_columns(SP_PARM); j++)
1801 PutChar(NCURSES_SP_ARGx CHREF(blank));
1808 /* Try to scroll down assuming given csr (miny, maxy). Returns ERR on failure */
1811 scroll_csr_backward(NCURSES_SP_DCLx
1821 if (n == 1 && scroll_reverse && top == miny && bot == maxy) {
1822 GoTo(NCURSES_SP_ARGx top, 0);
1823 UpdateAttrs(SP_PARM, blank);
1824 TPUTS_TRACE("scroll_reverse");
1825 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx scroll_reverse);
1826 } else if (n == 1 && insert_line && bot == maxy) {
1827 GoTo(NCURSES_SP_ARGx top, 0);
1828 UpdateAttrs(SP_PARM, blank);
1829 TPUTS_TRACE("insert_line");
1830 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1831 } else if (parm_rindex && top == miny && bot == maxy) {
1832 GoTo(NCURSES_SP_ARGx top, 0);
1833 UpdateAttrs(SP_PARM, blank);
1834 TPUTS_TRACE("parm_rindex");
1835 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1836 TPARM_2(parm_rindex, n, 0),
1838 NCURSES_SP_NAME(_nc_outch));
1839 } else if (parm_insert_line && bot == maxy) {
1840 GoTo(NCURSES_SP_ARGx top, 0);
1841 UpdateAttrs(SP_PARM, blank);
1842 TPUTS_TRACE("parm_insert_line");
1843 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1844 TPARM_2(parm_insert_line, n, 0),
1846 NCURSES_SP_NAME(_nc_outch));
1847 } else if (scroll_reverse && top == miny && bot == maxy) {
1848 GoTo(NCURSES_SP_ARGx top, 0);
1849 UpdateAttrs(SP_PARM, blank);
1850 for (i = 0; i < n; i++) {
1851 TPUTS_TRACE("scroll_reverse");
1852 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx scroll_reverse);
1854 } else if (insert_line && bot == maxy) {
1855 GoTo(NCURSES_SP_ARGx top, 0);
1856 UpdateAttrs(SP_PARM, blank);
1857 for (i = 0; i < n; i++) {
1858 TPUTS_TRACE("insert_line");
1859 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1864 #if NCURSES_EXT_FUNCS
1865 if (FILL_BCE(SP_PARM)) {
1867 for (i = 0; i < n; i++) {
1868 GoTo(NCURSES_SP_ARGx top + i, 0);
1869 for (j = 0; j < screen_columns(SP_PARM); j++)
1870 PutChar(NCURSES_SP_ARGx CHREF(blank));
1877 /* scroll by using delete_line at del and insert_line at ins */
1880 scroll_idl(NCURSES_SP_DCLx int n, int del, int ins, NCURSES_CH_T blank)
1884 if (!((parm_delete_line || delete_line) && (parm_insert_line || insert_line)))
1887 GoTo(NCURSES_SP_ARGx del, 0);
1888 UpdateAttrs(SP_PARM, blank);
1889 if (n == 1 && delete_line) {
1890 TPUTS_TRACE("delete_line");
1891 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1892 } else if (parm_delete_line) {
1893 TPUTS_TRACE("parm_delete_line");
1894 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1895 TPARM_2(parm_delete_line, n, 0),
1897 NCURSES_SP_NAME(_nc_outch));
1898 } else { /* if (delete_line) */
1899 for (i = 0; i < n; i++) {
1900 TPUTS_TRACE("delete_line");
1901 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx delete_line);
1905 GoTo(NCURSES_SP_ARGx ins, 0);
1906 UpdateAttrs(SP_PARM, blank);
1907 if (n == 1 && insert_line) {
1908 TPUTS_TRACE("insert_line");
1909 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1910 } else if (parm_insert_line) {
1911 TPUTS_TRACE("parm_insert_line");
1912 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1913 TPARM_2(parm_insert_line, n, 0),
1915 NCURSES_SP_NAME(_nc_outch));
1916 } else { /* if (insert_line) */
1917 for (i = 0; i < n; i++) {
1918 TPUTS_TRACE("insert_line");
1919 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx insert_line);
1927 * Note: some terminals require the cursor to be within the scrolling margins
1928 * before setting them. Generally, the cursor must be at the appropriate end
1929 * of the scrolling margins when issuing an indexing operation (it is not
1930 * apparent whether it must also be at the left margin; we do this just to be
1931 * safe). To make the related cursor movement a little faster, we use the
1932 * save/restore cursor capabilities if the terminal has them.
1935 NCURSES_SP_NAME(_nc_scrolln) (NCURSES_SP_DCLx
1940 /* scroll region from top to bot by n lines */
1944 bool cursor_saved = FALSE;
1947 TR(TRACE_MOVE, ("_nc_scrolln(%p, %d, %d, %d, %d)",
1948 (void *) SP_PARM, n, top, bot, maxy));
1950 if (!IsValidScreen(SP_PARM))
1953 blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1957 * If we scroll, we might remove a cookie.
1959 if (magic_cookie_glitch > 0) {
1964 if (n > 0) { /* scroll up (forward) */
1966 * Explicitly clear if stuff pushed off top of region might
1967 * be saved by the terminal.
1969 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, 0, maxy, blank);
1971 if (res == ERR && change_scroll_region) {
1972 if ((((n == 1 && scroll_forward) || parm_index)
1973 && (SP_PARM->_cursrow == bot || SP_PARM->_cursrow == bot - 1))
1974 && save_cursor && restore_cursor) {
1975 cursor_saved = TRUE;
1976 TPUTS_TRACE("save_cursor");
1977 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx save_cursor);
1979 TPUTS_TRACE("change_scroll_region");
1980 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
1981 TPARM_2(change_scroll_region, top, bot));
1983 TPUTS_TRACE("restore_cursor");
1984 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx restore_cursor);
1986 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1989 res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, top, bot, blank);
1991 TPUTS_TRACE("change_scroll_region");
1992 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
1993 TPARM_2(change_scroll_region, 0, maxy));
1994 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1997 if (res == ERR && SP_PARM->_nc_sp_idlok)
1998 res = scroll_idl(NCURSES_SP_ARGx n, top, bot - n + 1, blank);
2001 * Clear the newly shifted-in text.
2004 && (non_dest_scroll_region || (memory_below && bot == maxy))) {
2005 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2006 if (bot == maxy && clr_eos) {
2007 GoTo(NCURSES_SP_ARGx bot - n + 1, 0);
2008 ClrToEOS(NCURSES_SP_ARGx blank2);
2010 for (i = 0; i < n; i++) {
2011 GoTo(NCURSES_SP_ARGx bot - i, 0);
2012 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2017 } else { /* (n < 0) - scroll down (backward) */
2018 res = scroll_csr_backward(NCURSES_SP_ARGx -n, top, bot, 0, maxy, blank);
2020 if (res == ERR && change_scroll_region) {
2022 && (SP_PARM->_cursrow == top ||
2023 SP_PARM->_cursrow == top - 1)
2024 && save_cursor && restore_cursor) {
2025 cursor_saved = TRUE;
2026 TPUTS_TRACE("save_cursor");
2027 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx save_cursor);
2029 TPUTS_TRACE("change_scroll_region");
2030 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
2031 TPARM_2(change_scroll_region, top, bot));
2033 TPUTS_TRACE("restore_cursor");
2034 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx restore_cursor);
2036 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2039 res = scroll_csr_backward(NCURSES_SP_ARGx
2040 -n, top, bot, top, bot, blank);
2042 TPUTS_TRACE("change_scroll_region");
2043 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
2044 TPARM_2(change_scroll_region, 0, maxy));
2045 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2048 if (res == ERR && SP_PARM->_nc_sp_idlok)
2049 res = scroll_idl(NCURSES_SP_ARGx -n, bot + n + 1, top, blank);
2052 * Clear the newly shifted-in text.
2055 && (non_dest_scroll_region || (memory_above && top == 0))) {
2056 static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2057 for (i = 0; i < -n; i++) {
2058 GoTo(NCURSES_SP_ARGx i + top, 0);
2059 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2067 _nc_scroll_window(CurScreen(SP_PARM), n, top, bot, blank);
2069 /* shift hash values too - they can be reused */
2070 NCURSES_SP_NAME(_nc_scroll_oldhash) (NCURSES_SP_ARGx n, top, bot);
2075 #if NCURSES_SP_FUNCS
2077 _nc_scrolln(int n, int top, int bot, int maxy)
2079 return NCURSES_SP_NAME(_nc_scrolln) (CURRENT_SCREEN, n, top, bot, maxy);
2083 NCURSES_EXPORT(void)
2084 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_DCL0)
2088 /* make sure terminal is in a sane known state */
2089 SetAttr(SCREEN_ATTRS(SP_PARM), A_NORMAL);
2090 NewScreen(SP_PARM)->_clear = TRUE;
2092 /* reset color pairs and definitions */
2093 if (SP_PARM->_coloron || SP_PARM->_color_defs)
2094 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2096 /* restore user-defined colors, if any */
2097 if (SP_PARM->_color_defs < 0) {
2099 SP_PARM->_color_defs = -(SP_PARM->_color_defs);
2100 for (n = 0; n < SP_PARM->_color_defs; ++n) {
2101 if (SP_PARM->_color_table[n].init) {
2102 NCURSES_SP_NAME(init_color) (NCURSES_SP_ARGx n,
2103 SP_PARM->_color_table[n].r,
2104 SP_PARM->_color_table[n].g,
2105 SP_PARM->_color_table[n].b);
2110 if (exit_attribute_mode)
2111 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_attribute_mode);
2113 /* turn off attributes */
2114 if (exit_alt_charset_mode)
2115 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_alt_charset_mode);
2116 if (exit_standout_mode)
2117 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_standout_mode);
2118 if (exit_underline_mode)
2119 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_underline_mode);
2121 if (exit_insert_mode)
2122 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx exit_insert_mode);
2123 if (enter_am_mode && exit_am_mode)
2124 NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx
2130 #if NCURSES_SP_FUNCS
2131 NCURSES_EXPORT(void)
2132 _nc_screen_resume(void)
2134 NCURSES_SP_NAME(_nc_screen_resume) (CURRENT_SCREEN);
2138 NCURSES_EXPORT(void)
2139 NCURSES_SP_NAME(_nc_screen_init) (NCURSES_SP_DCL0)
2141 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
2144 #if NCURSES_SP_FUNCS
2145 NCURSES_EXPORT(void)
2146 _nc_screen_init(void)
2148 NCURSES_SP_NAME(_nc_screen_init) (CURRENT_SCREEN);
2152 /* wrap up screen handling */
2153 NCURSES_EXPORT(void)
2154 NCURSES_SP_NAME(_nc_screen_wrap) (NCURSES_SP_DCL0)
2159 UpdateAttrs(SP_PARM, normal);
2160 #if NCURSES_EXT_FUNCS
2161 if (SP_PARM->_coloron
2162 && !SP_PARM->_default_color) {
2163 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
2164 SP_PARM->_default_color = TRUE;
2165 NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
2169 NCURSES_SP_NAME(_nc_outch));
2170 SP_PARM->_default_color = FALSE;
2172 TINFO_MVCUR(NCURSES_SP_ARGx
2175 screen_lines(SP_PARM) - 1,
2178 ClrToEOL(NCURSES_SP_ARGx blank, TRUE);
2181 if (SP_PARM->_color_defs) {
2182 NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2186 #if NCURSES_SP_FUNCS
2187 NCURSES_EXPORT(void)
2188 _nc_screen_wrap(void)
2190 NCURSES_SP_NAME(_nc_screen_wrap) (CURRENT_SCREEN);
2195 NCURSES_EXPORT(void)
2196 NCURSES_SP_NAME(_nc_do_xmc_glitch) (NCURSES_SP_DCLx attr_t previous)
2199 attr_t chg = XMC_CHANGES(previous ^ AttrOf(SCREEN_ATTRS(SP_PARM)));
2203 SP_PARM->_curscol += magic_cookie_glitch;
2204 if (SP_PARM->_curscol >= SP_PARM->_columns)
2205 wrap_cursor(NCURSES_SP_ARG);
2206 TR(TRACE_UPDATE, ("bumped to %d,%d after cookie",
2207 SP_PARM->_cursrow, SP_PARM->_curscol));
2214 #if NCURSES_SP_FUNCS
2215 NCURSES_EXPORT(void)
2216 _nc_do_xmc_glitch(attr_t previous)
2218 NCURSES_SP_NAME(_nc_do_xmc_glitch) (CURRENT_SCREEN, previous);
2222 #endif /* USE_XMC_SUPPORT */