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