1 /****************************************************************************
2 * Copyright (c) 1998-2018,2019 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.206 2019/11/03 00:07:45 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)
181 SP_PARM->_TABSIZE = value;
195 set_tabsize(int value)
197 return NCURSES_SP_NAME(set_tabsize) (CURRENT_SCREEN, value);
200 #endif /* NCURSES_EXT_FUNCS */
204 * If we have a pending SIGWINCH, set the flag in each screen.
207 _nc_handle_sigwinch(SCREEN *sp)
211 if (_nc_globals.have_sigwinch) {
212 _nc_globals.have_sigwinch = 0;
214 for (each_screen(scan)) {
215 scan->_sig_winch = TRUE;
219 return (sp ? sp->_sig_winch : 0);
225 NCURSES_SP_NAME(use_env) (NCURSES_SP_DCLx bool f)
228 T((T_CALLED("use_env(%p,%d)"), (void *) SP_PARM, (int) f));
230 if (IsPreScreen(SP_PARM)) {
231 SP_PARM->_use_env = f;
234 _nc_prescreen.use_env = f;
240 NCURSES_SP_NAME(use_tioctl) (NCURSES_SP_DCLx bool f)
243 T((T_CALLED("use_tioctl(%p,%d)"), (void *) SP_PARM, (int) f));
245 if (IsPreScreen(SP_PARM)) {
246 SP_PARM->use_tioctl = f;
249 _nc_prescreen.use_tioctl = f;
259 T((T_CALLED("use_env(%d)"), (int) f));
260 _nc_prescreen.use_env = f;
268 T((T_CALLED("use_tioctl(%d)"), (int) f));
269 _nc_prescreen.use_tioctl = f;
275 _nc_get_screensize(SCREEN *sp,
276 #ifdef USE_TERM_DRIVER
279 int *linep, int *colp)
280 /* Obtain lines/columns values from the environment and/or terminfo entry */
282 #ifdef USE_TERM_DRIVER
283 TERMINAL_CONTROL_BLOCK *TCB;
286 assert(termp != 0 && linep != 0 && colp != 0);
287 TCB = (TERMINAL_CONTROL_BLOCK *) termp;
289 my_tabsize = TCB->info.tabsize;
290 TCB->drv->td_size(TCB, linep, colp);
294 sp->_TABSIZE = my_tabsize;
298 TABSIZE = my_tabsize;
300 T(("TABSIZE = %d", my_tabsize));
301 #else /* !USE_TERM_DRIVER */
302 TERMINAL *termp = cur_term;
304 bool useEnv = _nc_prescreen.use_env;
305 bool useTioctl = _nc_prescreen.use_tioctl;
307 /* figure out the size of the screen */
308 T(("screen size: terminfo lines = %d columns = %d", lines, columns));
310 *linep = (int) lines;
311 *colp = (int) columns;
315 useEnv = sp->_use_env;
316 useTioctl = sp->use_tioctl;
320 if (useEnv || useTioctl) {
324 _scrsize(screendata);
325 *colp = screendata[0];
326 *linep = ((sp != 0 && sp->_filtered)
329 T(("EMX screen size: environment LINES = %d COLUMNS = %d",
334 /* try asking the OS */
335 if (NC_ISATTY(cur_term->Filedes)) {
340 if (ioctl(cur_term->Filedes, IOCTL_WINSIZE, &size) >= 0) {
341 *linep = ((sp != 0 && sp->_filtered)
343 : WINSIZE_ROWS(size));
344 *colp = WINSIZE_COLS(size);
345 T(("SYS screen size: environment LINES = %d COLUMNS = %d",
352 #endif /* HAVE_SIZECHANGE */
359 * If environment variables are used, update them.
361 if ((sp == 0 || !sp->_filtered) && _nc_getenv_num("LINES") > 0) {
362 _nc_setenv_num("LINES", *linep);
364 if (_nc_getenv_num("COLUMNS") > 0) {
365 _nc_setenv_num("COLUMNS", *colp);
370 * Finally, look for environment variables.
372 * Solaris lets users override either dimension with an environment
375 if ((value = _nc_getenv_num("LINES")) > 0) {
377 T(("screen size: environment LINES = %d", *linep));
379 if ((value = _nc_getenv_num("COLUMNS")) > 0) {
381 T(("screen size: environment COLUMNS = %d", *colp));
385 /* if we can't get dynamic info about the size, use static */
387 *linep = (int) lines;
390 *colp = (int) columns;
393 /* the ultimate fallback, assume fixed 24x80 size */
402 * Put the derived values back in the screen-size caps, so
403 * tigetnum() and tgetnum() will do the right thing.
405 lines = (NCURSES_INT2) (*linep);
406 columns = (NCURSES_INT2) (*colp);
407 #if NCURSES_EXT_NUMBERS
408 #define OldNumber(termp,name) \
409 (termp)->type.Numbers[(&name - (termp)->type2.Numbers)]
410 OldNumber(termp, lines) = (short) (*linep);
411 OldNumber(termp, columns) = (short) (*colp);
415 T(("screen size is %dx%d", *linep, *colp));
417 if (VALID_NUMERIC(init_tabs))
418 my_tabsize = (int) init_tabs;
424 sp->_TABSIZE = my_tabsize;
426 TABSIZE = my_tabsize;
428 T(("TABSIZE = %d", TABSIZE));
429 #endif /* USE_TERM_DRIVER */
434 _nc_update_screensize(SCREEN *sp)
439 #ifdef USE_TERM_DRIVER
445 CallDriver_2(sp, td_getsize, &old_lines, &old_cols);
448 TERMINAL *termp = cur_term;
449 int old_lines = lines;
450 int old_cols = columns;
454 TINFO_GET_SIZE(sp, sp->_term, &new_lines, &new_cols);
456 * See is_term_resized() and resizeterm().
457 * We're doing it this way because those functions belong to the upper
458 * ncurses library, while this resides in the lower terminfo library.
460 if (sp->_resize != 0) {
461 if ((new_lines != old_lines) || (new_cols != old_cols)) {
462 sp->_resize(NCURSES_SP_ARGx new_lines, new_cols);
463 } else if (sp->_sig_winch && (sp->_ungetch != 0)) {
464 sp->_ungetch(SP_PARM, KEY_RESIZE); /* so application can know this */
466 sp->_sig_winch = FALSE;
470 #endif /* USE_SIZECHANGE */
472 /****************************************************************************
476 ****************************************************************************/
478 #if NCURSES_USE_DATABASE || NCURSES_USE_TERMCAP
480 * Return 1 if entry found, 0 if not found, -1 if database not accessible,
481 * just like tgetent().
484 _nc_setup_tinfo(const char *const tn, TERMTYPE2 *const tp)
486 char filename[PATH_MAX];
487 int status = _nc_read_entry2(tn, filename, tp);
490 * If we have an entry, force all of the cancelled strings to null
491 * pointers so we don't have to test them in the rest of the library.
492 * (The terminfo compiler bypasses this logic, since it must know if
493 * a string is cancelled, for merging entries).
495 if (status == TGETENT_YES) {
497 for_each_boolean(n, tp) {
498 if (!VALID_BOOLEAN(tp->Booleans[n]))
499 tp->Booleans[n] = FALSE;
501 for_each_string(n, tp) {
502 if (tp->Strings[n] == CANCELLED_STRING)
503 tp->Strings[n] = ABSENT_STRING;
511 ** Take the real command character out of the CC environment variable
512 ** and substitute it in for the prototype given in 'command_character'.
515 _nc_tinfo_cmdch(TERMINAL *termp, int proto)
520 * Only use the character if the string is a single character,
521 * since it is fairly common for developers to set the C compiler
522 * name as an environment variable - using the same symbol.
524 if ((tmp = getenv("CC")) != 0 && strlen(tmp) == 1) {
528 for_each_string(i, &(termp->type)) {
529 for (tmp = termp->type.Strings[i]; tmp && *tmp; tmp++) {
530 if (UChar(*tmp) == proto)
538 * Find the locale which is in effect.
540 NCURSES_EXPORT(char *)
546 * This is preferable to using getenv() since it ensures that we are using
547 * the locale which was actually initialized by the application.
549 env = setlocale(LC_CTYPE, 0);
551 if (((env = getenv("LANG")) != 0 && *env != '\0')
552 || ((env = getenv("LC_CTYPE")) != 0 && *env != '\0')
553 || ((env = getenv("LC_ALL")) != 0 && *env != '\0')) {
557 T(("_nc_get_locale %s", _nc_visbuf(env)));
562 * Check if we are running in a UTF-8 locale.
565 _nc_unicode_locale(void)
568 #if defined(_WIN32) && USE_WIDEC_SUPPORT
570 #elif HAVE_LANGINFO_CODESET
571 char *env = nl_langinfo(CODESET);
572 result = !strcmp(env, "UTF-8");
573 T(("_nc_unicode_locale(%s) ->%d", env, result));
575 char *env = _nc_get_locale();
577 if (strstr(env, ".UTF-8") != 0) {
579 T(("_nc_unicode_locale(%s) ->%d", env, result));
586 #define CONTROL_N(s) ((s) != 0 && strstr(s, "\016") != 0)
587 #define CONTROL_O(s) ((s) != 0 && strstr(s, "\017") != 0)
590 * Check for known broken cases where a UTF-8 locale breaks the alternate
594 _nc_locale_breaks_acs(TERMINAL *termp)
596 const char *env_name = "NCURSES_NO_UTF8_ACS";
601 T((T_CALLED("_nc_locale_breaks_acs:%d"), result));
602 if (getenv(env_name) != 0) {
603 result = _nc_getenv_num(env_name);
604 } else if ((value = tigetnum("U8")) >= 0) {
605 result = value; /* use extension feature */
606 } else if ((env = getenv("TERM")) != 0) {
607 if (strstr(env, "linux")) {
608 result = 1; /* always broken */
609 } else if (strstr(env, "screen") != 0
610 && ((env = getenv("TERMCAP")) != 0
611 && strstr(env, "screen") != 0)
612 && strstr(env, "hhII00") != 0) {
613 if (CONTROL_N(enter_alt_charset_mode) ||
614 CONTROL_O(enter_alt_charset_mode) ||
615 CONTROL_N(set_attributes) ||
616 CONTROL_O(set_attributes)) {
625 TINFO_SETUP_TERM(TERMINAL **tp,
631 #ifdef USE_TERM_DRIVER
632 TERMINAL_CONTROL_BLOCK *TCB = 0;
641 #ifdef USE_TERM_DRIVER
642 T((T_CALLED("_nc_setupterm_ex(%p,%s,%d,%p)"),
643 (void *) tp, _nc_visbuf(tname), Filedes, (void *) errret));
646 ret_error0(TGETENT_ERR,
647 "Invalid parameter, internal error.\n");
652 T((T_CALLED("setupterm(%s,%d,%p)"), _nc_visbuf(tname), Filedes, (void *) errret));
656 tname = getenv("TERM");
657 if (tname == 0 || *tname == '\0') {
658 #ifdef USE_TERM_DRIVER
661 ret_error0(TGETENT_ERR, "TERM environment variable not set.\n");
665 myname = strdup(tname);
667 if (strlen(myname) > MAX_NAME_SIZE) {
668 ret_error(TGETENT_ERR,
669 "TERM environment must be <= %d characters.\n",
674 T(("your terminal name is %s", myname));
677 * Allow output redirection. This is what SVr3 does. If stdout is
678 * directed to a file, screen updates go to standard error.
680 if (Filedes == STDOUT_FILENO && !NC_ISATTY(Filedes))
681 Filedes = STDERR_FILENO;
684 * Check if we have already initialized to use this terminal. If so, we
685 * do not need to re-read the terminfo entry, or obtain TTY settings.
687 * This is an improvement on SVr4 curses. If an application mixes curses
688 * and termcap calls, it may call both initscr and tgetent. This is not
689 * really a good thing to do, but can happen if someone tries using ncurses
690 * with the readline library. The problem we are fixing is that when
691 * tgetent calls setupterm, the resulting Ottyb struct in cur_term is
692 * zeroed. A subsequent call to endwin uses the zeroed terminal settings
693 * rather than the ones saved in initscr. So we check if cur_term appears
694 * to contain terminal settings for the same output file as our current
695 * call - and copy those terminal settings. (SVr4 curses does not do this,
696 * however applications that are working around the problem will still work
697 * properly with this feature).
701 && termp->Filedes == Filedes
702 && termp->_termname != 0
703 && !strcmp(termp->_termname, myname)
704 && _nc_name_match(TerminalType(termp).term_names, myname, "|")) {
705 T(("reusing existing terminal information and mode-settings"));
707 #ifdef USE_TERM_DRIVER
708 TCB = (TERMINAL_CONTROL_BLOCK *) termp;
711 #ifdef USE_TERM_DRIVER
712 TERMINAL_CONTROL_BLOCK *my_tcb;
714 if ((my_tcb = typeCalloc(TERMINAL_CONTROL_BLOCK, 1)) != 0)
715 termp = &(my_tcb->term);
719 termp = typeCalloc(TERMINAL, 1);
722 ret_error1(TGETENT_ERR,
723 "Not enough memory to create terminal structure.\n",
724 myname, free(myname));
732 limit = _nc_globals.getstr_limit;
735 if (limit < sysconf(_SC_LINE_MAX))
736 limit = sysconf(_SC_LINE_MAX);
738 if (_nc_globals.getstr_limit < (int) limit)
739 _nc_globals.getstr_limit = (int) limit;
741 #endif /* HAVE_SYSCONF */
742 T(("using %d for getstr limit", _nc_globals.getstr_limit));
744 #ifdef USE_TERM_DRIVER
746 TCB = (TERMINAL_CONTROL_BLOCK *) termp;
747 code = _nc_globals.term_driver(TCB, myname, errret);
749 termp->Filedes = (short) Filedes;
750 termp->_termname = strdup(myname);
752 ret_error1(errret ? *errret : TGETENT_ERR,
753 "Could not find any driver to handle terminal.\n",
754 myname, free(myname));
757 #if NCURSES_USE_DATABASE || NCURSES_USE_TERMCAP
758 status = _nc_setup_tinfo(myname, &TerminalType(termp));
759 T(("_nc_setup_tinfo returns %d", status));
761 T(("no database available"));
765 /* try fallback list if entry on disk */
766 if (status != TGETENT_YES) {
767 const TERMTYPE2 *fallback = _nc_fallback2(myname);
770 T(("found fallback entry"));
771 _nc_copy_termtype2(&(TerminalType(termp)), fallback);
772 status = TGETENT_YES;
776 if (status != TGETENT_YES) {
778 if (status == TGETENT_ERR) {
780 ret_error0(status, "terminals database is inaccessible\n");
781 } else if (status == TGETENT_NO) {
782 ret_error1(status, "unknown terminal type.\n",
783 myname, free(myname));
785 ret_error0(status, "unexpected return-code\n");
788 #if NCURSES_EXT_NUMBERS
789 _nc_export_termtype2(&termp->type, &TerminalType(termp));
795 termp->Filedes = (short) Filedes;
796 termp->_termname = strdup(myname);
800 if (command_character)
801 _nc_tinfo_cmdch(termp, UChar(*command_character));
804 * If an application calls setupterm() rather than initscr() or
805 * newterm(), we will not have the def_prog_mode() call in
806 * _nc_setupscreen(). Do it now anyway, so we can initialize the
807 * baudrate. Also get the shell-mode so that erasechar() works.
809 if (NC_ISATTY(Filedes)) {
810 NCURSES_SP_NAME(def_shell_mode) (NCURSES_SP_ARG);
811 NCURSES_SP_NAME(def_prog_mode) (NCURSES_SP_ARG);
818 #ifdef USE_TERM_DRIVER
820 NCURSES_SP_NAME(set_curterm) (sp, termp);
821 TCB->drv->td_init(TCB);
827 * We should always check the screensize, just in case.
829 TINFO_GET_SIZE(sp, termp, ptrLines(sp), ptrCols(sp));
832 *errret = TGETENT_YES;
834 #ifndef USE_TERM_DRIVER
837 * BSD 4.3's termcap contains mis-typed "gn" for wy99. Do a sanity
838 * check before giving up.
840 if ((VALID_STRING(cursor_address)
841 || (VALID_STRING(cursor_down) && VALID_STRING(cursor_home)))
842 && VALID_STRING(clear_screen)) {
843 ret_error1(TGETENT_YES, "terminal is not really generic.\n",
844 myname, free(myname));
847 ret_error1(TGETENT_NO, "I need something more specific.\n",
848 myname, free(myname));
850 } else if (hard_copy) {
851 ret_error1(TGETENT_YES, "I can't handle hardcopy terminals.\n",
852 myname, free(myname));
861 * Returns a non-null pointer unless a new screen should be allocated because
862 * no match was found in the pre-screen cache.
864 NCURSES_EXPORT(SCREEN *)
865 _nc_find_prescr(void)
869 pthread_t id = GetThreadID();
870 for (p = _nc_prescreen.allocated; p != 0; p = p->next) {
880 * Tells ncurses to forget that this thread was associated with the pre-screen
881 * cache. It does not modify the pre-screen cache itself, since that is used
882 * for creating new screens.
885 _nc_forget_prescr(void)
887 PRESCREEN_LIST *p, *q;
888 pthread_t id = GetThreadID();
889 for (p = _nc_prescreen.allocated, q = 0; p != 0; q = p, p = p->next) {
894 _nc_prescreen.allocated = p->next;
901 #endif /* USE_PTHREADS */
905 * In case of handling multiple screens, we need to have a screen before
906 * initialization in _nc_setupscreen takes place. This is to extend the
907 * substitute for some of the stuff in _nc_prescreen, especially for slk and
908 * ripoff handling which should be done per screen.
910 NCURSES_EXPORT(SCREEN *)
916 T((T_CALLED("new_prescr()")));
918 _nc_lock_global(screen);
919 if ((sp = _nc_find_prescr()) == 0) {
920 sp = _nc_alloc_screen_sp();
921 T(("_nc_alloc_screen_sp %p", (void *) sp));
924 PRESCREEN_LIST *p = typeCalloc(PRESCREEN_LIST, 1);
926 p->id = GetThreadID();
928 p->next = _nc_prescreen.allocated;
929 _nc_prescreen.allocated = p;
932 _nc_prescreen.allocated = sp;
934 sp->rsp = sp->rippedoff;
935 sp->_filtered = _nc_prescreen.filter_mode;
936 sp->_use_env = _nc_prescreen.use_env;
937 #if NCURSES_NO_PADDING
938 sp->_no_padding = _nc_prescreen._no_padding;
942 sp->_prescreen = TRUE;
945 sp->_TABSIZE = _nc_prescreen._TABSIZE;
946 sp->_ESCDELAY = _nc_prescreen._ESCDELAY;
950 T(("_nc_alloc_screen_sp %p (reuse)", (void *) sp));
952 _nc_unlock_global(screen);
957 #ifdef USE_TERM_DRIVER
959 * This entrypoint is called from tgetent() to allow a special case of reusing
960 * the same TERMINAL data (see comment).
963 _nc_setupterm(const char *tname,
971 _nc_lock_global(prescreen);
973 if (TINFO_SETUP_TERM(&termp, tname, Filedes, errret, reuse) == OK) {
975 if (NCURSES_SP_NAME(set_curterm) (CURRENT_SCREEN_PRE, termp) != 0) {
979 _nc_unlock_global(prescreen);
985 * setupterm(termname, Filedes, errret)
987 * Find and read the appropriate object file for the terminal
988 * Make cur_term point to the structure.
991 setupterm(const char *tname, int Filedes, int *errret)
994 return _nc_setupterm(tname, Filedes, errret, FALSE);