/****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc. *
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
+ * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
/****************************************************************************
* Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
* and: Eric S. Raymond <esr@snark.thyrsus.com> *
+ * and: Thomas E. Dickey 1996-on *
****************************************************************************/
-
/*
* tput.c -- shellscript access to terminal capabilities
*
* Ross Ridge's mytinfo package.
*/
-#include <progs.priv.h>
+#include <tparm_type.h>
+#include <clear_cmd.h>
+#include <reset_cmd.h>
-#include <curses.h>
+#include <transform.h>
+#include <tty_settings.h>
-MODULE_ID("$Id: tput.c,v 1.11 1998/02/11 12:14:02 tom Exp $")
+MODULE_ID("$Id: tput.c,v 1.104 2024/04/20 22:20:51 tom Exp $")
#define PUTS(s) fputs(s, stdout)
-#define PUTCHAR(c) putchar(c)
-#define FLUSH fflush(stdout)
-static char *prg_name;
+const char *_nc_progname = "tput";
+
+static bool opt_v = FALSE; /* quiet, do not show warnings */
+static bool opt_x = FALSE; /* clear scrollback if possible */
-static void quit(int status, const char *fmt, ...)
+static bool is_init = FALSE;
+static bool is_reset = FALSE;
+static bool is_clear = FALSE;
+
+static GCC_NORETURN void
+quit(int status, const char *fmt, ...)
{
-va_list argp;
+ va_list argp;
+
+ va_start(argp, fmt);
+ fprintf(stderr, "%s: ", _nc_progname);
+ vfprintf(stderr, fmt, argp);
+ fprintf(stderr, "\n");
+ va_end(argp);
+ ExitProgram(status);
+}
- va_start(argp,fmt);
- vfprintf (stderr, fmt, argp);
- fprintf(stderr, "\n");
- va_end(argp);
- exit(status);
+static GCC_NORETURN void
+usage(const char *optstring)
+{
+#define KEEP(s) s "\n"
+ static const char msg[] =
+ {
+ KEEP("")
+ KEEP("Options:")
+ KEEP(" -S << read commands from standard input")
+ KEEP(" -T TERM use this instead of $TERM")
+ KEEP(" -V print curses-version")
+ KEEP(" -v verbose, show warnings")
+ KEEP(" -x do not try to clear scrollback")
+ KEEP("")
+ KEEP("Commands:")
+ KEEP(" clear clear the screen")
+ KEEP(" init initialize the terminal")
+ KEEP(" reset reinitialize the terminal")
+ KEEP(" capname unlike clear/init/reset, print value for capability \"capname\"")
+ };
+#undef KEEP
+ (void) fprintf(stderr, "Usage: %s [options] [command]\n", _nc_progname);
+ if (optstring != NULL) {
+ const char *s = msg;
+ while (*s != '\0') {
+ fputc(UChar(*s), stderr);
+ if (!strncmp(s, " -", 3)) {
+ if (strchr(optstring, s[3]) == NULL)
+ s = strchr(s, '\n') + 1;
+ } else if (!strncmp(s, "\n\nC", 3))
+ break;
+ ++s;
+ }
+ } else {
+ fputs(msg, stderr);
+ }
+ ExitProgram(ErrUsage);
}
-static void usage(void)
+static char *
+check_aliases(char *name, bool program)
{
- fprintf(stderr, "usage: %s [-S] [-T term] capname\n", prg_name);
- exit(EXIT_FAILURE);
+ static char my_init[] = "init";
+ static char my_reset[] = "reset";
+ static char my_clear[] = "clear";
+
+ char *result = name;
+ if ((is_init = same_program(name, program ? PROG_INIT : my_init)))
+ result = my_init;
+ if ((is_reset = same_program(name, program ? PROG_RESET : my_reset)))
+ result = my_reset;
+ if ((is_clear = same_program(name, program ? PROG_CLEAR : my_clear)))
+ result = my_clear;
+ return result;
}
-static int tput(int argc, char *argv[])
+static int
+exit_code(int token, int value)
{
-char *s;
-int i, j, c;
-int reset, status;
-FILE *f;
-
- reset = 0;
- if (strcmp(argv[0], "reset") == 0) {
- reset = 1;
+ int result = 99;
+
+ switch (token) {
+ case BOOLEAN:
+ result = !value; /* TRUE=0, FALSE=1 */
+ break;
+ case NUMBER:
+ result = 0; /* always zero */
+ break;
+ case STRING:
+ result = value; /* 0=normal, 1=missing */
+ break;
+ }
+ return result;
+}
+
+/*
+ * Returns nonzero on error.
+ */
+static int
+tput_cmd(int fd, TTY * settings, int argc, char **argv, int *used)
+{
+ NCURSES_CONST char *name;
+ char *s;
+ int status;
+#if !PURE_TERMINFO
+ bool termcap = FALSE;
+#endif
+
+ name = check_aliases(argv[0], FALSE);
+ *used = 1;
+ if (is_reset || is_init) {
+ TTY oldmode = *settings;
+
+ int terasechar = -1; /* new erase character */
+ int intrchar = -1; /* new interrupt character */
+ int tkillchar = -1; /* new kill character */
+
+ if (is_reset) {
+ reset_start(stdout, TRUE, FALSE);
+ reset_tty_settings(fd, settings, FALSE);
+ } else {
+ reset_start(stdout, FALSE, TRUE);
}
- if (reset || strcmp(argv[0], "init") == 0) {
- if (init_prog != NULL) {
- system(init_prog);
- }
- FLUSH;
- if (reset && reset_1string != NULL) {
- PUTS(reset_1string);
- } else if (init_1string != NULL) {
- PUTS(init_1string);
- }
- FLUSH;
-
- if (reset && reset_2string != NULL) {
- PUTS(reset_2string);
- } else if (init_2string != NULL) {
- PUTS(init_2string);
- }
- FLUSH;
-
- if (set_lr_margin != NULL) {
- PUTS(tparm(set_lr_margin, 0, columns - 1));
- } else if (set_left_margin_parm != NULL
- && set_right_margin_parm != NULL) {
- PUTS(tparm(set_left_margin_parm, 0));
- PUTS(tparm(set_right_margin_parm, columns - 1));
- } else if (clear_margins != NULL && set_left_margin != NULL
- && set_right_margin != NULL) {
- PUTS(clear_margins);
- if (carriage_return != NULL) {
- PUTS(carriage_return);
- } else {
- PUTCHAR('\r');
- }
- PUTS(set_left_margin);
- if (parm_right_cursor) {
- PUTS(tparm(parm_right_cursor, columns - 1));
- } else {
- for(i = 0; i < columns - 1; i++) {
- PUTCHAR(' ');
- }
- }
- PUTS(set_right_margin);
- if (carriage_return != NULL) {
- PUTS(carriage_return);
- } else {
- PUTCHAR('\r');
- }
- }
- FLUSH;
-
- if (init_tabs != 8) {
- if (clear_all_tabs != NULL && set_tab != NULL) {
- for(i = 0; i < columns - 1; i += 8) {
- if (parm_right_cursor) {
- PUTS(tparm(parm_right_cursor, 8));
- } else {
- for(j = 0; j < 8; j++)
- PUTCHAR(' ');
- }
- PUTS(set_tab);
- }
- FLUSH;
- }
- }
-
- if (reset && reset_file != NULL) {
- f = fopen(reset_file, "r");
- if (f == NULL) {
- quit(errno, "Can't open reset_file: '%s'", reset_file);
- }
- while((c = fgetc(f)) != EOF) {
- PUTCHAR(c);
- }
- fclose(f);
- } else if (init_file != NULL) {
- f = fopen(init_file, "r");
- if (f == NULL) {
- quit(errno, "Can't open init_file: '%s'", init_file);
- }
- while((c = fgetc(f)) != EOF) {
- PUTCHAR(c);
- }
- fclose(f);
- }
- FLUSH;
-
- if (reset && reset_3string != NULL) {
- PUTS(reset_3string);
- } else if (init_2string != NULL) {
- PUTS(init_2string);
- }
- FLUSH;
- return 0;
+#if HAVE_SIZECHANGE
+ {
+ NCURSES_INT2 my_rows = lines;
+ NCURSES_INT2 my_cols = columns;
+ set_window_size(fd, &my_rows, &my_cols);
+ lines = my_rows;
+ columns = my_cols;
}
-
- if (strcmp(argv[0], "longname") == 0) {
- PUTS(longname());
- return 0;
+#else
+ (void) fd;
+#endif
+ set_control_chars(settings, terasechar, intrchar, tkillchar);
+ set_conversions(settings);
+
+ if (send_init_strings(fd, &oldmode)) {
+ reset_flush();
}
- if ((status = tigetflag(argv[0])) != -1)
- return(status != 0);
- else if ((status = tigetnum(argv[0])) != CANCELLED_NUMERIC) {
- (void) printf("%d\n", status);
- return(0);
- }
- else if ((s = tigetstr(argv[0])) == CANCELLED_STRING)
- quit(4, "%s: unknown terminfo capability '%s'", prg_name, argv[0]);
- else if (s != (char *)NULL) {
- if (argc > 1) {
- int k;
-
- /* Nasty hack time. The tparm function needs to see numeric
- * parameters as numbers, not as pointers to their string
- * representations
- */
-
- for (k = 1; k < argc; k++)
- if (isdigit(argv[k][0])) {
- long val = atol(argv[k]);
- argv[k] = (char *)val;
- }
-
- s = tparm(s,argv[1],argv[2],argv[3],argv[4],
- argv[5],argv[6],argv[7],argv[8],
- argv[9]);
+ update_tty_settings(&oldmode, settings);
+ return 0;
+ }
+
+ if (strcmp(name, "longname") == 0) {
+ PUTS(longname());
+ return 0;
+ }
+#if !PURE_TERMINFO
+ retry:
+#endif
+ if (strcmp(name, "clear") == 0) {
+ return (clear_cmd(opt_x) == ERR) ? ErrUsage : 0;
+ } else if ((status = tigetflag(name)) != -1) {
+ return exit_code(BOOLEAN, status);
+ } else if ((status = tigetnum(name)) != CANCELLED_NUMERIC) {
+ (void) printf("%d\n", status);
+ return exit_code(NUMBER, 0);
+ } else if ((s = tigetstr(name)) == CANCELLED_STRING) {
+#if !PURE_TERMINFO
+ if (!termcap) {
+ const struct name_table_entry *np;
+
+ termcap = TRUE;
+ if ((np = _nc_find_entry(name, _nc_get_hash_table(termcap))) != 0) {
+ switch (np->nte_type) {
+ case BOOLEAN:
+ name = boolnames[np->nte_index];
+ break;
+
+ case NUMBER:
+ name = numnames[np->nte_index];
+ break;
+
+ case STRING:
+ name = strnames[np->nte_index];
+ break;
}
-
- /* use putp() in order to perform padding */
- putp(s);
- return(0);
+ goto retry;
+ }
}
- return(0);
-}
+#endif
+ quit(ErrCapName, "unknown terminfo capability '%s'", name);
+ } else if (VALID_STRING(s)) {
+ if (argc > 1) {
+ int k;
+ int narg;
+ int analyzed;
+ int provided;
+ int popcount;
+ long numbers[1 + NUM_PARM];
+ char *strings[1 + NUM_PARM];
+ char *p_is_s[NUM_PARM];
+ TParams paramType;
+
+ /* Nasty hack time. The tparm function needs to see numeric
+ * parameters as numbers, not as pointers to their string
+ * representations
+ */
+
+ for (k = 1; (k < argc) && (k <= NUM_PARM); k++) {
+ char *tmp = 0;
+ strings[k] = argv[k];
+ numbers[k] = strtol(argv[k], &tmp, 0);
+ if (tmp == 0 || *tmp != 0)
+ numbers[k] = 0;
+ }
+ for (k = argc; k <= NUM_PARM; k++) {
+ numbers[k] = 0;
+ strings[k] = 0;
+ }
-int main(int argc, char **argv)
-{
-char *s, *term;
-int errret, cmdline = 1;
-int c;
-char buf[BUFSIZ];
-int errors = 0;
-
- prg_name = argv[0];
- s = strrchr(prg_name, '/');
- if (s != NULL && *++s != '\0')
- prg_name = s;
-
- term = getenv("TERM");
-
- while ((c = getopt (argc, argv, "ST:")) != EOF)
- switch (c)
- {
- case 'S':
- cmdline = 0;
+ paramType = tparm_type(name);
+#if NCURSES_XNAMES
+ /*
+ * If the capability is an extended one, analyze the string.
+ */
+ if (paramType == Numbers) {
+ struct name_table_entry const *entry_ptr;
+ entry_ptr = _nc_find_type_entry(name, STRING, FALSE);
+ if (entry_ptr == NULL) {
+ paramType = Other;
+ }
+ }
+#endif
+
+ popcount = 0;
+ _nc_reset_tparm(NULL);
+ /*
+ * Count the number of numeric parameters which are provided.
+ */
+ provided = 0;
+ for (narg = 1; narg < argc; ++narg) {
+ char *ending = NULL;
+ long check = strtol(argv[narg], &ending, 0);
+ if (check < 0 || ending == argv[narg] || *ending != '\0')
+ break;
+ provided = narg;
+ }
+ switch (paramType) {
+ case Str:
+ s = TPARM_1(s, strings[1]);
+ analyzed = 1;
+ if (provided == 0 && argc >= 1)
+ provided++;
+ break;
+ case Str_Str:
+ s = TPARM_2(s, strings[1], strings[2]);
+ analyzed = 2;
+ if (provided == 0 && argc >= 1)
+ provided++;
+ if (provided == 1 && argc >= 2)
+ provided++;
break;
- case 'T':
- use_env(FALSE);
- term = optarg;
+ case Num_Str:
+ s = TPARM_2(s, numbers[1], strings[2]);
+ analyzed = 2;
+ if (provided == 1 && argc >= 2)
+ provided++;
break;
+ case Num_Str_Str:
+ s = TPARM_3(s, numbers[1], strings[2], strings[3]);
+ analyzed = 3;
+ if (provided == 1 && argc >= 2)
+ provided++;
+ if (provided == 2 && argc >= 3)
+ provided++;
+ break;
+ case Numbers:
+ analyzed = _nc_tparm_analyze(NULL, s, p_is_s, &popcount);
+#define myParam(n) numbers[n]
+ s = TIPARM_9(s,
+ myParam(1),
+ myParam(2),
+ myParam(3),
+ myParam(4),
+ myParam(5),
+ myParam(6),
+ myParam(7),
+ myParam(8),
+ myParam(9));
+#undef myParam
+ break;
+ case Other:
+ /* FALLTHRU */
default:
- usage();
- /* NOTREACHED */
+ analyzed = _nc_tparm_analyze(NULL, s, p_is_s, &popcount);
+#define myParam(n) (p_is_s[n - 1] != 0 ? ((TPARM_ARG) strings[n]) : numbers[n])
+ s = TPARM_9(s,
+ myParam(1),
+ myParam(2),
+ myParam(3),
+ myParam(4),
+ myParam(5),
+ myParam(6),
+ myParam(7),
+ myParam(8),
+ myParam(9));
+#undef myParam
+ break;
}
- argc -= optind;
- argv += optind;
+ if (analyzed < popcount) {
+ analyzed = popcount;
+ }
+ if (opt_v && (analyzed != provided)) {
+ fprintf(stderr, "%s: %s parameters for \"%s\"\n",
+ _nc_progname,
+ (analyzed < provided ? "extra" : "missing"),
+ argv[0]);
+ }
+ *used += provided;
+ }
+
+ /* use putp() in order to perform padding */
+ putp(s);
+ return exit_code(STRING, 0);
+ }
+ return exit_code(STRING, 1);
+}
- if (cmdline && argc == 0) {
- usage();
- /* NOTREACHED */
+int
+main(int argc, char **argv)
+{
+ char *term;
+ int errret;
+ bool cmdline = TRUE;
+ int c;
+ char buf[BUFSIZ];
+ int result = 0;
+ int fd;
+ int used;
+ TTY old_settings;
+ TTY tty_settings;
+ bool is_alias;
+ bool need_tty;
+
+ _nc_progname = check_aliases(_nc_rootname(argv[0]), TRUE);
+ is_alias = (is_clear || is_reset || is_init);
+
+ term = getenv("TERM");
+
+ while ((c = getopt(argc, argv, is_alias ? "T:Vvx" : "ST:Vvx")) != -1) {
+ switch (c) {
+ case 'S':
+ cmdline = FALSE;
+ break;
+ case 'T':
+ use_env(FALSE);
+ use_tioctl(TRUE);
+ term = optarg;
+ break;
+ case 'V':
+ puts(curses_version());
+ ExitProgram(EXIT_SUCCESS);
+ case 'v': /* verbose */
+ opt_v = TRUE;
+ break;
+ case 'x': /* do not try to clear scrollback */
+ opt_x = TRUE;
+ break;
+ default:
+ usage(is_alias ? "TVx" : NULL);
+ /* NOTREACHED */
}
+ }
+
+ need_tty = ((is_reset || is_init) ||
+ (optind < argc &&
+ (!strcmp(argv[optind], "reset") ||
+ !strcmp(argv[optind], "init"))));
+
+ /*
+ * Modify the argument list to omit the options we processed.
+ */
+ if (is_alias) {
+ if (optind-- < argc) {
+ argc -= optind;
+ argv += optind;
+ }
+ argv[0] = strdup(_nc_progname);
+ } else {
+ argc -= optind;
+ argv += optind;
+ }
- if (term == NULL || *term == '\0')
- quit(2, "No value for $TERM and no -T specified");
+ if (term == 0 || *term == '\0')
+ quit(ErrUsage, "No value for $TERM and no -T specified");
- if (setupterm(term, STDOUT_FILENO, &errret) != OK)
- quit(3, "unknown terminal \"%s\"", term);
+ fd = save_tty_settings(&tty_settings, need_tty);
+ old_settings = tty_settings;
- if (cmdline)
- return tput(argc, argv);
+ if (setupterm(term, fd, &errret) != OK && errret <= 0)
+ quit(ErrTermType, "unknown terminal \"%s\"", term);
- while (fgets(buf, sizeof(buf), stdin) != (char *)NULL) {
- char *argvec[16]; /* command, 9 parms, null, & slop */
- int argnum = 0;
- char *cp;
+ if (cmdline) {
+ int code = 0;
+ if ((argc <= 0) && !is_alias)
+ usage(NULL);
+ while (argc > 0) {
+ tty_settings = old_settings;
+ code = tput_cmd(fd, &tty_settings, argc, argv, &used);
+ if (code != 0)
+ break;
+ argc -= used;
+ argv += used;
+ }
+ ExitProgram(code);
+ }
+
+ while (fgets(buf, sizeof(buf), stdin) != 0) {
+ size_t need = strlen(buf);
+ char **argvec = typeCalloc(char *, need + 1);
+ char **argnow;
+ int argnum = 0;
+ char *cp;
+
+ if (argvec == NULL) {
+ quit(ErrSystem(1), strerror(errno));
+ }
- /* crack the argument list into a dope vector */
- for (cp = buf; *cp; cp++) {
- if (isspace(*cp))
- *cp = '\0';
- else if (cp == buf || cp[-1] == 0)
- argvec[argnum++] = cp;
- }
- argvec[argnum] = (char *)NULL;
+ /* split the buffer into tokens */
+ for (cp = buf; *cp; cp++) {
+ if (isspace(UChar(*cp))) {
+ *cp = '\0';
+ } else if (cp == buf || cp[-1] == '\0') {
+ argvec[argnum++] = cp;
+ if (argnum >= (int) need)
+ break;
+ }
+ }
- if (tput(argnum, argvec) != 0)
- errors++;
+ argnow = argvec;
+ while (argnum > 0) {
+ int code;
+ tty_settings = old_settings;
+ code = tput_cmd(fd, &tty_settings, argnum, argnow, &used);
+ if (code != 0) {
+ if (result == 0)
+ result = ErrSystem(0); /* will return value >4 */
+ ++result;
+ }
+ argnum -= used;
+ argnow += used;
}
+ free(argvec);
+ }
- return errors > 0;
+ ExitProgram(result);
}
-