ncurses 5.6 - patch 20080920
[ncurses.git] / ncurses / tinfo / lib_setup.c
index 1fd0d48f3cc8a41d49ebbd954951c540890477b9..8cfaf12c5348f9cdbb7dcdcd75792145ebf5ea27 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998,1999,2000 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
@@ -29,6 +29,7 @@
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Thomas E. Dickey                        1996-on                 *
  ****************************************************************************/
 
 /*
 #define _POSIX_SOURCE
 #endif
 
+#if HAVE_LOCALE_H
+#include <locale.h>
+#endif
+
 #include <term.h>              /* lines, columns, cur_term */
 
-MODULE_ID("$Id: lib_setup.c,v 1.60 2000/09/02 18:13:12 tom Exp $")
+MODULE_ID("$Id: lib_setup.c,v 1.111 2008/08/03 22:42:33 tom Exp $")
 
 /****************************************************************************
  *
@@ -72,6 +77,10 @@ MODULE_ID("$Id: lib_setup.c,v 1.60 2000/09/02 18:13:12 tom Exp $")
 # include <sys/ptem.h>
 #endif
 
+#if HAVE_LANGINFO_CODESET
+#include <langinfo.h>
+#endif
+
 /*
  * SCO defines TIOCGSIZE and the corresponding struct.  Other systems (SunOS,
  * Solaris, IRIX) define TIOCGWINSZ and struct winsize.
@@ -90,26 +99,113 @@ MODULE_ID("$Id: lib_setup.c,v 1.60 2000/09/02 18:13:12 tom Exp $")
 # endif
 #endif
 
-static int _use_env = TRUE;
+/*
+ * Reduce explicit use of "cur_term" global variable.
+ */
+#undef CUR
+#define CUR termp->type.
 
-static void do_prototype(void);
+/*
+ * Wrap global variables in this module.
+ */
+#if USE_REENTRANT
+NCURSES_EXPORT(char *)
+NCURSES_PUBLIC_VAR(ttytype) (void)
+{
+    static char empty[] = "";
+    return cur_term ? cur_term->type.term_names : empty;
+}
+NCURSES_EXPORT(int *)
+_nc_ptr_Lines(void)
+{
+    return ptrLines();
+}
+NCURSES_EXPORT(int)
+NCURSES_PUBLIC_VAR(LINES) (void)
+{
+    return *_nc_ptr_Lines();
+}
+NCURSES_EXPORT(int *)
+_nc_ptr_Cols(void)
+{
+    return ptrCols();
+}
+NCURSES_EXPORT(int)
+NCURSES_PUBLIC_VAR(COLS) (void)
+{
+    return *_nc_ptr_Cols();
+}
+NCURSES_EXPORT(int)
+NCURSES_PUBLIC_VAR(TABSIZE) (void)
+{
+    return SP ? SP->_TABSIZE : 8;
+}
+#else
+NCURSES_EXPORT_VAR(char) ttytype[NAMESIZE] = "";
+NCURSES_EXPORT_VAR(int) LINES = 0;
+NCURSES_EXPORT_VAR(int) COLS = 0;
+NCURSES_EXPORT_VAR(int) TABSIZE = 0;
+#endif
 
-void
-use_env(bool f)
+#if NCURSES_EXT_FUNCS
+NCURSES_EXPORT(int)
+set_tabsize(int value)
 {
-    _use_env = f;
+    int code = OK;
+#if USE_REENTRANT
+    if (SP) {
+       SP->_TABSIZE = value;
+    } else {
+       code = ERR;
+    }
+#else
+    TABSIZE = value;
+#endif
+    return code;
 }
+#endif
 
