ncurses 6.1 - patch 20190914
[ncurses.git] / ncurses / tty / lib_mvcur.c
index ad41f8dd72d8e8a5a05be1a0f895f38db466fd50..c4847c720589edb685e200a4749bf48367de79ac 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 #define CUR SP_TERMTYPE
 #endif
 
-MODULE_ID("$Id: lib_mvcur.c,v 1.126 2011/01/22 19:48:21 tom Exp $")
+MODULE_ID("$Id: lib_mvcur.c,v 1.150 2019/06/01 23:42:09 tom Exp $")
 
 #define WANT_CHAR(sp, y, x) NewScreen(sp)->_line[y].text[x]    /* desired state */
 
@@ -176,6 +176,9 @@ static bool profiling = FALSE;
 static float diff;
 #endif /* MAIN */
 
+#undef NCURSES_OUTC_FUNC
+#define NCURSES_OUTC_FUNC myOutCh
+
 #define OPT_SIZE 512
 
 static int normalized_cost(NCURSES_SP_DCLx const char *const cap, int affcnt);
@@ -274,10 +277,9 @@ reset_scroll_region(NCURSES_SP_DCL0)
 /* Set the scroll-region to a known state (the default) */
 {
     if (change_scroll_region) {
-       NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
-                                  "change_scroll_region",
-                                  TPARM_2(change_scroll_region,
-                                          0, screen_lines(SP_PARM) - 1));
+       NCURSES_PUTP2("change_scroll_region",
+                     TPARM_2(change_scroll_region,
+                             0, screen_lines(SP_PARM) - 1));
     }
 }
 
