ncurses 6.0 - patch 20170311
[ncurses.git] / ncurses / base / lib_newterm.c
1 /****************************************************************************
2  * Copyright (c) 1998-2016,2017 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  *     and: Juergen Pfeifer                         2009                    *
34  ****************************************************************************/
35
36 /*
37 **      lib_newterm.c
38 **
39 **      The newterm() function.
40 **
41 */
42
43 #include <curses.priv.h>
44
45 #ifndef CUR
46 #define CUR SP_TERMTYPE
47 #endif
48
49 #include <tic.h>
50
51 MODULE_ID("$Id: lib_newterm.c,v 1.94 2017/02/11 17:28:07 tom Exp $")
52
53 #ifdef USE_TERM_DRIVER
54 #define NumLabels      InfoOf(SP_PARM).numlabels
55 #else
56 #define NumLabels      num_labels
57 #endif
58
59 #ifndef ONLCR                   /* Allows compilation under the QNX 4.2 OS */
60 #define ONLCR 0
61 #endif
62
63 /*
64  * SVr4/XSI Curses specify that hardware echo is turned off in initscr, and not
65  * restored during the curses session.  The library simulates echo in software.
66  * (The behavior is unspecified if the application enables hardware echo).
67  *
68  * The newterm function also initializes terminal settings, and since initscr
69  * is supposed to behave as if it calls newterm, we do it here.
70  */
71 static NCURSES_INLINE int
72 _nc_initscr(NCURSES_SP_DCL0)
73 {
74     int result = ERR;
75     TERMINAL *term = TerminalOf(SP_PARM);
76
77     /* for extended XPG4 conformance requires cbreak() at this point */
78     /* (SVr4 curses does this anyway) */
79     if (NCURSES_SP_NAME(cbreak) (NCURSES_SP_ARG) == OK) {
80         TTY buf;
81
82         buf = term->Nttyb;
83 #ifdef TERMIOS
84         buf.c_lflag &= (unsigned) ~(ECHO | ECHONL);
85         buf.c_iflag &= (unsigned) ~(ICRNL | INLCR | IGNCR);
86         buf.c_oflag &= (unsigned) ~(ONLCR);
87 #elif HAVE_SGTTY_H
88         buf.sg_flags &= ~(ECHO | CRMOD);
89 #else
90         memset(&buf, 0, sizeof(buf));
91 #endif
92         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
93         if (result == OK)
94             term->Nttyb = buf;
95     }
96     return result;
97 }
98
99 /*
100  * filter() has to be called before either initscr() or newterm(), so there is
101  * apparently no way to make this flag apply to some terminals and not others,
102  * aside from possibly delaying a filter() call until some terminals have been
103  * initialized.
104  */
105 NCURSES_EXPORT(void)
106 NCURSES_SP_NAME(filter) (NCURSES_SP_DCL0)
107 {
108     START_TRACE();
109     T((T_CALLED("filter(%p)"), (void *) SP_PARM));
110 #if NCURSES_SP_FUNCS
111     if (IsPreScreen(SP_PARM)) {
112         SP_PARM->_filtered = TRUE;
113     }
114 #else
115     _nc_prescreen.filter_mode = TRUE;
116 #endif
117     returnVoid;
118 }
119
120 #if NCURSES_SP_FUNCS
121 NCURSES_EXPORT(void)
122 filter(void)
123 {
124     START_TRACE();
125     T((T_CALLED("filter()")));
126     _nc_prescreen.filter_mode = TRUE;
127     returnVoid;
128 }
129 #endif
130
131 #if NCURSES_EXT_FUNCS
132 /*
133  * An extension, allowing the application to open a new screen without
134  * requiring it to also be filtered.
135  */
136 NCURSES_EXPORT(void)
137 NCURSES_SP_NAME(nofilter) (NCURSES_SP_DCL0)
138 {
139     START_TRACE();
140     T((T_CALLED("nofilter(%p)"), (void *) SP_PARM));
141 #if NCURSES_SP_FUNCS
142     if (IsPreScreen(SP_PARM)) {
143         SP_PARM->_filtered = FALSE;
144     }
145 #else
146     _nc_prescreen.filter_mode = FALSE;
147 #endif
148     returnVoid;
149 }
150
151 #if NCURSES_SP_FUNCS
152 NCURSES_EXPORT(void)
153 nofilter(void)
154 {
155     START_TRACE();
156     T((T_CALLED("nofilter()")));
157     _nc_prescreen.filter_mode = FALSE;
158     returnVoid;
159 }
160 #endif
161 #endif /* NCURSES_EXT_FUNCS */
162
163 NCURSES_EXPORT(SCREEN *)
164 NCURSES_SP_NAME(newterm) (NCURSES_SP_DCLx
165                           NCURSES_CONST char *name,
166                           FILE *ofp,
167                           FILE *ifp)
168 {
169     int errret;
170     SCREEN *result = 0;
171     SCREEN *current;
172     TERMINAL *its_term;
173     FILE *_ofp = ofp ? ofp : stdout;
174     FILE *_ifp = ifp ? ifp : stdin;
175     TERMINAL *new_term = 0;
176
177     START_TRACE();
178     T((T_CALLED("newterm(%p, \"%s\", %p,%p)"),
179        (void *) SP_PARM,
180        (name ? name : ""),
181        (void *) ofp,
182        (void *) ifp));
183
184 #if NCURSES_SP_FUNCS
185     assert(SP_PARM != 0);
186     if (SP_PARM == 0)
187         returnSP(SP_PARM);
188 #endif
189
190     _nc_init_pthreads();
191     _nc_lock_global(curses);
192
193     current = CURRENT_SCREEN;
194     its_term = (current ? current->_term : 0);
195
196     INIT_TERM_DRIVER();
197     /* this loads the capability entry, then sets LINES and COLS */
198     if (
199            TINFO_SETUP_TERM(&new_term, name,
200                             fileno(_ofp), &errret, FALSE) != ERR) {
201         int slk_format;
202         int filter_mode;
203
204         _nc_set_screen(0);
205 #ifdef USE_TERM_DRIVER
206         assert(new_term != 0);
207 #endif
208
209 #if NCURSES_SP_FUNCS
210         slk_format = SP_PARM->slk_format;
211         filter_mode = SP_PARM->_filtered;
212 #else
213         slk_format = _nc_globals.slk_format;
214         filter_mode = _nc_prescreen.filter_mode;
215 #endif
216
217         /*
218          * This actually allocates the screen structure, and saves the original
219          * terminal settings.
220          */
221         if (NCURSES_SP_NAME(_nc_setupscreen) (
222 #if NCURSES_SP_FUNCS
223                                                  &SP_PARM,
224 #endif
225                                                  *(ptrLines(SP_PARM)),
226                                                  *(ptrCols(SP_PARM)),
227                                                  _ofp,
228                                                  filter_mode,
229                                                  slk_format) == ERR) {
230             _nc_set_screen(current);
231             result = 0;
232         } else {
233             int value;
234             int cols;
235
236 #ifdef USE_TERM_DRIVER
237             TERMINAL_CONTROL_BLOCK *TCB;
238 #elif !NCURSES_SP_FUNCS
239             _nc_set_screen(CURRENT_SCREEN);
240 #endif
241             assert(SP_PARM != 0);
242             cols = *(ptrCols(SP_PARM));
243 #ifdef USE_TERM_DRIVER
244             _nc_set_screen(SP_PARM);
245             TCB = (TERMINAL_CONTROL_BLOCK *) new_term;
246             TCB->csp = SP_PARM;
247 #endif
248             /*
249              * In setupterm() we did a set_curterm(), but it was before we set
250              * CURRENT_SCREEN.  So the "current" screen's terminal pointer was
251              * overwritten with a different terminal.  Later, in
252              * _nc_setupscreen(), we set CURRENT_SCREEN and the terminal
253              * pointer in the new screen.
254              *
255              * Restore the terminal-pointer for the pre-existing screen, if
256              * any.
257              */
258             if (current)
259                 current->_term = its_term;
260
261 #ifdef USE_TERM_DRIVER
262             SP_PARM->_term = new_term;
263 #else
264             new_term = SP_PARM->_term;
265 #endif
266
267             /* allow user to set maximum escape delay from the environment */
268             if ((value = _nc_getenv_num("ESCDELAY")) >= 0) {
269 #if NCURSES_EXT_FUNCS
270                 NCURSES_SP_NAME(set_escdelay) (NCURSES_SP_ARGx value);
271 #else
272                 ESCDELAY = value;
273 #endif
274             }
275
276             /* if the terminal type has real soft labels, set those up */
277             if (slk_format && NumLabels > 0 && SLK_STDFMT(slk_format))
278                 _nc_slk_initialize(StdScreen(SP_PARM), cols);
279
280             SP_PARM->_ifd = fileno(_ifp);
281             NCURSES_SP_NAME(typeahead) (NCURSES_SP_ARGx fileno(_ifp));
282 #ifdef TERMIOS
283             SP_PARM->_use_meta = ((new_term->Ottyb.c_cflag & CSIZE) == CS8 &&
284                                   !(new_term->Ottyb.c_iflag & ISTRIP)) ||
285                 USE_KLIBC_KBD;
286 #else
287             SP_PARM->_use_meta = FALSE;
288 #endif
289             SP_PARM->_endwin = FALSE;
290 #ifndef USE_TERM_DRIVER
291             /*
292              * Check whether we can optimize scrolling under dumb terminals in
293              * case we do not have any of these capabilities, scrolling
294              * optimization will be useless.
295              */
296             SP_PARM->_scrolling = ((scroll_forward && scroll_reverse) ||
297                                    ((parm_rindex ||
298                                      parm_insert_line ||
299                                      insert_line) &&
300                                     (parm_index ||
301                                      parm_delete_line ||
302                                      delete_line)));
303 #endif
304
305             NCURSES_SP_NAME(baudrate) (NCURSES_SP_ARG);         /* sets a field in the screen structure */
306
307             SP_PARM->_keytry = 0;
308
309             /* compute movement costs so we can do better move optimization */
310 #ifdef USE_TERM_DRIVER
311             TCBOf(SP_PARM)->drv->td_scinit(SP_PARM);
312 #else /* ! USE_TERM_DRIVER */
313             /*
314              * Check for mismatched graphic-rendition capabilities.  Most SVr4
315              * terminfo trees contain entries that have rmul or rmso equated to
316              * sgr0 (Solaris curses copes with those entries).  We do this only
317              * for curses, since many termcap applications assume that
318              * smso/rmso and smul/rmul are paired, and will not function
319              * properly if we remove rmso or rmul.  Curses applications
320              * shouldn't be looking at this detail.
321              */
322 #define SGR0_TEST(mode) (mode != 0) && (exit_attribute_mode == 0 || strcmp(mode, exit_attribute_mode))
323             SP_PARM->_use_rmso = SGR0_TEST(exit_standout_mode);
324             SP_PARM->_use_rmul = SGR0_TEST(exit_underline_mode);
325 #if USE_ITALIC
326             SP_PARM->_use_ritm = SGR0_TEST(exit_italics_mode);
327 #endif
328
329             /* compute movement costs so we can do better move optimization */
330             _nc_mvcur_init();
331
332             /* initialize terminal to a sane state */
333             _nc_screen_init();
334 #endif /* USE_TERM_DRIVER */
335
336             /* Initialize the terminal line settings. */
337             _nc_initscr(NCURSES_SP_ARG);
338
339             _nc_signal_handler(TRUE);
340             result = SP_PARM;
341         }
342     }
343     _nc_unlock_global(curses);
344     returnSP(result);
345 }
346
347 #if NCURSES_SP_FUNCS
348 NCURSES_EXPORT(SCREEN *)
349 newterm(NCURSES_CONST char *name, FILE *ofp, FILE *ifp)
350 {
351     return NCURSES_SP_NAME(newterm) (CURRENT_SCREEN_PRE, name, ofp, ifp);
352 }
353 #endif