-int LINES = 0, COLS = 0, TABSIZE = 0;
+#if USE_SIGWINCH
+/*
+ * If we have a pending SIGWINCH, set the flag in each screen.
+ */
+NCURSES_EXPORT(int)
+_nc_handle_sigwinch(SCREEN *sp)
+{
+    SCREEN *scan;
 
-static void
-_nc_get_screensize(int *linep, int *colp)
+    if (_nc_globals.have_sigwinch) {
+       _nc_globals.have_sigwinch = 0;
+
+       for (each_screen(scan)) {
+           scan->_sig_winch = TRUE;
+       }
+    }
+
+    return (sp ? sp->_sig_winch : 0);
+}
+
+#endif
+
+NCURSES_EXPORT(void)
+use_env(bool f)
+{
+    T((T_CALLED("use_env()")));
+    _nc_prescreen.use_env = f;
+    returnVoid;
+}
+
+NCURSES_EXPORT(void)
+_nc_get_screensize(SCREEN *sp, int *linep, int *colp)
 /* Obtain lines/columns values from the environment and/or terminfo entry */
 {
+    TERMINAL *termp = cur_term;
+    int my_tabsize;
+
     /* figure out the size of the screen */
     T(("screen size: terminfo lines = %d columns = %d", lines, columns));
 
-    if (!_use_env) {
+    if (!_nc_prescreen.use_env) {
        *linep = (int) lines;
        *colp = (int) columns;
     } else {                   /* usually want to query LINES and COLUMNS from environment */
@@ -133,7 +229,7 @@ _nc_get_screensize(int *linep, int *colp)
            *colp = screendata[0];
            *linep = screendata[1];
            T(("EMX screen size: environment LINES = %d COLUMNS = %d",
-                   *linep, *colp));
+              *linep, *colp));
        }
 #endif
 #if HAVE_SIZECHANGE
@@ -155,7 +251,7 @@ _nc_get_screensize(int *linep, int *colp)
                 * environment variable.
                 */
                if (*linep <= 0)
-                   *linep = WINSIZE_ROWS(size);
+                   *linep = (sp != 0 && sp->_filtered) ? 1 : WINSIZE_ROWS(size);
                if (*colp <= 0)
                    *colp = WINSIZE_COLS(size);
            }
@@ -165,15 +261,18 @@ _nc_get_screensize(int *linep, int *colp)
 #endif /* HAVE_SIZECHANGE */
 
        /* if we can't get dynamic info about the size, use static */
-       if (*linep <= 0 || *colp <= 0)
-           if (lines > 0 && columns > 0) {
-               *linep = (int) lines;
-               *colp = (int) columns;
-           }
+       if (*linep <= 0) {
+           *linep = (int) lines;
+       }
+       if (*colp <= 0) {
+           *colp = (int) columns;
+       }
 
        /* the ultimate fallback, assume fixed 24x80 size */
-       if (*linep <= 0 || *colp <= 0) {
+       if (*linep <= 0) {
            *linep = 24;
+       }
+       if (*colp <= 0) {
            *colp = 80;
        }
 
@@ -188,22 +287,42 @@ _nc_get_screensize(int *linep, int *colp)
     T(("screen size is %dx%d", *linep, *colp));
 
     if (VALID_NUMERIC(init_tabs))
-       TABSIZE = (int) init_tabs;
+       my_tabsize = (int) init_tabs;
     else
-       TABSIZE = 8;
-    T(("TABSIZE = %d", TABSIZE));
+       my_tabsize = 8;
 
+#if USE_REENTRANT
+    if (sp != 0)
+       sp->_TABSIZE = my_tabsize;
+#else
+    TABSIZE = my_tabsize;
+#endif
+    T(("TABSIZE = %d", TABSIZE));
 }
 
 #if USE_SIZECHANGE
-void
-_nc_update_screensize(void)
+NCURSES_EXPORT(void)
+_nc_update_screensize(SCREEN *sp)
 {
-    int my_lines, my_cols;
+    TERMINAL *termp = cur_term;
+    int old_lines = lines;
+    int new_lines;
+    int old_cols = columns;
+    int new_cols;
+
+    _nc_get_screensize(sp, &new_lines, &new_cols);
 
-    _nc_get_screensize(&my_lines, &my_cols);
-    if (SP != 0 && SP->_resize != 0)
-       SP->_resize(my_lines, my_cols);
+    /*
+     * See is_term_resized() and resizeterm().
+     * We're doing it this way because those functions belong to the upper
+     * ncurses library, while this resides in the lower terminfo library.
+     */
+    if (sp != 0
+       && sp->_resize != 0) {
+       if ((new_lines != old_lines) || (new_cols != old_cols))
+           sp->_resize(new_lines, new_cols);
+       sp->_sig_winch = FALSE;
+    }
 }
 #endif
 
@@ -229,33 +348,16 @@ _nc_update_screensize(void)
                                            exit(EXIT_FAILURE);\
                                        }
 
-#if USE_DATABASE
+#if USE_DATABASE || USE_TERMCAP
+/*
+ * Return 1 if entry found, 0 if not found, -1 if database not accessible,
+ * just like tgetent().
+ */
 static int
