ncurses 6.2 - patch 20210418
[ncurses.git] / progs / tabs.c
1 /****************************************************************************
2  * Copyright 2020,2021 Thomas E. Dickey                                     *
3  * Copyright 2008-2016,2017 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Thomas E. Dickey                        2008                    *
32  ****************************************************************************/
33
34 /*
35  * tabs.c --  set terminal hard-tabstops
36  */
37
38 #define USE_LIBTINFO
39 #include <progs.priv.h>
40 #include <tty_settings.h>
41
42 MODULE_ID("$Id: tabs.c,v 1.47 2021/04/03 23:00:00 tom Exp $")
43
44 static GCC_NORETURN void usage(void);
45
46 const char *_nc_progname;
47 static int max_cols;
48
49 static void
50 failed(const char *s)
51 {
52     perror(s);
53     ExitProgram(EXIT_FAILURE);
54 }
55
56 static int
57 putch(int c)
58 {
59     return putchar(c);
60 }
61
62 static void
63 do_tabs(int *tab_list)
64 {
65     int last = 1;
66     int stop;
67
68     putchar('\r');
69     while ((stop = *tab_list++) > 0) {
70         if (last < stop) {
71             while (last++ < stop) {
72                 if (last > max_cols)
73                     break;
74                 putchar(' ');
75             }
76         }
77         if (stop <= max_cols) {
78             tputs(TIPARM_1(set_tab, stop), 1, putch);
79             last = stop;
80         } else {
81             break;
82         }
83     }
84     putchar('\r');
85 }
86
87 static int *
88 decode_tabs(const char *tab_list)
89 {
90     int *result = typeCalloc(int, strlen(tab_list) + (unsigned) max_cols);
91     int n = 0;
92     int value = 0;
93     int prior = 0;
94     int ch;
95
96     if (result == 0)
97         failed("decode_tabs");
98
99     while ((ch = *tab_list++) != '\0') {
100         if (isdigit(UChar(ch))) {
101             value *= 10;
102             value += (ch - '0');
103         } else if (ch == ',') {
104             result[n] = value + prior;
105             if (n > 0 && result[n] <= result[n - 1]) {
106                 fprintf(stderr,
107                         "%s: tab-stops are not in increasing order: %d %d\n",
108                         _nc_progname, value, result[n - 1]);
109                 free(result);
110                 result = 0;
111                 break;
112             }
113             ++n;
114             value = 0;
115             prior = 0;
116         } else if (ch == '+') {
117             if (n)
118                 prior = result[n - 1];
119         }
120     }
121
122     if (result != 0) {
123         /*
124          * If there is only one value, then it is an option such as "-8".
125          */
126         if ((n == 0) && (value > 0)) {
127             int step = value;
128             value = 1;
129             while (n < max_cols - 1) {
130                 result[n++] = value;
131                 value += step;
132             }
133         }
134
135         /*
136          * Add the last value, if any.
137          */
138         result[n++] = value + prior;
139         result[n] = 0;
140     }
141
142     return result;
143 }
144
145 static void
146 print_ruler(int *tab_list)
147 {
148     int last = 0;
149     int n;
150
151     /* first print a readable ruler */
152     for (n = 0; n < max_cols; n += 10) {
153         int ch = 1 + (n / 10);
154         char buffer[20];
155         _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer))
156                     "----+----%c",
157                     ((ch < 10)
158                      ? (ch + '0')
159                      : (ch + 'A' - 10)));
160         printf("%.*s", ((max_cols - n) > 10) ? 10 : (max_cols - n), buffer);
161     }
162     putchar('\n');
163
164     /* now, print '*' for each stop */
165     for (n = 0, last = 0; (tab_list[n] > 0) && (last < max_cols); ++n) {
166         int stop = tab_list[n];
167
168         while (++last < stop) {
169             if (last <= max_cols) {
170                 putchar('-');
171             } else {
172                 break;
173             }
174         }
175         if (last <= max_cols) {
176             putchar('*');
177             last = stop;
178         } else {
179             break;
180         }
181     }
182     while (++last <= max_cols)
183         putchar('-');
184     putchar('\n');
185 }
186
187 /*
188  * Write an '*' on each tabstop, to demonstrate whether it lines up with the
189  * ruler.
190  */
191 static void
192 write_tabs(int *tab_list)
193 {
194     int stop;
195
196     while ((stop = *tab_list++) > 0 && stop <= max_cols) {
197         fputs((stop == 1) ? "*" : "\t*", stdout);
198     };
199     /* also show a tab _past_ the stops */
200     if (stop < max_cols)
201         fputs("\t+", stdout);
202     putchar('\n');
203 }
204
205 /*
206  * Trim leading/trailing blanks, as well as blanks after a comma.
207  * Convert embedded blanks to commas.
208  */
209 static char *
210 trimmed_tab_list(const char *source)
211 {
212     char *result = strdup(source);
213     if (result != 0) {
214         int j, k, last;
215
216         for (j = k = last = 0; result[j] != 0; ++j) {
217             int ch = UChar(result[j]);
218             if (isspace(ch)) {
219                 if (last == '\0') {
220                     continue;
221                 } else if (isdigit(last) || last == ',') {
222                     ch = ',';
223                 }
224             } else if (ch == ',') {
225                 ;
226             } else {
227                 if (last == ',')
228                     result[k++] = (char) last;
229                 result[k++] = (char) ch;
230             }
231             last = ch;
232         }
233         result[k] = '\0';
234     }
235     return result;
236 }
237
238 static bool
239 comma_is_needed(const char *source)
240 {
241     bool result = FALSE;
242
243     if (source != 0) {
244         size_t len = strlen(source);
245         if (len != 0)
246             result = (source[len - 1] != ',');
247     } else {
248         result = FALSE;
249     }
250     return result;
251 }
252
253 /*
254  * Add a command-line parameter to the tab-list.  It can be blank- or comma-
255  * separated (or a mixture).  For simplicity, empty tabs are ignored, e.g.,
256  *      tabs 1,,6,11
257  *      tabs 1,6,11
258  * are treated the same.
259  */
260 static const char *
261 add_to_tab_list(char **append, const char *value)
262 {
263     char *result = *append;
264     char *copied = trimmed_tab_list(value);
265
266     if (copied != 0 && *copied != '\0') {
267         const char *comma = ",";
268         size_t need = 1 + strlen(copied);
269
270         if (*copied == ',')
271             comma = "";
272         else if (!comma_is_needed(*append))
273             comma = "";
274
275         need += strlen(comma);
276         if (*append != 0)
277             need += strlen(*append);
278
279         result = malloc(need);
280         if (result == 0)
281             failed("add_to_tab_list");
282
283         *result = '\0';
284         if (*append != 0) {
285             _nc_STRCPY(result, *append, need);
286             free(*append);
287         }
288         _nc_STRCAT(result, comma, need);
289         _nc_STRCAT(result, copied, need);
290
291         *append = result;
292     }
293     free(copied);
294     return result;
295 }
296
297 /*
298  * Check for illegal characters in the tab-list.
299  */
300 static bool
301 legal_tab_list(const char *tab_list)
302 {
303     bool result = TRUE;
304
305     if (tab_list != 0 && *tab_list != '\0') {
306         if (comma_is_needed(tab_list)) {
307             int n;
308
309             for (n = 0; tab_list[n] != '\0'; ++n) {
310                 int ch = UChar(tab_list[n]);
311
312                 if (!(isdigit(ch) || ch == ',' || ch == '+')) {
313                     fprintf(stderr,
314                             "%s: unexpected character found '%c'\n",
315                             _nc_progname, ch);
316                     result = FALSE;
317                     break;
318                 }
319             }
320         } else {
321             fprintf(stderr, "%s: trailing comma found '%s'\n", _nc_progname, tab_list);
322             result = FALSE;
323         }
324     } else {
325         fprintf(stderr, "%s: no tab-list given\n", _nc_progname);
326         result = FALSE;
327     }
328     return result;
329 }
330
331 static char *
332 skip_list(char *value)
333 {
334     while (*value != '\0' &&
335            (isdigit(UChar(*value)) ||
336             isspace(UChar(*value)) ||
337             strchr("+,", UChar(*value)) != 0)) {
338         ++value;
339     }
340     return value;
341 }
342
343 static void
344 usage(void)
345 {
346 #define DATA(s) s "\n"
347     static const char msg[] =
348     {
349         DATA("Usage: tabs [options] [tabstop-list]")
350         DATA("")
351         DATA("Options:")
352         DATA("  -0       reset tabs")
353         DATA("  -8       set tabs to standard interval")
354         DATA("  -a       Assembler, IBM S/370, first format")
355         DATA("  -a2      Assembler, IBM S/370, second format")
356         DATA("  -c       COBOL, normal format")
357         DATA("  -c2      COBOL compact format")
358         DATA("  -c3      COBOL compact format extended")
359         DATA("  -d       debug (show ruler with expected/actual tab positions)")
360         DATA("  -f       FORTRAN")
361         DATA("  -n       no-op (do not modify terminal settings)")
362         DATA("  -p       PL/I")
363         DATA("  -s       SNOBOL")
364         DATA("  -u       UNIVAC 1100 Assembler")
365         DATA("  -T name  use terminal type 'name'")
366         DATA("  -V       print version")
367         DATA("")
368         DATA("A tabstop-list is an ordered list of column numbers, e.g., 1,11,21")
369         DATA("or 1,+10,+10 which is the same.")
370     };
371 #undef DATA
372
373     fflush(stdout);
374     fputs(msg, stderr);
375     ExitProgram(EXIT_FAILURE);
376 }
377
378 int
379 main(int argc, char *argv[])
380 {
381     int rc = EXIT_FAILURE;
382     bool debug = FALSE;
383     bool no_op = FALSE;
384     int n, ch;
385     NCURSES_CONST char *term_name = 0;
386     char *append = 0;
387     const char *tab_list = 0;
388     TTY tty_settings;
389     int fd;
390
391     _nc_progname = _nc_rootname(argv[0]);
392
393     fd = save_tty_settings(&tty_settings, FALSE);
394
395     if ((term_name = getenv("TERM")) == 0)
396         term_name = "ansi+tabs";
397
398     /* cannot use getopt, since some options are two-character */
399     for (n = 1; n < argc; ++n) {
400         char *option = argv[n];
401         switch (option[0]) {
402         case '-':
403             while ((ch = *++option) != '\0') {
404                 switch (ch) {
405                 case 'a':
406                     switch (*++option) {
407                     default:
408                     case '\0':
409                         tab_list = "1,10,16,36,72";
410                         option--;
411                         /* Assembler, IBM S/370, first format */
412                         break;
413                     case '2':
414                         tab_list = "1,10,16,40,72";
415                         /* Assembler, IBM S/370, second format */
416                         break;
417                     }
418                     break;
419                 case 'c':
420                     switch (*++option) {
421                     default:
422                     case '\0':
423                         tab_list = "1,8,12,16,20,55";
424                         option--;
425                         /* COBOL, normal format */
426                         break;
427                     case '2':
428                         tab_list = "1,6,10,14,49";
429                         /* COBOL compact format */
430                         break;
431                     case '3':
432                         tab_list = "1,6,10,14,18,22,26,30,34,38,42,46,50,54,58,62,67";
433                         /* COBOL compact format extended */
434                         break;
435                     }
436                     break;
437                 case 'd':       /* ncurses extension */
438                     debug = TRUE;
439                     break;
440                 case 'f':
441                     tab_list = "1,7,11,15,19,23";
442                     /* FORTRAN */
443                     break;
444                 case 'n':       /* ncurses extension */
445                     no_op = TRUE;
446                     break;
447                 case 'p':
448                     tab_list = "1,5,9,13,17,21,25,29,33,37,41,45,49,53,57,61";
449                     /* PL/I */
450                     break;
451                 case 's':
452                     tab_list = "1,10,55";
453                     /* SNOBOL */
454                     break;
455                 case 'u':
456                     tab_list = "1,12,20,44";
457                     /* UNIVAC 1100 Assembler */
458                     break;
459                 case 'T':
460                     ++n;
461                     if (*++option != '\0') {
462                         term_name = option;
463                     } else {
464                         term_name = argv[n];
465                         option--;
466                     }
467                     option += ((int) strlen(option)) - 1;
468                     continue;
469                 case 'V':
470                     puts(curses_version());
471                     ExitProgram(EXIT_SUCCESS);
472                 default:
473                     if (isdigit(UChar(*option))) {
474                         char *copy = strdup(option);
475                         *skip_list(copy) = '\0';
476                         tab_list = copy;
477                         option = skip_list(option) - 1;
478                     } else {
479                         usage();
480                     }
481                     break;
482                 }
483             }
484             break;
485         case '+':
486             while ((ch = *++option) != '\0') {
487                 switch (ch) {
488                 case 'm':
489                     /*
490                      * The "+mXXX" option is unimplemented because only the long-obsolete
491                      * att510d implements smgl, which is needed to support
492                      * this option.
493                      */
494                     break;
495                 default:
496                     /* special case of relative stops separated by spaces? */
497                     if (option == argv[n] + 1) {
498                         tab_list = add_to_tab_list(&append, argv[n]);
499                     }
500                     break;
501                 }
502             }
503             break;
504         default:
505             if (append != 0) {
506                 if (tab_list != (const char *) append) {
507                     /* one of the predefined options was used */
508                     free(append);
509                     append = 0;
510                 }
511             }
512             tab_list = add_to_tab_list(&append, option);
513             break;
514         }
515     }
516
517     setupterm(term_name, fd, (int *) 0);
518
519     max_cols = (columns > 0) ? columns : 80;
520
521     if (!VALID_STRING(clear_all_tabs)) {
522         fprintf(stderr,
523                 "%s: terminal type '%s' cannot reset tabs\n",
524                 _nc_progname, term_name);
525     } else if (!VALID_STRING(set_tab)) {
526         fprintf(stderr,
527                 "%s: terminal type '%s' cannot set tabs\n",
528                 _nc_progname, term_name);
529     } else if (legal_tab_list(tab_list)) {
530         int *list = decode_tabs(tab_list);
531
532         if (!no_op)
533             tputs(clear_all_tabs, 1, putch);
534
535         if (list != 0) {
536             if (!no_op)
537                 do_tabs(list);
538             if (debug) {
539                 fflush(stderr);
540                 printf("tabs %s\n", tab_list);
541                 print_ruler(list);
542                 write_tabs(list);
543             }
544             free(list);
545         } else if (debug) {
546             fflush(stderr);
547             printf("tabs %s\n", tab_list);
548         }
549         rc = EXIT_SUCCESS;
550     }
551     if (append != 0)
552         free(append);
553     ExitProgram(rc);
554 }