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