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