1 /****************************************************************************
2 * Copyright (c) 1998-2007,2008 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 ****************************************************************************/
36 * Terminal setup routines common to termcap and terminfo:
39 * setupterm(char *, int, int *)
42 #include <curses.priv.h>
43 #include <tic.h> /* for MAX_NAME_SIZE */
44 #include <term_entry.h>
46 #if SVR4_TERMIO && !defined(_POSIX_SOURCE)
54 #include <term.h> /* lines, columns, cur_term */
56 MODULE_ID("$Id: lib_setup.c,v 1.102 2008/01/19 21:07:45 tom Exp $")
58 /****************************************************************************
60 * Terminal size computation
62 ****************************************************************************/
65 # if !defined(sun) || !TERMIOS
67 # include <sys/ioctl.h>
73 /* On SCO, they neglected to define struct winsize in termios.h -- it's only
74 * in termio.h and ptem.h (the former conflicts with other definitions).
76 # include <sys/stream.h>
77 # include <sys/ptem.h>
80 #if HAVE_LANGINFO_CODESET
85 * SCO defines TIOCGSIZE and the corresponding struct. Other systems (SunOS,
86 * Solaris, IRIX) define TIOCGWINSZ and struct winsize.
89 # define IOCTL_WINSIZE TIOCGSIZE
90 # define STRUCT_WINSIZE struct ttysize
91 # define WINSIZE_ROWS(n) (int)n.ts_lines
92 # define WINSIZE_COLS(n) (int)n.ts_cols
95 # define IOCTL_WINSIZE TIOCGWINSZ
96 # define STRUCT_WINSIZE struct winsize
97 # define WINSIZE_ROWS(n) (int)n.ws_row
98 # define WINSIZE_COLS(n) (int)n.ws_col
103 * Wrap global variables in this module.
106 NCURSES_EXPORT(char *)
107 NCURSES_PUBLIC_VAR(ttytype) (void)
109 static char empty[] = "";
110 return cur_term ? cur_term->type.term_names : empty;
113 NCURSES_PUBLIC_VAR(LINES) (void)
115 return (SP ? SP->_LINES : _nc_prescreen._LINES);
118 NCURSES_PUBLIC_VAR(COLS) (void)
120 return SP ? SP->_COLS : _nc_prescreen._COLS;
123 NCURSES_PUBLIC_VAR(TABSIZE) (void)
125 return SP ? SP->_TABSIZE : 8;
128 NCURSES_EXPORT_VAR(char) ttytype[NAMESIZE] = "";
129 NCURSES_EXPORT_VAR(int) LINES = 0;
130 NCURSES_EXPORT_VAR(int) COLS = 0;
131 NCURSES_EXPORT_VAR(int) TABSIZE = 0;
134 #if NCURSES_EXT_FUNCS
136 set_tabsize(int value)
141 SP->_TABSIZE = value;
154 * If we have a pending SIGWINCH, set the flag in each screen.
157 _nc_handle_sigwinch(int update)
161 (void) update; /* no longer used */
163 if (_nc_globals.have_sigwinch) {
164 _nc_globals.have_sigwinch = 0;
166 scan = _nc_screen_chain;
168 scan->_sig_winch = TRUE;
169 scan = scan->_next_screen;
173 return (SP ? SP->_sig_winch : 0);
181 T((T_CALLED("use_env()")));
182 _nc_prescreen.use_env = f;
187 _nc_get_screensize(int *linep, int *colp)
188 /* Obtain lines/columns values from the environment and/or terminfo entry */
192 /* figure out the size of the screen */
193 T(("screen size: terminfo lines = %d columns = %d", lines, columns));
195 if (!_nc_prescreen.use_env) {
196 *linep = (int) lines;
197 *colp = (int) columns;
198 } else { /* usually want to query LINES and COLUMNS from environment */
203 /* first, look for environment variables */
204 if ((value = _nc_getenv_num("LINES")) > 0) {
207 if ((value = _nc_getenv_num("COLUMNS")) > 0) {
210 T(("screen size: environment LINES = %d COLUMNS = %d", *linep, *colp));
213 if (*linep <= 0 || *colp <= 0) {
215 _scrsize(screendata);
216 *colp = screendata[0];
217 *linep = screendata[1];
218 T(("EMX screen size: environment LINES = %d COLUMNS = %d",
223 /* if that didn't work, maybe we can try asking the OS */
224 if (*linep <= 0 || *colp <= 0) {
225 if (isatty(cur_term->Filedes)) {
230 if (ioctl(cur_term->Filedes, IOCTL_WINSIZE, &size) < 0
237 * Solaris lets users override either dimension with an
238 * environment variable.
241 *linep = (SP != 0 && SP->_filtered) ? 1 : WINSIZE_ROWS(size);
243 *colp = WINSIZE_COLS(size);
248 #endif /* HAVE_SIZECHANGE */
250 /* if we can't get dynamic info about the size, use static */
252 *linep = (int) lines;
255 *colp = (int) columns;
258 /* the ultimate fallback, assume fixed 24x80 size */
267 * Put the derived values back in the screen-size caps, so
268 * tigetnum() and tgetnum() will do the right thing.
270 lines = (short) (*linep);
271 columns = (short) (*colp);
274 T(("screen size is %dx%d", *linep, *colp));
276 if (VALID_NUMERIC(init_tabs))
277 my_tabsize = (int) init_tabs;
283 SP->_TABSIZE = my_tabsize;
285 TABSIZE = my_tabsize;
287 T(("TABSIZE = %d", TABSIZE));
292 _nc_update_screensize(void)
294 int old_lines = lines;
296 int old_cols = columns;
299 _nc_get_screensize(&new_lines, &new_cols);
302 * See is_term_resized() and resizeterm().
303 * We're doing it this way because those functions belong to the upper
304 * ncurses library, while this resides in the lower terminfo library.
307 && SP->_resize != 0) {
308 if ((new_lines != old_lines) || (new_cols != old_cols))
309 SP->_resize(new_lines, new_cols);
310 SP->_sig_winch = FALSE;
315 /****************************************************************************
319 ****************************************************************************/
321 #define ret_error(code, fmt, arg) if (errret) {\
325 fprintf(stderr, fmt, arg);\
329 #define ret_error0(code, msg) if (errret) {\
333 fprintf(stderr, msg);\
337 #if USE_DATABASE || USE_TERMCAP
339 * Return 1 if entry found, 0 if not found, -1 if database not accessible,
340 * just like tgetent().
343 grab_entry(const char *const tn, TERMTYPE *const tp)
345 char filename[PATH_MAX];
346 int status = _nc_read_entry(tn, filename, tp);
349 * If we have an entry, force all of the cancelled strings to null
350 * pointers so we don't have to test them in the rest of the library.
351 * (The terminfo compiler bypasses this logic, since it must know if
352 * a string is cancelled, for merging entries).
354 if (status == TGETENT_YES) {
356 for_each_boolean(n, tp) {
357 if (!VALID_BOOLEAN(tp->Booleans[n]))
358 tp->Booleans[n] = FALSE;
360 for_each_string(n, tp) {
361 if (tp->Strings[n] == CANCELLED_STRING)
362 tp->Strings[n] = ABSENT_STRING;
372 ** Take the real command character out of the CC environment variable
373 ** and substitute it in for the prototype given in 'command_character'.
385 proto = *command_character;
387 for_each_string(i, &(cur_term->type)) {
388 for (tmp = cur_term->type.Strings[i]; *tmp; tmp++) {
396 * Find the locale which is in effect.
398 NCURSES_EXPORT(char *)
404 * This is preferable to using getenv() since it ensures that we are using
405 * the locale which was actually initialized by the application.
407 env = setlocale(LC_CTYPE, 0);
409 if (((env = getenv("LC_ALL")) != 0 && *env != '\0')
410 || ((env = getenv("LC_CTYPE")) != 0 && *env != '\0')
411 || ((env = getenv("LANG")) != 0 && *env != '\0')) {
415 T(("_nc_get_locale %s", _nc_visbuf(env)));
420 * Check if we are running in a UTF-8 locale.
423 _nc_unicode_locale(void)
426 #if HAVE_LANGINFO_CODESET
427 char *env = nl_langinfo(CODESET);
428 result = !strcmp(env, "UTF-8");
429 T(("_nc_unicode_locale(%s) ->%d", env, result));
431 char *env = _nc_get_locale();
433 if (strstr(env, ".UTF-8") != 0) {
435 T(("_nc_unicode_locale(%s) ->%d", env, result));
442 #define CONTROL_N(s) ((s) != 0 && strstr(s, "\016") != 0)
443 #define CONTROL_O(s) ((s) != 0 && strstr(s, "\017") != 0)
446 * Check for known broken cases where a UTF-8 locale breaks the alternate
450 _nc_locale_breaks_acs(void)
454 if ((env = getenv("NCURSES_NO_UTF8_ACS")) != 0) {
456 } else if ((env = getenv("TERM")) != 0) {
457 if (strstr(env, "linux"))
458 return 1; /* always broken */
459 if (strstr(env, "screen") != 0
460 && ((env = getenv("TERMCAP")) != 0
461 && strstr(env, "screen") != 0)
462 && strstr(env, "hhII00") != 0) {
463 if (CONTROL_N(enter_alt_charset_mode) ||
464 CONTROL_O(enter_alt_charset_mode) ||
465 CONTROL_N(set_attributes) ||
466 CONTROL_O(set_attributes))
474 * This entrypoint is called from tgetent() to allow a special case of reusing
475 * the same TERMINAL data (see comment).
478 _nc_setupterm(NCURSES_CONST char *tname, int Filedes, int *errret, bool reuse)
483 T((T_CALLED("setupterm(%s,%d,%p)"), _nc_visbuf(tname), Filedes, errret));
486 tname = getenv("TERM");
487 if (tname == 0 || *tname == '\0') {
488 ret_error0(TGETENT_ERR, "TERM environment variable not set.\n");
492 if (strlen(tname) > MAX_NAME_SIZE) {
493 ret_error(TGETENT_ERR,
494 "TERM environment must be <= %d characters.\n",
498 T(("your terminal name is %s", tname));
501 * Allow output redirection. This is what SVr3 does. If stdout is
502 * directed to a file, screen updates go to standard error.
504 if (Filedes == STDOUT_FILENO && !isatty(Filedes))
505 Filedes = STDERR_FILENO;
508 * Check if we have already initialized to use this terminal. If so, we
509 * do not need to re-read the terminfo entry, or obtain TTY settings.
511 * This is an improvement on SVr4 curses. If an application mixes curses
512 * and termcap calls, it may call both initscr and tgetent. This is not
513 * really a good thing to do, but can happen if someone tries using ncurses
514 * with the readline library. The problem we are fixing is that when
515 * tgetent calls setupterm, the resulting Ottyb struct in cur_term is
516 * zeroed. A subsequent call to endwin uses the zeroed terminal settings
517 * rather than the ones saved in initscr. So we check if cur_term appears
518 * to contain terminal settings for the same output file as our current
519 * call - and copy those terminal settings. (SVr4 curses does not do this,
520 * however applications that are working around the problem will still work
521 * properly with this feature).
525 && cur_term->Filedes == Filedes
526 && cur_term->_termname != 0
527 && !strcmp(cur_term->_termname, tname)
528 && _nc_name_match(cur_term->type.term_names, tname, "|")) {
529 T(("reusing existing terminal information and mode-settings"));
533 term_ptr = typeCalloc(TERMINAL, 1);
536 ret_error0(TGETENT_ERR,
537 "Not enough memory to create terminal structure.\n");
539 #if USE_DATABASE || USE_TERMCAP
540 status = grab_entry(tname, &term_ptr->type);
545 /* try fallback list if entry on disk */
546 if (status != TGETENT_YES) {
547 const TERMTYPE *fallback = _nc_fallback(tname);
550 term_ptr->type = *fallback;
551 status = TGETENT_YES;
555 if (status != TGETENT_YES) {
556 del_curterm(term_ptr);
557 if (status == TGETENT_ERR) {
558 ret_error0(status, "terminals database is inaccessible\n");
559 } else if (status == TGETENT_NO) {
560 ret_error(status, "'%s': unknown terminal type.\n", tname);
564 set_curterm(term_ptr);
566 if (command_character && getenv("CC"))
570 strncpy(ttytype, cur_term->type.term_names, NAMESIZE - 1);
571 ttytype[NAMESIZE - 1] = '\0';
574 cur_term->Filedes = Filedes;
575 cur_term->_termname = strdup(tname);
578 * If an application calls setupterm() rather than initscr() or
579 * newterm(), we will not have the def_prog_mode() call in
580 * _nc_setupscreen(). Do it now anyway, so we can initialize the
583 if (isatty(Filedes)) {
590 * We should always check the screensize, just in case.
593 _nc_get_screensize(SP ? &(SP->_LINES) : &(_nc_prescreen._LINES),
594 SP ? &(SP->_COLS) : &(_nc_prescreen._COLS));
596 _nc_get_screensize(&LINES, &COLS);
600 *errret = TGETENT_YES;
603 ret_error(TGETENT_NO, "'%s': I need something more specific.\n", tname);
606 ret_error(TGETENT_YES, "'%s': I can't handle hardcopy terminals.\n", tname);
612 * setupterm(termname, Filedes, errret)
614 * Find and read the appropriate object file for the terminal
615 * Make cur_term point to the structure.
618 setupterm(NCURSES_CONST char *tname, int Filedes, int *errret)
620 return _nc_setupterm(tname, Filedes, errret, FALSE);