X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=progs%2Ftput.c;h=f9321b60a8d3f5c08a9afa45261e944b6d3d25e8;hp=0fde63407c5ce25f0e41abec5caf94c0646df027;hb=HEAD;hpb=c13e57306ae5c4431fddd0fe856c3bcae6aeeb2c diff --git a/progs/tput.c b/progs/tput.c index 0fde6340..f9321b60 100644 --- a/progs/tput.c +++ b/progs/tput.c @@ -1,5 +1,6 @@ /**************************************************************************** - * Copyright (c) 1998-2006,2007 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 * @@ -29,6 +30,7 @@ /**************************************************************************** * Author: Zeyd M. Ben-Halim 1992,1995 * * and: Eric S. Raymond * + * and: Thomas E. Dickey 1996-on * ****************************************************************************/ /* @@ -38,89 +40,92 @@ * Ross Ridge's mytinfo package. */ -#include +#include +#include +#include -#if !PURE_TERMINFO -#include -#endif #include +#include -MODULE_ID("$Id: tput.c,v 1.39 2007/07/14 19:31:08 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) -typedef enum { - Numbers = 0 - ,Num_Str - ,Num_Str_Str -} TParams; +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 char *prg_name; static bool is_init = FALSE; static bool is_reset = FALSE; +static bool is_clear = FALSE; -static void -quit(int status, const char *fmt,...) +static GCC_NORETURN void +quit(int status, const char *fmt, ...) { va_list argp; va_start(argp, fmt); - fprintf(stderr, "%s: ", prg_name); + fprintf(stderr, "%s: ", _nc_progname); vfprintf(stderr, fmt, argp); fprintf(stderr, "\n"); va_end(argp); ExitProgram(status); } -static void -usage(void) -{ - fprintf(stderr, "usage: %s [-V] [-S] [-T term] capname\n", prg_name); - ExitProgram(EXIT_FAILURE); -} - -static void -check_aliases(const char *name) -{ - is_init = (strcmp(name, PROG_INIT) == 0); - is_reset = (strcmp(name, PROG_RESET) == 0); -} - -/* - * Lookup the type of call we should make to tparm(). This ignores the actual - * terminfo capability (bad, because it is not extensible), but makes this - * code portable to platforms where sizeof(int) != sizeof(char *). - * - * FIXME: If we want extensibility, analyze the capability string as we do - * in tparm() to decide how to parse the varargs list. - */ -static TParams -tparm_type(const char *name) +static GCC_NORETURN void +usage(const char *optstring) { -#define TD(code, longname, ti, tc) {code,longname},{code,ti},{code,tc} - TParams result = Numbers; - /* *INDENT-OFF* */ - static const struct { - TParams code; - const char *name; - } table[] = { - TD(Num_Str, "pkey_key", "pfkey", "pk"), - TD(Num_Str, "pkey_local", "pfloc", "pl"), - TD(Num_Str, "pkey_xmit", "pfx", "px"), - TD(Num_Str, "plab_norm", "pln", "pn"), - TD(Num_Str_Str, "pkey_plab", "pfxl", "xl"), +#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\"") }; - /* *INDENT-ON* */ - - unsigned n; - for (n = 0; n < SIZEOF(table); n++) { - if (!strcmp(name, table[n].name)) { - result = table[n].code; - break; +#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 char * +check_aliases(char *name, bool program) +{ + 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; } @@ -143,118 +148,54 @@ exit_code(int token, int value) return result; } +/* + * Returns nonzero on error. + */ static int -tput(int argc, char *argv[]) +tput_cmd(int fd, TTY * settings, int argc, char **argv, int *used) { NCURSES_CONST char *name; char *s; - int i, j, c; int status; - FILE *f; +#if !PURE_TERMINFO + bool termcap = FALSE; +#endif - if ((name = argv[0]) == 0) - name = ""; - check_aliases(name); + name = check_aliases(argv[0], FALSE); + *used = 1; if (is_reset || is_init) { - if (init_prog != 0) { - system(init_prog); - } - FLUSH; + TTY oldmode = *settings; - if (is_reset && reset_1string != 0) { - PUTS(reset_1string); - } else if (init_1string != 0) { - PUTS(init_1string); - } - FLUSH; + int terasechar = -1; /* new erase character */ + int intrchar = -1; /* new interrupt character */ + int tkillchar = -1; /* new kill character */ - if (is_reset && reset_2string != 0) { - PUTS(reset_2string); - } else if (init_2string != 0) { - PUTS(init_2string); + if (is_reset) { + reset_start(stdout, TRUE, FALSE); + reset_tty_settings(fd, settings, FALSE); + } else { + reset_start(stdout, FALSE, TRUE); } - FLUSH; -#ifdef set_lr_margin - if (set_lr_margin != 0) { - PUTS(TPARM_2(set_lr_margin, 0, columns - 1)); - } else -#endif -#ifdef set_left_margin_parm - if (set_left_margin_parm != 0 - && set_right_margin_parm != 0) { - PUTS(TPARM_1(set_left_margin_parm, 0)); - PUTS(TPARM_1(set_right_margin_parm, columns - 1)); - } else -#endif - if (clear_margins != 0 - && set_left_margin != 0 - && set_right_margin != 0) { - PUTS(clear_margins); - if (carriage_return != 0) { - PUTS(carriage_return); - } else { - PUTCHAR('\r'); - } - PUTS(set_left_margin); - if (parm_right_cursor) { - PUTS(TPARM_1(parm_right_cursor, columns - 1)); - } else { - for (i = 0; i < columns - 1; i++) { - PUTCHAR(' '); - } - } - PUTS(set_right_margin); - if (carriage_return != 0) { - PUTS(carriage_return); - } else { - PUTCHAR('\r'); - } - } - FLUSH; - - if (init_tabs != 8) { - if (clear_all_tabs != 0 && set_tab != 0) { - for (i = 0; i < columns - 1; i += 8) { - if (parm_right_cursor) { - PUTS(TPARM_1(parm_right_cursor, 8)); - } else { - for (j = 0; j < 8; j++) - PUTCHAR(' '); - } - PUTS(set_tab); - } - FLUSH; - } +#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; } +#else + (void) fd; +#endif + set_control_chars(settings, terasechar, intrchar, tkillchar); + set_conversions(settings); - if (is_reset && reset_file != 0) { - f = fopen(reset_file, "r"); - if (f == 0) { - quit(4 + errno, "Can't open reset_file: '%s'", reset_file); - } - while ((c = fgetc(f)) != EOF) { - PUTCHAR(c); - } - fclose(f); - } else if (init_file != 0) { - f = fopen(init_file, "r"); - if (f == 0) { - quit(4 + errno, "Can't open init_file: '%s'", init_file); - } - while ((c = fgetc(f)) != EOF) { - PUTCHAR(c); - } - fclose(f); + if (send_init_strings(fd, &oldmode)) { + reset_flush(); } - FLUSH; - if (is_reset && reset_3string != 0) { - PUTS(reset_3string); - } else if (init_3string != 0) { - PUTS(init_3string); - } - FLUSH; + update_tty_settings(&oldmode, settings); return 0; } @@ -263,50 +204,58 @@ tput(int argc, char *argv[]) return 0; } #if !PURE_TERMINFO - { - const struct name_table_entry *np; + 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; - if ((np = _nc_find_entry(name, _nc_get_hash_table(1))) != 0) - switch (np->nte_type) { - case BOOLEAN: - if (bool_from_termcap[np->nte_index]) + 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; + break; - case NUMBER: - if (num_from_termcap[np->nte_index]) + case NUMBER: name = numnames[np->nte_index]; - break; + break; - case STRING: - if (str_from_termcap[np->nte_index]) + case STRING: name = strnames[np->nte_index]; - break; + break; + } + goto retry; } - } + } #endif - - 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) { - quit(4, "unknown terminfo capability '%s'", name); - } else if (s != ABSENT_STRING) { + 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++) { + for (k = 1; (k < argc) && (k <= NUM_PARM); k++) { char *tmp = 0; strings[k] = argv[k]; numbers[k] = strtol(argv[k], &tmp, 0); @@ -318,17 +267,82 @@ tput(int argc, char *argv[]) strings[k] = 0; } - switch (tparm_type(name)) { + 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 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: - (void) _nc_tparm_analyze(s, p_is_s, &popcount); -#define myParam(n) (p_is_s[n - 1] != 0 ? ((long) strings[n]) : numbers[n]) + 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), @@ -339,8 +353,19 @@ tput(int argc, char *argv[]) myParam(7), myParam(8), myParam(9)); +#undef myParam break; } + 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 */ @@ -359,78 +384,122 @@ main(int argc, char **argv) int c; char buf[BUFSIZ]; int result = 0; + int fd; + int used; + TTY old_settings; + TTY tty_settings; + bool is_alias; + bool need_tty; - check_aliases(prg_name = _nc_rootname(argv[0])); + _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, "ST:V")) != EOF) { + 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(); + 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_reset || is_init) { + if (is_alias) { if (optind-- < argc) { argc -= optind; argv += optind; } - argv[0] = prg_name; + argv[0] = strdup(_nc_progname); } else { argc -= optind; argv += optind; } if (term == 0 || *term == '\0') - quit(2, "No value for $TERM and no -T specified"); + quit(ErrUsage, "No value for $TERM and no -T specified"); + + fd = save_tty_settings(&tty_settings, need_tty); + old_settings = tty_settings; - if (setupterm(term, STDOUT_FILENO, &errret) != OK && errret <= 0) - quit(3, "unknown terminal \"%s\"", term); + if (setupterm(term, fd, &errret) != OK && errret <= 0) + quit(ErrTermType, "unknown terminal \"%s\"", term); if (cmdline) { - if ((argc <= 0) && !is_reset && !is_init) - usage(); - ExitProgram(tput(argc, argv)); + 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) { - char *argvec[16]; /* command, 9 parms, null, & slop */ + size_t need = strlen(buf); + char **argvec = typeCalloc(char *, need + 1); + char **argnow; int argnum = 0; char *cp; - /* crack the argument list into a dope vector */ + if (argvec == NULL) { + quit(ErrSystem(1), strerror(errno)); + } + + /* split the buffer into tokens */ for (cp = buf; *cp; cp++) { if (isspace(UChar(*cp))) { *cp = '\0'; - } else if (cp == buf || cp[-1] == 0) { + } else if (cp == buf || cp[-1] == '\0') { argvec[argnum++] = cp; - if (argnum >= (int) SIZEOF(argvec) - 1) + if (argnum >= (int) need) break; } } - argvec[argnum] = 0; - if (argnum != 0 - && tput(argnum, argvec) != 0) { - if (result == 0) - result = 4; /* will return value >4 */ - ++result; + 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); } ExitProgram(result);