1 /****************************************************************************
2 * Copyright 2018-2020,2021 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 ****************************************************************************/
37 * tput.c -- shellscript access to terminal capabilities
39 * by Eric S. Raymond <esr@snark.thyrsus.com>, portions based on code from
40 * Ross Ridge's mytinfo package.
43 #include <tparm_type.h>
44 #include <clear_cmd.h>
45 #include <reset_cmd.h>
47 #include <transform.h>
48 #include <tty_settings.h>
50 MODULE_ID("$Id: tput.c,v 1.94 2021/09/19 00:06:44 tom Exp $")
52 #define PUTS(s) fputs(s, stdout)
54 const char *_nc_progname = "tput";
56 static char *prg_name;
57 static bool is_init = FALSE;
58 static bool is_reset = FALSE;
59 static bool is_clear = FALSE;
61 static GCC_NORETURN void
62 quit(int status, const char *fmt, ...)
67 fprintf(stderr, "%s: ", prg_name);
68 vfprintf(stderr, fmt, argp);
69 fprintf(stderr, "\n");
74 static GCC_NORETURN void
77 #define KEEP(s) s "\n"
78 static const char msg[] =
82 KEEP(" -S << read commands from standard input")
83 KEEP(" -T TERM use this instead of $TERM")
84 KEEP(" -V print curses-version")
85 KEEP(" -x do not try to clear scrollback")
88 KEEP(" clear clear the screen")
89 KEEP(" init initialize the terminal")
90 KEEP(" reset reinitialize the terminal")
91 KEEP(" capname unlike clear/init/reset, print value for capability \"capname\"")
94 (void) fprintf(stderr, "Usage: %s [options] [command]\n", prg_name);
96 ExitProgram(ErrUsage);
100 check_aliases(char *name, bool program)
102 static char my_init[] = "init";
103 static char my_reset[] = "reset";
104 static char my_clear[] = "clear";
107 if ((is_init = same_program(name, program ? PROG_INIT : my_init)))
109 if ((is_reset = same_program(name, program ? PROG_RESET : my_reset)))
111 if ((is_clear = same_program(name, program ? PROG_CLEAR : my_clear)))
117 exit_code(int token, int value)
123 result = !value; /* TRUE=0, FALSE=1 */
126 result = 0; /* always zero */
129 result = value; /* 0=normal, 1=missing */
136 * Returns nonzero on error.
139 tput_cmd(int fd, TTY * settings, bool opt_x, int argc, char **argv, int *used)
141 NCURSES_CONST char *name;
145 bool termcap = FALSE;
148 name = check_aliases(argv[0], FALSE);
150 if (is_reset || is_init) {
153 int terasechar = -1; /* new erase character */
154 int intrchar = -1; /* new interrupt character */
155 int tkillchar = -1; /* new kill character */
158 reset_start(stdout, TRUE, FALSE);
159 reset_tty_settings(fd, settings);
161 reset_start(stdout, FALSE, TRUE);
165 set_window_size(fd, &lines, &columns);
169 set_control_chars(settings, terasechar, intrchar, tkillchar);
170 set_conversions(settings);
171 if (send_init_strings(fd, &oldmode)) {
175 update_tty_settings(&oldmode, settings);
179 if (strcmp(name, "longname") == 0) {
186 if (strcmp(name, "clear") == 0) {
187 return (clear_cmd(opt_x) == ERR) ? ErrUsage : 0;
188 } else if ((status = tigetflag(name)) != -1) {
189 return exit_code(BOOLEAN, status);
190 } else if ((status = tigetnum(name)) != CANCELLED_NUMERIC) {
191 (void) printf("%d\n", status);
192 return exit_code(NUMBER, 0);
193 } else if ((s = tigetstr(name)) == CANCELLED_STRING) {
196 const struct name_table_entry *np;
199 if ((np = _nc_find_entry(name, _nc_get_hash_table(termcap))) != 0) {
200 switch (np->nte_type) {
202 name = boolnames[np->nte_index];
206 name = numnames[np->nte_index];
210 name = strnames[np->nte_index];
217 quit(ErrCapName, "unknown terminfo capability '%s'", name);
218 } else if (VALID_STRING(s)) {
223 long numbers[1 + NUM_PARM];
224 char *strings[1 + NUM_PARM];
225 char *p_is_s[NUM_PARM];
228 /* Nasty hack time. The tparm function needs to see numeric
229 * parameters as numbers, not as pointers to their string
233 for (k = 1; (k < argc) && (k <= NUM_PARM); k++) {
235 strings[k] = argv[k];
236 numbers[k] = strtol(argv[k], &tmp, 0);
237 if (tmp == 0 || *tmp != 0)
240 for (k = argc; k <= NUM_PARM; k++) {
245 paramType = tparm_type(name);
248 * If the capability is an extended one, analyze the string.
250 if (paramType == Numbers) {
251 struct name_table_entry const *entry_ptr;
252 entry_ptr = _nc_find_type_entry(name, STRING, FALSE);
253 if (entry_ptr == NULL) {
260 _nc_reset_tparm(NULL);
263 s = TPARM_2(s, numbers[1], strings[2]);
267 s = TPARM_3(s, numbers[1], strings[2], strings[3]);
271 analyzed = _nc_tparm_analyze(NULL, s, p_is_s, &popcount);
272 #define myParam(n) numbers[n]
288 analyzed = _nc_tparm_analyze(NULL, s, p_is_s, &popcount);
289 #define myParam(n) (p_is_s[n - 1] != 0 ? ((TPARM_ARG) strings[n]) : numbers[n])
303 if (analyzed < popcount) {
309 /* use putp() in order to perform padding */
311 return exit_code(STRING, 0);
313 return exit_code(STRING, 1);
317 main(int argc, char **argv)
328 bool opt_x = FALSE; /* clear scrollback if possible */
332 prg_name = check_aliases(_nc_rootname(argv[0]), TRUE);
334 term = getenv("TERM");
336 while ((c = getopt(argc, argv, "ST:Vx")) != -1) {
347 puts(curses_version());
348 ExitProgram(EXIT_SUCCESS);
349 case 'x': /* do not try to clear scrollback */
358 is_alias = (is_clear || is_reset || is_init);
359 need_tty = ((is_reset || is_init) ||
361 (!strcmp(argv[optind], "reset") ||
362 !strcmp(argv[optind], "init"))));
365 * Modify the argument list to omit the options we processed.
368 if (optind-- < argc) {
378 if (term == 0 || *term == '\0')
379 quit(ErrUsage, "No value for $TERM and no -T specified");
381 fd = save_tty_settings(&tty_settings, need_tty);
383 if (setupterm(term, fd, &errret) != OK && errret <= 0)
384 quit(ErrTermType, "unknown terminal \"%s\"", term);
388 if ((argc <= 0) && !is_alias)
391 code = tput_cmd(fd, &tty_settings, opt_x, argc, argv, &used);
400 while (fgets(buf, sizeof(buf), stdin) != 0) {
401 size_t need = strlen(buf);
402 char **argvec = typeCalloc(char *, need + 1);
407 if (argvec == NULL) {
408 quit(ErrSystem(1), strerror(errno));
411 /* split the buffer into tokens */
412 for (cp = buf; *cp; cp++) {
413 if (isspace(UChar(*cp))) {
415 } else if (cp == buf || cp[-1] == '\0') {
416 argvec[argnum++] = cp;
417 if (argnum >= (int) need)
424 int code = tput_cmd(fd, &tty_settings, opt_x, argnum, argnow, &used);
427 result = ErrSystem(0); /* will return value >4 */