ncurses/tinfo/tinfo_driver.c

   1 /****************************************************************************
   2  * Copyright (c) 2008-2009,2010 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: Juergen Pfeifer                                                 *
  31  *                                                                          *
  32  ****************************************************************************/
  33
  34 #include <curses.priv.h>
  35 #define CUR ((TERMINAL*)TCB)->type.
  36 #include <tic.h>
  37
  38 #if HAVE_NANOSLEEP
  39 #include <time.h>
  40 #if HAVE_SYS_TIME_H
  41 #include <sys/time.h>           /* needed for MacOS X DP3 */
  42 #endif
  43 #endif
  44
  45 #if HAVE_SIZECHANGE
  46 # if !defined(sun) || !TERMIOS
  47 #  if HAVE_SYS_IOCTL_H
  48 #   include <sys/ioctl.h>
  49 #  endif
  50 # endif
  51 #endif
  52
  53 MODULE_ID("$Id: tinfo_driver.c,v 1.8 2010/04/03 14:10:56 tom Exp $")
  54
  55 /*
  56  * SCO defines TIOCGSIZE and the corresponding struct.  Other systems (SunOS,
  57  * Solaris, IRIX) define TIOCGWINSZ and struct winsize.
  58  */
  59 #ifdef TIOCGSIZE
  60 # define IOCTL_WINSIZE TIOCGSIZE
  61 # define STRUCT_WINSIZE struct ttysize
  62 # define WINSIZE_ROWS(n) (int)n.ts_lines
  63 # define WINSIZE_COLS(n) (int)n.ts_cols
  64 #else
  65 # ifdef TIOCGWINSZ
  66 #  define IOCTL_WINSIZE TIOCGWINSZ
  67 #  define STRUCT_WINSIZE struct winsize
  68 #  define WINSIZE_ROWS(n) (int)n.ws_row
  69 #  define WINSIZE_COLS(n) (int)n.ws_col
  70 # endif
  71 #endif
  72
  73 /*
  74  * These should be screen structure members.  They need to be globals for
  75  * historical reasons.  So we assign them in start_color() and also in
  76  * set_term()'s screen-switching logic.
  77  */
  78 #if USE_REENTRANT
  79 NCURSES_EXPORT(int)
  80 NCURSES_PUBLIC_VAR(COLOR_PAIRS) (void)
  81 {
  82     return CURRENT_SCREEN ? CURRENT_SCREEN->_pair_count : -1;
  83 }
  84 NCURSES_EXPORT(int)
  85 NCURSES_PUBLIC_VAR(COLORS) (void)
  86 {
  87     return CURRENT_SCREEN ? CURRENT_SCREEN->_color_count : -1;
  88 }
  89 #else
  90 NCURSES_EXPORT_VAR(int) COLOR_PAIRS = 0;
  91 NCURSES_EXPORT_VAR(int) COLORS = 0;
  92 #endif
  93
  94 #define TCBMAGIC NCDRV_MAGIC(NCDRV_TINFO)
  95 #define AssertTCB() assert(TCB!=0 && TCB->magic==TCBMAGIC)
  96 #define SetSP() assert(TCB->csp!=0); sp = TCB->csp
  97
  98 /*
  99  * This routine needs to do all the work to make curscr look
 100  * like newscr.
 101  */
 102 static int
 103 drv_doupdate(TERMINAL_CONTROL_BLOCK * TCB)
 104 {
 105     AssertTCB();
 106     return TINFO_DOUPDATE(TCB->csp);
 107 }
 108
 109 #define ret_error(code, fmt, arg)       if (errret) {\
 110                                             *errret = code;\
 111                                             return(FALSE); \
 112                                         } else {\
 113                                             fprintf(stderr, fmt, arg);\
 114                                             exit(EXIT_FAILURE);\
 115                                         }
 116
 117 #define ret_error0(code, msg)           if (errret) {\
 118                                             *errret = code;\
 119                                             return(FALSE);\
 120                                         } else {\
 121                                             fprintf(stderr, msg);\
 122                                             exit(EXIT_FAILURE);\
 123                                         }
 124
 125 #if USE_DATABASE || USE_TERMCAP
 126 /*
 127  * Return 1 if entry found, 0 if not found, -1 if database not accessible,
 128  * just like tgetent().
 129  */
 130 static int
 131 grab_entry(const char *const tn, TERMTYPE *const tp)
 132 {
 133     char filename[PATH_MAX];
 134     int status = _nc_read_entry(tn, filename, tp);
 135
 136     /*
 137      * If we have an entry, force all of the cancelled strings to null
 138      * pointers so we don't have to test them in the rest of the library.
 139      * (The terminfo compiler bypasses this logic, since it must know if
 140      * a string is cancelled, for merging entries).
 141      */
 142     if (status == TGETENT_YES) {
 143         unsigned n;
 144         for_each_boolean(n, tp) {
 145             if (!VALID_BOOLEAN(tp->Booleans[n]))
 146                 tp->Booleans[n] = FALSE;
 147         }
 148         for_each_string(n, tp) {
 149             if (tp->Strings[n] == CANCELLED_STRING)
 150                 tp->Strings[n] = ABSENT_STRING;
 151         }
 152     }
 153     return (status);
 154 }
 155 #endif
 156
 157 static bool
 158 drv_CanHandle(TERMINAL_CONTROL_BLOCK * TCB, const char *tname, int *errret)
 159 {
 160     bool result = FALSE;
 161     int status;
 162     TERMINAL *termp;
 163     SCREEN *sp;
 164
 165     assert(TCB != 0 && tname != 0);
 166     termp = (TERMINAL *) TCB;
 167     sp = TCB->csp;
 168     TCB->magic = TCBMAGIC;
 169
 170 #if (USE_DATABASE || USE_TERMCAP)
 171     status = grab_entry(tname, &termp->type);
 172 #else
 173     status = TGETENT_NO;
 174 #endif
 175
 176     /* try fallback list if entry on disk */
 177     if (status != TGETENT_YES) {
 178         const TERMTYPE *fallback = _nc_fallback(tname);
 179
 180         if (fallback) {
 181             termp->type = *fallback;
 182             status = TGETENT_YES;
 183         }
 184     }
 185
 186     if (status != TGETENT_YES) {
 187         NCURSES_SP_NAME(del_curterm) (NCURSES_SP_ARGx termp);
 188         if (status == TGETENT_ERR) {
 189             ret_error0(status, "terminals database is inaccessible\n");
 190         } else if (status == TGETENT_NO) {
 191             ret_error(status, "'%s': unknown terminal type.\n", tname);
 192         }
 193     }
 194     result = TRUE;
 195 #if !USE_REENTRANT
 196     strncpy(ttytype, termp->type.term_names, NAMESIZE - 1);
 197     ttytype[NAMESIZE - 1] = '\0';
 198 #endif
 199
 200     if (command_character)
 201         _nc_tinfo_cmdch(termp, *command_character);
 202
 203     if (generic_type) {
 204         ret_error(TGETENT_NO, "'%s': I need something more specific.\n", tname);
 205     }
 206     if (hard_copy) {
 207         ret_error(TGETENT_YES, "'%s': I can't handle hardcopy terminals.\n", tname);
 208     }
 209
 210     return result;
 211 }
 212
 213 static int
 214 drv_dobeepflash(TERMINAL_CONTROL_BLOCK * TCB, bool beepFlag)
 215 {
 216     SCREEN *sp;
 217     int res = ERR;
 218
 219     AssertTCB();
 220     SetSP();
 221
 222     /* FIXME: should make sure that we are not in altchar mode */
 223     if (beepFlag) {
 224         if (bell) {
 225             res = NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx "bell", bell);
 226             NCURSES_SP_NAME(_nc_flush) (sp);
 227         } else if (flash_screen) {
 228             res = NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
 229                                              "flash_screen",
 230                                              flash_screen);
 231             NCURSES_SP_NAME(_nc_flush) (sp);
 232         }
 233     } else {
 234         if (flash_screen) {
 235             res = NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
 236                                              "flash_screen",
 237                                              flash_screen);
 238             NCURSES_SP_NAME(_nc_flush) (sp);
 239         } else if (bell) {
 240             res = NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx "bell", bell);
 241             NCURSES_SP_NAME(_nc_flush) (sp);
 242         }
 243     }
 244     return res;
 245 }
 246
 247 /*
 248  * SVr4 curses is known to interchange color codes (1,4) and (3,6), possibly
 249  * to maintain compatibility with a pre-ANSI scheme.  The same scheme is
 250  * also used in the FreeBSD syscons.
 251  */
 252 static int
 253 toggled_colors(int c)
 254 {
 255     if (c < 16) {
 256         static const int table[] =
 257         {0, 4, 2, 6, 1, 5, 3, 7,
 258          8, 12, 10, 14, 9, 13, 11, 15};
 259         c = table[c];
 260     }
 261     return c;
 262 }
 263
 264 static int
 265 drv_print(TERMINAL_CONTROL_BLOCK * TCB, char *data, int len)
 266 {
 267     SCREEN *sp;
 268
 269     AssertTCB();
 270     SetSP();
 271 #if NCURSES_EXT_FUNCS
 272     return NCURSES_SP_NAME(mcprint) (TCB->csp, data, len);
 273 #else
 274     return ERR;
 275 #endif
 276 }
 277
 278 static int
 279 drv_defaultcolors(TERMINAL_CONTROL_BLOCK * TCB, int fg, int bg)
 280 {
 281     SCREEN *sp;
 282     int code = ERR;
 283
 284     AssertTCB();
 285     SetSP();
 286
 287     if (sp != 0 && orig_pair && orig_colors && (initialize_pair != 0)) {
 288 #if NCURSES_EXT_FUNCS
 289         sp->_default_color = isDefaultColor(fg) || isDefaultColor(bg);
 290         sp->_has_sgr_39_49 = (NCURSES_SP_NAME(tigetflag) (NCURSES_SP_ARGx
 291                                                           "AX")
 292                               == TRUE);
 293         sp->_default_fg = isDefaultColor(fg) ? COLOR_DEFAULT : (fg & C_MASK);
 294         sp->_default_bg = isDefaultColor(bg) ? COLOR_DEFAULT : (bg & C_MASK);
 295         if (sp->_color_pairs != 0) {
 296             bool save = sp->_default_color;
 297             sp->_default_color = TRUE;
 298             NCURSES_SP_NAME(init_pair) (NCURSES_SP_ARGx
 299                                         0,
 300                                         (short)fg,
 301                                         (short)bg);
 302             sp->_default_color = save;
 303         }
 304 #endif
 305         code = OK;
 306     }
 307     return (code);
 308 }
 309
 310 static void
 311 drv_setcolor(TERMINAL_CONTROL_BLOCK * TCB,
 312              bool fore,
 313              int color,
 314              NCURSES_SP_OUTC outc)
 315 {
 316     SCREEN *sp;
 317
 318     AssertTCB();
 319     SetSP();
 320
 321     if (fore) {
 322         if (set_a_foreground) {
 323             TPUTS_TRACE("set_a_foreground");
 324             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
 325                                     TPARM_1(set_a_foreground, color), 1, outc);
 326         } else {
 327             TPUTS_TRACE("set_foreground");
 328             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
 329                                     TPARM_1(set_foreground,
 330                                             toggled_colors(color)), 1, outc);
 331         }
 332     } else {
 333         if (set_a_background) {
 334             TPUTS_TRACE("set_a_background");
 335             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
 336                                     TPARM_1(set_a_background, color), 1, outc);
 337         } else {
 338             TPUTS_TRACE("set_background");
 339             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
 340                                     TPARM_1(set_background,
 341                                             toggled_colors(color)), 1, outc);
 342         }
 343     }
 344 }
 345
 346 static bool
 347 drv_rescol(TERMINAL_CONTROL_BLOCK * TCB)
 348 {
 349     bool result = FALSE;
 350     SCREEN *sp;
 351
 352     AssertTCB();
 353     SetSP();
 354
 355     if (orig_pair != 0) {
 356         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx "orig_pair", orig_pair);
 357         result = TRUE;
 358     }
 359     return result;
 360 }
 361
 362 static bool
 363 drv_rescolors(TERMINAL_CONTROL_BLOCK * TCB)
 364 {
 365     int result = FALSE;
 366     SCREEN *sp;
 367
 368     AssertTCB();
 369     SetSP();
 370
 371     if (orig_colors != 0) {
 372         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx "orig_colors", orig_colors);
 373         result = TRUE;
 374     }
 375     return result;
 376 }
 377
 378 static int
 379 drv_size(TERMINAL_CONTROL_BLOCK * TCB, int *linep, int *colp)
 380 {
 381     SCREEN *sp;
 382     bool useEnv = TRUE;
 383
 384     AssertTCB();
 385     sp = TCB->csp;              /* can be null here */
 386
 387     if (sp) {
 388         useEnv = sp->_use_env;
 389     } else
 390         useEnv = _nc_prescreen.use_env;
 391
 392     /* figure out the size of the screen */
 393     T(("screen size: terminfo lines = %d columns = %d", lines, columns));
 394
 395     *linep = (int) lines;
 396     *colp = (int) columns;
 397
 398     if (useEnv) {
 399         int value;
 400
 401 #ifdef __EMX__
 402         {
 403             int screendata[2];
 404             _scrsize(screendata);
 405             *colp = screendata[0];
 406             *linep = screendata[1];
 407             T(("EMX screen size: environment LINES = %d COLUMNS = %d",
 408                *linep, *colp));
 409         }
 410 #endif
 411 #if HAVE_SIZECHANGE
 412         /* try asking the OS */
 413         {
 414             TERMINAL *termp = (TERMINAL *) TCB;
 415             if (isatty(termp->Filedes)) {
 416                 STRUCT_WINSIZE size;
 417
 418                 errno = 0;
 419                 do {
 420                     if (ioctl(termp->Filedes, IOCTL_WINSIZE, &size) >= 0) {
 421                         *linep = ((sp != 0 && sp->_filtered)
 422                                   ? 1
 423                                   : WINSIZE_ROWS(size));
 424                         *colp = WINSIZE_COLS(size);
 425                         T(("SYS screen size: environment LINES = %d COLUMNS = %d",
 426                            *linep, *colp));
 427                         break;
 428                     }
 429                 } while
 430                     (errno == EINTR);
 431             }
 432         }
 433 #endif /* HAVE_SIZECHANGE */
 434
 435         /*
 436          * Finally, look for environment variables.
 437          *
 438          * Solaris lets users override either dimension with an environment
 439          * variable.
 440          */
 441         if ((value = _nc_getenv_num("LINES")) > 0) {
 442             *linep = value;
 443             T(("screen size: environment LINES = %d", *linep));
 444         }
 445         if ((value = _nc_getenv_num("COLUMNS")) > 0) {
 446             *colp = value;
 447             T(("screen size: environment COLUMNS = %d", *colp));
 448         }
 449
 450         /* if we can't get dynamic info about the size, use static */
 451         if (*linep <= 0) {
 452             *linep = (int) lines;
 453         }
 454         if (*colp <= 0) {
 455             *colp = (int) columns;
 456         }
 457
 458         /* the ultimate fallback, assume fixed 24x80 size */
 459         if (*linep <= 0) {
 460             *linep = 24;
 461         }
 462         if (*colp <= 0) {
 463             *colp = 80;
 464         }
 465
 466         /*
 467          * Put the derived values back in the screen-size caps, so
 468          * tigetnum() and tgetnum() will do the right thing.
 469          */
 470         lines = (short) (*linep);
 471         columns = (short) (*colp);
 472     }
 473
 474     T(("screen size is %dx%d", *linep, *colp));
 475     return OK;
 476 }
 477
 478 static int
 479 drv_getsize(TERMINAL_CONTROL_BLOCK * TCB, int *l, int *c)
 480 {
 481     AssertTCB();
 482     assert(l != 0 && c != 0);
 483     *l = lines;
 484     *c = columns;
 485     return OK;
 486 }
 487
 488 static int
 489 drv_setsize(TERMINAL_CONTROL_BLOCK * TCB, int l, int c)
 490 {
 491     AssertTCB();
 492     lines = (short) l;
 493     columns = (short) c;
 494     return OK;
 495 }
 496
 497 static int
 498 drv_sgmode(TERMINAL_CONTROL_BLOCK * TCB, bool setFlag, TTY * buf)
 499 {
 500     SCREEN *sp = TCB->csp;
 501     TERMINAL *_term = (TERMINAL *) TCB;
 502     int result = OK;
 503
 504     AssertTCB();
 505     if (setFlag) {
 506         for (;;) {
 507             if (SET_TTY(_term->Filedes, buf) != 0) {
 508                 if (errno == EINTR)
 509                     continue;
 510                 if (errno == ENOTTY) {
 511                     if (sp)
 512                         sp->_notty = TRUE;
 513                 }
 514                 result = ERR;
 515             }
 516             break;
 517         }
 518     } else {
 519         for (;;) {
 520             if (GET_TTY(_term->Filedes, buf) != 0) {
 521                 if (errno == EINTR)
 522                     continue;
 523                 result = ERR;
 524             }
 525             break;
 526         }
 527     }
 528     return result;
 529 }
 530
 531 static int
 532 drv_mode(TERMINAL_CONTROL_BLOCK * TCB, bool progFlag, bool defFlag)
 533 {
 534     SCREEN *sp;
 535     TERMINAL *_term = (TERMINAL *) TCB;
 536     int code = ERR;
 537
 538     AssertTCB();
 539     sp = TCB->csp;
 540
 541     if (progFlag)               /* prog mode */
 542     {
 543         if (defFlag) {
 544             /* def_prog_mode */
 545             /*
 546              * Turn off the XTABS bit in the tty structure if it was on.
 547              */
 548             if ((drv_sgmode(TCB, FALSE, &(_term->Nttyb)) == OK)) {
 549 #ifdef TERMIOS
 550                 _term->Nttyb.c_oflag &= ~OFLAGS_TABS;
 551 #else
 552                 _term->Nttyb.sg_flags &= ~XTABS;
 553 #endif
 554                 code = OK;
 555             }
 556         } else {
 557             /* reset_prog_mode */
 558             if (drv_sgmode(TCB, TRUE, &(_term->Nttyb)) == OK) {
 559                 if (sp) {
 560                     if (sp->_keypad_on)
 561                         _nc_keypad(sp, TRUE);
 562                     NC_BUFFERED(sp, TRUE);
 563                 }
 564                 code = OK;
 565             }
 566         }
 567     } else {                    /* shell mode */
 568         if (defFlag) {
 569             /* def_shell_mode */
 570             /*
 571              * If XTABS was on, remove the tab and backtab capabilities.
 572              */
 573             if (drv_sgmode(TCB, FALSE, &(_term->Ottyb)) == OK) {
 574 #ifdef TERMIOS
 575                 if (_term->Ottyb.c_oflag & OFLAGS_TABS)
 576                     tab = back_tab = NULL;
 577 #else
 578                 if (_term->Ottyb.sg_flags & XTABS)
 579                     tab = back_tab = NULL;
 580 #endif
 581                 code = OK;
 582             }
 583         } else {
 584             /* reset_shell_mode */
 585             if (sp) {
 586                 _nc_keypad(sp, FALSE);
 587                 NCURSES_SP_NAME(_nc_flush) (sp);
 588                 NC_BUFFERED(sp, FALSE);
 589             }
 590             code = drv_sgmode(TCB, TRUE, &(_term->Ottyb));
 591         }
 592     }
 593     return (code);
 594 }
 595
 596 static void
 597 drv_wrap(SCREEN *sp)
 598 {
 599     if (sp) {
 600         sp->_mouse_wrap(sp);
 601         NCURSES_SP_NAME(_nc_screen_wrap) (sp);
 602         NCURSES_SP_NAME(_nc_mvcur_wrap) (sp);   /* wrap up cursor addressing */
 603     }
 604 }
 605
 606 static void
 607 drv_release(TERMINAL_CONTROL_BLOCK * TCB GCC_UNUSED)
 608 {
 609 }
 610
 611 #  define SGR0_TEST(mode) (mode != 0) && (exit_attribute_mode == 0 || strcmp(mode, exit_attribute_mode))
 612
 613 static void
 614 drv_screen_init(SCREEN *sp)
 615 {
 616     TERMINAL_CONTROL_BLOCK *TCB = TCBOf(sp);
 617
 618     AssertTCB();
 619
 620     /*
 621      * Check for mismatched graphic-rendition capabilities.  Most SVr4
 622      * terminfo trees contain entries that have rmul or rmso equated to
 623      * sgr0 (Solaris curses copes with those entries).  We do this only
 624      * for curses, since many termcap applications assume that
 625      * smso/rmso and smul/rmul are paired, and will not function
 626      * properly if we remove rmso or rmul.  Curses applications
 627      * shouldn't be looking at this detail.
 628      */
 629     sp->_use_rmso = SGR0_TEST(exit_standout_mode);
 630     sp->_use_rmul = SGR0_TEST(exit_underline_mode);
 631
 632     /*
 633      * Check whether we can optimize scrolling under dumb terminals in
 634      * case we do not have any of these capabilities, scrolling
 635      * optimization will be useless.
 636      */
 637     sp->_scrolling = ((scroll_forward && scroll_reverse) ||
 638                       ((parm_rindex ||
 639                         parm_insert_line ||
 640                         insert_line) &&
 641                        (parm_index ||
 642                         parm_delete_line ||
 643                         delete_line)));
 644
 645     NCURSES_SP_NAME(baudrate) (sp);
 646
 647     NCURSES_SP_NAME(_nc_mvcur_init) (sp);
 648     /* initialize terminal to a sane state */
 649     NCURSES_SP_NAME(_nc_screen_init) (sp);
 650 }
 651
 652 static void
 653 drv_init(TERMINAL_CONTROL_BLOCK * TCB)
 654 {
 655     SCREEN *sp;
 656     TERMINAL *trm;
 657
 658     AssertTCB();
 659
 660     trm = (TERMINAL *) TCB;
 661     sp = TCB->csp;
 662
 663     TCB->info.initcolor = initialize_color;
 664     TCB->info.canchange = can_change;
 665     TCB->info.hascolor = ((VALID_NUMERIC(max_colors) && VALID_NUMERIC(max_pairs)
 666                            && (((set_foreground != NULL)
 667                                 && (set_background != NULL))
 668                                || ((set_a_foreground != NULL)
 669                                    && (set_a_background != NULL))
 670                                || set_color_pair)) ? TRUE : FALSE);
 671
 672     TCB->info.caninit = !(exit_ca_mode && non_rev_rmcup);
 673
 674     TCB->info.maxpairs = VALID_NUMERIC(max_pairs) ? max_pairs : 0;
 675     TCB->info.maxcolors = VALID_NUMERIC(max_colors) ? max_colors : 0;
 676     TCB->info.numlabels = VALID_NUMERIC(num_labels) ? num_labels : 0;
 677     TCB->info.labelwidth = VALID_NUMERIC(label_width) ? label_width : 0;
 678     TCB->info.labelheight = VALID_NUMERIC(label_height) ? label_height : 0;
 679     TCB->info.nocolorvideo = VALID_NUMERIC(no_color_video) ? no_color_video
 680         : 0;
 681     TCB->info.tabsize = VALID_NUMERIC(init_tabs) ? (int) init_tabs : 8;
 682
 683     TCB->info.defaultPalette = hue_lightness_saturation ? _nc_hls_palette : _nc_cga_palette;
 684
 685     /*
 686      * If an application calls setupterm() rather than initscr() or
 687      * newterm(), we will not have the def_prog_mode() call in
 688      * _nc_setupscreen().  Do it now anyway, so we can initialize the
 689      * baudrate.
 690      */
 691     if (isatty(trm->Filedes)) {
 692         TCB->drv->mode(TCB, TRUE, TRUE);
 693     }
 694 }
 695
 696 #define MAX_PALETTE     8
 697 #define InPalette(n)    ((n) >= 0 && (n) < MAX_PALETTE)
 698
 699 static void
 700 drv_initpair(TERMINAL_CONTROL_BLOCK * TCB, short pair, short f, short b)
 701 {
 702     SCREEN *sp;
 703
 704     AssertTCB();
 705     SetSP();
 706
 707     if ((initialize_pair != NULL) && InPalette(f) && InPalette(b)) {
 708         const color_t *tp = InfoOf(sp).defaultPalette;
 709
 710         TR(TRACE_ATTRS,
 711            ("initializing pair: pair = %d, fg=(%d,%d,%d), bg=(%d,%d,%d)",
 712             pair,
 713             tp[f].red, tp[f].green, tp[f].blue,
 714             tp[b].red, tp[b].green, tp[b].blue));
 715
 716         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
 717                                    "initialize_pair",
 718                                    TPARM_7(initialize_pair,
 719                                            pair,
 720                                            tp[f].red, tp[f].green, tp[f].blue,
 721                                            tp[b].red, tp[b].green, tp[b].blue));
 722     }
 723 }
 724
 725 static int
 726 default_fg(SCREEN *sp)
 727 {
 728 #if NCURSES_EXT_FUNCS
 729     return (sp != 0) ? sp->_default_fg : COLOR_WHITE;
 730 #else
 731     return COLOR_WHITE;
 732 #endif
 733 }
 734
 735 static int
 736 default_bg(SCREEN *sp)
 737 {
 738 #if NCURSES_EXT_FUNCS
 739     return sp != 0 ? sp->_default_bg : COLOR_BLACK;
 740 #else
 741     return COLOR_BLACK;
 742 #endif
 743 }
 744
 745 static void
 746 drv_initcolor(TERMINAL_CONTROL_BLOCK * TCB,
 747               short color, short r, short g, short b)
 748 {
 749     SCREEN *sp = TCB->csp;
 750
 751     AssertTCB();
 752     if (initialize_color != NULL) {
 753         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
 754                                    "initialize_color",
 755                                    TPARM_4(initialize_color, color, r, g, b));
 756     }
 757 }
 758
 759 static void
 760 drv_do_color(TERMINAL_CONTROL_BLOCK * TCB,
 761              short old_pair,
 762              short pair,
 763              bool reverse,
 764              NCURSES_SP_OUTC outc)
 765 {
 766     SCREEN *sp = TCB->csp;
 767     NCURSES_COLOR_T fg = COLOR_DEFAULT;
 768     NCURSES_COLOR_T bg = COLOR_DEFAULT;
 769     NCURSES_COLOR_T old_fg, old_bg;
 770
 771     AssertTCB();
 772     if (sp == 0)
 773         return;
 774
 775     if (pair < 0 || pair >= COLOR_PAIRS) {
 776         return;
 777     } else if (pair != 0) {
 778         if (set_color_pair) {
 779             TPUTS_TRACE("set_color_pair");
 780             NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
 781                                     TPARM_1(set_color_pair, pair), 1, outc);
 782             return;
 783         } else if (sp != 0) {
 784             NCURSES_SP_NAME(pair_content) (NCURSES_SP_ARGx
 785                                            (short) pair,
 786                                            &fg,
 787                                            &bg);
 788         }
 789     }
 790
 791     if (old_pair >= 0
 792         && sp != 0
 793         && NCURSES_SP_NAME(pair_content) (NCURSES_SP_ARGx
 794                                           old_pair,
 795                                           &old_fg,
 796                                           &old_bg) !=ERR) {
 797         if ((isDefaultColor(fg) && !isDefaultColor(old_fg))
 798             || (isDefaultColor(bg) && !isDefaultColor(old_bg))) {
 799 #if NCURSES_EXT_FUNCS
 800             /*
 801              * A minor optimization - but extension.  If "AX" is specified in
 802              * the terminal description, treat it as screen's indicator of ECMA
 803              * SGR 39 and SGR 49, and assume the two sequences are independent.
 804              */
 805             if (sp->_has_sgr_39_49
 806                 && isDefaultColor(old_bg)
 807                 && !isDefaultColor(old_fg)) {
 808                 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx "\033[39m", 1, outc);
 809             } else if (sp->_has_sgr_39_49
 810                        && isDefaultColor(old_fg)
 811                        && !isDefaultColor(old_bg)) {
 812                 NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx "\033[49m", 1, outc);
 813             } else
 814 #endif
 815                 drv_rescol(TCB);
 816         }
 817     } else {
 818         drv_rescol(TCB);
 819         if (old_pair < 0)
 820             return;
 821     }
 822
 823 #if NCURSES_EXT_FUNCS
 824     if (isDefaultColor(fg))
 825         fg = (NCURSES_COLOR_T) default_fg(sp);
 826     if (isDefaultColor(bg))
 827         bg = (NCURSES_COLOR_T) default_bg(sp);
 828 #endif
 829
 830     if (reverse) {
 831         NCURSES_COLOR_T xx = fg;
 832         fg = bg;
 833         bg = xx;
 834     }
 835
 836     TR(TRACE_ATTRS, ("setting colors: pair = %d, fg = %d, bg = %d", pair,
 837                      fg, bg));
 838
 839     if (!isDefaultColor(fg)) {
 840         drv_setcolor(TCB, TRUE, fg, outc);
 841     }
 842     if (!isDefaultColor(bg)) {
 843         drv_setcolor(TCB, FALSE, bg, outc);
 844     }
 845 }
 846
 847 #define xterm_kmous "\033[M"
 848 static void
 849 init_xterm_mouse(SCREEN *sp)
 850 {
 851     sp->_mouse_type = M_XTERM;
 852     sp->_mouse_xtermcap = NCURSES_SP_NAME(tigetstr) (NCURSES_SP_ARGx "XM");
 853     if (!VALID_STRING(sp->_mouse_xtermcap))
 854         sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
 855 }
 856
 857 static void
 858 drv_initmouse(TERMINAL_CONTROL_BLOCK * TCB)
 859 {
 860     SCREEN *sp;
 861
 862     AssertTCB();
 863     SetSP();
 864
 865     /* we know how to recognize mouse events under "xterm" */
 866     if (sp != 0) {
 867         if (key_mouse != 0) {
 868             if (!strcmp(key_mouse, xterm_kmous)
 869                 || strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
 870                 init_xterm_mouse(sp);
 871             }
 872         } else if (strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
 873             if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
 874                 init_xterm_mouse(sp);
 875         }
 876     }
 877 }
 878
 879 static int
 880 drv_mvcur(TERMINAL_CONTROL_BLOCK * TCB, int yold, int xold, int ynew, int xnew)
 881 {
 882     SCREEN *sp = TCB->csp;
 883     AssertTCB();
 884     return TINFO_MVCUR(sp, yold, xold, ynew, xnew);
 885 }
 886
 887 static void
 888 drv_hwlabel(TERMINAL_CONTROL_BLOCK * TCB, int labnum, char *text)
 889 {
 890     SCREEN *sp = TCB->csp;
 891
 892     AssertTCB();
 893     if (labnum > 0 && labnum <= num_labels) {
 894         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
 895                                    "plab_norm",
 896                                    TPARM_2(plab_norm, labnum, text));
 897     }
 898 }
 899
 900 static void
 901 drv_hwlabelOnOff(TERMINAL_CONTROL_BLOCK * TCB, bool OnFlag)
 902 {
 903     SCREEN *sp = TCB->csp;
 904
 905     AssertTCB();
 906     if (OnFlag) {
 907         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx "label_on", label_on);
 908     } else {
 909         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx "label_off", label_off);
 910     }
 911 }
 912
 913 static chtype
 914 drv_conattr(TERMINAL_CONTROL_BLOCK * TCB)
 915 {
 916     SCREEN *sp = TCB->csp;
 917     chtype attrs = A_NORMAL;
 918
 919     AssertTCB();
 920     if (enter_alt_charset_mode)
 921         attrs |= A_ALTCHARSET;
 922
 923     if (enter_blink_mode)
 924         attrs |= A_BLINK;
 925
 926     if (enter_bold_mode)
 927         attrs |= A_BOLD;
 928
 929     if (enter_dim_mode)
 930         attrs |= A_DIM;
 931
 932     if (enter_reverse_mode)
 933         attrs |= A_REVERSE;
 934
 935     if (enter_standout_mode)
 936         attrs |= A_STANDOUT;
 937
 938     if (enter_protected_mode)
 939         attrs |= A_PROTECT;
 940
 941     if (enter_secure_mode)
 942         attrs |= A_INVIS;
 943
 944     if (enter_underline_mode)
 945         attrs |= A_UNDERLINE;
 946
 947     if (sp && sp->_coloron)
 948         attrs |= A_COLOR;
 949
 950     return (attrs);
 951 }
 952
 953 static void
 954 drv_setfilter(TERMINAL_CONTROL_BLOCK * TCB)
 955 {
 956     AssertTCB();
 957
 958     clear_screen = 0;
 959     cursor_down = parm_down_cursor = 0;
 960     cursor_address = 0;
 961     cursor_up = parm_up_cursor = 0;
 962     row_address = 0;
 963     cursor_home = carriage_return;
 964 }
 965
 966 static void
 967 drv_initacs(TERMINAL_CONTROL_BLOCK * TCB, chtype *real_map, chtype *fake_map)
 968 {
 969     SCREEN *sp = TCB->csp;
 970
 971     AssertTCB();
 972     assert(sp != 0);
 973     if (ena_acs != NULL) {
 974         NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx "ena_acs", ena_acs);
 975     }
 976 #if NCURSES_EXT_FUNCS
 977     /*
 978      * Linux console "supports" the "PC ROM" character set by the coincidence
 979      * that smpch/rmpch and smacs/rmacs have the same values.  ncurses has
 980      * no codepage support (see SCO Merge for an example).  Outside of the
 981      * values defined in acsc, there are no definitions for the "PC ROM"
 982      * character set (assumed by some applications to be codepage 437), but we
 983      * allow those applications to use those codepoints.
 984      *
 985      * test/blue.c uses this feature.
 986      */
 987 #define PCH_KLUDGE(a,b) (a != 0 && b != 0 && !strcmp(a,b))
 988     if (PCH_KLUDGE(enter_pc_charset_mode, enter_alt_charset_mode) &&
 989         PCH_KLUDGE(exit_pc_charset_mode, exit_alt_charset_mode)) {
 990         size_t i;
 991         for (i = 1; i < ACS_LEN; ++i) {
 992             if (real_map[i] == 0) {
 993                 real_map[i] = i;
 994                 if (real_map != fake_map) {
 995                     if (sp != 0)
 996                         sp->_screen_acs_map[i] = TRUE;
 997                 }
 998             }
 999         }
1000     }
1001 #endif
1002
1003     if (acs_chars != NULL) {
1004         size_t i = 0;
1005         size_t length = strlen(acs_chars);
1006
1007         while (i + 1 < length) {
1008             if (acs_chars[i] != 0 && UChar(acs_chars[i]) < ACS_LEN) {
1009                 real_map[UChar(acs_chars[i])] = UChar(acs_chars[i + 1]) | A_ALTCHARSET;
1010                 if (sp != 0)
1011                     sp->_screen_acs_map[UChar(acs_chars[i])] = TRUE;
1012             }
1013             i += 2;
1014         }
1015     }
1016 #ifdef TRACE
1017     /* Show the equivalent mapping, noting if it does not match the
1018      * given attribute, whether by re-ordering or duplication.
1019      */
1020     if (USE_TRACEF(TRACE_CALLS)) {
1021         size_t n, m;
1022         char show[ACS_LEN * 2 + 1];
1023         for (n = 1, m = 0; n < ACS_LEN; n++) {
1024             if (real_map[n] != 0) {
1025                 show[m++] = (char) n;
1026                 show[m++] = (char) ChCharOf(real_map[n]);
1027             }
1028         }
1029         show[m] = 0;
1030         if (acs_chars == NULL || strcmp(acs_chars, show))
1031             _tracef("%s acs_chars %s",
1032                     (acs_chars == NULL) ? "NULL" : "READ",
1033                     _nc_visbuf(acs_chars));
1034         _tracef("%s acs_chars %s",
1035                 (acs_chars == NULL)
1036                 ? "NULL"
1037                 : (strcmp(acs_chars, show)
1038                    ? "DIFF"
1039                    : "SAME"),
1040                 _nc_visbuf(show));
1041
1042         _nc_unlock_global(tracef);
1043     }
1044 #endif /* TRACE */
1045 }
1046
1047 #define ENSURE_TINFO(sp) (TCBOf(sp)->drv->isTerminfo)
1048
1049 NCURSES_EXPORT(void)
1050 _nc_cookie_init(SCREEN *sp)
1051 {
1052     bool support_cookies = USE_XMC_SUPPORT;
1053     TERMINAL_CONTROL_BLOCK *TCB = (TERMINAL_CONTROL_BLOCK *) (sp->_term);
1054
1055     if (sp == 0 || !ENSURE_TINFO(sp))
1056         return;
1057
1058 #if USE_XMC_SUPPORT
1059     /*
1060      * If we have no magic-cookie support compiled-in, or if it is suppressed
1061      * in the environment, reset the support-flag.
1062      */
1063     if (magic_cookie_glitch >= 0) {
1064         if (getenv("NCURSES_NO_MAGIC_COOKIE") != 0) {
1065             support_cookies = FALSE;
1066         }
1067     }
1068 #endif
1069
1070     if (!support_cookies && magic_cookie_glitch >= 0) {
1071         T(("will disable attributes to work w/o magic cookies"));
1072     }
1073
1074     if (magic_cookie_glitch > 0) {      /* tvi, wyse */
1075
1076         sp->_xmc_triggers = sp->_ok_attributes & (
1077                                                      A_STANDOUT |
1078                                                      A_UNDERLINE |
1079                                                      A_REVERSE |
1080                                                      A_BLINK |
1081                                                      A_DIM |
1082                                                      A_BOLD |
1083                                                      A_INVIS |
1084                                                      A_PROTECT
1085             );
1086 #if 0
1087         /*
1088          * We "should" treat colors as an attribute.  The wyse350 (and its
1089          * clones) appear to be the only ones that have both colors and magic
1090          * cookies.
1091          */
1092         if (has_colors()) {
1093             sp->_xmc_triggers |= A_COLOR;
1094         }
1095 #endif
1096         sp->_xmc_suppress = sp->_xmc_triggers & (chtype) ~(A_BOLD);
1097
1098         T(("magic cookie attributes %s", _traceattr(sp->_xmc_suppress)));
1099         /*
1100          * Supporting line-drawing may be possible.  But make the regular
1101          * video attributes work first.
1102          */
1103         acs_chars = ABSENT_STRING;
1104         ena_acs = ABSENT_STRING;
1105         enter_alt_charset_mode = ABSENT_STRING;
1106         exit_alt_charset_mode = ABSENT_STRING;
1107 #if USE_XMC_SUPPORT
1108         /*
1109          * To keep the cookie support simple, suppress all of the optimization
1110          * hooks except for clear_screen and the cursor addressing.
1111          */
1112         if (support_cookies) {
1113             clr_eol = ABSENT_STRING;
1114             clr_eos = ABSENT_STRING;
1115             set_attributes = ABSENT_STRING;
1116         }
1117 #endif
1118     } else if (magic_cookie_glitch == 0) {      /* hpterm */
1119     }
1120
1121     /*
1122      * If magic cookies are not supported, cancel the strings that set
1123      * video attributes.
1124      */
1125     if (!support_cookies && magic_cookie_glitch >= 0) {
1126         magic_cookie_glitch = ABSENT_NUMERIC;
1127         set_attributes = ABSENT_STRING;
1128         enter_blink_mode = ABSENT_STRING;
1129         enter_bold_mode = ABSENT_STRING;
1130         enter_dim_mode = ABSENT_STRING;
1131         enter_reverse_mode = ABSENT_STRING;
1132         enter_standout_mode = ABSENT_STRING;
1133         enter_underline_mode = ABSENT_STRING;
1134     }
1135
1136     /* initialize normal acs before wide, since we use mapping in the latter */
1137 #if !USE_WIDEC_SUPPORT
1138     if (_nc_unicode_locale() && _nc_locale_breaks_acs(sp->_term)) {
1139         acs_chars = NULL;
1140         ena_acs = NULL;
1141         enter_alt_charset_mode = NULL;
1142         exit_alt_charset_mode = NULL;
1143         set_attributes = NULL;
1144     }
1145 #endif
1146 }
1147
1148 static int
1149 drv_twait(TERMINAL_CONTROL_BLOCK * TCB,
1150           int mode,
1151           int milliseconds,
1152           int *timeleft
1153           EVENTLIST_2nd(_nc_eventlist * evl))
1154 {
1155     SCREEN *sp;
1156
1157     AssertTCB();
1158     SetSP();
1159
1160     return _nc_timed_wait(sp, mode, milliseconds, timeleft EVENTLIST_2nd(evl));
1161 }
1162
1163 static int
1164 drv_read(TERMINAL_CONTROL_BLOCK * TCB, int *buf)
1165 {
1166     SCREEN *sp;
1167     unsigned char c2 = 0;
1168     int n;
1169
1170     AssertTCB();
1171     assert(buf);
1172     SetSP();
1173
1174     n = read(sp->_ifd, &c2, 1);
1175     *buf = (int) c2;
1176     return n;
1177 }
1178
1179 static int
1180 drv_nap(TERMINAL_CONTROL_BLOCK * TCB GCC_UNUSED, int ms)
1181 {
1182 #if HAVE_NANOSLEEP
1183     {
1184         struct timespec request, remaining;
1185         request.tv_sec = ms / 1000;
1186         request.tv_nsec = (ms % 1000) * 1000000;
1187         while (nanosleep(&request, &remaining) == -1
1188                && errno == EINTR) {
1189             request = remaining;
1190         }
1191     }
1192 #else
1193     _nc_timed_wait(0, 0, ms, (int *) 0 EVENTLIST_2nd(0));
1194 #endif
1195     return OK;
1196 }
1197
1198 static int
1199 __nc_putp(SCREEN *sp, const char *name GCC_UNUSED, const char *value)
1200 {
1201     int rc = ERR;
1202
1203     if (value) {
1204         rc = NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx name, value);
1205     }
1206     return rc;
1207 }
1208
1209 static int
1210 __nc_putp_flush(SCREEN *sp, const char *name, const char *value)
1211 {
1212     int rc = __nc_putp(sp, name, value);
1213     if (rc != ERR) {
1214         NCURSES_SP_NAME(_nc_flush) (sp);
1215     }
1216     return rc;
1217 }
1218
1219 static int
1220 drv_kpad(TERMINAL_CONTROL_BLOCK * TCB, bool flag)
1221 {
1222     int ret = ERR;
1223     SCREEN *sp;
1224
1225     AssertTCB();
1226
1227     sp = TCB->csp;
1228
1229     if (sp) {
1230         if (flag) {
1231             (void) __nc_putp_flush(sp, "keypad_xmit", keypad_xmit);
1232         } else if (!flag && keypad_local) {
1233             (void) __nc_putp_flush(sp, "keypad_local", keypad_local);
1234         }
1235         if (flag && !sp->_tried) {
1236             _nc_init_keytry(sp);
1237             sp->_tried = TRUE;
1238         }
1239         ret = OK;
1240     }
1241
1242     return ret;
1243 }
1244
1245 static int
1246 drv_keyok(TERMINAL_CONTROL_BLOCK * TCB, int c, bool flag)
1247 {
1248     SCREEN *sp;
1249     int code = ERR;
1250     int count = 0;
1251     char *s;
1252
1253     AssertTCB();
1254     SetSP();
1255
1256     if (c >= 0) {
1257         unsigned ch = (unsigned) c;
1258         if (flag) {
1259             while ((s = _nc_expand_try(sp->_key_ok, ch, &count, 0)) != 0
1260                    && _nc_remove_key(&(sp->_key_ok), ch)) {
1261                 code = _nc_add_to_try(&(sp->_keytry), s, ch);
1262                 free(s);
1263                 count = 0;
1264                 if (code != OK)
1265                     break;
1266             }
1267         } else {
1268             while ((s = _nc_expand_try(sp->_keytry, ch, &count, 0)) != 0
1269                    && _nc_remove_key(&(sp->_keytry), ch)) {
1270                 code = _nc_add_to_try(&(sp->_key_ok), s, ch);
1271                 free(s);
1272                 count = 0;
1273                 if (code != OK)
1274                     break;
1275             }
1276         }
1277     }
1278     return (code);
1279 }
1280
1281 static bool
1282 drv_kyExist(TERMINAL_CONTROL_BLOCK * TCB, int key)
1283 {
1284     bool res = FALSE;
1285
1286     AssertTCB();
1287     if (TCB->csp)
1288         res = TINFO_HAS_KEY(TCB->csp, key) == 0 ? FALSE : TRUE;
1289
1290     return res;
1291 }
1292
1293 NCURSES_EXPORT_VAR (TERM_DRIVER) _nc_TINFO_DRIVER = {
1294     TRUE,
1295         drv_CanHandle,          /* CanHandle */
1296         drv_init,               /* init */
1297         drv_release,            /* release */
1298         drv_size,               /* size */
1299         drv_sgmode,             /* sgmode */
1300         drv_conattr,            /* conattr */
1301         drv_mvcur,              /* hwcur */
1302         drv_mode,               /* mode */
1303         drv_rescol,             /* rescol */
1304         drv_rescolors,          /* rescolors */
1305         drv_setcolor,           /* color */
1306         drv_dobeepflash,        /* doBeepOrFlash */
1307         drv_initpair,           /* initpair */
1308         drv_initcolor,          /* initcolor */
1309         drv_do_color,           /* docolor */
1310         drv_initmouse,          /* initmouse */
1311         drv_setfilter,          /* setfilter */
1312         drv_hwlabel,            /* hwlabel */
1313         drv_hwlabelOnOff,       /* hwlabelOnOff */
1314         drv_doupdate,           /* update */
1315         drv_defaultcolors,      /* defaultcolors */
1316         drv_print,              /* print */
1317         drv_getsize,            /* getsize */
1318         drv_setsize,            /* setsize */
1319         drv_initacs,            /* initacs */
1320         drv_screen_init,        /* scinit */
1321         drv_wrap,               /* scexit */
1322         drv_twait,              /* twait  */
1323         drv_read,               /* read */
1324         drv_nap,                /* nap */
1325         drv_kpad,               /* kpad */
1326         drv_keyok,              /* kyOk */
1327         drv_kyExist             /* kyExist */
1328 };