1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
39 ** The routine set_term().
43 #include <curses.priv.h>
45 #include <term.h> /* cur_term */
48 MODULE_ID("$Id: lib_set_term.c,v 1.118 2009/02/15 00:39:46 tom Exp $")
50 NCURSES_EXPORT(SCREEN *)
51 set_term(SCREEN *screenp)
56 T((T_CALLED("set_term(%p)"), screenp));
58 _nc_lock_global(curses);
61 _nc_set_screen(screenp);
65 set_curterm(newSP->_term);
67 curscr = newSP->_curscr;
68 newscr = newSP->_newscr;
69 stdscr = newSP->_stdscr;
70 COLORS = newSP->_color_count;
71 COLOR_PAIRS = newSP->_pair_count;
84 _nc_unlock_global(curses);
86 T((T_RETURN("%p"), oldSP));
91 _nc_free_keytry(TRIES * kt)
94 _nc_free_keytry(kt->child);
95 _nc_free_keytry(kt->sibling);
101 delink_screen(SCREEN *sp)
107 for (each_screen(temp)) {
110 last = sp->_next_screen;
112 _nc_screen_chain = sp->_next_screen;
122 * Free the storage associated with the given SCREEN sp.
125 delscreen(SCREEN *sp)
129 T((T_CALLED("delscreen(%p)"), sp));
131 _nc_lock_global(curses);
132 if (delink_screen(sp)) {
134 (void) _nc_freewin(sp->_curscr);
135 (void) _nc_freewin(sp->_newscr);
136 (void) _nc_freewin(sp->_stdscr);
139 if (sp->_slk->ent != 0) {
140 for (i = 0; i < sp->_slk->labcnt; ++i) {
141 FreeIfNeeded(sp->_slk->ent[i].ent_text);
142 FreeIfNeeded(sp->_slk->ent[i].form_text);
150 _nc_free_keytry(sp->_keytry);
153 _nc_free_keytry(sp->_key_ok);
156 FreeIfNeeded(sp->_current_attr);
158 FreeIfNeeded(sp->_color_table);
159 FreeIfNeeded(sp->_color_pairs);
161 FreeIfNeeded(sp->oldhash);
162 FreeIfNeeded(sp->newhash);
163 FreeIfNeeded(sp->hashtab);
165 FreeIfNeeded(sp->_acs_map);
166 FreeIfNeeded(sp->_screen_acs_map);
169 * If the associated output stream has been closed, we can discard the
170 * set-buffer. Limit the error check to EBADF, since fflush may fail
171 * for other reasons than trying to operate upon a closed stream.
175 && fflush(sp->_ofp) != 0
180 del_curterm(sp->_term);
184 * If this was the current screen, reset everything that the
185 * application might try to use (except cur_term, which may have
186 * multiple references in different screens).
199 _nc_unlock_global(curses);
205 no_mouse_event(SCREEN *sp GCC_UNUSED)
211 no_mouse_inline(SCREEN *sp GCC_UNUSED)
217 no_mouse_parse(SCREEN *sp GCC_UNUSED, int code GCC_UNUSED)
223 no_mouse_resume(SCREEN *sp GCC_UNUSED)
228 no_mouse_wrap(SCREEN *sp GCC_UNUSED)
232 #if NCURSES_EXT_FUNCS && USE_COLORFGBG
234 extract_fgbg(char *src, int *result)
237 long value = strtol(src, &dst, 0);
241 } else if (value >= 0) {
244 while (*dst != 0 && *dst != ';')
252 /* OS-independent screen initializations */
254 _nc_setupscreen(int slines GCC_UNUSED,
255 int scolumns GCC_UNUSED,
261 int bottom_stolen = 0;
262 bool support_cookies = USE_XMC_SUPPORT;
265 T((T_CALLED("_nc_setupscreen(%d, %d, %p, %d, %d)"),
266 slines, scolumns, output, filtered, slk_format));
268 assert(SP == 0); /* has been reset in newterm() ! */
269 if (!_nc_alloc_screen()
270 || ((SP->_acs_map = typeCalloc(chtype, ACS_LEN)) == 0)
271 || ((SP->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == 0)) {
275 T(("created SP %p", SP));
276 SP->_next_screen = _nc_screen_chain;
277 _nc_screen_chain = SP;
279 if ((SP->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0)
283 * We should always check the screensize, just in case.
285 _nc_get_screensize(SP, &slines, &scolumns);
288 T((T_CREATE("screen %s %dx%d"), termname(), LINES, COLS));
290 SP->_filtered = filtered;
292 /* implement filter mode */
297 cursor_down = parm_down_cursor = 0;
299 cursor_up = parm_up_cursor = 0;
302 cursor_home = carriage_return;
303 T(("filter screensize %dx%d", LINES, COLS));
306 T(("setting output mode to binary"));
308 setmode(output, O_BINARY);
310 _nc_set_buffer(output, TRUE);
311 SP->_term = cur_term;
313 SP->_lines_avail = slines;
314 SP->_columns = scolumns;
324 SP->_cursor = -1; /* cannot know real cursor shape */
328 #if NCURSES_EXT_FUNCS
329 SP->_default_color = FALSE;
330 SP->_has_sgr_39_49 = FALSE;
333 * Set our assumption of the terminal's default foreground and background
334 * colors. The curs_color man-page states that we can assume that the
335 * background is black. The origin of this assumption appears to be
336 * terminals that displayed colored text, but no colored backgrounds, e.g.,
337 * the first colored terminals around 1980. More recent ones with better
338 * technology can display not only colored backgrounds, but all
339 * combinations. So a terminal might be something other than "white" on
340 * black (green/black looks monochrome too), but black on white or even
343 * White-on-black is the simplest thing to use for monochrome. Almost
344 * all applications that use color paint both text and background, so
345 * the distinction is moot. But a few do not - which is why we leave this
346 * configurable (a better solution is to use assume_default_colors() for
347 * the rare applications that do require that sort of appearance, since
348 * is appears that more users expect to be able to make a white-on-black
349 * or black-on-white display under control of the application than not).
351 #ifdef USE_ASSUMED_COLOR
352 SP->_default_fg = COLOR_WHITE;
353 SP->_default_bg = COLOR_BLACK;
355 SP->_default_fg = C_MASK;
356 SP->_default_bg = C_MASK;
360 * Allow those assumed/default color assumptions to be overridden at
363 if ((env = getenv("NCURSES_ASSUMED_COLORS")) != 0) {
366 int count = sscanf(env, "%d%c%d%c", &fg, &sep1, &bg, &sep2);
368 SP->_default_fg = (fg >= 0 && fg < max_colors) ? fg : C_MASK;
370 SP->_default_bg = (bg >= 0 && bg < max_colors) ? bg : C_MASK;
372 TR(TRACE_CHARPUT | TRACE_MOVE,
373 ("from environment assumed fg=%d, bg=%d",
380 * If rxvt's $COLORFGBG variable is set, use it to specify the assumed
381 * default colors. Note that rxvt (mis)uses bold colors, equating a bold
382 * color to that value plus 8. We'll only use the non-bold color for now -
383 * decide later if it is worth having default attributes as well.
385 if (getenv("COLORFGBG") != 0) {
386 char *p = getenv("COLORFGBG");
387 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoding COLORFGBG %s", p));
388 p = extract_fgbg(p, &(SP->_default_fg));
389 p = extract_fgbg(p, &(SP->_default_bg));
390 if (*p) /* assume rxvt was compiled with xpm support */
391 p = extract_fgbg(p, &(SP->_default_bg));
392 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoded fg=%d, bg=%d",
393 SP->_default_fg, SP->_default_bg));
394 if (SP->_default_fg >= max_colors) {
395 if (set_a_foreground != ABSENT_STRING
396 && !strcmp(set_a_foreground, "\033[3%p1%dm")) {
397 set_a_foreground = "\033[3%?%p1%{8}%>%t9%e%p1%d%;m";
399 SP->_default_fg %= max_colors;
402 if (SP->_default_bg >= max_colors) {
403 if (set_a_background != ABSENT_STRING
404 && !strcmp(set_a_background, "\033[4%p1%dm")) {
405 set_a_background = "\033[4%?%p1%{8}%>%t9%e%p1%d%;m";
407 SP->_default_bg %= max_colors;
412 #endif /* NCURSES_EXT_FUNCS */
414 SP->_maxclick = DEFAULT_MAXCLICK;
415 SP->_mouse_event = no_mouse_event;
416 SP->_mouse_inline = no_mouse_inline;
417 SP->_mouse_parse = no_mouse_parse;
418 SP->_mouse_resume = no_mouse_resume;
419 SP->_mouse_wrap = no_mouse_wrap;
423 * If we've no magic cookie support, we suppress attributes that xmc would
424 * affect, i.e., the attributes that affect the rendition of a space.
426 SP->_ok_attributes = termattrs();
428 SP->_ok_attributes |= A_COLOR;
432 * If we have no magic-cookie support compiled-in, or if it is suppressed
433 * in the environment, reset the support-flag.
435 if (magic_cookie_glitch >= 0) {
436 if (getenv("NCURSES_NO_MAGIC_COOKIE") != 0) {
437 support_cookies = FALSE;
442 if (!support_cookies && magic_cookie_glitch >= 0) {
443 T(("will disable attributes to work w/o magic cookies"));
446 if (magic_cookie_glitch > 0) { /* tvi, wyse */
448 SP->_xmc_triggers = SP->_ok_attributes & (
460 * We "should" treat colors as an attribute. The wyse350 (and its
461 * clones) appear to be the only ones that have both colors and magic
465 SP->_xmc_triggers |= A_COLOR;
468 SP->_xmc_suppress = SP->_xmc_triggers & (chtype) ~(A_BOLD);
470 T(("magic cookie attributes %s", _traceattr(SP->_xmc_suppress)));
472 * Supporting line-drawing may be possible. But make the regular
473 * video attributes work first.
475 acs_chars = ABSENT_STRING;
476 ena_acs = ABSENT_STRING;
477 enter_alt_charset_mode = ABSENT_STRING;
478 exit_alt_charset_mode = ABSENT_STRING;
481 * To keep the cookie support simple, suppress all of the optimization
482 * hooks except for clear_screen and the cursor addressing.
484 if (support_cookies) {
485 clr_eol = ABSENT_STRING;
486 clr_eos = ABSENT_STRING;
487 set_attributes = ABSENT_STRING;
490 } else if (magic_cookie_glitch == 0) { /* hpterm */
494 * If magic cookies are not supported, cancel the strings that set
497 if (!support_cookies && magic_cookie_glitch >= 0) {
498 magic_cookie_glitch = ABSENT_NUMERIC;
499 set_attributes = ABSENT_STRING;
500 enter_blink_mode = ABSENT_STRING;
501 enter_bold_mode = ABSENT_STRING;
502 enter_dim_mode = ABSENT_STRING;
503 enter_reverse_mode = ABSENT_STRING;
504 enter_standout_mode = ABSENT_STRING;
505 enter_underline_mode = ABSENT_STRING;
508 /* initialize normal acs before wide, since we use mapping in the latter */
509 #if !USE_WIDEC_SUPPORT
510 if (_nc_unicode_locale() && _nc_locale_breaks_acs(cur_term)) {
513 enter_alt_charset_mode = NULL;
514 exit_alt_charset_mode = NULL;
515 set_attributes = NULL;
519 #if USE_WIDEC_SUPPORT
522 SP->_screen_acs_fix = (_nc_unicode_locale()
523 && _nc_locale_breaks_acs(cur_term));
525 env = _nc_get_locale();
526 SP->_legacy_coding = ((env == 0)
528 || !strcmp(env, "POSIX"));
529 T(("legacy-coding %d", SP->_legacy_coding));
537 T(("creating newscr"));
538 if ((SP->_newscr = newwin(slines, scolumns, 0, 0)) == 0)
541 T(("creating curscr"));
542 if ((SP->_curscr = newwin(slines, scolumns, 0, 0)) == 0)
546 newscr = SP->_newscr;
547 curscr = SP->_curscr;
550 SP->_resize = resizeterm;
553 newscr->_clear = TRUE;
554 curscr->_clear = FALSE;
559 for (rop = ripoff_stack;
560 rop != ripoff_sp && (rop - ripoff_stack) < N_RIPS;
563 /* If we must simulate soft labels, grab off the line to be used.
564 We assume that we must simulate, if it is none of the standard
565 formats (4-4 or 3-2-3) for which there may be some hardware
567 if (rop->hook == _nc_slk_initialize)
568 if (!(num_labels <= 0 || !SLK_STDFMT(slk_format)))
574 count = (rop->line < 0) ? -rop->line : rop->line;
575 T(("ripping off %i lines at %s", count,
580 w = newwin(count, scolumns,
582 ? SP->_lines_avail - count
587 rop->hook(w, scolumns);
592 bottom_stolen += count;
594 SP->_topstolen += count;
595 SP->_lines_avail -= count;
598 /* reset the stack */
599 ripoff_sp = ripoff_stack;
601 T(("creating stdscr"));
602 assert((SP->_lines_avail + SP->_topstolen + bottom_stolen) == slines);
603 if ((SP->_stdscr = newwin(SP->_lines_avail, scolumns, 0, 0)) == 0)
606 SET_LINES(SP->_lines_avail);
608 stdscr = SP->_stdscr;
615 * The internal implementation interprets line as the number of lines to rip
616 * off from the top or bottom.
619 _nc_ripoffline(int line, int (*init) (WINDOW *, int))
621 T((T_CALLED("_nc_ripoffline(%d, %p)"), line, init));
626 ripoff_sp = ripoff_stack;
627 if (ripoff_sp >= ripoff_stack + N_RIPS)
630 ripoff_sp->line = line;
631 ripoff_sp->hook = init;
639 NCURSES_SP_NAME(ripoffline) (NCURSES_SP_DCLx
641 int (*init) (WINDOW *, int))
644 T((T_CALLED("ripoffline(%d,%p)"), line, init));
649 returnCode(_nc_ripoffline((line < 0) ? -1 : 1, init));
654 ripoffline(int line, int (*init) (WINDOW *, int))
656 return NCURSES_SP_NAME(ripoffline) (CURRENT_SCREEN, line, init);