1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
39 ** The routines for moving the physical cursor and scrolling:
41 ** void _nc_mvcur_init(void)
43 ** void _nc_mvcur_resume(void)
45 ** int mvcur(int old_y, int old_x, int new_y, int new_x)
47 ** void _nc_mvcur_wrap(void)
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!).
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.
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.
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
77 /****************************************************************************
79 * Constants and macros for optimizer tuning.
81 ****************************************************************************/
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.
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
96 #define COMPUTE_OVERHEAD 1 /* I use a 90MHz Pentium @ 9.6Kbps */
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.
104 #define LONG_DIST (8 - COMPUTE_OVERHEAD)
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.
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))
117 /****************************************************************************
119 * External interfaces
121 ****************************************************************************/
124 * For this code to work OK, the following components must live in the
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)
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)
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.
155 #include <curses.priv.h>
159 MODULE_ID("$Id: lib_mvcur.c,v 1.118 2009/05/02 20:38:58 tom Exp $")
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 */
164 #if defined(MAIN) || defined(NCURSES_TEST)
165 #include <sys/time.h>
167 static bool profiling = FALSE;
173 static int normalized_cost(NCURSES_SP_DCLx const char *const cap, int affcnt);
175 /****************************************************************************
177 * Initialization/wrapup (including cost pre-computation)
179 ****************************************************************************/
183 trace_cost_of(NCURSES_SP_DCLx const char *capname, const char *cap, int affcnt)
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)));
190 #define CostOf(cap,affcnt) trace_cost_of(NCURSES_SP_ARGx #cap, cap, affcnt)
193 trace_normalized_cost(NCURSES_SP_DCLx const char *capname, const char *cap, int affcnt)
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)));
200 #define NormalizedCost(cap,affcnt) trace_normalized_cost(NCURSES_SP_ARGx #cap, cap, affcnt)
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)
210 NCURSES_SP_NAME(_nc_msec_cost) (NCURSES_SP_DCLx const char *const cap, int affcnt)
211 /* compute the cost of a given operation */
217 float cum_cost = 0.0;
219 for (cp = cap; *cp; cp++) {
220 /* extract padding, either mandatory or required */
221 if (cp[0] == '$' && cp[1] == '<' && strchr(cp, '>')) {
224 for (cp += 2; *cp != '>'; cp++) {
225 if (isdigit(UChar(*cp)))
226 number = number * 10 + (*cp - '0');
229 else if (*cp == '.' && (*++cp != '>') && isdigit(UChar(*cp)))
230 number += (*cp - '0') / 10.0;
233 #if NCURSES_NO_PADDING
234 if (!GetNoPadding(SP_PARM))
236 cum_cost += number * 10;
238 cum_cost += SP_PARM->_char_padding;
241 return ((int) cum_cost);
247 _nc_msec_cost(const char *const cap, int affcnt)
249 return NCURSES_SP_NAME(_nc_msec_cost) (CURRENT_SCREEN, cap, affcnt);
254 normalized_cost(NCURSES_SP_DCLx const char *const cap, int affcnt)
255 /* compute the effective character-count for an operation (round up) */
257 int cost = _nc_msec_cost(cap, affcnt);
258 if (cost != INFINITY)
259 cost = (cost + SP_PARM->_char_padding - 1) / SP_PARM->_char_padding;
264 reset_scroll_region(NCURSES_SP_DCL0)
265 /* Set the scroll-region to a known state (the default) */
267 if (change_scroll_region) {
268 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
269 "change_scroll_region",
270 TPARM_2(change_scroll_region,
271 0, screen_lines(SP_PARM) - 1));
276 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_DCL0)
277 /* what to do at initialization time and after each shellout */
279 /* initialize screen for cursor access */
281 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
287 * Doing this here rather than in _nc_mvcur_wrap() ensures that
288 * ncurses programs will see a reset scroll region even if a
289 * program that messed with it died ungracefully.
291 * This also undoes the effects of terminal init strings that assume
292 * they know the screen size. This is useful when you're running
293 * a vt100 emulation through xterm.
295 reset_scroll_region(NCURSES_SP_ARG);
296 SP_PARM->_cursrow = SP_PARM->_curscol = -1;
298 /* restore cursor shape */
299 if (SP_PARM->_cursor != -1) {
300 int cursor = SP_PARM->_cursor;
301 SP_PARM->_cursor = -1;
302 NCURSES_SP_NAME(curs_set) (NCURSES_SP_ARGx cursor);
308 _nc_mvcur_resume(void)
310 NCURSES_SP_NAME(_nc_mvcur_resume) (CURRENT_SCREEN);
315 NCURSES_SP_NAME(_nc_mvcur_init) (NCURSES_SP_DCL0)
316 /* initialize the cost structure */
318 if (SP_PARM->_ofp && isatty(fileno(SP_PARM->_ofp)))
319 SP_PARM->_char_padding = ((BAUDBYTE * 1000 * 10)
320 / (BAUDRATE(SP_PARM) > 0
324 SP_PARM->_char_padding = 1; /* must be nonzero */
325 if (SP_PARM->_char_padding <= 0)
326 SP_PARM->_char_padding = 1; /* must be nonzero */
327 TR(TRACE_CHARPUT | TRACE_MOVE, ("char_padding %d msecs", SP_PARM->_char_padding));
329 /* non-parameterized local-motion strings */
330 SP_PARM->_cr_cost = CostOf(carriage_return, 0);
331 SP_PARM->_home_cost = CostOf(cursor_home, 0);
332 SP_PARM->_ll_cost = CostOf(cursor_to_ll, 0);
334 if (getenv("NCURSES_NO_HARD_TABS") == 0) {
335 SP_PARM->_ht_cost = CostOf(tab, 0);
336 SP_PARM->_cbt_cost = CostOf(back_tab, 0);
338 SP_PARM->_ht_cost = INFINITY;
339 SP_PARM->_cbt_cost = INFINITY;
341 #endif /* USE_HARD_TABS */
342 SP_PARM->_cub1_cost = CostOf(cursor_left, 0);
343 SP_PARM->_cuf1_cost = CostOf(cursor_right, 0);
344 SP_PARM->_cud1_cost = CostOf(cursor_down, 0);
345 SP_PARM->_cuu1_cost = CostOf(cursor_up, 0);
347 SP_PARM->_smir_cost = CostOf(enter_insert_mode, 0);
348 SP_PARM->_rmir_cost = CostOf(exit_insert_mode, 0);
349 SP_PARM->_ip_cost = 0;
350 if (insert_padding) {
351 SP_PARM->_ip_cost = CostOf(insert_padding, 0);
355 * Assumption: if the terminal has memory_relative addressing, the
356 * initialization strings or smcup will set single-page mode so we
357 * can treat it like absolute screen addressing. This seems to be true
358 * for all cursor_mem_address terminal types in the terminfo database.
360 SP_PARM->_address_cursor = cursor_address ? cursor_address : cursor_mem_address;
363 * Parametrized local-motion strings. This static cost computation
364 * depends on the following assumptions:
366 * (1) They never have * padding. In the entire master terminfo database
367 * as of March 1995, only the obsolete Zenith Z-100 pc violates this.
368 * (Proportional padding is found mainly in insert, delete and scroll
371 * (2) The average case of cup has two two-digit parameters. Strictly,
372 * the average case for a 24 * 80 screen has ((10*10*(1 + 1)) +
373 * (14*10*(1 + 2)) + (10*70*(2 + 1)) + (14*70*4)) / (24*80) = 3.458
374 * digits of parameters. On a 25x80 screen the average is 3.6197.
375 * On larger screens the value gets much closer to 4.
377 * (3) The average case of cub/cuf/hpa/ech/rep has 2 digits of parameters
378 * (strictly, (((10 * 1) + (70 * 2)) / 80) = 1.8750).
380 * (4) The average case of cud/cuu/vpa has 2 digits of parameters
381 * (strictly, (((10 * 1) + (14 * 2)) / 24) = 1.5833).
383 * All these averages depend on the assumption that all parameter values
384 * are equally probable.
386 SP_PARM->_cup_cost = CostOf(TPARM_2(SP_PARM->_address_cursor, 23, 23), 1);
387 SP_PARM->_cub_cost = CostOf(TPARM_1(parm_left_cursor, 23), 1);
388 SP_PARM->_cuf_cost = CostOf(TPARM_1(parm_right_cursor, 23), 1);
389 SP_PARM->_cud_cost = CostOf(TPARM_1(parm_down_cursor, 23), 1);
390 SP_PARM->_cuu_cost = CostOf(TPARM_1(parm_up_cursor, 23), 1);
391 SP_PARM->_hpa_cost = CostOf(TPARM_1(column_address, 23), 1);
392 SP_PARM->_vpa_cost = CostOf(TPARM_1(row_address, 23), 1);
394 /* non-parameterized screen-update strings */
395 SP_PARM->_ed_cost = NormalizedCost(clr_eos, 1);
396 SP_PARM->_el_cost = NormalizedCost(clr_eol, 1);
397 SP_PARM->_el1_cost = NormalizedCost(clr_bol, 1);
398 SP_PARM->_dch1_cost = NormalizedCost(delete_character, 1);
399 SP_PARM->_ich1_cost = NormalizedCost(insert_character, 1);
402 * If this is a bce-terminal, we want to bias the choice so we use clr_eol
403 * rather than spaces at the end of a line.
405 if (back_color_erase)
406 SP_PARM->_el_cost = 0;
408 /* parameterized screen-update strings */
409 SP_PARM->_dch_cost = NormalizedCost(TPARM_1(parm_dch, 23), 1);
410 SP_PARM->_ich_cost = NormalizedCost(TPARM_1(parm_ich, 23), 1);
411 SP_PARM->_ech_cost = NormalizedCost(TPARM_1(erase_chars, 23), 1);
412 SP_PARM->_rep_cost = NormalizedCost(TPARM_2(repeat_char, ' ', 23), 1);
414 SP_PARM->_cup_ch_cost = NormalizedCost(
415 TPARM_2(SP_PARM->_address_cursor,
418 SP_PARM->_hpa_ch_cost = NormalizedCost(TPARM_1(column_address, 23), 1);
419 SP_PARM->_cuf_ch_cost = NormalizedCost(TPARM_1(parm_right_cursor, 23), 1);
420 SP_PARM->_inline_cost = min(SP_PARM->_cup_ch_cost,
421 min(SP_PARM->_hpa_ch_cost,
422 SP_PARM->_cuf_ch_cost));
425 * If save_cursor is used within enter_ca_mode, we should not use it for
426 * scrolling optimization, since the corresponding restore_cursor is not
427 * nested on the various terminals (vt100, xterm, etc.) which use this
431 && enter_ca_mode != 0
432 && strstr(enter_ca_mode, save_cursor) != 0) {
433 T(("...suppressed sc/rc capability due to conflict with smcup/rmcup"));
439 * A different, possibly better way to arrange this would be to set the
440 * SCREEN's _endwin to TRUE at window initialization time and let this be
441 * called by doupdate's return-from-shellout code.
450 NCURSES_SP_NAME(_nc_mvcur_init) (CURRENT_SCREEN);
456 NCURSES_SP_NAME(_nc_mvcur_wrap) (NCURSES_SP_DCL0)
457 /* wrap up cursor-addressing mode */
459 /* leave cursor at screen bottom */
460 mvcur(-1, -1, screen_lines(CURRENT_SCREEN) - 1, 0);
462 /* set cursor to normal mode */
463 if (SP_PARM->_cursor != -1) {
464 int cursor = SP_PARM->_cursor;
465 NCURSES_SP_NAME(curs_set) (NCURSES_SP_ARGx 1);
466 SP_PARM->_cursor = cursor;
470 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
475 * Reset terminal's tab counter. There's a long-time bug that
476 * if you exit a "curses" program such as vi or more, tab
477 * forward, and then backspace, the cursor doesn't go to the
478 * right place. The problem is that the kernel counts the
479 * escape sequences that reset things as column positions.
480 * Utter a \r to reset this invisibly.
482 NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_ARGx '\r');
489 NCURSES_SP_NAME(_nc_mvcur_wrap) (CURRENT_SCREEN);
493 /****************************************************************************
495 * Optimized cursor movement
497 ****************************************************************************/
500 * Perform repeated-append, returning cost
502 static NCURSES_INLINE int
503 repeated_append(string_desc * target, int total, int num, int repeat, const char *src)
505 size_t need = repeat * strlen(src);
507 if (need < target->s_size) {
508 while (repeat-- > 0) {
509 if (_nc_safe_strcat(target, src)) {
523 #define NEXTTAB(fr) (fr + init_tabs - (fr % init_tabs))
526 * Assume back_tab (CBT) does not wrap backwards at the left margin, return
527 * a negative value at that point to simplify the loop.
529 #define LASTTAB(fr) ((fr > 0) ? ((fr - 1) / init_tabs) * init_tabs : -1)
532 relative_move(NCURSES_SP_DCLx
533 string_desc * target,
539 /* move via local motions (cuu/cuu1/cud/cud1/cub1/cub/cuf1/cuf/vpa/hpa) */
542 int n, vcost = 0, hcost = 0;
544 (void) _nc_str_copy(&save, target);
546 if (to_y != from_y) {
550 && _nc_safe_strcat(target, TPARM_1(row_address, to_y))) {
551 vcost = SP_PARM->_vpa_cost;
558 && SP_PARM->_cud_cost < vcost
559 && _nc_safe_strcat(_nc_str_copy(target, &save),
560 TPARM_1(parm_down_cursor, n))) {
561 vcost = SP_PARM->_cud_cost;
565 && (*cursor_down != '\n' || SP_PARM->_nl)
566 && (n * SP_PARM->_cud1_cost < vcost)) {
567 vcost = repeated_append(_nc_str_copy(target, &save), 0,
568 SP_PARM->_cud1_cost, n, cursor_down);
570 } else { /* (to_y < from_y) */
574 && SP_PARM->_cuu_cost < vcost
575 && _nc_safe_strcat(_nc_str_copy(target, &save),
576 TPARM_1(parm_up_cursor, n))) {
577 vcost = SP_PARM->_cuu_cost;
580 if (cursor_up && (n * SP_PARM->_cuu1_cost < vcost)) {
581 vcost = repeated_append(_nc_str_copy(target, &save), 0,
582 SP_PARM->_cuu1_cost, n, cursor_up);
586 if (vcost == INFINITY)
592 if (to_x != from_x) {
599 && _nc_safe_strcat(_nc_str_copy(target, &save),
600 TPARM_1(column_address, to_x))) {
601 hcost = SP_PARM->_hpa_cost;
607 if (parm_right_cursor
608 && SP_PARM->_cuf_cost < hcost
609 && _nc_safe_strcat(_nc_str_copy(target, &save),
610 TPARM_1(parm_right_cursor, n))) {
611 hcost = SP_PARM->_cuf_cost;
617 (void) _nc_str_init(&check, str, sizeof(str));
620 /* use hard tabs, if we have them, to do as much as possible */
621 if (init_tabs > 0 && tab) {
624 for (fr = from_x; (nxt = NEXTTAB(fr)) <= to_x; fr = nxt) {
625 lhcost = repeated_append(&check, lhcost,
626 SP_PARM->_ht_cost, 1, tab);
627 if (lhcost == INFINITY)
634 #endif /* USE_HARD_TABS */
636 if (n <= 0 || n >= (int) check.s_size)
640 * If we're allowing BSD-style padding in tputs, don't generate
641 * a string with a leading digit. Otherwise, that will be
642 * interpreted as a padding value rather than sent to the
647 && n < (int) check.s_size
650 int wanted = CharOf(WANT_CHAR(SP_PARM, to_y, from_x));
651 if (is8bits(wanted) && isdigit(wanted))
656 * If we have no attribute changes, overwrite is cheaper.
657 * Note: must suppress this by passing in ovw = FALSE whenever
658 * WANT_CHAR would return invalid data. In particular, this
659 * is true between the time a hardware scroll has been done
660 * and the time the structure WANT_CHAR would access has been
666 for (i = 0; i < n; i++) {
667 NCURSES_CH_T ch = WANT_CHAR(SP_PARM, to_y, from_x + i);
668 if (!SameAttrOf(ch, SCREEN_ATTRS(SP_PARM))
669 #if USE_WIDEC_SUPPORT
681 for (i = 0; i < n; i++)
682 *check.s_tail++ = (char) CharOf(WANT_CHAR(SP_PARM, to_y,
684 *check.s_tail = '\0';
686 lhcost += n * SP_PARM->_char_padding;
688 lhcost = repeated_append(&check, lhcost, SP_PARM->_cuf1_cost,
693 && _nc_safe_strcat(_nc_str_copy(target, &save), str)) {
697 } else { /* (to_x < from_x) */
701 && SP_PARM->_cub_cost < hcost
702 && _nc_safe_strcat(_nc_str_copy(target, &save),
703 TPARM_1(parm_left_cursor, n))) {
704 hcost = SP_PARM->_cub_cost;
710 (void) _nc_str_init(&check, str, sizeof(str));
713 if (init_tabs > 0 && back_tab) {
716 for (fr = from_x; (nxt = LASTTAB(fr)) >= to_x; fr = nxt) {
717 lhcost = repeated_append(&check, lhcost,
720 if (lhcost == INFINITY)
726 #endif /* USE_HARD_TABS */
728 lhcost = repeated_append(&check, lhcost,
733 && _nc_safe_strcat(_nc_str_copy(target, &save), str)) {
739 if (hcost == INFINITY)
743 return (vcost + hcost);
745 #endif /* !NO_OPTIMIZE */
748 * With the machinery set up above, it's conceivable that
749 * onscreen_mvcur could be modified into a recursive function that does
750 * an alpha-beta search of motion space, as though it were a chess
751 * move tree, with the weight function being boolean and the search
752 * depth equated to length of string. However, this would jack up the
753 * computation cost a lot, especially on terminals without a cup
754 * capability constraining the search tree depth. So we settle for
755 * the simpler method below.
758 static NCURSES_INLINE int
759 onscreen_mvcur(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew, bool ovw)
760 /* onscreen move from (yold, xold) to (ynew, xnew) */
763 char buffer[OPT_SIZE];
764 int tactic = 0, newcost, usecost = INFINITY;
767 #if defined(MAIN) || defined(NCURSES_TEST)
768 struct timeval before, after;
770 gettimeofday(&before, NULL);
773 #define NullResult _nc_str_null(&result, sizeof(buffer))
774 #define InitResult _nc_str_init(&result, buffer, sizeof(buffer))
776 /* tactic #0: use direct cursor addressing */
777 if (_nc_safe_strcpy(InitResult, TPARM_2(SP_PARM->_address_cursor, ynew, xnew))) {
779 usecost = SP_PARM->_cup_cost;
781 #if defined(TRACE) || defined(NCURSES_TEST)
782 if (!(_nc_optimize_enable & OPTIMIZE_MVCUR))
787 * We may be able to tell in advance that the full optimization
788 * will probably not be worth its overhead. Also, don't try to
789 * use local movement if the current attribute is anything but
790 * A_NORMAL...there are just too many ways this can screw up
791 * (like, say, local-movement \n getting mapped to some obscure
792 * character because A_ALTCHARSET is on).
794 if (yold == -1 || xold == -1 || NOT_LOCAL(SP_PARM, yold, xold, ynew, xnew)) {
795 #if defined(MAIN) || defined(NCURSES_TEST)
797 (void) fputs("nonlocal\n", stderr);
798 goto nonlocal; /* always run the optimizer if profiling */
806 /* tactic #1: use local movement */
807 if (yold != -1 && xold != -1
808 && ((newcost = relative_move(NCURSES_SP_ARGx
811 ynew, xnew, ovw)) != INFINITY)
812 && newcost < usecost) {
817 /* tactic #2: use carriage-return + local movement */
818 if (yold != -1 && carriage_return
819 && ((newcost = relative_move(NCURSES_SP_ARGx
822 ynew, xnew, ovw)) != INFINITY)
823 && SP_PARM->_cr_cost + newcost < usecost) {
825 usecost = SP_PARM->_cr_cost + newcost;
828 /* tactic #3: use home-cursor + local movement */
830 && ((newcost = relative_move(NCURSES_SP_ARGx
833 ynew, xnew, ovw)) != INFINITY)
834 && SP_PARM->_home_cost + newcost < usecost) {
836 usecost = SP_PARM->_home_cost + newcost;
839 /* tactic #4: use home-down + local movement */
841 && ((newcost = relative_move(NCURSES_SP_ARGx
843 screen_lines(SP_PARM) - 1, 0,
844 ynew, xnew, ovw)) != INFINITY)
845 && SP_PARM->_ll_cost + newcost < usecost) {
847 usecost = SP_PARM->_ll_cost + newcost;
851 * tactic #5: use left margin for wrap to right-hand side,
852 * unless strange wrap behavior indicated by xenl might hose us.
854 t5_cr_cost = (xold > 0 ? SP_PARM->_cr_cost : 0);
855 if (auto_left_margin && !eat_newline_glitch
856 && yold > 0 && cursor_left
857 && ((newcost = relative_move(NCURSES_SP_ARGx
859 yold - 1, screen_columns(SP_PARM) - 1,
860 ynew, xnew, ovw)) != INFINITY)
861 && t5_cr_cost + SP_PARM->_cub1_cost + newcost < usecost) {
863 usecost = t5_cr_cost + SP_PARM->_cub1_cost + newcost;
867 * These cases are ordered by estimated relative frequency.
873 (void) relative_move(NCURSES_SP_ARGx
879 (void) _nc_safe_strcpy(&result, carriage_return);
880 (void) relative_move(NCURSES_SP_ARGx
886 (void) _nc_safe_strcpy(&result, cursor_home);
887 (void) relative_move(NCURSES_SP_ARGx
892 (void) _nc_safe_strcpy(&result, cursor_to_ll);
893 (void) relative_move(NCURSES_SP_ARGx
895 screen_lines(SP_PARM) - 1, 0,
900 (void) _nc_safe_strcat(&result, carriage_return);
901 (void) _nc_safe_strcat(&result, cursor_left);
902 (void) relative_move(NCURSES_SP_ARGx
904 yold - 1, screen_columns(SP_PARM) - 1,
908 #endif /* !NO_OPTIMIZE */
911 #if defined(MAIN) || defined(NCURSES_TEST)
912 gettimeofday(&after, NULL);
913 diff = after.tv_usec - before.tv_usec
914 + (after.tv_sec - before.tv_sec) * 1000000;
916 (void) fprintf(stderr,
917 "onscreen: %d microsec, %f 28.8Kbps char-equivalents\n",
918 (int) diff, diff / 288);
921 if (usecost != INFINITY) {
922 TPUTS_TRACE("mvcur");
923 tputs(buffer, 1, _nc_outch);
924 SP_PARM->_cursrow = ynew;
925 SP_PARM->_curscol = xnew;
931 /* optimized cursor move from (yold, xold) to (ynew, xnew) */
933 NCURSES_SP_NAME(mvcur) (NCURSES_SP_DCLx
934 int yold, int xold, int ynew, int xnew)
936 NCURSES_CH_T oldattr;
939 TR(TRACE_CALLS | TRACE_MOVE, (T_CALLED("mvcur(%d,%d,%d,%d)"),
940 yold, xold, ynew, xnew));
944 } else if (yold == ynew && xold == xnew) {
949 * Most work here is rounding for terminal boundaries getting the
950 * column position implied by wraparound or the lack thereof and
951 * rolling up the screen to get ynew on the screen.
953 if (xnew >= screen_columns(SP_PARM)) {
954 ynew += xnew / screen_columns(SP_PARM);
955 xnew %= screen_columns(SP_PARM);
959 * Force restore even if msgr is on when we're in an alternate
960 * character set -- these have a strong tendency to screw up the CR &
961 * LF used for local character motions!
963 oldattr = SCREEN_ATTRS(SP_PARM);
964 if ((AttrOf(oldattr) & A_ALTCHARSET)
965 || (AttrOf(oldattr) && !move_standout_mode)) {
966 TR(TRACE_CHARPUT, ("turning off (%#lx) %s before move",
967 (unsigned long) AttrOf(oldattr),
968 _traceattr(AttrOf(oldattr))));
969 (void) VIDATTR(SP_PARM, A_NORMAL, 0);
972 if (xold >= screen_columns(SP_PARM)) {
976 l = (xold + 1) / screen_columns(SP_PARM);
978 if (yold >= screen_lines(SP_PARM))
979 l -= (yold - screen_lines(SP_PARM) - 1);
982 if (carriage_return) {
983 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
987 NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_ARGx '\r');
992 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
996 NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_ARGx '\n');
1002 * If caller set nonl(), we cannot really use newlines to
1003 * position to the next row.
1010 if (yold > screen_lines(SP_PARM) - 1)
1011 yold = screen_lines(SP_PARM) - 1;
1012 if (ynew > screen_lines(SP_PARM) - 1)
1013 ynew = screen_lines(SP_PARM) - 1;
1015 /* destination location is on screen now */
1016 code = onscreen_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew, TRUE);
1019 * Restore attributes if we disabled them before moving.
1021 if (!SameAttrOf(oldattr, SCREEN_ATTRS(SP_PARM))) {
1022 TR(TRACE_CHARPUT, ("turning on (%#lx) %s after move",
1023 (unsigned long) AttrOf(oldattr),
1024 _traceattr(AttrOf(oldattr))));
1025 (void) VIDATTR(SP_PARM, AttrOf(oldattr), GetPair(oldattr));
1031 #if NCURSES_SP_FUNCS
1033 mvcur(int yold, int xold, int ynew, int xnew)
1035 return NCURSES_SP_NAME(mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
1039 #if defined(TRACE) || defined(NCURSES_TEST)
1040 NCURSES_EXPORT_VAR(int) _nc_optimize_enable = OPTIMIZE_ALL;
1043 #if defined(MAIN) || defined(NCURSES_TEST)
1044 /****************************************************************************
1046 * Movement optimizer test code
1048 ****************************************************************************/
1051 #include <dump_entry.h>
1054 NCURSES_EXPORT_VAR(const char *) _nc_progname = "mvcur";
1056 static unsigned long xmits;
1058 /* these override lib_tputs.c */
1060 tputs(const char *string, int affcnt GCC_UNUSED, int (*outc) (int) GCC_UNUSED)
1061 /* stub tputs() that dumps sequences in a visible form */
1064 xmits += strlen(string);
1066 (void) fputs(_nc_visbuf(string), stdout);
1071 putp(const char *string)
1073 return (tputs(string, 1, _nc_outch));
1084 delay_output(int ms GCC_UNUSED)
1089 static char tname[PATH_MAX];
1094 (void) setupterm(tname, STDOUT_FILENO, NULL);
1102 i = (RAND_MAX / n) * n;
1103 while ((j = rand()) >= i)
1109 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
1111 strcpy(tname, getenv("TERM"));
1113 _nc_setupscreen(lines, columns, stdout, FALSE, 0);
1119 (void) puts("The mvcur tester. Type ? for help");
1121 fputs("smcup:", stdout);
1125 int fy, fx, ty, tx, n, i;
1126 char buf[BUFSIZ], capname[BUFSIZ];
1128 (void) fputs("> ", stdout);
1129 (void) fgets(buf, sizeof(buf), stdin);
1131 if (buf[0] == '?') {
1132 (void) puts("? -- display this help message");
1134 puts("fy fx ty tx -- (4 numbers) display (fy,fx)->(ty,tx) move");
1135 (void) puts("s[croll] n t b m -- display scrolling sequence");
1137 printf("r[eload] -- reload terminal info for %s\n",
1140 puts("l[oad] <term> -- load terminal info for type <term>");
1141 (void) puts("d[elete] <cap> -- delete named capability");
1142 (void) puts("i[nspect] -- display terminal capabilities");
1144 puts("c[ost] -- dump cursor-optimization cost table");
1145 (void) puts("o[optimize] -- toggle movement optimization");
1147 puts("t[orture] <num> -- torture-test with <num> random moves");
1148 (void) puts("q[uit] -- quit the program");
1149 } else if (sscanf(buf, "%d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1150 struct timeval before, after;
1154 gettimeofday(&before, NULL);
1155 mvcur(fy, fx, ty, tx);
1156 gettimeofday(&after, NULL);
1158 printf("\" (%ld msec)\n",
1159 (long) (after.tv_usec - before.tv_usec
1160 + (after.tv_sec - before.tv_sec)
1162 } else if (sscanf(buf, "s %d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1163 struct timeval before, after;
1167 gettimeofday(&before, NULL);
1168 _nc_scrolln(fy, fx, ty, tx);
1169 gettimeofday(&after, NULL);
1171 printf("\" (%ld msec)\n",
1172 (long) (after.tv_usec - before.tv_usec + (after.tv_sec -
1175 } else if (buf[0] == 'r') {
1176 (void) strcpy(tname, termname());
1178 } else if (sscanf(buf, "l %s", tname) == 1) {
1180 } else if (sscanf(buf, "d %s", capname) == 1) {
1181 struct name_table_entry const *np = _nc_find_entry(capname,
1182 _nc_get_hash_table(FALSE));
1185 (void) printf("No such capability as \"%s\"\n", capname);
1187 switch (np->nte_type) {
1189 cur_term->type.Booleans[np->nte_index] = FALSE;
1191 printf("Boolean capability `%s' (%d) turned off.\n",
1192 np->nte_name, np->nte_index);
1196 cur_term->type.Numbers[np->nte_index] = ABSENT_NUMERIC;
1197 (void) printf("Number capability `%s' (%d) set to -1.\n",
1198 np->nte_name, np->nte_index);
1202 cur_term->type.Strings[np->nte_index] = ABSENT_STRING;
1203 (void) printf("String capability `%s' (%d) deleted.\n",
1204 np->nte_name, np->nte_index);
1208 } else if (buf[0] == 'i') {
1209 dump_init((char *) NULL, F_TERMINFO, S_TERMINFO, 70, 0, FALSE);
1210 dump_entry(&cur_term->type, FALSE, TRUE, 0, 0);
1212 } else if (buf[0] == 'o') {
1213 if (_nc_optimize_enable & OPTIMIZE_MVCUR) {
1214 _nc_optimize_enable &= ~OPTIMIZE_MVCUR;
1215 (void) puts("Optimization is now off.");
1217 _nc_optimize_enable |= OPTIMIZE_MVCUR;
1218 (void) puts("Optimization is now on.");
1222 * You can use the `t' test to profile and tune the movement
1223 * optimizer. Use iteration values in three digits or more.
1224 * At above 5000 iterations the profile timing averages are stable
1225 * to within a millisecond or three.
1227 * The `overhead' field of the report will help you pick a
1228 * COMPUTE_OVERHEAD figure appropriate for your processor and
1229 * expected line speed. The `total estimated time' is
1230 * computation time plus a character-transmission time
1231 * estimate computed from the number of transmits and the baud
1234 * Use this together with the `o' command to get a read on the
1235 * optimizer's effectiveness. Compare the total estimated times
1236 * for `t' runs of the same length in both optimized and un-optimized
1237 * modes. As long as the optimized times are less, the optimizer
1240 else if (sscanf(buf, "t %d", &n) == 1) {
1241 float cumtime = 0.0, perchar;
1243 {2400, 9600, 14400, 19200, 28800, 38400, 0};
1245 srand((unsigned) (getpid() + time((time_t *) 0)));
1248 for (i = 0; i < n; i++) {
1250 * This does a move test between two random locations,
1251 * Random moves probably short-change the optimizer,
1252 * which will work better on the short moves probably
1253 * typical of doupdate()'s usage pattern. Still,
1254 * until we have better data...
1256 #ifdef FIND_COREDUMP
1257 int from_y = roll(lines);
1258 int to_y = roll(lines);
1259 int from_x = roll(columns);
1260 int to_x = roll(columns);
1262 printf("(%d,%d) -> (%d,%d)\n", from_y, from_x, to_y, to_x);
1263 mvcur(from_y, from_x, to_y, to_x);
1265 mvcur(roll(lines), roll(columns), roll(lines), roll(columns));
1266 #endif /* FIND_COREDUMP */
1273 * Average milliseconds per character optimization time.
1274 * This is the key figure to watch when tuning the optimizer.
1276 perchar = cumtime / n;
1278 (void) printf("%d moves (%ld chars) in %d msec, %f msec each:\n",
1279 n, xmits, (int) cumtime, perchar);
1281 for (i = 0; speeds[i]; i++) {
1283 * Total estimated time for the moves, computation and
1284 * transmission both. Transmission time is an estimate
1285 * assuming 9 bits/char, 8 bits + 1 stop bit.
1287 float totalest = cumtime + xmits * 9 * 1e6 / speeds[i];
1290 * Per-character optimization overhead in character transmits
1291 * at the current speed. Round this to the nearest integer
1292 * to figure COMPUTE_OVERHEAD for the speed.
1294 float overhead = speeds[i] * perchar / 1e6;
1297 printf("%6d bps: %3.2f char-xmits overhead; total estimated time %15.2f\n",
1298 speeds[i], overhead, totalest);
1300 } else if (buf[0] == 'c') {
1301 (void) printf("char padding: %d\n", CURRENT_SCREEN->_char_padding);
1302 (void) printf("cr cost: %d\n", CURRENT_SCREEN->_cr_cost);
1303 (void) printf("cup cost: %d\n", CURRENT_SCREEN->_cup_cost);
1304 (void) printf("home cost: %d\n", CURRENT_SCREEN->_home_cost);
1305 (void) printf("ll cost: %d\n", CURRENT_SCREEN->_ll_cost);
1307 (void) printf("ht cost: %d\n", CURRENT_SCREEN->_ht_cost);
1308 (void) printf("cbt cost: %d\n", CURRENT_SCREEN->_cbt_cost);
1309 #endif /* USE_HARD_TABS */
1310 (void) printf("cub1 cost: %d\n", CURRENT_SCREEN->_cub1_cost);
1311 (void) printf("cuf1 cost: %d\n", CURRENT_SCREEN->_cuf1_cost);
1312 (void) printf("cud1 cost: %d\n", CURRENT_SCREEN->_cud1_cost);
1313 (void) printf("cuu1 cost: %d\n", CURRENT_SCREEN->_cuu1_cost);
1314 (void) printf("cub cost: %d\n", CURRENT_SCREEN->_cub_cost);
1315 (void) printf("cuf cost: %d\n", CURRENT_SCREEN->_cuf_cost);
1316 (void) printf("cud cost: %d\n", CURRENT_SCREEN->_cud_cost);
1317 (void) printf("cuu cost: %d\n", CURRENT_SCREEN->_cuu_cost);
1318 (void) printf("hpa cost: %d\n", CURRENT_SCREEN->_hpa_cost);
1319 (void) printf("vpa cost: %d\n", CURRENT_SCREEN->_vpa_cost);
1320 } else if (buf[0] == 'x' || buf[0] == 'q')
1323 (void) puts("Invalid command.");
1326 (void) fputs("rmcup:", stdout);
1335 /* lib_mvcur.c ends here */