ncurses/lib_mvcur.c

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