@@ -285,14 +287,12 @@ NCURSES_EXPORT(void)
 NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_DCL0)
 /* what to do at initialization time and after each shellout */
 {
-    if (SP_PARM && !IsTermInfo(SP_PARM))
+    if (!SP_PARM || !IsTermInfo(SP_PARM))
        return;
 
     /* initialize screen for cursor access */
     if (enter_ca_mode) {
-       NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
-                                  "enter_ca_mode",
-                                  enter_ca_mode);
+       NCURSES_PUTP2("enter_ca_mode", enter_ca_mode);
     }
 
     /*
@@ -327,13 +327,14 @@ NCURSES_EXPORT(void)
 NCURSES_SP_NAME(_nc_mvcur_init) (NCURSES_SP_DCL0)
 /* initialize the cost structure */
 {
-    if (SP_PARM->_ofp && isatty(fileno(SP_PARM->_ofp)))
+    if (SP_PARM->_ofp && NC_ISATTY(fileno(SP_PARM->_ofp))) {
        SP_PARM->_char_padding = ((BAUDBYTE * 1000 * 10)
                                  / (BAUDRATE(SP_PARM) > 0
                                     ? BAUDRATE(SP_PARM)
                                     : 9600));
-    else
+    } else {
        SP_PARM->_char_padding = 1;     /* must be nonzero */
+    }
     if (SP_PARM->_char_padding <= 0)
        SP_PARM->_char_padding = 1;     /* must be nonzero */
     TR(TRACE_CHARPUT | TRACE_MOVE, ("char_padding %d msecs", SP_PARM->_char_padding));
@@ -343,7 +344,9 @@ NCURSES_SP_NAME(_nc_mvcur_init) (NCURSES_SP_DCL0)
     SP_PARM->_home_cost = CostOf(cursor_home, 0);
     SP_PARM->_ll_cost = CostOf(cursor_to_ll, 0);
 #if USE_HARD_TABS
-    if (getenv("NCURSES_NO_HARD_TABS") == 0) {
+    if (getenv("NCURSES_NO_HARD_TABS") == 0
+       && dest_tabs_magic_smso == 0
+       && HasHardTabs()) {
        SP_PARM->_ht_cost = CostOf(tab, 0);
        SP_PARM->_cbt_cost = CostOf(back_tab, 0);
     } else {
@@ -449,8 +452,8 @@ NCURSES_SP_NAME(_nc_mvcur_init) (NCURSES_SP_DCL0)
 
     /*
      * A different, possibly better way to arrange this would be to set the
-     * SCREEN's _endwin to TRUE at window initialization time and let this be
-     * called by doupdate's return-from-shellout code.
+     * SCREEN's _endwin at window initialization time and let this be called by
+     * doupdate's return-from-shellout code.
      */
     NCURSES_SP_NAME(_nc_mvcur_resume) (NCURSES_SP_ARG);
 }
@@ -481,9 +484,7 @@ NCURSES_SP_NAME(_nc_mvcur_wrap) (NCURSES_SP_DCL0)
     }
 
     if (exit_ca_mode) {
-       NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
-                                  "exit_ca_mode",
-                                  exit_ca_mode);
+       NCURSES_PUTP2("exit_ca_mode", exit_ca_mode);
     }
     /*
      * Reset terminal's tab counter.  There's a long-time bug that
@@ -549,7 +550,7 @@ relative_move(NCURSES_SP_DCLx
              int from_x,
              int to_y,
              int to_x,
-             bool ovw)
+             int ovw)
 /* move via local motions (cuu/cuu1/cud/cud1/cub1/cub/cuf1/cuf/vpa/hpa) */
 {
     string_desc save;
@@ -770,7 +771,10 @@ relative_move(NCURSES_SP_DCLx
  */
 
 static NCURSES_INLINE int
-onscreen_mvcur(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew, bool ovw)
+onscreen_mvcur(NCURSES_SP_DCLx
+              int yold, int xold,
+              int ynew, int xnew, int ovw,
+              NCURSES_SP_OUTC myOutCh)
 /* onscreen move from (yold, xold) to (ynew, xnew) */
 {
     string_desc result;
@@ -933,9 +937,10 @@ onscreen_mvcur(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew, bool ovw)
 #endif /* MAIN */
 
     if (usecost != INFINITY) {
+       TR(TRACE_MOVE, ("mvcur tactic %d", tactic));
        TPUTS_TRACE("mvcur");
        NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
-                               buffer, 1, NCURSES_SP_NAME(_nc_outch));
+                               buffer, 1, myOutCh);
        SP_PARM->_cursrow = ynew;
        SP_PARM->_curscol = xnew;
        return (OK);
@@ -943,9 +948,15 @@ onscreen_mvcur(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew, bool ovw)
        return (ERR);
 }
 
-NCURSES_EXPORT(int)
-TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
-/* optimized cursor move from (yold, xold) to (ynew, xnew) */
+/*
+ * optimized cursor move from (yold, xold) to (ynew, xnew)
+ */
+static int
+_nc_real_mvcur(NCURSES_SP_DCLx
+              int yold, int xold,
+              int ynew, int xnew,
+              NCURSES_SP_OUTC myOutCh,
+              int ovw)
 {
     NCURSES_CH_T oldattr;
     int code;
@@ -980,34 +991,32 @@ TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
            TR(TRACE_CHARPUT, ("turning off (%#lx) %s before move",
                               (unsigned long) AttrOf(oldattr),
                               _traceattr(AttrOf(oldattr))));
-           (void) VIDATTR(SP_PARM, A_NORMAL, 0);
+           VIDPUTS(SP_PARM, A_NORMAL, 0);
        }
 
        if (xold >= screen_columns(SP_PARM)) {
-           int l;
 
            if (SP_PARM->_nl) {
-               l = (xold + 1) / screen_columns(SP_PARM);
+               int l = (xold + 1) / screen_columns(SP_PARM);
+
                yold += l;
                if (yold >= screen_lines(SP_PARM))
                    l -= (yold - screen_lines(SP_PARM) - 1);
 
                if (l > 0) {
                    if (carriage_return) {
-                       NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
-                                                  "carriage_return",
-                                                  carriage_return);
-                   } else
-                       NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_ARGx '\r');
+                       NCURSES_PUTP2("carriage_return", carriage_return);
+                   } else {
+                       myOutCh(NCURSES_SP_ARGx '\r');
+                   }
                    xold = 0;
 
                    while (l > 0) {
                        if (newline) {
-                           NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
-                                                      "newline",
-                                                      newline);
-                       } else
-                           NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_ARGx '\n');
+                           NCURSES_PUTP2("newline", newline);
+                       } else {
+                           myOutCh(NCURSES_SP_ARGx '\n');
+                       }
                        l--;
                    }
                }
