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