1 /****************************************************************************
2 * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
37 * Terminal setup routines common to termcap and terminfo:
41 * setupterm(char *, int, int *)
44 #include <curses.priv.h>
45 #include <tic.h> /* for MAX_NAME_SIZE */
51 MODULE_ID("$Id: lib_setup.c,v 1.197 2018/11/24 22:13:16 tom Exp $")
53 /****************************************************************************
55 * Terminal size computation
57 ****************************************************************************/
60 # if !defined(sun) || !TERMIOS
62 # include <sys/ioctl.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).
71 # include <sys/stream.h>
72 # include <sys/ptem.h>
75 #if HAVE_LANGINFO_CODESET
80 * SCO defines TIOCGSIZE and the corresponding struct. Other systems (SunOS,
81 * Solaris, IRIX) define TIOCGWINSZ and struct winsize.
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
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
98 * Reduce explicit use of "cur_term" global variable.
101 #define CUR TerminalType(termp).
104 * Wrap global variables in this module.
108 NCURSES_EXPORT(char *)
109 NCURSES_PUBLIC_VAR(ttytype) (void)
111 static char empty[] = "";
112 char *result = empty;
115 if (CURRENT_SCREEN) {
116 TERMINAL *termp = TerminalOf(CURRENT_SCREEN);
118 result = TerminalType(termp).term_names;
123 result = TerminalType(cur_term).term_names;
129 NCURSES_EXPORT(int *)
130 _nc_ptr_Lines(SCREEN *sp)
136 NCURSES_PUBLIC_VAR(LINES) (void)
138 return *_nc_ptr_Lines(CURRENT_SCREEN);
141 NCURSES_EXPORT(int *)
142 _nc_ptr_Cols(SCREEN *sp)
148 NCURSES_PUBLIC_VAR(COLS) (void)
150 return *_nc_ptr_Cols(CURRENT_SCREEN);
153 NCURSES_EXPORT(int *)
154 _nc_ptr_Tabsize(SCREEN *sp)
156 return ptrTabsize(sp);
160 NCURSES_PUBLIC_VAR(TABSIZE) (void)
162 return *_nc_ptr_Tabsize(CURRENT_SCREEN);
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;
171 #if NCURSES_EXT_FUNCS
173 NCURSES_SP_NAME(set_tabsize) (NCURSES_SP_DCLx int value)
178 SP_PARM->_TABSIZE = value;
191 set_tabsize(int value)
193 return NCURSES_SP_NAME(set_tabsize) (CURRENT_SCREEN, value);
196 #endif /* NCURSES_EXT_FUNCS */
200 * If we have a pending SIGWINCH, set the flag in each screen.
203 _nc_handle_sigwinch(SCREEN *sp)
207 if (_nc_globals.have_sigwinch) {
208 _nc_globals.have_sigwinch = 0;
210 for (each_screen(scan)) {
211 scan->_sig_winch = TRUE;
215 return (sp ? sp->_sig_winch : 0);
221 NCURSES_SP_NAME(use_env) (NCURSES_SP_DCLx bool f)
224 T((T_CALLED("use_env(%p,%d)"), (void *) SP_PARM, (int) f));
226 if (IsPreScreen(SP_PARM)) {
227 SP_PARM->_use_env = f;
230 _nc_prescreen.use_env = f;
236 NCURSES_SP_NAME(use_tioctl) (NCURSES_SP_DCLx bool f)
239 T((T_CALLED("use_tioctl(%p,%d)"), (void *) SP_PARM, (int) f));
241 if (IsPreScreen(SP_PARM)) {
242 SP_PARM->use_tioctl = f;
245 _nc_prescreen.use_tioctl = f;
255 T((T_CALLED("use_env(%d)"), (int) f));
256 _nc_prescreen.use_env = f;
264 T((T_CALLED("use_tioctl(%d)"), (int) f));
265 _nc_prescreen.use_tioctl = f;
271 _nc_get_screensize(SCREEN *sp,
272 #ifdef USE_TERM_DRIVER
275 int *linep, int *colp)
276 /* Obtain lines/columns values from the environment and/or terminfo entry */
278 #ifdef USE_TERM_DRIVER
279 TERMINAL_CONTROL_BLOCK *TCB;
282 assert(termp != 0 && linep != 0 && colp != 0);
283 TCB = (TERMINAL_CONTROL_BLOCK *) termp;
285 my_tabsize = TCB->info.tabsize;
286 TCB->drv->td_size(TCB, linep, colp);
290 sp->_TABSIZE = my_tabsize;
294 TABSIZE = my_tabsize;
296 T(("TABSIZE = %d", my_tabsize));
297 #else /* !USE_TERM_DRIVER */
298 TERMINAL *termp = cur_term;
300 bool useEnv = _nc_prescreen.use_env;
301 bool useTioctl = _nc_prescreen.use_tioctl;
303 /* figure out the size of the screen */
304 T(("screen size: terminfo lines = %d columns = %d", lines, columns));
306 *linep = (int) lines;
307 *colp = (int) columns;
311 useEnv = sp->_use_env;
312 useTioctl = sp->use_tioctl;
316 if (useEnv || useTioctl) {
320 _scrsize(screendata);
321 *colp = screendata[0];
322 *linep = ((sp != 0 && sp->_filtered)
325 T(("EMX screen size: environment LINES = %d COLUMNS = %d",
330 /* try asking the OS */
331 if (NC_ISATTY(cur_term->Filedes)) {
336 if (ioctl(cur_term->Filedes, IOCTL_WINSIZE, &size) >= 0) {
337 *linep = ((sp != 0 && sp->_filtered)
339 : WINSIZE_ROWS(size));
340 *colp = WINSIZE_COLS(size);
341 T(("SYS screen size: environment LINES = %d COLUMNS = %d",
348 #endif /* HAVE_SIZECHANGE */
355 * If environment variables are used, update them.
357 if ((sp == 0 || !sp->_filtered) && _nc_getenv_num("LINES") > 0) {
358 _nc_setenv_num("LINES", *linep);
360 if (_nc_getenv_num("COLUMNS") > 0) {
361 _nc_setenv_num("COLUMNS", *colp);
366 * Finally, look for environment variables.
368 * Solaris lets users override either dimension with an environment
371 if ((value = _nc_getenv_num("LINES")) > 0) {
373 T(("screen size: environment LINES = %d", *linep));
375 if ((value = _nc_getenv_num("COLUMNS")) > 0) {
377 T(("screen size: environment COLUMNS = %d", *colp));
381 /* if we can't get dynamic info about the size, use static */
383 *linep = (int) lines;
386 *colp = (int) columns;
389 /* the ultimate fallback, assume fixed 24x80 size */
398 * Put the derived values back in the screen-size caps, so
399 * tigetnum() and tgetnum() will do the right thing.
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);
411 T(("screen size is %dx%d", *linep, *colp));
413 if (VALID_NUMERIC(init_tabs))
414 my_tabsize = (int) init_tabs;
420 sp->_TABSIZE = my_tabsize;
422 TABSIZE = my_tabsize;
424 T(("TABSIZE = %d", TABSIZE));
425 #endif /* USE_TERM_DRIVER */
430 _nc_update_screensize(SCREEN *sp)
435 #ifdef USE_TERM_DRIVER
441 CallDriver_2(sp, td_getsize, &old_lines, &old_cols);
444 TERMINAL *termp = cur_term;
445 int old_lines = lines;
446 int old_cols = columns;
449 TINFO_GET_SIZE(sp, sp->_term, &new_lines, &new_cols);
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.
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 */
462 sp->_sig_winch = FALSE;
467 /****************************************************************************
471 ****************************************************************************/
473 #if NCURSES_USE_DATABASE || NCURSES_USE_TERMCAP
475 * Return 1 if entry found, 0 if not found, -1 if database not accessible,
476 * just like tgetent().
479 _nc_setup_tinfo(const char *const tn, TERMTYPE2 *const tp)
481 char filename[PATH_MAX];
482 int status = _nc_read_entry2(tn, filename, tp);
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).
490 if (status == TGETENT_YES) {
492 for_each_boolean(n, tp) {
493 if (!VALID_BOOLEAN(tp->Booleans[n]))
494 tp->Booleans[n] = FALSE;
496 for_each_string(n, tp) {
497 if (tp->Strings[n] == CANCELLED_STRING)
498 tp->Strings[n] = ABSENT_STRING;
506 ** Take the real command character out of the CC environment variable
507 ** and substitute it in for the prototype given in 'command_character'.
510 _nc_tinfo_cmdch(TERMINAL *termp, int proto)
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.
519 if ((tmp = getenv("CC")) != 0 && strlen(tmp) == 1) {
523 for_each_string(i, &(termp->type)) {
524 for (tmp = termp->type.Strings[i]; tmp && *tmp; tmp++) {
525 if (UChar(*tmp) == proto)
533 * Find the locale which is in effect.
535 NCURSES_EXPORT(char *)
541 * This is preferable to using getenv() since it ensures that we are using
542 * the locale which was actually initialized by the application.
544 env = setlocale(LC_CTYPE, 0);
546 if (((env = getenv("LANG")) != 0 && *env != '\0')
547 || ((env = getenv("LC_CTYPE")) != 0 && *env != '\0')
548 || ((env = getenv("LC_ALL")) != 0 && *env != '\0')) {
552 T(("_nc_get_locale %s", _nc_visbuf(env)));
557 * Check if we are running in a UTF-8 locale.
560 _nc_unicode_locale(void)
563 #if defined(_WIN32) && USE_WIDEC_SUPPORT
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));
570 char *env = _nc_get_locale();
572 if (strstr(env, ".UTF-8") != 0) {
574 T(("_nc_unicode_locale(%s) ->%d", env, result));
581 #define CONTROL_N(s) ((s) != 0 && strstr(s, "\016") != 0)
582 #define CONTROL_O(s) ((s) != 0 && strstr(s, "\017") != 0)
585 * Check for known broken cases where a UTF-8 locale breaks the alternate
589 _nc_locale_breaks_acs(TERMINAL *termp)
591 const char *env_name = "NCURSES_NO_UTF8_ACS";
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)) {
620 TINFO_SETUP_TERM(TERMINAL **tp,
626 #ifdef USE_TERM_DRIVER
627 TERMINAL_CONTROL_BLOCK *TCB = 0;
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));
640 ret_error0(TGETENT_ERR,
641 "Invalid parameter, internal error.\n");
646 T((T_CALLED("setupterm(%s,%d,%p)"), _nc_visbuf(tname), Filedes, (void *) errret));
650 tname = getenv("TERM");
651 if (tname == 0 || *tname == '\0') {
652 #ifdef USE_TERM_DRIVER
655 ret_error0(TGETENT_ERR, "TERM environment variable not set.\n");
660 if (strlen(tname) > MAX_NAME_SIZE) {
661 ret_error(TGETENT_ERR,
662 "TERM environment must be <= %d characters.\n",
666 T(("your terminal name is %s", tname));
669 * Allow output redirection. This is what SVr3 does. If stdout is
670 * directed to a file, screen updates go to standard error.
672 if (Filedes == STDOUT_FILENO && !NC_ISATTY(Filedes))
673 Filedes = STDERR_FILENO;
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.
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).
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"));
699 #ifdef USE_TERM_DRIVER
700 TCB = (TERMINAL_CONTROL_BLOCK *) termp;
703 #ifdef USE_TERM_DRIVER
704 TERMINAL_CONTROL_BLOCK *my_tcb;
706 if ((my_tcb = typeCalloc(TERMINAL_CONTROL_BLOCK, 1)) != 0)
707 termp = &(my_tcb->term);
711 termp = typeCalloc(TERMINAL, 1);
714 ret_error0(TGETENT_ERR,
715 "Not enough memory to create terminal structure.\n");
723 limit = _nc_globals.getstr_limit;
726 if (limit < sysconf(_SC_LINE_MAX))
727 limit = sysconf(_SC_LINE_MAX);
729 if (_nc_globals.getstr_limit < (int) limit)
730 _nc_globals.getstr_limit = (int) limit;
732 #endif /* HAVE_SYSCONF */
733 T(("using %d for getstr limit", _nc_globals.getstr_limit));
735 #ifdef USE_TERM_DRIVER
737 TCB = (TERMINAL_CONTROL_BLOCK *) termp;
738 code = _nc_globals.term_driver(TCB, tname, errret);
740 termp->Filedes = (short) Filedes;
741 termp->_termname = strdup(tname);
743 ret_error0(errret ? *errret : TGETENT_ERR,
744 "Could not find any driver to handle this terminal.\n");
747 #if NCURSES_USE_DATABASE || NCURSES_USE_TERMCAP
748 status = _nc_setup_tinfo(tname, &TerminalType(termp));
749 T(("_nc_setup_tinfo returns %d", status));
751 T(("no database available"));
755 /* try fallback list if entry on disk */
756 if (status != TGETENT_YES) {
757 const TERMTYPE2 *fallback = _nc_fallback2(tname);
760 T(("found fallback entry"));
761 TerminalType(termp) = *fallback;
762 status = TGETENT_YES;
766 if (status != TGETENT_YES) {
768 if (status == TGETENT_ERR) {
769 ret_error0(status, "terminals database is inaccessible\n");
770 } else if (status == TGETENT_NO) {
771 ret_error1(status, "unknown terminal type.\n", tname);
774 #if NCURSES_EXT_NUMBERS
775 _nc_export_termtype2(&termp->type, &TerminalType(termp));
781 termp->Filedes = (short) Filedes;
782 termp->_termname = strdup(tname);
786 if (command_character)
787 _nc_tinfo_cmdch(termp, UChar(*command_character));
790 * If an application calls setupterm() rather than initscr() or
791 * newterm(), we will not have the def_prog_mode() call in
792 * _nc_setupscreen(). Do it now anyway, so we can initialize the
793 * baudrate. Also get the shell-mode so that erasechar() works.
795 if (NC_ISATTY(Filedes)) {
796 NCURSES_SP_NAME(def_shell_mode) (NCURSES_SP_ARG);
797 NCURSES_SP_NAME(def_prog_mode) (NCURSES_SP_ARG);
804 #ifdef USE_TERM_DRIVER
806 NCURSES_SP_NAME(set_curterm) (sp, termp);
807 TCB->drv->td_init(TCB);
813 * We should always check the screensize, just in case.
815 TINFO_GET_SIZE(sp, termp, ptrLines(sp), ptrCols(sp));
818 *errret = TGETENT_YES;
820 #ifndef USE_TERM_DRIVER
823 * BSD 4.3's termcap contains mis-typed "gn" for wy99. Do a sanity
824 * check before giving up.
826 if ((VALID_STRING(cursor_address)
827 || (VALID_STRING(cursor_down) && VALID_STRING(cursor_home)))
828 && VALID_STRING(clear_screen)) {
829 ret_error1(TGETENT_YES, "terminal is not really generic.\n", tname);
832 ret_error1(TGETENT_NO, "I need something more specific.\n", tname);
834 } else if (hard_copy) {
835 ret_error1(TGETENT_YES, "I can't handle hardcopy terminals.\n", tname);
843 * Returns a non-null pointer unless a new screen should be allocated because
844 * no match was found in the pre-screen cache.
846 NCURSES_EXPORT(SCREEN *)
847 _nc_find_prescr(void)
851 pthread_t id = GetThreadID();
852 for (p = _nc_prescreen.allocated; p != 0; p = p->next) {
862 * Tells ncurses to forget that this thread was associated with the pre-screen
863 * cache. It does not modify the pre-screen cache itself, since that is used
864 * for creating new screens.
867 _nc_forget_prescr(void)
869 PRESCREEN_LIST *p, *q;
870 pthread_t id = GetThreadID();
871 for (p = _nc_prescreen.allocated, q = 0; p != 0; q = p, p = p->next) {
876 _nc_prescreen.allocated = p->next;
883 #endif /* USE_PTHREADS */
887 * In case of handling multiple screens, we need to have a screen before
888 * initialization in _nc_setupscreen takes place. This is to extend the
889 * substitute for some of the stuff in _nc_prescreen, especially for slk and
890 * ripoff handling which should be done per screen.
892 NCURSES_EXPORT(SCREEN *)
898 T((T_CALLED("new_prescr()")));
900 _nc_lock_global(screen);
901 if ((sp = _nc_find_prescr()) == 0) {
902 sp = _nc_alloc_screen_sp();
903 T(("_nc_alloc_screen_sp %p", (void *) sp));
906 PRESCREEN_LIST *p = typeCalloc(PRESCREEN_LIST, 1);
908 p->id = GetThreadID();
910 p->next = _nc_prescreen.allocated;
911 _nc_prescreen.allocated = p;
914 _nc_prescreen.allocated = sp;
916 sp->rsp = sp->rippedoff;
917 sp->_filtered = _nc_prescreen.filter_mode;
918 sp->_use_env = _nc_prescreen.use_env;
919 #if NCURSES_NO_PADDING
920 sp->_no_padding = _nc_prescreen._no_padding;
924 sp->_prescreen = TRUE;
927 sp->_TABSIZE = _nc_prescreen._TABSIZE;
928 sp->_ESCDELAY = _nc_prescreen._ESCDELAY;
932 T(("_nc_alloc_screen_sp %p (reuse)", (void *) sp));
934 _nc_unlock_global(screen);
939 #ifdef USE_TERM_DRIVER
941 * This entrypoint is called from tgetent() to allow a special case of reusing
942 * the same TERMINAL data (see comment).
945 _nc_setupterm(const char *tname,
953 _nc_lock_global(prescreen);
955 if (TINFO_SETUP_TERM(&termp, tname, Filedes, errret, reuse) == OK) {
957 if (NCURSES_SP_NAME(set_curterm) (CURRENT_SCREEN_PRE, termp) != 0) {
961 _nc_unlock_global(prescreen);
967 * setupterm(termname, Filedes, errret)
969 * Find and read the appropriate object file for the terminal
970 * Make cur_term point to the structure.
973 setupterm(const char *tname, int Filedes, int *errret)
976 return _nc_setupterm(tname, Filedes, errret, FALSE);