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