ncurses 5.9 - patch 20110416
[ncurses.git] / ncurses / base / lib_newterm.c
index ad7b122be8ad1baecee24607cd0ade96c2e8f41c..5318ba4e81ea7b3fa634022e5ae70abd970a4691 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2002,2004 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2010,2011 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            *
@@ -30,6 +30,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                 *
+ *     and: Juergen Pfeifer                         2009                    *
  ****************************************************************************/
 
 /*
 
 #include <curses.priv.h>
 
-#if SVR4_TERMIO && !defined(_POSIX_SOURCE)
-#define _POSIX_SOURCE
+#ifndef CUR
+#define CUR SP_TERMTYPE
 #endif
 
-#include <term.h>              /* clear_screen, cup & friends, cur_term */
 #include <tic.h>
 
-MODULE_ID("$Id: lib_newterm.c,v 1.58 2004/08/14 20:36:39 tom Exp $")
+MODULE_ID("$Id: lib_newterm.c,v 1.87 2011/04/16 16:42:10 tom Exp $")
+
+#ifdef USE_TERM_DRIVER
+#define NumLabels      InfoOf(SP_PARM).numlabels
+#else
+#define NumLabels      num_labels
+#endif
 
 #ifndef ONLCR                  /* Allows compilation under the QNX 4.2 OS */
 #define ONLCR 0
