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