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