ncurses 6.0 - patch 20170826
[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.294 2017/07/31 21:06:04 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 != 0 &&
670 #if USE_WIDEC_SUPPORT
671                        (CharOf(ntext0) < ACS_LEN) &&
672 #endif
673                        runcount > SP_PARM->_rep_cost) {
674                 NCURSES_CH_T temp;
675                 bool wrap_possible = (SP_PARM->_curscol + runcount >=
676                                       screen_columns(SP_PARM));
677                 int rep_count = runcount;
678
679                 if (wrap_possible)
680                     rep_count--;
681
682                 UpdateAttrs(SP_PARM, ntext0);
683                 temp = ntext0;
684                 if ((AttrOf(temp) & A_ALTCHARSET) &&
685                     SP_PARM->_acs_map != 0) {
686                     SetChar(temp,
687                             SP_PARM->_acs_map[CharOf(temp)],
688                             AttrOf(temp) | A_ALTCHARSET);
689                 }
690                 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
691                                         TPARM_2(repeat_char,
692                                                 CharOf(temp),
693                                                 rep_count),
694                                         1,
695                                         NCURSES_SP_NAME(_nc_outch));
696                 SP_PARM->_curscol += rep_count;
697
698                 if (wrap_possible)
699                     PutChar(NCURSES_SP_ARGx CHREF(ntext0));
700             } else {
701                 for (i = 0; i < runcount; i++)
702                     PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
703             }
704             ntext += runcount;
705             num -= runcount;
706         }
707         return 0;
708     }
709
710     for (i = 0; i < num; i++)
711         PutChar(NCURSES_SP_ARGx CHREF(ntext[i]));
712     return 0;
713 }
714
715 /*
716  * Output the line in the given range [first .. last]
717  *
718  * If there's a run of identical characters that's long enough to justify
719  * cursor movement, use that also.
720  *
721  * Returns: same as EmitRange
722  */
723 static int
724 PutRange(NCURSES_SP_DCLx
725          const NCURSES_CH_T * otext,
726          const NCURSES_CH_T * ntext,
727          int row,
728          int first, int last)
729 {
730     int rc;
731
732     TR(TRACE_CHARPUT, ("PutRange(%p, %p, %p, %d, %d, %d)",
733                        (void *) SP_PARM,
734                        (const void *) otext,
735                        (const void *) ntext,
736                        row, first, last));
737
738     if (otext != ntext
739         && (last - first + 1) > SP_PARM->_inline_cost) {
740         int i, j, same;
741
742         for (j = first, same = 0; j <= last; j++) {
743             if (!same && isWidecExt(otext[j]))
744                 continue;
745             if (CharEq(otext[j], ntext[j])) {
746                 same++;
747             } else {
748                 if (same > SP_PARM->_inline_cost) {
749                     EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
750                     GoTo(NCURSES_SP_ARGx row, first = j);
751                 }
752                 same = 0;
753             }
754         }
755         i = EmitRange(NCURSES_SP_ARGx ntext + first, j - same - first);
756         /*
757          * Always return 1 for the next GoTo() after a PutRange() if we found
758          * identical characters at end of interval
759          */
760         rc = (same == 0 ? i : 1);
761     } else {
762         rc = EmitRange(NCURSES_SP_ARGx ntext + first, last - first + 1);
763     }
764     return rc;
765 }
766
767 /* leave unbracketed here so 'indent' works */
768 #define MARK_NOCHANGE(win,row) \
769                 win->_line[row].firstchar = _NOCHANGE; \
770                 win->_line[row].lastchar = _NOCHANGE; \
771                 if_USE_SCROLL_HINTS(win->_line[row].oldindex = row)
772
773 NCURSES_EXPORT(int)
774 TINFO_DOUPDATE(NCURSES_SP_DCL0)
775 {
776     int i;
777     int nonempty;
778 #if USE_TRACE_TIMES
779     struct tms before, after;
780 #endif /* USE_TRACE_TIMES */
781
782     T((T_CALLED("_nc_tinfo:doupdate(%p)"), (void *) SP_PARM));
783
784     _nc_lock_global(update);
785
786     if (SP_PARM == 0) {
787         _nc_unlock_global(update);
788         returnCode(ERR);
789     }
790 #if !USE_REENTRANT
791     /*
792      * It is "legal" but unlikely that an application could assign a new
793      * value to one of the standard windows.  Check for that possibility
794      * and try to recover.
795      *
796      * We do not allow applications to assign new values in the reentrant
797      * model.
798      */
799 #define SyncScreens(internal,exported) \
800         if (internal == 0) internal = exported; \
801         if (internal != exported) exported = internal
802
803     SyncScreens(CurScreen(SP_PARM), curscr);
804     SyncScreens(NewScreen(SP_PARM), newscr);
805     SyncScreens(StdScreen(SP_PARM), stdscr);
806 #endif
807
808     if (CurScreen(SP_PARM) == 0
809         || NewScreen(SP_PARM) == 0
810         || StdScreen(SP_PARM) == 0) {
811         _nc_unlock_global(update);
812         returnCode(ERR);
813     }
814 #ifdef TRACE
815     if (USE_TRACEF(TRACE_UPDATE)) {
816         if (CurScreen(SP_PARM)->_clear)
817             _tracef("curscr is clear");
818         else
819             _tracedump("curscr", CurScreen(SP_PARM));
820         _tracedump("newscr", NewScreen(SP_PARM));
821         _nc_unlock_global(tracef);
822     }
823 #endif /* TRACE */
824
825     _nc_signal_handler(FALSE);
826
827     if (SP_PARM->_fifohold)
828         SP_PARM->_fifohold--;
829
830 #if USE_SIZECHANGE
831     if ((SP_PARM->_endwin == ewRunning)
832         || _nc_handle_sigwinch(SP_PARM)) {
833         /*
834          * This is a transparent extension:  XSI does not address it,
835          * and applications need not know that ncurses can do it.
836          *
837          * Check if the terminal size has changed while curses was off
838          * (this can happen in an xterm, for example), and resize the
839          * ncurses data structures accordingly.
840          */
841         _nc_update_screensize(SP_PARM);
842     }
843 #endif
844
845     if (SP_PARM->_endwin == ewSuspend) {
846
847         T(("coming back from shell mode"));
848         NCURSES_SP_NAME(reset_prog_mode) (NCURSES_SP_ARG);
849
850         NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
851         NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
852         SP_PARM->_mouse_resume(SP_PARM);
853
854         SP_PARM->_endwin = ewRunning;
855     }
856 #if USE_TRACE_TIMES
857     /* zero the metering machinery */
858     RESET_OUTCHARS();
859     (void) times(&before);
860 #endif /* USE_TRACE_TIMES */
861
862     /*
863      * This is the support for magic-cookie terminals.  The theory:  we scan
864      * the virtual screen looking for attribute turnons.  Where we find one,
865      * check to make sure it's realizable by seeing if the required number of
866      * un-attributed blanks are present before and after the attributed range;
867      * try to shift the range boundaries over blanks (not changing the screen
868      * display) so this becomes true.  If it is, shift the beginning attribute
869      * change appropriately (the end one, if we've gotten this far, is
870      * guaranteed room for its cookie).  If not, nuke the added attributes out
871      * of the span.
872      */
873 #if USE_XMC_SUPPORT
874     if (magic_cookie_glitch > 0) {
875         int j, k;
876         attr_t rattr = A_NORMAL;
877
878         for (i = 0; i < screen_lines(SP_PARM); i++) {
879             for (j = 0; j < screen_columns(SP_PARM); j++) {
880                 bool failed = FALSE;
881                 NCURSES_CH_T *thisline = NewScreen(SP_PARM)->_line[i].text;
882                 attr_t thisattr = AttrOf(thisline[j]) & SP_PARM->_xmc_triggers;
883                 attr_t turnon = thisattr & ~rattr;
884
885                 /* is an attribute turned on here? */
886                 if (turnon == 0) {
887                     rattr = thisattr;
888                     continue;
889                 }
890
891                 TR(TRACE_ATTRS, ("At (%d, %d): from %s...", i, j, _traceattr(rattr)));
892                 TR(TRACE_ATTRS, ("...to %s", _traceattr(turnon)));
893
894                 /*
895                  * If the attribute change location is a blank with a "safe"
896                  * attribute, undo the attribute turnon.  This may ensure
897                  * there's enough room to set the attribute before the first
898                  * non-blank in the run.
899                  */
900 #define SAFE(scr,a)     (!((a) & (scr)->_xmc_triggers))
901                 if (ISBLANK(thisline[j]) && SAFE(SP_PARM, turnon)) {
902                     RemAttr(thisline[j], turnon);
903                     continue;
904                 }
905
906                 /* check that there's enough room at start of span */
907                 for (k = 1; k <= magic_cookie_glitch; k++) {
908                     if (j - k < 0
909                         || !ISBLANK(thisline[j - k])
910                         || !SAFE(SP_PARM, AttrOf(thisline[j - k]))) {
911                         failed = TRUE;
912                         TR(TRACE_ATTRS, ("No room at start in %d,%d%s%s",
913                                          i, j - k,
914                                          (ISBLANK(thisline[j - k])
915                                           ? ""
916                                           : ":nonblank"),
917                                          (SAFE(SP_PARM, AttrOf(thisline[j - k]))
918                                           ? ""
919                                           : ":unsafe")));
920                         break;
921                     }
922                 }
923                 if (!failed) {
924                     bool end_onscreen = FALSE;
925                     int m, n = j;
926
927                     /* find end of span, if it's onscreen */
928                     for (m = i; m < screen_lines(SP_PARM); m++) {
929                         for (; n < screen_columns(SP_PARM); n++) {
930                             attr_t testattr =
931                             AttrOf(NewScreen(SP_PARM)->_line[m].text[n]);
932                             if ((testattr & SP_PARM->_xmc_triggers) == rattr) {
933                                 end_onscreen = TRUE;
934                                 TR(TRACE_ATTRS,
935                                    ("Range attributed with %s ends at (%d, %d)",
936                                     _traceattr(turnon), m, n));
937                                 goto foundit;
938                             }
939                         }
940                         n = 0;
941                     }
942                     TR(TRACE_ATTRS,
943                        ("Range attributed with %s ends offscreen",
944                         _traceattr(turnon)));
945                   foundit:;
946
947                     if (end_onscreen) {
948                         NCURSES_CH_T *lastline =
949                         NewScreen(SP_PARM)->_line[m].text;
950
951                         /*
952                          * If there are safely-attributed blanks at the end of
953                          * the range, shorten the range.  This will help ensure
954                          * that there is enough room at end of span.
955                          */
956                         while (n >= 0
957                                && ISBLANK(lastline[n])
958                                && SAFE(SP_PARM, AttrOf(lastline[n]))) {
959                             RemAttr(lastline[n--], turnon);
960                         }
961
962                         /* check that there's enough room at end of span */
963                         for (k = 1; k <= magic_cookie_glitch; k++) {
964                             if (n + k >= screen_columns(SP_PARM)
965                                 || !ISBLANK(lastline[n + k])
966                                 || !SAFE(SP_PARM, AttrOf(lastline[n + k]))) {
967                                 failed = TRUE;
968                                 TR(TRACE_ATTRS,
969                                    ("No room at end in %d,%d%s%s",
970                                     i, j - k,
971                                     (ISBLANK(lastline[n + k])
972                                      ? ""
973                                      : ":nonblank"),
974                                     (SAFE(SP_PARM, AttrOf(lastline[n + k]))
975                                      ? ""
976                                      : ":unsafe")));
977                                 break;
978                             }
979                         }
980                     }
981                 }
982
983                 if (failed) {
984                     int p, q = j;
985
986                     TR(TRACE_ATTRS,
987                        ("Clearing %s beginning at (%d, %d)",
988                         _traceattr(turnon), i, j));
989
990                     /* turn off new attributes over span */
991                     for (p = i; p < screen_lines(SP_PARM); p++) {
992                         for (; q < screen_columns(SP_PARM); q++) {
993                             attr_t testattr = AttrOf(newscr->_line[p].text[q]);
994                             if ((testattr & SP_PARM->_xmc_triggers) == rattr)
995                                 goto foundend;
996                             RemAttr(NewScreen(SP_PARM)->_line[p].text[q], turnon);
997                         }
998                         q = 0;
999                     }
1000                   foundend:;
1001                 } else {
1002                     TR(TRACE_ATTRS,
1003                        ("Cookie space for %s found before (%d, %d)",
1004                         _traceattr(turnon), i, j));
1005
1006                     /*
1007                      * Back up the start of range so there's room for cookies
1008                      * before the first nonblank character.
1009                      */
1010                     for (k = 1; k <= magic_cookie_glitch; k++)
1011                         AddAttr(thisline[j - k], turnon);
1012                 }
1013
1014                 rattr = thisattr;
1015             }
1016         }
1017
1018 #ifdef TRACE
1019         /* show altered highlights after magic-cookie check */
1020         if (USE_TRACEF(TRACE_UPDATE)) {
1021             _tracef("After magic-cookie check...");
1022             _tracedump("newscr", NewScreen(SP_PARM));
1023             _nc_unlock_global(tracef);
1024         }
1025 #endif /* TRACE */
1026     }
1027 #endif /* USE_XMC_SUPPORT */
1028
1029     nonempty = 0;
1030     if (CurScreen(SP_PARM)->_clear || NewScreen(SP_PARM)->_clear) {     /* force refresh ? */
1031         ClrUpdate(NCURSES_SP_ARG);
1032         CurScreen(SP_PARM)->_clear = FALSE;     /* reset flag */
1033         NewScreen(SP_PARM)->_clear = FALSE;     /* reset flag */
1034     } else {
1035         int changedlines = CHECK_INTERVAL;
1036
1037         if (check_pending(NCURSES_SP_ARG))
1038             goto cleanup;
1039
1040         nonempty = min(screen_lines(SP_PARM), NewScreen(SP_PARM)->_maxy + 1);
1041
1042         if (SP_PARM->_scrolling) {
1043             NCURSES_SP_NAME(_nc_scroll_optimize) (NCURSES_SP_ARG);
1044         }
1045
1046         nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1047
1048         TR(TRACE_UPDATE, ("Transforming lines, nonempty %d", nonempty));
1049         for (i = 0; i < nonempty; i++) {
1050             /*
1051              * Here is our line-breakout optimization.
1052              */
1053             if (changedlines == CHECK_INTERVAL) {
1054                 if (check_pending(NCURSES_SP_ARG))
1055                     goto cleanup;
1056                 changedlines = 0;
1057             }
1058
1059             /*
1060              * newscr->line[i].firstchar is normally set
1061              * by wnoutrefresh.  curscr->line[i].firstchar
1062              * is normally set by _nc_scroll_window in the
1063              * vertical-movement optimization code,
1064              */
1065             if (NewScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE
1066                 || CurScreen(SP_PARM)->_line[i].firstchar != _NOCHANGE) {
1067                 TransformLine(NCURSES_SP_ARGx i);
1068                 changedlines++;
1069             }
1070
1071             /* mark line changed successfully */
1072             if (i <= NewScreen(SP_PARM)->_maxy) {
1073                 MARK_NOCHANGE(NewScreen(SP_PARM), i);
1074             }
1075             if (i <= CurScreen(SP_PARM)->_maxy) {
1076                 MARK_NOCHANGE(CurScreen(SP_PARM), i);
1077             }
1078         }
1079     }
1080
1081     /* put everything back in sync */
1082     for (i = nonempty; i <= NewScreen(SP_PARM)->_maxy; i++) {
1083         MARK_NOCHANGE(NewScreen(SP_PARM), i);
1084     }
1085     for (i = nonempty; i <= CurScreen(SP_PARM)->_maxy; i++) {
1086         MARK_NOCHANGE(CurScreen(SP_PARM), i);
1087     }
1088
1089     if (!NewScreen(SP_PARM)->_leaveok) {
1090         CurScreen(SP_PARM)->_curx = NewScreen(SP_PARM)->_curx;
1091         CurScreen(SP_PARM)->_cury = NewScreen(SP_PARM)->_cury;
1092
1093         GoTo(NCURSES_SP_ARGx CurScreen(SP_PARM)->_cury, CurScreen(SP_PARM)->_curx);
1094     }
1095
1096   cleanup:
1097     /*
1098      * We would like to keep the physical screen in normal mode in case we get
1099      * other processes writing to the screen.  This goal cannot be met for
1100      * magic cookies since it interferes with attributes that may propagate
1101      * past the current position.
1102      */
1103 #if USE_XMC_SUPPORT
1104     if (magic_cookie_glitch != 0)
1105 #endif
1106         UpdateAttrs(SP_PARM, normal);
1107
1108     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1109     WINDOW_ATTRS(CurScreen(SP_PARM)) = WINDOW_ATTRS(NewScreen(SP_PARM));
1110
1111 #if USE_TRACE_TIMES
1112     (void) times(&after);
1113     TR(TRACE_TIMES,
1114        ("Update cost: %ld chars, %ld clocks system time, %ld clocks user time",
1115         _nc_outchars,
1116         (long) (after.tms_stime - before.tms_stime),
1117         (long) (after.tms_utime - before.tms_utime)));
1118 #endif /* USE_TRACE_TIMES */
1119
1120     _nc_signal_handler(TRUE);
1121
1122     _nc_unlock_global(update);
1123     returnCode(OK);
1124 }
1125
1126 #if NCURSES_SP_FUNCS && !defined(USE_TERM_DRIVER)
1127 NCURSES_EXPORT(int)
1128 doupdate(void)
1129 {
1130     return TINFO_DOUPDATE(CURRENT_SCREEN);
1131 }
1132 #endif
1133
1134 /*
1135  *      ClrBlank(win)
1136  *
1137  *      Returns the attributed character that corresponds to the "cleared"
1138  *      screen.  If the terminal has the back-color-erase feature, this will be
1139  *      colored according to the wbkgd() call.
1140  *
1141  *      We treat 'curscr' specially because it isn't supposed to be set directly
1142  *      in the wbkgd() call.  Assume 'stdscr' for this case.
1143  */
1144 #define BCE_ATTRS (A_NORMAL|A_COLOR)
1145 #define BCE_BKGD(sp,win) (((win) == CurScreen(sp) ? StdScreen(sp) : (win))->_nc_bkgd)
1146
1147 static NCURSES_INLINE NCURSES_CH_T
1148 ClrBlank(NCURSES_SP_DCLx WINDOW *win)
1149 {
1150     NCURSES_CH_T blank = blankchar;
1151     if (back_color_erase)
1152         AddAttr(blank, (AttrOf(BCE_BKGD(SP_PARM, win)) & BCE_ATTRS));
1153     return blank;
1154 }
1155
1156 /*
1157 **      ClrUpdate()
1158 **
1159 **      Update by clearing and redrawing the entire screen.
1160 **
1161 */
1162
1163 static void
1164 ClrUpdate(NCURSES_SP_DCL0)
1165 {
1166     TR(TRACE_UPDATE, (T_CALLED("ClrUpdate")));
1167     if (0 != SP_PARM) {
1168         int i;
1169         NCURSES_CH_T blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
1170         int nonempty = min(screen_lines(SP_PARM),
1171                            NewScreen(SP_PARM)->_maxy + 1);
1172
1173         ClearScreen(NCURSES_SP_ARGx blank);
1174
1175         TR(TRACE_UPDATE, ("updating screen from scratch"));
1176
1177         nonempty = ClrBottom(NCURSES_SP_ARGx nonempty);
1178
1179         for (i = 0; i < nonempty; i++)
1180             TransformLine(NCURSES_SP_ARGx i);
1181     }
1182     TR(TRACE_UPDATE, (T_RETURN("")));
1183 }
1184
1185 /*
1186 **      ClrToEOL(blank)
1187 **
1188 **      Clear to end of current line, starting at the cursor position
1189 */
1190
1191 static void
1192 ClrToEOL(NCURSES_SP_DCLx NCURSES_CH_T blank, int needclear)
1193 {
1194     if (CurScreen(SP_PARM) != 0
1195         && SP_PARM->_cursrow >= 0) {
1196         int j;
1197
1198         for (j = SP_PARM->_curscol; j < screen_columns(SP_PARM); j++) {
1199             if (j >= 0) {
1200                 NCURSES_CH_T *cp =
1201                 &(CurScreen(SP_PARM)->_line[SP_PARM->_cursrow].text[j]);
1202
1203                 if (!CharEq(*cp, blank)) {
1204                     *cp = blank;
1205                     needclear = TRUE;
1206                 }
1207             }
1208         }
1209     }
1210
1211     if (needclear) {
1212         UpdateAttrs(SP_PARM, blank);
1213         if (clr_eol && SP_PARM->_el_cost <= (screen_columns(SP_PARM) - SP_PARM->_curscol)) {
1214             NCURSES_PUTP2("clr_eol", clr_eol);
1215         } else {
1216             int count = (screen_columns(SP_PARM) - SP_PARM->_curscol);
1217             while (count-- > 0)
1218                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1219         }
1220     }
1221 }
1222
1223 /*
1224 **      ClrToEOS(blank)
1225 **
1226 **      Clear to end of screen, starting at the cursor position
1227 */
1228
1229 static void
1230 ClrToEOS(NCURSES_SP_DCLx NCURSES_CH_T blank)
1231 {
1232     int row, col;
1233
1234     row = SP_PARM->_cursrow;
1235     col = SP_PARM->_curscol;
1236
1237     if (row < 0)
1238         row = 0;
1239     if (col < 0)
1240         col = 0;
1241
1242     UpdateAttrs(SP_PARM, blank);
1243     TPUTS_TRACE("clr_eos");
1244     NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1245                             clr_eos,
1246                             screen_lines(SP_PARM) - row,
1247                             NCURSES_SP_NAME(_nc_outch));
1248
1249     while (col < screen_columns(SP_PARM))
1250         CurScreen(SP_PARM)->_line[row].text[col++] = blank;
1251
1252     for (row++; row < screen_lines(SP_PARM); row++) {
1253         for (col = 0; col < screen_columns(SP_PARM); col++)
1254             CurScreen(SP_PARM)->_line[row].text[col] = blank;
1255     }
1256 }
1257
1258 /*
1259  *      ClrBottom(total)
1260  *
1261  *      Test if clearing the end of the screen would satisfy part of the
1262  *      screen-update.  Do this by scanning backwards through the lines in the
1263  *      screen, checking if each is blank, and one or more are changed.
1264  */
1265 static int
1266 ClrBottom(NCURSES_SP_DCLx int total)
1267 {
1268     int top = total;
1269     int last = min(screen_columns(SP_PARM), NewScreen(SP_PARM)->_maxx + 1);
1270     NCURSES_CH_T blank = NewScreen(SP_PARM)->_line[total - 1].text[last - 1];
1271
1272     if (clr_eos && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1273         int row;
1274
1275         for (row = total - 1; row >= 0; row--) {
1276             int col;
1277             bool ok;
1278
1279             for (col = 0, ok = TRUE; ok && col < last; col++) {
1280                 ok = (CharEq(NewScreen(SP_PARM)->_line[row].text[col], blank));
1281             }
1282             if (!ok)
1283                 break;
1284
1285             for (col = 0; ok && col < last; col++) {
1286                 ok = (CharEq(CurScreen(SP_PARM)->_line[row].text[col], blank));
1287             }
1288             if (!ok)
1289                 top = row;
1290         }
1291
1292         /* don't use clr_eos for just one line if clr_eol available */
1293         if (top < total) {
1294             GoTo(NCURSES_SP_ARGx top, 0);
1295             ClrToEOS(NCURSES_SP_ARGx blank);
1296             if (SP_PARM->oldhash && SP_PARM->newhash) {
1297                 for (row = top; row < screen_lines(SP_PARM); row++)
1298                     SP_PARM->oldhash[row] = SP_PARM->newhash[row];
1299             }
1300         }
1301     }
1302     return top;
1303 }
1304
1305 #if USE_XMC_SUPPORT
1306 #if USE_WIDEC_SUPPORT
1307 #define check_xmc_transition(sp, a, b)                                  \
1308     ((((a)->attr ^ (b)->attr) & ~((a)->attr) & (sp)->_xmc_triggers) != 0)
1309 #define xmc_turn_on(sp,a,b) check_xmc_transition(sp,&(a), &(b))
1310 #else
1311 #define xmc_turn_on(sp,a,b) ((((a)^(b)) & ~(a) & (sp)->_xmc_triggers) != 0)
1312 #endif
1313
1314 #define xmc_new(sp,r,c) NewScreen(sp)->_line[r].text[c]
1315 #define xmc_turn_off(sp,a,b) xmc_turn_on(sp,b,a)
1316 #endif /* USE_XMC_SUPPORT */
1317
1318 /*
1319 **      TransformLine(lineno)
1320 **
1321 **      Transform the given line in curscr to the one in newscr, using
1322 **      Insert/Delete Character if idcok && has_ic().
1323 **
1324 **              firstChar = position of first different character in line
1325 **              oLastChar = position of last different character in old line
1326 **              nLastChar = position of last different character in new line
1327 **
1328 **              move to firstChar
1329 **              overwrite chars up to min(oLastChar, nLastChar)
1330 **              if oLastChar < nLastChar
1331 **                      insert newLine[oLastChar+1..nLastChar]
1332 **              else
1333 **                      delete oLastChar - nLastChar spaces
1334 */
1335
1336 static void
1337 TransformLine(NCURSES_SP_DCLx int const lineno)
1338 {
1339     int firstChar, oLastChar, nLastChar;
1340     NCURSES_CH_T *newLine = NewScreen(SP_PARM)->_line[lineno].text;
1341     NCURSES_CH_T *oldLine = CurScreen(SP_PARM)->_line[lineno].text;
1342     int n;
1343     bool attrchanged = FALSE;
1344
1345     TR(TRACE_UPDATE, (T_CALLED("TransformLine(%p, %d)"), (void *) SP_PARM, lineno));
1346
1347     /* copy new hash value to old one */
1348     if (SP_PARM->oldhash && SP_PARM->newhash)
1349         SP_PARM->oldhash[lineno] = SP_PARM->newhash[lineno];
1350
1351     /*
1352      * If we have colors, there is the possibility of having two color pairs
1353      * that display as the same colors.  For instance, Lynx does this.  Check
1354      * for this case, and update the old line with the new line's colors when
1355      * they are equivalent.
1356      */
1357     if (SP_PARM->_coloron) {
1358         int oldPair;
1359         int newPair;
1360
1361         for (n = 0; n < screen_columns(SP_PARM); n++) {
1362             if (!CharEq(newLine[n], oldLine[n])) {
1363                 oldPair = GetPair(oldLine[n]);
1364                 newPair = GetPair(newLine[n]);
1365                 if (oldPair != newPair
1366                     && unColor(oldLine[n]) == unColor(newLine[n])) {
1367                     if (oldPair < SP_PARM->_pair_limit
1368                         && newPair < SP_PARM->_pair_limit
1369                         && (isSamePair(SP_PARM->_color_pairs[oldPair],
1370                                        SP_PARM->_color_pairs[newPair]))) {
1371                         SetPair(oldLine[n], GetPair(newLine[n]));
1372                     }
1373                 }
1374             }
1375         }
1376     }
1377
1378     if (ceol_standout_glitch && clr_eol) {
1379         firstChar = 0;
1380         while (firstChar < screen_columns(SP_PARM)) {
1381             if (!SameAttrOf(newLine[firstChar], oldLine[firstChar])) {
1382                 attrchanged = TRUE;
1383                 break;
1384             }
1385             firstChar++;
1386         }
1387     }
1388
1389     firstChar = 0;
1390
1391     if (attrchanged) {          /* we may have to disregard the whole line */
1392         GoTo(NCURSES_SP_ARGx lineno, firstChar);
1393         ClrToEOL(NCURSES_SP_ARGx
1394                  ClrBlank(NCURSES_SP_ARGx
1395                           CurScreen(SP_PARM)), FALSE);
1396         PutRange(NCURSES_SP_ARGx
1397                  oldLine, newLine, lineno, 0,
1398                  screen_columns(SP_PARM) - 1);
1399 #if USE_XMC_SUPPORT
1400
1401         /*
1402          * This is a very simple loop to paint characters which may have the
1403          * magic cookie glitch embedded.  It doesn't know much about video
1404          * attributes which are continued from one line to the next.  It
1405          * assumes that we have filtered out requests for attribute changes
1406          * that do not get mapped to blank positions.
1407          *
1408          * FIXME: we are not keeping track of where we put the cookies, so this
1409          * will work properly only once, since we may overwrite a cookie in a
1410          * following operation.
1411          */
1412     } else if (magic_cookie_glitch > 0) {
1413         GoTo(NCURSES_SP_ARGx lineno, firstChar);
1414         for (n = 0; n < screen_columns(SP_PARM); n++) {
1415             int m = n + magic_cookie_glitch;
1416
1417             /* check for turn-on:
1418              * If we are writing an attributed blank, where the
1419              * previous cell is not attributed.
1420              */
1421             if (ISBLANK(newLine[n])
1422                 && ((n > 0
1423                      && xmc_turn_on(SP_PARM, newLine[n - 1], newLine[n]))
1424                     || (n == 0
1425                         && lineno > 0
1426                         && xmc_turn_on(SP_PARM,
1427                                        xmc_new(SP_PARM, lineno - 1,
1428                                                screen_columns(SP_PARM) - 1),
1429                                        newLine[n])))) {
1430                 n = m;
1431             }
1432
1433             PutChar(NCURSES_SP_ARGx CHREF(newLine[n]));
1434
1435             /* check for turn-off:
1436              * If we are writing an attributed non-blank, where the
1437              * next cell is blank, and not attributed.
1438              */
1439             if (!ISBLANK(newLine[n])
1440                 && ((n + 1 < screen_columns(SP_PARM)
1441                      && xmc_turn_off(SP_PARM, newLine[n], newLine[n + 1]))
1442                     || (n + 1 >= screen_columns(SP_PARM)
1443                         && lineno + 1 < screen_lines(SP_PARM)
1444                         && xmc_turn_off(SP_PARM,
1445                                         newLine[n],
1446                                         xmc_new(SP_PARM, lineno + 1, 0))))) {
1447                 n = m;
1448             }
1449
1450         }
1451 #endif
1452     } else {
1453         NCURSES_CH_T blank;
1454
1455         /* it may be cheap to clear leading whitespace with clr_bol */
1456         blank = newLine[0];
1457         if (clr_bol && can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1458             int oFirstChar, nFirstChar;
1459
1460             for (oFirstChar = 0;
1461                  oFirstChar < screen_columns(SP_PARM);
1462                  oFirstChar++)
1463                 if (!CharEq(oldLine[oFirstChar], blank))
1464                     break;
1465             for (nFirstChar = 0;
1466                  nFirstChar < screen_columns(SP_PARM);
1467                  nFirstChar++)
1468                 if (!CharEq(newLine[nFirstChar], blank))
1469                     break;
1470
1471             if (nFirstChar == oFirstChar) {
1472                 firstChar = nFirstChar;
1473                 /* find the first differing character */
1474                 while (firstChar < screen_columns(SP_PARM)
1475                        && CharEq(newLine[firstChar], oldLine[firstChar]))
1476                     firstChar++;
1477             } else if (oFirstChar > nFirstChar) {
1478                 firstChar = nFirstChar;
1479             } else {            /* oFirstChar < nFirstChar */
1480                 firstChar = oFirstChar;
1481                 if (SP_PARM->_el1_cost < nFirstChar - oFirstChar) {
1482                     if (nFirstChar >= screen_columns(SP_PARM)
1483                         && SP_PARM->_el_cost <= SP_PARM->_el1_cost) {
1484                         GoTo(NCURSES_SP_ARGx lineno, 0);
1485                         UpdateAttrs(SP_PARM, blank);
1486                         NCURSES_PUTP2("clr_eol", clr_eol);
1487                     } else {
1488                         GoTo(NCURSES_SP_ARGx lineno, nFirstChar - 1);
1489                         UpdateAttrs(SP_PARM, blank);
1490                         NCURSES_PUTP2("clr_bol", clr_bol);
1491                     }
1492
1493                     while (firstChar < nFirstChar)
1494                         oldLine[firstChar++] = blank;
1495                 }
1496             }
1497         } else {
1498             /* find the first differing character */
1499             while (firstChar < screen_columns(SP_PARM)
1500                    && CharEq(newLine[firstChar], oldLine[firstChar]))
1501                 firstChar++;
1502         }
1503         /* if there wasn't one, we're done */
1504         if (firstChar >= screen_columns(SP_PARM)) {
1505             TR(TRACE_UPDATE, (T_RETURN("")));
1506             return;
1507         }
1508
1509         blank = newLine[screen_columns(SP_PARM) - 1];
1510
1511         if (!can_clear_with(NCURSES_SP_ARGx CHREF(blank))) {
1512             /* find the last differing character */
1513             nLastChar = screen_columns(SP_PARM) - 1;
1514
1515             while (nLastChar > firstChar
1516                    && CharEq(newLine[nLastChar], oldLine[nLastChar]))
1517                 nLastChar--;
1518
1519             if (nLastChar >= firstChar) {
1520                 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1521                 PutRange(NCURSES_SP_ARGx
1522                          oldLine,
1523                          newLine,
1524                          lineno,
1525                          firstChar,
1526                          nLastChar);
1527                 memcpy(oldLine + firstChar,
1528                        newLine + firstChar,
1529                        (unsigned) (nLastChar - firstChar + 1) * sizeof(NCURSES_CH_T));
1530             }
1531             TR(TRACE_UPDATE, (T_RETURN("")));
1532             return;
1533         }
1534
1535         /* find last non-blank character on old line */
1536         oLastChar = screen_columns(SP_PARM) - 1;
1537         while (oLastChar > firstChar && CharEq(oldLine[oLastChar], blank))
1538             oLastChar--;
1539
1540         /* find last non-blank character on new line */
1541         nLastChar = screen_columns(SP_PARM) - 1;
1542         while (nLastChar > firstChar && CharEq(newLine[nLastChar], blank))
1543             nLastChar--;
1544
1545         if ((nLastChar == firstChar)
1546             && (SP_PARM->_el_cost < (oLastChar - nLastChar))) {
1547             GoTo(NCURSES_SP_ARGx lineno, firstChar);
1548             if (!CharEq(newLine[firstChar], blank))
1549                 PutChar(NCURSES_SP_ARGx CHREF(newLine[firstChar]));
1550             ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1551         } else if ((nLastChar != oLastChar)
1552                    && (!CharEq(newLine[nLastChar], oldLine[oLastChar])
1553                        || !(SP_PARM->_nc_sp_idcok
1554                             && NCURSES_SP_NAME(has_ic) (NCURSES_SP_ARG)))) {
1555             GoTo(NCURSES_SP_ARGx lineno, firstChar);
1556             if ((oLastChar - nLastChar) > SP_PARM->_el_cost) {
1557                 if (PutRange(NCURSES_SP_ARGx
1558                              oldLine,
1559                              newLine,
1560                              lineno,
1561                              firstChar,
1562                              nLastChar)) {
1563                     GoTo(NCURSES_SP_ARGx lineno, nLastChar + 1);
1564                 }
1565                 ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1566             } else {
1567                 n = max(nLastChar, oLastChar);
1568                 PutRange(NCURSES_SP_ARGx
1569                          oldLine,
1570                          newLine,
1571                          lineno,
1572                          firstChar,
1573                          n);
1574             }
1575         } else {
1576             int nLastNonblank = nLastChar;
1577             int oLastNonblank = oLastChar;
1578
1579             /* find the last characters that really differ */
1580             /* can be -1 if no characters differ */
1581             while (CharEq(newLine[nLastChar], oldLine[oLastChar])) {
1582                 /* don't split a wide char */
1583                 if (isWidecExt(newLine[nLastChar]) &&
1584                     !CharEq(newLine[nLastChar - 1], oldLine[oLastChar - 1]))
1585                     break;
1586                 nLastChar--;
1587                 oLastChar--;
1588                 if (nLastChar == -1 || oLastChar == -1)
1589                     break;
1590             }
1591
1592             n = min(oLastChar, nLastChar);
1593             if (n >= firstChar) {
1594                 GoTo(NCURSES_SP_ARGx lineno, firstChar);
1595                 PutRange(NCURSES_SP_ARGx
1596                          oldLine,
1597                          newLine,
1598                          lineno,
1599                          firstChar,
1600                          n);
1601             }
1602
1603             if (oLastChar < nLastChar) {
1604                 int m = max(nLastNonblank, oLastNonblank);
1605 #if USE_WIDEC_SUPPORT
1606                 if (n) {
1607                     while (isWidecExt(newLine[n + 1]) && n) {
1608                         --n;
1609                         --oLastChar;    /* increase cost */
1610                     }
1611                 } else if (n >= firstChar &&
1612                            isWidecBase(newLine[n])) {
1613                     while (isWidecExt(newLine[n + 1])) {
1614                         ++n;
1615                         ++oLastChar;    /* decrease cost */
1616                     }
1617                 }
1618 #endif
1619                 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1620                 if ((nLastChar < nLastNonblank)
1621                     || InsCharCost(SP_PARM, nLastChar - oLastChar) > (m - n)) {
1622                     PutRange(NCURSES_SP_ARGx
1623                              oldLine,
1624                              newLine,
1625                              lineno,
1626                              n + 1,
1627                              m);
1628                 } else {
1629                     InsStr(NCURSES_SP_ARGx &newLine[n + 1], nLastChar - oLastChar);
1630                 }
1631             } else if (oLastChar > nLastChar) {
1632                 GoTo(NCURSES_SP_ARGx lineno, n + 1);
1633                 if (DelCharCost(SP_PARM, oLastChar - nLastChar)
1634                     > SP_PARM->_el_cost + nLastNonblank - (n + 1)) {
1635                     if (PutRange(NCURSES_SP_ARGx oldLine, newLine, lineno,
1636                                  n + 1, nLastNonblank)) {
1637                         GoTo(NCURSES_SP_ARGx lineno, nLastNonblank + 1);
1638                     }
1639                     ClrToEOL(NCURSES_SP_ARGx blank, FALSE);
1640                 } else {
1641                     /*
1642                      * The delete-char sequence will
1643                      * effectively shift in blanks from the
1644                      * right margin of the screen.  Ensure
1645                      * that they are the right color by
1646                      * setting the video attributes from
1647                      * the last character on the row.
1648                      */
1649                     UpdateAttrs(SP_PARM, blank);
1650                     DelChar(NCURSES_SP_ARGx oLastChar - nLastChar);
1651                 }
1652             }
1653         }
1654     }
1655
1656     /* update the code's internal representation */
1657     if (screen_columns(SP_PARM) > firstChar)
1658         memcpy(oldLine + firstChar,
1659                newLine + firstChar,
1660                (unsigned) (screen_columns(SP_PARM) - firstChar) * sizeof(NCURSES_CH_T));
1661     TR(TRACE_UPDATE, (T_RETURN("")));
1662     return;
1663 }
1664
1665 /*
1666 **      ClearScreen(blank)
1667 **
1668 **      Clear the physical screen and put cursor at home
1669 **
1670 */
1671
1672 static void
1673 ClearScreen(NCURSES_SP_DCLx NCURSES_CH_T blank)
1674 {
1675     int i, j;
1676     bool fast_clear = (clear_screen || clr_eos || clr_eol);
1677
1678     TR(TRACE_UPDATE, ("ClearScreen() called"));
1679
1680 #if NCURSES_EXT_FUNCS
1681     if (SP_PARM->_coloron
1682         && !SP_PARM->_default_color) {
1683         NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
1684                                        (short) GET_SCREEN_PAIR(SP_PARM),
1685                                        0,
1686                                        FALSE,
1687                                        NCURSES_SP_NAME(_nc_outch));
1688         if (!back_color_erase) {
1689             fast_clear = FALSE;
1690         }
1691     }
1692 #endif
1693
1694     if (fast_clear) {
1695         if (clear_screen) {
1696             UpdateAttrs(SP_PARM, blank);
1697             NCURSES_PUTP2("clear_screen", clear_screen);
1698             SP_PARM->_cursrow = SP_PARM->_curscol = 0;
1699             position_check(NCURSES_SP_ARGx
1700                            SP_PARM->_cursrow,
1701                            SP_PARM->_curscol,
1702                            "ClearScreen");
1703         } else if (clr_eos) {
1704             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1705             GoTo(NCURSES_SP_ARGx 0, 0);
1706             UpdateAttrs(SP_PARM, blank);
1707             TPUTS_TRACE("clr_eos");
1708             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1709                                     clr_eos,
1710                                     screen_lines(SP_PARM),
1711                                     NCURSES_SP_NAME(_nc_outch));
1712         } else if (clr_eol) {
1713             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
1714             UpdateAttrs(SP_PARM, blank);
1715             for (i = 0; i < screen_lines(SP_PARM); i++) {
1716                 GoTo(NCURSES_SP_ARGx i, 0);
1717                 NCURSES_PUTP2("clr_eol", clr_eol);
1718             }
1719             GoTo(NCURSES_SP_ARGx 0, 0);
1720         }
1721     } else {
1722         UpdateAttrs(SP_PARM, blank);
1723         for (i = 0; i < screen_lines(SP_PARM); i++) {
1724             GoTo(NCURSES_SP_ARGx i, 0);
1725             for (j = 0; j < screen_columns(SP_PARM); j++)
1726                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1727         }
1728         GoTo(NCURSES_SP_ARGx 0, 0);
1729     }
1730
1731     for (i = 0; i < screen_lines(SP_PARM); i++) {
1732         for (j = 0; j < screen_columns(SP_PARM); j++)
1733             CurScreen(SP_PARM)->_line[i].text[j] = blank;
1734     }
1735
1736     TR(TRACE_UPDATE, ("screen cleared"));
1737 }
1738
1739 /*
1740 **      InsStr(line, count)
1741 **
1742 **      Insert the count characters pointed to by line.
1743 **
1744 */
1745
1746 static void
1747 InsStr(NCURSES_SP_DCLx NCURSES_CH_T * line, int count)
1748 {
1749     TR(TRACE_UPDATE, ("InsStr(%p, %p,%d) called",
1750                       (void *) SP_PARM,
1751                       (void *) line, count));
1752
1753     /* Prefer parm_ich as it has the smallest cost - no need to shift
1754      * the whole line on each character. */
1755     /* The order must match that of InsCharCost. */
1756     if (parm_ich) {
1757         TPUTS_TRACE("parm_ich");
1758         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1759                                 TPARM_1(parm_ich, count),
1760                                 1,
1761                                 NCURSES_SP_NAME(_nc_outch));
1762         while (count > 0) {
1763             PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1764             line++;
1765             count--;
1766         }
1767     } else if (enter_insert_mode && exit_insert_mode) {
1768         NCURSES_PUTP2("enter_insert_mode", enter_insert_mode);
1769         while (count > 0) {
1770             PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1771             if (insert_padding) {
1772                 NCURSES_PUTP2("insert_padding", insert_padding);
1773             }
1774             line++;
1775             count--;
1776         }
1777         NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
1778     } else {
1779         while (count > 0) {
1780             NCURSES_PUTP2("insert_character", insert_character);
1781             PutAttrChar(NCURSES_SP_ARGx CHREF(*line));
1782             if (insert_padding) {
1783                 NCURSES_PUTP2("insert_padding", insert_padding);
1784             }
1785             line++;
1786             count--;
1787         }
1788     }
1789     position_check(NCURSES_SP_ARGx
1790                    SP_PARM->_cursrow,
1791                    SP_PARM->_curscol, "InsStr");
1792 }
1793
1794 /*
1795 **      DelChar(count)
1796 **
1797 **      Delete count characters at current position
1798 **
1799 */
1800
1801 static void
1802 DelChar(NCURSES_SP_DCLx int count)
1803 {
1804     TR(TRACE_UPDATE, ("DelChar(%p, %d) called, position = (%ld,%ld)",
1805                       (void *) SP_PARM, count,
1806                       (long) NewScreen(SP_PARM)->_cury,
1807                       (long) NewScreen(SP_PARM)->_curx));
1808
1809     if (parm_dch) {
1810         TPUTS_TRACE("parm_dch");
1811         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1812                                 TPARM_1(parm_dch, count),
1813                                 1,
1814                                 NCURSES_SP_NAME(_nc_outch));
1815     } else {
1816         int n;
1817
1818         for (n = 0; n < count; n++) {
1819             NCURSES_PUTP2("delete_character", delete_character);
1820         }
1821     }
1822 }
1823
1824 /*
1825  * Physical-scrolling support
1826  *
1827  * This code was adapted from Keith Bostic's hardware scrolling
1828  * support for 4.4BSD curses.  I (esr) translated it to use terminfo
1829  * capabilities, narrowed the call interface slightly, and cleaned
1830  * up some convoluted tests.  I also added support for the memory_above
1831  * memory_below, and non_dest_scroll_region capabilities.
1832  *
1833  * For this code to work, we must have either
1834  * change_scroll_region and scroll forward/reverse commands, or
1835  * insert and delete line capabilities.
1836  * When the scrolling region has been set, the cursor has to
1837  * be at the last line of the region to make the scroll up
1838  * happen, or on the first line of region to scroll down.
1839  *
1840  * This code makes one aesthetic decision in the opposite way from
1841  * BSD curses.  BSD curses preferred pairs of il/dl operations
1842  * over scrolls, allegedly because il/dl looked faster.  We, on
1843  * the other hand, prefer scrolls because (a) they're just as fast
1844  * on many terminals and (b) using them avoids bouncing an
1845  * unchanged bottom section of the screen up and down, which is
1846  * visually nasty.
1847  *
1848  * (lav): added more cases, used dl/il when bot==maxy and in csr case.
1849  *
1850  * I used assumption that capabilities il/il1/dl/dl1 work inside
1851  * changed scroll region not shifting screen contents outside of it.
1852  * If there are any terminals behaving different way, it would be
1853  * necessary to add some conditions to scroll_csr_forward/backward.
1854  */
1855
1856 /* Try to scroll up assuming given csr (miny, maxy). Returns ERR on failure */
1857 static int
1858 scroll_csr_forward(NCURSES_SP_DCLx
1859                    int n,
1860                    int top,
1861                    int bot,
1862                    int miny,
1863                    int maxy,
1864                    NCURSES_CH_T blank)
1865 {
1866     int i;
1867
1868     if (n == 1 && scroll_forward && top == miny && bot == maxy) {
1869         GoTo(NCURSES_SP_ARGx bot, 0);
1870         UpdateAttrs(SP_PARM, blank);
1871         NCURSES_PUTP2("scroll_forward", scroll_forward);
1872     } else if (n == 1 && delete_line && bot == maxy) {
1873         GoTo(NCURSES_SP_ARGx top, 0);
1874         UpdateAttrs(SP_PARM, blank);
1875         NCURSES_PUTP2("delete_line", delete_line);
1876     } else if (parm_index && top == miny && bot == maxy) {
1877         GoTo(NCURSES_SP_ARGx bot, 0);
1878         UpdateAttrs(SP_PARM, blank);
1879         TPUTS_TRACE("parm_index");
1880         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1881                                 TPARM_2(parm_index, n, 0),
1882                                 n,
1883                                 NCURSES_SP_NAME(_nc_outch));
1884     } else if (parm_delete_line && bot == maxy) {
1885         GoTo(NCURSES_SP_ARGx top, 0);
1886         UpdateAttrs(SP_PARM, blank);
1887         TPUTS_TRACE("parm_delete_line");
1888         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1889                                 TPARM_2(parm_delete_line, n, 0),
1890                                 n,
1891                                 NCURSES_SP_NAME(_nc_outch));
1892     } else if (scroll_forward && top == miny && bot == maxy) {
1893         GoTo(NCURSES_SP_ARGx bot, 0);
1894         UpdateAttrs(SP_PARM, blank);
1895         for (i = 0; i < n; i++) {
1896             NCURSES_PUTP2("scroll_forward", scroll_forward);
1897         }
1898     } else if (delete_line && bot == maxy) {
1899         GoTo(NCURSES_SP_ARGx top, 0);
1900         UpdateAttrs(SP_PARM, blank);
1901         for (i = 0; i < n; i++) {
1902             NCURSES_PUTP2("delete_line", delete_line);
1903         }
1904     } else
1905         return ERR;
1906
1907 #if NCURSES_EXT_FUNCS
1908     if (FILL_BCE(SP_PARM)) {
1909         int j;
1910         for (i = 0; i < n; i++) {
1911             GoTo(NCURSES_SP_ARGx bot - i, 0);
1912             for (j = 0; j < screen_columns(SP_PARM); j++)
1913                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1914         }
1915     }
1916 #endif
1917     return OK;
1918 }
1919
1920 /* Try to scroll down assuming given csr (miny, maxy). Returns ERR on failure */
1921 /* n > 0 */
1922 static int
1923 scroll_csr_backward(NCURSES_SP_DCLx
1924                     int n,
1925                     int top,
1926                     int bot,
1927                     int miny,
1928                     int maxy,
1929                     NCURSES_CH_T blank)
1930 {
1931     int i;
1932
1933     if (n == 1 && scroll_reverse && top == miny && bot == maxy) {
1934         GoTo(NCURSES_SP_ARGx top, 0);
1935         UpdateAttrs(SP_PARM, blank);
1936         NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1937     } else if (n == 1 && insert_line && bot == maxy) {
1938         GoTo(NCURSES_SP_ARGx top, 0);
1939         UpdateAttrs(SP_PARM, blank);
1940         NCURSES_PUTP2("insert_line", insert_line);
1941     } else if (parm_rindex && top == miny && bot == maxy) {
1942         GoTo(NCURSES_SP_ARGx top, 0);
1943         UpdateAttrs(SP_PARM, blank);
1944         TPUTS_TRACE("parm_rindex");
1945         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1946                                 TPARM_2(parm_rindex, n, 0),
1947                                 n,
1948                                 NCURSES_SP_NAME(_nc_outch));
1949     } else if (parm_insert_line && bot == maxy) {
1950         GoTo(NCURSES_SP_ARGx top, 0);
1951         UpdateAttrs(SP_PARM, blank);
1952         TPUTS_TRACE("parm_insert_line");
1953         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
1954                                 TPARM_2(parm_insert_line, n, 0),
1955                                 n,
1956                                 NCURSES_SP_NAME(_nc_outch));
1957     } else if (scroll_reverse && top == miny && bot == maxy) {
1958         GoTo(NCURSES_SP_ARGx top, 0);
1959         UpdateAttrs(SP_PARM, blank);
1960         for (i = 0; i < n; i++) {
1961             NCURSES_PUTP2("scroll_reverse", scroll_reverse);
1962         }
1963     } else if (insert_line && bot == maxy) {
1964         GoTo(NCURSES_SP_ARGx top, 0);
1965         UpdateAttrs(SP_PARM, blank);
1966         for (i = 0; i < n; i++) {
1967             NCURSES_PUTP2("insert_line", insert_line);
1968         }
1969     } else
1970         return ERR;
1971
1972 #if NCURSES_EXT_FUNCS
1973     if (FILL_BCE(SP_PARM)) {
1974         int j;
1975         for (i = 0; i < n; i++) {
1976             GoTo(NCURSES_SP_ARGx top + i, 0);
1977             for (j = 0; j < screen_columns(SP_PARM); j++)
1978                 PutChar(NCURSES_SP_ARGx CHREF(blank));
1979         }
1980     }
1981 #endif
1982     return OK;
1983 }
1984
1985 /* scroll by using delete_line at del and insert_line at ins */
1986 /* n > 0 */
1987 static int
1988 scroll_idl(NCURSES_SP_DCLx int n, int del, int ins, NCURSES_CH_T blank)
1989 {
1990     int i;
1991
1992     if (!((parm_delete_line || delete_line) && (parm_insert_line || insert_line)))
1993         return ERR;
1994
1995     GoTo(NCURSES_SP_ARGx del, 0);
1996     UpdateAttrs(SP_PARM, blank);
1997     if (n == 1 && delete_line) {
1998         NCURSES_PUTP2("delete_line", delete_line);
1999     } else if (parm_delete_line) {
2000         TPUTS_TRACE("parm_delete_line");
2001         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
2002                                 TPARM_2(parm_delete_line, n, 0),
2003                                 n,
2004                                 NCURSES_SP_NAME(_nc_outch));
2005     } else {                    /* if (delete_line) */
2006         for (i = 0; i < n; i++) {
2007             NCURSES_PUTP2("delete_line", delete_line);
2008         }
2009     }
2010
2011     GoTo(NCURSES_SP_ARGx ins, 0);
2012     UpdateAttrs(SP_PARM, blank);
2013     if (n == 1 && insert_line) {
2014         NCURSES_PUTP2("insert_line", insert_line);
2015     } else if (parm_insert_line) {
2016         TPUTS_TRACE("parm_insert_line");
2017         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
2018                                 TPARM_2(parm_insert_line, n, 0),
2019                                 n,
2020                                 NCURSES_SP_NAME(_nc_outch));
2021     } else {                    /* if (insert_line) */
2022         for (i = 0; i < n; i++) {
2023             NCURSES_PUTP2("insert_line", insert_line);
2024         }
2025     }
2026
2027     return OK;
2028 }
2029
2030 /*
2031  * Note:  some terminals require the cursor to be within the scrolling margins
2032  * before setting them.  Generally, the cursor must be at the appropriate end
2033  * of the scrolling margins when issuing an indexing operation (it is not
2034  * apparent whether it must also be at the left margin; we do this just to be
2035  * safe).  To make the related cursor movement a little faster, we use the
2036  * save/restore cursor capabilities if the terminal has them.
2037  */
2038 NCURSES_EXPORT(int)
2039 NCURSES_SP_NAME(_nc_scrolln) (NCURSES_SP_DCLx
2040                               int n,
2041                               int top,
2042                               int bot,
2043                               int maxy)
2044 /* scroll region from top to bot by n lines */
2045 {
2046     NCURSES_CH_T blank;
2047     int i;
2048     bool cursor_saved = FALSE;
2049     int res;
2050
2051     TR(TRACE_MOVE, ("_nc_scrolln(%p, %d, %d, %d, %d)",
2052                     (void *) SP_PARM, n, top, bot, maxy));
2053
2054     if (!IsValidScreen(SP_PARM))
2055         return (ERR);
2056
2057     blank = ClrBlank(NCURSES_SP_ARGx StdScreen(SP_PARM));
2058
2059 #if USE_XMC_SUPPORT
2060     /*
2061      * If we scroll, we might remove a cookie.
2062      */
2063     if (magic_cookie_glitch > 0) {
2064         return (ERR);
2065     }
2066 #endif
2067
2068     if (n > 0) {                /* scroll up (forward) */
2069         /*
2070          * Explicitly clear if stuff pushed off top of region might
2071          * be saved by the terminal.
2072          */
2073         res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, 0, maxy, blank);
2074
2075         if (res == ERR && change_scroll_region) {
2076             if ((((n == 1 && scroll_forward) || parm_index)
2077                  && (SP_PARM->_cursrow == bot || SP_PARM->_cursrow == bot - 1))
2078                 && save_cursor && restore_cursor) {
2079                 cursor_saved = TRUE;
2080                 NCURSES_PUTP2("save_cursor", save_cursor);
2081             }
2082             NCURSES_PUTP2("change_scroll_region",
2083                           TPARM_2(change_scroll_region, top, bot));
2084             if (cursor_saved) {
2085                 NCURSES_PUTP2("restore_cursor", restore_cursor);
2086             } else {
2087                 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2088             }
2089
2090             res = scroll_csr_forward(NCURSES_SP_ARGx n, top, bot, top, bot, blank);
2091
2092             NCURSES_PUTP2("change_scroll_region",
2093                           TPARM_2(change_scroll_region, 0, maxy));
2094             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2095         }
2096
2097         if (res == ERR && SP_PARM->_nc_sp_idlok)
2098             res = scroll_idl(NCURSES_SP_ARGx n, top, bot - n + 1, blank);
2099
2100         /*
2101          * Clear the newly shifted-in text.
2102          */
2103         if (res != ERR
2104             && (non_dest_scroll_region || (memory_below && bot == maxy))) {
2105             static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2106             if (bot == maxy && clr_eos) {
2107                 GoTo(NCURSES_SP_ARGx bot - n + 1, 0);
2108                 ClrToEOS(NCURSES_SP_ARGx blank2);
2109             } else {
2110                 for (i = 0; i < n; i++) {
2111                     GoTo(NCURSES_SP_ARGx bot - i, 0);
2112                     ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2113                 }
2114             }
2115         }
2116
2117     } else {                    /* (n < 0) - scroll down (backward) */
2118         res = scroll_csr_backward(NCURSES_SP_ARGx -n, top, bot, 0, maxy, blank);
2119
2120         if (res == ERR && change_scroll_region) {
2121             if (top != 0
2122                 && (SP_PARM->_cursrow == top ||
2123                     SP_PARM->_cursrow == top - 1)
2124                 && save_cursor && restore_cursor) {
2125                 cursor_saved = TRUE;
2126                 NCURSES_PUTP2("save_cursor", save_cursor);
2127             }
2128             NCURSES_PUTP2("change_scroll_region",
2129                           TPARM_2(change_scroll_region, top, bot));
2130             if (cursor_saved) {
2131                 NCURSES_PUTP2("restore_cursor", restore_cursor);
2132             } else {
2133                 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2134             }
2135
2136             res = scroll_csr_backward(NCURSES_SP_ARGx
2137                                       -n, top, bot, top, bot, blank);
2138
2139             NCURSES_PUTP2("change_scroll_region",
2140                           TPARM_2(change_scroll_region, 0, maxy));
2141             SP_PARM->_cursrow = SP_PARM->_curscol = -1;
2142         }
2143
2144         if (res == ERR && SP_PARM->_nc_sp_idlok)
2145             res = scroll_idl(NCURSES_SP_ARGx -n, bot + n + 1, top, blank);
2146
2147         /*
2148          * Clear the newly shifted-in text.
2149          */
2150         if (res != ERR
2151             && (non_dest_scroll_region || (memory_above && top == 0))) {
2152             static const NCURSES_CH_T blank2 = NewChar(BLANK_TEXT);
2153             for (i = 0; i < -n; i++) {
2154                 GoTo(NCURSES_SP_ARGx i + top, 0);
2155                 ClrToEOL(NCURSES_SP_ARGx blank2, FALSE);
2156             }
2157         }
2158     }
2159
2160     if (res == ERR)
2161         return (ERR);
2162
2163     _nc_scroll_window(CurScreen(SP_PARM), n,
2164                       (NCURSES_SIZE_T) top,
2165                       (NCURSES_SIZE_T) bot,
2166                       blank);
2167
2168     /* shift hash values too - they can be reused */
2169     NCURSES_SP_NAME(_nc_scroll_oldhash) (NCURSES_SP_ARGx n, top, bot);
2170
2171     return (OK);
2172 }
2173
2174 #if NCURSES_SP_FUNCS
2175 NCURSES_EXPORT(int)
2176 _nc_scrolln(int n, int top, int bot, int maxy)
2177 {
2178     return NCURSES_SP_NAME(_nc_scrolln) (CURRENT_SCREEN, n, top, bot, maxy);
2179 }
2180 #endif
2181
2182 NCURSES_EXPORT(void)
2183 NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_DCL0)
2184 {
2185     assert(SP_PARM);
2186
2187     /* make sure terminal is in a sane known state */
2188     SetAttr(SCREEN_ATTRS(SP_PARM), A_NORMAL);
2189     NewScreen(SP_PARM)->_clear = TRUE;
2190
2191     /* reset color pairs and definitions */
2192     if (SP_PARM->_coloron || SP_PARM->_color_defs)
2193         NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2194
2195     /* restore user-defined colors, if any */
2196     if (SP_PARM->_color_defs < 0 && !SP_PARM->_direct_color.value) {
2197         int n;
2198         SP_PARM->_color_defs = -(SP_PARM->_color_defs);
2199         for (n = 0; n < SP_PARM->_color_defs; ++n) {
2200             if (SP_PARM->_color_table[n].init) {
2201                 _nc_init_color(SP_PARM,
2202                                n,
2203                                SP_PARM->_color_table[n].r,
2204                                SP_PARM->_color_table[n].g,
2205                                SP_PARM->_color_table[n].b);
2206             }
2207         }
2208     }
2209
2210     if (exit_attribute_mode)
2211         NCURSES_PUTP2("exit_attribute_mode", exit_attribute_mode);
2212     else {
2213         /* turn off attributes */
2214         if (exit_alt_charset_mode)
2215             NCURSES_PUTP2("exit_alt_charset_mode", exit_alt_charset_mode);
2216         if (exit_standout_mode)
2217             NCURSES_PUTP2("exit_standout_mode", exit_standout_mode);
2218         if (exit_underline_mode)
2219             NCURSES_PUTP2("exit_underline_mode", exit_underline_mode);
2220     }
2221     if (exit_insert_mode)
2222         NCURSES_PUTP2("exit_insert_mode", exit_insert_mode);
2223     if (enter_am_mode && exit_am_mode) {
2224         if (auto_right_margin) {
2225             NCURSES_PUTP2("enter_am_mode", enter_am_mode);
2226         } else {
2227             NCURSES_PUTP2("exit_am_mode", exit_am_mode);
2228         }
2229     }
2230 }
2231
2232 #if NCURSES_SP_FUNCS
2233 NCURSES_EXPORT(void)
2234 _nc_screen_resume(void)
2235 {
2236     NCURSES_SP_NAME(_nc_screen_resume) (CURRENT_SCREEN);
2237 }
2238 #endif
2239
2240 NCURSES_EXPORT(void)
2241 NCURSES_SP_NAME(_nc_screen_init) (NCURSES_SP_DCL0)
2242 {
2243     NCURSES_SP_NAME(_nc_screen_resume) (NCURSES_SP_ARG);
2244 }
2245
2246 #if NCURSES_SP_FUNCS
2247 NCURSES_EXPORT(void)
2248 _nc_screen_init(void)
2249 {
2250     NCURSES_SP_NAME(_nc_screen_init) (CURRENT_SCREEN);
2251 }
2252 #endif
2253
2254 /* wrap up screen handling */
2255 NCURSES_EXPORT(void)
2256 NCURSES_SP_NAME(_nc_screen_wrap) (NCURSES_SP_DCL0)
2257 {
2258     if (SP_PARM != 0) {
2259
2260         UpdateAttrs(SP_PARM, normal);
2261 #if NCURSES_EXT_FUNCS
2262         if (SP_PARM->_coloron
2263             && !SP_PARM->_default_color) {
2264             static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
2265             SP_PARM->_default_color = TRUE;
2266             NCURSES_SP_NAME(_nc_do_color) (NCURSES_SP_ARGx
2267                                            -1,
2268                                            0,
2269                                            FALSE,
2270                                            NCURSES_SP_NAME(_nc_outch));
2271             SP_PARM->_default_color = FALSE;
2272
2273             TINFO_MVCUR(NCURSES_SP_ARGx
2274                         SP_PARM->_cursrow,
2275                         SP_PARM->_curscol,
2276                         screen_lines(SP_PARM) - 1,
2277                         0);
2278
2279             ClrToEOL(NCURSES_SP_ARGx blank, TRUE);
2280         }
2281 #endif
2282         if (SP_PARM->_color_defs) {
2283             NCURSES_SP_NAME(_nc_reset_colors) (NCURSES_SP_ARG);
2284         }
2285     }
2286 }
2287
2288 #if NCURSES_SP_FUNCS
2289 NCURSES_EXPORT(void)
2290 _nc_screen_wrap(void)
2291 {
2292     NCURSES_SP_NAME(_nc_screen_wrap) (CURRENT_SCREEN);
2293 }
2294 #endif
2295
2296 #if USE_XMC_SUPPORT
2297 NCURSES_EXPORT(void)
2298 NCURSES_SP_NAME(_nc_do_xmc_glitch) (NCURSES_SP_DCLx attr_t previous)
2299 {
2300     if (SP_PARM != 0) {
2301         attr_t chg = XMC_CHANGES(previous ^ AttrOf(SCREEN_ATTRS(SP_PARM)));
2302
2303         while (chg != 0) {
2304             if (chg & 1) {
2305                 SP_PARM->_curscol += magic_cookie_glitch;
2306                 if (SP_PARM->_curscol >= SP_PARM->_columns)
2307                     wrap_cursor(NCURSES_SP_ARG);
2308                 TR(TRACE_UPDATE, ("bumped to %d,%d after cookie",
2309                                   SP_PARM->_cursrow, SP_PARM->_curscol));
2310             }
2311             chg >>= 1;
2312         }
2313     }
2314 }
2315
2316 #if NCURSES_SP_FUNCS
2317 NCURSES_EXPORT(void)
2318 _nc_do_xmc_glitch(attr_t previous)
2319 {
2320     NCURSES_SP_NAME(_nc_do_xmc_glitch) (CURRENT_SCREEN, previous);
2321 }
2322 #endif
2323
2324 #endif /* USE_XMC_SUPPORT */