ncurses 5.6 - patch 20070310
[ncurses.git] / ncurses / base / lib_newterm.c
1 /****************************************************************************
2  * Copyright (c) 1998-2006,2007 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
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  ****************************************************************************/
34
35 /*
36 **      lib_newterm.c
37 **
38 **      The newterm() function.
39 **
40 */
41
42 #include <curses.priv.h>
43
44 #if SVR4_TERMIO && !defined(_POSIX_SOURCE)
45 #define _POSIX_SOURCE
46 #endif
47
48 #include <term.h>               /* clear_screen, cup & friends, cur_term */
49 #include <tic.h>
50
51 MODULE_ID("$Id: lib_newterm.c,v 1.65 2007/03/10 23:39:27 tom Exp $")
52
53 #ifndef ONLCR                   /* Allows compilation under the QNX 4.2 OS */
54 #define ONLCR 0
55 #endif
56
57 /*
58  * SVr4/XSI Curses specify that hardware echo is turned off in initscr, and not
59  * restored during the curses session.  The library simulates echo in software.
60  * (The behavior is unspecified if the application enables hardware echo).
61  *
62  * The newterm function also initializes terminal settings, and since initscr
63  * is supposed to behave as if it calls newterm, we do it here.
64  */
65 static NCURSES_INLINE int
66 _nc_initscr(void)
67 {
68     int result = ERR;
69
70     /* for extended XPG4 conformance requires cbreak() at this point */
71     /* (SVr4 curses does this anyway) */
72     if (cbreak() == OK) {
73         TTY buf;
74
75         buf = cur_term->Nttyb;
76 #ifdef TERMIOS
77         buf.c_lflag &= ~(ECHO | ECHONL);
78         buf.c_iflag &= ~(ICRNL | INLCR | IGNCR);
79         buf.c_oflag &= ~(ONLCR);
80 #elif HAVE_SGTTY_H
81         buf.sg_flags &= ~(ECHO | CRMOD);
82 #else
83         memset(&buf, 0, sizeof(buf));
84 #endif
85         if ((result = _nc_set_tty_mode(&buf)) == OK)
86             cur_term->Nttyb = buf;
87     }
88     return result;
89 }
90
91 /*
92  * filter() has to be called before either initscr() or newterm(), so there is
93  * apparently no way to make this flag apply to some terminals and not others,
94  * aside from possibly delaying a filter() call until some terminals have been
95  * initialized.
96  */
97 static bool filter_mode = FALSE;
98
99 NCURSES_EXPORT(void)
100 filter(void)
101 {
102     START_TRACE();
103     T((T_CALLED("filter")));
104     filter_mode = TRUE;
105     returnVoid;
106 }
107
108 #if NCURSES_EXT_FUNCS
109 /*
110  * An extension, allowing the application to open a new screen without
111  * requiring it to also be filtered.
112  */
113 NCURSES_EXPORT(void)
114 nofilter(void)
115 {
116     START_TRACE();
117     T((T_CALLED("nofilter")));
118     filter_mode = FALSE;
119     returnVoid;
120 }
121 #endif
122
123 NCURSES_EXPORT(SCREEN *)
124 newterm(NCURSES_CONST char *name, FILE *ofp, FILE *ifp)
125 {
126     int value;
127     int errret;
128     int slk_format = _nc_slk_format;
129     SCREEN *current;
130     SCREEN *result = 0;
131
132     START_TRACE();
133     T((T_CALLED("newterm(\"%s\",%p,%p)"), name, ofp, ifp));
134
135     _nc_handle_sigwinch(0);
136
137     /* this loads the capability entry, then sets LINES and COLS */
138     if (setupterm(name, fileno(ofp), &errret) == ERR) {
139         result = 0;
140     } else {
141         /*
142          * This actually allocates the screen structure, and saves the original
143          * terminal settings.
144          */
145         current = SP;
146         _nc_set_screen(0);
147
148         /* allow user to set maximum escape delay from the environment */
149         if ((value = _nc_getenv_num("ESCDELAY")) >= 0) {
150 #if USE_REENTRANT
151             SP->_ESCDELAY = value;
152 #else
153             ESCDELAY = value;
154 #endif
155         }
156
157         if (_nc_setupscreen(LINES, COLS, ofp, filter_mode, slk_format) == ERR) {
158             _nc_set_screen(current);
159             result = 0;
160         } else {
161             /* if the terminal type has real soft labels, set those up */
162             if (slk_format && num_labels > 0 && SLK_STDFMT(slk_format))
163                 _nc_slk_initialize(stdscr, COLS);
164
165             SP->_ifd = fileno(ifp);
166             typeahead(fileno(ifp));
167 #ifdef TERMIOS
168             SP->_use_meta = ((cur_term->Ottyb.c_cflag & CSIZE) == CS8 &&
169                              !(cur_term->Ottyb.c_iflag & ISTRIP));
170 #else
171             SP->_use_meta = FALSE;
172 #endif
173             SP->_endwin = FALSE;
174
175             /*
176              * Check whether we can optimize scrolling under dumb terminals in
177              * case we do not have any of these capabilities, scrolling
178              * optimization will be useless.
179              */
180             SP->_scrolling = ((scroll_forward && scroll_reverse) ||
181                               ((parm_rindex ||
182                                 parm_insert_line ||
183                                 insert_line) &&
184                                (parm_index ||
185                                 parm_delete_line ||
186                                 delete_line)));
187
188             baudrate();         /* sets a field in the SP structure */
189
190             SP->_keytry = 0;
191
192             /*
193              * Check for mismatched graphic-rendition capabilities.  Most SVr4
194              * terminfo trees contain entries that have rmul or rmso equated to
195              * sgr0 (Solaris curses copes with those entries).  We do this only
196              * for curses, since many termcap applications assume that
197              * smso/rmso and smul/rmul are paired, and will not function
198              * properly if we remove rmso or rmul.  Curses applications
199              * shouldn't be looking at this detail.
200              */
201 #define SGR0_TEST(mode) (mode != 0) && (exit_attribute_mode == 0 || strcmp(mode, exit_attribute_mode))
202             SP->_use_rmso = SGR0_TEST(exit_standout_mode);
203             SP->_use_rmul = SGR0_TEST(exit_underline_mode);
204
205             /* compute movement costs so we can do better move optimization */
206             _nc_mvcur_init();
207
208             /* initialize terminal to a sane state */
209             _nc_screen_init();
210
211             /* Initialize the terminal line settings. */
212             _nc_initscr();
213
214             _nc_signal_handler(TRUE);
215
216             result = SP;
217         }
218     }
219     _nc_handle_sigwinch(1);
220     returnSP(result);
221 }