1/****************************************************************************
2 * Copyright (c) 1998-2012,2013 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
162MODULE_ID("$Id: lib_mvcur.c,v 1.133 2013/05/25 23:59:41 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
175static bool profiling = FALSE;
176static float diff;
177#endif /* MAIN */
178
179#undef NCURSES_OUTC_FUNC
180#define NCURSES_OUTC_FUNC myOutCh
181
182#define OPT_SIZE 512
183
184static 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
193static int
194trace_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
203static int
204trace_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
220NCURSES_EXPORT(int)
221NCURSES_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
258NCURSES_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
265static int
266normalized_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
275static void
276reset_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
286NCURSES_EXPORT(void)
287NCURSES_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
319NCURSES_EXPORT(void)
320_nc_mvcur_resume(void)
321{
322    NCURSES_SP_NAME(_nc_mvcur_resume) (CURRENT_SCREEN);
323}
324#endif
325
326NCURSES_EXPORT(void)
327NCURSES_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
460NCURSES_EXPORT(void)
461_nc_mvcur_init(void)
462{
463    NCURSES_SP_NAME(_nc_mvcur_init) (CURRENT_SCREEN);
464}
465#endif
466
467NCURSES_EXPORT(void)
468NCURSES_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_PUTP2("exit_ca_mode", exit_ca_mode);
486    }
487    /*
488     * Reset terminal's tab counter.  There's a long-time bug that
489     * if you exit a "curses" program such as vi or more, tab
490     * forward, and then backspace, the cursor doesn't go to the
491     * right place.  The problem is that the kernel counts the
492     * escape sequences that reset things as column positions.
493     * Utter a \r to reset this invisibly.
494     */
495    NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_ARGx '\r');
496}
497
498#if NCURSES_SP_FUNCS
499NCURSES_EXPORT(void)
500_nc_mvcur_wrap(void)
501{
502    NCURSES_SP_NAME(_nc_mvcur_wrap) (CURRENT_SCREEN);
503}
504#endif
505
506/****************************************************************************
507 *
508 * Optimized cursor movement
509 *
510 ****************************************************************************/
511
512/*
513 * Perform repeated-append, returning cost
514 */
515static NCURSES_INLINE int
516repeated_append(string_desc * target, int total, int num, int repeat, const char *src)
517{
518    size_t need = (size_t) repeat * strlen(src);
519
520    if (need < target->s_size) {
521	while (repeat-- > 0) {
522	    if (_nc_safe_strcat(target, src)) {
523		total += num;
524	    } else {
525		total = INFINITY;
526		break;
527	    }
528	}
529    } else {
530	total = INFINITY;
531    }
532    return total;
533}
534
535#ifndef NO_OPTIMIZE
536#define NEXTTAB(fr)	(fr + init_tabs - (fr % init_tabs))
537
538/*
539 * Assume back_tab (CBT) does not wrap backwards at the left margin, return
540 * a negative value at that point to simplify the loop.
541 */
542#define LASTTAB(fr)	((fr > 0) ? ((fr - 1) / init_tabs) * init_tabs : -1)
543
544static int
545relative_move(NCURSES_SP_DCLx
546	      string_desc * target,
547	      int from_y,
548	      int from_x,
549	      int to_y,
550	      int to_x,
551	      int ovw)
552/* move via local motions (cuu/cuu1/cud/cud1/cub1/cub/cuf1/cuf/vpa/hpa) */
553{
554    string_desc save;
555    int n, vcost = 0, hcost = 0;
556
557    (void) _nc_str_copy(&save, target);
558
559    if (to_y != from_y) {
560	vcost = INFINITY;
561
562	if (row_address != 0
563	    && _nc_safe_strcat(target, TPARM_1(row_address, to_y))) {
564	    vcost = SP_PARM->_vpa_cost;
565	}
566
567	if (to_y > from_y) {
568	    n = (to_y - from_y);
569
570	    if (parm_down_cursor
571		&& SP_PARM->_cud_cost < vcost
572		&& _nc_safe_strcat(_nc_str_copy(target, &save),
573				   TPARM_1(parm_down_cursor, n))) {
574		vcost = SP_PARM->_cud_cost;
575	    }
576
577	    if (cursor_down
578		&& (*cursor_down != '\n' || SP_PARM->_nl)
579		&& (n * SP_PARM->_cud1_cost < vcost)) {
580		vcost = repeated_append(_nc_str_copy(target, &save), 0,
581					SP_PARM->_cud1_cost, n, cursor_down);
582	    }
583	} else {		/* (to_y < from_y) */
584	    n = (from_y - to_y);
585
586	    if (parm_up_cursor
587		&& SP_PARM->_cuu_cost < vcost
588		&& _nc_safe_strcat(_nc_str_copy(target, &save),
589				   TPARM_1(parm_up_cursor, n))) {
590		vcost = SP_PARM->_cuu_cost;
591	    }
592
593	    if (cursor_up && (n * SP_PARM->_cuu1_cost < vcost)) {
594		vcost = repeated_append(_nc_str_copy(target, &save), 0,
595					SP_PARM->_cuu1_cost, n, cursor_up);
596	    }
597	}
598
599	if (vcost == INFINITY)
600	    return (INFINITY);
601    }
602
603    save = *target;
604
605    if (to_x != from_x) {
606	char str[OPT_SIZE];
607	string_desc check;
608
609	hcost = INFINITY;
610
611	if (column_address
612	    && _nc_safe_strcat(_nc_str_copy(target, &save),
613			       TPARM_1(column_address, to_x))) {
614	    hcost = SP_PARM->_hpa_cost;
615	}
616
617	if (to_x > from_x) {
618	    n = to_x - from_x;
619
620	    if (parm_right_cursor
621		&& SP_PARM->_cuf_cost < hcost
622		&& _nc_safe_strcat(_nc_str_copy(target, &save),
623				   TPARM_1(parm_right_cursor, n))) {
624		hcost = SP_PARM->_cuf_cost;
625	    }
626
627	    if (cursor_right) {
628		int lhcost = 0;
629
630		(void) _nc_str_init(&check, str, sizeof(str));
631
632#if USE_HARD_TABS
633		/* use hard tabs, if we have them, to do as much as possible */
634		if (init_tabs > 0 && tab) {
635		    int nxt, fr;
636
637		    for (fr = from_x; (nxt = NEXTTAB(fr)) <= to_x; fr = nxt) {
638			lhcost = repeated_append(&check, lhcost,
639						 SP_PARM->_ht_cost, 1, tab);
640			if (lhcost == INFINITY)
641			    break;
642		    }
643
644		    n = to_x - fr;
645		    from_x = fr;
646		}
647#endif /* USE_HARD_TABS */
648
649		if (n <= 0 || n >= (int) check.s_size)
650		    ovw = FALSE;
651#if BSD_TPUTS
652		/*
653		 * If we're allowing BSD-style padding in tputs, don't generate
654		 * a string with a leading digit.  Otherwise, that will be
655		 * interpreted as a padding value rather than sent to the
656		 * screen.
657		 */
658		if (ovw
659		    && n > 0
660		    && n < (int) check.s_size
661		    && vcost == 0
662		    && str[0] == '\0') {
663		    int wanted = CharOf(WANT_CHAR(SP_PARM, to_y, from_x));
664		    if (is8bits(wanted) && isdigit(wanted))
665			ovw = FALSE;
666		}
667#endif
668		/*
669		 * If we have no attribute changes, overwrite is cheaper.
670		 * Note: must suppress this by passing in ovw = FALSE whenever
671		 * WANT_CHAR would return invalid data.  In particular, this
672		 * is true between the time a hardware scroll has been done
673		 * and the time the structure WANT_CHAR would access has been
674		 * updated.
675		 */
676		if (ovw) {
677		    int i;
678
679		    for (i = 0; i < n; i++) {
680			NCURSES_CH_T ch = WANT_CHAR(SP_PARM, to_y, from_x + i);
681			if (!SameAttrOf(ch, SCREEN_ATTRS(SP_PARM))
682#if USE_WIDEC_SUPPORT
683			    || !Charable(ch)
684#endif
685			    ) {
686			    ovw = FALSE;
687			    break;
688			}
689		    }
690		}
691		if (ovw) {
692		    int i;
693
694		    for (i = 0; i < n; i++)
695			*check.s_tail++ = (char) CharOf(WANT_CHAR(SP_PARM, to_y,
696								  from_x + i));
697		    *check.s_tail = '\0';
698		    check.s_size -= (size_t) n;
699		    lhcost += n * SP_PARM->_char_padding;
700		} else {
701		    lhcost = repeated_append(&check, lhcost, SP_PARM->_cuf1_cost,
702					     n, cursor_right);
703		}
704
705		if (lhcost < hcost
706		    && _nc_safe_strcat(_nc_str_copy(target, &save), str)) {
707		    hcost = lhcost;
708		}
709	    }
710	} else {		/* (to_x < from_x) */
711	    n = from_x - to_x;
712
713	    if (parm_left_cursor
714		&& SP_PARM->_cub_cost < hcost
715		&& _nc_safe_strcat(_nc_str_copy(target, &save),
716				   TPARM_1(parm_left_cursor, n))) {
717		hcost = SP_PARM->_cub_cost;
718	    }
719
720	    if (cursor_left) {
721		int lhcost = 0;
722
723		(void) _nc_str_init(&check, str, sizeof(str));
724
725#if USE_HARD_TABS
726		if (init_tabs > 0 && back_tab) {
727		    int nxt, fr;
728
729		    for (fr = from_x; (nxt = LASTTAB(fr)) >= to_x; fr = nxt) {
730			lhcost = repeated_append(&check, lhcost,
731						 SP_PARM->_cbt_cost,
732						 1, back_tab);
733			if (lhcost == INFINITY)
734			    break;
735		    }
736
737		    n = fr - to_x;
738		}
739#endif /* USE_HARD_TABS */
740
741		lhcost = repeated_append(&check, lhcost,
742					 SP_PARM->_cub1_cost,
743					 n, cursor_left);
744
745		if (lhcost < hcost
746		    && _nc_safe_strcat(_nc_str_copy(target, &save), str)) {
747		    hcost = lhcost;
748		}
749	    }
750	}
751
752	if (hcost == INFINITY)
753	    return (INFINITY);
754    }
755
756    return (vcost + hcost);
757}
758#endif /* !NO_OPTIMIZE */
759
760/*
761 * With the machinery set up above, it's conceivable that
762 * onscreen_mvcur could be modified into a recursive function that does
763 * an alpha-beta search of motion space, as though it were a chess
764 * move tree, with the weight function being boolean and the search
765 * depth equated to length of string.  However, this would jack up the
766 * computation cost a lot, especially on terminals without a cup
767 * capability constraining the search tree depth.  So we settle for
768 * the simpler method below.
769 */
770
771static NCURSES_INLINE int
772onscreen_mvcur(NCURSES_SP_DCLx
773	       int yold, int xold,
774	       int ynew, int xnew, int ovw,
775	       NCURSES_SP_OUTC myOutCh)
776/* onscreen move from (yold, xold) to (ynew, xnew) */
777{
778    string_desc result;
779    char buffer[OPT_SIZE];
780    int tactic = 0, newcost, usecost = INFINITY;
781    int t5_cr_cost;
782
783#if defined(MAIN) || defined(NCURSES_TEST)
784    struct timeval before, after;
785
786    gettimeofday(&before, NULL);
787#endif /* MAIN */
788
789#define NullResult _nc_str_null(&result, sizeof(buffer))
790#define InitResult _nc_str_init(&result, buffer, sizeof(buffer))
791
792    /* tactic #0: use direct cursor addressing */
793    if (_nc_safe_strcpy(InitResult, TPARM_2(SP_PARM->_address_cursor, ynew, xnew))) {
794	tactic = 0;
795	usecost = SP_PARM->_cup_cost;
796
797#if defined(TRACE) || defined(NCURSES_TEST)
798	if (!(_nc_optimize_enable & OPTIMIZE_MVCUR))
799	    goto nonlocal;
800#endif /* TRACE */
801
802	/*
803	 * We may be able to tell in advance that the full optimization
804	 * will probably not be worth its overhead.  Also, don't try to
805	 * use local movement if the current attribute is anything but
806	 * A_NORMAL...there are just too many ways this can screw up
807	 * (like, say, local-movement \n getting mapped to some obscure
808	 * character because A_ALTCHARSET is on).
809	 */
810	if (yold == -1 || xold == -1 || NOT_LOCAL(SP_PARM, yold, xold, ynew, xnew)) {
811#if defined(MAIN) || defined(NCURSES_TEST)
812	    if (!profiling) {
813		(void) fputs("nonlocal\n", stderr);
814		goto nonlocal;	/* always run the optimizer if profiling */
815	    }
816#else
817	    goto nonlocal;
818#endif /* MAIN */
819	}
820    }
821#ifndef NO_OPTIMIZE
822    /* tactic #1: use local movement */
823    if (yold != -1 && xold != -1
824	&& ((newcost = relative_move(NCURSES_SP_ARGx
825				     NullResult,
826				     yold, xold,
827				     ynew, xnew, ovw)) != INFINITY)
828	&& newcost < usecost) {
829	tactic = 1;
830	usecost = newcost;
831    }
832
833    /* tactic #2: use carriage-return + local movement */
834    if (yold != -1 && carriage_return
835	&& ((newcost = relative_move(NCURSES_SP_ARGx
836				     NullResult,
837				     yold, 0,
838				     ynew, xnew, ovw)) != INFINITY)
839	&& SP_PARM->_cr_cost + newcost < usecost) {
840	tactic = 2;
841	usecost = SP_PARM->_cr_cost + newcost;
842    }
843
844    /* tactic #3: use home-cursor + local movement */
845    if (cursor_home
846	&& ((newcost = relative_move(NCURSES_SP_ARGx
847				     NullResult,
848				     0, 0,
849				     ynew, xnew, ovw)) != INFINITY)
850	&& SP_PARM->_home_cost + newcost < usecost) {
851	tactic = 3;
852	usecost = SP_PARM->_home_cost + newcost;
853    }
854
855    /* tactic #4: use home-down + local movement */
856    if (cursor_to_ll
857	&& ((newcost = relative_move(NCURSES_SP_ARGx
858				     NullResult,
859				     screen_lines(SP_PARM) - 1, 0,
860				     ynew, xnew, ovw)) != INFINITY)
861	&& SP_PARM->_ll_cost + newcost < usecost) {
862	tactic = 4;
863	usecost = SP_PARM->_ll_cost + newcost;
864    }
865
866    /*
867     * tactic #5: use left margin for wrap to right-hand side,
868     * unless strange wrap behavior indicated by xenl might hose us.
869     */
870    t5_cr_cost = (xold > 0 ? SP_PARM->_cr_cost : 0);
871    if (auto_left_margin && !eat_newline_glitch
872	&& yold > 0 && cursor_left
873	&& ((newcost = relative_move(NCURSES_SP_ARGx
874				     NullResult,
875				     yold - 1, screen_columns(SP_PARM) - 1,
876				     ynew, xnew, ovw)) != INFINITY)
877	&& t5_cr_cost + SP_PARM->_cub1_cost + newcost < usecost) {
878	tactic = 5;
879	usecost = t5_cr_cost + SP_PARM->_cub1_cost + newcost;
880    }
881
882    /*
883     * These cases are ordered by estimated relative frequency.
884     */
885    if (tactic)
886	InitResult;
887    switch (tactic) {
888    case 1:
889	(void) relative_move(NCURSES_SP_ARGx
890			     &result,
891			     yold, xold,
892			     ynew, xnew, ovw);
893	break;
894    case 2:
895	(void) _nc_safe_strcpy(&result, carriage_return);
896	(void) relative_move(NCURSES_SP_ARGx
897			     &result,
898			     yold, 0,
899			     ynew, xnew, ovw);
900	break;
901    case 3:
902	(void) _nc_safe_strcpy(&result, cursor_home);
903	(void) relative_move(NCURSES_SP_ARGx
904			     &result, 0, 0,
905			     ynew, xnew, ovw);
906	break;
907    case 4:
908	(void) _nc_safe_strcpy(&result, cursor_to_ll);
909	(void) relative_move(NCURSES_SP_ARGx
910			     &result,
911			     screen_lines(SP_PARM) - 1, 0,
912			     ynew, xnew, ovw);
913	break;
914    case 5:
915	if (xold > 0)
916	    (void) _nc_safe_strcat(&result, carriage_return);
917	(void) _nc_safe_strcat(&result, cursor_left);
918	(void) relative_move(NCURSES_SP_ARGx
919			     &result,
920			     yold - 1, screen_columns(SP_PARM) - 1,
921			     ynew, xnew, ovw);
922	break;
923    }
924#endif /* !NO_OPTIMIZE */
925
926  nonlocal:
927#if defined(MAIN) || defined(NCURSES_TEST)
928    gettimeofday(&after, NULL);
929    diff = after.tv_usec - before.tv_usec
930	+ (after.tv_sec - before.tv_sec) * 1000000;
931    if (!profiling)
932	(void) fprintf(stderr,
933		       "onscreen: %d microsec, %f 28.8Kbps char-equivalents\n",
934		       (int) diff, diff / 288);
935#endif /* MAIN */
936
937    if (usecost != INFINITY) {
938	TPUTS_TRACE("mvcur");
939	NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
940				buffer, 1, myOutCh);
941	SP_PARM->_cursrow = ynew;
942	SP_PARM->_curscol = xnew;
943	return (OK);
944    } else
945	return (ERR);
946}
947
948/*
949 * optimized cursor move from (yold, xold) to (ynew, xnew)
950 */
951static int
952_nc_real_mvcur(NCURSES_SP_DCLx
953	       int yold, int xold,
954	       int ynew, int xnew,
955	       NCURSES_SP_OUTC myOutCh,
956	       int ovw)
957{
958    NCURSES_CH_T oldattr;
959    int code;
960
961    TR(TRACE_CALLS | TRACE_MOVE, (T_CALLED("_nc_tinfo_mvcur(%p,%d,%d,%d,%d)"),
962				  (void *) SP_PARM, yold, xold, ynew, xnew));
963
964    if (SP_PARM == 0) {
965	code = ERR;
966    } else if (yold == ynew && xold == xnew) {
967	code = OK;
968    } else {
969
970	/*
971	 * Most work here is rounding for terminal boundaries getting the
972	 * column position implied by wraparound or the lack thereof and
973	 * rolling up the screen to get ynew on the screen.
974	 */
975	if (xnew >= screen_columns(SP_PARM)) {
976	    ynew += xnew / screen_columns(SP_PARM);
977	    xnew %= screen_columns(SP_PARM);
978	}
979
980	/*
981	 * Force restore even if msgr is on when we're in an alternate
982	 * character set -- these have a strong tendency to screw up the CR &
983	 * LF used for local character motions!
984	 */
985	oldattr = SCREEN_ATTRS(SP_PARM);
986	if ((AttrOf(oldattr) & A_ALTCHARSET)
987	    || (AttrOf(oldattr) && !move_standout_mode)) {
988	    TR(TRACE_CHARPUT, ("turning off (%#lx) %s before move",
989			       (unsigned long) AttrOf(oldattr),
990			       _traceattr(AttrOf(oldattr))));
991	    (void) VIDATTR(SP_PARM, A_NORMAL, 0);
992	}
993
994	if (xold >= screen_columns(SP_PARM)) {
995	    int l;
996
997	    if (SP_PARM->_nl) {
998		l = (xold + 1) / screen_columns(SP_PARM);
999		yold += l;
1000		if (yold >= screen_lines(SP_PARM))
1001		    l -= (yold - screen_lines(SP_PARM) - 1);
1002
1003		if (l > 0) {
1004		    if (carriage_return) {
1005			NCURSES_PUTP2("carriage_return", carriage_return);
1006		    } else {
1007			myOutCh(NCURSES_SP_ARGx '\r');
1008		    }
1009		    xold = 0;
1010
1011		    while (l > 0) {
1012			if (newline) {
1013			    NCURSES_PUTP2("newline", newline);
1014			} else {
1015			    myOutCh(NCURSES_SP_ARGx '\n');
1016			}
1017			l--;
1018		    }
1019		}
1020	    } else {
1021		/*
1022		 * If caller set nonl(), we cannot really use newlines to
1023		 * position to the next row.
1024		 */
1025		xold = -1;
1026		yold = -1;
1027	    }
1028	}
1029
1030	if (yold > screen_lines(SP_PARM) - 1)
1031	    yold = screen_lines(SP_PARM) - 1;
1032	if (ynew > screen_lines(SP_PARM) - 1)
1033	    ynew = screen_lines(SP_PARM) - 1;
1034
1035	/* destination location is on screen now */
1036	code = onscreen_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew, ovw, myOutCh);
1037
1038	/*
1039	 * Restore attributes if we disabled them before moving.
1040	 */
1041	if (!SameAttrOf(oldattr, SCREEN_ATTRS(SP_PARM))) {
1042	    TR(TRACE_CHARPUT, ("turning on (%#lx) %s after move",
1043			       (unsigned long) AttrOf(oldattr),
1044			       _traceattr(AttrOf(oldattr))));
1045	    (void) VIDATTR(SP_PARM, AttrOf(oldattr), GetPair(oldattr));
1046	}
1047    }
1048    returnCode(code);
1049}
1050
1051/*
1052 * These entrypoints are used within the library.
1053 */
1054NCURSES_EXPORT(int)
1055NCURSES_SP_NAME(_nc_mvcur) (NCURSES_SP_DCLx
1056			    int yold, int xold,
1057			    int ynew, int xnew)
1058{
1059    return _nc_real_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew,
1060			  NCURSES_SP_NAME(_nc_outch),
1061			  TRUE);
1062}
1063
1064#if NCURSES_SP_FUNCS
1065NCURSES_EXPORT(int)
1066_nc_mvcur(int yold, int xold,
1067	  int ynew, int xnew)
1068{
1069    return NCURSES_SP_NAME(_nc_mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
1070}
1071#endif
1072
1073#if defined(USE_TERM_DRIVER)
1074/*
1075 * The terminal driver does not support the external "mvcur()".
1076 */
1077NCURSES_EXPORT(int)
1078TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
1079{
1080    return _nc_real_mvcur(NCURSES_SP_ARGx
1081			  yold, xold,
1082			  ynew, xnew,
1083			  NCURSES_SP_NAME(_nc_outch),
1084			  TRUE);
1085}
1086
1087#else /* !USE_TERM_DRIVER */
1088
1089/*
1090 * These entrypoints support users of the library.
1091 */
1092NCURSES_EXPORT(int)
1093NCURSES_SP_NAME(mvcur) (NCURSES_SP_DCLx int yold, int xold, int ynew,
1094			int xnew)
1095{
1096    return _nc_real_mvcur(NCURSES_SP_ARGx
1097			  yold, xold,
1098			  ynew, xnew,
1099			  NCURSES_SP_NAME(_nc_putchar),
1100			  FALSE);
1101}
1102
1103#if NCURSES_SP_FUNCS
1104NCURSES_EXPORT(int)
1105mvcur(int yold, int xold, int ynew, int xnew)
1106{
1107    return NCURSES_SP_NAME(mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
1108}
1109#endif
1110#endif /* USE_TERM_DRIVER */
1111
1112#if defined(TRACE) || defined(NCURSES_TEST)
1113NCURSES_EXPORT_VAR(int) _nc_optimize_enable = OPTIMIZE_ALL;
1114#endif
1115
1116#if defined(MAIN) || defined(NCURSES_TEST)
1117/****************************************************************************
1118 *
1119 * Movement optimizer test code
1120 *
1121 ****************************************************************************/
1122
1123#include <tic.h>
1124#include <dump_entry.h>
1125#include <time.h>
1126
1127NCURSES_EXPORT_VAR(const char *) _nc_progname = "mvcur";
1128
1129static unsigned long xmits;
1130
1131/* these override lib_tputs.c */
1132NCURSES_EXPORT(int)
1133tputs(const char *string, int affcnt GCC_UNUSED, int (*outc) (int) GCC_UNUSED)
1134/* stub tputs() that dumps sequences in a visible form */
1135{
1136    if (profiling)
1137	xmits += strlen(string);
1138    else
1139	(void) fputs(_nc_visbuf(string), stdout);
1140    return (OK);
1141}
1142
1143NCURSES_EXPORT(int)
1144putp(const char *string)
1145{
1146    return (tputs(string, 1, _nc_outch));
1147}
1148
1149NCURSES_EXPORT(int)
1150_nc_outch(int ch)
1151{
1152    putc(ch, stdout);
1153    return OK;
1154}
1155
1156NCURSES_EXPORT(int)
1157delay_output(int ms GCC_UNUSED)
1158{
1159    return OK;
1160}
1161
1162static char tname[PATH_MAX];
1163
1164static void
1165load_term(void)
1166{
1167    (void) setupterm(tname, STDOUT_FILENO, NULL);
1168}
1169
1170static int
1171roll(int n)
1172{
1173    int i, j;
1174
1175    i = (RAND_MAX / n) * n;
1176    while ((j = rand()) >= i)
1177	continue;
1178    return (j % n);
1179}
1180
1181int
1182main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
1183{
1184    strcpy(tname, getenv("TERM"));
1185    load_term();
1186    _nc_setupscreen(lines, columns, stdout, FALSE, 0);
1187    baudrate();
1188
1189    _nc_mvcur_init();
1190    NC_BUFFERED(FALSE);
1191
1192    (void) puts("The mvcur tester.  Type ? for help");
1193
1194    fputs("smcup:", stdout);
1195    putchar('\n');
1196
1197    for (;;) {
1198	int fy, fx, ty, tx, n, i;
1199	char buf[BUFSIZ], capname[BUFSIZ];
1200
1201	(void) fputs("> ", stdout);
1202	(void) fgets(buf, sizeof(buf), stdin);
1203
1204	if (buf[0] == '?') {
1205	    (void) puts("?                -- display this help message");
1206	    (void)
1207		puts("fy fx ty tx      -- (4 numbers) display (fy,fx)->(ty,tx) move");
1208	    (void) puts("s[croll] n t b m -- display scrolling sequence");
1209	    (void)
1210		printf("r[eload]         -- reload terminal info for %s\n",
1211		       termname());
1212	    (void)
1213		puts("l[oad] <term>    -- load terminal info for type <term>");
1214	    (void) puts("d[elete] <cap>   -- delete named capability");
1215	    (void) puts("i[nspect]        -- display terminal capabilities");
1216	    (void)
1217		puts("c[ost]           -- dump cursor-optimization cost table");
1218	    (void) puts("o[optimize]      -- toggle movement optimization");
1219	    (void)
1220		puts("t[orture] <num>  -- torture-test with <num> random moves");
1221	    (void) puts("q[uit]           -- quit the program");
1222	} else if (sscanf(buf, "%d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1223	    struct timeval before, after;
1224
1225	    putchar('"');
1226
1227	    gettimeofday(&before, NULL);
1228	    mvcur(fy, fx, ty, tx);
1229	    gettimeofday(&after, NULL);
1230
1231	    printf("\" (%ld msec)\n",
1232		   (long) (after.tv_usec - before.tv_usec
1233			   + (after.tv_sec - before.tv_sec)
1234			   * 1000000));
1235	} else if (sscanf(buf, "s %d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
1236	    struct timeval before, after;
1237
1238	    putchar('"');
1239
1240	    gettimeofday(&before, NULL);
1241	    _nc_scrolln(fy, fx, ty, tx);
1242	    gettimeofday(&after, NULL);
1243
1244	    printf("\" (%ld msec)\n",
1245		   (long) (after.tv_usec - before.tv_usec + (after.tv_sec -
1246							     before.tv_sec)
1247			   * 1000000));
1248	} else if (buf[0] == 'r') {
1249	    (void) strcpy(tname, termname());
1250	    load_term();
1251	} else if (sscanf(buf, "l %s", tname) == 1) {
1252	    load_term();
1253	} else if (sscanf(buf, "d %s", capname) == 1) {
1254	    struct name_table_entry const *np = _nc_find_entry(capname,
1255							       _nc_get_hash_table(FALSE));
1256
1257	    if (np == NULL)
1258		(void) printf("No such capability as \"%s\"\n", capname);
1259	    else {
1260		switch (np->nte_type) {
1261		case BOOLEAN:
1262		    cur_term->type.Booleans[np->nte_index] = FALSE;
1263		    (void)
1264			printf("Boolean capability `%s' (%d) turned off.\n",
1265			       np->nte_name, np->nte_index);
1266		    break;
1267
1268		case NUMBER:
1269		    cur_term->type.Numbers[np->nte_index] = ABSENT_NUMERIC;
1270		    (void) printf("Number capability `%s' (%d) set to -1.\n",
1271				  np->nte_name, np->nte_index);
1272		    break;
1273
1274		case STRING:
1275		    cur_term->type.Strings[np->nte_index] = ABSENT_STRING;
1276		    (void) printf("String capability `%s' (%d) deleted.\n",
1277				  np->nte_name, np->nte_index);
1278		    break;
1279		}
1280	    }
1281	} else if (buf[0] == 'i') {
1282	    dump_init((char *) NULL, F_TERMINFO, S_TERMINFO, 70, 0, FALSE);
1283	    dump_entry(&cur_term->type, FALSE, TRUE, 0, 0);
1284	    putchar('\n');
1285	} else if (buf[0] == 'o') {
1286	    if (_nc_optimize_enable & OPTIMIZE_MVCUR) {
1287		_nc_optimize_enable &= ~OPTIMIZE_MVCUR;
1288		(void) puts("Optimization is now off.");
1289	    } else {
1290		_nc_optimize_enable |= OPTIMIZE_MVCUR;
1291		(void) puts("Optimization is now on.");
1292	    }
1293	}
1294	/*
1295	 * You can use the `t' test to profile and tune the movement
1296	 * optimizer.  Use iteration values in three digits or more.
1297	 * At above 5000 iterations the profile timing averages are stable
1298	 * to within a millisecond or three.
1299	 *
1300	 * The `overhead' field of the report will help you pick a
1301	 * COMPUTE_OVERHEAD figure appropriate for your processor and
1302	 * expected line speed.  The `total estimated time' is
1303	 * computation time plus a character-transmission time
1304	 * estimate computed from the number of transmits and the baud
1305	 * rate.
1306	 *
1307	 * Use this together with the `o' command to get a read on the
1308	 * optimizer's effectiveness.  Compare the total estimated times
1309	 * for `t' runs of the same length in both optimized and un-optimized
1310	 * modes.  As long as the optimized times are less, the optimizer
1311	 * is winning.
1312	 */
1313	else if (sscanf(buf, "t %d", &n) == 1) {
1314	    float cumtime = 0.0, perchar;
1315	    int speeds[] =
1316	    {2400, 9600, 14400, 19200, 28800, 38400, 0};
1317
1318	    srand((unsigned) (getpid() + time((time_t *) 0)));
1319	    profiling = TRUE;
1320	    xmits = 0;
1321	    for (i = 0; i < n; i++) {
1322		/*
1323		 * This does a move test between two random locations,
1324		 * Random moves probably short-change the optimizer,
1325		 * which will work better on the short moves probably
1326		 * typical of doupdate()'s usage pattern.  Still,
1327		 * until we have better data...
1328		 */
1329#ifdef FIND_COREDUMP
1330		int from_y = roll(lines);
1331		int to_y = roll(lines);
1332		int from_x = roll(columns);
1333		int to_x = roll(columns);
1334
1335		printf("(%d,%d) -> (%d,%d)\n", from_y, from_x, to_y, to_x);
1336		mvcur(from_y, from_x, to_y, to_x);
1337#else
1338		mvcur(roll(lines), roll(columns), roll(lines), roll(columns));
1339#endif /* FIND_COREDUMP */
1340		if (diff)
1341		    cumtime += diff;
1342	    }
1343	    profiling = FALSE;
1344
1345	    /*
1346	     * Average milliseconds per character optimization time.
1347	     * This is the key figure to watch when tuning the optimizer.
1348	     */
1349	    perchar = cumtime / n;
1350
1351	    (void) printf("%d moves (%ld chars) in %d msec, %f msec each:\n",
1352			  n, xmits, (int) cumtime, perchar);
1353
1354	    for (i = 0; speeds[i]; i++) {
1355		/*
1356		 * Total estimated time for the moves, computation and
1357		 * transmission both. Transmission time is an estimate
1358		 * assuming 9 bits/char, 8 bits + 1 stop bit.
1359		 */
1360		float totalest = cumtime + xmits * 9 * 1e6 / speeds[i];
1361
1362		/*
1363		 * Per-character optimization overhead in character transmits
1364		 * at the current speed.  Round this to the nearest integer
1365		 * to figure COMPUTE_OVERHEAD for the speed.
1366		 */
1367		float overhead = speeds[i] * perchar / 1e6;
1368
1369		(void)
1370		    printf("%6d bps: %3.2f char-xmits overhead; total estimated time %15.2f\n",
1371			   speeds[i], overhead, totalest);
1372	    }
1373	} else if (buf[0] == 'c') {
1374	    (void) printf("char padding: %d\n", CURRENT_SCREEN->_char_padding);
1375	    (void) printf("cr cost: %d\n", CURRENT_SCREEN->_cr_cost);
1376	    (void) printf("cup cost: %d\n", CURRENT_SCREEN->_cup_cost);
1377	    (void) printf("home cost: %d\n", CURRENT_SCREEN->_home_cost);
1378	    (void) printf("ll cost: %d\n", CURRENT_SCREEN->_ll_cost);
1379#if USE_HARD_TABS
1380	    (void) printf("ht cost: %d\n", CURRENT_SCREEN->_ht_cost);
1381	    (void) printf("cbt cost: %d\n", CURRENT_SCREEN->_cbt_cost);
1382#endif /* USE_HARD_TABS */
1383	    (void) printf("cub1 cost: %d\n", CURRENT_SCREEN->_cub1_cost);
1384	    (void) printf("cuf1 cost: %d\n", CURRENT_SCREEN->_cuf1_cost);
1385	    (void) printf("cud1 cost: %d\n", CURRENT_SCREEN->_cud1_cost);
1386	    (void) printf("cuu1 cost: %d\n", CURRENT_SCREEN->_cuu1_cost);
1387	    (void) printf("cub cost: %d\n", CURRENT_SCREEN->_cub_cost);
1388	    (void) printf("cuf cost: %d\n", CURRENT_SCREEN->_cuf_cost);
1389	    (void) printf("cud cost: %d\n", CURRENT_SCREEN->_cud_cost);
1390	    (void) printf("cuu cost: %d\n", CURRENT_SCREEN->_cuu_cost);
1391	    (void) printf("hpa cost: %d\n", CURRENT_SCREEN->_hpa_cost);
1392	    (void) printf("vpa cost: %d\n", CURRENT_SCREEN->_vpa_cost);
1393	} else if (buf[0] == 'x' || buf[0] == 'q')
1394	    break;
1395	else
1396	    (void) puts("Invalid command.");
1397    }
1398
1399    (void) fputs("rmcup:", stdout);
1400    _nc_mvcur_wrap();
1401    putchar('\n');
1402
1403    return (0);
1404}
1405
1406#endif /* MAIN */
1407
1408/* lib_mvcur.c ends here */
1409