ncurses 6.1 - patch 20180623
[ncurses.git] / ncurses / tinfo / lib_setup.c
1 /****************************************************************************
2  * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  *     and: Juergen Pfeifer                         2009                    *
34  ****************************************************************************/
35
36 /*
37  * Terminal setup routines common to termcap and terminfo:
38  *
39  *              use_env(bool)
40  *              use_tioctl(bool)
41  *              setupterm(char *, int, int *)
42  */
43
44 #include <curses.priv.h>
45 #include <tic.h>                /* for MAX_NAME_SIZE */
46
47 #if HAVE_LOCALE_H
48 #include <locale.h>
49 #endif
50
51 MODULE_ID("$Id: lib_setup.c,v 1.193 2018/06/23 21:35:06 tom Exp $")
52
53 /****************************************************************************
54  *
55  * Terminal size computation
56  *
57  ****************************************************************************/
58
59 #if HAVE_SIZECHANGE
60 # if !defined(sun) || !TERMIOS
61 #  if HAVE_SYS_IOCTL_H
62 #   include <sys/ioctl.h>
63 #  endif
64 # endif
65 #endif
66
67 #if NEED_PTEM_H
68  /* On SCO, they neglected to define struct winsize in termios.h -- it's only
69   * in termio.h and ptem.h (the former conflicts with other definitions).
70   */
71 # include <sys/stream.h>
72 # include <sys/ptem.h>
73 #endif
74
75 #if HAVE_LANGINFO_CODESET
76 #include <langinfo.h>
77 #endif
78
79 /*
80  * SCO defines TIOCGSIZE and the corresponding struct.  Other systems (SunOS,
81  * Solaris, IRIX) define TIOCGWINSZ and struct winsize.
82  */
83 #ifdef TIOCGSIZE
84 # define IOCTL_WINSIZE TIOCGSIZE
85 # define STRUCT_WINSIZE struct ttysize
86 # define WINSIZE_ROWS(n) (int)n.ts_lines
87 # define WINSIZE_COLS(n) (int)n.ts_cols
88 #else
89 # ifdef TIOCGWINSZ
90 #  define IOCTL_WINSIZE TIOCGWINSZ
91 #  define STRUCT_WINSIZE struct winsize
92 #  define WINSIZE_ROWS(n) (int)n.ws_row
93 #  define WINSIZE_COLS(n) (int)n.ws_col
94 # endif
95 #endif
96
97 /*
98  * Reduce explicit use of "cur_term" global variable.
99  */
100 #undef CUR
101 #define CUR TerminalType(termp).
102
103 /*
104  * Wrap global variables in this module.
105  */
106 #if USE_REENTRANT
107
108 NCURSES_EXPORT(char *)
109 NCURSES_PUBLIC_VAR(ttytype) (void)
110 {
111     static char empty[] = "";
112     char *result = empty;
113
114 #if NCURSES_SP_FUNCS
115     if (CURRENT_SCREEN) {
116         TERMINAL *termp = TerminalOf(CURRENT_SCREEN);
117         if (termp != 0) {
118             result = TerminalType(termp).term_names;
119         }
120     }
121 #else
122     if (cur_term != 0) {
123         result = TerminalType(cur_term).term_names;
124     }
125 #endif
126     return result;
127 }
128
129 NCURSES_EXPORT(int *)
130 _nc_ptr_Lines(SCREEN *sp)
131 {
132     return ptrLines(sp);
133 }
134
135 NCURSES_EXPORT(int)
136 NCURSES_PUBLIC_VAR(LINES) (void)
137 {
138     return *_nc_ptr_Lines(CURRENT_SCREEN);
139 }
140
141 NCURSES_EXPORT(int *)
142 _nc_ptr_Cols(SCREEN *sp)
143 {
144     return ptrCols(sp);
145 }
146
147 NCURSES_EXPORT(int)
148 NCURSES_PUBLIC_VAR(COLS) (void)
149 {
150     return *_nc_ptr_Cols(CURRENT_SCREEN);
151 }
152
153 NCURSES_EXPORT(int *)
154 _nc_ptr_Tabsize(SCREEN *sp)
155 {
156     return ptrTabsize(sp);
157 }
158
159 NCURSES_EXPORT(int)
160 NCURSES_PUBLIC_VAR(TABSIZE) (void)
161 {
162     return *_nc_ptr_Tabsize(CURRENT_SCREEN);
163 }
164 #else
165 NCURSES_EXPORT_VAR(char) ttytype[NAMESIZE] = "";
166 NCURSES_EXPORT_VAR(int) LINES = 0;
167 NCURSES_EXPORT_VAR(int) COLS = 0;
168 NCURSES_EXPORT_VAR(int) TABSIZE = 8;
169 #endif
170
171 #if NCURSES_EXT_FUNCS
172 NCURSES_EXPORT(int)
173 NCURSES_SP_NAME(set_tabsize) (NCURSES_SP_DCLx int value)
174 {
175     int code = OK;
176 #if USE_REENTRANT
177     if (SP_PARM) {
178         SP_PARM->_TABSIZE = value;
179     } else {
180         code = ERR;
181     }
182 #else
183     (void) SP_PARM;
184     TABSIZE = value;
185 #endif
186     return code;
187 }
188
189 #if NCURSES_SP_FUNCS
190 NCURSES_EXPORT(int)
191 set_tabsize(int value)
192 {
193     return NCURSES_SP_NAME(set_tabsize) (CURRENT_SCREEN, value);
194 }
195 #endif
196 #endif /* NCURSES_EXT_FUNCS */
197
198 #if USE_SIGWINCH
199 /*
200  * If we have a pending SIGWINCH, set the flag in each screen.
201  */
202 NCURSES_EXPORT(int)
203 _nc_handle_sigwinch(SCREEN *sp)
204 {
205     SCREEN *scan;
206
207     if (_nc_globals.have_sigwinch) {
208         _nc_globals.have_sigwinch = 0;
209
210         for (each_screen(scan)) {
211             scan->_sig_winch = TRUE;
212         }
213     }
214
215     return (sp ? sp->_sig_winch : 0);
216 }
217
218 #endif
219
220 NCURSES_EXPORT(void)
221 NCURSES_SP_NAME(use_env) (NCURSES_SP_DCLx bool f)
222 {
223     START_TRACE();
224     T((T_CALLED("use_env(%p,%d)"), (void *) SP_PARM, (int) f));
225 #if NCURSES_SP_FUNCS
226     if (IsPreScreen(SP_PARM)) {
227         SP_PARM->_use_env = f;
228     }
229 #else
230     _nc_prescreen.use_env = f;
231 #endif
232     returnVoid;
233 }
234
235 NCURSES_EXPORT(void)
236 NCURSES_SP_NAME(use_tioctl) (NCURSES_SP_DCLx bool f)
237 {
238     START_TRACE();
239     T((T_CALLED("use_tioctl(%p,%d)"), (void *) SP_PARM, (int) f));
240 #if NCURSES_SP_FUNCS
241     if (IsPreScreen(SP_PARM)) {
242         SP_PARM->use_tioctl = f;
243     }
244 #else
245     _nc_prescreen.use_tioctl = f;
246 #endif
247     returnVoid;
248 }
249
250 #if NCURSES_SP_FUNCS
251 NCURSES_EXPORT(void)
252 use_env(bool f)
253 {
254     START_TRACE();
255     T((T_CALLED("use_env(%d)"), (int) f));
256     _nc_prescreen.use_env = f;
257     returnVoid;
258 }
259
260 NCURSES_EXPORT(void)
261 use_tioctl(bool f)
262 {
263     START_TRACE();
264     T((T_CALLED("use_tioctl(%d)"), (int) f));
265     _nc_prescreen.use_tioctl = f;
266     returnVoid;
267 }
268 #endif
269
270 NCURSES_EXPORT(void)
271 _nc_get_screensize(SCREEN *sp,
272 #ifdef USE_TERM_DRIVER
273                    TERMINAL *termp,
274 #endif
275                    int *linep, int *colp)
276 /* Obtain lines/columns values from the environment and/or terminfo entry */
277 {
278 #ifdef USE_TERM_DRIVER
279     TERMINAL_CONTROL_BLOCK *TCB;
280     int my_tabsize;
281
282     assert(termp != 0 && linep != 0 && colp != 0);
283     TCB = (TERMINAL_CONTROL_BLOCK *) termp;
284
285     my_tabsize = TCB->info.tabsize;
286     TCB->drv->td_size(TCB, linep, colp);
287
288 #if USE_REENTRANT
289     if (sp != 0) {
290         sp->_TABSIZE = my_tabsize;
291     }
292 #else
293     (void) sp;
294     TABSIZE = my_tabsize;
295 #endif
296     T(("TABSIZE = %d", my_tabsize));
297 #else /* !USE_TERM_DRIVER */
298     TERMINAL *termp = cur_term;
299     int my_tabsize;
300     bool useEnv = _nc_prescreen.use_env;
301     bool useTioctl = _nc_prescreen.use_tioctl;
302
303     /* figure out the size of the screen */
304     T(("screen size: terminfo lines = %d columns = %d", lines, columns));
305
306     *linep = (int) lines;
307     *colp = (int) columns;
308
309 #if NCURSES_SP_FUNCS
310     if (sp) {
311         useEnv = sp->_use_env;
312         useTioctl = sp->use_tioctl;
313     }
314 #endif
315
316     if (useEnv || useTioctl) {
317 #ifdef __EMX__
318         {
319             int screendata[2];
320             _scrsize(screendata);
321             *colp = screendata[0];
322             *linep = ((sp != 0 && sp->_filtered)
323                       ? 1
324                       : screendata[1]);
325             T(("EMX screen size: environment LINES = %d COLUMNS = %d",
326                *linep, *colp));
327         }
328 #endif
329 #if HAVE_SIZECHANGE
330         /* try asking the OS */
331         if (NC_ISATTY(cur_term->Filedes)) {
332             STRUCT_WINSIZE size;
333
334             errno = 0;
335             do {
336                 if (ioctl(cur_term->Filedes, IOCTL_WINSIZE, &size) >= 0) {
337                     *linep = ((sp != 0 && sp->_filtered)
338                               ? 1
339                               : WINSIZE_ROWS(size));
340                     *colp = WINSIZE_COLS(size);
341                     T(("SYS screen size: environment LINES = %d COLUMNS = %d",
342                        *linep, *colp));
343                     break;
344                 }
345             } while
346                 (errno == EINTR);
347         }
348 #endif /* HAVE_SIZECHANGE */
349
350         if (useEnv) {
351             int value;
352
353             if (useTioctl) {
354                 /*
355                  * If environment variables are used, update them.
356                  */
357                 if ((sp == 0 || !sp->_filtered) && _nc_getenv_num("LINES") > 0) {
358                     _nc_setenv_num("LINES", *linep);
359                 }
360                 if (_nc_getenv_num("COLUMNS") > 0) {
361                     _nc_setenv_num("COLUMNS", *colp);
362                 }
363             }
364
365             /*
366              * Finally, look for environment variables.
367              *
368              * Solaris lets users override either dimension with an environment
369              * variable.
370              */
371             if ((value = _nc_getenv_num("LINES")) > 0) {
372                 *linep = value;
373                 T(("screen size: environment LINES = %d", *linep));
374             }
375             if ((value = _nc_getenv_num("COLUMNS")) > 0) {
376                 *colp = value;
377                 T(("screen size: environment COLUMNS = %d", *colp));
378             }
379         }
380
381         /* if we can't get dynamic info about the size, use static */
382         if (*linep <= 0) {
383             *linep = (int) lines;
384         }
385         if (*colp <= 0) {
386             *colp = (int) columns;
387         }
388
389         /* the ultimate fallback, assume fixed 24x80 size */
390         if (*linep <= 0) {
391             *linep = 24;
392         }
393         if (*colp <= 0) {
394             *colp = 80;
395         }
396
397         /*
398          * Put the derived values back in the screen-size caps, so
399          * tigetnum() and tgetnum() will do the right thing.
400          */
401         lines = (NCURSES_INT2) (*linep);
402         columns = (NCURSES_INT2) (*colp);
403 #if NCURSES_EXT_NUMBERS
404 #define OldNumber(termp,name) \
405         (termp)->type.Numbers[(&name - (termp)->type2.Numbers)]
406         OldNumber(termp, lines) = (short) (*linep);
407         OldNumber(termp, columns) = (short) (*colp);
408 #endif
409     }
410
411     T(("screen size is %dx%d", *linep, *colp));
412
413     if (VALID_NUMERIC(init_tabs))
414         my_tabsize = (int) init_tabs;
415     else
416         my_tabsize = 8;
417
418 #if USE_REENTRANT
419     if (sp != 0)
420         sp->_TABSIZE = my_tabsize;
421 #else
422     TABSIZE = my_tabsize;
423 #endif
424     T(("TABSIZE = %d", TABSIZE));
425 #endif /* USE_TERM_DRIVER */
426 }
427
428 #if USE_SIZECHANGE
429 NCURSES_EXPORT(void)
430 _nc_update_screensize(SCREEN *sp)
431 {
432     int new_lines;
433     int new_cols;
434
435 #ifdef USE_TERM_DRIVER
436     int old_lines;
437     int old_cols;
438
439     assert(sp != 0);
440
441     CallDriver_2(sp, td_getsize, &old_lines, &old_cols);
442
443 #else
444     TERMINAL *termp = cur_term;
445     int old_lines = lines;
446     int old_cols = columns;
447 #endif
448
449     TINFO_GET_SIZE(sp, sp->_term, &new_lines, &new_cols);
450
451     /*
452      * See is_term_resized() and resizeterm().
453      * We're doing it this way because those functions belong to the upper
454      * ncurses library, while this resides in the lower terminfo library.
455      */
456     if (sp != 0 && sp->_resize != 0) {
457         if ((new_lines != old_lines) || (new_cols != old_cols)) {
458             sp->_resize(NCURSES_SP_ARGx new_lines, new_cols);
459         } else if (sp->_sig_winch && (sp->_ungetch != 0)) {
460             sp->_ungetch(SP_PARM, KEY_RESIZE);  /* so application can know this */
461         }
462         sp->_sig_winch = FALSE;
463     }
464 }
465 #endif
466
467 /****************************************************************************
468  *
469  * Terminal setup
470  *
471  ****************************************************************************/
472
473 #if NCURSES_USE_DATABASE || NCURSES_USE_TERMCAP
474 /*
475  * Return 1 if entry found, 0 if not found, -1 if database not accessible,
476  * just like tgetent().
477  */
478 int
479 _nc_setup_tinfo(const char *const tn, TERMTYPE2 *const tp)
480 {
481     char filename[PATH_MAX];
482     int status = _nc_read_entry2(tn, filename, tp);
483
484     /*
485      * If we have an entry, force all of the cancelled strings to null
486      * pointers so we don't have to test them in the rest of the library.
487      * (The terminfo compiler bypasses this logic, since it must know if
488      * a string is cancelled, for merging entries).
489      */
490     if (status == TGETENT_YES) {
491         unsigned n;
492         for_each_boolean(n, tp) {
493             if (!VALID_BOOLEAN(tp->Booleans[n]))
494                 tp->Booleans[n] = FALSE;
495         }
496         for_each_string(n, tp) {
497             if (tp->Strings[n] == CANCELLED_STRING)
498                 tp->Strings[n] = ABSENT_STRING;
499         }
500     }
501     return (status);
502 }
503 #endif
504
505 /*
506 **      Take the real command character out of the CC environment variable
507 **      and substitute it in for the prototype given in 'command_character'.
508 */
509 void
510 _nc_tinfo_cmdch(TERMINAL *termp, int proto)
511 {
512     char *tmp;
513
514     /*
515      * Only use the character if the string is a single character,
516      * since it is fairly common for developers to set the C compiler
517      * name as an environment variable - using the same symbol.
518      */
519     if ((tmp = getenv("CC")) != 0 && strlen(tmp) == 1) {
520         unsigned i;
521         char CC = *tmp;
522
523         for_each_string(i, &(termp->type)) {
524             for (tmp = termp->type.Strings[i]; tmp && *tmp; tmp++) {
525                 if (UChar(*tmp) == proto)
526                     *tmp = CC;
527             }
528         }
529     }
530 }
531
532 /*
533  * Find the locale which is in effect.
534  */
535 NCURSES_EXPORT(char *)
536 _nc_get_locale(void)
537 {
538     char *env;
539 #if HAVE_LOCALE_H
540     /*
541      * This is preferable to using getenv() since it ensures that we are using
542      * the locale which was actually initialized by the application.
543      */
544     env = setlocale(LC_CTYPE, 0);
545 #else
546     if (((env = getenv("LC_ALL")) != 0 && *env != '\0')
547         || ((env = getenv("LC_CTYPE")) != 0 && *env != '\0')
548         || ((env = getenv("LANG")) != 0 && *env != '\0')) {
549         ;
550     }
551 #endif
552     T(("_nc_get_locale %s", _nc_visbuf(env)));
553     return env;
554 }
555
556 /*
557  * Check if we are running in a UTF-8 locale.
558  */
559 NCURSES_EXPORT(int)
560 _nc_unicode_locale(void)
561 {
562     int result = 0;
563 #if defined(_WIN32) && USE_WIDEC_SUPPORT
564     result = 1;
565 #elif HAVE_LANGINFO_CODESET
566     char *env = nl_langinfo(CODESET);
567     result = !strcmp(env, "UTF-8");
568     T(("_nc_unicode_locale(%s) ->%d", env, result));
569 #else
570     char *env = _nc_get_locale();
571     if (env != 0) {
572         if (strstr(env, ".UTF-8") != 0) {
573             result = 1;
574             T(("_nc_unicode_locale(%s) ->%d", env, result));
575         }
576     }
577 #endif
578     return result;
579 }
580
581 #define CONTROL_N(s) ((s) != 0 && strstr(s, "\016") != 0)
582 #define CONTROL_O(s) ((s) != 0 && strstr(s, "\017") != 0)
583
584 /*
585  * Check for known broken cases where a UTF-8 locale breaks the alternate
586  * character set.
587  */
588 NCURSES_EXPORT(int)
589 _nc_locale_breaks_acs(TERMINAL *termp)
590 {
591     const char *env_name = "NCURSES_NO_UTF8_ACS";
592     const char *env;
593     int value;
594     int result = 0;
595
596     T((T_CALLED("_nc_locale_breaks_acs:%d"), result));
597     if (getenv(env_name) != 0) {
598         result = _nc_getenv_num(env_name);
599     } else if ((value = tigetnum("U8")) >= 0) {
600         result = value;         /* use extension feature */
601     } else if ((env = getenv("TERM")) != 0) {
602         if (strstr(env, "linux")) {
603             result = 1;         /* always broken */
604         } else if (strstr(env, "screen") != 0
605                    && ((env = getenv("TERMCAP")) != 0
606                        && strstr(env, "screen") != 0)
607                    && strstr(env, "hhII00") != 0) {
608             if (CONTROL_N(enter_alt_charset_mode) ||
609                 CONTROL_O(enter_alt_charset_mode) ||
610                 CONTROL_N(set_attributes) ||
611                 CONTROL_O(set_attributes)) {
612                 result = 1;
613             }
614         }
615     }
616     returnCode(result);
617 }
618
619 NCURSES_EXPORT(int)
620 TINFO_SETUP_TERM(TERMINAL **tp,
621                  const char *tname,
622                  int Filedes,
623                  int *errret,
624                  int reuse)
625 {
626 #ifdef USE_TERM_DRIVER
627     TERMINAL_CONTROL_BLOCK *TCB = 0;
628 #endif
629     TERMINAL *termp;
630     SCREEN *sp = 0;
631     int code = ERR;
632
633     START_TRACE();
634
635 #ifdef USE_TERM_DRIVER
636     T((T_CALLED("_nc_setupterm_ex(%p,%s,%d,%p)"),
637        (void *) tp, _nc_visbuf(tname), Filedes, (void *) errret));
638
639     if (tp == 0) {
640         ret_error0(TGETENT_ERR,
641                    "Invalid parameter, internal error.\n");
642     } else
643         termp = *tp;
644 #else
645     termp = cur_term;
646     T((T_CALLED("setupterm(%s,%d,%p)"), _nc_visbuf(tname), Filedes, (void *) errret));
647 #endif
648
649     if (tname == 0) {
650         tname = getenv("TERM");
651         if (tname == 0 || *tname == '\0') {
652 #ifdef USE_TERM_DRIVER
653             tname = "unknown";
654 #else
655             ret_error0(TGETENT_ERR, "TERM environment variable not set.\n");
656 #endif
657         }
658     }
659
660     if (strlen(tname) > MAX_NAME_SIZE) {
661         ret_error(TGETENT_ERR,
662                   "TERM environment must be <= %d characters.\n",
663                   MAX_NAME_SIZE);
664     }
665
666     T(("your terminal name is %s", tname));
667
668     /*
669      * Allow output redirection.  This is what SVr3 does.  If stdout is
670      * directed to a file, screen updates go to standard error.
671      */
672     if (Filedes == STDOUT_FILENO && !NC_ISATTY(Filedes))
673         Filedes = STDERR_FILENO;
674
675     /*
676      * Check if we have already initialized to use this terminal.  If so, we
677      * do not need to re-read the terminfo entry, or obtain TTY settings.
678      *
679      * This is an improvement on SVr4 curses.  If an application mixes curses
680      * and termcap calls, it may call both initscr and tgetent.  This is not
681      * really a good thing to do, but can happen if someone tries using ncurses
682      * with the readline library.  The problem we are fixing is that when
683      * tgetent calls setupterm, the resulting Ottyb struct in cur_term is
684      * zeroed.  A subsequent call to endwin uses the zeroed terminal settings
685      * rather than the ones saved in initscr.  So we check if cur_term appears
686      * to contain terminal settings for the same output file as our current
687      * call - and copy those terminal settings.  (SVr4 curses does not do this,
688      * however applications that are working around the problem will still work
689      * properly with this feature).
690      */
691     if (reuse
692         && (termp != 0)
693         && termp->Filedes == Filedes
694         && termp->_termname != 0
695         && !strcmp(termp->_termname, tname)
696         && _nc_name_match(TerminalType(termp).term_names, tname, "|")) {
697         T(("reusing existing terminal information and mode-settings"));
698         code = OK;
699 #ifdef USE_TERM_DRIVER
700         TCB = (TERMINAL_CONTROL_BLOCK *) termp;
701 #endif
702     } else {
703 #ifdef USE_TERM_DRIVER
704         TERMINAL_CONTROL_BLOCK *my_tcb;
705         termp = 0;
706         if ((my_tcb = typeCalloc(TERMINAL_CONTROL_BLOCK, 1)) != 0)
707             termp = &(my_tcb->term);
708 #else
709         int status;
710
711         termp = typeCalloc(TERMINAL, 1);
712 #endif
713         if (termp == 0) {
714             ret_error0(TGETENT_ERR,
715                        "Not enough memory to create terminal structure.\n");
716         }
717 #ifdef USE_TERM_DRIVER
718         INIT_TERM_DRIVER();
719         TCB = (TERMINAL_CONTROL_BLOCK *) termp;
720         code = _nc_globals.term_driver(TCB, tname, errret);
721         if (code == OK) {
722             termp->Filedes = (short) Filedes;
723             termp->_termname = strdup(tname);
724         } else {
725             ret_error0(errret ? *errret : TGETENT_ERR,
726                        "Could not find any driver to handle this terminal.\n");
727         }
728 #else
729 #if NCURSES_USE_DATABASE || NCURSES_USE_TERMCAP
730         status = _nc_setup_tinfo(tname, &TerminalType(termp));
731 #else
732         status = TGETENT_NO;
733 #endif
734
735         /* try fallback list if entry on disk */
736         if (status != TGETENT_YES) {
737             const TERMTYPE2 *fallback = _nc_fallback2(tname);
738
739             if (fallback) {
740                 TerminalType(termp) = *fallback;
741                 status = TGETENT_YES;
742             }
743         }
744
745         if (status != TGETENT_YES) {
746             del_curterm(termp);
747             if (status == TGETENT_ERR) {
748                 ret_error0(status, "terminals database is inaccessible\n");
749             } else if (status == TGETENT_NO) {
750                 ret_error1(status, "unknown terminal type.\n", tname);
751             }
752         }
753 #if NCURSES_EXT_NUMBERS
754         _nc_export_termtype2(&termp->type, &TerminalType(termp));
755 #endif
756 #if !USE_REENTRANT
757         save_ttytype(termp);
758 #endif
759
760         termp->Filedes = (short) Filedes;
761         termp->_termname = strdup(tname);
762
763         set_curterm(termp);
764
765         if (command_character)
766             _nc_tinfo_cmdch(termp, UChar(*command_character));
767
768         /*
769          * If an application calls setupterm() rather than initscr() or
770          * newterm(), we will not have the def_prog_mode() call in
771          * _nc_setupscreen().  Do it now anyway, so we can initialize the
772          * baudrate.  Also get the shell-mode so that erasechar() works.
773          */
774         if (NC_ISATTY(Filedes)) {
775             NCURSES_SP_NAME(def_shell_mode) (NCURSES_SP_ARG);
776             NCURSES_SP_NAME(def_prog_mode) (NCURSES_SP_ARG);
777             baudrate();
778         }
779         code = OK;
780 #endif
781     }
782
783 #ifdef USE_TERM_DRIVER
784     *tp = termp;
785     NCURSES_SP_NAME(set_curterm) (sp, termp);
786     TCB->drv->td_init(TCB);
787 #else
788     sp = SP;
789 #endif
790
791     /*
792      * We should always check the screensize, just in case.
793      */
794     TINFO_GET_SIZE(sp, termp, ptrLines(sp), ptrCols(sp));
795
796     if (errret)
797         *errret = TGETENT_YES;
798
799 #ifndef USE_TERM_DRIVER
800     if (generic_type) {
801         /*
802          * BSD 4.3's termcap contains mis-typed "gn" for wy99.  Do a sanity
803          * check before giving up.
804          */
805         if ((VALID_STRING(cursor_address)
806              || (VALID_STRING(cursor_down) && VALID_STRING(cursor_home)))
807             && VALID_STRING(clear_screen)) {
808             ret_error1(TGETENT_YES, "terminal is not really generic.\n", tname);
809         } else {
810             del_curterm(termp);
811             ret_error1(TGETENT_NO, "I need something more specific.\n", tname);
812         }
813     } else if (hard_copy) {
814         ret_error1(TGETENT_YES, "I can't handle hardcopy terminals.\n", tname);
815     }
816 #endif
817     returnCode(code);
818 }
819
820 #ifdef USE_PTHREADS
821 /*
822  * Returns a non-null pointer unless a new screen should be allocated because
823  * no match was found in the pre-screen cache.
824  */
825 NCURSES_EXPORT(SCREEN *)
826 _nc_find_prescr(void)
827 {
828     SCREEN *result = 0;
829     PRESCREEN_LIST *p;
830     pthread_t id = GetThreadID();
831     for (p = _nc_prescreen.allocated; p != 0; p = p->next) {
832         if (p->id == id) {
833             result = p->sp;
834             break;
835         }
836     }
837     return result;
838 }
839
840 /*
841  * Tells ncurses to forget that this thread was associated with the pre-screen
842  * cache.  It does not modify the pre-screen cache itself, since that is used
843  * for creating new screens.
844  */
845 NCURSES_EXPORT(void)
846 _nc_forget_prescr(void)
847 {
848     PRESCREEN_LIST *p, *q;
849     pthread_t id = GetThreadID();
850     for (p = _nc_prescreen.allocated, q = 0; p != 0; q = p, p = p->next) {
851         if (p->id == id) {
852             if (q) {
853                 q->next = p->next;
854             } else {
855                 _nc_prescreen.allocated = p->next;
856             }
857             free(p);
858             break;
859         }
860     }
861 }
862 #endif /* USE_PTHREADS */
863
864 #if NCURSES_SP_FUNCS
865 /*
866  * In case of handling multiple screens, we need to have a screen before
867  * initialization in _nc_setupscreen takes place.  This is to extend the
868  * substitute for some of the stuff in _nc_prescreen, especially for slk and
869  * ripoff handling which should be done per screen.
870  */
871 NCURSES_EXPORT(SCREEN *)
872 new_prescr(void)
873 {
874     SCREEN *sp;
875
876     START_TRACE();
877     T((T_CALLED("new_prescr()")));
878
879     _nc_lock_global(screen);
880     if ((sp = _nc_find_prescr()) == 0) {
881         sp = _nc_alloc_screen_sp();
882         T(("_nc_alloc_screen_sp %p", (void *) sp));
883         if (sp != 0) {
884 #ifdef USE_PTHREADS
885             PRESCREEN_LIST *p = typeCalloc(PRESCREEN_LIST, 1);
886             if (p != 0) {
887                 p->id = GetThreadID();
888                 p->sp = sp;
889                 p->next = _nc_prescreen.allocated;
890                 _nc_prescreen.allocated = p;
891             }
892 #else
893             _nc_prescreen.allocated = sp;
894 #endif
895             sp->rsp = sp->rippedoff;
896             sp->_filtered = _nc_prescreen.filter_mode;
897             sp->_use_env = _nc_prescreen.use_env;
898 #if NCURSES_NO_PADDING
899             sp->_no_padding = _nc_prescreen._no_padding;
900 #endif
901             sp->slk_format = 0;
902             sp->_slk = 0;
903             sp->_prescreen = TRUE;
904             SP_PRE_INIT(sp);
905 #if USE_REENTRANT
906             sp->_TABSIZE = _nc_prescreen._TABSIZE;
907             sp->_ESCDELAY = _nc_prescreen._ESCDELAY;
908 #endif
909         }
910     } else {
911         T(("_nc_alloc_screen_sp %p (reuse)", (void *) sp));
912     }
913     _nc_unlock_global(screen);
914     returnSP(sp);
915 }
916 #endif
917
918 #ifdef USE_TERM_DRIVER
919 /*
920  * This entrypoint is called from tgetent() to allow a special case of reusing
921  * the same TERMINAL data (see comment).
922  */
923 NCURSES_EXPORT(int)
924 _nc_setupterm(const char *tname,
925               int Filedes,
926               int *errret,
927               int reuse)
928 {
929     int rc = ERR;
930     TERMINAL *termp = 0;
931
932     _nc_lock_global(prescreen);
933     START_TRACE();
934     if (TINFO_SETUP_TERM(&termp, tname, Filedes, errret, reuse) == OK) {
935         _nc_forget_prescr();
936         if (NCURSES_SP_NAME(set_curterm) (CURRENT_SCREEN_PRE, termp) != 0) {
937             rc = OK;
938         }
939     }
940     _nc_unlock_global(prescreen);
941     return rc;
942 }
943 #endif
944
945 /*
946  *      setupterm(termname, Filedes, errret)
947  *
948  *      Find and read the appropriate object file for the terminal
949  *      Make cur_term point to the structure.
950  */
951 NCURSES_EXPORT(int)
952 setupterm(const char *tname, int Filedes, int *errret)
953 {
954     START_TRACE();
955     return _nc_setupterm(tname, Filedes, errret, FALSE);
956 }