@@ -62,26 +68,30 @@ MODULE_ID("$Id: lib_newterm.c,v 1.58 2004/08/14 20:36:39 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(NCURSES_SP_DCL0)
 {
     int result = ERR;
+    TERMINAL *term = TerminalOf(SP_PARM);
 
     /* for extended XPG4 conformance requires cbreak() at this point */
     /* (SVr4 curses does this anyway) */
-    if (cbreak() == OK) {
+    if (NCURSES_SP_NAME(cbreak) (NCURSES_SP_ARG) == OK) {
        TTY buf;
 
-       buf = cur_term->Nttyb;
+       buf = term->Nttyb;
 #ifdef TERMIOS
-       buf.c_lflag &= ~(ECHO | ECHONL);
-       buf.c_iflag &= ~(ICRNL | INLCR | IGNCR);
-       buf.c_oflag &= ~(ONLCR);
-#else
+       buf.c_lflag &= (unsigned) ~(ECHO | ECHONL);
+       buf.c_iflag &= (unsigned) ~(ICRNL | INLCR | IGNCR);
+       buf.c_oflag &= (unsigned) ~(ONLCR);
+#elif HAVE_SGTTY_H
        buf.sg_flags &= ~(ECHO | CRMOD);
+#else
+       memset(&buf, 0, sizeof(buf));
 #endif
-       if ((result = _nc_set_tty_mode(&buf)) == OK)
-           cur_term->Nttyb = buf;
+       result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
+       if (result == OK)
+           term->Nttyb = buf;
     }
     return result;
 }
@@ -92,120 +102,246 @@ _nc_initscr(void)
  * aside from possibly delaying a filter() call until some terminals have been
  * initialized.
  */
-static int filter_mode = FALSE;
+NCURSES_EXPORT(void)
+NCURSES_SP_NAME(filter) (NCURSES_SP_DCL0)
+{
+    START_TRACE();
+    T((T_CALLED("filter(%p)"), (void *) SP_PARM));
+#if NCURSES_SP_FUNCS
+    if (IsPreScreen(SP_PARM)) {
+       SP_PARM->_filtered = TRUE;
+    }
+#else
+    _nc_prescreen.filter_mode = TRUE;
+#endif
+    returnVoid;
+}
 
+#if NCURSES_SP_FUNCS
 NCURSES_EXPORT(void)
 filter(void)
 {
-    T((T_CALLED("filter")));
-    filter_mode = TRUE;
+    START_TRACE();
+    T((T_CALLED("filter()")));
+    _nc_prescreen.filter_mode = TRUE;
     returnVoid;
 }
+#endif
+
+#if NCURSES_EXT_FUNCS
+/*
+ * An extension, allowing the application to open a new screen without
+ * requiring it to also be filtered.
+ */
+NCURSES_EXPORT(void)
+NCURSES_SP_NAME(nofilter) (NCURSES_SP_DCL0)
+{
+    START_TRACE();
+    T((T_CALLED("nofilter(%p)"), (void *) SP_PARM));
+#if NCURSES_SP_FUNCS
+    if (IsPreScreen(SP_PARM)) {
+       SP_PARM->_filtered = FALSE;
+    }
+#else
+    _nc_prescreen.filter_mode = FALSE;
+#endif
+    returnVoid;
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(void)
+nofilter(void)
+{
+    START_TRACE();
+    T((T_CALLED("nofilter()")));
+    _nc_prescreen.filter_mode = FALSE;
+    returnVoid;
+}
+#endif
+#endif /* NCURSES_EXT_FUNCS */
 
 NCURSES_EXPORT(SCREEN *)
-newterm(NCURSES_CONST char *name, FILE *ofp, FILE *ifp)
+NCURSES_SP_NAME(newterm) (NCURSES_SP_DCLx
+                         NCURSES_CONST char *name,
+                         FILE *ofp,
+                         FILE *ifp)
 {
+    int value;
     int errret;
-    int slk_format = _nc_slk_format;
+    SCREEN *result = 0;
     SCREEN *current;
+    TERMINAL *its_term;
+    FILE *_ofp = ofp ? ofp : stdout;
+    FILE *_ifp = ifp ? ifp : stdin;
+    int cols;
+    int slk_format;
+    int filter_mode;
+    TERMINAL *new_term = 0;
 
     START_TRACE();
-    T((T_CALLED("newterm(\"%s\",%p,%p)"), name, ofp, ifp));
+    T((T_CALLED("newterm(%p, \"%s\", %p,%p)"),
+       (void *) SP_PARM,
+       name,
+       (void *) ofp,
+       (void *) ifp));
+
+#if NCURSES_SP_FUNCS
+    assert(SP_PARM != 0);
+    if (SP_PARM == 0)
+       returnSP(SP_PARM);
+#endif
+
+    _nc_init_pthreads();
+    _nc_lock_global(curses);
 
+    current = CURRENT_SCREEN;
+    its_term = (current ? current->_term : 0);
+
+    INIT_TERM_DRIVER();
     /* this loads the capability entry, then sets LINES and COLS */
-    if (setupterm(name, fileno(ofp), &errret) == ERR)
-       returnSP(0);
+    if (
+#if NCURSES_SP_FUNCS
+          SP_PARM->_prescreen &&
+#endif
+          TINFO_SETUP_TERM(&new_term, name,
+                           fileno(_ofp), &errret, FALSE) != ERR) {
 
-    /* implement filter mode */
-    if (filter_mode) {
-       LINES = 1;
+       _nc_set_screen(0);
+#ifdef USE_TERM_DRIVER
+       assert(new_term != 0);
+#endif
 
-       clear_screen = 0;
-       cursor_down = parm_down_cursor = 0;
-       cursor_address = 0;
-       cursor_up = parm_up_cursor = 0;
-       row_address = 0;
+#if NCURSES_SP_FUNCS
+       slk_format = SP_PARM->slk_format;
+       filter_mode = SP_PARM->_filtered;
+#else
+       slk_format = _nc_globals.slk_format;
+       filter_mode = _nc_prescreen.filter_mode;
+#endif
 
-       cursor_home = carriage_return;
-    }
+       /*
+        * This actually allocates the screen structure, and saves the original
+        * terminal settings.
+        */
+       if (NCURSES_SP_NAME(_nc_setupscreen) (
+#if NCURSES_SP_FUNCS
+                                                &SP_PARM,
+#endif
+                                                *(ptrLines(SP_PARM)),
+                                                *(ptrCols(SP_PARM)),
+                                                _ofp,
+                                                filter_mode,
+                                                slk_format) == ERR) {
+           _nc_set_screen(current);
+           result = 0;
+       } else {
+#ifdef USE_TERM_DRIVER
+           TERMINAL_CONTROL_BLOCK *TCB;
+#elif !NCURSES_SP_FUNCS
+           _nc_set_screen(CURRENT_SCREEN);
+#endif
+           assert(SP_PARM != 0);
+           cols = *(ptrCols(SP_PARM));
+#ifdef USE_TERM_DRIVER
+           _nc_set_screen(SP_PARM);
+           TCB = (TERMINAL_CONTROL_BLOCK *) new_term;
+           TCB->csp = SP_PARM;
+#endif
+           /*
+            * In setupterm() we did a set_curterm(), but it was before we set
+            * CURRENT_SCREEN.  So the "current" screen's terminal pointer was
+            * overwritten with a different terminal.  Later, in
+            * _nc_setupscreen(), we set CURRENT_SCREEN and the terminal
+            * pointer in the new screen.
+            *
+            * Restore the terminal-pointer for the pre-existing screen, if
+            * any.
+            */
+           if (current)
+               current->_term = its_term;
 
-    /* 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))
-               returnSP(0);
-       }
-    /* 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);
-       returnSP(0);
-    }
+#ifdef USE_TERM_DRIVER
+           SP_PARM->_term = new_term;
+#else
+           new_term = SP_PARM->_term;
+#endif
+
+           /* allow user to set maximum escape delay from the environment */
+           if ((value = _nc_getenv_num("ESCDELAY")) >= 0) {
+               NCURSES_SP_NAME(set_escdelay) (NCURSES_SP_ARGx value);
+           }
 
-    /* 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);
+           /* if the terminal type has real soft labels, set those up */
+           if (slk_format && NumLabels > 0 && SLK_STDFMT(slk_format))
+               _nc_slk_initialize(StdScreen(SP_PARM), cols);
 
-    SP->_ifd = fileno(ifp);
-    typeahead(fileno(ifp));
+           SP_PARM->_ifd = fileno(_ifp);
+           NCURSES_SP_NAME(typeahead) (NCURSES_SP_ARGx fileno(_ifp));
 #ifdef TERMIOS
-    SP->_use_meta = ((cur_term->Ottyb.c_cflag & CSIZE) == CS8 &&
-                    !(cur_term->Ottyb.c_iflag & ISTRIP));
+           SP_PARM->_use_meta = ((new_term->Ottyb.c_cflag & CSIZE) == CS8 &&
+                                 !(new_term->Ottyb.c_iflag & ISTRIP));
 #else
-    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.
-     */
-#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_PARM->_use_meta = FALSE;
+#endif
+           SP_PARM->_endwin = FALSE;
+#ifndef USE_TERM_DRIVER
+           /*
+            * 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_PARM->_scrolling = ((scroll_forward && scroll_reverse) ||
+                                  ((parm_rindex ||
+                                    parm_insert_line ||
+                                    insert_line) &&
+                                   (parm_index ||
+                                    parm_delete_line ||
+                                    delete_line)));
+#endif
 
-    /* compute movement costs so we can do better move optimization */
-    _nc_mvcur_init();
+           NCURSES_SP_NAME(baudrate) (NCURSES_SP_ARG);         /* sets a field in the screen structure */
 
-    /* initialize terminal to a sane state */
-    _nc_screen_init();
+           SP_PARM->_keytry = 0;
 
-    /* Initialize the terminal line settings. */
-    _nc_initscr();
+           /* compute movement costs so we can do better move optimization */
+#ifdef USE_TERM_DRIVER
+           TCBOf(SP_PARM)->drv->scinit(SP_PARM);
+#else
+           /*
+            * 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_PARM->_use_rmso = SGR0_TEST(exit_standout_mode);
+           SP_PARM->_use_rmul = SGR0_TEST(exit_underline_mode);
 
-    _nc_signal_handler(TRUE);
+           /* compute movement costs so we can do better move optimization */
+           _nc_mvcur_init();
 
-#if USE_SIZECHANGE
-    /*
-     * Pretend we received a SIGWINCH, just in case we're starting up in a
-     * terminal that cannot initialize its size properly (Debian #265631).
-     */
-    SP->_sig_winch = TRUE;
+           /* initialize terminal to a sane state */
+           _nc_screen_init();
 #endif
 
-    returnSP(SP);
+           /* Initialize the terminal line settings. */
+           _nc_initscr(NCURSES_SP_ARG);
+
+           _nc_signal_handler(TRUE);
+           result = SP_PARM;
+       }
+    }
+    _nc_unlock_global(curses);
+    returnSP(result);
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(SCREEN *)
+newterm(NCURSES_CONST char *name, FILE *ofp, FILE *ifp)
+{
+    return NCURSES_SP_NAME(newterm) (CURRENT_SCREEN_PRE, name, ofp, ifp);
 }
+#endif