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