ncurses/tty/lib_mvcur.c

   1 /****************************************************************************
   2  * Copyright 2018-2022,2023 Thomas E. Dickey                                *
   3  * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
   4  *                                                                          *
   5  * Permission is hereby granted, free of charge, to any person obtaining a  *
   6  * copy of this software and associated documentation files (the            *
   7  * "Software"), to deal in the Software without restriction, including      *
   8  * without limitation the rights to use, copy, modify, merge, publish,      *
   9  * distribute, distribute with modifications, sublicense, and/or sell       *
  10  * copies of the Software, and to permit persons to whom the Software is    *
  11  * furnished to do so, subject to the following conditions:                 *
  12  *                                                                          *
  13  * The above copyright notice and this permission notice shall be included  *
  14  * in all copies or substantial portions of the Software.                   *
  15  *                                                                          *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23  *                                                                          *
  24  * Except as contained in this notice, the name(s) of the above copyright   *
  25  * holders shall not be used in advertising or otherwise to promote the     *
  26  * sale, use or other dealings in this Software without prior written       *
  27  * authorization.                                                           *
  28  ****************************************************************************/
  29
  30 /****************************************************************************
  31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  33  *     and: Thomas E. Dickey                        1996-on                 *
  34  *     and: Juergen Pfeifer                         2009                    *
  35  ****************************************************************************/
  36
  37 /*
  38 **      lib_mvcur.c
  39 **
  40 **      The routines for moving the physical cursor and scrolling:
  41 **
  42 **              void _nc_mvcur_init(void)
  43 **
  44 **              void _nc_mvcur_resume(void)
  45 **
  46 **              int mvcur(int old_y, int old_x, int new_y, int new_x)
  47 **
  48 **              void _nc_mvcur_wrap(void)
  49 **
  50 ** Comparisons with older movement optimizers:
  51 **    SVr3 curses mvcur() can't use cursor_to_ll or auto_left_margin.
  52 **    4.4BSD curses can't use cuu/cud/cuf/cub/hpa/vpa/tab/cbt for local
  53 ** motions.  It doesn't use tactics based on auto_left_margin.  Weirdly
  54 ** enough, it doesn't use its own hardware-scrolling routine to scroll up
  55 ** destination lines for out-of-bounds addresses!
  56 **    old ncurses optimizer: less accurate cost computations (in fact,
  57 ** it was broken and had to be commented out!).
  58 **
  59 ** Compile with -DMAIN to build an interactive tester/timer for the movement
  60 ** optimizer.  You can use it to investigate the optimizer's behavior.
  61 ** You can also use it for tuning the formulas used to determine whether
  62 ** or not full optimization is attempted.
  63 **
  64 ** This code has a nasty tendency to find bugs in terminfo entries, because it
  65 ** exercises the non-cup movement capabilities heavily.  If you think you've
  66 ** found a bug, try deleting subsets of the following capabilities (arranged
  67 ** in decreasing order of suspiciousness): it, tab, cbt, hpa, vpa, cuu, cud,
  68 ** cuf, cub, cuu1, cud1, cuf1, cub1.  It may be that one or more are wrong.
  69 **
  70 ** Note: you should expect this code to look like a resource hog in a profile.
  71 ** That's because it does a lot of I/O, through the tputs() calls.  The I/O
  72 ** cost swamps the computation overhead (and as machines get faster, this
  73 ** will become even more true).  Comments in the test exerciser at the end
  74 ** go into detail about tuning and how you can gauge the optimizer's
  75 ** effectiveness.
  76 **/
  77
  78 /****************************************************************************
  79  *
  80  * Constants and macros for optimizer tuning.
  81  *
  82  ****************************************************************************/
  83
  84 /*
  85  * The average overhead of a full optimization computation in character
  86  * transmission times.  If it is too high, the algorithm will be a bit
  87  * over-biased toward using cup rather than local motions; if it is too
  88  * low, the algorithm may spend more time than is strictly optimal
  89  * looking for non-cup motions.  Profile the optimizer using the `t'
  90  * command of the exerciser (see below), and round to the nearest integer.
  91  *
  92  * Yes, I (esr) thought about computing expected overhead dynamically, say
  93  * by derivation from a running average of optimizer times.  But the
  94  * whole point of this optimization is to *decrease* the frequency of
  95  * system calls. :-)
  96  */
  97 #define COMPUTE_OVERHEAD        1       /* I use a 90MHz Pentium @ 9.6Kbps */
  98
  99 /*
 100  * LONG_DIST is the distance we consider to be just as costly to move over as a
 101  * cup sequence is to emit.  In other words, it is the length of a cup sequence
 102  * adjusted for average computation overhead.  The magic number is the length
 103  * of "\033[yy;xxH", the typical cup sequence these days.
 104  */
 105 #define LONG_DIST               (8 - COMPUTE_OVERHEAD)
 106
 107 /*
 108  * Tell whether a motion is optimizable by local motions.  Needs to be cheap to
 109  * compute. In general, all the fast moves go to either the right or left edge
 110  * of the screen.  So any motion to a location that is (a) further away than
 111  * LONG_DIST and (b) further inward from the right or left edge than LONG_DIST,
 112  * we'll consider nonlocal.
 113  */
 114 #define NOT_LOCAL(sp, fy, fx, ty, tx)   ((tx > LONG_DIST) \
 115                  && (tx < screen_columns(sp) - 1 - LONG_DIST) \
 116                  && (abs(ty-fy) + abs(tx-fx) > LONG_DIST))
 117
 118 /****************************************************************************
 119  *
 120  * External interfaces
 121  *
 122  ****************************************************************************/
 123
 124 /*
 125  * For this code to work OK, the following components must live in the
 126  * screen structure:
 127  *
 128  *      int             _char_padding;  // cost of character put
 129  *      int             _cr_cost;       // cost of (carriage_return)
 130  *      int             _cup_cost;      // cost of (cursor_address)
 131  *      int             _home_cost;     // cost of (cursor_home)
 132  *      int             _ll_cost;       // cost of (cursor_to_ll)
 133  *#if USE_HARD_TABS
 134  *      int             _ht_cost;       // cost of (tab)
 135  *      int             _cbt_cost;      // cost of (back_tab)
 136  *#endif USE_HARD_TABS
 137  *      int             _cub1_cost;     // cost of (cursor_left)
 138  *      int             _cuf1_cost;     // cost of (cursor_right)
 139  *      int             _cud1_cost;     // cost of (cursor_down)
 140  *      int             _cuu1_cost;     // cost of (cursor_up)
 141  *      int             _cub_cost;      // cost of (parm_cursor_left)
 142  *      int             _cuf_cost;      // cost of (parm_cursor_right)
 143  *      int             _cud_cost;      // cost of (parm_cursor_down)
 144  *      int             _cuu_cost;      // cost of (parm_cursor_up)
 145  *      int             _hpa_cost;      // cost of (column_address)
 146  *      int             _vpa_cost;      // cost of (row_address)
 147  *      int             _ech_cost;      // cost of (erase_chars)
 148  *      int             _rep_cost;      // cost of (repeat_char)
 149  *
 150  * The USE_HARD_TABS switch controls whether it is reliable to use tab/backtabs
 151  * for local motions.  On many systems, it is not, due to uncertainties about
 152  * tab delays and whether or not tabs will be expanded in raw mode.  If you
 153  * have parm_right_cursor, tab motions don't win you a lot anyhow.
 154  */
 155
 156 #include <curses.priv.h>
 157 #include <ctype.h>
 158
 159 #ifndef CUR
 160 #define CUR SP_TERMTYPE
 161 #endif
 162
 163 MODULE_ID("$Id: lib_mvcur.c,v 1.161 2023/09/16 16:29:02 tom Exp $")
 164
 165 #define WANT_CHAR(sp, y, x) NewScreen(sp)->_line[y].text[x]     /* desired state */
 166
 167 #if NCURSES_SP_FUNCS
 168 #define BAUDRATE(sp)    sp->_term->_baudrate    /* bits per second */
 169 #else
 170 #define BAUDRATE(sp)    cur_term->_baudrate     /* bits per second */
 171 #endif
 172
 173 #if defined(MAIN) || defined(NCURSES_TEST)
 174 #include <sys/time.h>
 175
 176 static bool profiling = FALSE;
 177 static float diff;
 178 #endif /* MAIN */
 179
 180 #undef NCURSES_OUTC_FUNC
 181 #define NCURSES_OUTC_FUNC myOutCh
 182
 183 #define OPT_SIZE 512
 184
 185 static int normalized_cost(NCURSES_SP_DCLx const char *const cap, int affcnt);
 186
 187 /****************************************************************************
 188  *
 189  * Initialization/wrapup (including cost pre-computation)
 190  *
 191  ****************************************************************************/
 192
 193 #ifdef TRACE
 194 static int
 195 trace_cost_of(NCURSES_SP_DCLx const char *capname, const char *cap, int affcnt)
 196 {
 197     int result = NCURSES_SP_NAME(_nc_msec_cost) (NCURSES_SP_ARGx cap, affcnt);
 198     TR(TRACE_CHARPUT | TRACE_MOVE,
 199        ("CostOf %s %d %s", capname, result, _nc_visbuf(cap)));
 200     return result;
 201 }
 202 #define CostOf(cap,affcnt) trace_cost_of(NCURSES_SP_ARGx #cap, cap, affcnt)
 203
 204 static int
 205 trace_normalized_cost(NCURSES_SP_DCLx const char *capname, const char *cap, int affcnt)
 206 {
 207     int result = normalized_cost(NCURSES_SP_ARGx cap, affcnt);
 208     TR(TRACE_CHARPUT | TRACE_MOVE,
 209        ("NormalizedCost %s %d %s", capname, result, _nc_visbuf(cap)));
 210     return result;
 211 }
 212 #define NormalizedCost(cap,affcnt) trace_normalized_cost(NCURSES_SP_ARGx #cap, cap, affcnt)
 213
 214 #else
 215
 216 #define CostOf(cap,affcnt) NCURSES_SP_NAME(_nc_msec_cost)(NCURSES_SP_ARGx cap, affcnt)
 217 #define NormalizedCost(cap,affcnt) normalized_cost(NCURSES_SP_ARGx cap, affcnt)
 218
 219 #endif
 220
 221 NCURSES_EXPORT(int)
 222 NCURSES_SP_NAME(_nc_msec_cost) (NCURSES_SP_DCLx const char *const cap, int affcnt)
 223 /* compute the cost of a given operation */
 224 {
 225     if (cap == 0)
 226         return (INFINITY);
 227     else {
 228         const char *cp;
 229         float cum_cost = 0.0;
 230
 231         for (cp = cap; *cp; cp++) {
 232             /* extract padding, either mandatory or required */
 233             if (cp[0] == '$' && cp[1] == '<' && strchr(cp, '>')) {
 234                 float number = 0.0;
 235                 int state = 0;
 236
 237                 for (cp += 2; *cp != '>'; cp++) {
 238                     if (isdigit(UChar(*cp))) {
 239                         switch (state) {
 240                         case 0:
 241                             number = number * 10 + (float) (*cp - '0');
 242                             break;
 243                         case 2:
 244                             number += (float) ((*cp - '0') / 10.0);
 245                             ++state;
 246                             break;
 247                         }
 248                     } else if (*cp == '*') {
 249                         /* padding is always a suffix */
 250                         if (state < 4) {
 251                             number *= (float) affcnt;
 252                             state = 4;
 253                         }
 254                     } else if (*cp == '.') {
 255                         /* a single decimal point is allowed */
 256                         state = (state == 0) ? 2 : 3;
 257                     }
 258                     if (number > MAX_DELAY_MSECS) {
 259                         number = MAX_DELAY_MSECS;
 260                         break;
 261                     }
 262                 }
 263
 264 #if NCURSES_NO_PADDING
 265                 if (!GetNoPadding(SP_PARM))
 266 #endif
 267                     cum_cost += number * 10;
 268             } else if (SP_PARM) {
 269                 cum_cost += (float) SP_PARM->_char_padding;
 270             }
 271         }
 272
 273         return ((int) cum_cost);
 274     }
 275 }
 276
 277 #if NCURSES_SP_FUNCS
 278 NCURSES_EXPORT(int)
 279 _nc_msec_cost(const char *const cap, int affcnt)
 280 {
 281     return NCURSES_SP_NAME(_nc_msec_cost) (CURRENT_SCREEN, cap, affcnt);
 282 }
 283 #endif
 284
 285 static int
 286 normalized_cost(NCURSES_SP_DCLx const char *const cap, int affcnt)
 287 /* compute the effective character-count for an operation (round up) */
 288 {
 289     int cost = NCURSES_SP_NAME(_nc_msec_cost) (NCURSES_SP_ARGx cap, affcnt);
 290     if (cost != INFINITY)
 291         cost = (cost + SP_PARM->_char_padding - 1) / SP_PARM->_char_padding;
 292     return cost;
 293 }
 294
 295 static void
 296 reset_scroll_region(NCURSES_SP_DCL0)
 297 /* Set the scroll-region to a known state (the default) */
 298 {
 299     if (change_scroll_region) {
 300         NCURSES_PUTP2("change_scroll_region",
 301                       TIPARM_2(change_scroll_region,
 302                                0, screen_lines(SP_PARM) - 1));
 303     }
 304 }
 305
 306 NCURSES_EXPORT(void)
 307 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_DCL0)
 308 /* what to do at initialization time and after each shellout */
 309 {
 310     if (!SP_PARM || !IsTermInfo(SP_PARM))
 311         return;
 312
 313     /* initialize screen for cursor access */
 314     if (enter_ca_mode) {
 315         NCURSES_PUTP2("enter_ca_mode", enter_ca_mode);
 316     }
 317
 318     /*
 319      * Doing this here rather than in _nc_mvcur_wrap() ensures that
 320      * ncurses programs will see a reset scroll region even if a
 321      * program that messed with it died ungracefully.
 322      *
 323      * This also undoes the effects of terminal init strings that assume
 324      * they know the screen size.  This is useful when you're running
 325      * a vt100 emulation through xterm.
 326      */
 327     reset_scroll_region(NCURSES_SP_ARG);
 328     SP_PARM->_cursrow = SP_PARM->_curscol = -1;
 329
 330     /* restore cursor shape */
 331     if (SP_PARM->_cursor != -1) {
 332         int cursor = SP_PARM->_cursor;
 333         SP_PARM->_cursor = -1;
 334         NCURSES_SP_NAME(curs_set) (NCURSES_SP_ARGx cursor);
 335     }
 336 }
 337
 338 #if NCURSES_SP_FUNCS
 339 NCURSES_EXPORT(void)
 340 _nc_mvcur_resume(void)
 341 {
 342     NCURSES_SP_NAME(_nc_mvcur_resume) (CURRENT_SCREEN);
 343 }
 344 #endif
 345
 346 NCURSES_EXPORT(void)
 347 NCURSES_SP_NAME(_nc_mvcur_init) (NCURSES_SP_DCL0)
 348 /* initialize the cost structure */
 349 {
 350     if (SP_PARM->_ofp && NC_ISATTY(fileno(SP_PARM->_ofp))) {
 351         SP_PARM->_char_padding = ((BAUDBYTE * 1000 * 10)
 352                                   / (BAUDRATE(SP_PARM) > 0
 353                                      ? BAUDRATE(SP_PARM)
 354                                      : 9600));
 355     } else {
 356         SP_PARM->_char_padding = 1;     /* must be nonzero */
 357     }
 358     if (SP_PARM->_char_padding <= 0)
 359         SP_PARM->_char_padding = 1;     /* must be nonzero */
 360     TR(TRACE_CHARPUT | TRACE_MOVE, ("char_padding %d msecs", SP_PARM->_char_padding));
 361
 362     /* non-parameterized local-motion strings */
 363     SP_PARM->_cr_cost = CostOf(carriage_return, 0);
 364     SP_PARM->_home_cost = CostOf(cursor_home, 0);
 365     SP_PARM->_ll_cost = CostOf(cursor_to_ll, 0);
 366 #if USE_HARD_TABS
 367     if (getenv("NCURSES_NO_HARD_TABS") == 0
 368         && dest_tabs_magic_smso == 0
 369         && HasHardTabs()) {
 370         SP_PARM->_ht_cost = CostOf(tab, 0);
 371         SP_PARM->_cbt_cost = CostOf(back_tab, 0);
 372     } else {
 373         SP_PARM->_ht_cost = INFINITY;
 374         SP_PARM->_cbt_cost = INFINITY;
 375     }
 376 #endif /* USE_HARD_TABS */
 377     SP_PARM->_cub1_cost = CostOf(cursor_left, 0);
 378     SP_PARM->_cuf1_cost = CostOf(cursor_right, 0);
 379     SP_PARM->_cud1_cost = CostOf(cursor_down, 0);
 380     SP_PARM->_cuu1_cost = CostOf(cursor_up, 0);
 381
 382     SP_PARM->_smir_cost = CostOf(enter_insert_mode, 0);
 383     SP_PARM->_rmir_cost = CostOf(exit_insert_mode, 0);
 384     SP_PARM->_ip_cost = 0;
 385     if (insert_padding) {
 386         SP_PARM->_ip_cost = CostOf(insert_padding, 0);
 387     }
 388
 389     /*
 390      * Assumption: if the terminal has memory_relative addressing, the
 391      * initialization strings or smcup will set single-page mode so we
 392      * can treat it like absolute screen addressing.  This seems to be true
 393      * for all cursor_mem_address terminal types in the terminfo database.
 394      */
 395     SP_PARM->_address_cursor = cursor_address ? cursor_address : cursor_mem_address;
 396
 397     /*
 398      * Parametrized local-motion strings.  This static cost computation
 399      * depends on the following assumptions:
 400      *
 401      * (1) They never have * padding.  In the entire master terminfo database
 402      *     as of March 1995, only the obsolete Zenith Z-100 pc violates this.
 403      *     (Proportional padding is found mainly in insert, delete and scroll
 404      *     capabilities).
 405      *
 406      * (2) The average case of cup has two two-digit parameters.  Strictly,
 407      *     the average case for a 24 * 80 screen has ((10*10*(1 + 1)) +
 408      *     (14*10*(1 + 2)) + (10*70*(2 + 1)) + (14*70*4)) / (24*80) = 3.458
 409      *     digits of parameters.  On a 25x80 screen the average is 3.6197.
 410      *     On larger screens the value gets much closer to 4.
 411      *
 412      * (3) The average case of cub/cuf/hpa/ech/rep has 2 digits of parameters
 413      *     (strictly, (((10 * 1) + (70 * 2)) / 80) = 1.8750).
 414      *
 415      * (4) The average case of cud/cuu/vpa has 2 digits of parameters
 416      *     (strictly, (((10 * 1) + (14 * 2)) / 24) = 1.5833).
 417      *
 418      * All these averages depend on the assumption that all parameter values
 419      * are equally probable.
 420      */
 421     SP_PARM->_cup_cost = CostOf(TIPARM_2(SP_PARM->_address_cursor, 23, 23), 1);
 422     SP_PARM->_cub_cost = CostOf(TIPARM_1(parm_left_cursor, 23), 1);
 423     SP_PARM->_cuf_cost = CostOf(TIPARM_1(parm_right_cursor, 23), 1);
 424     SP_PARM->_cud_cost = CostOf(TIPARM_1(parm_down_cursor, 23), 1);
 425     SP_PARM->_cuu_cost = CostOf(TIPARM_1(parm_up_cursor, 23), 1);
 426     SP_PARM->_hpa_cost = CostOf(TIPARM_1(column_address, 23), 1);
 427     SP_PARM->_vpa_cost = CostOf(TIPARM_1(row_address, 23), 1);
 428
 429     /* non-parameterized screen-update strings */
 430     SP_PARM->_ed_cost = NormalizedCost(clr_eos, 1);
 431     SP_PARM->_el_cost = NormalizedCost(clr_eol, 1);
 432     SP_PARM->_el1_cost = NormalizedCost(clr_bol, 1);
 433     SP_PARM->_dch1_cost = NormalizedCost(delete_character, 1);
 434     SP_PARM->_ich1_cost = NormalizedCost(insert_character, 1);
 435
 436     /*
 437      * If this is a bce-terminal, we want to bias the choice so we use clr_eol
 438      * rather than spaces at the end of a line.
 439      */
 440     if (back_color_erase)
 441         SP_PARM->_el_cost = 0;
 442
 443     /* parameterized screen-update strings */
 444     SP_PARM->_dch_cost = NormalizedCost(TIPARM_1(parm_dch, 23), 1);
 445     SP_PARM->_ich_cost = NormalizedCost(TIPARM_1(parm_ich, 23), 1);
 446     SP_PARM->_ech_cost = NormalizedCost(TIPARM_1(erase_chars, 23), 1);
 447     SP_PARM->_rep_cost = NormalizedCost(TIPARM_2(repeat_char, ' ', 23), 1);
 448
 449     SP_PARM->_cup_ch_cost = NormalizedCost(TIPARM_2(SP_PARM->_address_cursor,
 450                                                     23, 23),
 451                                            1);
 452     SP_PARM->_hpa_ch_cost = NormalizedCost(TIPARM_1(column_address, 23), 1);
 453     SP_PARM->_cuf_ch_cost = NormalizedCost(TIPARM_1(parm_right_cursor, 23), 1);
 454     SP_PARM->_inline_cost = Min(SP_PARM->_cup_ch_cost,
 455                                 Min(SP_PARM->_hpa_ch_cost,
 456                                     SP_PARM->_cuf_ch_cost));
 457
 458     /*
 459      * If save_cursor is used within enter_ca_mode, we should not use it for
 460      * scrolling optimization, since the corresponding restore_cursor is not
 461      * nested on the various terminals (vt100, xterm, etc.) which use this
 462      * feature.
 463      */
 464     if (save_cursor != 0
 465         && enter_ca_mode != 0
 466         && strstr(enter_ca_mode, save_cursor) != 0) {
 467         T(("...suppressed sc/rc capability due to conflict with smcup/rmcup"));
 468         save_cursor = 0;
 469         restore_cursor = 0;
 470     }
 471
 472     /*
 473      * A different, possibly better way to arrange this would be to set the
 474      * SCREEN's _endwin at window initialization time and let this be called by
 475      * doupdate's return-from-shellout code.
 476      */
 477     NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
 478 }
 479
 480 #if NCURSES_SP_FUNCS
 481 NCURSES_EXPORT(void)
 482 _nc_mvcur_init(void)
 483 {
 484     NCURSES_SP_NAME(_nc_mvcur_init) (CURRENT_SCREEN);
 485 }
 486 #endif
 487
 488 NCURSES_EXPORT(void)
 489 NCURSES_SP_NAME(_nc_mvcur_wrap) (NCURSES_SP_DCL0)
 490 /* wrap up cursor-addressing mode */
 491 {
 492     if (!SP_PARM || !IsTermInfo(SP_PARM))
 493         return;
 494
 495     /* leave cursor at screen bottom */
 496     TINFO_MVCUR(NCURSES_SP_ARGx -1, -1, screen_lines(SP_PARM) - 1, 0);
 497
 498     /* set cursor to normal mode */
 499     if (SP_PARM->_cursor != -1) {
 500         int cursor = SP_PARM->_cursor;
 501         NCURSES_SP_NAME(curs_set) (NCURSES_SP_ARGx 1);
 502         SP_PARM->_cursor = cursor;
 503     }
 504
 505     if (exit_ca_mode) {
 506         NCURSES_PUTP2("exit_ca_mode", exit_ca_mode);
 507     }
 508     /*
 509      * Reset terminal's tab counter.  There's a long-time bug that
 510      * if you exit a "curses" program such as vi or more, tab
 511      * forward, and then backspace, the cursor doesn't go to the
 512      * right place.  The problem is that the kernel counts the
 513      * escape sequences that reset things as column positions.
 514      * Utter a \r to reset this invisibly.
 515      */
 516     NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_ARGx '\r');
 517 }
 518
 519 #if NCURSES_SP_FUNCS
 520 NCURSES_EXPORT(void)
 521 _nc_mvcur_wrap(void)
 522 {
 523     NCURSES_SP_NAME(_nc_mvcur_wrap) (CURRENT_SCREEN);
 524 }
 525 #endif
 526
 527 /****************************************************************************
 528  *
 529  * Optimized cursor movement
 530  *
 531  ****************************************************************************/
 532
 533 /*
 534  * Perform repeated-append, returning cost
 535  */
 536 static NCURSES_INLINE int
 537 repeated_append(string_desc * target, int total, int num, int repeat, const char *src)
 538 {
 539     size_t need = (size_t) repeat * strlen(src);
 540
 541     if (need < target->s_size) {
 542         while (repeat-- > 0) {
 543             if (_nc_safe_strcat(target, src)) {
 544                 total += num;
 545             } else {
 546                 total = INFINITY;
 547                 break;
 548             }
 549         }
 550     } else {
 551         total = INFINITY;
 552     }
 553     return total;
 554 }
 555
 556 #ifndef NO_OPTIMIZE
 557 #define NEXTTAB(fr)     (fr + init_tabs - (fr % init_tabs))
 558
 559 /*
 560  * Assume back_tab (CBT) does not wrap backwards at the left margin, return
 561  * a negative value at that point to simplify the loop.
 562  */
 563 #define LASTTAB(fr)     ((fr > 0) ? ((fr - 1) / init_tabs) * init_tabs : -1)
 564
 565 static int
 566 relative_move(NCURSES_SP_DCLx
 567               string_desc * target,
 568               int from_y,
 569               int from_x,
 570               int to_y,
 571               int to_x,
 572               int ovw)
 573 /* move via local motions (cuu/cuu1/cud/cud1/cub1/cub/cuf1/cuf/vpa/hpa) */
 574 {
 575     string_desc save;
 576     int n, vcost = 0, hcost = 0;
 577
 578     (void) _nc_str_copy(&save, target);
 579
 580     if (to_y != from_y) {
 581         vcost = INFINITY;
 582
 583         if (row_address != 0
 584             && _nc_safe_strcat(target, TIPARM_1(row_address, to_y))) {
 585             vcost = SP_PARM->_vpa_cost;
 586         }
 587
 588         if (to_y > from_y) {
 589             n = (to_y - from_y);
 590
 591             if (parm_down_cursor
 592                 && SP_PARM->_cud_cost < vcost
 593                 && _nc_safe_strcat(_nc_str_copy(target, &save),
 594                                    TIPARM_1(parm_down_cursor, n))) {
 595                 vcost = SP_PARM->_cud_cost;
 596             }
 597
 598             if (cursor_down
 599                 && (*cursor_down != '\n')
 600                 && (n * SP_PARM->_cud1_cost < vcost)) {
 601                 vcost = repeated_append(_nc_str_copy(target, &save), 0,
 602                                         SP_PARM->_cud1_cost, n, cursor_down);
 603             }
 604         } else {                /* (to_y < from_y) */
 605             n = (from_y - to_y);
 606
 607             if (parm_up_cursor
 608                 && SP_PARM->_cuu_cost < vcost
 609                 && _nc_safe_strcat(_nc_str_copy(target, &save),
 610                                    TIPARM_1(parm_up_cursor, n))) {
 611                 vcost = SP_PARM->_cuu_cost;
 612             }
 613
 614             if (cursor_up && (n * SP_PARM->_cuu1_cost < vcost)) {
 615                 vcost = repeated_append(_nc_str_copy(target, &save), 0,
 616                                         SP_PARM->_cuu1_cost, n, cursor_up);
 617             }
 618         }
 619
 620         if (vcost == INFINITY)
 621             return (INFINITY);
 622     }
 623
 624     save = *target;
 625
 626     if (to_x != from_x) {
 627         char str[OPT_SIZE];
 628         string_desc check;
 629
 630         hcost = INFINITY;
 631
 632         if (column_address
 633             && _nc_safe_strcat(_nc_str_copy(target, &save),
 634                                TIPARM_1(column_address, to_x))) {
 635             hcost = SP_PARM->_hpa_cost;
 636         }
 637
 638         if (to_x > from_x) {
 639             n = to_x - from_x;
 640
 641             if (parm_right_cursor
 642                 && SP_PARM->_cuf_cost < hcost
 643                 && _nc_safe_strcat(_nc_str_copy(target, &save),
 644                                    TIPARM_1(parm_right_cursor, n))) {
 645                 hcost = SP_PARM->_cuf_cost;
 646             }
 647
 648             if (cursor_right) {
 649                 int lhcost = 0;
 650
 651                 (void) _nc_str_init(&check, str, sizeof(str));
 652
 653 #if USE_HARD_TABS
 654                 /* use hard tabs, if we have them, to do as much as possible */
 655                 if (init_tabs > 0 && tab) {
 656                     int nxt, fr;
 657
 658                     for (fr = from_x; (nxt = NEXTTAB(fr)) <= to_x; fr = nxt) {
 659                         lhcost = repeated_append(&check, lhcost,
 660                                                  SP_PARM->_ht_cost, 1, tab);
 661                         if (lhcost == INFINITY)
 662                             break;
 663                     }
 664
 665                     n = to_x - fr;
 666                     from_x = fr;
 667                 }
 668 #endif /* USE_HARD_TABS */
 669
 670                 if (n <= 0 || n >= (int) check.s_size)
 671                     ovw = FALSE;
 672 #if BSD_TPUTS
 673                 /*
 674                  * If we're allowing BSD-style padding in tputs, don't generate
 675                  * a string with a leading digit.  Otherwise, that will be
 676                  * interpreted as a padding value rather than sent to the
 677                  * screen.
 678                  */
 679                 if (ovw
 680                     && n > 0
 681                     && n < (int) check.s_size
 682                     && vcost == 0
 683                     && str[0] == '\0') {
 684                     int wanted = CharOf(WANT_CHAR(SP_PARM, to_y, from_x));
 685                     if (is8bits(wanted) && isdigit(wanted))
 686                         ovw = FALSE;
 687                 }
 688 #endif
 689                 /*
 690                  * If we have no attribute changes, overwrite is cheaper.
 691                  * Note: must suppress this by passing in ovw = FALSE whenever
 692                  * WANT_CHAR would return invalid data.  In particular, this
 693                  * is true between the time a hardware scroll has been done
 694                  * and the time the structure WANT_CHAR would access has been
 695                  * updated.
 696                  */
 697                 if (ovw && to_y >= 0) {
 698                     int i;
 699
 700                     for (i = 0; i < n; i++) {
 701                         NCURSES_CH_T ch = WANT_CHAR(SP_PARM, to_y, from_x + i);
 702                         if (!SameAttrOf(ch, SCREEN_ATTRS(SP_PARM))
 703 #if USE_WIDEC_SUPPORT
 704                             || !Charable(ch)
 705 #endif
 706                             ) {
 707                             ovw = FALSE;
 708                             break;
 709                         }
 710                     }
 711                 }
 712                 if (ovw && to_y >= 0) {
 713                     int i;
 714
 715                     for (i = 0; i < n; i++)
 716                         *check.s_tail++ = (char) CharOf(WANT_CHAR(SP_PARM, to_y,
 717                                                                   from_x + i));
 718                     *check.s_tail = '\0';
 719                     check.s_size -= (size_t) n;
 720                     lhcost += n * SP_PARM->_char_padding;
 721                 } else {
 722                     lhcost = repeated_append(&check, lhcost, SP_PARM->_cuf1_cost,
 723                                              n, cursor_right);
 724                 }
 725
 726                 if (lhcost < hcost
 727                     && _nc_safe_strcat(_nc_str_copy(target, &save), str)) {
 728                     hcost = lhcost;
 729                 }
 730             }
 731         } else {                /* (to_x < from_x) */
 732             n = from_x - to_x;
 733
 734             if (parm_left_cursor
 735                 && SP_PARM->_cub_cost < hcost
 736                 && _nc_safe_strcat(_nc_str_copy(target, &save),
 737                                    TIPARM_1(parm_left_cursor, n))) {
 738                 hcost = SP_PARM->_cub_cost;
 739             }
 740
 741             if (cursor_left) {
 742                 int lhcost = 0;
 743
 744                 (void) _nc_str_init(&check, str, sizeof(str));
 745
 746 #if USE_HARD_TABS
 747                 if (init_tabs > 0 && back_tab) {
 748                     int nxt, fr;
 749
 750                     for (fr = from_x; (nxt = LASTTAB(fr)) >= to_x; fr = nxt) {
 751                         lhcost = repeated_append(&check, lhcost,
 752                                                  SP_PARM->_cbt_cost,
 753                                                  1, back_tab);
 754                         if (lhcost == INFINITY)
 755                             break;
 756                     }
 757
 758                     n = fr - to_x;
 759                 }
 760 #endif /* USE_HARD_TABS */
 761
 762                 lhcost = repeated_append(&check, lhcost,
 763                                          SP_PARM->_cub1_cost,
 764                                          n, cursor_left);
 765
 766                 if (lhcost < hcost
 767                     && _nc_safe_strcat(_nc_str_copy(target, &save), str)) {
 768                     hcost = lhcost;
 769                 }
 770             }
 771         }
 772
 773         if (hcost == INFINITY)
 774             return (INFINITY);
 775     }
 776
 777     return (vcost + hcost);
 778 }
 779 #endif /* !NO_OPTIMIZE */
 780
 781 /*
 782  * With the machinery set up above, it is conceivable that
 783  * onscreen_mvcur could be modified into a recursive function that does
 784  * an alpha-beta search of motion space, as though it were a chess
 785  * move tree, with the weight function being boolean and the search
 786  * depth equated to length of string.  However, this would jack up the
 787  * computation cost a lot, especially on terminals without a cup
 788  * capability constraining the search tree depth.  So we settle for
 789  * the simpler method below.
 790  */
 791
 792 static NCURSES_INLINE int
 793 onscreen_mvcur(NCURSES_SP_DCLx
 794                int yold, int xold,
 795                int ynew, int xnew, int ovw,
 796                NCURSES_SP_OUTC myOutCh)
 797 /* onscreen move from (yold, xold) to (ynew, xnew) */
 798 {
 799     string_desc result;
 800     char buffer[OPT_SIZE];
 801     int tactic = 0, newcost, usecost = INFINITY;
 802     int t5_cr_cost;
 803
 804 #if defined(MAIN) || defined(NCURSES_TEST)
 805     struct timeval before, after;
 806
 807     gettimeofday(&before, NULL);
 808 #endif /* MAIN */
 809
 810 #define NullResult _nc_str_null(&result, sizeof(buffer))
 811 #define InitResult _nc_str_init(&result, buffer, sizeof(buffer))
 812
 813     /* tactic #0: use direct cursor addressing */
 814     if (_nc_safe_strcpy(InitResult, TIPARM_2(SP_PARM->_address_cursor,
 815                                              ynew, xnew))) {
 816         tactic = 0;
 817         usecost = SP_PARM->_cup_cost;
 818
 819 #if defined(TRACE) || defined(NCURSES_TEST)
 820         if (!(_nc_optimize_enable & OPTIMIZE_MVCUR))
 821             goto nonlocal;
 822 #endif /* TRACE */
 823
 824         /*
 825          * We may be able to tell in advance that the full optimization
 826          * will probably not be worth its overhead.  Also, don't try to
 827          * use local movement if the current attribute is anything but
 828          * A_NORMAL...there are just too many ways this can screw up
 829          * (like, say, local-movement \n getting mapped to some obscure
 830          * character because A_ALTCHARSET is on).
 831          */
 832         if (yold == -1 || xold == -1 || NOT_LOCAL(SP_PARM, yold, xold, ynew, xnew)) {
 833 #if defined(MAIN) || defined(NCURSES_TEST)
 834             if (!profiling) {
 835                 (void) fputs("nonlocal\n", stderr);
 836                 goto nonlocal;  /* always run the optimizer if profiling */
 837             }
 838 #else
 839             goto nonlocal;
 840 #endif /* MAIN */
 841         }
 842     }
 843 #ifndef NO_OPTIMIZE
 844     /* tactic #1: use local movement */
 845     if (yold != -1 && xold != -1
 846         && ((newcost = relative_move(NCURSES_SP_ARGx
 847                                      NullResult,
 848                                      yold, xold,
 849                                      ynew, xnew, ovw)) != INFINITY)
 850         && newcost < usecost) {
 851         tactic = 1;
 852         usecost = newcost;
 853     }
 854
 855     /* tactic #2: use carriage-return + local movement */
 856     if (yold != -1 && carriage_return
 857         && ((newcost = relative_move(NCURSES_SP_ARGx
 858                                      NullResult,
 859                                      yold, 0,
 860                                      ynew, xnew, ovw)) != INFINITY)
 861         && SP_PARM->_cr_cost + newcost < usecost) {
 862         tactic = 2;
 863         usecost = SP_PARM->_cr_cost + newcost;
 864     }
 865
 866     /* tactic #3: use home-cursor + local movement */
 867     if (cursor_home
 868         && ((newcost = relative_move(NCURSES_SP_ARGx
 869                                      NullResult,
 870                                      0, 0,
 871                                      ynew, xnew, ovw)) != INFINITY)
 872         && SP_PARM->_home_cost + newcost < usecost) {
 873         tactic = 3;
 874         usecost = SP_PARM->_home_cost + newcost;
 875     }
 876
 877     /* tactic #4: use home-down + local movement */
 878     if (cursor_to_ll
 879         && ((newcost = relative_move(NCURSES_SP_ARGx
 880                                      NullResult,
 881                                      screen_lines(SP_PARM) - 1, 0,
 882                                      ynew, xnew, ovw)) != INFINITY)
 883         && SP_PARM->_ll_cost + newcost < usecost) {
 884         tactic = 4;
 885         usecost = SP_PARM->_ll_cost + newcost;
 886     }
 887
 888     /*
 889      * tactic #5: use left margin for wrap to right-hand side,
 890      * unless strange wrap behavior indicated by xenl might hose us.
 891      */
 892     t5_cr_cost = (xold > 0 ? SP_PARM->_cr_cost : 0);
 893     if (auto_left_margin && !eat_newline_glitch
 894         && yold > 0 && cursor_left
 895         && ((newcost = relative_move(NCURSES_SP_ARGx
 896                                      NullResult,
 897                                      yold - 1, screen_columns(SP_PARM) - 1,
 898                                      ynew, xnew, ovw)) != INFINITY)
 899         && t5_cr_cost + SP_PARM->_cub1_cost + newcost < usecost) {
 900         tactic = 5;
 901         usecost = t5_cr_cost + SP_PARM->_cub1_cost + newcost;
 902     }
 903
 904     /*
 905      * These cases are ordered by estimated relative frequency.
 906      */
 907     if (tactic)
 908         InitResult;
 909     switch (tactic) {
 910     case 1:
 911         (void) relative_move(NCURSES_SP_ARGx
 912                              &result,
 913                              yold, xold,
 914                              ynew, xnew, ovw);
 915         break;
 916     case 2:
 917         (void) _nc_safe_strcpy(&result, carriage_return);
 918         (void) relative_move(NCURSES_SP_ARGx
 919                              &result,
 920                              yold, 0,
 921                              ynew, xnew, ovw);
 922         break;
 923     case 3:
 924         (void) _nc_safe_strcpy(&result, cursor_home);
 925         (void) relative_move(NCURSES_SP_ARGx
 926                              &result, 0, 0,
 927                              ynew, xnew, ovw);
 928         break;
 929     case 4:
 930         (void) _nc_safe_strcpy(&result, cursor_to_ll);
 931         (void) relative_move(NCURSES_SP_ARGx
 932                              &result,
 933                              screen_lines(SP_PARM) - 1, 0,
 934                              ynew, xnew, ovw);
 935         break;
 936     case 5:
 937         if (xold > 0)
 938             (void) _nc_safe_strcat(&result, carriage_return);
 939         (void) _nc_safe_strcat(&result, cursor_left);
 940         (void) relative_move(NCURSES_SP_ARGx
 941                              &result,
 942                              yold - 1, screen_columns(SP_PARM) - 1,
 943                              ynew, xnew, ovw);
 944         break;
 945     }
 946 #endif /* !NO_OPTIMIZE */
 947
 948   nonlocal:
 949 #if defined(MAIN) || defined(NCURSES_TEST)
 950     gettimeofday(&after, NULL);
 951     diff = after.tv_usec - before.tv_usec
 952         + (after.tv_sec - before.tv_sec) * 1000000;
 953     if (!profiling)
 954         (void) fprintf(stderr,
 955                        "onscreen: %d microsec, %f 28.8Kbps char-equivalents\n",
 956                        (int) diff, diff / 288);
 957 #endif /* MAIN */
 958
 959     if (usecost != INFINITY) {
 960         TR(TRACE_MOVE, ("mvcur tactic %d", tactic));
 961         TPUTS_TRACE("mvcur");
 962         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
 963                                 buffer, 1, myOutCh);
 964         SP_PARM->_cursrow = ynew;
 965         SP_PARM->_curscol = xnew;
 966         return (OK);
 967     } else
 968         return (ERR);
 969 }
 970
 971 /*
 972  * optimized cursor move from (yold, xold) to (ynew, xnew)
 973  */
 974 static int
 975 _nc_real_mvcur(NCURSES_SP_DCLx
 976                int yold, int xold,
 977                int ynew, int xnew,
 978                NCURSES_SP_OUTC myOutCh,
 979                int ovw)
 980 {
 981     NCURSES_CH_T oldattr;
 982     int code;
 983
 984     TR(TRACE_CALLS | TRACE_MOVE, (T_CALLED("_nc_real_mvcur(%p,%d,%d,%d,%d)"),
 985                                   (void *) SP_PARM, yold, xold, ynew, xnew));
 986
 987     if (SP_PARM == 0) {
 988         code = ERR;
 989     } else if (yold == ynew && xold == xnew) {
 990         code = OK;
 991     } else {
 992
 993         /*
 994          * Most work here is rounding for terminal boundaries getting the
 995          * column position implied by wraparound or the lack thereof and
 996          * rolling up the screen to get ynew on the screen.
 997          */
 998         if (xnew >= screen_columns(SP_PARM)) {
 999             ynew += xnew / screen_columns(SP_PARM);
1000             xnew %= screen_columns(SP_PARM);
1001         }
1002
1003         /*
1004          * Force restore even if msgr is on when we're in an alternate
1005          * character set -- these have a strong tendency to screw up the CR &
1006          * LF used for local character motions!
1007          */
1008         oldattr = SCREEN_ATTRS(SP_PARM);
1009         if ((AttrOf(oldattr) & A_ALTCHARSET)
1010             || (AttrOf(oldattr) && !move_standout_mode)) {
1011             TR(TRACE_CHARPUT, ("turning off (%#lx) %s before move",
1012                                (unsigned long) AttrOf(oldattr),
1013                                _traceattr(AttrOf(oldattr))));
1014             VIDPUTS(SP_PARM, A_NORMAL, 0);
1015         }
1016
1017         if (xold >= screen_columns(SP_PARM)) {
1018
1019             int l = (xold + 1) / screen_columns(SP_PARM);
1020
1021             yold += l;
1022             if (yold >= screen_lines(SP_PARM))
1023                 l -= (yold - screen_lines(SP_PARM) - 1);
1024
1025             if (l > 0) {
1026                 if (carriage_return) {
1027                     NCURSES_PUTP2("carriage_return", carriage_return);
1028                 } else {
1029                     myOutCh(NCURSES_SP_ARGx '\r');
1030                 }
1031                 xold = 0;
1032
1033                 while (l > 0) {
1034                     if (newline) {
1035                         NCURSES_PUTP2("newline", newline);
1036                     } else {
1037                         myOutCh(NCURSES_SP_ARGx '\n');
1038                     }
1039                     l--;
1040                 }
1041             }
1042         }
1043
1044         if (yold > screen_lines(SP_PARM) - 1)
1045             yold = screen_lines(SP_PARM) - 1;
1046         if (ynew > screen_lines(SP_PARM) - 1)
1047             ynew = screen_lines(SP_PARM) - 1;
1048
1049         /* destination location is on screen now */
1050         code = onscreen_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew, ovw, myOutCh);
1051
1052         /*
1053          * Restore attributes if we disabled them before moving.
1054          */
1055         if (!SameAttrOf(oldattr, SCREEN_ATTRS(SP_PARM))) {
1056             TR(TRACE_CHARPUT, ("turning on (%#lx) %s after move",
1057                                (unsigned long) AttrOf(oldattr),
1058                                _traceattr(AttrOf(oldattr))));
1059             VIDPUTS(SP_PARM, AttrOf(oldattr), GetPair(oldattr));
1060         }
1061     }
1062     returnCode(code);
1063 }
1064
1065 /*
1066  * These entrypoints are used within the library.
1067  */
1068 NCURSES_EXPORT(int)
1069 NCURSES_SP_NAME(_nc_mvcur) (NCURSES_SP_DCLx
1070                             int yold, int xold,
1071                             int ynew, int xnew)
1072 {
1073     int rc;
1074     rc = _nc_real_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew,
1075                         NCURSES_SP_NAME(_nc_outch),
1076                         TRUE);
1077     /*
1078      * With the terminal-driver, we cannot distinguish between internal and
1079      * external calls.  Flush the output if the screen has not been
1080      * initialized, e.g., when used from low-level terminfo programs.
1081      */
1082     if ((SP_PARM != 0) && (SP_PARM->_endwin == ewInitial))
1083         NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1084     return rc;
1085 }
1086
1087 #if NCURSES_SP_FUNCS
1088 NCURSES_EXPORT(int)
1089 _nc_mvcur(int yold, int xold,
1090           int ynew, int xnew)
1091 {
1092     return NCURSES_SP_NAME(_nc_mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
1093 }
1094 #endif
1095
1096 #if defined(USE_TERM_DRIVER)
1097 /*
1098  * The terminal driver does not support the external "mvcur()".
1099  */
1100 NCURSES_EXPORT(int)
1101 TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
1102 {
1103     int rc;
1104     rc = _nc_real_mvcur(NCURSES_SP_ARGx
1105                         yold, xold,
1106                         ynew, xnew,
1107                         NCURSES_SP_NAME(_nc_outch),
1108                         TRUE);
1109     if ((SP_PARM != 0) && (SP_PARM->_endwin == ewInitial))
1110         NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1111     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1112     return rc;
1113 }
1114
1115 #else /* !USE_TERM_DRIVER */
1116
1117 /*
1118  * These entrypoints support users of the library.
1119  */
1120 NCURSES_EXPORT(int)
1121 NCURSES_SP_NAME(mvcur) (NCURSES_SP_DCLx int yold, int xold, int ynew,
1122                         int xnew)
1123 {
1124     return _nc_real_mvcur(NCURSES_SP_ARGx
1125                           yold, xold,
1126                           ynew, xnew,
1127                           NCURSES_SP_NAME(_nc_putchar),
1128                           FALSE);
1129 }
1130
1131 #if NCURSES_SP_FUNCS
1132 NCURSES_EXPORT(int)
1133 mvcur(int yold, int xold, int ynew, int xnew)
1134 {
1135     return NCURSES_SP_NAME(mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
1136 }
1137 #endif
1138 #endif /* USE_TERM_DRIVER */
1139
1140 #if defined(TRACE) || defined(NCURSES_TEST)
1141 NCURSES_EXPORT_VAR(int) _nc_optimize_enable = OPTIMIZE_ALL;
1142 #endif
1143
1144 #if defined(MAIN) || defined(NCURSES_TEST)
1145 /****************************************************************************
1146  *
1147  * Movement optimizer test code
1148  *
1149  ****************************************************************************/
1150
1151 #include <tic.h>
1152 #include <dump_entry.h>
1153 #include <time.h>
1154
1155 NCURSES_EXPORT_VAR(const char *) _nc_progname = "mvcur";
1156
1157 static unsigned long xmits;
1158
1159 /* these override lib_tputs.c */
1160 NCURSES_EXPORT(int)
1161 tputs(const char *string, int affcnt GCC_UNUSED, int (*outc) (int) GCC_UNUSED)
1162 /* stub tputs() that dumps sequences in a visible form */
1163 {
1164     if (profiling)
1165         xmits += strlen(string);
1166     else
1167         (void) fputs(_nc_visbuf(string), stdout);
1168     return (OK);
1169 }
1170
1171 NCURSES_EXPORT(int)
1172 putp(const char *string)
1173 {
1174     return (tputs(string, 1, _nc_outch));
1175 }
1176
1177 NCURSES_EXPORT(int)
1178 _nc_outch(int ch)
1179 {
1180     putc(ch, stdout);
1181     return OK;
1182 }
1183
1184 NCURSES_EXPORT(int)
1185 delay_output(int ms GCC_UNUSED)
1186 {
1187     return OK;
1188 }
1189
1190 static char tname[PATH_MAX];
1191
1192 static void
1193 load_term(void)
1194 {
1195     (void) setupterm(tname, STDOUT_FILENO, NULL);
1196 }
1197
1198 static int
1199 roll(int n)
1200 {
1201     int i, j;
1202
1203     i = (RAND_MAX / n) * n;
1204     while ((j = rand()) >= i)
1205         continue;
1206     return (j % n);
1207 }
1208
1209 int
1210 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
1211 {
1212     _nc_STRCPY(tname, getenv("TERM"), sizeof(tname));
1213     load_term();
1214     _nc_setupscreen(lines, columns, stdout, FALSE, 0);
1215     baudrate();
1216
1217     _nc_mvcur_init();
1218
1219     (void) puts("The mvcur tester.  Type ? for help");
1220
1221     fputs("smcup:", stdout);
1222     putchar('\n');
1223
1224     for (;;) {
1225         int fy, fx, ty, tx, n, i;
1226         char buf[BUFSIZ], capname[BUFSIZ];
1227
1228         if (fputs("> ", stdout) == EOF)
1229             break;
1230         if (fgets(buf, sizeof(buf), stdin) == 0)
1231             break;
1232
1233 #define PUTS(s)   (void) puts(s)
1234 #define PUTF(s,t) (void) printf(s,t)
1235         if (buf[0] == '?') {
1236             PUTS("?                -- display this help message");
1237             PUTS("fy fx ty tx      -- (4 numbers) display (fy,fx)->(ty,tx) move");
1238             PUTS("s[croll] n t b m -- display scrolling sequence");
1239             PUTF("r[eload]         -- reload terminal info for %s\n",
1240                  termname());
1241             PUTS("l[oad] <term>    -- load terminal info for type <term>");
1242             PUTS("d[elete] <cap>   -- delete named capability");
1243             PUTS("i[nspect]        -- display terminal capabilities");
1244             PUTS("c[ost]           -- dump cursor-optimization cost table");
1245             PUTS("o[optimize]      -- toggle movement optimization");
1246             PUTS("t[orture] <num>  -- torture-test with <num> random moves");
1247             PUTS("q[uit]           -- quit the program");
1248         } else if (sscanf(buf, "%d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1249             struct timeval before, after;
1250
1251             putchar('"');
1252
1253             gettimeofday(&before, NULL);
1254             mvcur(fy, fx, ty, tx);
1255             gettimeofday(&after, NULL);
1256
1257             printf("\" (%ld msec)\n",
1258                    (long) (after.tv_usec - before.tv_usec
1259                            + (after.tv_sec - before.tv_sec)
1260                            * 1000000));
1261         } else if (sscanf(buf, "s %d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1262             struct timeval before, after;
1263
1264             putchar('"');
1265
1266             gettimeofday(&before, NULL);
1267             _nc_scrolln(fy, fx, ty, tx);
1268             gettimeofday(&after, NULL);
1269
1270             printf("\" (%ld msec)\n",
1271                    (long) (after.tv_usec - before.tv_usec + (after.tv_sec -
1272                                                              before.tv_sec)
1273                            * 1000000));
1274         } else if (buf[0] == 'r') {
1275             _nc_STRCPY(tname, termname(), sizeof(tname));
1276             load_term();
1277         } else if (sscanf(buf, "l %s", tname) == 1) {
1278             load_term();
1279         } else if (sscanf(buf, "d %s", capname) == 1) {
1280             struct name_table_entry const *np = _nc_find_entry(capname,
1281                                                                _nc_get_hash_table(FALSE));
1282
1283             if (np == NULL)
1284                 (void) printf("No such capability as \"%s\"\n", capname);
1285             else {
1286                 switch (np->nte_type) {
1287                 case BOOLEAN:
1288                     cur_term->type.Booleans[np->nte_index] = FALSE;
1289                     (void)
1290                         printf("Boolean capability `%s' (%d) turned off.\n",
1291                                np->nte_name, np->nte_index);
1292                     break;
1293
1294                 case NUMBER:
1295                     cur_term->type.Numbers[np->nte_index] = ABSENT_NUMERIC;
1296                     (void) printf("Number capability `%s' (%d) set to -1.\n",
1297                                   np->nte_name, np->nte_index);
1298                     break;
1299
1300                 case STRING:
1301                     cur_term->type.Strings[np->nte_index] = ABSENT_STRING;
1302                     (void) printf("String capability `%s' (%d) deleted.\n",
1303                                   np->nte_name, np->nte_index);
1304                     break;
1305                 }
1306             }
1307         } else if (buf[0] == 'i') {
1308             dump_init(NULL, F_TERMINFO, S_TERMINFO,
1309                       FALSE, 70, 0, 0, FALSE, FALSE, 0);
1310             dump_entry(&TerminalType(cur_term), FALSE, TRUE, 0, 0);
1311             putchar('\n');
1312         } else if (buf[0] == 'o') {
1313             if (_nc_optimize_enable & OPTIMIZE_MVCUR) {
1314                 _nc_optimize_enable &= ~OPTIMIZE_MVCUR;
1315                 (void) puts("Optimization is now off.");
1316             } else {
1317                 _nc_optimize_enable |= OPTIMIZE_MVCUR;
1318                 (void) puts("Optimization is now on.");
1319             }
1320         }
1321         /*
1322          * You can use the `t' test to profile and tune the movement
1323          * optimizer.  Use iteration values in three digits or more.
1324          * At above 5000 iterations the profile timing averages are stable
1325          * to within a millisecond or three.
1326          *
1327          * The `overhead' field of the report will help you pick a
1328          * COMPUTE_OVERHEAD figure appropriate for your processor and
1329          * expected line speed.  The `total estimated time' is
1330          * computation time plus a character-transmission time
1331          * estimate computed from the number of transmits and the baud
1332          * rate.
1333          *
1334          * Use this together with the `o' command to get a read on the
1335          * optimizer's effectiveness.  Compare the total estimated times
1336          * for `t' runs of the same length in both optimized and un-optimized
1337          * modes.  As long as the optimized times are less, the optimizer
1338          * is winning.
1339          */
1340         else if (sscanf(buf, "t %d", &n) == 1) {
1341             float cumtime = 0.0, perchar;
1342             int speeds[] =
1343             {2400, 9600, 14400, 19200, 28800, 38400, 0};
1344
1345             srand((unsigned) (getpid() + time((time_t *) 0)));
1346             profiling = TRUE;
1347             xmits = 0;
1348             for (i = 0; i < n; i++) {
1349                 /*
1350                  * This does a move test between two random locations,
1351                  * Random moves probably short-change the optimizer,
1352                  * which will work better on the short moves probably
1353                  * typical of doupdate()'s usage pattern.  Still,
1354                  * until we have better data...
1355                  */
1356 #ifdef FIND_COREDUMP
1357                 int from_y = roll(lines);
1358                 int to_y = roll(lines);
1359                 int from_x = roll(columns);
1360                 int to_x = roll(columns);
1361
1362                 printf("(%d,%d) -> (%d,%d)\n", from_y, from_x, to_y, to_x);
1363                 mvcur(from_y, from_x, to_y, to_x);
1364 #else
1365                 mvcur(roll(lines), roll(columns), roll(lines), roll(columns));
1366 #endif /* FIND_COREDUMP */
1367                 if (diff)
1368                     cumtime += diff;
1369             }
1370             profiling = FALSE;
1371
1372             /*
1373              * Average milliseconds per character optimization time.
1374              * This is the key figure to watch when tuning the optimizer.
1375              */
1376             perchar = cumtime / n;
1377
1378             (void) printf("%d moves (%ld chars) in %d msec, %f msec each:\n",
1379                           n, xmits, (int) cumtime, perchar);
1380
1381             for (i = 0; speeds[i]; i++) {
1382                 /*
1383                  * Total estimated time for the moves, computation and
1384                  * transmission both. Transmission time is an estimate
1385                  * assuming 9 bits/char, 8 bits + 1 stop bit.
1386                  */
1387                 float totalest = cumtime + xmits * 9 * 1e6 / speeds[i];
1388
1389                 /*
1390                  * Per-character optimization overhead in character transmits
1391                  * at the current speed.  Round this to the nearest integer
1392                  * to figure COMPUTE_OVERHEAD for the speed.
1393                  */
1394                 float overhead = speeds[i] * perchar / 1e6;
1395
1396                 (void)
1397                     printf("%6d bps: %3.2f char-xmits overhead; total estimated time %15.2f\n",
1398                            speeds[i], overhead, totalest);
1399             }
1400         } else if (buf[0] == 'c') {
1401             (void) printf("char padding: %d\n", CURRENT_SCREEN->_char_padding);
1402             (void) printf("cr cost: %d\n", CURRENT_SCREEN->_cr_cost);
1403             (void) printf("cup cost: %d\n", CURRENT_SCREEN->_cup_cost);
1404             (void) printf("home cost: %d\n", CURRENT_SCREEN->_home_cost);
1405             (void) printf("ll cost: %d\n", CURRENT_SCREEN->_ll_cost);
1406 #if USE_HARD_TABS
1407             (void) printf("ht cost: %d\n", CURRENT_SCREEN->_ht_cost);
1408             (void) printf("cbt cost: %d\n", CURRENT_SCREEN->_cbt_cost);
1409 #endif /* USE_HARD_TABS */
1410             (void) printf("cub1 cost: %d\n", CURRENT_SCREEN->_cub1_cost);
1411             (void) printf("cuf1 cost: %d\n", CURRENT_SCREEN->_cuf1_cost);
1412             (void) printf("cud1 cost: %d\n", CURRENT_SCREEN->_cud1_cost);
1413             (void) printf("cuu1 cost: %d\n", CURRENT_SCREEN->_cuu1_cost);
1414             (void) printf("cub cost: %d\n", CURRENT_SCREEN->_cub_cost);
1415             (void) printf("cuf cost: %d\n", CURRENT_SCREEN->_cuf_cost);
1416             (void) printf("cud cost: %d\n", CURRENT_SCREEN->_cud_cost);
1417             (void) printf("cuu cost: %d\n", CURRENT_SCREEN->_cuu_cost);
1418             (void) printf("hpa cost: %d\n", CURRENT_SCREEN->_hpa_cost);
1419             (void) printf("vpa cost: %d\n", CURRENT_SCREEN->_vpa_cost);
1420         } else if (buf[0] == 'x' || buf[0] == 'q')
1421             break;
1422         else
1423             (void) puts("Invalid command.");
1424     }
1425
1426     (void) fputs("rmcup:", stdout);
1427     _nc_mvcur_wrap();
1428     putchar('\n');
1429
1430     return (0);
1431 }
1432
1433 #endif /* MAIN */
1434
1435 /* lib_mvcur.c ends here */