-grab_entry(const char *const tn, TERMTYPE * const tp)
-/* return 1 if entry found, 0 if not found, -1 if database not accessible */
+grab_entry(const char *const tn, TERMTYPE *const tp)
 {
     char filename[PATH_MAX];
-    int status;
-
-    /*
-     * $TERM shouldn't contain pathname delimiters.
-     */
-    if (strchr(tn, '/'))
-       return 0;
-
-    if ((status = _nc_read_entry(tn, filename, tp)) != 1) {
-
-#if !PURE_TERMINFO
-       /*
-        * Try falling back on the termcap file.
-        * Note:  allowing this call links the entire terminfo/termcap
-        * compiler into the startup code.  It's preferable to build a
-        * real terminfo database and use that.
-        */
-       status = _nc_read_termcap_entry(tn, tp);
-#endif /* PURE_TERMINFO */
-
-    }
+    int status = _nc_read_entry(tn, filename, tp);
 
     /*
      * If we have an entry, force all of the cancelled strings to null
@@ -263,152 +365,267 @@ grab_entry(const char *const tn, TERMTYPE * const tp)
      * (The terminfo compiler bypasses this logic, since it must know if
      * a string is cancelled, for merging entries).
      */
-    if (status == 1) {
-       int n;
-       for_each_boolean(n, tp)
+    if (status == TGETENT_YES) {
+       unsigned n;
+       for_each_boolean(n, tp) {
            if (!VALID_BOOLEAN(tp->Booleans[n]))
-           tp->Booleans[n] = FALSE;
-       for_each_string(n, tp)
+               tp->Booleans[n] = FALSE;
+       }
+       for_each_string(n, tp) {
            if (tp->Strings[n] == CANCELLED_STRING)
-           tp->Strings[n] = ABSENT_STRING;
+               tp->Strings[n] = ABSENT_STRING;
+       }
     }
     return (status);
 }
 #endif
 
-char ttytype[NAMESIZE] = "";
+/*
+**     do_prototype()
+**
+**     Take the real command character out of the CC environment variable
+**     and substitute it in for the prototype given in 'command_character'.
+*/
+static void
+do_prototype(TERMINAL * termp)
+{
+    unsigned i;
+    char CC;
+    char proto;
+    char *tmp;
+
+    if ((tmp = getenv("CC")) != 0) {
+       if ((CC = *tmp) != 0) {
+           proto = *command_character;
+
+           for_each_string(i, &(termp->type)) {
+               for (tmp = termp->type.Strings[i]; *tmp; tmp++) {
+                   if (*tmp == proto)
+                       *tmp = CC;
+               }
+           }
+       }
+    }
+}
 
 /*
- *     setupterm(termname, Filedes, errret)
- *
- *     Find and read the appropriate object file for the terminal
- *     Make cur_term point to the structure.
- *
+ * Find the locale which is in effect.
  */
+NCURSES_EXPORT(char *)
+_nc_get_locale(void)
+{
+    char *env;
+#if HAVE_LOCALE_H
+    /*
+     * This is preferable to using getenv() since it ensures that we are using
+     * the locale which was actually initialized by the application.
+     */
+    env = setlocale(LC_CTYPE, 0);
+#else
+    if (((env = getenv("LC_ALL")) != 0 && *env != '\0')
+       || ((env = getenv("LC_CTYPE")) != 0 && *env != '\0')
+       || ((env = getenv("LANG")) != 0 && *env != '\0')) {
+       ;
+    }
+#endif
+    T(("_nc_get_locale %s", _nc_visbuf(env)));
+    return env;
+}
 
-int
-setupterm(NCURSES_CONST char *tname, int Filedes, int *errret)
+/*
+ * Check if we are running in a UTF-8 locale.
+ */
+NCURSES_EXPORT(int)
+_nc_unicode_locale(void)
+{
+    int result = 0;
+#if HAVE_LANGINFO_CODESET
+    char *env = nl_langinfo(CODESET);
+    result = !strcmp(env, "UTF-8");
+    T(("_nc_unicode_locale(%s) ->%d", env, result));
+#else
+    char *env = _nc_get_locale();
+    if (env != 0) {
+       if (strstr(env, ".UTF-8") != 0) {
+           result = 1;
+           T(("_nc_unicode_locale(%s) ->%d", env, result));
+       }
+    }
+#endif
+    return result;
+}
+
+#define CONTROL_N(s) ((s) != 0 && strstr(s, "\016") != 0)
+#define CONTROL_O(s) ((s) != 0 && strstr(s, "\017") != 0)
+
+/*
+ * Check for known broken cases where a UTF-8 locale breaks the alternate
+ * character set.
+ */
+NCURSES_EXPORT(int)
+_nc_locale_breaks_acs(TERMINAL * termp)
 {
-    struct term *term_ptr;
+    char *env;
+
+    if ((env = getenv("NCURSES_NO_UTF8_ACS")) != 0) {
+       return atoi(env);
+    } else if ((env = getenv("TERM")) != 0) {
+       if (strstr(env, "linux"))
+           return 1;           /* always broken */
+       if (strstr(env, "screen") != 0
+           && ((env = getenv("TERMCAP")) != 0
+               && strstr(env, "screen") != 0)
+           && strstr(env, "hhII00") != 0) {
+           if (CONTROL_N(enter_alt_charset_mode) ||
+               CONTROL_O(enter_alt_charset_mode) ||
+               CONTROL_N(set_attributes) ||
+               CONTROL_O(set_attributes))
+               return 1;
+       }
+    }
+    return 0;
+}
+
+/*
+ * This entrypoint is called from tgetent() to allow a special case of reusing
+ * the same TERMINAL data (see comment).
+ */
+NCURSES_EXPORT(int)
+_nc_setupterm(NCURSES_CONST char *tname, int Filedes, int *errret, bool reuse)
+{
+    TERMINAL *termp;
     int status;
 
+    START_TRACE();
     T((T_CALLED("setupterm(%s,%d,%p)"), _nc_visbuf(tname), Filedes, errret));
 
     if (tname == 0) {
        tname = getenv("TERM");
        if (tname == 0 || *tname == '\0') {
-           ret_error0(-1, "TERM environment variable not set.\n");
+           ret_error0(TGETENT_ERR, "TERM environment variable not set.\n");
        }
     }
+
     if (strlen(tname) > MAX_NAME_SIZE) {
-       ret_error(-1, "TERM environment must be <= %d characters.\n",
-           MAX_NAME_SIZE);
+       ret_error(TGETENT_ERR,
+                 "TERM environment must be <= %d characters.\n",
+                 MAX_NAME_SIZE);
     }
 
     T(("your terminal name is %s", tname));
 
-    term_ptr = typeCalloc(TERMINAL, 1);
+    /*
+     * Allow output redirection.  This is what SVr3 does.  If stdout is
+     * directed to a file, screen updates go to standard error.
+     */
+    if (Filedes == STDOUT_FILENO && !isatty(Filedes))
+       Filedes = STDERR_FILENO;
 
-    if (term_ptr == 0) {
-       ret_error0(-1, "Not enough memory to create terminal structure.\n");
-    }
-#if USE_DATABASE
-    status = grab_entry(tname, &term_ptr->type);
+    /*
+     * Check if we have already initialized to use this terminal.  If so, we
+     * do not need to re-read the terminfo entry, or obtain TTY settings.
+     *
+     * This is an improvement on SVr4 curses.  If an application mixes curses
+     * and termcap calls, it may call both initscr and tgetent.  This is not
+     * really a good thing to do, but can happen if someone tries using ncurses
+     * with the readline library.  The problem we are fixing is that when
+     * tgetent calls setupterm, the resulting Ottyb struct in cur_term is
+     * zeroed.  A subsequent call to endwin uses the zeroed terminal settings
+     * rather than the ones saved in initscr.  So we check if cur_term appears
+     * to contain terminal settings for the same output file as our current
+     * call - and copy those terminal settings.  (SVr4 curses does not do this,
+     * however applications that are working around the problem will still work
+     * properly with this feature).
+     */
+    if (reuse
+       && (termp = cur_term) != 0
+       && termp->Filedes == Filedes
+       && termp->_termname != 0
+       && !strcmp(termp->_termname, tname)
+       && _nc_name_match(termp->type.term_names, tname, "|")) {
+       T(("reusing existing terminal information and mode-settings"));
+    } else {
+
+       termp = typeCalloc(TERMINAL, 1);
+
+       if (termp == 0) {
+           ret_error0(TGETENT_ERR,
+                      "Not enough memory to create terminal structure.\n");
+       }
+#if USE_DATABASE || USE_TERMCAP
+       status = grab_entry(tname, &termp->type);
 #else
-    status = 0;
+       status = TGETENT_NO;
 #endif
 
-    /* try fallback list if entry on disk */
-    if (status != 1) {
-       const TERMTYPE *fallback = _nc_fallback(tname);
+       /* try fallback list if entry on disk */
+       if (status != TGETENT_YES) {
+           const TERMTYPE *fallback = _nc_fallback(tname);
 
-       if (fallback) {
-           term_ptr->type = *fallback;
-           status = 1;
+           if (fallback) {
+               termp->type = *fallback;
+               status = TGETENT_YES;
+           }
        }
-    }
 
-    if (status == -1) {
-       ret_error0(-1, "terminals database is inaccessible\n");
-    } else if (status == 0) {
-       ret_error(0, "'%s': unknown terminal type.\n", tname);
-    }
+       if (status != TGETENT_YES) {
+           del_curterm(termp);
+           if (status == TGETENT_ERR) {
+               ret_error0(status, "terminals database is inaccessible\n");
+           } else if (status == TGETENT_NO) {
+               ret_error(status, "'%s': unknown terminal type.\n", tname);
+           }
+       }
+#if !USE_REENTRANT
+       strncpy(ttytype, termp->type.term_names, NAMESIZE - 1);
+       ttytype[NAMESIZE - 1] = '\0';
+#endif
 
-    /*
-     * Improve on SVr4 curses.  If an application mixes curses and termcap
-     * calls, it may call both initscr and tgetent.  This is not really a
-     * good thing to do, but can happen if someone tries using ncurses with
-     * the readline library.  The problem we are fixing is that when
-     * tgetent calls setupterm, the resulting Ottyb struct in cur_term is
-     * zeroed.  A subsequent call to endwin uses the zeroed terminal
-     * settings rather than the ones saved in initscr.  So we check if
-     * cur_term appears to contain terminal settings for the same output
-     * file as our current call - and copy those terminal settings.  (SVr4
-     * curses does not do this, however applications that are working
-     * around the problem will still work properly with this feature).
-     */
-    if (cur_term != 0) {
-       if (cur_term->Filedes == Filedes)
-           term_ptr->Ottyb = cur_term->Ottyb;
-    }
+       termp->Filedes = Filedes;
+       termp->_termname = strdup(tname);
 
-    set_curterm(term_ptr);
+       set_curterm(termp);
 
-    if (command_character && getenv("CC"))
-       do_prototype();
+       if (command_character && getenv("CC"))
+           do_prototype(termp);
 
-    strncpy(ttytype, cur_term->type.term_names, NAMESIZE - 1);
-    ttytype[NAMESIZE - 1] = '\0';
+       /*
+        * If an application calls setupterm() rather than initscr() or
+        * newterm(), we will not have the def_prog_mode() call in
+        * _nc_setupscreen().  Do it now anyway, so we can initialize the
+        * baudrate.
+        */
+       if (isatty(Filedes)) {
+           def_prog_mode();
+           baudrate();
+       }
+    }
 
     /*
-     * Allow output redirection.  This is what SVr3 does.
-     * If stdout is directed to a file, screen updates go
-     * to standard error.
+     * We should always check the screensize, just in case.
      */
-    if (Filedes == STDOUT_FILENO && !isatty(Filedes))
-       Filedes = STDERR_FILENO;
-    cur_term->Filedes = Filedes;
-
-    _nc_get_screensize(&LINES, &COLS);
+    _nc_get_screensize(SP, ptrLines(), ptrCols());
 
     if (errret)
-       *errret = 1;
-
-    T((T_CREATE("screen %s %dx%d"), tname, LINES, COLS));
+       *errret = TGETENT_YES;
 
     if (generic_type) {
-       ret_error(0, "'%s': I need something more specific.\n", tname);
+       ret_error(TGETENT_NO, "'%s': I need something more specific.\n", tname);
     }
     if (hard_copy) {
-       ret_error(1, "'%s': I can't handle hardcopy terminals.\n", tname);
+       ret_error(TGETENT_YES, "'%s': I can't handle hardcopy terminals.\n", tname);
     }
     returnCode(OK);
 }
 
 /*
-**     do_prototype()
-**
-**     Take the real command character out of the CC environment variable
-**     and substitute it in for the prototype given in 'command_character'.
-**
-*/
-
-static void
-do_prototype(void)
+ *     setupterm(termname, Filedes, errret)
+ *
+ *     Find and read the appropriate object file for the terminal
+ *     Make cur_term point to the structure.
+ */
+NCURSES_EXPORT(int)
+setupterm(NCURSES_CONST char *tname, int Filedes, int *errret)
 {
-    int i;
-    char CC;
-    char proto;
-    char *tmp;
-
-    tmp = getenv("CC");
-    CC = *tmp;
-    proto = *command_character;
-
-    for_each_string(i, &(cur_term->type)) {
-       for (tmp = cur_term->type.Strings[i]; *tmp; tmp++) {
-           if (*tmp == proto)
-               *tmp = CC;
-       }
-    }
+    return _nc_setupterm(tname, Filedes, errret, FALSE);
 }