ncurses 6.0 - patch 20161015
[ncurses.git] / ncurses / tty / tty_update.c
1 /****************************************************************************
2  * Copyright (c) 1998-2015,2016 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
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  ****************************************************************************/
35
36 /*-----------------------------------------------------------------
37  *
38  *      lib_doupdate.c
39  *
40  *      The routine doupdate() and its dependents.
41  *      All physical output is concentrated here (except _nc_outch()
42  *      in lib_tputs.c).
43  *
44  *-----------------------------------------------------------------*/
45
46 #include <curses.priv.h>
47
48 #ifndef CUR
49 #define CUR SP_TERMTYPE
50 #endif
51
52 #if defined __HAIKU__ && defined __BEOS__
53 #undef __BEOS__
54 #endif
55
56 #ifdef __BEOS__
57 #undef false
58 #undef true
59 #include <OS.h>
60 #endif
61
62 #if defined(TRACE) && HAVE_SYS_TIMES_H && HAVE_TIMES
63 #define USE_TRACE_TIMES 1
64 #else
65 #define USE_TRACE_TIMES 0
66 #endif
67
68 #if HAVE_SYS_TIME_H && HAVE_SYS_TIME_SELECT
69 #include <sys/time.h>
70 #endif
71
72 #if USE_TRACE_TIMES
73 #include <sys/times.h>
74 #endif
75
76 #if USE_FUNC_POLL
77 #elif HAVE_SELECT
78 #if HAVE_SYS_SELECT_H
79 #include <sys/select.h>
80 #endif
81 #endif
82
83 #include <ctype.h>
84
85 MODULE_ID("$Id: tty_update.c,v 1.284 2016/10/15 23:00:29 tom Exp $")
86
87 /*
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.
92  *
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.
95  */
96 #define CHECK_INTERVAL  5
97
98 #define FILL_BCE(sp) (sp->_coloron && !sp->_default_color && !back_color_erase)
99
100 static const NCURSES_CH_T blankchar = NewChar(BLANK_TEXT);
101 static NCURSES_CH_T normal = NewChar(BLANK_TEXT);
102
103 /*
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!
107  */
108 /* #define POSITION_DEBUG */
109
110 static NCURSES_INLINE NCURSES_CH_T ClrBlank(NCURSES_SP_DCLx WINDOW *win);
111
112 #if NCURSES_SP_FUNCS
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);
119 #else
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);
126 #endif
127
128 #ifdef POSITION_DEBUG
129 /****************************************************************************
130  *
131  * Debugging code.  Only works on ANSI-standard terminals.
132  *
133  ****************************************************************************/
134
135 static void
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 */
138 {
139     char buf[20];
140     char *s;
141     int y, x;
142
143     if (!_nc_tracing || (expected_y < 0 && expected_x < 0))
144         return;
145
146     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
147     memset(buf, '\0', sizeof(buf));
148     NCURSES_PUTP2_FLUSH("cpr", "\033[6n");      /* only works on ANSI-compatibles */
149     *(s = buf) = 0;
150     do {
151         int ask = sizeof(buf) - 1 - (s - buf);
152         int got = read(0, s, ask);
153         if (got == 0)
154             break;
155         s += got;
156     } while (strchr(buf, 'R') == 0);
157     _tracef("probe returned %s", _nc_visbuf(buf));
158
159     /* try to interpret as a position report */
160     if (sscanf(buf, "\033[%d;%dR", &y, &x) != 2) {
161         _tracef("position probe failed in %s", legend);
162     } else {
163         if (expected_x < 0)
164             expected_x = x - 1;
165         if (expected_y < 0)
166             expected_y = y - 1;
167         if (y - 1 != expected_y || x - 1 != expected_x) {
168             NCURSES_SP_NAME(beep) (NCURSES_SP_ARG);
169             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
170                                     tparm("\033[%d;%dH",
171                                           expected_y + 1,
172                                           expected_x + 1),
173                                     1, NCURSES_SP_NAME(_nc_outch));
174             _tracef("position seen (%d, %d) doesn't match expected one (%d, %d) in %s",
175                     y - 1, x - 1, expected_y, expected_x, legend);
176         } else {
177             _tracef("position matches OK in %s", legend);
178         }
179     }
180 }
181 #else
182 #define position_check(expected_y, expected_x, legend)  /* nothing */
183 #endif /* POSITION_DEBUG */
184
185 /****************************************************************************
186  *
187  * Optimized update code
188  *
189  ****************************************************************************/
190
191 static NCURSES_INLINE void
192 GoTo(NCURSES_SP_DCLx int const row, int const col)
193 {
194     TR(TRACE_MOVE, ("GoTo(%p, %d, %d) from (%d, %d)",
195                     (void *) SP_PARM, row, col, SP_PARM->_cursrow, SP_PARM->_curscol));
196
197     position_check(NCURSES_SP_ARGx
198                    SP_PARM->_cursrow,
199                    SP_PARM->_curscol, "GoTo");
200
201     TINFO_MVCUR(NCURSES_SP_ARGx
202                 SP_PARM->_cursrow,
203                 SP_PARM->_curscol,
204                 row, col);
205     position_check(NCURSES_SP_ARGx
206                    SP_PARM->_cursrow,
207                    SP_PARM->_curscol, "GoTo2");
208 }
209
210 #if !NCURSES_WCWIDTH_GRAPHICS
211 static bool
212 is_wacs_value(unsigned ch)
213 {
214     bool result;
215     switch (ch) {
216     case 0x00a3:                /* FALLTHRU - ncurses pound-sterling symbol */
217     case 0x00b0:                /* FALLTHRU - VT100 degree symbol */
218     case 0x00b1:                /* FALLTHRU - VT100 plus/minus */
219     case 0x00b7:                /* FALLTHRU - VT100 bullet */
220     case 0x03c0:                /* FALLTHRU - ncurses greek pi */
221     case 0x2190:                /* FALLTHRU - Teletype arrow pointing left */
222     case 0x2191:                /* FALLTHRU - Teletype arrow pointing up */
223     case 0x2192:                /* FALLTHRU - Teletype arrow pointing right */
224     case 0x2193:                /* FALLTHRU - Teletype arrow pointing down */
225     case 0x2260:                /* FALLTHRU - ncurses not-equal */
226     case 0x2264:                /* FALLTHRU - ncurses less-than-or-equal-to */
227     case 0x2265:                /* FALLTHRU - ncurses greater-than-or-equal-to */
228     case 0x23ba:                /* FALLTHRU - VT100 scan line 1 */
229     case 0x23bb:                /* FALLTHRU - ncurses scan line 3 */
230     case 0x23bc:                /* FALLTHRU - ncurses scan line 7 */
231     case 0x23bd:                /* FALLTHRU - VT100 scan line 9 */
232     case 0x2500:                /* FALLTHRU - VT100 horizontal line */
233     case 0x2501:                /* FALLTHRU - thick horizontal line */
234     case 0x2502:                /* FALLTHRU - VT100 vertical line */
235     case 0x2503:                /* FALLTHRU - thick vertical line */
236     case 0x250c:                /* FALLTHRU - VT100 upper left corner */
237     case 0x250f:                /* FALLTHRU - thick upper left corner */
238     case 0x2510:                /* FALLTHRU - VT100 upper right corner */
239     case 0x2513:                /* FALLTHRU - thick upper right corner */
240     case 0x2514:                /* FALLTHRU - VT100 lower left corner */
241     case 0x2517:                /* FALLTHRU - thick lower left corner */
242     case 0x2518:                /* FALLTHRU - VT100 lower right corner */
243     case 0x251b:                /* FALLTHRU - thick lower right corner */
244     case 0x251c:                /* FALLTHRU - VT100 tee pointing left */
245     case 0x2523:                /* FALLTHRU - thick tee pointing left */
246     case 0x2524:                /* FALLTHRU - VT100 tee pointing right */
247     case 0x252b:                /* FALLTHRU - thick tee pointing right */
248     case 0x252c:                /* FALLTHRU - VT100 tee pointing down */
249     case 0x2533:                /* FALLTHRU - thick tee pointing down */
250     case 0x2534:                /* FALLTHRU - VT100 tee pointing up */
251     case 0x253b:                /* FALLTHRU - thick tee pointing up */
252     case 0x253c:                /* FALLTHRU - VT100 large plus or crossover */
253     case 0x254b:                /* FALLTHRU - thick large plus or crossover */
254     case 0x2550:                /* FALLTHRU - double horizontal line */
255     case 0x2551:                /* FALLTHRU - double vertical line */
256     case 0x2554:                /* FALLTHRU - double upper left corner */
257     case 0x2557:                /* FALLTHRU - double upper right corner */
258     case 0x255a:                /* FALLTHRU - double lower left corner */
259     case 0x255d:                /* FALLTHRU - double lower right corner */
260     case 0x2560:                /* FALLTHRU - double tee pointing right */
261     case 0x2563:                /* FALLTHRU - double tee pointing left */
262     case 0x2566:                /* FALLTHRU - double tee pointing down */
263     case 0x2569:                /* FALLTHRU - double tee pointing up */
264     case 0x256c:                /* FALLTHRU - double large plus or crossover */
265     case 0x2592:                /* FALLTHRU - VT100 checker board (stipple) */
266     case 0x25ae:                /* FALLTHRU - Teletype solid square block */
267     case 0x25c6:                /* FALLTHRU - VT100 diamond */
268     case 0x2603:                /* FALLTHRU - Teletype lantern symbol */
269         result = TRUE;
270         break;
271     default:
272         result = FALSE;
273         break;
274     }
275     return result;
276 }
277 #endif
278
279 static NCURSES_INLINE void
280 PutAttrChar(NCURSES_SP_DCLx CARG_CH_T ch)
281 {
282     int chlen = 1;
283     NCURSES_CH_T my_ch;
284 #if USE_WIDEC_SUPPORT
285     PUTC_DATA;
286 #endif
287     NCURSES_CH_T tilde;
288     NCURSES_CH_T attr = CHDEREF(ch);
289
290     TR(TRACE_CHARPUT, ("PutAttrChar(%s) at (%d, %d)",
291                        _tracech_t(ch),
292                        SP_PARM->_cursrow, SP_PARM->_curscol));
293 #if USE_WIDEC_SUPPORT
294     /*
295      * If this is not a valid character, there is nothing more to do.
296      */
297     if (isWidecExt(CHDEREF(ch))) {
298         TR(TRACE_CHARPUT, ("...skip"));
299         return;
300     }
301     /*
302      * Determine the number of character cells which the 'ch' value will use
303      * on the screen.  It should be at least one.
304      */
305     if ((chlen = wcwidth(CharOf(CHDEREF(ch)))) <= 0) {
306         static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
307
308         /*
309          * If the character falls into any of these special cases, do
310          * not force the result to a blank:
311          *
312          * a) it is printable (this works around a bug in wcwidth()).
313          * b) use_legacy_coding() has been called to modify the treatment
314          *    of codes 128-255.
315          * c) the acs_map[] has been initialized to allow codes 0-31
316          *    to be rendered.  This supports Linux console's "PC"
317          *    characters.  Codes 128-255 are allowed though this is
318          *    not checked.
319          */
320         if (is8bits(CharOf(CHDEREF(ch)))
321             && (isprint(CharOf(CHDEREF(ch)))
322                 || (SP_PARM->_legacy_coding > 0 && CharOf(CHDEREF(ch)) >= 160)
323                 || (SP_PARM->_legacy_coding > 1 && CharOf(CHDEREF(ch)) >= 128)
324                 || (AttrOf(attr) & A_ALTCHARSET
325                     && ((CharOfD(ch) < ACS_LEN
326                          && SP_PARM->_acs_map != 0
327                          && SP_PARM->_acs_map[CharOfD(ch)] != 0)
328                         || (CharOfD(ch) >= 128))))) {
329             ;
330         } else {
331             ch = CHREF(blank);
332             TR(TRACE_CHARPUT, ("forced to blank"));
333         }
334         chlen = 1;
335     }
336 #endif
337
338     if ((AttrOf(attr) & A_ALTCHARSET)
339         && SP_PARM->_acs_map != 0
340         && ((CharOfD(ch) < ACS_LEN)
341 #if !NCURSES_WCWIDTH_GRAPHICS
342             || is_wacs_value(CharOfD(ch))
343 #endif
344         )) {
345         my_ch = CHDEREF(ch);    /* work around const param */
346 #if USE_WIDEC_SUPPORT
347         /*
348          * This is crude & ugly, but works most of the time.  It checks if the
349          * acs_chars string specified that we have a mapping for this
350          * character, and uses the wide-character mapping when we expect the
351          * normal one to be broken (by mis-design ;-).
352          */
353         if (SP_PARM->_screen_unicode
354             && _nc_wacs[CharOf(my_ch)].chars[0]) {
355             if (SP_PARM->_screen_acs_map[CharOf(my_ch)]) {
356                 if (SP_PARM->_screen_acs_fix) {
357                     RemAttr(attr, A_ALTCHARSET);
358                     my_ch = _nc_wacs[CharOf(my_ch)];
359                 }
360             } else {
361                 RemAttr(attr, A_ALTCHARSET);
362                 my_ch = _nc_wacs[CharOf(my_ch)];
363             }
364 #if !NCURSES_WCWIDTH_GRAPHICS
365             if (!(AttrOf(attr) & A_ALTCHARSET)) {
366                 chlen = 1;
367             }
368 #endif /* !NCURSES_WCWIDTH_GRAPHICS */
369         }
370 #endif
371         /*
372          * If we (still) have alternate character set, it is the normal 8bit
373          * flavor.  The _screen_acs_map[] array tells if the character was
374          * really in acs_chars, needed because of the way wide/normal line
375          * drawing flavors are integrated.
376          */
377         if (AttrOf(attr) & A_ALTCHARSET) {
378             int j = CharOfD(ch);
379             chtype temp = UChar(SP_PARM->_acs_map[j]);
380
381             if (temp != 0) {
382                 SetChar(my_ch, temp, AttrOf(attr));
383             } else {
384                 my_ch = CHDEREF(ch);
385                 RemAttr(attr, A_ALTCHARSET);
386             }
387         }
388         ch = CHREF(my_ch);
389     }
390 #if USE_WIDEC_SUPPORT && !NCURSES_WCWIDTH_GRAPHICS
391     else if (chlen > 1 && is_wacs_value(CharOfD(ch))) {
392         chlen = 1;
393     }
394 #endif
395     if (tilde_glitch && (CharOfD(ch) == L('~'))) {
396         SetChar(tilde, L('`'), AttrOf(attr));
397         ch = CHREF(tilde);
398     }
399
400     UpdateAttrs(SP_PARM, attr);
401     PUTC(CHDEREF(ch));
402 #if !USE_WIDEC_SUPPORT
403     COUNT_OUTCHARS(1);
404 #endif
405     SP_PARM->_curscol += chlen;
406     if (char_padding) {
407         NCURSES_PUTP2("char_padding", char_padding);
408     }
409 }
410
411 static bool
412 check_pending(NCURSES_SP_DCL0)
413 /* check for pending input */
414 {
415     bool have_pending = FALSE;
416
417     /*
418      * Only carry out this check when the flag is zero, otherwise we'll
419      * have the refreshing slow down drastically (or stop) if there's an
420      * unread character available.
421      */
422     if (SP_PARM->_fifohold != 0)
423         return FALSE;
424
425     if (SP_PARM->_checkfd >= 0) {
426 #if USE_FUNC_POLL
427         struct pollfd fds[1];
428         fds[0].fd = SP_PARM->_checkfd;
429         fds[0].events = POLLIN;
430         if (poll(fds, (size_t) 1, 0) > 0) {
431             have_pending = TRUE;
432         }
433 #elif defined(__BEOS__)
434         /*
435          * BeOS's select() is declared in socket.h, so the configure script does
436          * not see it.  That's just as well, since that function works only for
437          * sockets.  This (using snooze and ioctl) was distilled from Be's patch
438          * for ncurses which uses a separate thread to simulate select().
439          *
440          * FIXME: the return values from the ioctl aren't very clear if we get
441          * interrupted.
442          */
443         int n = 0;
444         int howmany = ioctl(0, 'ichr', &n);
445         if (howmany >= 0 && n > 0) {
446             have_pending = TRUE;
447         }
448 #elif HAVE_SELECT
449         fd_set fdset;
450         struct timeval ktimeout;
451
452         ktimeout.tv_sec =
453             ktimeout.tv_usec = 0;
454
455         FD_ZERO(&fdset);
456         FD_SET(SP_PARM->_checkfd, &fdset);
457         if (select(SP_PARM->_checkfd + 1, &fdset, NULL, NULL, &ktimeout) != 0) {
458             have_pending = TRUE;
459         }
460 #endif
461     }
462     if (have_pending) {
463         SP_PARM->_fifohold = 5;
464         NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
465     }
466     return FALSE;
467 }
468
469 /* put char at lower right corner */
470 static void
471 PutCharLR(NCURSES_SP_DCLx const ARG_CH_T ch)
472 {
473     if (!auto_right_margin) {
474         /* we can put the char directly */
475         PutAttrChar(NCURSES_SP_ARGx ch);
476     } else if (enter_am_mode && exit_am_mode) {
477         /* we can suppress automargin */
478         NCURSES_PUTP2("exit_am_mode", exit_am_mode);
479
480         PutAttrChar(NCURSES_SP_ARGx ch);
481         SP_PARM->_curscol--;
482         position_check(NCURSES_SP_ARGx
483                        SP_PARM->_cursrow,
484                        SP_PARM->_curscol,
485                        "exit_am_mode");
486
487         NCURSES_PUTP2("enter_am_mode", enter_am_mode);
488     } else if ((enter_insert_mode && exit_insert_mode)
489                || insert_character || parm_ich) {
490         GoTo(NCURSES_SP_ARGx
491              screen_lines(SP_PARM) - 1,
492              screen_columns(SP_PARM) - 2);
493         PutAttrChar(NCURSES_SP_ARGx ch);
494         GoTo(NCURSES_SP_ARGx
495              screen_lines(SP_PARM) - 1,
496              screen_columns(SP_PARM) - 2);
497         InsStr(NCURSES_SP_ARGx
498                NewScreen(SP_PARM)->_line[screen_lines(SP_PARM) - 1].text +
499                screen_columns(SP_PARM) - 2, 1);
500     }
501 }
502
503 /*
504  * Wrap the cursor position, i.e., advance to the beginning of the next line.
505  */
506 static void
507 wrap_cursor(NCURSES_SP_DCL0)
508 {
509     if (eat_newline_glitch) {
510         /*
511          * xenl can manifest two different ways.  The vt100 way is that, when
512          * you'd expect the cursor to wrap, it stays hung at the right margin
513          * (on top of the character just emitted) and doesn't wrap until the
514          * *next* graphic char is emitted.  The c100 way is to ignore LF
515          * received just after an am wrap.
516          *
517          * An aggressive way to handle this would be to emit CR/LF after the
518          * char and then assume the wrap is done, you're on the first position
519          * of the next line, and the terminal out of its weird state.  Here
520          * it's safe to just tell the code that the cursor is in hyperspace and
521          * let the next mvcur() call straighten things out.
522          */
523         SP_PARM->_curscol = -1;
524         SP_PARM->_cursrow = -1;
525     } else if (auto_right_margin) {
526         SP_PARM->_curscol = 0;
527         SP_PARM->_cursrow++;
528         /*
529          * We've actually moved - but may have to work around problems with
530          * video attributes not working.
531          */
532         if (!move_standout_mode && AttrOf(SCREEN_ATTRS(SP_PARM))) {
533             TR(TRACE_CHARPUT, ("turning off (%#lx) %s before wrapping",
534                                (unsigned long) AttrOf(SCREEN_ATTRS(SP_PARM)),
535                                _traceattr(AttrOf(SCREEN_ATTRS(SP_PARM)))));
536             (void) VIDATTR(SP_PARM, A_NORMAL, 0);
537         }
538     } else {
539         SP_PARM->_curscol--;
540     }
541     position_check(NCURSES_SP_ARGx
542                    SP_PARM->_cursrow,
543                    SP_PARM->_curscol,
544                    "wrap_cursor");
545 }
546
547 static NCURSES_INLINE void
548 PutChar(NCURSES_SP_DCLx const ARG_CH_T ch)
549 /* insert character, handling automargin stuff */
550 {
551     if (SP_PARM->_cursrow == screen_lines(SP_PARM) - 1 &&
552         SP_PARM->_curscol == screen_columns(SP_PARM) - 1) {
553         PutCharLR(NCURSES_SP_ARGx ch);
554     } else {
555         PutAttrChar(NCURSES_SP_ARGx ch);
556     }
557
558     if (SP_PARM->_curscol >= screen_columns(SP_PARM))
559         wrap_cursor(NCURSES_SP_ARG);
560
561     position_check(NCURSES_SP_ARGx
562                    SP_PARM->_cursrow,
563                    SP_PARM->_curscol, "PutChar");
564 }
565
566 /*
567  * Check whether the given character can be output by clearing commands.  This
568  * includes test for being a space and not including any 'bad' attributes, such
569  * as A_REVERSE.  All attribute flags which don't affect appearance of a space
570  * or can be output by clearing (A_COLOR in case of bce-terminal) are excluded.
571  */
572 static NCURSES_INLINE bool
573 can_clear_with(NCURSES_SP_DCLx ARG_CH_T ch)
574 {
575     if (!back_color_erase && SP_PARM->_coloron) {
576 #if NCURSES_EXT_FUNCS
577         int pair;
578
579         if (!SP_PARM->_default_color)
580             return FALSE;
581         if (SP_PARM->_default_fg != C_MASK || SP_PARM->_default_bg != C_MASK)
582             return FALSE;
583         if ((pair = GetPair(CHDEREF(ch))) != 0) {
584             NCURSES_COLOR_T fg, bg;
585             if (NCURSES_SP_NAME(pair_content) (NCURSES_SP_ARGx
586                                                (short) pair,
587                                                &fg, &bg) == ERR
588                 || (fg != C_MASK || bg != C_MASK)) {
589                 return FALSE;
590             }
591         }
592 #else
593         if (AttrOfD(ch) & A_COLOR)
594             return FALSE;
595 #endif
596     }
597     return (ISBLANK(CHDEREF(ch)) &&
598             (AttrOfD(ch) & ~(NONBLANK_ATTR | A_COLOR)) == BLANK_ATTR);
599 }
600
601 /*
602  * Issue a given span of characters from an array.
603  * Must be functionally equivalent to:
604  *      for (i = 0; i < num; i++)
605  *          PutChar(ntext[i]);
606  * but can leave the cursor positioned at the middle of the interval.
607  *
608  * Returns: 0 - cursor is at the end of interval
609  *          1 - cursor is somewhere in the middle
610  *
611  * This code is optimized using ech and rep.
612  */
613 static int
614 EmitRange(NCURSES_SP_DCLx const NCURSES_CH_T * ntext, int num)
615 {
616     int i;
617
618     TR(TRACE_CHARPUT, ("EmitRange %d:%s", num, _nc_viscbuf(ntext, num)));
619
620     if (erase_chars || repeat_char) {
621         while (num > 0) {
622             int runcount;
623             NCURSES_CH_T ntext0;
624
625             while (num > 1 && !CharEq(ntext[0], ntext[1])) {
626                 PutChar(NCURSES_SP_ARGx CHREF(ntext[0]));
627                 ntext++;
628                 num--;
629             }
630             ntext0 = ntext[0];
631             if (num == 1) {
632                 PutChar(NCURSES_SP_ARGx CHREF(ntext0));
633                 return 0;
634             }
635             runcount = 2;
636
637             while (runcount < num && CharEq(ntext[runcount], ntext0))
638                 runcount++;
639
640             /*
641              * The cost expression in the middle isn't exactly right.
642              * _cup_ch_cost is an upper bound on the cost for moving to the
643              * end of the erased area, but not the cost itself (which we
644              * can't compute without emitting the move).  This may result
645              * in erase_chars not getting used in some situations for
646              * which it would be marginally advantageous.
647              */
648             if (erase_chars
649                 && runcount > SP_PARM->_ech_cost + SP_PARM->_cup_ch_cost
650                 && can_clear_with(NCURSES_SP_ARGx CHREF(ntext0))) {
651                 UpdateAttrs(SP_PARM, ntext0);
652                 NCURSES_PUTP2("erase_chars", TPARM_1(erase_chars, runcount));
653
654                 /*
655                  * If this is the last part of the given interval,
656                  * don't bother moving cursor, since it can be the
657                  * last update on the line.
658                  */
659                 if (runcount < num) {
660                     GoTo(NCURSES_SP_ARGx
661                          SP_PARM->_cursrow,
662                          SP_PARM->_curscol + runcount);
663                 } else {
664                     return 1;   /* cursor stays in the middle */
665                 }
666             } else if (repeat_char && runcount > SP_PARM->_rep_cost) {
667                 bool wrap_possible = (SP_PARM->_curscol + runcount >=
668                                       screen_columns(SP_PARM));
669                 int rep_count = runcount;
670
671                 if (wrap_possible)
672                     rep_count--;
673
674                 UpdateAttrs(SP_PARM, ntext0);
675                 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
676                                         TPARM_2(repeat_char,
677                                                 CharOf(ntext0),
678                                                 rep_count),
679                                         1,
680                                         NCURSES_SP_NAME(_nc_outch));
681                 SP_PARM->_curscol += rep_count;
682
683                 if (wrap_possible)
684                     PutChar(NCURSES_SP_ARGx CHREF(ntext0));
685             } else {
686                 for (i = 0; i < runcount; i++)
687                     PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
688             }
689             ntext += runcount;
690             num -= runcount;
691         }
692         return 0;
693     }
694
695     for (i = 0; i < num; i++)
696         PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
697     return 0;
698 }
699
700 /*
701  * Output the line in the given range [first .. last]
702  *
703  * If there's a run of identical characters that's long enough to justify
704  * cursor movement, use that also.
705  *
706  * Returns: same as EmitRange
707  */
708 static int
709 PutRange(NCURSES_SP_DCLx
710          const NCURSES_CH_T * otext,
711          const NCURSES_CH_T * ntext,
712          int row,
713          int first, int last)
714 {
715     int rc;
716
717     TR(TRACE_CHARPUT, ("PutRange(%p, %p, %p, %d, %d, %d)",
718                        (void *) SP_PARM,
719                        (const void *) otext,
720                        (const void *) ntext,
721                        row, first, last));
722
723     if (otext != ntext
724         && (last - first + 1) > SP_PARM->_inline_cost) {
725         int i, j, same;
726
727         for (j = first, same = 0; j <= last; j++) {
728             if (!same && isWidecExt(otext[j]))
729                 continue;
730             if (CharEq(otext[j], ntext[j])) {
731                 same++;
732             } else {
733                 if (same > SP_PARM->_inline_cost) {
734                     EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
735                     GoTo(NCURSES_SP_ARGx row, first = j);
736                 }
737                 same = 0;
738             }
739         }
740         i = EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
741         /*
742          * Always return 1 for the next GoTo() after a PutRange() if we found
743          * identical characters at end of interval
744          */
745         rc = (same == 0 ? i : 1);
746     } else {
747         rc = EmitRange(NCURSES_SP_ARGx ntext + first, last - first + 1);
748     }
749     return rc;
750 }
751
752 /* leave unbracketed here so 'indent' works */
753 #define MARK_NOCHANGE(win,row) \
754                 win->_line[row].firstchar = _NOCHANGE; \
755                 win->_line[row].lastchar = _NOCHANGE; \
756                 if_USE_SCROLL_HINTS(win->_line[row].oldindex = row)
757
758 NCURSES_EXPORT(int)
759 TINFO_DOUPDATE(NCURSES_SP_DCL0)
760 {
761     int i;
762     int nonempty;
763 #if USE_TRACE_TIMES
764     struct tms before, after;
765 #endif /* USE_TRACE_TIMES */
766
767     T((T_CALLED("_nc_tinfo:doupdate(%p)"), (void *) SP_PARM));
768
769     if (SP_PARM == 0)
770         returnCode(ERR);
771
772 #if !USE_REENTRANT
773     /*
774      * It is "legal" but unlikely that an application could assign a new
775      * value to one of the standard windows.  Check for that possibility
776      * and try to recover.
777      *
778      * We do not allow applications to assign new values in the reentrant
779      * model.
780      */
781 #define SyncScreens(internal,exported) \
782         if (internal == 0) internal = exported; \
783         if (internal != exported) exported = internal
784
785     SyncScreens(CurScreen(SP_PARM), curscr);
786     SyncScreens(NewScreen(SP_PARM), newscr);
787     SyncScreens(StdScreen(SP_PARM), stdscr);
788 #endif
789
790     if (CurScreen(SP_PARM) == 0
791         || NewScreen(SP_PARM) == 0
792         || StdScreen(SP_PARM) == 0)
793         returnCode(ERR);
794
795 #ifdef TRACE
796     if (USE_TRACEF(TRACE_UPDATE)) {
797         if (CurScreen(SP_PARM)->_clear)
798             _tracef("curscr is clear");
799         else
800             _tracedump("curscr", CurScreen(SP_PARM));
801         _tracedump("newscr", NewScreen(SP_PARM));
802         _nc_unlock_global(tracef);
803     }
804 #endif /* TRACE */
805
806     _nc_signal_handler(FALSE);
807
808     if (SP_PARM->_fifohold)
809         SP_PARM->_fifohold--;
810
811 #if USE_SIZECHANGE
812     if (SP_PARM->_endwin || _nc_handle_sigwinch(SP_PARM)) {
813         /*
814          * This is a transparent extension:  XSI does not address it,
815          * and applications need not know that ncurses can do it.
816          *
817          * Check if the terminal size has changed while curses was off
818          * (this can happen in an xterm, for example), and resize the
819          * ncurses data structures accordingly.
820          */
821         _nc_update_screensize(SP_PARM);
822     }
823 #endif
824
825     if (SP_PARM->_endwin) {
826
827         T(("coming back from shell mode"));
828         NCURSES_SP_NAME(reset_prog_mode) (NCURSES_SP_ARG);
829
830         NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
831         NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
832         SP_PARM->_mouse_resume(SP_PARM);
833
834         SP_PARM->_endwin = FALSE;
835     }
836 #if USE_TRACE_TIMES
837     /* zero the metering machinery */
838     RESET_OUTCHARS();
839     (void) times(&before);
840 #endif /* USE_TRACE_TIMES */
841
842     /*
843      * This is the support for magic-cookie terminals.  The theory:  we scan
844      * the virtual screen looking for attribute turnons.  Where we find one,
845      * check to make sure it's realizable by seeing if the required number of
846      * un-attributed blanks are present before and after the attributed range;
847      * try to shift the range boundaries over blanks (not changing the screen
848      * display) so this becomes true.  If it is, shift the beginning attribute
849      * change appropriately (the end one, if we've gotten this far, is
850      * guaranteed room for its cookie).  If not, nuke the added attributes out
851      * of the span.
852      */
853 #if USE_XMC_SUPPORT
854     if (magic_cookie_glitch > 0) {
855         int j, k;
856         attr_t rattr = A_NORMAL;
857
858         for (i = 0; i < screen_lines(SP_PARM); i++) {
859             for (j = 0; j < screen_columns(SP_PARM); j++) {
860                 bool failed = FALSE;
861                 NCURSES_CH_T *thisline = NewScreen(SP_PARM)->_line[i].text;
862                 attr_t thisattr = AttrOf(thisline[j]) & SP_PARM->_xmc_triggers;
863                 attr_t turnon = thisattr & ~rattr;
864
865                 /* is an attribute turned on here? */
866                 if (turnon == 0) {
867                     rattr = thisattr;
868                     continue;
869                 }
870
871                 TR(TRACE_ATTRS, ("At (%d, %d): from %s...", i, j, _traceattr(rattr)));
872                 TR(TRACE_ATTRS, ("...to %s", _traceattr(turnon)));
873
874                 /*
875                  * If the attribute change location is a blank with a "safe"
876                  * attribute, undo the attribute turnon.  This may ensure
877                  * there's enough room to set the attribute before the first
878                  * non-blank in the run.
879                  */
880 #define SAFE(scr,a)     (!((a) & (scr)->_xmc_triggers))
881                 if (ISBLANK(thisline[j]) && SAFE(SP_PARM, turnon)) {
882                     RemAttr(thisline[j], turnon);
883                     continue;
884                 }
885
886                 /* check that there's enough room at start of span */
887                 for (k = 1; k <= magic_cookie_glitch; k++) {
888                     if (j - k < 0
889                         || !ISBLANK(thisline[j - k])
890                         || !SAFE(SP_PARM, AttrOf(thisline[j - k]))) {
891                         failed = TRUE;
892                         TR(TRACE_ATTRS, ("No room at start in %d,%d%s%s",
893                                          i, j - k,
894                                          (ISBLANK(thisline[j - k])
895                                           ? ""
896                                           : ":nonblank"),
897                                          (SAFE(SP_PARM, AttrOf(thisline[j - k]))
898                                           ? ""
899                                           : ":unsafe")));
900                         break;
901                     }
902                 }
903                 if (!failed) {
904                     bool end_onscreen = FALSE;
905                     int m, n = j;
906
907                     /* find end of span, if it's onscreen */
908                     for (m = i; m < screen_lines(SP_PARM); m++) {
909                         for (; n < screen_columns(SP_PARM); n++) {
910                             attr_t testattr =
911                             AttrOf(NewScreen(SP_PARM)->_line[m].text[n]);
912                             if ((testattr & SP_PARM->_xmc_triggers) == rattr) {
913                                 end_onscreen = TRUE;
914                                 TR(TRACE_ATTRS,
915                                    ("Range attributed with %s ends at (%d, %d)",
916                                     _traceattr(turnon), m, n));
917                                 goto foundit;
918                             }
919                         }
920                         n = 0;
921                     }
922                     TR(TRACE_ATTRS,
923                        ("Range attributed with %s ends offscreen",
924                         _traceattr(turnon)));
925                   foundit:;
926
927                     if (end_onscreen) {
928                         NCURSES_CH_T *lastline =
929                         NewScreen(SP_PARM)->_line[m].text;
930
931                         /*
932                          * If there are safely-attributed blanks at the end of
933                          * the range, shorten the range.  This will help ensure
934                          * that there is enough room at end of span.
935                          */
936                         while (n >= 0
937                                && ISBLANK(lastline[n])
938                                && SAFE(SP_PARM, AttrOf(lastline[n]))) {
939                             RemAttr(lastline[n--], turnon);
940                         }
941
942                         /* check that there's enough room at end of span */
943                         for (k = 1; k <= magic_cookie_glitch; k++) {
944                             if (n + k >= screen_columns(SP_PARM)
945                                 || !ISBLANK(lastline[n + k])
946                                 || !SAFE(SP_PARM, AttrOf(lastline[n + k]))) {
947                                 failed = TRUE;
948                                 TR(TRACE_ATTRS,
949                                    ("No room at end in %d,%d%s%s",
950                                     i, j - k,
951                                     (ISBLANK(lastline[n + k])
952                                      ? ""
953                                      : ":nonblank"),
954                                     (SAFE(SP_PARM, AttrOf(lastline[n + k]))
955                                      ? ""
956                                      : ":unsafe")));
957                                 break;
958                             }
959                         }
960                     }
961                 }
962
963                 if (failed) {
964                     int p, q = j;
965
966                     TR(TRACE_ATTRS,
967                        ("Clearing %s beginning at (%d, %d)",
968                         _traceattr(turnon), i, j));
969
970                     /* turn off new attributes over span */
971                     for (p = i; p < screen_lines(SP_PARM); p++) {
972                         for (; q < screen_columns(SP_PARM); q++) {
973                             attr_t testattr = AttrOf(newscr->_line[p].text[q]);
974                             if ((testattr & SP_PARM->_xmc_triggers) == rattr)
975                                 goto foundend;
976                             RemAttr(NewScreen(SP_PARM)->_line[p].text[q], turnon);
977                         }
978                         q = 0;
979                     }
980                   foundend:;
981                 } else {
982                     TR(TRACE_ATTRS,
983                        ("Cookie space for %s found before (%d, %d)",
984                         _traceattr(turnon), i, j));
985
986                     /*
987                      * Back up the start of range so there's room for cookies
988                      * before the first nonblank character.
989                      */
990                     for (k = 1; k <= magic_cookie_glitch; k++)
991                         AddAttr(thisline[j - k], turnon);
992                 }
993
994                 rattr = thisattr;
995             }
996         }
997
998 #ifdef TRACE
999         /* show altered highlights after magic-cookie check */
1000         if (USE_TRACEF(TRACE_UPDATE)) {
1001             _tracef("After magic-cookie check...");
1002             _tracedump("newscr", NewScreen(SP_PARM));
1003             _nc_unlock_global(tracef);
1004         }
1005 #endif /* TRACE */
1006     }
1007 #endif /* USE_XMC_SUPPORT */
1008
1009     nonempty = 0;
1010     if (CurScreen(SP_PARM)->_clear || NewScreen(SP_PARM)->_clear) {     /* force refresh ? */
1011         ClrUpdate(NCURSES_SP_ARG);
1012         CurScreen(SP_PARM)->_clear = FALSE;     /* reset flag */
1013         NewScreen(SP_PARM)->_clear = FALSE;     /* reset flag */
1014     } else {
1015         int changedlines = CHECK_INTERVAL;
1016
1017         if (check_pending(NCURSES_SP_ARG))
1018             goto cleanup;
1019
1020         nonempty = min(screen_lines(SP_PARM), NewScreen(SP_PARM)->_maxy + 1);
1021
1022         if (SP_PARM->_scrolling) {
1023             NCURSES_SP_NAME(_nc_scroll_optimize) (NCURSES_SP_ARG);
1024         }
1025
1026         nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1027
1028         TR(TRACE_UPDATE, ("Transforming lines, nonempty %d", nonempty));
1029         for (i = 0; i < nonempty; i++) {
1030             /*
1031              * Here is our line-breakout optimization.
1032              */
1033             if (changedlines == CHECK_INTERVAL) {
1034                 if (check_pending(NCURSES_SP_ARG))
1035                     goto cleanup;
1036                 changedlines = 0;
1037             }
1038
1039             /*
1040              * newscr->line[i].firstchar is normally set
1041              * by wnoutrefresh.  curscr->line[i].firstchar
1042              * is normally set by _nc_scroll_window in the
1043              * vertical-movement optimization code,
1044              */
1045             if (NewScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE
1046                 || CurScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE) {
1047                 TransformLine(NCURSES_SP_ARGx i);
1048                 changedlines++;
1049             }
1050
1051             /* mark line changed successfully */
1052             if (i <= NewScreen(SP_PARM)->_maxy) {
1053                 MARK_NOCHANGE(NewScreen(SP_PARM), i);
1054             }
1055             if (i <= CurScreen(SP_PARM)->_maxy) {
1056                 MARK_NOCHANGE(CurScreen(SP_PARM), i);
1057             }
1058         }
1059     }
1060
1061     /* put everything back in sync */
1062     for (i = nonempty; i <= NewScreen(SP_PARM)->_maxy; i++) {
1063         MARK_NOCHANGE(NewScreen(SP_PARM), i);
1064     }
1065     for (i = nonempty; i <= CurScreen(SP_PARM)->_maxy; i++) {
1066         MARK_NOCHANGE(CurScreen(SP_PARM), i);
1067     }
1068
1069     if (!NewScreen(SP_PARM)->_leaveok) {
1070         CurScreen(SP_PARM)->_curx = NewScreen(SP_PARM)->_curx;
1071         CurScreen(SP_PARM)->_cury = NewScreen(SP_PARM)->_cury;
1072
1073         GoTo(NCURSES_SP_ARGx CurScreen(SP_PARM)->_cury, CurScreen(SP_PARM)->_curx);
1074     }
1075
1076   cleanup:
1077     /*
1078      * We would like to keep the physical screen in normal mode in case we get
1079      * other processes writing to the screen.  This goal cannot be met for
1080      * magic cookies since it interferes with attributes that may propagate
1081      * past the current position.
1082      */
1083 #if USE_XMC_SUPPORT
1084     if (magic_cookie_glitch != 0)
1085 #endif
1086         UpdateAttrs(SP_PARM, normal);
1087
1088     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1089     WINDOW_ATTRS(CurScreen(SP_PARM)) = WINDOW_ATTRS(NewScreen(SP_PARM));
1090
1091 #if USE_TRACE_TIMES
1092     (void) times(&after);
1093     TR(TRACE_TIMES,
1094        ("Update cost: %ld chars, %ld clocks system time, %ld clocks user time",
1095         _nc_outchars,
1096         (long) (after.tms_stime - before.tms_stime),
1097         (long) (after.tms_utime - before.tms_utime)));
1098 #endif /* USE_TRACE_TIMES */
1099
1100     _nc_signal_handler(TRUE);
1101
1102     returnCode(OK);
1103 }
1104
1105 #if NCURSES_SP_FUNCS && !defined(USE_TERM_DRIVER)
1106 NCURSES_EXPORT(int)
1107 doupdate(void)
1108 {
1109     return TINFO_DOUPDATE(CURRENT_SCREEN);
1110 }
1111 #endif
1112
1113 /*
1114  *      ClrBlank(win)
1115  *
1116  *      Returns the attributed character that corresponds to the "cleared"
1117  *      screen.  If the terminal has the back-color-erase feature, this will be
1118  *      colored according to the wbkgd() call.
1119  *
1120  *      We treat 'curscr' specially because it isn't supposed to be set directly
1121  *      in the wbkgd() call.  Assume 'stdscr' for this case.
1122  */
1123 #define BCE_ATTRS (A_NORMAL|A_COLOR)
1124 #define BCE_BKGD(sp,win) (((win) == CurScreen(sp) ? StdScreen(sp) : (win))->_nc_bkgd)
1125
1126 static NCURSES_INLINE NCURSES_CH_T
1127 ClrBlank(NCURSES_SP_DCLx WINDOW *win)
1128 {
1129     NCURSES_CH_T blank = blankchar;
1130     if (back_color_erase)
1131         AddAttr(blank, (AttrOf(BCE_BKGD(SP_PARM, win)) & BCE_ATTRS));
1132     return blank;
1133 }
1134
1135 /*
1136 **      ClrUpdate()
1137 **
1138 **      Update by clearing and redrawing the entire screen.
1139 **
1140 */
1141
1142 static void
1143 ClrUpdate(NCURSES_SP_DCL0)
1144 {
1145     TR(TRACE_UPDATE, (T_CALLED("ClrUpdate")));
1146     if (0 != SP_PARM) {
1147         int i;
1148         NCURSES_CH_T blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1149         int nonempty = min(screen_lines(SP_PARM),
1150                            NewScreen(SP_PARM)->_maxy + 1);
1151
1152         ClearScreen(NCURSES_SP_ARGx blank);
1153
1154         TR(TRACE_UPDATE, ("updating screen from scratch"));
1155
1156         nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1157
1158         for (i = 0; i < nonempty; i++)
1159             TransformLine(NCURSES_SP_ARGx i);
1160     }
1161     TR(TRACE_UPDATE, (T_RETURN("")));
1162 }
1163
1164 /*
1165 **      ClrToEOL(blank)
1166 **
1167 **      Clear to end of current line, starting at the cursor position
1168 */
1169
1170 static void
1171 ClrToEOL(NCURSES_SP_DCLx NCURSES_CH_T blank, int needclear)
1172 {
1173     if (CurScreen(SP_PARM) != 0
1174         && SP_PARM->_cursrow >= 0) {
1175         int j;
1176
1177         for (j = SP_PARM->_curscol; j < screen_columns(SP_PARM); j++) {
1178             if (j >= 0) {
1179                 NCURSES_CH_T *cp =
1180                 &(CurScreen(SP_PARM)->_line[SP_PARM->_cursrow].text[j]);
1181
1182                 if (!CharEq(*cp, blank)) {
1183                     *cp = blank;
1184                     needclear = TRUE;
1185                 }
1186             }
1187         }
1188     }
1189
1190     if (needclear) {
1191         UpdateAttrs(SP_PARM, blank);
1192         if (clr_eol && SP_PARM->_el_cost <= (screen_columns(SP_PARM) - SP_PARM->_curscol)) {
1193             NCURSES_PUTP2("clr_eol", clr_eol);
1194         } else {
1195             int count = (screen_columns(SP_PARM) - SP_PARM->_curscol);
1196             while (count-- > 0)
1197                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1198         }
1199     }
1200 }
1201
1202 /*
1203 **      ClrToEOS(blank)
1204 **
1205 **      Clear to end of screen, starting at the cursor position
1206 */
1207
1208 static void
1209 ClrToEOS(NCURSES_SP_DCLx NCURSES_CH_T blank)
1210 {
1211     int row, col;
1212
1213     row = SP_PARM->_cursrow;
1214     col = SP_PARM->_curscol;
1215
1216     if (row < 0)
1217         row = 0;
1218     if (col < 0)
1219         col = 0;
1220
1221     UpdateAttrs(SP_PARM, blank);
1222     TPUTS_TRACE("clr_eos");
1223     NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1224                             clr_eos,
1225                             screen_lines(SP_PARM) - row,
1226                             NCURSES_SP_NAME(_nc_outch));
1227
1228     while (col < screen_columns(SP_PARM))
1229         CurScreen(SP_PARM)->_line[row].text[col++] = blank;
1230
1231     for (row++; row < screen_lines(SP_PARM); row++) {
1232         for (col = 0; col < screen_columns(SP_PARM); col++)
1233             CurScreen(SP_PARM)->_line[row].text[col] = blank;
1234     }
1235 }
1236
1237 /*
1238  *      ClrBottom(total)
1239  *
1240  *      Test if clearing the end of the screen would satisfy part of the
1241  *      screen-update.  Do this by scanning backwards through the lines in the
1242  *      screen, checking if each is blank, and one or more are changed.
1243  */
1244 static int
1245 ClrBottom(NCURSES_SP_DCLx int total)
1246 {
1247     int top = total;
1248     int last = min(screen_columns(SP_PARM), NewScreen(SP_PARM)->_maxx + 1);
1249     NCURSES_CH_T blank = NewScreen(SP_PARM)->_line[total - 1].text[last - 1];
1250
1251     if (clr_eos && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1252         int row;
1253
1254         for (row = total - 1; row >= 0; row--) {
1255             int col;
1256             bool ok;
1257
1258             for (col = 0, ok = TRUE; ok && col < last; col++) {
1259                 ok = (CharEq(NewScreen(SP_PARM)->_line[row].text[col], blank));
1260             }
1261             if (!ok)
1262                 break;
1263
1264             for (col = 0; ok && col < last; col++) {
1265                 ok = (CharEq(CurScreen(SP_PARM)->_line[row].text[col], blank));
1266             }
1267             if (!ok)
1268                 top = row;
1269         }
1270
1271         /* don't use clr_eos for just one line if clr_eol available */
1272         if (top < total) {
1273             GoTo(NCURSES_SP_ARGx top, 0);
1274             ClrToEOS(NCURSES_SP_ARGx blank);
1275             if (SP_PARM->oldhash && SP_PARM->newhash) {
1276                 for (row = top; row < screen_lines(SP_PARM); row++)
1277                     SP_PARM->oldhash[row] = SP_PARM->newhash[row];
1278             }
1279         }
1280     }
1281     return top;
1282 }
1283
1284 #if USE_XMC_SUPPORT
1285 #if USE_WIDEC_SUPPORT
1286 #define check_xmc_transition(sp, a, b)                                  \
1287     ((((a)->attr ^ (b)->attr) & ~((a)->attr) & (sp)->_xmc_triggers) != 0)
1288 #define xmc_turn_on(sp,a,b) check_xmc_transition(sp,&(a), &(b))
1289 #else
1290 #define xmc_turn_on(sp,a,b) ((((a)^(b)) & ~(a) & (sp)->_xmc_triggers) != 0)
1291 #endif
1292
1293 #define xmc_new(sp,r,c) NewScreen(sp)->_line[r].text[c]
1294 #define xmc_turn_off(sp,a,b) xmc_turn_on(sp,b,a)
1295 #endif /* USE_XMC_SUPPORT */
1296
1297 /*
1298 **      TransformLine(lineno)
1299 **
1300 **      Transform the given line in curscr to the one in newscr, using
1301 **      Insert/Delete Character if idcok && has_ic().
1302 **
1303 **              firstChar = position of first different character in line
1304 **              oLastChar = position of last different character in old line
1305 **              nLastChar = position of last different character in new line
1306 **
1307 **              move to firstChar
1308 **              overwrite chars up to min(oLastChar, nLastChar)
1309 **              if oLastChar < nLastChar
1310 **                      insert newLine[oLastChar+1..nLastChar]
1311 **              else
1312 **                      delete oLastChar - nLastChar spaces
1313 */
1314
1315 static void
1316 TransformLine(NCURSES_SP_DCLx int const lineno)
1317 {
1318     int firstChar, oLastChar, nLastChar;
1319     NCURSES_CH_T *newLine = NewScreen(SP_PARM)->_line[lineno].text;
1320     NCURSES_CH_T *oldLine = CurScreen(SP_PARM)->_line[lineno].text;
1321     int n;
1322     bool attrchanged = FALSE;
1323
1324     TR(TRACE_UPDATE, (T_CALLED("TransformLine(%p, %d)"), (void *) SP_PARM, lineno));
1325
1326     /* copy new hash value to old one */
1327     if (SP_PARM->oldhash && SP_PARM->newhash)
1328         SP_PARM->oldhash[lineno] = SP_PARM->newhash[lineno];
1329
1330     /*
1331      * If we have colors, there is the possibility of having two color pairs
1332      * that display as the same colors.  For instance, Lynx does this.  Check
1333      * for this case, and update the old line with the new line's colors when
1334      * they are equivalent.
1335      */
1336     if (SP_PARM->_coloron) {
1337         int oldPair;
1338         int newPair;
1339
1340         for (n = 0; n < screen_columns(SP_PARM); n++) {
1341             if (!CharEq(newLine[n], oldLine[n])) {
1342                 oldPair = GetPair(oldLine[n]);
1343                 newPair = GetPair(newLine[n]);
1344                 if (oldPair != newPair
1345                     && unColor(oldLine[n]) == unColor(newLine[n])) {
1346                     if (oldPair < SP_PARM->_pair_limit
1347                         && newPair < SP_PARM->_pair_limit
1348                         && (SP_PARM->_color_pairs[oldPair] ==
1349                             SP_PARM->_color_pairs[newPair])) {
1350                         SetPair(oldLine[n], GetPair(newLine[n]));
1351                     }
1352                 }
1353             }
1354         }
1355     }
1356
1357     if (ceol_standout_glitch && clr_eol) {
1358         firstChar = 0;
1359         while (firstChar < screen_columns(SP_PARM)) {
1360             if (!SameAttrOf(newLine[firstChar], oldLine[firstChar])) {
1361                 attrchanged = TRUE;
1362                 break;
1363             }
1364             firstChar++;
1365         }
1366     }
1367
1368     firstChar = 0;
1369
1370     if (attrchanged) {          /* we may have to disregard the whole line */
1371         GoTo(NCURSES_SP_ARGx lineno, firstChar);
1372         ClrToEOL(NCURSES_SP_ARGx
1373                  ClrBlank(NCURSES_SP_ARGx
1374                           CurScreen(SP_PARM)), FALSE);
1375         PutRange(NCURSES_SP_ARGx
1376                  oldLine, newLine, lineno, 0,
1377                  screen_columns(SP_PARM) - 1);
1378 #if USE_XMC_SUPPORT
1379
1380         /*
1381          * This is a very simple loop to paint characters which may have the
1382          * magic cookie glitch embedded.  It doesn't know much about video
1383          * attributes which are continued from one line to the next.  It
1384          * assumes that we have filtered out requests for attribute changes
1385          * that do not get mapped to blank positions.
1386          *
1387          * FIXME: we are not keeping track of where we put the cookies, so this
1388          * will work properly only once, since we may overwrite a cookie in a
1389          * following operation.
1390          */
1391     } else if (magic_cookie_glitch > 0) {
1392         GoTo(NCURSES_SP_ARGx lineno, firstChar);
1393         for (n = 0; n < screen_columns(SP_PARM); n++) {
1394             int m = n + magic_cookie_glitch;
1395
1396             /* check for turn-on:
1397              * If we are writing an attributed blank, where the
1398              * previous cell is not attributed.
1399              */
1400             if (ISBLANK(newLine[n])
1401                 && ((n > 0
1402                      && xmc_turn_on(SP_PARM, newLine[n - 1], newLine[n]))
1403                     || (n == 0
1404                         && lineno > 0
1405                         && xmc_turn_on(SP_PARM,
1406                                        xmc_new(SP_PARM, lineno - 1,
1407                                                screen_columns(SP_PARM) - 1),
1408                                        newLine[n])))) {
1409                 n = m;
1410             }
1411
1412             PutChar(NCURSES_SP_ARGx CHREF(newLine[n]));
1413
1414             /* check for turn-off:
1415              * If we are writing an attributed non-blank, where the
1416              * next cell is blank, and not attributed.
1417              */
1418             if (!ISBLANK(newLine[n])
1419                 && ((n + 1 < screen_columns(SP_PARM)
1420                      && xmc_turn_off(SP_PARM, newLine[n], newLine[n + 1]))
1421                     || (n + 1 >= screen_columns(SP_PARM)
1422                         && lineno + 1 < screen_lines(SP_PARM)
1423                         && xmc_turn_off(SP_PARM,
1424                                         newLine[n],
1425                                         xmc_new(SP_PARM, lineno + 1, 0))))) {
1426                 n = m;
1427             }
1428
1429         }
1430 #endif
1431     } else {
1432         NCURSES_CH_T blank;
1433
1434         /* it may be cheap to clear leading whitespace with clr_bol */
1435         blank = newLine[0];
1436         if (clr_bol && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1437             int oFirstChar, nFirstChar;
1438
1439             for (oFirstChar = 0;
1440                  oFirstChar < screen_columns(SP_PARM);
1441                  oFirstChar++)
1442                 if (!CharEq(oldLine[oFirstChar], blank))
1443                     break;
1444             for (nFirstChar = 0;
1445                  nFirstChar < screen_columns(SP_PARM);
1446                  nFirstChar++)
1447                 if (!CharEq(newLine[nFirstChar], blank))
1448                     break;
1449
1450             if (nFirstChar == oFirstChar) {
1451                 firstChar = nFirstChar;
1452                 /* find the first differing character */
1453                 while (firstChar < screen_columns(SP_PARM)
1454                        && CharEq(newLine[firstChar], oldLine[firstChar]))
1455                     firstChar++;
1456             } else if (oFirstChar > nFirstChar) {
1457                 firstChar = nFirstChar;
1458             } else {            /* oFirstChar < nFirstChar */
1459                 firstChar = oFirstChar;
1460                 if (SP_PARM->_el1_cost < nFirstChar - oFirstChar) {
1461                     if (nFirstChar >= screen_columns(SP_PARM)
1462                         && SP_PARM->_el_cost <= SP_PARM->_el1_cost) {
1463                         GoTo(NCURSES_SP_ARGx lineno, 0);
1464                         UpdateAttrs(SP_PARM, blank);
1465                         NCURSES_PUTP2("clr_eol", clr_eol);
1466                     } else {
1467                         GoTo(NCURSES_SP_ARGx lineno, nFirstChar - 1);
1468                         UpdateAttrs(SP_PARM, blank);
1469                         NCURSES_PUTP2("clr_bol", clr_bol);
1470                     }
1471
1472                     while (firstChar < nFirstChar)
1473                         oldLine[firstChar++] = blank;
1474                 }
1475             }
1476         } else {
1477             /* find the first differing character */
1478             while (firstChar < screen_columns(SP_PARM)
1479                    && CharEq(newLine[firstChar], oldLine[firstChar]))
1480                 firstChar++;
1481         }
1482         /* if there wasn't one, we're done */
1483         if (firstChar >= screen_columns(SP_PARM)) {
1484             TR(TRACE_UPDATE, (T_RETURN("")));
1485             return;
1486         }
1487
1488         blank = newLine[screen_columns(SP_PARM) - 1];
1489
1490         if (!can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1491             /* find the last differing character */
1492             nLastChar = screen_columns(SP_PARM) - 1;
1493
1494             while (nLastChar > firstChar
1495                    && CharEq(newLine[nLastChar], oldLine[nLastChar]))
1496                 nLastChar--;
1497
1498             if (nLastChar >= firstChar) {
1499                 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1500                 PutRange(NCURSES_SP_ARGx
1501                          oldLine,
1502                          newLine,
1503                          lineno,
1504                          firstChar,
1505                          nLastChar);
1506                 memcpy(oldLine + firstChar,
1507                        newLine + firstChar,
1508                        (unsigned) (nLastChar - firstChar + 1) * sizeof(NCURSES_CH_T));
1509             }
1510             TR(TRACE_UPDATE, (T_RETURN("")));
1511             return;
1512         }
1513
1514         /* find last non-blank character on old line */
1515         oLastChar = screen_columns(SP_PARM) - 1;
1516         while (oLastChar > firstChar && CharEq(oldLine[oLastChar], blank))
1517             oLastChar--;
1518
1519         /* find last non-blank character on new line */
1520         nLastChar = screen_columns(SP_PARM) - 1;
1521         while (nLastChar > firstChar && CharEq(newLine[nLastChar], blank))
1522             nLastChar--;
1523
1524         if ((nLastChar == firstChar)
1525             && (SP_PARM->_el_cost < (oLastChar - nLastChar))) {
1526             GoTo(NCURSES_SP_ARGx lineno, firstChar);
1527             if (!CharEq(newLine[firstChar], blank))
1528                 PutChar(NCURSES_SP_ARGx CHREF(newLine[firstChar]));
1529             ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1530         } else if ((nLastChar != oLastChar)
1531                    && (!CharEq(newLine[nLastChar], oldLine[oLastChar])
1532                        || !(SP_PARM->_nc_sp_idcok
1533                             && NCURSES_SP_NAME(has_ic) (NCURSES_SP_ARG)))) {
1534             GoTo(NCURSES_SP_ARGx lineno, firstChar);
1535             if ((oLastChar - nLastChar) > SP_PARM->_el_cost) {
1536                 if (PutRange(NCURSES_SP_ARGx
1537                              oldLine,
1538                              newLine,
1539                              lineno,
1540                              firstChar,
1541                              nLastChar)) {
1542                     GoTo(NCURSES_SP_ARGx lineno, nLastChar + 1);
1543                 }
1544                 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1545             } else {
1546                 n = max(nLastChar, oLastChar);
1547                 PutRange(NCURSES_SP_ARGx
1548                          oldLine,
1549                          newLine,
1550                          lineno,
1551                          firstChar,
1552                          n);
1553             }
1554         } else {
1555             int nLastNonblank = nLastChar;
1556             int oLastNonblank = oLastChar;
1557
1558             /* find the last characters that really differ */
1559             /* can be -1 if no characters differ */
1560             while (CharEq(newLine[nLastChar], oldLine[oLastChar])) {
1561                 /* don't split a wide char */
1562                 if (isWidecExt(newLine[nLastChar]) &&
1563                     !CharEq(newLine[nLastChar - 1], oldLine[oLastChar - 1]))
1564                     break;
1565                 nLastChar--;
1566                 oLastChar--;
1567                 if (nLastChar == -1 || oLastChar == -1)
1568                     break;
1569             }
1570
1571             n = min(oLastChar, nLastChar);
1572             if (n >= firstChar) {
1573                 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1574                 PutRange(NCURSES_SP_ARGx
1575                          oldLine,
1576                          newLine,
1577                          lineno,
1578                          firstChar,
1579                          n);
1580             }
1581
1582             if (oLastChar < nLastChar) {
1583                 int m = max(nLastNonblank, oLastNonblank);
1584 #if USE_WIDEC_SUPPORT
1585                 if (n) {
1586                     while (isWidecExt(newLine[n + 1]) && n) {
1587                         --n;
1588                         --oLastChar;    /* increase cost */
1589                     }
1590                 } else if (n >= firstChar &&
1591                            isWidecBase(newLine[n])) {
1592                     while (isWidecExt(newLine[n + 1])) {
1593                         ++n;
1594                         ++oLastChar;    /* decrease cost */
1595                     }
1596                 }
1597 #endif
1598                 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1599                 if ((nLastChar < nLastNonblank)
1600                     || InsCharCost(SP_PARM, nLastChar - oLastChar) > (m - n)) {
1601                     PutRange(NCURSES_SP_ARGx
1602                              oldLine,
1603                              newLine,
1604                              lineno,
1605                              n + 1,
1606                              m);
1607                 } else {
1608                     InsStr(NCURSES_SP_ARGx &newLine[n + 1], nLastChar - oLastChar);
1609                 }
1610             } else if (oLastChar > nLastChar) {
1611                 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1612                 if (DelCharCost(SP_PARM, oLastChar - nLastChar)
1613                     > SP_PARM->_el_cost + nLastNonblank - (n + 1)) {
1614                     if (PutRange(NCURSES_SP_ARGx oldLine, newLine, lineno,
1615                                  n + 1, nLastNonblank)) {
1616                         GoTo(NCURSES_SP_ARGx lineno, nLastNonblank + 1);
1617                     }
1618                     ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1619                 } else {
1620                     /*
1621                      * The delete-char sequence will
1622                      * effectively shift in blanks from the
1623                      * right margin of the screen.  Ensure
1624                      * that they are the right color by
1625                      * setting the video attributes from
1626                      * the last character on the row.
1627                      */
1628                     UpdateAttrs(SP_PARM, blank);
1629                     DelChar(NCURSES_SP_ARGx oLastChar - nLastChar);
1630                 }
1631             }
1632         }
1633     }
1634
1635     /* update the code's internal representation */
1636     if (screen_columns(SP_PARM) > firstChar)
1637         memcpy(oldLine + firstChar,
1638                newLine + firstChar,
1639                (unsigned) (screen_columns(SP_PARM) - firstChar) * sizeof(NCURSES_CH_T));
1640     TR(TRACE_UPDATE, (T_RETURN("")));
1641     return;
1642 }
1643
1644 /*
1645 **      ClearScreen(blank)
1646 **
1647 **      Clear the physical screen and put cursor at home
1648 **
1649 */
1650
1651 static void
1652 ClearScreen(NCURSES_SP_DCLx NCURSES_CH_T blank)
1653 {
1654     int i, j;
1655     bool fast_clear = (clear_screen || clr_eos || clr_eol);
1656
1657     TR(TRACE_UPDATE, ("ClearScreen() called"));
1658
1659 #if NCURSES_EXT_FUNCS
1660     if (SP_PARM->_coloron
1661         && !SP_PARM->_default_color) {
1662         NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
1663                                        (short) GET_SCREEN_PAIR(SP_PARM),
1664                                        0,
1665                                        FALSE,
1666                                        NCURSES_SP_NAME(_nc_outch));
1667         if (!back_color_erase) {
1668             fast_clear = FALSE;
1669         }
1670     }
1671 #endif
1672
1673     if (fast_clear) {
1674         if (clear_screen) {
1675             UpdateAttrs(SP_PARM, blank);
1676             NCURSES_PUTP2("clear_screen", clear_screen);
1677             SP_PARM->_cursrow = SP_PARM->_curscol = 0;
1678             position_check(NCURSES_SP_ARGx
1679                            SP_PARM->_cursrow,
1680                            SP_PARM->_curscol,
1681                            "ClearScreen");
1682         } else if (clr_eos) {
1683             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1684             GoTo(NCURSES_SP_ARGx 0, 0);
1685             UpdateAttrs(SP_PARM, blank);
1686             TPUTS_TRACE("clr_eos");
1687             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1688                                     clr_eos,
1689                                     screen_lines(SP_PARM),
1690                                     NCURSES_SP_NAME(_nc_outch));
1691         } else if (clr_eol) {
1692             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1693             UpdateAttrs(SP_PARM, blank);
1694             for (i = 0; i < screen_lines(SP_PARM); i++) {
1695                 GoTo(NCURSES_SP_ARGx i, 0);
1696                 NCURSES_PUTP2("clr_eol", clr_eol);
1697             }
1698             GoTo(NCURSES_SP_ARGx 0, 0);
1699         }
1700     } else {
1701         UpdateAttrs(SP_PARM, blank);
1702         for (i = 0; i < screen_lines(SP_PARM); i++) {
1703             GoTo(NCURSES_SP_ARGx i, 0);
1704             for (j = 0; j < screen_columns(SP_PARM); j++)
1705                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1706         }
1707         GoTo(NCURSES_SP_ARGx 0, 0);
1708     }
1709
1710     for (i = 0; i < screen_lines(SP_PARM); i++) {
1711         for (j = 0; j < screen_columns(SP_PARM); j++)
1712             CurScreen(SP_PARM)->_line[i].text[j] = blank;
1713     }
1714
1715     TR(TRACE_UPDATE, ("screen cleared"));
1716 }
1717
1718 /*
1719 **      InsStr(line, count)
1720 **
1721 **      Insert the count characters pointed to by line.
1722 **
1723 */
1724
1725 static void
1726 InsStr(NCURSES_SP_DCLx NCURSES_CH_T * line, int count)
1727 {
1728     TR(TRACE_UPDATE, ("InsStr(%p, %p,%d) called",
1729                       (void *) SP_PARM,
1730                       (void *) line, count));
1731
1732     /* Prefer parm_ich as it has the smallest cost - no need to shift
1733      * the whole line on each character. */
1734     /* The order must match that of InsCharCost. */
1735     if (parm_ich) {
1736         TPUTS_TRACE("parm_ich");
1737         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1738                                 TPARM_1(parm_ich, count),
1739                                 1,
1740                                 NCURSES_SP_NAME(_nc_outch));
1741         while (count) {
1742             PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1743             line++;
1744             count--;
1745         }
1746     } else if (enter_insert_mode && exit_insert_mode) {
1747         NCURSES_PUTP2("enter_insert_mode", enter_insert_mode);
1748         while (count) {
1749             PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1750             if (insert_padding) {
1751                 NCURSES_PUTP2("insert_padding", insert_padding);
1752             }
1753             line++;
1754             count--;
1755         }
1756         NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
1757     } else {
1758         while (count) {
1759             NCURSES_PUTP2("insert_character", insert_character);
1760             PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1761             if (insert_padding) {
1762                 NCURSES_PUTP2("insert_padding", insert_padding);
1763             }
1764             line++;
1765             count--;
1766         }
1767     }
1768     position_check(NCURSES_SP_ARGx
1769                    SP_PARM->_cursrow,
1770                    SP_PARM->_curscol, "InsStr");
1771 }
1772
1773 /*
1774 **      DelChar(count)
1775 **
1776 **      Delete count characters at current position
1777 **
1778 */
1779
1780 static void
1781 DelChar(NCURSES_SP_DCLx int count)
1782 {
1783     TR(TRACE_UPDATE, ("DelChar(%p, %d) called, position = (%ld,%ld)",
1784                       (void *) SP_PARM, count,
1785                       (long) NewScreen(SP_PARM)->_cury,
1786                       (long) NewScreen(SP_PARM)->_curx));
1787
1788     if (parm_dch) {
1789         TPUTS_TRACE("parm_dch");
1790         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1791                                 TPARM_1(parm_dch, count),
1792                                 1,
1793                                 NCURSES_SP_NAME(_nc_outch));
1794     } else {
1795         int n;
1796
1797         for (n = 0; n < count; n++) {
1798             NCURSES_PUTP2("delete_character", delete_character);
1799         }
1800     }
1801 }
1802
1803 /*
1804  * Physical-scrolling support
1805  *
1806  * This code was adapted from Keith Bostic's hardware scrolling
1807  * support for 4.4BSD curses.  I (esr) translated it to use terminfo
1808  * capabilities, narrowed the call interface slightly, and cleaned
1809  * up some convoluted tests.  I also added support for the memory_above
1810  * memory_below, and non_dest_scroll_region capabilities.
1811  *
1812  * For this code to work, we must have either
1813  * change_scroll_region and scroll forward/reverse commands, or
1814  * insert and delete line capabilities.
1815  * When the scrolling region has been set, the cursor has to
1816  * be at the last line of the region to make the scroll up
1817  * happen, or on the first line of region to scroll down.
1818  *
1819  * This code makes one aesthetic decision in the opposite way from
1820  * BSD curses.  BSD curses preferred pairs of il/dl operations
1821  * over scrolls, allegedly because il/dl looked faster.  We, on
1822  * the other hand, prefer scrolls because (a) they're just as fast
1823  * on many terminals and (b) using them avoids bouncing an
1824  * unchanged bottom section of the screen up and down, which is
1825  * visually nasty.
1826  *
1827  * (lav): added more cases, used dl/il when bot==maxy and in csr case.
1828  *
1829  * I used assumption that capabilities il/il1/dl/dl1 work inside
1830  * changed scroll region not shifting screen contents outside of it.
1831  * If there are any terminals behaving different way, it would be
1832  * necessary to add some conditions to scroll_csr_forward/backward.
1833  */
1834
1835 /* Try to scroll up assuming given csr (miny, maxy). Returns ERR on failure */
1836 static int
1837 scroll_csr_forward(NCURSES_SP_DCLx
1838                    int n,
1839                    int top,
1840                    int bot,
1841                    int miny,
1842                    int maxy,
1843                    NCURSES_CH_T blank)
1844 {
1845     int i;
1846
1847     if (n == 1 && scroll_forward && top == miny && bot == maxy) {
1848         GoTo(NCURSES_SP_ARGx bot, 0);
1849         UpdateAttrs(SP_PARM, blank);
1850         NCURSES_PUTP2("scroll_forward", scroll_forward);
1851     } else if (n == 1 && delete_line && bot == maxy) {
1852         GoTo(NCURSES_SP_ARGx top, 0);
1853         UpdateAttrs(SP_PARM, blank);
1854         NCURSES_PUTP2("delete_line", delete_line);
1855     } else if (parm_index && top == miny && bot == maxy) {
1856         GoTo(NCURSES_SP_ARGx bot, 0);
1857         UpdateAttrs(SP_PARM, blank);
1858         TPUTS_TRACE("parm_index");
1859         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1860                                 TPARM_2(parm_index, n, 0),
1861                                 n,
1862                                 NCURSES_SP_NAME(_nc_outch));
1863     } else if (parm_delete_line && bot == maxy) {
1864         GoTo(NCURSES_SP_ARGx top, 0);
1865         UpdateAttrs(SP_PARM, blank);
1866         TPUTS_TRACE("parm_delete_line");
1867         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1868                                 TPARM_2(parm_delete_line, n, 0),
1869                                 n,
1870                                 NCURSES_SP_NAME(_nc_outch));
1871     } else if (scroll_forward && top == miny && bot == maxy) {
1872         GoTo(NCURSES_SP_ARGx bot, 0);
1873         UpdateAttrs(SP_PARM, blank);
1874         for (i = 0; i < n; i++) {
1875             NCURSES_PUTP2("scroll_forward", scroll_forward);
1876         }
1877     } else if (delete_line && bot == maxy) {
1878         GoTo(NCURSES_SP_ARGx top, 0);
1879         UpdateAttrs(SP_PARM, blank);
1880         for (i = 0; i < n; i++) {
1881             NCURSES_PUTP2("delete_line", delete_line);
1882         }
1883     } else
1884         return ERR;
1885
1886 #if NCURSES_EXT_FUNCS
1887     if (FILL_BCE(SP_PARM)) {
1888         int j;
1889         for (i = 0; i < n; i++) {
1890             GoTo(NCURSES_SP_ARGx bot - i, 0);
1891             for (j = 0; j < screen_columns(SP_PARM); j++)
1892                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1893         }
1894     }
1895 #endif
1896     return OK;
1897 }
1898
1899 /* Try to scroll down assuming given csr (miny, maxy). Returns ERR on failure */
1900 /* n > 0 */
1901 static int
1902 scroll_csr_backward(NCURSES_SP_DCLx
1903                     int n,
1904                     int top,
1905                     int bot,
1906                     int miny,
1907                     int maxy,
1908                     NCURSES_CH_T blank)
1909 {
1910     int i;
1911
1912     if (n == 1 && scroll_reverse && top == miny && bot == maxy) {
1913         GoTo(NCURSES_SP_ARGx top, 0);
1914         UpdateAttrs(SP_PARM, blank);
1915         NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1916     } else if (n == 1 && insert_line && bot == maxy) {
1917         GoTo(NCURSES_SP_ARGx top, 0);
1918         UpdateAttrs(SP_PARM, blank);
1919         NCURSES_PUTP2("insert_line", insert_line);
1920     } else if (parm_rindex && top == miny && bot == maxy) {
1921         GoTo(NCURSES_SP_ARGx top, 0);
1922         UpdateAttrs(SP_PARM, blank);
1923         TPUTS_TRACE("parm_rindex");
1924         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1925                                 TPARM_2(parm_rindex, n, 0),
1926                                 n,
1927                                 NCURSES_SP_NAME(_nc_outch));
1928     } else if (parm_insert_line && bot == maxy) {
1929         GoTo(NCURSES_SP_ARGx top, 0);
1930         UpdateAttrs(SP_PARM, blank);
1931         TPUTS_TRACE("parm_insert_line");
1932         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1933                                 TPARM_2(parm_insert_line, n, 0),
1934                                 n,
1935                                 NCURSES_SP_NAME(_nc_outch));
1936     } else if (scroll_reverse && top == miny && bot == maxy) {
1937         GoTo(NCURSES_SP_ARGx top, 0);
1938         UpdateAttrs(SP_PARM, blank);
1939         for (i = 0; i < n; i++) {
1940             NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1941         }
1942     } else if (insert_line && bot == maxy) {
1943         GoTo(NCURSES_SP_ARGx top, 0);
1944         UpdateAttrs(SP_PARM, blank);
1945         for (i = 0; i < n; i++) {
1946             NCURSES_PUTP2("insert_line", insert_line);
1947         }
1948     } else
1949         return ERR;
1950
1951 #if NCURSES_EXT_FUNCS
1952     if (FILL_BCE(SP_PARM)) {
1953         int j;
1954         for (i = 0; i < n; i++) {
1955             GoTo(NCURSES_SP_ARGx top + i, 0);
1956             for (j = 0; j < screen_columns(SP_PARM); j++)
1957                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1958         }
1959     }
1960 #endif
1961     return OK;
1962 }
1963
1964 /* scroll by using delete_line at del and insert_line at ins */
1965 /* n > 0 */
1966 static int
1967 scroll_idl(NCURSES_SP_DCLx int n, int del, int ins, NCURSES_CH_T blank)
1968 {
1969     int i;
1970
1971     if (!((parm_delete_line || delete_line) && (parm_insert_line || insert_line)))
1972         return ERR;
1973
1974     GoTo(NCURSES_SP_ARGx del, 0);
1975     UpdateAttrs(SP_PARM, blank);
1976     if (n == 1 && delete_line) {
1977         NCURSES_PUTP2("delete_line", delete_line);
1978     } else if (parm_delete_line) {
1979         TPUTS_TRACE("parm_delete_line");
1980         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1981                                 TPARM_2(parm_delete_line, n, 0),
1982                                 n,
1983                                 NCURSES_SP_NAME(_nc_outch));
1984     } else {                    /* if (delete_line) */
1985         for (i = 0; i < n; i++) {
1986             NCURSES_PUTP2("delete_line", delete_line);
1987         }
1988     }
1989
1990     GoTo(NCURSES_SP_ARGx ins, 0);
1991     UpdateAttrs(SP_PARM, blank);
1992     if (n == 1 && insert_line) {
1993         NCURSES_PUTP2("insert_line", insert_line);
1994     } else if (parm_insert_line) {
1995         TPUTS_TRACE("parm_insert_line");
1996         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1997                                 TPARM_2(parm_insert_line, n, 0),
1998                                 n,
1999                                 NCURSES_SP_NAME(_nc_outch));
2000     } else {                    /* if (insert_line) */
2001         for (i = 0; i < n; i++) {
2002             NCURSES_PUTP2("insert_line", insert_line);
2003         }
2004     }
2005
2006     return OK;
2007 }
2008
2009 /*
2010  * Note:  some terminals require the cursor to be within the scrolling margins
2011  * before setting them.  Generally, the cursor must be at the appropriate end
2012  * of the scrolling margins when issuing an indexing operation (it is not
2013  * apparent whether it must also be at the left margin; we do this just to be
2014  * safe).  To make the related cursor movement a little faster, we use the
2015  * save/restore cursor capabilities if the terminal has them.
2016  */
2017 NCURSES_EXPORT(int)
2018 NCURSES_SP_NAME(_nc_scrolln) (NCURSES_SP_DCLx
2019                               int n,
2020                               int top,
2021                               int bot,
2022                               int maxy)
2023 /* scroll region from top to bot by n lines */
2024 {
2025     NCURSES_CH_T blank;
2026     int i;
2027     bool cursor_saved = FALSE;
2028     int res;
2029
2030     TR(TRACE_MOVE, ("_nc_scrolln(%p, %d, %d, %d, %d)",
2031                     (void *) SP_PARM, n, top, bot, maxy));
2032
2033     if (!IsValidScreen(SP_PARM))
2034         return (ERR);
2035
2036     blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
2037
2038 #if USE_XMC_SUPPORT
2039     /*
2040      * If we scroll, we might remove a cookie.
2041      */
2042     if (magic_cookie_glitch > 0) {
2043         return (ERR);
2044     }
2045 #endif
2046
2047     if (n > 0) {                /* scroll up (forward) */
2048         /*
2049          * Explicitly clear if stuff pushed off top of region might
2050          * be saved by the terminal.
2051          */
2052         res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, 0, maxy, blank);
2053
2054         if (res == ERR && change_scroll_region) {
2055             if ((((n == 1 && scroll_forward) || parm_index)
2056                  && (SP_PARM->_cursrow == bot || SP_PARM->_cursrow == bot - 1))
2057                 && save_cursor && restore_cursor) {
2058                 cursor_saved = TRUE;
2059                 NCURSES_PUTP2("save_cursor", save_cursor);
2060             }
2061             NCURSES_PUTP2("change_scroll_region",
2062                           TPARM_2(change_scroll_region, top, bot));
2063             if (cursor_saved) {
2064                 NCURSES_PUTP2("restore_cursor", restore_cursor);
2065             } else {
2066                 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2067             }
2068
2069             res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, top, bot, blank);
2070
2071             NCURSES_PUTP2("change_scroll_region",
2072                           TPARM_2(change_scroll_region, 0, maxy));
2073             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2074         }
2075
2076         if (res == ERR && SP_PARM->_nc_sp_idlok)
2077             res = scroll_idl(NCURSES_SP_ARGx n, top, bot - n + 1, blank);
2078
2079         /*
2080          * Clear the newly shifted-in text.
2081          */
2082         if (res != ERR
2083             && (non_dest_scroll_region || (memory_below && bot == maxy))) {
2084             static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2085             if (bot == maxy && clr_eos) {
2086                 GoTo(NCURSES_SP_ARGx bot - n + 1, 0);
2087                 ClrToEOS(NCURSES_SP_ARGx blank2);
2088             } else {
2089                 for (i = 0; i < n; i++) {
2090                     GoTo(NCURSES_SP_ARGx bot - i, 0);
2091                     ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2092                 }
2093             }
2094         }
2095
2096     } else {                    /* (n < 0) - scroll down (backward) */
2097         res = scroll_csr_backward(NCURSES_SP_ARGx -n, top, bot, 0, maxy, blank);
2098
2099         if (res == ERR && change_scroll_region) {
2100             if (top != 0
2101                 && (SP_PARM->_cursrow == top ||
2102                     SP_PARM->_cursrow == top - 1)
2103                 && save_cursor && restore_cursor) {
2104                 cursor_saved = TRUE;
2105                 NCURSES_PUTP2("save_cursor", save_cursor);
2106             }
2107             NCURSES_PUTP2("change_scroll_region",
2108                           TPARM_2(change_scroll_region, top, bot));
2109             if (cursor_saved) {
2110                 NCURSES_PUTP2("restore_cursor", restore_cursor);
2111             } else {
2112                 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2113             }
2114
2115             res = scroll_csr_backward(NCURSES_SP_ARGx
2116                                       -n, top, bot, top, bot, blank);
2117
2118             NCURSES_PUTP2("change_scroll_region",
2119                           TPARM_2(change_scroll_region, 0, maxy));
2120             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2121         }
2122
2123         if (res == ERR && SP_PARM->_nc_sp_idlok)
2124             res = scroll_idl(NCURSES_SP_ARGx -n, bot + n + 1, top, blank);
2125
2126         /*
2127          * Clear the newly shifted-in text.
2128          */
2129         if (res != ERR
2130             && (non_dest_scroll_region || (memory_above && top == 0))) {
2131             static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2132             for (i = 0; i < -n; i++) {
2133                 GoTo(NCURSES_SP_ARGx i + top, 0);
2134                 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2135             }
2136         }
2137     }
2138
2139     if (res == ERR)
2140         return (ERR);
2141
2142     _nc_scroll_window(CurScreen(SP_PARM), n,
2143                       (NCURSES_SIZE_T) top,
2144                       (NCURSES_SIZE_T) bot,
2145                       blank);
2146
2147     /* shift hash values too - they can be reused */
2148     NCURSES_SP_NAME(_nc_scroll_oldhash) (NCURSES_SP_ARGx n, top, bot);
2149
2150     return (OK);
2151 }
2152
2153 #if NCURSES_SP_FUNCS
2154 NCURSES_EXPORT(int)
2155 _nc_scrolln(int n, int top, int bot, int maxy)
2156 {
2157     return NCURSES_SP_NAME(_nc_scrolln) (CURRENT_SCREEN, n, top, bot, maxy);
2158 }
2159 #endif
2160
2161 NCURSES_EXPORT(void)
2162 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_DCL0)
2163 {
2164     assert(SP_PARM);
2165
2166     /* make sure terminal is in a sane known state */
2167     SetAttr(SCREEN_ATTRS(SP_PARM), A_NORMAL);
2168     NewScreen(SP_PARM)->_clear = TRUE;
2169
2170     /* reset color pairs and definitions */
2171     if (SP_PARM->_coloron || SP_PARM->_color_defs)
2172         NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2173
2174     /* restore user-defined colors, if any */
2175     if (SP_PARM->_color_defs < 0) {
2176         int n;
2177         SP_PARM->_color_defs = -(SP_PARM->_color_defs);
2178         for (n = 0; n < SP_PARM->_color_defs; ++n) {
2179             if (SP_PARM->_color_table[n].init) {
2180                 NCURSES_SP_NAME(init_color) (NCURSES_SP_ARGx
2181                                              (short) n,
2182                                              SP_PARM->_color_table[n].r,
2183                                              SP_PARM->_color_table[n].g,
2184                                              SP_PARM->_color_table[n].b);
2185             }
2186         }
2187     }
2188
2189     if (exit_attribute_mode)
2190         NCURSES_PUTP2("exit_attribute_mode", exit_attribute_mode);
2191     else {
2192         /* turn off attributes */
2193         if (exit_alt_charset_mode)
2194             NCURSES_PUTP2("exit_alt_charset_mode", exit_alt_charset_mode);
2195         if (exit_standout_mode)
2196             NCURSES_PUTP2("exit_standout_mode", exit_standout_mode);
2197         if (exit_underline_mode)
2198             NCURSES_PUTP2("exit_underline_mode", exit_underline_mode);
2199     }
2200     if (exit_insert_mode)
2201         NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
2202     if (enter_am_mode && exit_am_mode) {
2203         if (auto_right_margin) {
2204             NCURSES_PUTP2("enter_am_mode", enter_am_mode);
2205         } else {
2206             NCURSES_PUTP2("exit_am_mode", exit_am_mode);
2207         }
2208     }
2209 }
2210
2211 #if NCURSES_SP_FUNCS
2212 NCURSES_EXPORT(void)
2213 _nc_screen_resume(void)
2214 {
2215     NCURSES_SP_NAME(_nc_screen_resume) (CURRENT_SCREEN);
2216 }
2217 #endif
2218
2219 NCURSES_EXPORT(void)
2220 NCURSES_SP_NAME(_nc_screen_init) (NCURSES_SP_DCL0)
2221 {
2222     NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
2223 }
2224
2225 #if NCURSES_SP_FUNCS
2226 NCURSES_EXPORT(void)
2227 _nc_screen_init(void)
2228 {
2229     NCURSES_SP_NAME(_nc_screen_init) (CURRENT_SCREEN);
2230 }
2231 #endif
2232
2233 /* wrap up screen handling */
2234 NCURSES_EXPORT(void)
2235 NCURSES_SP_NAME(_nc_screen_wrap) (NCURSES_SP_DCL0)
2236 {
2237     if (SP_PARM != 0) {
2238
2239         UpdateAttrs(SP_PARM, normal);
2240 #if NCURSES_EXT_FUNCS
2241         if (SP_PARM->_coloron
2242             && !SP_PARM->_default_color) {
2243             static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
2244             SP_PARM->_default_color = TRUE;
2245             NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
2246                                            -1,
2247                                            0,
2248                                            FALSE,
2249                                            NCURSES_SP_NAME(_nc_outch));
2250             SP_PARM->_default_color = FALSE;
2251
2252             TINFO_MVCUR(NCURSES_SP_ARGx
2253                         SP_PARM->_cursrow,
2254                         SP_PARM->_curscol,
2255                         screen_lines(SP_PARM) - 1,
2256                         0);
2257
2258             ClrToEOL(NCURSES_SP_ARGx blank, TRUE);
2259         }
2260 #endif
2261         if (SP_PARM->_color_defs) {
2262             NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2263         }
2264     }
2265 }
2266
2267 #if NCURSES_SP_FUNCS
2268 NCURSES_EXPORT(void)
2269 _nc_screen_wrap(void)
2270 {
2271     NCURSES_SP_NAME(_nc_screen_wrap) (CURRENT_SCREEN);
2272 }
2273 #endif
2274
2275 #if USE_XMC_SUPPORT
2276 NCURSES_EXPORT(void)
2277 NCURSES_SP_NAME(_nc_do_xmc_glitch) (NCURSES_SP_DCLx attr_t previous)
2278 {
2279     if (SP_PARM != 0) {
2280         attr_t chg = XMC_CHANGES(previous ^ AttrOf(SCREEN_ATTRS(SP_PARM)));
2281
2282         while (chg != 0) {
2283             if (chg & 1) {
2284                 SP_PARM->_curscol += magic_cookie_glitch;
2285                 if (SP_PARM->_curscol >= SP_PARM->_columns)
2286                     wrap_cursor(NCURSES_SP_ARG);
2287                 TR(TRACE_UPDATE, ("bumped to %d,%d after cookie",
2288                                   SP_PARM->_cursrow, SP_PARM->_curscol));
2289             }
2290             chg >>= 1;
2291         }
2292     }
2293 }
2294
2295 #if NCURSES_SP_FUNCS
2296 NCURSES_EXPORT(void)
2297 _nc_do_xmc_glitch(attr_t previous)
2298 {
2299     NCURSES_SP_NAME(_nc_do_xmc_glitch) (CURRENT_SCREEN, previous);
2300 }
2301 #endif
2302
2303 #endif /* USE_XMC_SUPPORT */