ncurses/tty/lib_mvcur.c

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