ncurses 5.6 - patch 20070224
[ncurses.git] / ncurses / base / lib_newterm.c
index 9a4919bf5292480e2c61f87df1d2d19d78062036..fe201d6b8e27054570510fe736c7a549a6e77f27 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998-2005,2006 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            *
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Thomas E. Dickey                        1996-on                 *
  ****************************************************************************/
 
-
-
 /*
 **     lib_newterm.c
 **
 
 #include <curses.priv.h>
 
-#if defined(SVR4_TERMIO) && !defined(_POSIX_SOURCE)
+#if SVR4_TERMIO && !defined(_POSIX_SOURCE)
 #define _POSIX_SOURCE
 #endif
 
-#include <term.h>      /* clear_screen, cup & friends, cur_term */
+#include <term.h>              /* clear_screen, cup & friends, cur_term */
+#include <tic.h>
 
-MODULE_ID("$Id: lib_newterm.c,v 1.41 1999/07/24 20:07:48 tom Exp $")
+MODULE_ID("$Id: lib_newterm.c,v 1.64 2006/01/14 15:36:24 tom Exp $")
 
-#ifndef ONLCR          /* Allows compilation under the QNX 4.2 OS */
+#ifndef ONLCR                  /* Allows compilation under the QNX 4.2 OS */
 #define ONLCR 0
 #endif
 
@@ -62,20 +62,30 @@ MODULE_ID("$Id: lib_newterm.c,v 1.41 1999/07/24 20:07:48 tom Exp $")
  * The newterm function also initializes terminal settings, and since initscr
  * is supposed to behave as if it calls newterm, we do it here.
  */
-static inline int _nc_initscr(void)
+static NCURSES_INLINE int
+_nc_initscr(void)
 {
-       /* for extended XPG4 conformance requires cbreak() at this point */
-       /* (SVr4 curses does this anyway) */
-       cbreak();
+    int result = ERR;
 
+    /* for extended XPG4 conformance requires cbreak() at this point */
+    /* (SVr4 curses does this anyway) */
+    if (cbreak() == OK) {
+       TTY buf;
+
+       buf = cur_term->Nttyb;
 #ifdef TERMIOS
-       cur_term->Nttyb.c_lflag &= ~(ECHO|ECHONL);
-       cur_term->Nttyb.c_iflag &= ~(ICRNL|INLCR|IGNCR);
-       cur_term->Nttyb.c_oflag &= ~(ONLCR);
+       buf.c_lflag &= ~(ECHO | ECHONL);
+       buf.c_iflag &= ~(ICRNL | INLCR | IGNCR);
+       buf.c_oflag &= ~(ONLCR);
+#elif HAVE_SGTTY_H
+       buf.sg_flags &= ~(ECHO | CRMOD);
 #else
-       cur_term->Nttyb.sg_flags &= ~(ECHO|CRMOD);
+       memset(&buf, 0, sizeof(buf));
 #endif
-       return _nc_set_tty_mode(&cur_term->Nttyb);
+       if ((result = _nc_set_tty_mode(&buf)) == OK)
+           cur_term->Nttyb = buf;
+    }
+    return result;
 }
 
 /*
@@ -84,123 +94,123 @@ static inline int _nc_initscr(void)
  * aside from possibly delaying a filter() call until some terminals have been
  * initialized.
  */
-static int filter_mode = FALSE;
+static bool filter_mode = FALSE;
 
-void filter(void)
+NCURSES_EXPORT(void)
+filter(void)
 {
+    START_TRACE();
+    T((T_CALLED("filter")));
     filter_mode = TRUE;
+    returnVoid;
 }
 
-SCREEN * newterm(NCURSES_CONST char *name, FILE *ofp, FILE *ifp)
+#if NCURSES_EXT_FUNCS
+/*
+ * An extension, allowing the application to open a new screen without
+ * requiring it to also be filtered.
+ */
+NCURSES_EXPORT(void)
+nofilter(void)
 {
-int    errret;
-int     slk_format = _nc_slk_format;
-SCREEN* current;
-#ifdef TRACE
-int t = _nc_getenv_num("NCURSES_TRACE");
-
-       if (t >= 0)
-               trace(t);
+    START_TRACE();
+    T((T_CALLED("nofilter")));
+    filter_mode = FALSE;
+    returnVoid;
+}
 #endif
 
