progs/tput.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2007,2008 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  ****************************************************************************/
  33
  34 /*
  35  * tput.c -- shellscript access to terminal capabilities
  36  *
  37  * by Eric S. Raymond <esr@snark.thyrsus.com>, portions based on code from
  38  * Ross Ridge's mytinfo package.
  39  */
  40
  41 #define USE_LIBTINFO
  42 #include <progs.priv.h>
  43
  44 #if !PURE_TERMINFO
  45 #include <dump_entry.h>
  46 #include <termsort.c>
  47 #endif
  48 #include <transform.h>
  49
  50 MODULE_ID("$Id: tput.c,v 1.42 2008/07/13 11:05:12 tom Exp $")
  51
  52 #define PUTS(s)         fputs(s, stdout)
  53 #define PUTCHAR(c)      putchar(c)
  54 #define FLUSH           fflush(stdout)
  55
  56 typedef enum {
  57     Numbers = 0
  58     ,Num_Str
  59     ,Num_Str_Str
  60 } TParams;
  61
  62 static char *prg_name;
  63 static bool is_init = FALSE;
  64 static bool is_reset = FALSE;
  65
  66 static void
  67 quit(int status, const char *fmt,...)
  68 {
  69     va_list argp;
  70
  71     va_start(argp, fmt);
  72     fprintf(stderr, "%s: ", prg_name);
  73     vfprintf(stderr, fmt, argp);
  74     fprintf(stderr, "\n");
  75     va_end(argp);
  76     ExitProgram(status);
  77 }
  78
  79 static void
  80 usage(void)
  81 {
  82     fprintf(stderr, "usage: %s [-V] [-S] [-T term] capname\n", prg_name);
  83     ExitProgram(EXIT_FAILURE);
  84 }
  85
  86 static void
  87 check_aliases(const char *name)
  88 {
  89     is_init = (strcmp(name, PROG_INIT) == 0);
  90     is_reset = (strcmp(name, PROG_RESET) == 0);
  91 }
  92
  93 /*
  94  * Lookup the type of call we should make to tparm().  This ignores the actual
  95  * terminfo capability (bad, because it is not extensible), but makes this
  96  * code portable to platforms where sizeof(int) != sizeof(char *).
  97  *
  98  * FIXME: If we want extensibility, analyze the capability string as we do
  99  * in tparm() to decide how to parse the varargs list.
 100  */
 101 static TParams
 102 tparm_type(const char *name)
 103 {
 104 #define TD(code, longname, ti, tc) {code,longname},{code,ti},{code,tc}
 105     TParams result = Numbers;
 106     /* *INDENT-OFF* */
 107     static const struct {
 108         TParams code;
 109         const char *name;
 110     } table[] = {
 111         TD(Num_Str,     "pkey_key",     "pfkey",        "pk"),
 112         TD(Num_Str,     "pkey_local",   "pfloc",        "pl"),
 113         TD(Num_Str,     "pkey_xmit",    "pfx",          "px"),
 114         TD(Num_Str,     "plab_norm",    "pln",          "pn"),
 115         TD(Num_Str_Str, "pkey_plab",    "pfxl",         "xl"),
 116     };
 117     /* *INDENT-ON* */
 118
 119     unsigned n;
 120     for (n = 0; n < SIZEOF(table); n++) {
 121         if (!strcmp(name, table[n].name)) {
 122             result = table[n].code;
 123             break;
 124         }
 125     }
 126     return result;
 127 }
 128
 129 static int
 130 exit_code(int token, int value)
 131 {
 132     int result = 99;
 133
 134     switch (token) {
 135     case BOOLEAN:
 136         result = !value;        /* TRUE=0, FALSE=1 */
 137         break;
 138     case NUMBER:
 139         result = 0;             /* always zero */
 140         break;
 141     case STRING:
 142         result = value;         /* 0=normal, 1=missing */
 143         break;
 144     }
 145     return result;
 146 }
 147
 148 static int
 149 tput(int argc, char *argv[])
 150 {
 151     NCURSES_CONST char *name;
 152     char *s;
 153     int i, j, c;
 154     int status;
 155     FILE *f;
 156
 157     if ((name = argv[0]) == 0)
 158         name = "";
 159     check_aliases(name);
 160     if (is_reset || is_init) {
 161         if (init_prog != 0) {
 162             system(init_prog);
 163         }
 164         FLUSH;
 165
 166         if (is_reset && reset_1string != 0) {
 167             PUTS(reset_1string);
 168         } else if (init_1string != 0) {
 169             PUTS(init_1string);
 170         }
 171         FLUSH;
 172
 173         if (is_reset && reset_2string != 0) {
 174             PUTS(reset_2string);
 175         } else if (init_2string != 0) {
 176             PUTS(init_2string);
 177         }
 178         FLUSH;
 179
 180 #ifdef set_lr_margin
 181         if (set_lr_margin != 0) {
 182             PUTS(TPARM_2(set_lr_margin, 0, columns - 1));
 183         } else
 184 #endif
 185 #ifdef set_left_margin_parm
 186             if (set_left_margin_parm != 0
 187                 && set_right_margin_parm != 0) {
 188             PUTS(TPARM_1(set_left_margin_parm, 0));
 189             PUTS(TPARM_1(set_right_margin_parm, columns - 1));
 190         } else
 191 #endif
 192             if (clear_margins != 0
 193                 && set_left_margin != 0
 194                 && set_right_margin != 0) {
 195             PUTS(clear_margins);
 196             if (carriage_return != 0) {
 197                 PUTS(carriage_return);
 198             } else {
 199                 PUTCHAR('\r');
 200             }
 201             PUTS(set_left_margin);
 202             if (parm_right_cursor) {
 203                 PUTS(TPARM_1(parm_right_cursor, columns - 1));
 204             } else {
 205                 for (i = 0; i < columns - 1; i++) {
 206                     PUTCHAR(' ');
 207                 }
 208             }
 209             PUTS(set_right_margin);
 210             if (carriage_return != 0) {
 211                 PUTS(carriage_return);
 212             } else {
 213                 PUTCHAR('\r');
 214             }
 215         }
 216         FLUSH;
 217
 218         if (init_tabs != 8) {
 219             if (clear_all_tabs != 0 && set_tab != 0) {
 220                 for (i = 0; i < columns - 1; i += 8) {
 221                     if (parm_right_cursor) {
 222                         PUTS(TPARM_1(parm_right_cursor, 8));
 223                     } else {
 224                         for (j = 0; j < 8; j++)
 225                             PUTCHAR(' ');
 226                     }
 227                     PUTS(set_tab);
 228                 }
 229                 FLUSH;
 230             }
 231         }
 232
 233         if (is_reset && reset_file != 0) {
 234             f = fopen(reset_file, "r");
 235             if (f == 0) {
 236                 quit(4 + errno, "Can't open reset_file: '%s'", reset_file);
 237             }
 238             while ((c = fgetc(f)) != EOF) {
 239                 PUTCHAR(c);
 240             }
 241             fclose(f);
 242         } else if (init_file != 0) {
 243             f = fopen(init_file, "r");
 244             if (f == 0) {
 245                 quit(4 + errno, "Can't open init_file: '%s'", init_file);
 246             }
 247             while ((c = fgetc(f)) != EOF) {
 248                 PUTCHAR(c);
 249             }
 250             fclose(f);
 251         }
 252         FLUSH;
 253
 254         if (is_reset && reset_3string != 0) {
 255             PUTS(reset_3string);
 256         } else if (init_3string != 0) {
 257             PUTS(init_3string);
 258         }
 259         FLUSH;
 260         return 0;
 261     }
 262
 263     if (strcmp(name, "longname") == 0) {
 264         PUTS(longname());
 265         return 0;
 266     }
 267 #if !PURE_TERMINFO
 268     {
 269         const struct name_table_entry *np;
 270
 271         if ((np = _nc_find_entry(name, _nc_get_hash_table(1))) != 0)
 272             switch (np->nte_type) {
 273             case BOOLEAN:
 274                 if (bool_from_termcap[np->nte_index])
 275                     name = boolnames[np->nte_index];
 276                 break;
 277
 278             case NUMBER:
 279                 if (num_from_termcap[np->nte_index])
 280                     name = numnames[np->nte_index];
 281                 break;
 282
 283             case STRING:
 284                 if (str_from_termcap[np->nte_index])
 285                     name = strnames[np->nte_index];
 286                 break;
 287             }
 288     }
 289 #endif
 290
 291     if ((status = tigetflag(name)) != -1) {
 292         return exit_code(BOOLEAN, status);
 293     } else if ((status = tigetnum(name)) != CANCELLED_NUMERIC) {
 294         (void) printf("%d\n", status);
 295         return exit_code(NUMBER, 0);
 296     } else if ((s = tigetstr(name)) == CANCELLED_STRING) {
 297         quit(4, "unknown terminfo capability '%s'", name);
 298     } else if (s != ABSENT_STRING) {
 299         if (argc > 1) {
 300             int k;
 301             int popcount;
 302             long numbers[1 + NUM_PARM];
 303             char *strings[1 + NUM_PARM];
 304             char *p_is_s[NUM_PARM];
 305
 306             /* Nasty hack time. The tparm function needs to see numeric
 307              * parameters as numbers, not as pointers to their string
 308              * representations
 309              */
 310
 311             for (k = 1; k < argc; k++) {
 312                 char *tmp = 0;
 313                 strings[k] = argv[k];
 314                 numbers[k] = strtol(argv[k], &tmp, 0);
 315                 if (tmp == 0 || *tmp != 0)
 316                     numbers[k] = 0;
 317             }
 318             for (k = argc; k <= NUM_PARM; k++) {
 319                 numbers[k] = 0;
 320                 strings[k] = 0;
 321             }
 322
 323             switch (tparm_type(name)) {
 324             case Num_Str:
 325                 s = TPARM_2(s, numbers[1], strings[2]);
 326                 break;
 327             case Num_Str_Str:
 328                 s = TPARM_3(s, numbers[1], strings[2], strings[3]);
 329                 break;
 330             case Numbers:
 331             default:
 332                 (void) _nc_tparm_analyze(s, p_is_s, &popcount);
 333 #define myParam(n) (p_is_s[n - 1] != 0 ? ((long) strings[n]) : numbers[n])
 334                 s = TPARM_9(s,
 335                             myParam(1),
 336                             myParam(2),
 337                             myParam(3),
 338                             myParam(4),
 339                             myParam(5),
 340                             myParam(6),
 341                             myParam(7),
 342                             myParam(8),
 343                             myParam(9));
 344                 break;
 345             }
 346         }
 347
 348         /* use putp() in order to perform padding */
 349         putp(s);
 350         return exit_code(STRING, 0);
 351     }
 352     return exit_code(STRING, 1);
 353 }
 354
 355 int
 356 main(int argc, char **argv)
 357 {
 358     char *term;
 359     int errret;
 360     bool cmdline = TRUE;
 361     int c;
 362     char buf[BUFSIZ];
 363     int result = 0;
 364
 365     check_aliases(prg_name = _nc_rootname(argv[0]));
 366
 367     term = getenv("TERM");
 368
 369     while ((c = getopt(argc, argv, "ST:V")) != -1) {
 370         switch (c) {
 371         case 'S':
 372             cmdline = FALSE;
 373             break;
 374         case 'T':
 375             use_env(FALSE);
 376             term = optarg;
 377             break;
 378         case 'V':
 379             puts(curses_version());
 380             ExitProgram(EXIT_SUCCESS);
 381         default:
 382             usage();
 383             /* NOTREACHED */
 384         }
 385     }
 386
 387     /*
 388      * Modify the argument list to omit the options we processed.
 389      */
 390     if (is_reset || is_init) {
 391         if (optind-- < argc) {
 392             argc -= optind;
 393             argv += optind;
 394         }
 395         argv[0] = prg_name;
 396     } else {
 397         argc -= optind;
 398         argv += optind;
 399     }
 400
 401     if (term == 0 || *term == '\0')
 402         quit(2, "No value for $TERM and no -T specified");
 403
 404     if (setupterm(term, STDOUT_FILENO, &errret) != OK && errret <= 0)
 405         quit(3, "unknown terminal \"%s\"", term);
 406
 407     if (cmdline) {
 408         if ((argc <= 0) && !is_reset && !is_init)
 409             usage();
 410         ExitProgram(tput(argc, argv));
 411     }
 412
 413     while (fgets(buf, sizeof(buf), stdin) != 0) {
 414         char *argvec[16];       /* command, 9 parms, null, & slop */
 415         int argnum = 0;
 416         char *cp;
 417
 418         /* crack the argument list into a dope vector */
 419         for (cp = buf; *cp; cp++) {
 420             if (isspace(UChar(*cp))) {
 421                 *cp = '\0';
 422             } else if (cp == buf || cp[-1] == 0) {
 423                 argvec[argnum++] = cp;
 424                 if (argnum >= (int) SIZEOF(argvec) - 1)
 425                     break;
 426             }
 427         }
 428         argvec[argnum] = 0;
 429
 430         if (argnum != 0
 431             && tput(argnum, argvec) != 0) {
 432             if (result == 0)
 433                 result = 4;     /* will return value >4 */
 434             ++result;
 435         }
 436     }
 437
 438     ExitProgram(result);
 439 }