ncurses 6.1 - patch 20180630
[ncurses.git] / progs / tput.c
1 /****************************************************************************
2  * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34
35 /*
36  * tput.c -- shellscript access to terminal capabilities
37  *
38  * by Eric S. Raymond <esr@snark.thyrsus.com>, portions based on code from
39  * Ross Ridge's mytinfo package.
40  */
41
42 #include <tparm_type.h>
43 #include <clear_cmd.h>
44 #include <reset_cmd.h>
45
46 #if !PURE_TERMINFO
47 #include <dump_entry.h>
48 #include <termsort.c>
49 #endif
50 #include <transform.h>
51 #include <tty_settings.h>
52
53 MODULE_ID("$Id: tput.c,v 1.79 2018/06/30 15:56:01 Nicholas.Marriott Exp $")
54
55 #define PUTS(s)         fputs(s, stdout)
56
57 const char *_nc_progname = "tput";
58
59 static char *prg_name;
60 static bool is_init = FALSE;
61 static bool is_reset = FALSE;
62 static bool is_clear = FALSE;
63
64 static void
65 quit(int status, const char *fmt,...)
66 {
67     va_list argp;
68
69     va_start(argp, fmt);
70     fprintf(stderr, "%s: ", prg_name);
71     vfprintf(stderr, fmt, argp);
72     fprintf(stderr, "\n");
73     va_end(argp);
74     ExitProgram(status);
75 }
76
77 static void
78 usage(void)
79 {
80 #define KEEP(s) s "\n"
81     static const char msg[] =
82     {
83         KEEP("")
84         KEEP("Options:")
85         KEEP("  -S <<       read commands from standard input")
86         KEEP("  -T TERM     use this instead of $TERM")
87         KEEP("  -V          print curses-version")
88         KEEP("  -x          do not try to clear scrollback")
89         KEEP("")
90         KEEP("Commands:")
91         KEEP("  clear       clear the screen")
92         KEEP("  init        initialize the terminal")
93         KEEP("  reset       reinitialize the terminal")
94         KEEP("  capname     unlike clear/init/reset, print value for capability \"capname\"")
95     };
96 #undef KEEP
97     (void) fprintf(stderr, "Usage: %s [options] [command]\n", prg_name);
98     fputs(msg, stderr);
99     ExitProgram(ErrUsage);
100 }
101
102 static char *
103 check_aliases(char *name, bool program)
104 {
105     static char my_init[] = "init";
106     static char my_reset[] = "reset";
107     static char my_clear[] = "clear";
108
109     char *result = name;
110     if ((is_init = same_program(name, program ? PROG_INIT : my_init)))
111         result = my_init;
112     if ((is_reset = same_program(name, program ? PROG_RESET : my_reset)))
113         result = my_reset;
114     if ((is_clear = same_program(name, program ? PROG_CLEAR : my_clear)))
115         result = my_clear;
116     return result;
117 }
118
119 static int
120 exit_code(int token, int value)
121 {
122     int result = 99;
123
124     switch (token) {
125     case BOOLEAN:
126         result = !value;        /* TRUE=0, FALSE=1 */
127         break;
128     case NUMBER:
129         result = 0;             /* always zero */
130         break;
131     case STRING:
132         result = value;         /* 0=normal, 1=missing */
133         break;
134     }
135     return result;
136 }
137
138 /*
139  * Returns nonzero on error.
140  */
141 static int
142 tput_cmd(int fd, TTY * saved_settings, bool opt_x, int argc, char *argv[])
143 {
144     NCURSES_CONST char *name;
145     char *s;
146     int status;
147 #if !PURE_TERMINFO
148     bool termcap = FALSE;
149 #endif
150
151     name = check_aliases(argv[0], FALSE);
152     if (is_reset || is_init) {
153         TTY oldmode;
154
155         int terasechar = -1;    /* new erase character */
156         int intrchar = -1;      /* new interrupt character */
157         int tkillchar = -1;     /* new kill character */
158
159         if (is_reset) {
160             reset_start(stdout, TRUE, FALSE);
161             reset_tty_settings(fd, saved_settings);
162         } else {
163             reset_start(stdout, FALSE, TRUE);
164         }
165
166 #if HAVE_SIZECHANGE
167         set_window_size(fd, &lines, &columns);
168 #else
169         (void) fd;
170 #endif
171         set_control_chars(saved_settings, terasechar, intrchar, tkillchar);
172         set_conversions(saved_settings);
173         if (send_init_strings(fd, &oldmode)) {
174             reset_flush();
175         }
176
177         update_tty_settings(&oldmode, saved_settings);
178         return 0;
179     }
180
181     if (strcmp(name, "longname") == 0) {
182         PUTS(longname());
183         return 0;
184     }
185 #if !PURE_TERMINFO
186   retry:
187 #endif
188     if (strcmp(name, "clear") == 0) {
189         return (clear_cmd(opt_x) == ERR) ? ErrUsage : 0;
190     } else if ((status = tigetflag(name)) != -1) {
191         return exit_code(BOOLEAN, status);
192     } else if ((status = tigetnum(name)) != CANCELLED_NUMERIC) {
193         (void) printf("%d\n", status);
194         return exit_code(NUMBER, 0);
195     } else if ((s = tigetstr(name)) == CANCELLED_STRING) {
196 #if !PURE_TERMINFO
197         if (!termcap) {
198             const struct name_table_entry *np;
199
200             termcap = TRUE;
201             if ((np = _nc_find_entry(name, _nc_get_hash_table(termcap))) != 0) {
202                 switch (np->nte_type) {
203                 case BOOLEAN:
204                     name = boolnames[np->nte_index];
205                     break;
206
207                 case NUMBER:
208                     name = numnames[np->nte_index];
209                     break;
210
211                 case STRING:
212                     name = strnames[np->nte_index];
213                     break;
214                 }
215                 goto retry;
216             }
217         }
218 #endif
219         quit(ErrCapName, "unknown terminfo capability '%s'", name);
220     } else if (VALID_STRING(s)) {
221         if (argc > 1) {
222             int k;
223             int ignored;
224             long numbers[1 + NUM_PARM];
225             char *strings[1 + NUM_PARM];
226             char *p_is_s[NUM_PARM];
227
228             /* Nasty hack time. The tparm function needs to see numeric
229              * parameters as numbers, not as pointers to their string
230              * representations
231              */
232
233             for (k = 1; k < argc; k++) {
234                 char *tmp = 0;
235                 strings[k] = argv[k];
236                 numbers[k] = strtol(argv[k], &tmp, 0);
237                 if (tmp == 0 || *tmp != 0)
238                     numbers[k] = 0;
239             }
240             for (k = argc; k <= NUM_PARM; k++) {
241                 numbers[k] = 0;
242                 strings[k] = 0;
243             }
244
245             switch (tparm_type(name)) {
246             case Num_Str:
247                 s = TPARM_2(s, numbers[1], strings[2]);
248                 break;
249             case Num_Str_Str:
250                 s = TPARM_3(s, numbers[1], strings[2], strings[3]);
251                 break;
252             case Numbers:
253             default:
254                 (void) _nc_tparm_analyze(s, p_is_s, &ignored);
255 #define myParam(n) (p_is_s[n - 1] != 0 ? ((TPARM_ARG) strings[n]) : numbers[n])
256                 s = TPARM_9(s,
257                             myParam(1),
258                             myParam(2),
259                             myParam(3),
260                             myParam(4),
261                             myParam(5),
262                             myParam(6),
263                             myParam(7),
264                             myParam(8),
265                             myParam(9));
266                 break;
267             }
268         }
269
270         /* use putp() in order to perform padding */
271         putp(s);
272         return exit_code(STRING, 0);
273     }
274     return exit_code(STRING, 1);
275 }
276
277 int
278 main(int argc, char **argv)
279 {
280     char *term;
281     int errret;
282     bool cmdline = TRUE;
283     int c;
284     char buf[BUFSIZ];
285     int result = 0;
286     int fd;
287     TTY tty_settings;
288     bool opt_x = FALSE;         /* clear scrollback if possible */
289     bool is_alias;
290     bool need_tty;
291
292     prg_name = check_aliases(_nc_rootname(argv[0]), TRUE);
293
294     term = getenv("TERM");
295
296     while ((c = getopt(argc, argv, "ST:Vx")) != -1) {
297         switch (c) {
298         case 'S':
299             cmdline = FALSE;
300             break;
301         case 'T':
302             use_env(FALSE);
303             use_tioctl(TRUE);
304             term = optarg;
305             break;
306         case 'V':
307             puts(curses_version());
308             ExitProgram(EXIT_SUCCESS);
309         case 'x':               /* do not try to clear scrollback */
310             opt_x = TRUE;
311             break;
312         default:
313             usage();
314             /* NOTREACHED */
315         }
316     }
317
318     is_alias = (is_clear || is_reset || is_init);
319     need_tty = ((is_reset || is_init) ||
320                 (optind < argc &&
321                  (!strcmp(argv[optind], "reset") ||
322                   !strcmp(argv[optind], "init"))));
323
324     /*
325      * Modify the argument list to omit the options we processed.
326      */
327     if (is_alias) {
328         if (optind-- < argc) {
329             argc -= optind;
330             argv += optind;
331         }
332         argv[0] = prg_name;
333     } else {
334         argc -= optind;
335         argv += optind;
336     }
337
338     if (term == 0 || *term == '\0')
339         quit(ErrUsage, "No value for $TERM and no -T specified");
340
341     fd = save_tty_settings(&tty_settings, need_tty);
342
343     if (setupterm(term, fd, &errret) != OK && errret <= 0)
344         quit(ErrTermType, "unknown terminal \"%s\"", term);
345
346     if (cmdline) {
347         if ((argc <= 0) && !is_alias)
348             usage();
349         ExitProgram(tput_cmd(fd, &tty_settings, opt_x, argc, argv));
350     }
351
352     while (fgets(buf, sizeof(buf), stdin) != 0) {
353         char *argvec[16];       /* command, 9 parms, null, & slop */
354         int argnum = 0;
355         char *cp;
356
357         /* crack the argument list into a dope vector */
358         for (cp = buf; *cp; cp++) {
359             if (isspace(UChar(*cp))) {
360                 *cp = '\0';
361             } else if (cp == buf || cp[-1] == 0) {
362                 argvec[argnum++] = cp;
363                 if (argnum >= (int) SIZEOF(argvec) - 1)
364                     break;
365             }
366         }
367         argvec[argnum] = 0;
368
369         if (argnum != 0
370             && tput_cmd(fd, &tty_settings, opt_x, argnum, argvec) != 0) {
371             if (result == 0)
372                 result = ErrSystem(0);  /* will return value >4 */
373             ++result;
374         }
375     }
376
377     ExitProgram(result);
378 }