]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - progs/tabs.c
ncurses 6.2 - patch 20211009
[ncurses.git] / progs / tabs.c
index 0539e85653ea5985f3a4440d83eb1a0e529a24fa..02de31c6b1244105b7d5c0c5c9f7d8bf8cf18927 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
 /****************************************************************************
- * Copyright 2020 Thomas E. Dickey                                          *
+ * Copyright 2020,2021 Thomas E. Dickey                                     *
  * Copyright 2008-2016,2017 Free Software Foundation, Inc.                  *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * Copyright 2008-2016,2017 Free Software Foundation, Inc.                  *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -39,9 +39,9 @@
 #include <progs.priv.h>
 #include <tty_settings.h>
 
 #include <progs.priv.h>
 #include <tty_settings.h>
 
-MODULE_ID("$Id: tabs.c,v 1.45 2020/05/27 23:47:22 tom Exp $")
+MODULE_ID("$Id: tabs.c,v 1.50 2021/10/10 00:54:41 tom Exp $")
 
 
-static void usage(void) GCC_NORETURN;
+static GCC_NORETURN void usage(void);
 
 const char *_nc_progname;
 static int max_cols;
 
 const char *_nc_progname;
 static int max_cols;
@@ -59,14 +59,44 @@ putch(int c)
     return putchar(c);
 }
 
     return putchar(c);
 }
 
+static char *
+skip_csi(char *value)
+{
+    if (UChar(*value) == 0x9b)
+       ++value;
+    else if (!strncmp(value, "\033[", 2))
+       value += 2;
+    return value;
+}
+
+/*
+ * If the terminal uses ANSI clear_all_tabs, then it is not necessary to first
+ * move to the left margin before clearing tabs.
+ */
+static bool
+ansi_clear_tabs(void)
+{
+    bool result = FALSE;
+    if (VALID_STRING(clear_all_tabs)) {
+       char *param = skip_csi(clear_all_tabs);
+       if (!strcmp(param, "3g"))
+           result = TRUE;
+    }
+    return result;
+}
+
 static void
 do_tabs(int *tab_list)
 {
     int last = 1;
     int stop;
 static void
 do_tabs(int *tab_list)
 {
     int last = 1;
     int stop;
+    bool first = TRUE;
 
 
-    putchar('\r');
     while ((stop = *tab_list++) > 0) {
     while ((stop = *tab_list++) > 0) {
+       if (first) {
+           first = FALSE;
+           putchar('\r');
+       }
        if (last < stop) {
            while (last++ < stop) {
                if (last > max_cols)
        if (last < stop) {
            while (last++ < stop) {
                if (last > max_cols)
@@ -75,7 +105,7 @@ do_tabs(int *tab_list)
            }
        }
        if (stop <= max_cols) {
            }
        }
        if (stop <= max_cols) {
-           tputs(TIPARM_1(set_tab, stop), 1, putch);
+           tputs(set_tab, 1, putch);
            last = stop;
        } else {
            break;
            last = stop;
        } else {
            break;
@@ -84,8 +114,13 @@ do_tabs(int *tab_list)
     putchar('\r');
 }
 
     putchar('\r');
 }
 
+/*
+ * Decode a list of tab-stops from a string, returning an array of integers.
+ * If the margin is positive (because the terminal does not support margins),
+ * work around this by adding the margin to the decoded values.
+ */
 static int *
 static int *
-decode_tabs(const char *tab_list)
+decode_tabs(const char *tab_list, int margin)
 {
     int *result = typeCalloc(int, strlen(tab_list) + (unsigned) max_cols);
     int n = 0;
 {
     int *result = typeCalloc(int, strlen(tab_list) + (unsigned) max_cols);
     int n = 0;
@@ -96,12 +131,15 @@ decode_tabs(const char *tab_list)
     if (result == 0)
        failed("decode_tabs");
 
     if (result == 0)
        failed("decode_tabs");
 
+    if (margin < 0)
+       margin = 0;
+
     while ((ch = *tab_list++) != '\0') {
        if (isdigit(UChar(ch))) {
            value *= 10;
            value += (ch - '0');
        } else if (ch == ',') {
     while ((ch = *tab_list++) != '\0') {
        if (isdigit(UChar(ch))) {
            value *= 10;
            value += (ch - '0');
        } else if (ch == ',') {
-           result[n] = value + prior;
+           result[n] = value + prior + margin;
            if (n > 0 && result[n] <= result[n - 1]) {
                fprintf(stderr,
                        "%s: tab-stops are not in increasing order: %d %d\n",
            if (n > 0 && result[n] <= result[n - 1]) {
                fprintf(stderr,
                        "%s: tab-stops are not in increasing order: %d %d\n",
@@ -127,7 +165,7 @@ decode_tabs(const char *tab_list)
            int step = value;
            value = 1;
            while (n < max_cols - 1) {
            int step = value;
            value = 1;
            while (n < max_cols - 1) {
-               result[n++] = value;
+               result[n++] = value + margin;
                value += step;
            }
        }
                value += step;
            }
        }
@@ -135,7 +173,7 @@ decode_tabs(const char *tab_list)
        /*
         * Add the last value, if any.
         */
        /*
         * Add the last value, if any.
         */
-       result[n++] = value + prior;
+       result[n++] = value + prior + margin;
        result[n] = 0;
     }
 
        result[n] = 0;
     }
 
@@ -143,10 +181,9 @@ decode_tabs(const char *tab_list)
 }
 
 static void
 }
 
 static void
-print_ruler(int *tab_list)
+print_ruler(int *tab_list, const char *new_line)
 {
     int last = 0;
 {
     int last = 0;
-    int stop;
     int n;
 
     /* first print a readable ruler */
     int n;
 
     /* first print a readable ruler */
@@ -160,11 +197,12 @@ print_ruler(int *tab_list)
                     : (ch + 'A' - 10)));
        printf("%.*s", ((max_cols - n) > 10) ? 10 : (max_cols - n), buffer);
     }
                     : (ch + 'A' - 10)));
        printf("%.*s", ((max_cols - n) > 10) ? 10 : (max_cols - n), buffer);
     }
-    putchar('\n');
+    printf("%s", new_line);
 
     /* now, print '*' for each stop */
     for (n = 0, last = 0; (tab_list[n] > 0) && (last < max_cols); ++n) {
 
     /* now, print '*' for each stop */
     for (n = 0, last = 0; (tab_list[n] > 0) && (last < max_cols); ++n) {
-       stop = tab_list[n];
+       int stop = tab_list[n];
+
        while (++last < stop) {
            if (last <= max_cols) {
                putchar('-');
        while (++last < stop) {
            if (last <= max_cols) {
                putchar('-');
@@ -181,7 +219,7 @@ print_ruler(int *tab_list)
     }
     while (++last <= max_cols)
        putchar('-');
     }
     while (++last <= max_cols)
        putchar('-');
-    putchar('\n');
+    printf("%s", new_line);
 }
 
 /*
 }
 
 /*
@@ -189,7 +227,7 @@ print_ruler(int *tab_list)
  * ruler.
  */
 static void
  * ruler.
  */
 static void
-write_tabs(int *tab_list)
+write_tabs(int *tab_list, const char *new_line)
 {
     int stop;
 
 {
     int stop;
 
@@ -199,7 +237,7 @@ write_tabs(int *tab_list)
     /* also show a tab _past_ the stops */
     if (stop < max_cols)
        fputs("\t+", stdout);
     /* also show a tab _past_ the stops */
     if (stop < max_cols)
        fputs("\t+", stdout);
-    putchar('\n');
+    fputs(new_line, stdout);
 }
 
 /*
 }
 
 /*
@@ -210,11 +248,11 @@ static char *
 trimmed_tab_list(const char *source)
 {
     char *result = strdup(source);
 trimmed_tab_list(const char *source)
 {
     char *result = strdup(source);
-    int ch, j, k, last;
-
     if (result != 0) {
     if (result != 0) {
+       int j, k, last;
+
        for (j = k = last = 0; result[j] != 0; ++j) {
        for (j = k = last = 0; result[j] != 0; ++j) {
-           ch = UChar(result[j]);
+           int ch = UChar(result[j]);
            if (isspace(ch)) {
                if (last == '\0') {
                    continue;
            if (isspace(ch)) {
                if (last == '\0') {
                    continue;
@@ -294,6 +332,60 @@ add_to_tab_list(char **append, const char *value)
     return result;
 }
 
     return result;
 }
 
+/*
+ * If the terminal supports it, (re)set the left margin and return true.
+ * Otherwise, return false.
+ */
+static bool
+do_set_margin(int margin, bool no_op)
+{
+    bool result = FALSE;
+
+    if (margin == 0) {         /* 0 is special case for resetting */
+       if (VALID_STRING(clear_margins)) {
+           result = TRUE;
+           if (!no_op)
+               tputs(clear_margins, 1, putch);
+       }
+    } else if (margin-- < 0) { /* margin will be 0-based from here on */
+       result = TRUE;
+    } else if (VALID_STRING(set_left_margin)) {
+       result = TRUE;
+       if (!no_op) {
+           /*
+            * assuming we're on the first column of the line, move the cursor
+            * to the column at which we will set a margin.
+            */
+           if (VALID_STRING(column_address)) {
+               tputs(TIPARM_1(column_address, margin), 1, putch);
+           } else if (margin >= 1) {
+               if (VALID_STRING(parm_right_cursor)) {
+                   tputs(TIPARM_1(parm_right_cursor, margin), 1, putch);
+               } else {
+                   while (margin-- > 0)
+                       putch(' ');
+               }
+           }
+           tputs(set_left_margin, 1, putch);
+       }
+    } else if (VALID_STRING(set_left_margin_parm)) {
+       result = TRUE;
+       if (!no_op) {
+           if (VALID_STRING(set_right_margin_parm)) {
+               tputs(TIPARM_1(set_left_margin_parm, margin), 1, putch);
+           } else {
+               tputs(TIPARM_2(set_left_margin_parm, margin, max_cols), 1, putch);
+           }
+       }
+    } else if (VALID_STRING(set_lr_margin)) {
+       result = TRUE;
+       if (!no_op) {
+           tputs(TIPARM_2(set_lr_margin, margin, max_cols), 1, putch);
+       }
+    }
+    return result;
+}
+
 /*
  * Check for illegal characters in the tab-list.
  */
 /*
  * Check for illegal characters in the tab-list.
  */
@@ -304,9 +396,11 @@ legal_tab_list(const char *tab_list)
 
     if (tab_list != 0 && *tab_list != '\0') {
        if (comma_is_needed(tab_list)) {
 
     if (tab_list != 0 && *tab_list != '\0') {
        if (comma_is_needed(tab_list)) {
-           int n, ch;
+           int n;
+
            for (n = 0; tab_list[n] != '\0'; ++n) {
            for (n = 0; tab_list[n] != '\0'; ++n) {
-               ch = UChar(tab_list[n]);
+               int ch = UChar(tab_list[n]);
+
                if (!(isdigit(ch) || ch == ',' || ch == '+')) {
                    fprintf(stderr,
                            "%s: unexpected character found '%c'\n",
                if (!(isdigit(ch) || ch == ',' || ch == '+')) {
                    fprintf(stderr,
                            "%s: unexpected character found '%c'\n",
@@ -320,8 +414,7 @@ legal_tab_list(const char *tab_list)
            result = FALSE;
        }
     } else {
            result = FALSE;
        }
     } else {
-       fprintf(stderr, "%s: no tab-list given\n", _nc_progname);
-       result = FALSE;
+       /* if no list given, default to "tabs -8" */
     }
     return result;
 }
     }
     return result;
 }
@@ -379,17 +472,18 @@ main(int argc, char *argv[])
     int rc = EXIT_FAILURE;
     bool debug = FALSE;
     bool no_op = FALSE;
     int rc = EXIT_FAILURE;
     bool debug = FALSE;
     bool no_op = FALSE;
+    bool change_tty = FALSE;
     int n, ch;
     NCURSES_CONST char *term_name = 0;
     char *append = 0;
     const char *tab_list = 0;
     int n, ch;
     NCURSES_CONST char *term_name = 0;
     char *append = 0;
     const char *tab_list = 0;
+    const char *new_line = "\n";
+    int margin = -1;
     TTY tty_settings;
     int fd;
 
     _nc_progname = _nc_rootname(argv[0]);
 
     TTY tty_settings;
     int fd;
 
     _nc_progname = _nc_rootname(argv[0]);
 
-    fd = save_tty_settings(&tty_settings, FALSE);
-
     if ((term_name = getenv("TERM")) == 0)
        term_name = "ansi+tabs";
 
     if ((term_name = getenv("TERM")) == 0)
        term_name = "ansi+tabs";
 
@@ -481,7 +575,10 @@ main(int argc, char *argv[])
            }
            break;
        case '+':
            }
            break;
        case '+':
-           while ((ch = *++option) != '\0') {
+           if ((ch = *++option) != '\0') {
+               int digits = 0;
+               int number = 0;
+
                switch (ch) {
                case 'm':
                    /*
                switch (ch) {
                case 'm':
                    /*
@@ -489,6 +586,17 @@ main(int argc, char *argv[])
                     * att510d implements smgl, which is needed to support
                     * this option.
                     */
                     * att510d implements smgl, which is needed to support
                     * this option.
                     */
+                   while ((ch = *++option) != '\0') {
+                       if (isdigit(UChar(ch))) {
+                           ++digits;
+                           number = number * 10 + (ch - '0');
+                       } else {
+                           usage();
+                       }
+                   }
+                   if (digits == 0)
+                       number = 10;
+                   margin = number;
                    break;
                default:
                    /* special case of relative stops separated by spaces? */
                    break;
                default:
                    /* special case of relative stops separated by spaces? */
@@ -512,9 +620,13 @@ main(int argc, char *argv[])
        }
     }
 
        }
     }
 
+    fd = save_tty_settings(&tty_settings, FALSE);
+
     setupterm(term_name, fd, (int *) 0);
 
     max_cols = (columns > 0) ? columns : 80;
     setupterm(term_name, fd, (int *) 0);
 
     max_cols = (columns > 0) ? columns : 80;
+    if (margin > 0)
+       max_cols -= margin;
 
     if (!VALID_STRING(clear_all_tabs)) {
        fprintf(stderr,
 
     if (!VALID_STRING(clear_all_tabs)) {
        fprintf(stderr,
@@ -525,24 +637,61 @@ main(int argc, char *argv[])
                "%s: terminal type '%s' cannot set tabs\n",
                _nc_progname, term_name);
     } else if (legal_tab_list(tab_list)) {
                "%s: terminal type '%s' cannot set tabs\n",
                _nc_progname, term_name);
     } else if (legal_tab_list(tab_list)) {
-       int *list = decode_tabs(tab_list);
+       int *list;
+
+       if (tab_list == NULL)
+           tab_list = add_to_tab_list(&append, "8");
+
+       if (!no_op) {
+#if defined(TERMIOS) && defined(OCRNL)
+           /* set tty modes to -ocrnl to allow \r */
+           if (isatty(STDOUT_FILENO)) {
+               TTY new_settings = tty_settings;
+               new_settings.c_oflag &= (unsigned)~OCRNL;
+               update_tty_settings(&tty_settings, &new_settings);
+               change_tty = TRUE;
+               new_line = "\r\n";
+           }
+#endif
 
 
-       if (!no_op)
+           if (!ansi_clear_tabs())
+               putch('\r');
            tputs(clear_all_tabs, 1, putch);
            tputs(clear_all_tabs, 1, putch);
+       }
+
+       if (margin >= 0) {
+           putch('\r');
+           if (margin > 0) {
+               /* reset existing margin before setting margin, to reduce
+                * problems moving left of the current margin.
+                */
+               if (do_set_margin(0, no_op))
+                   putch('\r');
+           }
+           if (do_set_margin(margin, no_op))
+               margin = -1;
+       }
+
+       list = decode_tabs(tab_list, margin);
 
        if (list != 0) {
            if (!no_op)
                do_tabs(list);
            if (debug) {
                fflush(stderr);
 
        if (list != 0) {
            if (!no_op)
                do_tabs(list);
            if (debug) {
                fflush(stderr);
-               printf("tabs %s\n", tab_list);
-               print_ruler(list);
-               write_tabs(list);
+               printf("tabs %s%s", tab_list, new_line);
+               print_ruler(list, new_line);
+               write_tabs(list, new_line);
            }
            free(list);
        } else if (debug) {
            fflush(stderr);
            }
            free(list);
        } else if (debug) {
            fflush(stderr);
-           printf("tabs %s\n", tab_list);
+           printf("tabs %s%s", tab_list, new_line);
+       }
+       if (!no_op) {
+           if (change_tty) {
+               restore_tty_settings();
+           }
        }
        rc = EXIT_SUCCESS;
     }
        }
        rc = EXIT_SUCCESS;
     }