313d488ad07c6d809d8d8b3ea207178f10df05f2
[ncurses.git] / ncurses / tty / lib_mvcur.c
1 /****************************************************************************
2  * Copyright (c) 1998-2018,2019 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.148 2019/02/24 00:31:57 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 #undef NCURSES_OUTC_FUNC
180 #define NCURSES_OUTC_FUNC myOutCh
181
182 #define OPT_SIZE 512
183
184 static int normalized_cost(NCURSES_SP_DCLx const char *const cap, int affcnt);
185
186 /****************************************************************************
187  *
188  * Initialization/wrapup (including cost pre-computation)
189  *
190  ****************************************************************************/
191
192 #ifdef TRACE
193 static int
194 trace_cost_of(NCURSES_SP_DCLx const char *capname, const char *cap, int affcnt)
195 {
196     int result = NCURSES_SP_NAME(_nc_msec_cost) (NCURSES_SP_ARGx cap, affcnt);
197     TR(TRACE_CHARPUT | TRACE_MOVE,
198        ("CostOf %s %d %s", capname, result, _nc_visbuf(cap)));
199     return result;
200 }
201 #define CostOf(cap,affcnt) trace_cost_of(NCURSES_SP_ARGx #cap, cap, affcnt)
202
203 static int
204 trace_normalized_cost(NCURSES_SP_DCLx const char *capname, const char *cap, int affcnt)
205 {
206     int result = normalized_cost(NCURSES_SP_ARGx cap, affcnt);
207     TR(TRACE_CHARPUT | TRACE_MOVE,
208        ("NormalizedCost %s %d %s", capname, result, _nc_visbuf(cap)));
209     return result;
210 }
211 #define NormalizedCost(cap,affcnt) trace_normalized_cost(NCURSES_SP_ARGx #cap, cap, affcnt)
212
213 #else
214
215 #define CostOf(cap,affcnt) NCURSES_SP_NAME(_nc_msec_cost)(NCURSES_SP_ARGx cap, affcnt)
216 #define NormalizedCost(cap,affcnt) normalized_cost(NCURSES_SP_ARGx cap, affcnt)
217
218 #endif
219
220 NCURSES_EXPORT(int)
221 NCURSES_SP_NAME(_nc_msec_cost) (NCURSES_SP_DCLx const char *const cap, int affcnt)
222 /* compute the cost of a given operation */
223 {
224     if (cap == 0)
225         return (INFINITY);
226     else {
227         const char *cp;
228         float cum_cost = 0.0;
229
230         for (cp = cap; *cp; cp++) {
231             /* extract padding, either mandatory or required */
232             if (cp[0] == '$' && cp[1] == '<' && strchr(cp, '>')) {
233                 float number = 0.0;
234
235                 for (cp += 2; *cp != '>'; cp++) {
236                     if (isdigit(UChar(*cp)))
237                         number = number * 10 + (float) (*cp - '0');
238                     else if (*cp == '*')
239                         number *= (float) affcnt;
240                     else if (*cp == '.' && (*++cp != '>') && isdigit(UChar(*cp)))
241                         number += (float) ((*cp - '0') / 10.0);
242                 }
243
244 #if NCURSES_NO_PADDING
245                 if (!GetNoPadding(SP_PARM))
246 #endif
247                     cum_cost += number * 10;
248             } else if (SP_PARM) {
249                 cum_cost += (float) SP_PARM->_char_padding;
250             }
251         }
252
253         return ((int) cum_cost);
254     }
255 }
256
257 #if NCURSES_SP_FUNCS
258 NCURSES_EXPORT(int)
259 _nc_msec_cost(const char *const cap, int affcnt)
260 {
261     return NCURSES_SP_NAME(_nc_msec_cost) (CURRENT_SCREEN, cap, affcnt);
262 }
263 #endif
264
265 static int
266 normalized_cost(NCURSES_SP_DCLx const char *const cap, int affcnt)
267 /* compute the effective character-count for an operation (round up) */
268 {
269     int cost = NCURSES_SP_NAME(_nc_msec_cost) (NCURSES_SP_ARGx cap, affcnt);
270     if (cost != INFINITY)
271         cost = (cost + SP_PARM->_char_padding - 1) / SP_PARM->_char_padding;
272     return cost;
273 }
274
275 static void
276 reset_scroll_region(NCURSES_SP_DCL0)
277 /* Set the scroll-region to a known state (the default) */
278 {
279     if (change_scroll_region) {
280         NCURSES_PUTP2("change_scroll_region",
281                       TPARM_2(change_scroll_region,
282                               0, screen_lines(SP_PARM) - 1));
283     }
284 }
285
286 NCURSES_EXPORT(void)
287 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_DCL0)
288 /* what to do at initialization time and after each shellout */
289 {
290     if (!SP_PARM || !IsTermInfo(SP_PARM))
291         return;
292
293     /* initialize screen for cursor access */
294     if (enter_ca_mode) {
295         NCURSES_PUTP2("enter_ca_mode", 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 && NC_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         && dest_tabs_magic_smso == 0
349         && HasHardTabs()) {
350         SP_PARM->_ht_cost = CostOf(tab, 0);
351         SP_PARM->_cbt_cost = CostOf(back_tab, 0);
352     } else {
353         SP_PARM->_ht_cost = INFINITY;
354         SP_PARM->_cbt_cost = INFINITY;
355     }
356 #endif /* USE_HARD_TABS */
357     SP_PARM->_cub1_cost = CostOf(cursor_left, 0);
358     SP_PARM->_cuf1_cost = CostOf(cursor_right, 0);
359     SP_PARM->_cud1_cost = CostOf(cursor_down, 0);
360     SP_PARM->_cuu1_cost = CostOf(cursor_up, 0);
361
362     SP_PARM->_smir_cost = CostOf(enter_insert_mode, 0);
363     SP_PARM->_rmir_cost = CostOf(exit_insert_mode, 0);
364     SP_PARM->_ip_cost = 0;
365     if (insert_padding) {
366         SP_PARM->_ip_cost = CostOf(insert_padding, 0);
367     }
368
369     /*
370      * Assumption: if the terminal has memory_relative addressing, the
371      * initialization strings or smcup will set single-page mode so we
372      * can treat it like absolute screen addressing.  This seems to be true
373      * for all cursor_mem_address terminal types in the terminfo database.
374      */
375     SP_PARM->_address_cursor = cursor_address ? cursor_address : cursor_mem_address;
376
377     /*
378      * Parametrized local-motion strings.  This static cost computation
379      * depends on the following assumptions:
380      *
381      * (1) They never have * padding.  In the entire master terminfo database
382      *     as of March 1995, only the obsolete Zenith Z-100 pc violates this.
383      *     (Proportional padding is found mainly in insert, delete and scroll
384      *     capabilities).
385      *
386      * (2) The average case of cup has two two-digit parameters.  Strictly,
387      *     the average case for a 24 * 80 screen has ((10*10*(1 + 1)) +
388      *     (14*10*(1 + 2)) + (10*70*(2 + 1)) + (14*70*4)) / (24*80) = 3.458
389      *     digits of parameters.  On a 25x80 screen the average is 3.6197.
390      *     On larger screens the value gets much closer to 4.
391      *
392      * (3) The average case of cub/cuf/hpa/ech/rep has 2 digits of parameters
393      *     (strictly, (((10 * 1) + (70 * 2)) / 80) = 1.8750).
394      *
395      * (4) The average case of cud/cuu/vpa has 2 digits of parameters
396      *     (strictly, (((10 * 1) + (14 * 2)) / 24) = 1.5833).
397      *
398      * All these averages depend on the assumption that all parameter values
399      * are equally probable.
400      */
401     SP_PARM->_cup_cost = CostOf(TPARM_2(SP_PARM->_address_cursor, 23, 23), 1);
402     SP_PARM->_cub_cost = CostOf(TPARM_1(parm_left_cursor, 23), 1);
403     SP_PARM->_cuf_cost = CostOf(TPARM_1(parm_right_cursor, 23), 1);
404     SP_PARM->_cud_cost = CostOf(TPARM_1(parm_down_cursor, 23), 1);
405     SP_PARM->_cuu_cost = CostOf(TPARM_1(parm_up_cursor, 23), 1);
406     SP_PARM->_hpa_cost = CostOf(TPARM_1(column_address, 23), 1);
407     SP_PARM->_vpa_cost = CostOf(TPARM_1(row_address, 23), 1);
408
409     /* non-parameterized screen-update strings */
410     SP_PARM->_ed_cost = NormalizedCost(clr_eos, 1);
411     SP_PARM->_el_cost = NormalizedCost(clr_eol, 1);
412     SP_PARM->_el1_cost = NormalizedCost(clr_bol, 1);
413     SP_PARM->_dch1_cost = NormalizedCost(delete_character, 1);
414     SP_PARM->_ich1_cost = NormalizedCost(insert_character, 1);
415
416     /*
417      * If this is a bce-terminal, we want to bias the choice so we use clr_eol
418      * rather than spaces at the end of a line.
419      */
420     if (back_color_erase)
421         SP_PARM->_el_cost = 0;
422
423     /* parameterized screen-update strings */
424     SP_PARM->_dch_cost = NormalizedCost(TPARM_1(parm_dch, 23), 1);
425     SP_PARM->_ich_cost = NormalizedCost(TPARM_1(parm_ich, 23), 1);
426     SP_PARM->_ech_cost = NormalizedCost(TPARM_1(erase_chars, 23), 1);
427     SP_PARM->_rep_cost = NormalizedCost(TPARM_2(repeat_char, ' ', 23), 1);
428
429     SP_PARM->_cup_ch_cost = NormalizedCost(
430                                               TPARM_2(SP_PARM->_address_cursor,
431                                                       23, 23),
432                                               1);
433     SP_PARM->_hpa_ch_cost = NormalizedCost(TPARM_1(column_address, 23), 1);
434     SP_PARM->_cuf_ch_cost = NormalizedCost(TPARM_1(parm_right_cursor, 23), 1);
435     SP_PARM->_inline_cost = min(SP_PARM->_cup_ch_cost,
436                                 min(SP_PARM->_hpa_ch_cost,
437                                     SP_PARM->_cuf_ch_cost));
438
439     /*
440      * If save_cursor is used within enter_ca_mode, we should not use it for
441      * scrolling optimization, since the corresponding restore_cursor is not
442      * nested on the various terminals (vt100, xterm, etc.) which use this
443      * feature.
444      */
445     if (save_cursor != 0
446         && enter_ca_mode != 0
447         && strstr(enter_ca_mode, save_cursor) != 0) {
448         T(("...suppressed sc/rc capability due to conflict with smcup/rmcup"));
449         save_cursor = 0;
450         restore_cursor = 0;
451     }
452
453     /*
454      * A different, possibly better way to arrange this would be to set the
455      * SCREEN's _endwin at window initialization time and let this be called by
456      * doupdate's return-from-shellout code.
457      */
458     NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
459 }
460
461 #if NCURSES_SP_FUNCS
462 NCURSES_EXPORT(void)
463 _nc_mvcur_init(void)
464 {
465     NCURSES_SP_NAME(_nc_mvcur_init) (CURRENT_SCREEN);
466 }
467 #endif
468
469 NCURSES_EXPORT(void)
470 NCURSES_SP_NAME(_nc_mvcur_wrap) (NCURSES_SP_DCL0)
471 /* wrap up cursor-addressing mode */
472 {
473     /* leave cursor at screen bottom */
474     TINFO_MVCUR(NCURSES_SP_ARGx -1, -1, screen_lines(SP_PARM) - 1, 0);
475
476     if (!SP_PARM || !IsTermInfo(SP_PARM))
477         return;
478
479     /* set cursor to normal mode */
480     if (SP_PARM->_cursor != -1) {
481         int cursor = SP_PARM->_cursor;
482         NCURSES_SP_NAME(curs_set) (NCURSES_SP_ARGx 1);
483         SP_PARM->_cursor = cursor;
484     }
485
486     if (exit_ca_mode) {
487         NCURSES_PUTP2("exit_ca_mode", 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
775                int yold, int xold,
776                int ynew, int xnew, int ovw,
777                NCURSES_SP_OUTC myOutCh)
778 /* onscreen move from (yold, xold) to (ynew, xnew) */
779 {
780     string_desc result;
781     char buffer[OPT_SIZE];
782     int tactic = 0, newcost, usecost = INFINITY;
783     int t5_cr_cost;
784
785 #if defined(MAIN) || defined(NCURSES_TEST)
786     struct timeval before, after;
787
788     gettimeofday(&before, NULL);
789 #endif /* MAIN */
790
791 #define NullResult _nc_str_null(&result, sizeof(buffer))
792 #define InitResult _nc_str_init(&result, buffer, sizeof(buffer))
793
794     /* tactic #0: use direct cursor addressing */
795     if (_nc_safe_strcpy(InitResult, TPARM_2(SP_PARM->_address_cursor, ynew, xnew))) {
796         tactic = 0;
797         usecost = SP_PARM->_cup_cost;
798
799 #if defined(TRACE) || defined(NCURSES_TEST)
800         if (!(_nc_optimize_enable & OPTIMIZE_MVCUR))
801             goto nonlocal;
802 #endif /* TRACE */
803
804         /*
805          * We may be able to tell in advance that the full optimization
806          * will probably not be worth its overhead.  Also, don't try to
807          * use local movement if the current attribute is anything but
808          * A_NORMAL...there are just too many ways this can screw up
809          * (like, say, local-movement \n getting mapped to some obscure
810          * character because A_ALTCHARSET is on).
811          */
812         if (yold == -1 || xold == -1 || NOT_LOCAL(SP_PARM, yold, xold, ynew, xnew)) {
813 #if defined(MAIN) || defined(NCURSES_TEST)
814             if (!profiling) {
815                 (void) fputs("nonlocal\n", stderr);
816                 goto nonlocal;  /* always run the optimizer if profiling */
817             }
818 #else
819             goto nonlocal;
820 #endif /* MAIN */
821         }
822     }
823 #ifndef NO_OPTIMIZE
824     /* tactic #1: use local movement */
825     if (yold != -1 && xold != -1
826         && ((newcost = relative_move(NCURSES_SP_ARGx
827                                      NullResult,
828                                      yold, xold,
829                                      ynew, xnew, ovw)) != INFINITY)
830         && newcost < usecost) {
831         tactic = 1;
832         usecost = newcost;
833     }
834
835     /* tactic #2: use carriage-return + local movement */
836     if (yold != -1 && carriage_return
837         && ((newcost = relative_move(NCURSES_SP_ARGx
838                                      NullResult,
839                                      yold, 0,
840                                      ynew, xnew, ovw)) != INFINITY)
841         && SP_PARM->_cr_cost + newcost < usecost) {
842         tactic = 2;
843         usecost = SP_PARM->_cr_cost + newcost;
844     }
845
846     /* tactic #3: use home-cursor + local movement */
847     if (cursor_home
848         && ((newcost = relative_move(NCURSES_SP_ARGx
849                                      NullResult,
850                                      0, 0,
851                                      ynew, xnew, ovw)) != INFINITY)
852         && SP_PARM->_home_cost + newcost < usecost) {
853         tactic = 3;
854         usecost = SP_PARM->_home_cost + newcost;
855     }
856
857     /* tactic #4: use home-down + local movement */
858     if (cursor_to_ll
859         && ((newcost = relative_move(NCURSES_SP_ARGx
860                                      NullResult,
861                                      screen_lines(SP_PARM) - 1, 0,
862                                      ynew, xnew, ovw)) != INFINITY)
863         && SP_PARM->_ll_cost + newcost < usecost) {
864         tactic = 4;
865         usecost = SP_PARM->_ll_cost + newcost;
866     }
867
868     /*
869      * tactic #5: use left margin for wrap to right-hand side,
870      * unless strange wrap behavior indicated by xenl might hose us.
871      */
872     t5_cr_cost = (xold > 0 ? SP_PARM->_cr_cost : 0);
873     if (auto_left_margin && !eat_newline_glitch
874         && yold > 0 && cursor_left
875         && ((newcost = relative_move(NCURSES_SP_ARGx
876                                      NullResult,
877                                      yold - 1, screen_columns(SP_PARM) - 1,
878                                      ynew, xnew, ovw)) != INFINITY)
879         && t5_cr_cost + SP_PARM->_cub1_cost + newcost < usecost) {
880         tactic = 5;
881         usecost = t5_cr_cost + SP_PARM->_cub1_cost + newcost;
882     }
883
884     /*
885      * These cases are ordered by estimated relative frequency.
886      */
887     if (tactic)
888         InitResult;
889     switch (tactic) {
890     case 1:
891         (void) relative_move(NCURSES_SP_ARGx
892                              &result,
893                              yold, xold,
894                              ynew, xnew, ovw);
895         break;
896     case 2:
897         (void) _nc_safe_strcpy(&result, carriage_return);
898         (void) relative_move(NCURSES_SP_ARGx
899                              &result,
900                              yold, 0,
901                              ynew, xnew, ovw);
902         break;
903     case 3:
904         (void) _nc_safe_strcpy(&result, cursor_home);
905         (void) relative_move(NCURSES_SP_ARGx
906                              &result, 0, 0,
907                              ynew, xnew, ovw);
908         break;
909     case 4:
910         (void) _nc_safe_strcpy(&result, cursor_to_ll);
911         (void) relative_move(NCURSES_SP_ARGx
912                              &result,
913                              screen_lines(SP_PARM) - 1, 0,
914                              ynew, xnew, ovw);
915         break;
916     case 5:
917         if (xold > 0)
918             (void) _nc_safe_strcat(&result, carriage_return);
919         (void) _nc_safe_strcat(&result, cursor_left);
920         (void) relative_move(NCURSES_SP_ARGx
921                              &result,
922                              yold - 1, screen_columns(SP_PARM) - 1,
923                              ynew, xnew, ovw);
924         break;
925     }
926 #endif /* !NO_OPTIMIZE */
927
928   nonlocal:
929 #if defined(MAIN) || defined(NCURSES_TEST)
930     gettimeofday(&after, NULL);
931     diff = after.tv_usec - before.tv_usec
932         + (after.tv_sec - before.tv_sec) * 1000000;
933     if (!profiling)
934         (void) fprintf(stderr,
935                        "onscreen: %d microsec, %f 28.8Kbps char-equivalents\n",
936                        (int) diff, diff / 288);
937 #endif /* MAIN */
938
939     if (usecost != INFINITY) {
940         TR(TRACE_MOVE, ("mvcur tactic %d", tactic));
941         TPUTS_TRACE("mvcur");
942         NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
943                                 buffer, 1, myOutCh);
944         SP_PARM->_cursrow = ynew;
945         SP_PARM->_curscol = xnew;
946         return (OK);
947     } else
948         return (ERR);
949 }
950
951 /*
952  * optimized cursor move from (yold, xold) to (ynew, xnew)
953  */
954 static int
955 _nc_real_mvcur(NCURSES_SP_DCLx
956                int yold, int xold,
957                int ynew, int xnew,
958                NCURSES_SP_OUTC myOutCh,
959                int ovw)
960 {
961     NCURSES_CH_T oldattr;
962     int code;
963
964     TR(TRACE_CALLS | TRACE_MOVE, (T_CALLED("_nc_tinfo_mvcur(%p,%d,%d,%d,%d)"),
965                                   (void *) SP_PARM, yold, xold, ynew, xnew));
966
967     if (SP_PARM == 0) {
968         code = ERR;
969     } else if (yold == ynew && xold == xnew) {
970         code = OK;
971     } else {
972
973         /*
974          * Most work here is rounding for terminal boundaries getting the
975          * column position implied by wraparound or the lack thereof and
976          * rolling up the screen to get ynew on the screen.
977          */
978         if (xnew >= screen_columns(SP_PARM)) {
979             ynew += xnew / screen_columns(SP_PARM);
980             xnew %= screen_columns(SP_PARM);
981         }
982
983         /*
984          * Force restore even if msgr is on when we're in an alternate
985          * character set -- these have a strong tendency to screw up the CR &
986          * LF used for local character motions!
987          */
988         oldattr = SCREEN_ATTRS(SP_PARM);
989         if ((AttrOf(oldattr) & A_ALTCHARSET)
990             || (AttrOf(oldattr) && !move_standout_mode)) {
991             TR(TRACE_CHARPUT, ("turning off (%#lx) %s before move",
992                                (unsigned long) AttrOf(oldattr),
993                                _traceattr(AttrOf(oldattr))));
994             (void) VIDATTR(SP_PARM, A_NORMAL, 0);
995         }
996
997         if (xold >= screen_columns(SP_PARM)) {
998
999             if (SP_PARM->_nl) {
1000                 int l = (xold + 1) / screen_columns(SP_PARM);
1001
1002                 yold += l;
1003                 if (yold >= screen_lines(SP_PARM))
1004                     l -= (yold - screen_lines(SP_PARM) - 1);
1005
1006                 if (l > 0) {
1007                     if (carriage_return) {
1008                         NCURSES_PUTP2("carriage_return", carriage_return);
1009                     } else {
1010                         myOutCh(NCURSES_SP_ARGx '\r');
1011                     }
1012                     xold = 0;
1013
1014                     while (l > 0) {
1015                         if (newline) {
1016                             NCURSES_PUTP2("newline", newline);
1017                         } else {
1018                             myOutCh(NCURSES_SP_ARGx '\n');
1019                         }
1020                         l--;
1021                     }
1022                 }
1023             } else {
1024                 /*
1025                  * If caller set nonl(), we cannot really use newlines to
1026                  * position to the next row.
1027                  */
1028                 xold = -1;
1029                 yold = -1;
1030             }
1031         }
1032
1033         if (yold > screen_lines(SP_PARM) - 1)
1034             yold = screen_lines(SP_PARM) - 1;
1035         if (ynew > screen_lines(SP_PARM) - 1)
1036             ynew = screen_lines(SP_PARM) - 1;
1037
1038         /* destination location is on screen now */
1039         code = onscreen_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew, ovw, myOutCh);
1040
1041         /*
1042          * Restore attributes if we disabled them before moving.
1043          */
1044         if (!SameAttrOf(oldattr, SCREEN_ATTRS(SP_PARM))) {
1045             TR(TRACE_CHARPUT, ("turning on (%#lx) %s after move",
1046                                (unsigned long) AttrOf(oldattr),
1047                                _traceattr(AttrOf(oldattr))));
1048             (void) VIDATTR(SP_PARM, AttrOf(oldattr), GetPair(oldattr));
1049         }
1050     }
1051     returnCode(code);
1052 }
1053
1054 /*
1055  * These entrypoints are used within the library.
1056  */
1057 NCURSES_EXPORT(int)
1058 NCURSES_SP_NAME(_nc_mvcur) (NCURSES_SP_DCLx
1059                             int yold, int xold,
1060                             int ynew, int xnew)
1061 {
1062     int rc;
1063     rc = _nc_real_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew,
1064                         NCURSES_SP_NAME(_nc_outch),
1065                         TRUE);
1066     /*
1067      * With the terminal-driver, we cannot distinguish between internal and
1068      * external calls.  Flush the output if the screen has not been
1069      * initialized, e.g., when used from low-level terminfo programs.
1070      */
1071     if ((SP_PARM != 0) && (SP_PARM->_endwin == ewInitial))
1072         NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1073     return rc;
1074 }
1075
1076 #if NCURSES_SP_FUNCS
1077 NCURSES_EXPORT(int)
1078 _nc_mvcur(int yold, int xold,
1079           int ynew, int xnew)
1080 {
1081     return NCURSES_SP_NAME(_nc_mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
1082 }
1083 #endif
1084
1085 #if defined(USE_TERM_DRIVER)
1086 /*
1087  * The terminal driver does not support the external "mvcur()".
1088  */
1089 NCURSES_EXPORT(int)
1090 TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
1091 {
1092     int rc;
1093     rc = _nc_real_mvcur(NCURSES_SP_ARGx
1094                         yold, xold,
1095                         ynew, xnew,
1096                         NCURSES_SP_NAME(_nc_outch),
1097                         TRUE);
1098     if ((SP_PARM != 0) && (SP_PARM->_endwin == ewInitial))
1099         NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1100     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1101     return rc;
1102 }
1103
1104 #else /* !USE_TERM_DRIVER */
1105
1106 /*
1107  * These entrypoints support users of the library.
1108  */
1109 NCURSES_EXPORT(int)
1110 NCURSES_SP_NAME(mvcur) (NCURSES_SP_DCLx int yold, int xold, int ynew,
1111                         int xnew)
1112 {
1113     return _nc_real_mvcur(NCURSES_SP_ARGx
1114                           yold, xold,
1115                           ynew, xnew,
1116                           NCURSES_SP_NAME(_nc_putchar),
1117                           FALSE);
1118 }
1119
1120 #if NCURSES_SP_FUNCS
1121 NCURSES_EXPORT(int)
1122 mvcur(int yold, int xold, int ynew, int xnew)
1123 {
1124     return NCURSES_SP_NAME(mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
1125 }
1126 #endif
1127 #endif /* USE_TERM_DRIVER */
1128
1129 #if defined(TRACE) || defined(NCURSES_TEST)
1130 NCURSES_EXPORT_VAR(int) _nc_optimize_enable = OPTIMIZE_ALL;
1131 #endif
1132
1133 #if defined(MAIN) || defined(NCURSES_TEST)
1134 /****************************************************************************
1135  *
1136  * Movement optimizer test code
1137  *
1138  ****************************************************************************/
1139
1140 #include <tic.h>
1141 #include <dump_entry.h>
1142 #include <time.h>
1143
1144 NCURSES_EXPORT_VAR(const char *) _nc_progname = "mvcur";
1145
1146 static unsigned long xmits;
1147
1148 /* these override lib_tputs.c */
1149 NCURSES_EXPORT(int)
1150 tputs(const char *string, int affcnt GCC_UNUSED, int (*outc) (int) GCC_UNUSED)
1151 /* stub tputs() that dumps sequences in a visible form */
1152 {
1153     if (profiling)
1154         xmits += strlen(string);
1155     else
1156         (void) fputs(_nc_visbuf(string), stdout);
1157     return (OK);
1158 }
1159
1160 NCURSES_EXPORT(int)
1161 putp(const char *string)
1162 {
1163     return (tputs(string, 1, _nc_outch));
1164 }
1165
1166 NCURSES_EXPORT(int)
1167 _nc_outch(int ch)
1168 {
1169     putc(ch, stdout);
1170     return OK;
1171 }
1172
1173 NCURSES_EXPORT(int)
1174 delay_output(int ms GCC_UNUSED)
1175 {
1176     return OK;
1177 }
1178
1179 static char tname[PATH_MAX];
1180
1181 static void
1182 load_term(void)
1183 {
1184     (void) setupterm(tname, STDOUT_FILENO, NULL);
1185 }
1186
1187 static int
1188 roll(int n)
1189 {
1190     int i, j;
1191
1192     i = (RAND_MAX / n) * n;
1193     while ((j = rand()) >= i)
1194         continue;
1195     return (j % n);
1196 }
1197
1198 int
1199 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
1200 {
1201     _nc_STRCPY(tname, getenv("TERM"), sizeof(tname));
1202     load_term();
1203     _nc_setupscreen(lines, columns, stdout, FALSE, 0);
1204     baudrate();
1205
1206     _nc_mvcur_init();
1207
1208     (void) puts("The mvcur tester.  Type ? for help");
1209
1210     fputs("smcup:", stdout);
1211     putchar('\n');
1212
1213     for (;;) {
1214         int fy, fx, ty, tx, n, i;
1215         char buf[BUFSIZ], capname[BUFSIZ];
1216
1217         if (fputs("> ", stdout) == EOF)
1218             break;
1219         if (fgets(buf, sizeof(buf), stdin) == 0)
1220             break;
1221
1222 #define PUTS(s)   (void) puts(s)
1223 #define PUTF(s,t) (void) printf(s,t)
1224         if (buf[0] == '?') {
1225             PUTS("?                -- display this help message");
1226             PUTS("fy fx ty tx      -- (4 numbers) display (fy,fx)->(ty,tx) move");
1227             PUTS("s[croll] n t b m -- display scrolling sequence");
1228             PUTF("r[eload]         -- reload terminal info for %s\n",
1229                  termname());
1230             PUTS("l[oad] <term>    -- load terminal info for type <term>");
1231             PUTS("d[elete] <cap>   -- delete named capability");
1232             PUTS("i[nspect]        -- display terminal capabilities");
1233             PUTS("c[ost]           -- dump cursor-optimization cost table");
1234             PUTS("o[optimize]      -- toggle movement optimization");
1235             PUTS("t[orture] <num>  -- torture-test with <num> random moves");
1236             PUTS("q[uit]           -- quit the program");
1237         } else if (sscanf(buf, "%d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1238             struct timeval before, after;
1239
1240             putchar('"');
1241
1242             gettimeofday(&before, NULL);
1243             mvcur(fy, fx, ty, tx);
1244             gettimeofday(&after, NULL);
1245
1246             printf("\" (%ld msec)\n",
1247                    (long) (after.tv_usec - before.tv_usec
1248                            + (after.tv_sec - before.tv_sec)
1249                            * 1000000));
1250         } else if (sscanf(buf, "s %d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1251             struct timeval before, after;
1252
1253             putchar('"');
1254
1255             gettimeofday(&before, NULL);
1256             _nc_scrolln(fy, fx, ty, tx);
1257             gettimeofday(&after, NULL);
1258
1259             printf("\" (%ld msec)\n",
1260                    (long) (after.tv_usec - before.tv_usec + (after.tv_sec -
1261                                                              before.tv_sec)
1262                            * 1000000));
1263         } else if (buf[0] == 'r') {
1264             _nc_STRCPY(tname, termname(), sizeof(tname));
1265             load_term();
1266         } else if (sscanf(buf, "l %s", tname) == 1) {
1267             load_term();
1268         } else if (sscanf(buf, "d %s", capname) == 1) {
1269             struct name_table_entry const *np = _nc_find_entry(capname,
1270                                                                _nc_get_hash_table(FALSE));
1271
1272             if (np == NULL)
1273                 (void) printf("No such capability as \"%s\"\n", capname);
1274             else {
1275                 switch (np->nte_type) {
1276                 case BOOLEAN:
1277                     cur_term->type.Booleans[np->nte_index] = FALSE;
1278                     (void)
1279                         printf("Boolean capability `%s' (%d) turned off.\n",
1280                                np->nte_name, np->nte_index);
1281                     break;
1282
1283                 case NUMBER:
1284                     cur_term->type.Numbers[np->nte_index] = ABSENT_NUMERIC;
1285                     (void) printf("Number capability `%s' (%d) set to -1.\n",
1286                                   np->nte_name, np->nte_index);
1287                     break;
1288
1289                 case STRING:
1290                     cur_term->type.Strings[np->nte_index] = ABSENT_STRING;
1291                     (void) printf("String capability `%s' (%d) deleted.\n",
1292                                   np->nte_name, np->nte_index);
1293                     break;
1294                 }
1295             }
1296         } else if (buf[0] == 'i') {
1297             dump_init(NULL, F_TERMINFO, S_TERMINFO,
1298                       FALSE, 70, 0, 0, FALSE, FALSE, 0);
1299             dump_entry(&TerminalType(cur_term), FALSE, TRUE, 0, 0);
1300             putchar('\n');
1301         } else if (buf[0] == 'o') {
1302             if (_nc_optimize_enable & OPTIMIZE_MVCUR) {
1303                 _nc_optimize_enable &= ~OPTIMIZE_MVCUR;
1304                 (void) puts("Optimization is now off.");
1305             } else {
1306                 _nc_optimize_enable |= OPTIMIZE_MVCUR;
1307                 (void) puts("Optimization is now on.");
1308             }
1309         }
1310         /*
1311          * You can use the `t' test to profile and tune the movement
1312          * optimizer.  Use iteration values in three digits or more.
1313          * At above 5000 iterations the profile timing averages are stable
1314          * to within a millisecond or three.
1315          *
1316          * The `overhead' field of the report will help you pick a
1317          * COMPUTE_OVERHEAD figure appropriate for your processor and
1318          * expected line speed.  The `total estimated time' is
1319          * computation time plus a character-transmission time
1320          * estimate computed from the number of transmits and the baud
1321          * rate.
1322          *
1323          * Use this together with the `o' command to get a read on the
1324          * optimizer's effectiveness.  Compare the total estimated times
1325          * for `t' runs of the same length in both optimized and un-optimized
1326          * modes.  As long as the optimized times are less, the optimizer
1327          * is winning.
1328          */
1329         else if (sscanf(buf, "t %d", &n) == 1) {
1330             float cumtime = 0.0, perchar;
1331             int speeds[] =
1332             {2400, 9600, 14400, 19200, 28800, 38400, 0};
1333
1334             srand((unsigned) (getpid() + time((time_t *) 0)));
1335             profiling = TRUE;
1336             xmits = 0;
1337             for (i = 0; i < n; i++) {
1338                 /*
1339                  * This does a move test between two random locations,
1340                  * Random moves probably short-change the optimizer,
1341                  * which will work better on the short moves probably
1342                  * typical of doupdate()'s usage pattern.  Still,
1343                  * until we have better data...
1344                  */
1345 #ifdef FIND_COREDUMP
1346                 int from_y = roll(lines);
1347                 int to_y = roll(lines);
1348                 int from_x = roll(columns);
1349                 int to_x = roll(columns);
1350
1351                 printf("(%d,%d) -> (%d,%d)\n", from_y, from_x, to_y, to_x);
1352                 mvcur(from_y, from_x, to_y, to_x);
1353 #else
1354                 mvcur(roll(lines), roll(columns), roll(lines), roll(columns));
1355 #endif /* FIND_COREDUMP */
1356                 if (diff)
1357                     cumtime += diff;
1358             }
1359             profiling = FALSE;
1360
1361             /*
1362              * Average milliseconds per character optimization time.
1363              * This is the key figure to watch when tuning the optimizer.
1364              */
1365             perchar = cumtime / n;
1366
1367             (void) printf("%d moves (%ld chars) in %d msec, %f msec each:\n",
1368                           n, xmits, (int) cumtime, perchar);
1369
1370             for (i = 0; speeds[i]; i++) {
1371                 /*
1372                  * Total estimated time for the moves, computation and
1373                  * transmission both. Transmission time is an estimate
1374                  * assuming 9 bits/char, 8 bits + 1 stop bit.
1375                  */
1376                 float totalest = cumtime + xmits * 9 * 1e6 / speeds[i];
1377
1378                 /*
1379                  * Per-character optimization overhead in character transmits
1380                  * at the current speed.  Round this to the nearest integer
1381                  * to figure COMPUTE_OVERHEAD for the speed.
1382                  */
1383                 float overhead = speeds[i] * perchar / 1e6;
1384
1385                 (void)
1386                     printf("%6d bps: %3.2f char-xmits overhead; total estimated time %15.2f\n",
1387                            speeds[i], overhead, totalest);
1388             }
1389         } else if (buf[0] == 'c') {
1390             (void) printf("char padding: %d\n", CURRENT_SCREEN->_char_padding);
1391             (void) printf("cr cost: %d\n", CURRENT_SCREEN->_cr_cost);
1392             (void) printf("cup cost: %d\n", CURRENT_SCREEN->_cup_cost);
1393             (void) printf("home cost: %d\n", CURRENT_SCREEN->_home_cost);
1394             (void) printf("ll cost: %d\n", CURRENT_SCREEN->_ll_cost);
1395 #if USE_HARD_TABS
1396             (void) printf("ht cost: %d\n", CURRENT_SCREEN->_ht_cost);
1397             (void) printf("cbt cost: %d\n", CURRENT_SCREEN->_cbt_cost);
1398 #endif /* USE_HARD_TABS */
1399             (void) printf("cub1 cost: %d\n", CURRENT_SCREEN->_cub1_cost);
1400             (void) printf("cuf1 cost: %d\n", CURRENT_SCREEN->_cuf1_cost);
1401             (void) printf("cud1 cost: %d\n", CURRENT_SCREEN->_cud1_cost);
1402             (void) printf("cuu1 cost: %d\n", CURRENT_SCREEN->_cuu1_cost);
1403             (void) printf("cub cost: %d\n", CURRENT_SCREEN->_cub_cost);
1404             (void) printf("cuf cost: %d\n", CURRENT_SCREEN->_cuf_cost);
1405             (void) printf("cud cost: %d\n", CURRENT_SCREEN->_cud_cost);
1406             (void) printf("cuu cost: %d\n", CURRENT_SCREEN->_cuu_cost);
1407             (void) printf("hpa cost: %d\n", CURRENT_SCREEN->_hpa_cost);
1408             (void) printf("vpa cost: %d\n", CURRENT_SCREEN->_vpa_cost);
1409         } else if (buf[0] == 'x' || buf[0] == 'q')
1410             break;
1411         else
1412             (void) puts("Invalid command.");
1413     }
1414
1415     (void) fputs("rmcup:", stdout);
1416     _nc_mvcur_wrap();
1417     putchar('\n');
1418
1419     return (0);
1420 }
1421
1422 #endif /* MAIN */
1423
1424 /* lib_mvcur.c ends here */