-       T((T_CALLED("newterm(\"%s\",%p,%p)"), name, ofp, ifp));
-
-       /* this loads the capability entry, then sets LINES and COLS */
-       if (setupterm(name, fileno(ofp), &errret) == ERR)
-               return 0;
-
-       /* implement filter mode */
-       if (filter_mode) {
-               LINES = 1;
-
-               if (init_tabs != -1)
-                       TABSIZE = init_tabs;
-               else
-                       TABSIZE = 8;
-
-               T(("TABSIZE = %d", TABSIZE));
-
-               clear_screen = 0;
-               cursor_down = parm_down_cursor = 0;
-               cursor_address = 0;
-               cursor_up = parm_up_cursor = 0;
-               row_address = 0;
-
-               cursor_home = carriage_return;
-       }
-
-       /* If we must simulate soft labels, grab off the line to be used.
-          We assume that we must simulate, if it is none of the standard
-          formats (4-4  or 3-2-3) for which there may be some hardware
-          support. */
-       if (num_labels <= 0 || !SLK_STDFMT(slk_format))
-           if (slk_format)
-             {
-               if (ERR==_nc_ripoffline(-SLK_LINES(slk_format),
-                                       _nc_slk_initialize))
-                 return 0;
-             }
-       /* this actually allocates the screen structure, and saves the
-        * original terminal settings.
+NCURSES_EXPORT(SCREEN *)
+newterm(NCURSES_CONST char *name, FILE *ofp, FILE *ifp)
+{
+    int value;
+    int errret;
+    int slk_format = _nc_slk_format;
+    SCREEN *current;
+    SCREEN *result = 0;
+
+    START_TRACE();
+    T((T_CALLED("newterm(\"%s\",%p,%p)"), name, ofp, ifp));
+
+    _nc_handle_sigwinch(0);
+
+    /* allow user to set maximum escape delay from the environment */
+    if ((value = _nc_getenv_num("ESCDELAY")) >= 0) {
+       ESCDELAY = value;
+    }
+
+    /* this loads the capability entry, then sets LINES and COLS */
+    if (setupterm(name, fileno(ofp), &errret) == ERR) {
+       result = 0;
+    } else {
+       /*
+        * This actually allocates the screen structure, and saves the original
+        * terminal settings.
         */
        current = SP;
        _nc_set_screen(0);
-       if (_nc_setupscreen(LINES, COLS, ofp) == ERR) {
-               _nc_set_screen(current);
-               return 0;
-       }
-
-       /* if the terminal type has real soft labels, set those up */
-       if (slk_format && num_labels > 0 && SLK_STDFMT(slk_format))
-           _nc_slk_initialize(stdscr, COLS);
-
-       SP->_ifd        = fileno(ifp);
-       SP->_checkfd    = fileno(ifp);
-       typeahead(fileno(ifp));
+       if (_nc_setupscreen(LINES, COLS, ofp, filter_mode, slk_format) == ERR) {
+           _nc_set_screen(current);
+           result = 0;
+       } else {
+           /* if the terminal type has real soft labels, set those up */
+           if (slk_format && num_labels > 0 && SLK_STDFMT(slk_format))
+               _nc_slk_initialize(stdscr, COLS);
+
+           SP->_ifd = fileno(ifp);
+           typeahead(fileno(ifp));
 #ifdef TERMIOS
-       SP->_use_meta   = ((cur_term->Ottyb.c_cflag & CSIZE) == CS8 &&
-                           !(cur_term->Ottyb.c_iflag & ISTRIP));
+           SP->_use_meta = ((cur_term->Ottyb.c_cflag & CSIZE) == CS8 &&
+                            !(cur_term->Ottyb.c_iflag & ISTRIP));
 #else
-       SP->_use_meta   = FALSE;
+           SP->_use_meta = FALSE;
 #endif
-       SP->_endwin     = FALSE;
-
-       /* Check whether we can optimize scrolling under dumb terminals in case
-        * we do not have any of these capabilities, scrolling optimization
-        * will be useless.
-        */
-       SP->_scrolling = ((scroll_forward && scroll_reverse) ||
-                         ((parm_rindex || parm_insert_line || insert_line) &&
-                          (parm_index  || parm_delete_line || delete_line)));
-
-       baudrate();     /* sets a field in the SP structure */
-
-       SP->_keytry = 0;
-
-       /*
-        * Check for mismatched graphic-rendition capabilities.  Most SVr4
-        * terminfo trees contain entries that have rmul or rmso equated to
-        * sgr0 (Solaris curses copes with those entries).  We do this only for
-        * curses, since many termcap applications assume that smso/rmso and
-        * smul/rmul are paired, and will not function properly if we remove
-        * rmso or rmul.  Curses applications shouldn't be looking at this
-        * detail.
-        */
+           SP->_endwin = FALSE;
+
+           /*
+            * Check whether we can optimize scrolling under dumb terminals in
+            * case we do not have any of these capabilities, scrolling
+            * optimization will be useless.
+            */
+           SP->_scrolling = ((scroll_forward && scroll_reverse) ||
+                             ((parm_rindex ||
+                               parm_insert_line ||
+                               insert_line) &&
+                              (parm_index ||
+                               parm_delete_line ||
+                               delete_line)));
+
+           baudrate();         /* sets a field in the SP structure */
+
+           SP->_keytry = 0;
+
+           /*
+            * Check for mismatched graphic-rendition capabilities.  Most SVr4
+            * terminfo trees contain entries that have rmul or rmso equated to
+            * sgr0 (Solaris curses copes with those entries).  We do this only
+            * for curses, since many termcap applications assume that
+            * smso/rmso and smul/rmul are paired, and will not function
+            * properly if we remove rmso or rmul.  Curses applications
+            * shouldn't be looking at this detail.
+            */
 #define SGR0_TEST(mode) (mode != 0) && (exit_attribute_mode == 0 || strcmp(mode, exit_attribute_mode))
-       SP->_use_rmso = SGR0_TEST(exit_standout_mode);
-       SP->_use_rmul = SGR0_TEST(exit_underline_mode);
+           SP->_use_rmso = SGR0_TEST(exit_standout_mode);
+           SP->_use_rmul = SGR0_TEST(exit_underline_mode);
 
-       /* compute movement costs so we can do better move optimization */
-       _nc_mvcur_init();
+           /* compute movement costs so we can do better move optimization */
+           _nc_mvcur_init();
 
-       /* initialize terminal to a sane state */
-       _nc_screen_init();
+           /* initialize terminal to a sane state */
+           _nc_screen_init();
 
-       /* Initialize the terminal line settings. */
-       _nc_initscr();
+           /* Initialize the terminal line settings. */
+           _nc_initscr();
 
-       _nc_signal_handler(TRUE);
+           _nc_signal_handler(TRUE);
 
-       T((T_RETURN("%p"), SP));
-       return(SP);
+           result = SP;
+       }
+    }
+    _nc_handle_sigwinch(1);
+    returnSP(result);
 }