1/****************************************************************************
2 * Copyright (c) 1998-2007,2008 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
51MODULE_ID("$Id: lib_newterm.c,v 1.73 2008/08/16 21:20:48 Werner.Fink 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 */
65static 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 */
97NCURSES_EXPORT(void)
98filter(void)
99{
100    START_TRACE();
101    T((T_CALLED("filter")));
102    _nc_prescreen.filter_mode = TRUE;
103    returnVoid;
104}
105
106#if NCURSES_EXT_FUNCS
107/*
108 * An extension, allowing the application to open a new screen without
109 * requiring it to also be filtered.
110 */
111NCURSES_EXPORT(void)
112nofilter(void)
113{
114    START_TRACE();
115    T((T_CALLED("nofilter")));
116    _nc_prescreen.filter_mode = FALSE;
117    returnVoid;
118}
119#endif
120
121NCURSES_EXPORT(SCREEN *)
122newterm(NCURSES_CONST char *name, FILE *ofp, FILE *ifp)
123{
124    int value;
125    int errret;
126    SCREEN *current;
127    SCREEN *result = 0;
128    TERMINAL *its_term;
129
130    START_TRACE();
131    T((T_CALLED("newterm(\"%s\",%p,%p)"), name, ofp, ifp));
132
133    _nc_init_pthreads();
134    _nc_lock_global(curses);
135
136    current = SP;
137    its_term = (SP ? SP->_term : 0);
138
139    /* this loads the capability entry, then sets LINES and COLS */
140    if (setupterm(name, fileno(ofp), &errret) != ERR) {
141	int slk_format = _nc_globals.slk_format;
142
143	/*
144	 * This actually allocates the screen structure, and saves the original
145	 * terminal settings.
146	 */
147	_nc_set_screen(0);
148
149	/* allow user to set maximum escape delay from the environment */
150	if ((value = _nc_getenv_num("ESCDELAY")) >= 0) {
151	    set_escdelay(value);
152	}
153
154	if (_nc_setupscreen(LINES,
155			    COLS,
156			    ofp,
157			    _nc_prescreen.filter_mode,
158			    slk_format) == ERR) {
159	    _nc_set_screen(current);
160	    result = 0;
161	} else {
162	    assert(SP != 0);
163	    /*
164	     * In setupterm() we did a set_curterm(), but it was before we set
165	     * SP.  So the "current" screen's terminal pointer was overwritten
166	     * with a different terminal.  Later, in _nc_setupscreen(), we set
167	     * SP and the terminal pointer in the new screen.
168	     *
169	     * Restore the terminal-pointer for the pre-existing screen, if
170	     * any.
171	     */
172	    if (current)
173		current->_term = its_term;
174
175	    /* if the terminal type has real soft labels, set those up */
176	    if (slk_format && num_labels > 0 && SLK_STDFMT(slk_format))
177		_nc_slk_initialize(stdscr, COLS);
178
179	    SP->_ifd = fileno(ifp);
180	    typeahead(fileno(ifp));
181#ifdef TERMIOS
182	    SP->_use_meta = ((cur_term->Ottyb.c_cflag & CSIZE) == CS8 &&
183			     !(cur_term->Ottyb.c_iflag & ISTRIP));
184#else
185	    SP->_use_meta = FALSE;
186#endif
187	    SP->_endwin = FALSE;
188
189	    /*
190	     * Check whether we can optimize scrolling under dumb terminals in
191	     * case we do not have any of these capabilities, scrolling
192	     * optimization will be useless.
193	     */
194	    SP->_scrolling = ((scroll_forward && scroll_reverse) ||
195			      ((parm_rindex ||
196				parm_insert_line ||
197				insert_line) &&
198			       (parm_index ||
199				parm_delete_line ||
200				delete_line)));
201
202	    baudrate();		/* sets a field in the SP structure */
203
204	    SP->_keytry = 0;
205
206	    /*
207	     * Check for mismatched graphic-rendition capabilities.  Most SVr4
208	     * terminfo trees contain entries that have rmul or rmso equated to
209	     * sgr0 (Solaris curses copes with those entries).  We do this only
210	     * for curses, since many termcap applications assume that
211	     * smso/rmso and smul/rmul are paired, and will not function
212	     * properly if we remove rmso or rmul.  Curses applications
213	     * shouldn't be looking at this detail.
214	     */
215#define SGR0_TEST(mode) (mode != 0) && (exit_attribute_mode == 0 || strcmp(mode, exit_attribute_mode))
216	    SP->_use_rmso = SGR0_TEST(exit_standout_mode);
217	    SP->_use_rmul = SGR0_TEST(exit_underline_mode);
218
219	    /* compute movement costs so we can do better move optimization */
220	    _nc_mvcur_init();
221
222	    /* initialize terminal to a sane state */
223	    _nc_screen_init();
224
225	    /* Initialize the terminal line settings. */
226	    _nc_initscr();
227
228	    _nc_signal_handler(TRUE);
229
230	    result = SP;
231	}
232    }
233    _nc_unlock_global(curses);
234    returnSP(result);
235}
236