@@ -1027,7 +1036,7 @@ TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
            ynew = screen_lines(SP_PARM) - 1;
 
        /* destination location is on screen now */
-       code = onscreen_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew, TRUE);
+       code = onscreen_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew, ovw, myOutCh);
 
        /*
         * Restore attributes if we disabled them before moving.
@@ -1036,19 +1045,86 @@ TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
            TR(TRACE_CHARPUT, ("turning on (%#lx) %s after move",
                               (unsigned long) AttrOf(oldattr),
                               _traceattr(AttrOf(oldattr))));
-           (void) VIDATTR(SP_PARM, AttrOf(oldattr), GetPair(oldattr));
+           VIDPUTS(SP_PARM, AttrOf(oldattr), GetPair(oldattr));
        }
     }
     returnCode(code);
 }
 
-#if NCURSES_SP_FUNCS && !defined(USE_TERM_DRIVER)
+/*
+ * These entrypoints are used within the library.
+ */
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(_nc_mvcur) (NCURSES_SP_DCLx
+                           int yold, int xold,
+                           int ynew, int xnew)
+{
+    int rc;
+    rc = _nc_real_mvcur(NCURSES_SP_ARGx yold, xold, ynew, xnew,
+                       NCURSES_SP_NAME(_nc_outch),
+                       TRUE);
+    /*
+     * With the terminal-driver, we cannot distinguish between internal and
+     * external calls.  Flush the output if the screen has not been
+     * initialized, e.g., when used from low-level terminfo programs.
+     */
+    if ((SP_PARM != 0) && (SP_PARM->_endwin == ewInitial))
+       NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
+    return rc;
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+_nc_mvcur(int yold, int xold,
+         int ynew, int xnew)
+{
+    return NCURSES_SP_NAME(_nc_mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
+}
+#endif
+
+#if defined(USE_TERM_DRIVER)
+/*
+ * The terminal driver does not support the external "mvcur()".
+ */
+NCURSES_EXPORT(int)
+TINFO_MVCUR(NCURSES_SP_DCLx int yold, int xold, int ynew, int xnew)
+{
+    int rc;
+    rc = _nc_real_mvcur(NCURSES_SP_ARGx
+                       yold, xold,
+                       ynew, xnew,
+                       NCURSES_SP_NAME(_nc_outch),
+                       TRUE);
+    if ((SP_PARM != 0) && (SP_PARM->_endwin == ewInitial))
+       NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
+    NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
+    return rc;
+}
+
+#else /* !USE_TERM_DRIVER */
+
+/*
+ * These entrypoints support users of the library.
+ */
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(mvcur) (NCURSES_SP_DCLx int yold, int xold, int ynew,
+                       int xnew)
+{
+    return _nc_real_mvcur(NCURSES_SP_ARGx
+                         yold, xold,
+                         ynew, xnew,
+                         NCURSES_SP_NAME(_nc_putchar),
+                         FALSE);
+}
+
+#if NCURSES_SP_FUNCS
 NCURSES_EXPORT(int)
 mvcur(int yold, int xold, int ynew, int xnew)
 {
     return NCURSES_SP_NAME(mvcur) (CURRENT_SCREEN, yold, xold, ynew, xnew);
 }
 #endif
+#endif /* USE_TERM_DRIVER */
 
 #if defined(TRACE) || defined(NCURSES_TEST)
 NCURSES_EXPORT_VAR(int) _nc_optimize_enable = OPTIMIZE_ALL;
@@ -1122,13 +1198,12 @@ roll(int n)
 int
 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
 {
-    strcpy(tname, getenv("TERM"));
+    _nc_STRCPY(tname, getenv("TERM"), sizeof(tname));
     load_term();
     _nc_setupscreen(lines, columns, stdout, FALSE, 0);
     baudrate();
 
     _nc_mvcur_init();
-    NC_BUFFERED(FALSE);
 
     (void) puts("The mvcur tester.  Type ? for help");
 
@@ -1139,27 +1214,26 @@ main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
        int fy, fx, ty, tx, n, i;
        char buf[BUFSIZ], capname[BUFSIZ];
 
-       (void) fputs("> ", stdout);
-       (void) fgets(buf, sizeof(buf), stdin);
+       if (fputs("> ", stdout) == EOF)
+           break;
+       if (fgets(buf, sizeof(buf), stdin) == 0)
+           break;
 
+#define PUTS(s)   (void) puts(s)
+#define PUTF(s,t) (void) printf(s,t)
        if (buf[0] == '?') {
-           (void) puts("?                -- display this help message");
-           (void)
-               puts("fy fx ty tx      -- (4 numbers) display (fy,fx)->(ty,tx) move");
-           (void) puts("s[croll] n t b m -- display scrolling sequence");
-           (void)
-               printf("r[eload]         -- reload terminal info for %s\n",
-                      termname());
-           (void)
-               puts("l[oad] <term>    -- load terminal info for type <term>");
-           (void) puts("d[elete] <cap>   -- delete named capability");
-           (void) puts("i[nspect]        -- display terminal capabilities");
-           (void)
-               puts("c[ost]           -- dump cursor-optimization cost table");
-           (void) puts("o[optimize]      -- toggle movement optimization");
-           (void)
-               puts("t[orture] <num>  -- torture-test with <num> random moves");
-           (void) puts("q[uit]           -- quit the program");
+           PUTS("?                -- display this help message");
+           PUTS("fy fx ty tx      -- (4 numbers) display (fy,fx)->(ty,tx) move");
+           PUTS("s[croll] n t b m -- display scrolling sequence");
+           PUTF("r[eload]         -- reload terminal info for %s\n",
+                termname());
+           PUTS("l[oad] <term>    -- load terminal info for type <term>");
+           PUTS("d[elete] <cap>   -- delete named capability");
+           PUTS("i[nspect]        -- display terminal capabilities");
+           PUTS("c[ost]           -- dump cursor-optimization cost table");
+           PUTS("o[optimize]      -- toggle movement optimization");
+           PUTS("t[orture] <num>  -- torture-test with <num> random moves");
+           PUTS("q[uit]           -- quit the program");
        } else if (sscanf(buf, "%d %d %d %d", &fy, &fx, &ty, &tx) == 4) {
            struct timeval before, after;
 
@@ -1187,7 +1261,7 @@ main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
                                                             before.tv_sec)
                           * 1000000));
        } else if (buf[0] == 'r') {
-           (void) strcpy(tname, termname());
+           _nc_STRCPY(tname, termname(), sizeof(tname));
            load_term();
        } else if (sscanf(buf, "l %s", tname) == 1) {
            load_term();
@@ -1220,8 +1294,9 @@ main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
                }
            }
        } else if (buf[0] == 'i') {
-           dump_init((char *) NULL, F_TERMINFO, S_TERMINFO, 70, 0, FALSE);
-           dump_entry(&cur_term->type, FALSE, TRUE, 0, 0);
+           dump_init(NULL, F_TERMINFO, S_TERMINFO,
+                     FALSE, 70, 0, 0, FALSE, FALSE, 0);
+           dump_entry(&TerminalType(cur_term), FALSE, TRUE, 0, 0);
            putchar('\n');
        } else if (buf[0] == 'o') {
            if (_nc_optimize_enable & OPTIMIZE_MVCUR) {