lib/libcurses/setterm.c

   1 /*      $NetBSD: setterm.c,v 1.47 2010/02/11 11:45:47 roy Exp $ */
   2
   3 /*
   4  * Copyright (c) 1981, 1993, 1994
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #include <sys/cdefs.h>
  33 #ifndef lint
  34 #if 0
  35 static char sccsid[] = "@(#)setterm.c   8.8 (Berkeley) 10/25/94";
  36 #else
  37 __RCSID("$NetBSD: setterm.c,v 1.47 2010/02/11 11:45:47 roy Exp $");
  38 #endif
  39 #endif /* not lint */
  40
  41 #include <sys/ioctl.h>          /* TIOCGWINSZ on old systems. */
  42
  43 #include <stdlib.h>
  44 #include <string.h>
  45 #include <termios.h>
  46 #include <unistd.h>
  47
  48 #include "curses.h"
  49 #include "curses_private.h"
  50
  51 static int does_esc_m(const char *cap);
  52 static int does_ctrl_o(const char *cap);
  53
  54 attr_t   __mask_op, __mask_me, __mask_ue, __mask_se;
  55
  56 int
  57 setterm(char *type)
  58 {
  59         return _cursesi_setterm(type, _cursesi_screen);
  60 }
  61
  62 int
  63 _cursesi_setterm(char *type, SCREEN *screen)
  64 {
  65         int unknown, r;
  66         struct winsize win;
  67         char *p;
  68
  69         if (type[0] == '\0')
  70                 type = "xx";
  71         unknown = 0;
  72         (void)ti_setupterm(&screen->term, type, fileno(screen->outfd), &r);
  73         if (screen->term == NULL) {
  74                 unknown++;
  75                 (void)ti_setupterm(&screen->term, "dumb",
  76                     fileno(screen->outfd), &r);
  77                 /* No dumb term? We can't continue */
  78                 if (screen->term == NULL)
  79                         return ERR;
  80         }
  81 #ifdef DEBUG
  82         __CTRACE(__CTRACE_INIT, "setterm: tty = %s\n", type);
  83 #endif
  84
  85         /* Try TIOCGWINSZ, and, if it fails, the termcap entry. */
  86         if (ioctl(fileno(screen->outfd), TIOCGWINSZ, &win) != -1 &&
  87             win.ws_row != 0 && win.ws_col != 0) {
  88                 screen->LINES = win.ws_row;
  89                 screen->COLS = win.ws_col;
  90         }  else {
  91                 if (unknown) {
  92                         screen->LINES = -1;
  93                         screen->COLS = -1;
  94                 } else {
  95                         screen->LINES = t_lines(screen->term);
  96                         screen->COLS = t_columns(screen->term);
  97                 }
  98
  99         }
 100
 101         /* POSIX 1003.2 requires that the environment override. */
 102         if ((p = getenv("LINES")) != NULL)
 103                 screen->LINES = (int) strtol(p, NULL, 0);
 104         if ((p = getenv("COLUMNS")) != NULL)
 105                 screen->COLS = (int) strtol(p, NULL, 0);
 106         if ((p = getenv("ESCDELAY")) != NULL)
 107                 ESCDELAY = (int) strtol(p, NULL, 0);
 108
 109         /*
 110          * Want cols > 4, otherwise things will fail.
 111          */
 112         if (screen->COLS <= 4)
 113                 return (ERR);
 114
 115         LINES = screen->LINES;
 116         COLS = screen->COLS;
 117
 118 #ifdef DEBUG
 119         __CTRACE(__CTRACE_INIT, "setterm: LINES = %d, COLS = %d\n",
 120             LINES, COLS);
 121 #endif
 122
 123         /*
 124          * set the pad char, only take the first char of the pc capability
 125          * as this is all we can use.
 126          */
 127         screen->padchar = t_pad_char(screen->term) ?
 128             t_pad_char(screen->term)[0] : 0;
 129
 130         /* Get full name of terminal */
 131         if (unknown) {
 132                 strcpy(screen->ttytype, "dumb");
 133                 return ERR;
 134         }
 135         if (screen->term->desc == NULL)
 136                 screen->ttytype[0] = '\0';
 137         else
 138                 strlcpy(screen->ttytype, screen->term->desc,
 139                     sizeof(screen->ttytype));
 140
 141         /* If no scrolling commands, no quick change. */
 142         screen->noqch =
 143             (t_change_scroll_region(screen->term) == NULL ||
 144                 t_cursor_home(screen->term) == NULL ||
 145                 (t_parm_index(screen->term) == NULL &&
 146                     t_scroll_forward(screen->term) == NULL) ||
 147                 (t_parm_rindex(screen->term) == NULL &&
 148                     t_scroll_reverse(screen->term) == NULL)) &&
 149             ((t_parm_insert_line(screen->term) == NULL &&
 150                 t_insert_line(screen->term) == NULL) ||
 151                 (t_parm_delete_line(screen->term) == NULL &&
 152                     t_delete_line(screen->term) == NULL));
 153
 154         /*
 155          * Precalculate conflict info for color/attribute end commands.
 156          */
 157 #ifndef HAVE_WCHAR
 158         screen->mask_op = __ATTRIBUTES & ~__COLOR;
 159 #else
 160         screen->mask_op = WA_ATTRIBUTES & ~__COLOR;
 161 #endif /* HAVE_WCHAR */
 162         if (t_orig_pair(screen->term) != NULL) {
 163                 if (does_esc_m(t_orig_pair(screen->term)))
 164                         screen->mask_op &=
 165                             ~(__STANDOUT | __UNDERSCORE | __TERMATTR);
 166                 else {
 167                         if (t_exit_standout_mode(screen->term) != NULL &&
 168                             !strcmp(t_orig_pair(screen->term),
 169                                 t_exit_standout_mode(screen->term)))
 170                                 screen->mask_op &= ~__STANDOUT;
 171                         if (t_exit_underline_mode(screen->term) != NULL &&
 172                             !strcmp(t_orig_pair(screen->term),
 173                                 t_exit_underline_mode(screen->term)))
 174                                 screen->mask_op &= ~__UNDERSCORE;
 175                         if (t_exit_attribute_mode(screen->term) != NULL &&
 176                             !strcmp(t_orig_pair(screen->term),
 177                                 t_exit_attribute_mode(screen->term)))
 178                                 screen->mask_op &= ~__TERMATTR;
 179                 }
 180         }
 181         /*
 182          * Assume that "me" turns off all attributes apart from ACS.
 183          * It might turn off ACS, so check for that.
 184          */
 185         if (t_exit_attribute_mode(screen->term) != NULL &&
 186             does_ctrl_o(t_exit_attribute_mode(screen->term)))
 187                 screen->mask_me = 0;
 188         else
 189                 screen->mask_me = __ALTCHARSET;
 190
 191         /* Check what turning off the attributes also turns off */
 192 #ifndef HAVE_WCHAR
 193         screen->mask_ue = __ATTRIBUTES & ~__UNDERSCORE;
 194 #else
 195         screen->mask_ue = WA_ATTRIBUTES & ~__UNDERSCORE;
 196 #endif /* HAVE_WCHAR */
 197         if (t_exit_underline_mode(screen->term) != NULL) {
 198                 if (does_esc_m(t_exit_underline_mode(screen->term)))
 199                         screen->mask_ue &=
 200                             ~(__STANDOUT | __TERMATTR | __COLOR);
 201                 else {
 202                         if (t_exit_standout_mode(screen->term) != NULL &&
 203                             !strcmp(t_exit_underline_mode(screen->term),
 204                                 t_exit_standout_mode(screen->term)))
 205                                 screen->mask_ue &= ~__STANDOUT;
 206                         if (t_exit_attribute_mode(screen->term) != NULL &&
 207                             !strcmp(t_exit_underline_mode(screen->term),
 208                                 t_exit_attribute_mode(screen->term)))
 209                                 screen->mask_ue &= ~__TERMATTR;
 210                         if (t_orig_pair(screen->term) != NULL &&
 211                             !strcmp(t_exit_underline_mode(screen->term),
 212                                 t_orig_pair(screen->term)))
 213                                 screen->mask_ue &= ~__COLOR;
 214                 }
 215         }
 216 #ifndef HAVE_WCHAR
 217         screen->mask_se = __ATTRIBUTES & ~__STANDOUT;
 218 #else
 219         screen->mask_se = WA_ATTRIBUTES & ~__STANDOUT;
 220 #endif /* HAVE_WCHAR */
 221         if (t_exit_standout_mode(screen->term) != NULL) {
 222                 if (does_esc_m(t_exit_standout_mode(screen->term)))
 223                         screen->mask_se &=
 224                             ~(__UNDERSCORE | __TERMATTR | __COLOR);
 225                 else {
 226                         if (t_exit_underline_mode(screen->term) != NULL &&
 227                             !strcmp(t_exit_standout_mode(screen->term),
 228                                 t_exit_underline_mode(screen->term)))
 229                                 screen->mask_se &= ~__UNDERSCORE;
 230                         if (t_exit_attribute_mode(screen->term) != NULL &&
 231                             !strcmp(t_exit_standout_mode(screen->term),
 232                                 t_exit_attribute_mode(screen->term)))
 233                                 screen->mask_se &= ~__TERMATTR;
 234                         if (t_orig_pair(screen->term) != NULL &&
 235                             !strcmp(t_exit_standout_mode(screen->term),
 236                                 t_orig_pair(screen->term)))
 237                                 screen->mask_se &= ~__COLOR;
 238                 }
 239         }
 240
 241         return (unknown ? ERR : OK);
 242 }
 243
 244 /*
 245  * _cursesi_resetterm --
 246  *  Copy the terminal instance data for the given screen to the global
 247  *  variables.
 248  */
 249 void
 250 _cursesi_resetterm(SCREEN *screen)
 251 {
 252
 253         LINES = screen->LINES;
 254         COLS = screen->COLS;
 255         __GT = screen->GT;
 256
 257         __noqch = screen->noqch;
 258         __mask_op = screen->mask_op;
 259         __mask_me = screen->mask_me;
 260         __mask_ue = screen->mask_ue;
 261         __mask_se = screen->mask_se;
 262
 263         set_curterm(screen->term);
 264 }
 265
 266 /*
 267  * does_esc_m --
 268  * A hack for xterm-like terminals where "\E[m" or "\E[0m" will turn off
 269  * other attributes, so we check for this in the capability passed to us.
 270  * Note that we can't just do simple string comparison, as the capability
 271  * may contain multiple, ';' separated sequence parts.
 272  */
 273 static int
 274 does_esc_m(const char *cap)
 275 {
 276 #define WAITING 0
 277 #define PARSING 1
 278 #define NUMBER 2
 279 #define FOUND 4
 280         const char *capptr;
 281         int seq;
 282
 283 #ifdef DEBUG
 284         __CTRACE(__CTRACE_INIT, "does_esc_m: Checking %s\n", cap);
 285 #endif
 286         /* Is it just "\E[m" or "\E[0m"? */
 287         if (!strcmp(cap, "\x1b[m") || !strcmp(cap, "\x1b[0m"))
 288                 return 1;
 289
 290         /* Does it contain a "\E[...m" sequence? */
 291         if (strlen(cap) < 4)
 292                 return 0;
 293         capptr = cap;
 294         seq = WAITING;
 295         while (*capptr != 0) {
 296                 switch (seq) {
 297                 /* Start of sequence */
 298                 case WAITING:
 299                         if (!strncmp(capptr, "\x1b[", 2)) {
 300                                 capptr+=2;
 301                                 if (*capptr == 'm')
 302                                         return 1;
 303                                 else {
 304                                         seq=PARSING;
 305                                         continue;
 306                                 }
 307                         }
 308                         break;
 309                 /* Looking for '0' */
 310                 case PARSING:
 311                         if (*capptr == '0')
 312                                 seq=FOUND;
 313                         else if (*capptr > '0' && *capptr <= '9')
 314                                 seq=NUMBER;
 315                         else if (*capptr != ';')
 316                                 seq=WAITING;
 317                         break;
 318                 /* Some other number */
 319                 case NUMBER:
 320                         if (*capptr == ';')
 321                                 seq=PARSING;
 322                         else if (!(*capptr >= '0' && *capptr <= '9'))
 323                                 seq=WAITING;
 324                         break;
 325                 /* Found a '0' */
 326                 case FOUND:
 327                         if (*capptr == 'm')
 328                                 return 1;
 329                         else if (!((*capptr >= '0' && *capptr <= '9') ||
 330                             *capptr == ';'))
 331                                 seq=WAITING;
 332                         break;
 333                 default:
 334                         break;
 335                 }
 336                 capptr++;
 337         }
 338         return 0;
 339 }
 340
 341 /*
 342  * does_ctrl_o --
 343  * A hack for vt100/xterm-like terminals where the "me" capability also
 344  * unsets acs (i.e. it contains the character '\017').
 345  */
 346 static int
 347 does_ctrl_o(const char *cap)
 348 {
 349         const char *capptr = cap;
 350
 351 #ifdef DEBUG
 352         __CTRACE(__CTRACE_INIT, "does_ctrl_o: Looping on %s\n", capptr);
 353 #endif
 354         while (*capptr != 0) {
 355                 if (*capptr == '\x0f')
 356                         return 1;
 357                 capptr++;
 358         }
 359         return 0;
 360 }