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