f90e76cdb667b7eeb5b5b3c91fc9fd4269776388
[ncurses.git] / progs / tput.c
1 /****************************************************************************
2  * Copyright (c) 1998-2015,2016 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 <reset_cmd.h>
44
45 #if !PURE_TERMINFO
46 #include <dump_entry.h>
47 #include <termsort.c>
48 #endif
49 #include <transform.h>
50
51 MODULE_ID("$Id: tput.c,v 1.56 2016/08/06 20:59:26 tom Exp $")
52
53 #define PUTS(s)         fputs(s, stdout)
54
55 const char *_nc_progname = "tput";
56
57 static char *prg_name;
58 static bool is_init = FALSE;
59 static bool is_reset = FALSE;
60
61 static void
62 quit(int status, const char *fmt,...)
63 {
64     va_list argp;
65
66     va_start(argp, fmt);
67     fprintf(stderr, "%s: ", prg_name);
68     vfprintf(stderr, fmt, argp);
69     fprintf(stderr, "\n");
70     va_end(argp);
71     ExitProgram(status);
72 }
73
74 static void
75 usage(void)
76 {
77     fprintf(stderr, "usage: %s [-V] [-S] [-T term] capname\n", prg_name);
78     ExitProgram(EXIT_FAILURE);
79 }
80
81 static void
82 check_aliases(const char *name, bool program)
83 {
84     is_init = same_program(name, program ? PROG_INIT : "init");
85     is_reset = same_program(name, program ? PROG_RESET : "reset");
86 }
87
88 static int
89 exit_code(int token, int value)
90 {
91     int result = 99;
92
93     switch (token) {
94     case BOOLEAN:
95         result = !value;        /* TRUE=0, FALSE=1 */
96         break;
97     case NUMBER:
98         result = 0;             /* always zero */
99         break;
100     case STRING:
101         result = value;         /* 0=normal, 1=missing */
102         break;
103     }
104     return result;
105 }
106
107 static int
108 tput_cmd(int argc, char *argv[])
109 {
110     NCURSES_CONST char *name;
111     char *s;
112     int status;
113 #if !PURE_TERMINFO
114     bool termcap = FALSE;
115 #endif
116
117     if ((name = argv[0]) == 0)
118         name = "";
119     check_aliases(name, FALSE);
120     if (is_reset || is_init) {
121         reset_start(stdout, is_reset, is_init);
122         if (send_init_strings((TTY *) 0)) {
123             reset_flush();
124         }
125         return 0;
126     }
127
128     if (strcmp(name, "longname") == 0) {
129         PUTS(longname());
130         return 0;
131     }
132 #if !PURE_TERMINFO
133   retry:
134 #endif
135     if ((status = tigetflag(name)) != -1) {
136         return exit_code(BOOLEAN, status);
137     } else if ((status = tigetnum(name)) != CANCELLED_NUMERIC) {
138         (void) printf("%d\n", status);
139         return exit_code(NUMBER, 0);
140     } else if ((s = tigetstr(name)) == CANCELLED_STRING) {
141 #if !PURE_TERMINFO
142         if (!termcap) {
143             const struct name_table_entry *np;
144
145             termcap = TRUE;
146             if ((np = _nc_find_entry(name, _nc_get_hash_table(termcap))) != 0) {
147                 switch (np->nte_type) {
148                 case BOOLEAN:
149                     if (bool_from_termcap[np->nte_index])
150                         name = boolnames[np->nte_index];
151                     break;
152
153                 case NUMBER:
154                     if (num_from_termcap[np->nte_index])
155                         name = numnames[np->nte_index];
156                     break;
157
158                 case STRING:
159                     if (str_from_termcap[np->nte_index])
160                         name = strnames[np->nte_index];
161                     break;
162                 }
163                 goto retry;
164             }
165         }
166 #endif
167         quit(4, "unknown terminfo capability '%s'", name);
168     } else if (s != ABSENT_STRING) {
169         if (argc > 1) {
170             int k;
171             int ignored;
172             long numbers[1 + NUM_PARM];
173             char *strings[1 + NUM_PARM];
174             char *p_is_s[NUM_PARM];
175
176             /* Nasty hack time. The tparm function needs to see numeric
177              * parameters as numbers, not as pointers to their string
178              * representations
179              */
180
181             for (k = 1; k < argc; k++) {
182                 char *tmp = 0;
183                 strings[k] = argv[k];
184                 numbers[k] = strtol(argv[k], &tmp, 0);
185                 if (tmp == 0 || *tmp != 0)
186                     numbers[k] = 0;
187             }
188             for (k = argc; k <= NUM_PARM; k++) {
189                 numbers[k] = 0;
190                 strings[k] = 0;
191             }
192
193             switch (tparm_type(name)) {
194             case Num_Str:
195                 s = TPARM_2(s, numbers[1], strings[2]);
196                 break;
197             case Num_Str_Str:
198                 s = TPARM_3(s, numbers[1], strings[2], strings[3]);
199                 break;
200             case Numbers:
201             default:
202                 (void) _nc_tparm_analyze(s, p_is_s, &ignored);
203 #define myParam(n) (p_is_s[n - 1] != 0 ? ((TPARM_ARG) strings[n]) : numbers[n])
204                 s = TPARM_9(s,
205                             myParam(1),
206                             myParam(2),
207                             myParam(3),
208                             myParam(4),
209                             myParam(5),
210                             myParam(6),
211                             myParam(7),
212                             myParam(8),
213                             myParam(9));
214                 break;
215             }
216         }
217
218         /* use putp() in order to perform padding */
219         putp(s);
220         return exit_code(STRING, 0);
221     }
222     return exit_code(STRING, 1);
223 }
224
225 int
226 main(int argc, char **argv)
227 {
228     char *term;
229     int errret;
230     bool cmdline = TRUE;
231     int c;
232     char buf[BUFSIZ];
233     int result = 0;
234
235     check_aliases(prg_name = _nc_rootname(argv[0]), TRUE);
236
237     term = getenv("TERM");
238
239     while ((c = getopt(argc, argv, "ST:V")) != -1) {
240         switch (c) {
241         case 'S':
242             cmdline = FALSE;
243             break;
244         case 'T':
245             use_env(FALSE);
246             term = optarg;
247             break;
248         case 'V':
249             puts(curses_version());
250             ExitProgram(EXIT_SUCCESS);
251         default:
252             usage();
253             /* NOTREACHED */
254         }
255     }
256
257     /*
258      * Modify the argument list to omit the options we processed.
259      */
260     if (is_reset || is_init) {
261         if (optind-- < argc) {
262             argc -= optind;
263             argv += optind;
264         }
265         argv[0] = prg_name;
266     } else {
267         argc -= optind;
268         argv += optind;
269     }
270
271     if (term == 0 || *term == '\0')
272         quit(2, "No value for $TERM and no -T specified");
273
274     if (setupterm(term, STDOUT_FILENO, &errret) != OK && errret <= 0)
275         quit(3, "unknown terminal \"%s\"", term);
276
277     if (cmdline) {
278         if ((argc <= 0) && !is_reset && !is_init)
279             usage();
280         ExitProgram(tput_cmd(argc, argv));
281     }
282
283     while (fgets(buf, sizeof(buf), stdin) != 0) {
284         char *argvec[16];       /* command, 9 parms, null, & slop */
285         int argnum = 0;
286         char *cp;
287
288         /* crack the argument list into a dope vector */
289         for (cp = buf; *cp; cp++) {
290             if (isspace(UChar(*cp))) {
291                 *cp = '\0';
292             } else if (cp == buf || cp[-1] == 0) {
293                 argvec[argnum++] = cp;
294                 if (argnum >= (int) SIZEOF(argvec) - 1)
295                     break;
296             }
297         }
298         argvec[argnum] = 0;
299
300         if (argnum != 0
301             && tput_cmd(argnum, argvec) != 0) {
302             if (result == 0)
303                 result = 4;     /* will return value >4 */
304             ++result;
305         }
306     }
307
308     ExitProgram(result);
309 }