1 /****************************************************************************
2 * Copyright 2018-2021,2022 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
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 ****************************************************************************/
40 ** The routine set_term().
44 #include <curses.priv.h>
49 /* use dynamic loader to avoid linkage dependency */
55 #define CUR SP_TERMTYPE
57 MODULE_ID("$Id: lib_set_term.c,v 1.182 2022/08/13 23:14:26 tom Exp $")
59 #ifdef USE_TERM_DRIVER
60 #define MaxColors InfoOf(sp).maxcolors
61 #define NumLabels InfoOf(sp).numlabels
63 #define MaxColors max_colors
64 #define NumLabels num_labels
67 NCURSES_EXPORT(SCREEN *)
68 set_term(SCREEN *screenp)
73 T((T_CALLED("set_term(%p)"), (void *) screenp));
75 _nc_lock_global(curses);
77 oldSP = CURRENT_SCREEN;
78 _nc_set_screen(screenp);
82 TINFO_SET_CURTERM(newSP, newSP->_term);
84 curscr = CurScreen(newSP);
85 newscr = NewScreen(newSP);
86 stdscr = StdScreen(newSP);
87 COLORS = newSP->_color_count;
88 COLOR_PAIRS = newSP->_pair_count;
91 TINFO_SET_CURTERM(oldSP, 0);
101 _nc_unlock_global(curses);
103 T((T_RETURN("%p"), (void *) oldSP));
108 _nc_free_keytry(TRIES * kt)
111 _nc_free_keytry(kt->child);
112 _nc_free_keytry(kt->sibling);
118 delink_screen(SCREEN *sp)
124 for (each_screen(temp)) {
127 last->_next_screen = sp->_next_screen;
129 _nc_screen_chain = sp->_next_screen;
139 * Free the storage associated with the given SCREEN sp.
142 delscreen(SCREEN *sp)
145 T((T_CALLED("delscreen(%p)"), (void *) sp));
147 _nc_lock_global(curses);
148 if (delink_screen(sp)) {
150 bool is_current = (sp == CURRENT_SCREEN);
153 if (safe_ripoff_sp && safe_ripoff_sp != safe_ripoff_stack) {
155 for (rop = safe_ripoff_stack;
156 rop != safe_ripoff_sp && (rop - safe_ripoff_stack) < N_RIPS;
159 (void) delwin(rop->win);
166 /* delete all of the windows in this screen */
168 for (each_window(sp, wl)) {
169 if (_nc_freewin(&(wl->win)) == OK) {
176 if (sp->_slk->ent != 0) {
179 for (i = 0; i < sp->_slk->labcnt; ++i) {
180 FreeIfNeeded(sp->_slk->ent[i].ent_text);
181 FreeIfNeeded(sp->_slk->ent[i].form_text);
189 _nc_free_keytry(sp->_keytry);
192 _nc_free_keytry(sp->_key_ok);
195 FreeIfNeeded(sp->_current_attr);
197 FreeIfNeeded(sp->_color_table);
198 FreeIfNeeded(sp->_color_pairs);
200 FreeIfNeeded(sp->_oldnum_list);
201 FreeIfNeeded(sp->oldhash);
202 FreeIfNeeded(sp->newhash);
203 FreeIfNeeded(sp->hashtab);
205 FreeIfNeeded(sp->_acs_map);
206 FreeIfNeeded(sp->_screen_acs_map);
208 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
209 NCURSES_SP_NAME(del_curterm) (NCURSES_SP_ARGx sp->_term);
210 FreeIfNeeded(sp->out_buffer);
211 if (_nc_find_prescr() == sp) {
216 if (sp->_dlopen_gpm != 0) {
217 dlclose(sp->_dlopen_gpm);
221 #endif /* USE_GPM_SUPPORT */
225 * If this was the current screen, reset everything that the
226 * application might try to use (except cur_term, which may have
227 * multiple references in different screens).
238 #if USE_WIDEC_SUPPORT
240 FreeIfNeeded(_nc_wacs);
245 set_term(CURRENT_SCREEN);
248 _nc_unlock_global(curses);
254 no_mouse_event(SCREEN *sp GCC_UNUSED)
260 no_mouse_inline(SCREEN *sp GCC_UNUSED)
266 no_mouse_parse(SCREEN *sp GCC_UNUSED, int code GCC_UNUSED)
272 no_mouse_resume(SCREEN *sp GCC_UNUSED)
277 no_mouse_wrap(SCREEN *sp GCC_UNUSED)
281 #if NCURSES_EXT_FUNCS && USE_COLORFGBG
283 extract_fgbg(const char *src, int *result)
287 long value = strtol(src, &tmp, 0);
289 if ((dst = tmp) == 0) {
291 } else if (value >= 0) {
292 *result = (int) value;
294 while (*dst != 0 && *dst != ';')
302 #define ReturnScreenError() do { _nc_set_screen(0); \
303 returnCode(ERR); } while (0)
305 /* OS-independent screen initializations */
307 NCURSES_SP_NAME(_nc_setupscreen) (
317 #ifndef USE_TERM_DRIVER
318 static const TTY null_TTY; /* all zeros iff uninitialized */
321 int bottom_stolen = 0;
323 #ifndef USE_TERM_DRIVER
324 bool support_cookies = USE_XMC_SUPPORT;
327 T((T_CALLED("_nc_setupscreen(%d, %d, %p, %d, %d)"),
328 slines, scolumns, (void *) output, filtered, slk_format));
330 assert(CURRENT_SCREEN == 0); /* has been reset in newterm() ! */
337 sp = _nc_alloc_screen_sp();
338 T(("_nc_alloc_screen_sp %p", (void *) sp));
344 if ((sp->_acs_map = typeCalloc(chtype, ACS_LEN)) == NULL) {
347 if ((sp->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == NULL) {
352 T(("created SP %p", (void *) sp));
353 sp->_next_screen = _nc_screen_chain;
354 _nc_screen_chain = sp;
356 if ((sp->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0) {
360 if (!_nc_alloc_screen()
361 || ((SP->_acs_map = typeCalloc(chtype, ACS_LEN)) == 0)
362 || ((SP->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == 0)) {
366 T(("created SP %p", (void *) SP));
368 sp = SP; /* fixup so SET_LINES and SET_COLS works */
369 sp->_next_screen = _nc_screen_chain;
370 _nc_screen_chain = sp;
372 if ((sp->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0) {
378 * We should always check the screensize, just in case.
381 sp->_term = cur_term;
382 #ifdef USE_TERM_DRIVER
384 _nc_get_screensize(sp, sp->_term, &slines, &scolumns);
386 _nc_get_screensize(sp, &slines, &scolumns);
391 T((T_CREATE("screen %s %dx%d"),
392 NCURSES_SP_NAME(termname) (NCURSES_SP_ARG), slines, scolumns));
394 sp->_filtered = filtered;
396 /* implement filter mode */
400 #ifdef USE_TERM_DRIVER
401 CallDriver(sp, td_setfilter);
404 clear_screen = ABSENT_STRING;
405 cursor_address = ABSENT_STRING;
406 cursor_down = ABSENT_STRING;
407 cursor_up = ABSENT_STRING;
408 parm_down_cursor = ABSENT_STRING;
409 parm_up_cursor = ABSENT_STRING;
410 row_address = ABSENT_STRING;
411 cursor_home = carriage_return;
413 if (back_color_erase)
414 clr_eos = ABSENT_STRING;
417 T(("filter screensize %dx%d", slines, scolumns));
420 T(("setting output mode to binary"));
422 setmode(output, O_BINARY);
424 #if defined(EXP_WIN32_DRIVER)
425 T(("setting output mode to binary"));
427 _setmode(fileno(output), _O_BINARY);
429 sp->_lines = (NCURSES_SIZE_T) slines;
430 sp->_lines_avail = (NCURSES_SIZE_T) slines;
431 sp->_columns = (NCURSES_SIZE_T) scolumns;
434 sp->_ofd = output ? fileno(output) : -1;
436 #if defined(EXP_WIN32_DRIVER)
438 _setmode(fileno(output), _O_BINARY);
440 sp->out_limit = (size_t) ((2 + slines) * (6 + scolumns));
441 if ((sp->out_buffer = malloc(sp->out_limit)) == 0)
448 #if NCURSES_EXT_FUNCS
449 sp->_default_color = FALSE;
450 sp->_has_sgr_39_49 = FALSE;
453 * Set our assumption of the terminal's default foreground and background
454 * colors. The curs_color man-page states that we can assume that the
455 * background is black. The origin of this assumption appears to be
456 * terminals that displayed colored text, but no colored backgrounds, e.g.,
457 * the first colored terminals around 1980. More recent ones with better
458 * technology can display not only colored backgrounds, but all
459 * combinations. So a terminal might be something other than "white" on
460 * black (green/black looks monochrome too), but black on white or even
463 * White-on-black is the simplest thing to use for monochrome. Almost
464 * all applications that use color paint both text and background, so
465 * the distinction is moot. But a few do not - which is why we leave this
466 * configurable (a better solution is to use assume_default_colors() for
467 * the rare applications that do require that sort of appearance, since
468 * is appears that more users expect to be able to make a white-on-black
469 * or black-on-white display under control of the application than not).
471 #ifdef USE_ASSUMED_COLOR
472 sp->_default_fg = COLOR_WHITE;
473 sp->_default_bg = COLOR_BLACK;
475 sp->_default_fg = COLOR_DEFAULT;
476 sp->_default_bg = COLOR_DEFAULT;
480 * Allow those assumed/default color assumptions to be overridden at
483 if ((env = getenv("NCURSES_ASSUMED_COLORS")) != 0) {
486 int count = sscanf(env, "%d%c%d%c", &fg, &sep1, &bg, &sep2);
488 sp->_default_fg = ((fg >= 0 && fg < MaxColors) ? fg : COLOR_DEFAULT);
490 sp->_default_bg = ((bg >= 0 && bg < MaxColors) ? bg : COLOR_DEFAULT);
492 TR(TRACE_CHARPUT | TRACE_MOVE,
493 ("from environment assumed fg=%d, bg=%d",
500 * If rxvt's $COLORFGBG variable is set, use it to specify the assumed
501 * default colors. Note that rxvt (mis)uses bold colors, equating a bold
502 * color to that value plus 8. We'll only use the non-bold color for now -
503 * decide later if it is worth having default attributes as well.
505 if (getenv("COLORFGBG") != 0) {
506 const char *p = getenv("COLORFGBG");
507 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoding COLORFGBG %s", p));
508 p = extract_fgbg(p, &(sp->_default_fg));
509 p = extract_fgbg(p, &(sp->_default_bg));
510 if (*p) /* assume rxvt was compiled with xpm support */
511 extract_fgbg(p, &(sp->_default_bg));
512 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoded fg=%d, bg=%d",
513 sp->_default_fg, sp->_default_bg));
514 if (sp->_default_fg >= MaxColors) {
515 if (set_a_foreground != ABSENT_STRING
516 && !strcmp(set_a_foreground, "\033[3%p1%dm")) {
517 set_a_foreground = strdup("\033[3%?%p1%{8}%>%t9%e%p1%d%;m");
519 sp->_default_fg %= MaxColors;
522 if (sp->_default_bg >= MaxColors) {
523 if (set_a_background != ABSENT_STRING
524 && !strcmp(set_a_background, "\033[4%p1%dm")) {
525 set_a_background = strdup("\033[4%?%p1%{8}%>%t9%e%p1%d%;m");
527 sp->_default_bg %= MaxColors;
532 #endif /* NCURSES_EXT_FUNCS */
534 sp->_maxclick = DEFAULT_MAXCLICK;
535 sp->_mouse_event = no_mouse_event;
536 sp->_mouse_inline = no_mouse_inline;
537 sp->_mouse_parse = no_mouse_parse;
538 sp->_mouse_resume = no_mouse_resume;
539 sp->_mouse_wrap = no_mouse_wrap;
543 * If we've no magic cookie support, we suppress attributes that xmc would
544 * affect, i.e., the attributes that affect the rendition of a space.
546 sp->_ok_attributes = NCURSES_SP_NAME(termattrs) (NCURSES_SP_ARG);
547 if (NCURSES_SP_NAME(has_colors) (NCURSES_SP_ARG)) {
548 sp->_ok_attributes |= A_COLOR;
550 #ifdef USE_TERM_DRIVER
555 * If we have no magic-cookie support compiled-in, or if it is suppressed
556 * in the environment, reset the support-flag.
558 if (magic_cookie_glitch >= 0) {
559 if (getenv("NCURSES_NO_MAGIC_COOKIE") != 0) {
560 support_cookies = FALSE;
565 if (!support_cookies && magic_cookie_glitch >= 0) {
566 T(("will disable attributes to work w/o magic cookies"));
569 if (magic_cookie_glitch > 0) { /* tvi, wyse */
571 sp->_xmc_triggers = sp->_ok_attributes & XMC_CONFLICT;
574 * We "should" treat colors as an attribute. The wyse350 (and its
575 * clones) appear to be the only ones that have both colors and magic
579 sp->_xmc_triggers |= A_COLOR;
582 sp->_xmc_suppress = sp->_xmc_triggers & (chtype) ~(A_BOLD);
584 T(("magic cookie attributes %s", _traceattr(sp->_xmc_suppress)));
586 * Supporting line-drawing may be possible. But make the regular
587 * video attributes work first.
589 acs_chars = ABSENT_STRING;
590 ena_acs = ABSENT_STRING;
591 enter_alt_charset_mode = ABSENT_STRING;
592 exit_alt_charset_mode = ABSENT_STRING;
595 * To keep the cookie support simple, suppress all of the optimization
596 * hooks except for clear_screen and the cursor addressing.
598 if (support_cookies) {
599 clr_eol = ABSENT_STRING;
600 clr_eos = ABSENT_STRING;
601 set_attributes = ABSENT_STRING;
604 } else if (magic_cookie_glitch == 0) { /* hpterm */
608 * If magic cookies are not supported, cancel the strings that set
611 if (!support_cookies && magic_cookie_glitch >= 0) {
612 magic_cookie_glitch = ABSENT_NUMERIC;
613 set_attributes = ABSENT_STRING;
614 enter_blink_mode = ABSENT_STRING;
615 enter_bold_mode = ABSENT_STRING;
616 enter_dim_mode = ABSENT_STRING;
617 enter_reverse_mode = ABSENT_STRING;
618 enter_standout_mode = ABSENT_STRING;
619 enter_underline_mode = ABSENT_STRING;
622 /* initialize normal acs before wide, since we use mapping in the latter */
623 #if !USE_WIDEC_SUPPORT
624 if (_nc_unicode_locale() && _nc_locale_breaks_acs(sp->_term)) {
627 enter_alt_charset_mode = NULL;
628 exit_alt_charset_mode = NULL;
629 set_attributes = NULL;
634 NCURSES_SP_NAME(_nc_init_acs) (NCURSES_SP_ARG);
635 #if USE_WIDEC_SUPPORT
636 sp->_screen_unicode = _nc_unicode_locale();
644 sp->_screen_acs_fix = (sp->_screen_unicode
645 && _nc_locale_breaks_acs(sp->_term));
647 env = _nc_get_locale();
648 sp->_legacy_coding = ((env == 0)
650 || !strcmp(env, "POSIX"));
651 T(("legacy-coding %d", sp->_legacy_coding));
653 sp->_nc_sp_idcok = TRUE;
654 sp->_nc_sp_idlok = FALSE;
659 T(("creating newscr"));
660 NewScreen(sp) = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx slines, scolumns,
662 if (NewScreen(sp) == 0) {
665 T(("creating curscr"));
666 CurScreen(sp) = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx slines, scolumns,
668 if (CurScreen(sp) == 0) {
672 newscr = NewScreen(sp);
673 curscr = CurScreen(sp);
676 sp->_resize = NCURSES_SP_NAME(resizeterm);
677 sp->_ungetch = safe_ungetch;
680 NewScreen(sp)->_clear = TRUE;
681 CurScreen(sp)->_clear = FALSE;
684 * Get the current tty-modes. setupterm() may already have done this,
685 * unless we use the term-driver.
687 #ifndef USE_TERM_DRIVER
689 !memcmp(&cur_term->Ottyb, &null_TTY, sizeof(TTY)))
692 NCURSES_SP_NAME(def_shell_mode) (NCURSES_SP_ARG);
693 NCURSES_SP_NAME(def_prog_mode) (NCURSES_SP_ARG);
696 if (safe_ripoff_sp && safe_ripoff_sp != safe_ripoff_stack) {
699 for (rop = safe_ripoff_stack;
700 rop != safe_ripoff_sp && (rop - safe_ripoff_stack) < N_RIPS;
703 /* If we must simulate soft labels, grab off the line to be used.
704 We assume that we must simulate, if it is none of the standard
705 formats (4-4 or 3-2-3) for which there may be some hardware
707 if (rop->hook == _nc_slk_initialize) {
708 if (!TerminalOf(sp)) {
711 if (!(NumLabels <= 0 || !SLK_STDFMT(slk_format))) {
719 count = (rop->line < 0) ? -rop->line : rop->line;
720 T(("ripping off %i lines at %s", count,
725 w = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx
728 ? sp->_lines_avail - count
733 rop->hook(w, scolumns);
738 bottom_stolen += count;
740 sp->_topstolen = (NCURSES_SIZE_T) (sp->_topstolen + count);
742 sp->_lines_avail = (NCURSES_SIZE_T) (sp->_lines_avail - count);
745 /* reset the stack */
746 safe_ripoff_sp = safe_ripoff_stack;
749 T(("creating stdscr"));
750 assert((sp->_lines_avail + sp->_topstolen + bottom_stolen) == slines);
751 if ((StdScreen(sp) = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx
753 scolumns, 0, 0)) == 0) {
756 SET_LINES(sp->_lines_avail);
758 stdscr = StdScreen(sp);
760 sp->_prescreen = FALSE;
766 _nc_setupscreen(int slines GCC_UNUSED,
767 int scolumns GCC_UNUSED,
773 int rc = NCURSES_SP_NAME(_nc_setupscreen) (&sp,
786 * The internal implementation interprets line as the number of lines to rip
787 * off from the top or bottom.
790 NCURSES_SP_NAME(_nc_ripoffline) (NCURSES_SP_DCLx
792 int (*init) (WINDOW *, int))
798 T((T_CALLED("ripoffline(%p,%d,%s)"),
799 (void *) SP_PARM, line,
800 TR_FUNC_ARG(0, init)));
803 if (SP_PARM != 0 && SP_PARM->_prescreen)
809 if (safe_ripoff_sp == 0) {
810 safe_ripoff_sp = safe_ripoff_stack;
812 if (safe_ripoff_sp < safe_ripoff_stack + N_RIPS) {
813 safe_ripoff_sp->line = line;
814 safe_ripoff_sp->hook = init;
816 T(("ripped-off %d:%d chunks",
817 (int) (safe_ripoff_sp - safe_ripoff_stack), N_RIPS));
828 _nc_ripoffline(int line, int (*init) (WINDOW *, int))
833 _nc_lock_global(prescreen);
835 rc = NCURSES_SP_NAME(_nc_ripoffline) (CURRENT_SCREEN_PRE, line, init);
836 _nc_unlock_global(prescreen);
843 NCURSES_SP_NAME(ripoffline) (NCURSES_SP_DCLx
845 int (*init) (WINDOW *, int))
848 return NCURSES_SP_NAME(_nc_ripoffline) (NCURSES_SP_ARGx
855 ripoffline(int line, int (*init) (WINDOW *, int))
860 _nc_lock_global(prescreen);
862 rc = NCURSES_SP_NAME(ripoffline) (CURRENT_SCREEN_PRE, line, init);
863 _nc_unlock_global(prescreen);