ncurses 6.2 - patch 20210515
[ncurses.git] / ncurses / base / lib_set_term.c
1 /****************************************************************************
2  * Copyright 2018-2020,2021 Thomas E. Dickey                                *
3  * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *     and: Thomas E. Dickey                        1996-on                 *
34  *     and: Juergen Pfeifer                         2009                    *
35  ****************************************************************************/
36
37 /*
38 **      lib_set_term.c
39 **
40 **      The routine set_term().
41 **
42 */
43
44 #include <curses.priv.h>
45 #include <tic.h>
46
47 #if USE_GPM_SUPPORT
48 #ifdef HAVE_LIBDL
49 /* use dynamic loader to avoid linkage dependency */
50 #include <dlfcn.h>
51 #endif
52 #endif
53
54 #undef CUR
55 #define CUR SP_TERMTYPE
56
57 MODULE_ID("$Id: lib_set_term.c,v 1.179 2021/05/08 21:48:34 tom Exp $")
58
59 #ifdef USE_TERM_DRIVER
60 #define MaxColors      InfoOf(sp).maxcolors
61 #define NumLabels      InfoOf(sp).numlabels
62 #else
63 #define MaxColors      max_colors
64 #define NumLabels      num_labels
65 #endif
66
67 NCURSES_EXPORT(SCREEN *)
68 set_term(SCREEN *screenp)
69 {
70     SCREEN *oldSP;
71     SCREEN *newSP;
72
73     T((T_CALLED("set_term(%p)"), (void *) screenp));
74
75     _nc_lock_global(curses);
76
77     oldSP = CURRENT_SCREEN;
78     _nc_set_screen(screenp);
79     newSP = screenp;
80
81     if (newSP != 0) {
82         TINFO_SET_CURTERM(newSP, newSP->_term);
83 #if !USE_REENTRANT
84         curscr = CurScreen(newSP);
85         newscr = NewScreen(newSP);
86         stdscr = StdScreen(newSP);
87         COLORS = newSP->_color_count;
88         COLOR_PAIRS = newSP->_pair_count;
89 #endif
90     } else {
91         TINFO_SET_CURTERM(oldSP, 0);
92 #if !USE_REENTRANT
93         curscr = 0;
94         newscr = 0;
95         stdscr = 0;
96         COLORS = 0;
97         COLOR_PAIRS = 0;
98 #endif
99     }
100
101     _nc_unlock_global(curses);
102
103     T((T_RETURN("%p"), (void *) oldSP));
104     return (oldSP);
105 }
106
107 static void
108 _nc_free_keytry(TRIES * kt)
109 {
110     if (kt != 0) {
111         _nc_free_keytry(kt->child);
112         _nc_free_keytry(kt->sibling);
113         free(kt);
114     }
115 }
116
117 static bool
118 delink_screen(SCREEN *sp)
119 {
120     SCREEN *last = 0;
121     SCREEN *temp;
122     bool result = FALSE;
123
124     for (each_screen(temp)) {
125         if (temp == sp) {
126             if (last)
127                 last->_next_screen = sp->_next_screen;
128             else
129                 _nc_screen_chain = sp->_next_screen;
130             result = TRUE;
131             break;
132         }
133         last = temp;
134     }
135     return result;
136 }
137
138 /*
139  * Free the storage associated with the given SCREEN sp.
140  */
141 NCURSES_EXPORT(void)
142 delscreen(SCREEN *sp)
143 {
144
145     T((T_CALLED("delscreen(%p)"), (void *) sp));
146
147     _nc_lock_global(curses);
148     if (delink_screen(sp)) {
149 #ifdef USE_SP_RIPOFF
150         if (safe_ripoff_sp && safe_ripoff_sp != safe_ripoff_stack) {
151             ripoff_t *rop;
152             for (rop = safe_ripoff_stack;
153                  rop != safe_ripoff_sp && (rop - safe_ripoff_stack) < N_RIPS;
154                  rop++) {
155                 if (rop->win) {
156                     (void) delwin(rop->win);
157                     rop->win = 0;
158                 }
159             }
160         }
161 #endif
162
163         (void) _nc_freewin(CurScreen(sp));
164         (void) _nc_freewin(NewScreen(sp));
165         (void) _nc_freewin(StdScreen(sp));
166
167         if (sp->_slk != 0) {
168
169             if (sp->_slk->ent != 0) {
170                 int i;
171
172                 for (i = 0; i < sp->_slk->labcnt; ++i) {
173                     FreeIfNeeded(sp->_slk->ent[i].ent_text);
174                     FreeIfNeeded(sp->_slk->ent[i].form_text);
175                 }
176                 free(sp->_slk->ent);
177             }
178             free(sp->_slk);
179             sp->_slk = 0;
180         }
181
182         _nc_free_keytry(sp->_keytry);
183         sp->_keytry = 0;
184
185         _nc_free_keytry(sp->_key_ok);
186         sp->_key_ok = 0;
187
188         FreeIfNeeded(sp->_current_attr);
189
190         FreeIfNeeded(sp->_color_table);
191         FreeIfNeeded(sp->_color_pairs);
192
193         FreeIfNeeded(sp->_oldnum_list);
194         FreeIfNeeded(sp->oldhash);
195         FreeIfNeeded(sp->newhash);
196         FreeIfNeeded(sp->hashtab);
197
198         FreeIfNeeded(sp->_acs_map);
199         FreeIfNeeded(sp->_screen_acs_map);
200
201         NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
202         NCURSES_SP_NAME(del_curterm) (NCURSES_SP_ARGx sp->_term);
203         FreeIfNeeded(sp->out_buffer);
204         if (_nc_find_prescr() == sp) {
205             _nc_forget_prescr();
206         }
207 #if USE_GPM_SUPPORT
208 #ifdef HAVE_LIBDL
209         if (sp->_dlopen_gpm != 0) {
210             dlclose(sp->_dlopen_gpm);
211             sp->_dlopen_gpm = 0;
212         }
213 #endif
214 #endif /* USE_GPM_SUPPORT */
215         free(sp);
216
217         /*
218          * If this was the current screen, reset everything that the
219          * application might try to use (except cur_term, which may have
220          * multiple references in different screens).
221          */
222         if (sp == CURRENT_SCREEN) {
223 #if !USE_REENTRANT
224             curscr = 0;
225             newscr = 0;
226             stdscr = 0;
227             COLORS = 0;
228             COLOR_PAIRS = 0;
229 #endif
230             _nc_set_screen(0);
231 #if USE_WIDEC_SUPPORT
232             if (SP == 0) {
233                 FreeIfNeeded(_nc_wacs);
234                 _nc_wacs = 0;
235             }
236 #endif
237         }
238     }
239     _nc_unlock_global(curses);
240
241     returnVoid;
242 }
243
244 static bool
245 no_mouse_event(SCREEN *sp GCC_UNUSED)
246 {
247     return FALSE;
248 }
249
250 static bool
251 no_mouse_inline(SCREEN *sp GCC_UNUSED)
252 {
253     return FALSE;
254 }
255
256 static bool
257 no_mouse_parse(SCREEN *sp GCC_UNUSED, int code GCC_UNUSED)
258 {
259     return TRUE;
260 }
261
262 static void
263 no_mouse_resume(SCREEN *sp GCC_UNUSED)
264 {
265 }
266
267 static void
268 no_mouse_wrap(SCREEN *sp GCC_UNUSED)
269 {
270 }
271
272 #if NCURSES_EXT_FUNCS && USE_COLORFGBG
273 static const char *
274 extract_fgbg(const char *src, int *result)
275 {
276     const char *dst = 0;
277     char *tmp = 0;
278     long value = strtol(src, &tmp, 0);
279
280     if ((dst = tmp) == 0) {
281         dst = src;
282     } else if (value >= 0) {
283         *result = (int) value;
284     }
285     while (*dst != 0 && *dst != ';')
286         dst++;
287     if (*dst == ';')
288         dst++;
289     return dst;
290 }
291 #endif
292
293 #define ReturnScreenError() do { _nc_set_screen(0); \
294                             returnCode(ERR); } while (0)
295
296 /* OS-independent screen initializations */
297 NCURSES_EXPORT(int)
298 NCURSES_SP_NAME(_nc_setupscreen) (
299 #if NCURSES_SP_FUNCS
300                                      SCREEN **spp,
301 #endif
302                                      int slines,
303                                      int scolumns,
304                                      FILE *output,
305                                      int filtered,
306                                      int slk_format)
307 {
308 #ifndef USE_TERM_DRIVER
309     static const TTY null_TTY;  /* all zeros iff uninitialized */
310 #endif
311     char *env;
312     int bottom_stolen = 0;
313     SCREEN *sp;
314 #ifndef USE_TERM_DRIVER
315     bool support_cookies = USE_XMC_SUPPORT;
316 #endif
317
318     T((T_CALLED("_nc_setupscreen(%d, %d, %p, %d, %d)"),
319        slines, scolumns, (void *) output, filtered, slk_format));
320
321     assert(CURRENT_SCREEN == 0);        /* has been reset in newterm() ! */
322
323 #if NCURSES_SP_FUNCS
324     assert(spp != 0);
325     sp = *spp;
326
327     if (!sp) {
328         sp = _nc_alloc_screen_sp();
329         T(("_nc_alloc_screen_sp %p", (void *) sp));
330         *spp = sp;
331     }
332     if (sp == NULL) {
333         ReturnScreenError();
334     }
335     if ((sp->_acs_map = typeCalloc(chtype, ACS_LEN)) == NULL) {
336         ReturnScreenError();
337     }
338     if ((sp->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == NULL) {
339         free(sp->_acs_map);
340         ReturnScreenError();
341     }
342
343     T(("created SP %p", (void *) sp));
344     sp->_next_screen = _nc_screen_chain;
345     _nc_screen_chain = sp;
346
347     if ((sp->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0) {
348         ReturnScreenError();
349     }
350 #else
351     if (!_nc_alloc_screen()
352         || ((SP->_acs_map = typeCalloc(chtype, ACS_LEN)) == 0)
353         || ((SP->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == 0)) {
354         returnCode(ERR);
355     }
356
357     T(("created SP %p", (void *) SP));
358
359     sp = SP;                    /* fixup so SET_LINES and SET_COLS works */
360     sp->_next_screen = _nc_screen_chain;
361     _nc_screen_chain = sp;
362
363     if ((sp->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0) {
364         returnCode(ERR);
365     }
366 #endif
367
368     /*
369      * We should always check the screensize, just in case.
370      */
371     _nc_set_screen(sp);
372     sp->_term = cur_term;
373 #ifdef USE_TERM_DRIVER
374     TCBOf(sp)->csp = sp;
375     _nc_get_screensize(sp, sp->_term, &slines, &scolumns);
376 #else
377     _nc_get_screensize(sp, &slines, &scolumns);
378 #endif
379     SET_LINES(slines);
380     SET_COLS(scolumns);
381
382     T((T_CREATE("screen %s %dx%d"),
383        NCURSES_SP_NAME(termname) (NCURSES_SP_ARG), slines, scolumns));
384
385     sp->_filtered = filtered;
386
387     /* implement filter mode */
388     if (filtered) {
389         slines = 1;
390         SET_LINES(slines);
391 #ifdef USE_TERM_DRIVER
392         CallDriver(sp, td_setfilter);
393 #else
394         /* *INDENT-EQLS* */
395         clear_screen     = ABSENT_STRING;
396         cursor_address   = ABSENT_STRING;
397         cursor_down      = ABSENT_STRING;
398         cursor_up        = ABSENT_STRING;
399         parm_down_cursor = ABSENT_STRING;
400         parm_up_cursor   = ABSENT_STRING;
401         row_address      = ABSENT_STRING;
402         cursor_home      = carriage_return;
403
404         if (back_color_erase)
405             clr_eos = ABSENT_STRING;
406
407 #endif
408         T(("filter screensize %dx%d", slines, scolumns));
409     }
410 #ifdef __DJGPP__
411     T(("setting output mode to binary"));
412     fflush(output);
413     setmode(output, O_BINARY);
414 #endif
415 #if defined(EXP_WIN32_DRIVER)
416     T(("setting output mode to binary"));
417     fflush(output);
418     _setmode(fileno(output), _O_BINARY);
419 #endif
420     sp->_lines = (NCURSES_SIZE_T) slines;
421     sp->_lines_avail = (NCURSES_SIZE_T) slines;
422     sp->_columns = (NCURSES_SIZE_T) scolumns;
423
424     fflush(output);
425     sp->_ofd = output ? fileno(output) : -1;
426     sp->_ofp = output;
427 #if defined(EXP_WIN32_DRIVER)
428     if (output)
429         _setmode(fileno(output), _O_BINARY);
430 #endif
431     sp->out_limit = (size_t) ((2 + slines) * (6 + scolumns));
432     if ((sp->out_buffer = malloc(sp->out_limit)) == 0)
433         sp->out_limit = 0;
434     sp->out_inuse = 0;
435
436     SP_PRE_INIT(sp);
437     SetNoPadding(sp);
438
439 #if NCURSES_EXT_FUNCS
440     sp->_default_color = FALSE;
441     sp->_has_sgr_39_49 = FALSE;
442
443     /*
444      * Set our assumption of the terminal's default foreground and background
445      * colors.  The curs_color man-page states that we can assume that the
446      * background is black.  The origin of this assumption appears to be
447      * terminals that displayed colored text, but no colored backgrounds, e.g.,
448      * the first colored terminals around 1980.  More recent ones with better
449      * technology can display not only colored backgrounds, but all
450      * combinations.  So a terminal might be something other than "white" on
451      * black (green/black looks monochrome too), but black on white or even
452      * on ivory.
453      *
454      * White-on-black is the simplest thing to use for monochrome.  Almost
455      * all applications that use color paint both text and background, so
456      * the distinction is moot.  But a few do not - which is why we leave this
457      * configurable (a better solution is to use assume_default_colors() for
458      * the rare applications that do require that sort of appearance, since
459      * is appears that more users expect to be able to make a white-on-black
460      * or black-on-white display under control of the application than not).
461      */
462 #ifdef USE_ASSUMED_COLOR
463     sp->_default_fg = COLOR_WHITE;
464     sp->_default_bg = COLOR_BLACK;
465 #else
466     sp->_default_fg = COLOR_DEFAULT;
467     sp->_default_bg = COLOR_DEFAULT;
468 #endif
469
470     /*
471      * Allow those assumed/default color assumptions to be overridden at
472      * runtime:
473      */
474     if ((env = getenv("NCURSES_ASSUMED_COLORS")) != 0) {
475         int fg, bg;
476         char sep1, sep2;
477         int count = sscanf(env, "%d%c%d%c", &fg, &sep1, &bg, &sep2);
478         if (count >= 1) {
479             sp->_default_fg = ((fg >= 0 && fg < MaxColors) ? fg : COLOR_DEFAULT);
480             if (count >= 3) {
481                 sp->_default_bg = ((bg >= 0 && bg < MaxColors) ? bg : COLOR_DEFAULT);
482             }
483             TR(TRACE_CHARPUT | TRACE_MOVE,
484                ("from environment assumed fg=%d, bg=%d",
485                 sp->_default_fg,
486                 sp->_default_bg));
487         }
488     }
489 #if USE_COLORFGBG
490     /*
491      * If rxvt's $COLORFGBG variable is set, use it to specify the assumed
492      * default colors.  Note that rxvt (mis)uses bold colors, equating a bold
493      * color to that value plus 8.  We'll only use the non-bold color for now -
494      * decide later if it is worth having default attributes as well.
495      */
496     if (getenv("COLORFGBG") != 0) {
497         const char *p = getenv("COLORFGBG");
498         TR(TRACE_CHARPUT | TRACE_MOVE, ("decoding COLORFGBG %s", p));
499         p = extract_fgbg(p, &(sp->_default_fg));
500         p = extract_fgbg(p, &(sp->_default_bg));
501         if (*p)                 /* assume rxvt was compiled with xpm support */
502             extract_fgbg(p, &(sp->_default_bg));
503         TR(TRACE_CHARPUT | TRACE_MOVE, ("decoded fg=%d, bg=%d",
504                                         sp->_default_fg, sp->_default_bg));
505         if (sp->_default_fg >= MaxColors) {
506             if (set_a_foreground != ABSENT_STRING
507                 && !strcmp(set_a_foreground, "\033[3%p1%dm")) {
508                 set_a_foreground = strdup("\033[3%?%p1%{8}%>%t9%e%p1%d%;m");
509             } else {
510                 sp->_default_fg %= MaxColors;
511             }
512         }
513         if (sp->_default_bg >= MaxColors) {
514             if (set_a_background != ABSENT_STRING
515                 && !strcmp(set_a_background, "\033[4%p1%dm")) {
516                 set_a_background = strdup("\033[4%?%p1%{8}%>%t9%e%p1%d%;m");
517             } else {
518                 sp->_default_bg %= MaxColors;
519             }
520         }
521     }
522 #endif
523 #endif /* NCURSES_EXT_FUNCS */
524
525     sp->_maxclick = DEFAULT_MAXCLICK;
526     sp->_mouse_event = no_mouse_event;
527     sp->_mouse_inline = no_mouse_inline;
528     sp->_mouse_parse = no_mouse_parse;
529     sp->_mouse_resume = no_mouse_resume;
530     sp->_mouse_wrap = no_mouse_wrap;
531     sp->_mouse_fd = -1;
532
533     /*
534      * If we've no magic cookie support, we suppress attributes that xmc would
535      * affect, i.e., the attributes that affect the rendition of a space.
536      */
537     sp->_ok_attributes = NCURSES_SP_NAME(termattrs) (NCURSES_SP_ARG);
538     if (NCURSES_SP_NAME(has_colors) (NCURSES_SP_ARG)) {
539         sp->_ok_attributes |= A_COLOR;
540     }
541 #ifdef USE_TERM_DRIVER
542     _nc_cookie_init(sp);
543 #else
544 #if USE_XMC_SUPPORT
545     /*
546      * If we have no magic-cookie support compiled-in, or if it is suppressed
547      * in the environment, reset the support-flag.
548      */
549     if (magic_cookie_glitch >= 0) {
550         if (getenv("NCURSES_NO_MAGIC_COOKIE") != 0) {
551             support_cookies = FALSE;
552         }
553     }
554 #endif
555
556     if (!support_cookies && magic_cookie_glitch >= 0) {
557         T(("will disable attributes to work w/o magic cookies"));
558     }
559
560     if (magic_cookie_glitch > 0) {      /* tvi, wyse */
561
562         sp->_xmc_triggers = sp->_ok_attributes & XMC_CONFLICT;
563 #if 0
564         /*
565          * We "should" treat colors as an attribute.  The wyse350 (and its
566          * clones) appear to be the only ones that have both colors and magic
567          * cookies.
568          */
569         if (has_colors()) {
570             sp->_xmc_triggers |= A_COLOR;
571         }
572 #endif
573         sp->_xmc_suppress = sp->_xmc_triggers & (chtype) ~(A_BOLD);
574
575         T(("magic cookie attributes %s", _traceattr(sp->_xmc_suppress)));
576         /*
577          * Supporting line-drawing may be possible.  But make the regular
578          * video attributes work first.
579          */
580         acs_chars = ABSENT_STRING;
581         ena_acs = ABSENT_STRING;
582         enter_alt_charset_mode = ABSENT_STRING;
583         exit_alt_charset_mode = ABSENT_STRING;
584 #if USE_XMC_SUPPORT
585         /*
586          * To keep the cookie support simple, suppress all of the optimization
587          * hooks except for clear_screen and the cursor addressing.
588          */
589         if (support_cookies) {
590             clr_eol = ABSENT_STRING;
591             clr_eos = ABSENT_STRING;
592             set_attributes = ABSENT_STRING;
593         }
594 #endif
595     } else if (magic_cookie_glitch == 0) {      /* hpterm */
596     }
597
598     /*
599      * If magic cookies are not supported, cancel the strings that set
600      * video attributes.
601      */
602     if (!support_cookies && magic_cookie_glitch >= 0) {
603         magic_cookie_glitch = ABSENT_NUMERIC;
604         set_attributes = ABSENT_STRING;
605         enter_blink_mode = ABSENT_STRING;
606         enter_bold_mode = ABSENT_STRING;
607         enter_dim_mode = ABSENT_STRING;
608         enter_reverse_mode = ABSENT_STRING;
609         enter_standout_mode = ABSENT_STRING;
610         enter_underline_mode = ABSENT_STRING;
611     }
612
613     /* initialize normal acs before wide, since we use mapping in the latter */
614 #if !USE_WIDEC_SUPPORT
615     if (_nc_unicode_locale() && _nc_locale_breaks_acs(sp->_term)) {
616         acs_chars = NULL;
617         ena_acs = NULL;
618         enter_alt_charset_mode = NULL;
619         exit_alt_charset_mode = NULL;
620         set_attributes = NULL;
621     }
622 #endif
623 #endif
624
625     NCURSES_SP_NAME(_nc_init_acs) (NCURSES_SP_ARG);
626 #if USE_WIDEC_SUPPORT
627     sp->_screen_unicode = _nc_unicode_locale();
628     if (_nc_wacs == 0) {
629         _nc_init_wacs();
630     }
631     if (_nc_wacs == 0) {
632         ReturnScreenError();
633     }
634
635     sp->_screen_acs_fix = (sp->_screen_unicode
636                            && _nc_locale_breaks_acs(sp->_term));
637 #endif
638     env = _nc_get_locale();
639     sp->_legacy_coding = ((env == 0)
640                           || !strcmp(env, "C")
641                           || !strcmp(env, "POSIX"));
642     T(("legacy-coding %d", sp->_legacy_coding));
643
644     sp->_nc_sp_idcok = TRUE;
645     sp->_nc_sp_idlok = FALSE;
646
647     sp->oldhash = 0;
648     sp->newhash = 0;
649
650     T(("creating newscr"));
651     NewScreen(sp) = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx slines, scolumns,
652                                              0, 0);
653     if (NewScreen(sp) == 0) {
654         ReturnScreenError();
655     }
656     T(("creating curscr"));
657     CurScreen(sp) = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx slines, scolumns,
658                                              0, 0);
659     if (CurScreen(sp) == 0) {
660         ReturnScreenError();
661     }
662 #if !USE_REENTRANT
663     newscr = NewScreen(sp);
664     curscr = CurScreen(sp);
665 #endif
666 #if USE_SIZECHANGE
667     sp->_resize = NCURSES_SP_NAME(resizeterm);
668     sp->_ungetch = safe_ungetch;
669 #endif
670
671     NewScreen(sp)->_clear = TRUE;
672     CurScreen(sp)->_clear = FALSE;
673
674     /*
675      * Get the current tty-modes. setupterm() may already have done this,
676      * unless we use the term-driver.
677      */
678 #ifndef USE_TERM_DRIVER
679     if (cur_term != 0 &&
680         !memcmp(&cur_term->Ottyb, &null_TTY, sizeof(TTY)))
681 #endif
682     {
683         NCURSES_SP_NAME(def_shell_mode) (NCURSES_SP_ARG);
684         NCURSES_SP_NAME(def_prog_mode) (NCURSES_SP_ARG);
685     }
686
687     if (safe_ripoff_sp && safe_ripoff_sp != safe_ripoff_stack) {
688         ripoff_t *rop;
689
690         for (rop = safe_ripoff_stack;
691              rop != safe_ripoff_sp && (rop - safe_ripoff_stack) < N_RIPS;
692              rop++) {
693
694             /* If we must simulate soft labels, grab off the line to be used.
695                We assume that we must simulate, if it is none of the standard
696                formats (4-4 or 3-2-3) for which there may be some hardware
697                support. */
698             if (rop->hook == _nc_slk_initialize) {
699                 if (!TerminalOf(sp)) {
700                     continue;
701                 }
702                 if (!(NumLabels <= 0 || !SLK_STDFMT(slk_format))) {
703                     continue;
704                 }
705             }
706             if (rop->hook) {
707                 int count;
708                 WINDOW *w;
709
710                 count = (rop->line < 0) ? -rop->line : rop->line;
711                 T(("ripping off %i lines at %s", count,
712                    ((rop->line < 0)
713                     ? "bottom"
714                     : "top")));
715
716                 w = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx
717                                              count, scolumns,
718                                              ((rop->line < 0)
719                                               ? sp->_lines_avail - count
720                                               : 0),
721                                              0);
722                 if (w) {
723                     rop->win = w;
724                     rop->hook(w, scolumns);
725                 } else {
726                     ReturnScreenError();
727                 }
728                 if (rop->line < 0) {
729                     bottom_stolen += count;
730                 } else {
731                     sp->_topstolen = (NCURSES_SIZE_T) (sp->_topstolen + count);
732                 }
733                 sp->_lines_avail = (NCURSES_SIZE_T) (sp->_lines_avail - count);
734             }
735         }
736         /* reset the stack */
737         safe_ripoff_sp = safe_ripoff_stack;
738     }
739
740     T(("creating stdscr"));
741     assert((sp->_lines_avail + sp->_topstolen + bottom_stolen) == slines);
742     if ((StdScreen(sp) = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx
743                                                   sp->_lines_avail,
744                                                   scolumns, 0, 0)) == 0) {
745         ReturnScreenError();
746     }
747     SET_LINES(sp->_lines_avail);
748 #if !USE_REENTRANT
749     stdscr = StdScreen(sp);
750 #endif
751     sp->_prescreen = FALSE;
752     returnCode(OK);
753 }
754
755 #if NCURSES_SP_FUNCS
756 NCURSES_EXPORT(int)
757 _nc_setupscreen(int slines GCC_UNUSED,
758                 int scolumns GCC_UNUSED,
759                 FILE *output,
760                 int filtered,
761                 int slk_format)
762 {
763     SCREEN *sp = 0;
764     int rc = NCURSES_SP_NAME(_nc_setupscreen) (&sp,
765                                                slines,
766                                                scolumns,
767                                                output,
768                                                filtered,
769                                                slk_format);
770     if (rc != OK)
771         _nc_set_screen(0);
772     return rc;
773 }
774 #endif
775
776 /*
777  * The internal implementation interprets line as the number of lines to rip
778  * off from the top or bottom.
779  */
780 NCURSES_EXPORT(int)
781 NCURSES_SP_NAME(_nc_ripoffline) (NCURSES_SP_DCLx
782                                  int line,
783                                  int (*init) (WINDOW *, int))
784 {
785     int code = ERR;
786     TR_FUNC_BFR(1);
787
788     START_TRACE();
789     T((T_CALLED("ripoffline(%p,%d,%s)"),
790        (void *) SP_PARM, line,
791        TR_FUNC_ARG(0, init)));
792
793 #if NCURSES_SP_FUNCS
794     if (SP_PARM != 0 && SP_PARM->_prescreen)
795 #endif
796     {
797         if (line == 0) {
798             code = OK;
799         } else {
800             if (safe_ripoff_sp == 0) {
801                 safe_ripoff_sp = safe_ripoff_stack;
802             }
803             if (safe_ripoff_sp < safe_ripoff_stack + N_RIPS) {
804                 safe_ripoff_sp->line = line;
805                 safe_ripoff_sp->hook = init;
806                 (safe_ripoff_sp)++;
807                 T(("ripped-off %d:%d chunks",
808                    (int) (safe_ripoff_sp - safe_ripoff_stack), N_RIPS));
809                 code = OK;
810             }
811         }
812     }
813
814     returnCode(code);
815 }
816
817 #if NCURSES_SP_FUNCS
818 NCURSES_EXPORT(int)
819 _nc_ripoffline(int line, int (*init) (WINDOW *, int))
820 {
821     int rc;
822     _nc_lock_global(prescreen);
823     START_TRACE();
824     rc = NCURSES_SP_NAME(_nc_ripoffline) (CURRENT_SCREEN_PRE, line, init);
825     _nc_unlock_global(prescreen);
826     return rc;
827 }
828 #endif
829
830 NCURSES_EXPORT(int)
831 NCURSES_SP_NAME(ripoffline) (NCURSES_SP_DCLx
832                              int line,
833                              int (*init) (WINDOW *, int))
834 {
835     START_TRACE();
836     return NCURSES_SP_NAME(_nc_ripoffline) (NCURSES_SP_ARGx
837                                             (line < 0) ? -1 : 1,
838                                             init);
839 }
840
841 #if NCURSES_SP_FUNCS
842 NCURSES_EXPORT(int)
843 ripoffline(int line, int (*init) (WINDOW *, int))
844 {
845     int rc;
846     _nc_lock_global(prescreen);
847     START_TRACE();
848     rc = NCURSES_SP_NAME(ripoffline) (CURRENT_SCREEN_PRE, line, init);
849     _nc_unlock_global(prescreen);
850     return rc;
851 }
852 #endif