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