1 /****************************************************************************
2 * Copyright (c) 1998-2007,2008 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 ****************************************************************************/
38 ** The routine set_term().
42 #include <curses.priv.h>
44 #include <term.h> /* cur_term */
47 MODULE_ID("$Id: lib_set_term.c,v 1.117 2008/08/04 18:11:12 tom Exp $")
49 NCURSES_EXPORT(SCREEN *)
50 set_term(SCREEN *screenp)
55 T((T_CALLED("set_term(%p)"), screenp));
57 _nc_lock_global(curses);
60 _nc_set_screen(screenp);
64 set_curterm(newSP->_term);
66 curscr = newSP->_curscr;
67 newscr = newSP->_newscr;
68 stdscr = newSP->_stdscr;
69 COLORS = newSP->_color_count;
70 COLOR_PAIRS = newSP->_pair_count;
83 _nc_unlock_global(curses);
85 T((T_RETURN("%p"), oldSP));
90 _nc_free_keytry(TRIES * kt)
93 _nc_free_keytry(kt->child);
94 _nc_free_keytry(kt->sibling);
100 delink_screen(SCREEN *sp)
106 for (each_screen(temp)) {
109 last = sp->_next_screen;
111 _nc_screen_chain = sp->_next_screen;
121 * Free the storage associated with the given SCREEN sp.
124 delscreen(SCREEN *sp)
128 T((T_CALLED("delscreen(%p)"), sp));
130 _nc_lock_global(curses);
131 if (delink_screen(sp)) {
133 (void) _nc_freewin(sp->_curscr);
134 (void) _nc_freewin(sp->_newscr);
135 (void) _nc_freewin(sp->_stdscr);
138 if (sp->_slk->ent != 0) {
139 for (i = 0; i < sp->_slk->labcnt; ++i) {
140 FreeIfNeeded(sp->_slk->ent[i].ent_text);
141 FreeIfNeeded(sp->_slk->ent[i].form_text);
149 _nc_free_keytry(sp->_keytry);
152 _nc_free_keytry(sp->_key_ok);
155 FreeIfNeeded(sp->_current_attr);
157 FreeIfNeeded(sp->_color_table);
158 FreeIfNeeded(sp->_color_pairs);
160 FreeIfNeeded(sp->oldhash);
161 FreeIfNeeded(sp->newhash);
162 FreeIfNeeded(sp->hashtab);
164 FreeIfNeeded(sp->_acs_map);
165 FreeIfNeeded(sp->_screen_acs_map);
168 * If the associated output stream has been closed, we can discard the
169 * set-buffer. Limit the error check to EBADF, since fflush may fail
170 * for other reasons than trying to operate upon a closed stream.
174 && fflush(sp->_ofp) != 0
179 del_curterm(sp->_term);
183 * If this was the current screen, reset everything that the
184 * application might try to use (except cur_term, which may have
185 * multiple references in different screens).
198 _nc_unlock_global(curses);
204 no_mouse_event(SCREEN *sp GCC_UNUSED)
210 no_mouse_inline(SCREEN *sp GCC_UNUSED)
216 no_mouse_parse(SCREEN *sp GCC_UNUSED, int code GCC_UNUSED)
222 no_mouse_resume(SCREEN *sp GCC_UNUSED)
227 no_mouse_wrap(SCREEN *sp GCC_UNUSED)
231 #if NCURSES_EXT_FUNCS && USE_COLORFGBG
233 extract_fgbg(char *src, int *result)
236 long value = strtol(src, &dst, 0);
240 } else if (value >= 0) {
243 while (*dst != 0 && *dst != ';')
251 /* OS-independent screen initializations */
253 _nc_setupscreen(int slines GCC_UNUSED,
254 int scolumns GCC_UNUSED,
260 int bottom_stolen = 0;
261 bool support_cookies = USE_XMC_SUPPORT;
264 T((T_CALLED("_nc_setupscreen(%d, %d, %p, %d, %d)"),
265 slines, scolumns, output, filtered, slk_format));
267 assert(SP == 0); /* has been reset in newterm() ! */
268 if (!_nc_alloc_screen()
269 || ((SP->_acs_map = typeCalloc(chtype, ACS_LEN)) == 0)
270 || ((SP->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == 0)) {
274 T(("created SP %p", SP));
275 SP->_next_screen = _nc_screen_chain;
276 _nc_screen_chain = SP;
278 if ((SP->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0)
282 * We should always check the screensize, just in case.
284 _nc_get_screensize(SP, &slines, &scolumns);
287 T((T_CREATE("screen %s %dx%d"), termname(), LINES, COLS));
289 SP->_filtered = filtered;
291 /* implement filter mode */
296 cursor_down = parm_down_cursor = 0;
298 cursor_up = parm_up_cursor = 0;
301 cursor_home = carriage_return;
302 T(("filter screensize %dx%d", LINES, COLS));
305 T(("setting output mode to binary"));
307 setmode(output, O_BINARY);
309 _nc_set_buffer(output, TRUE);
310 SP->_term = cur_term;
312 SP->_lines_avail = slines;
313 SP->_columns = scolumns;
323 SP->_cursor = -1; /* cannot know real cursor shape */
327 #if NCURSES_EXT_FUNCS
328 SP->_default_color = FALSE;
329 SP->_has_sgr_39_49 = FALSE;
332 * Set our assumption of the terminal's default foreground and background
333 * colors. The curs_color man-page states that we can assume that the
334 * background is black. The origin of this assumption appears to be
335 * terminals that displayed colored text, but no colored backgrounds, e.g.,
336 * the first colored terminals around 1980. More recent ones with better
337 * technology can display not only colored backgrounds, but all
338 * combinations. So a terminal might be something other than "white" on
339 * black (green/black looks monochrome too), but black on white or even
342 * White-on-black is the simplest thing to use for monochrome. Almost
343 * all applications that use color paint both text and background, so
344 * the distinction is moot. But a few do not - which is why we leave this
345 * configurable (a better solution is to use assume_default_colors() for
346 * the rare applications that do require that sort of appearance, since
347 * is appears that more users expect to be able to make a white-on-black
348 * or black-on-white display under control of the application than not).
350 #ifdef USE_ASSUMED_COLOR
351 SP->_default_fg = COLOR_WHITE;
352 SP->_default_bg = COLOR_BLACK;
354 SP->_default_fg = C_MASK;
355 SP->_default_bg = C_MASK;
359 * Allow those assumed/default color assumptions to be overridden at
362 if ((env = getenv("NCURSES_ASSUMED_COLORS")) != 0) {
365 int count = sscanf(env, "%d%c%d%c", &fg, &sep1, &bg, &sep2);
367 SP->_default_fg = (fg >= 0 && fg < max_colors) ? fg : C_MASK;
369 SP->_default_bg = (bg >= 0 && bg < max_colors) ? bg : C_MASK;
371 TR(TRACE_CHARPUT | TRACE_MOVE,
372 ("from environment assumed fg=%d, bg=%d",
379 * If rxvt's $COLORFGBG variable is set, use it to specify the assumed
380 * default colors. Note that rxvt (mis)uses bold colors, equating a bold
381 * color to that value plus 8. We'll only use the non-bold color for now -
382 * decide later if it is worth having default attributes as well.
384 if (getenv("COLORFGBG") != 0) {
385 char *p = getenv("COLORFGBG");
386 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoding COLORFGBG %s", p));
387 p = extract_fgbg(p, &(SP->_default_fg));
388 p = extract_fgbg(p, &(SP->_default_bg));
389 if (*p) /* assume rxvt was compiled with xpm support */
390 p = extract_fgbg(p, &(SP->_default_bg));
391 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoded fg=%d, bg=%d",
392 SP->_default_fg, SP->_default_bg));
393 if (SP->_default_fg >= max_colors) {
394 if (set_a_foreground != ABSENT_STRING
395 && !strcmp(set_a_foreground, "\033[3%p1%dm")) {
396 set_a_foreground = "\033[3%?%p1%{8}%>%t9%e%p1%d%;m";
398 SP->_default_fg %= max_colors;
401 if (SP->_default_bg >= max_colors) {
402 if (set_a_background != ABSENT_STRING
403 && !strcmp(set_a_background, "\033[4%p1%dm")) {
404 set_a_background = "\033[4%?%p1%{8}%>%t9%e%p1%d%;m";
406 SP->_default_bg %= max_colors;
411 #endif /* NCURSES_EXT_FUNCS */
413 SP->_maxclick = DEFAULT_MAXCLICK;
414 SP->_mouse_event = no_mouse_event;
415 SP->_mouse_inline = no_mouse_inline;
416 SP->_mouse_parse = no_mouse_parse;
417 SP->_mouse_resume = no_mouse_resume;
418 SP->_mouse_wrap = no_mouse_wrap;
422 * If we've no magic cookie support, we suppress attributes that xmc would
423 * affect, i.e., the attributes that affect the rendition of a space.
425 SP->_ok_attributes = termattrs();
427 SP->_ok_attributes |= A_COLOR;
431 * If we have no magic-cookie support compiled-in, or if it is suppressed
432 * in the environment, reset the support-flag.
434 if (magic_cookie_glitch >= 0) {
435 if (getenv("NCURSES_NO_MAGIC_COOKIE") != 0) {
436 support_cookies = FALSE;
441 if (!support_cookies && magic_cookie_glitch >= 0) {
442 T(("will disable attributes to work w/o magic cookies"));
445 if (magic_cookie_glitch > 0) { /* tvi, wyse */
447 SP->_xmc_triggers = SP->_ok_attributes & (
459 * We "should" treat colors as an attribute. The wyse350 (and its
460 * clones) appear to be the only ones that have both colors and magic
464 SP->_xmc_triggers |= A_COLOR;
467 SP->_xmc_suppress = SP->_xmc_triggers & (chtype) ~(A_BOLD);
469 T(("magic cookie attributes %s", _traceattr(SP->_xmc_suppress)));
471 * Supporting line-drawing may be possible. But make the regular
472 * video attributes work first.
474 acs_chars = ABSENT_STRING;
475 ena_acs = ABSENT_STRING;
476 enter_alt_charset_mode = ABSENT_STRING;
477 exit_alt_charset_mode = ABSENT_STRING;
480 * To keep the cookie support simple, suppress all of the optimization
481 * hooks except for clear_screen and the cursor addressing.
483 if (support_cookies) {
484 clr_eol = ABSENT_STRING;
485 clr_eos = ABSENT_STRING;
486 set_attributes = ABSENT_STRING;
489 } else if (magic_cookie_glitch == 0) { /* hpterm */
493 * If magic cookies are not supported, cancel the strings that set
496 if (!support_cookies && magic_cookie_glitch >= 0) {
497 magic_cookie_glitch = ABSENT_NUMERIC;
498 set_attributes = ABSENT_STRING;
499 enter_blink_mode = ABSENT_STRING;
500 enter_bold_mode = ABSENT_STRING;
501 enter_dim_mode = ABSENT_STRING;
502 enter_reverse_mode = ABSENT_STRING;
503 enter_standout_mode = ABSENT_STRING;
504 enter_underline_mode = ABSENT_STRING;
507 /* initialize normal acs before wide, since we use mapping in the latter */
508 #if !USE_WIDEC_SUPPORT
509 if (_nc_unicode_locale() && _nc_locale_breaks_acs(cur_term)) {
512 enter_alt_charset_mode = NULL;
513 exit_alt_charset_mode = NULL;
514 set_attributes = NULL;
518 #if USE_WIDEC_SUPPORT
521 SP->_screen_acs_fix = (_nc_unicode_locale()
522 && _nc_locale_breaks_acs(cur_term));
524 env = _nc_get_locale();
525 SP->_legacy_coding = ((env == 0)
527 || !strcmp(env, "POSIX"));
528 T(("legacy-coding %d", SP->_legacy_coding));
536 T(("creating newscr"));
537 if ((SP->_newscr = newwin(slines, scolumns, 0, 0)) == 0)
540 T(("creating curscr"));
541 if ((SP->_curscr = newwin(slines, scolumns, 0, 0)) == 0)
545 newscr = SP->_newscr;
546 curscr = SP->_curscr;
549 SP->_resize = resizeterm;
552 newscr->_clear = TRUE;
553 curscr->_clear = FALSE;
558 for (rop = ripoff_stack;
559 rop != ripoff_sp && (rop - ripoff_stack) < N_RIPS;
562 /* If we must simulate soft labels, grab off the line to be used.
563 We assume that we must simulate, if it is none of the standard
564 formats (4-4 or 3-2-3) for which there may be some hardware
566 if (rop->hook == _nc_slk_initialize)
567 if (!(num_labels <= 0 || !SLK_STDFMT(slk_format)))
573 count = (rop->line < 0) ? -rop->line : rop->line;
574 T(("ripping off %i lines at %s", count,
579 w = newwin(count, scolumns,
581 ? SP->_lines_avail - count
586 rop->hook(w, scolumns);
591 bottom_stolen += count;
593 SP->_topstolen += count;
594 SP->_lines_avail -= count;
597 /* reset the stack */
598 ripoff_sp = ripoff_stack;
600 T(("creating stdscr"));
601 assert((SP->_lines_avail + SP->_topstolen + bottom_stolen) == slines);
602 if ((SP->_stdscr = newwin(SP->_lines_avail, scolumns, 0, 0)) == 0)
605 SET_LINES(SP->_lines_avail);
607 stdscr = SP->_stdscr;
614 * The internal implementation interprets line as the number of lines to rip
615 * off from the top or bottom.
618 _nc_ripoffline(int line, int (*init) (WINDOW *, int))
620 T((T_CALLED("_nc_ripoffline(%d, %p)"), line, init));
625 ripoff_sp = ripoff_stack;
626 if (ripoff_sp >= ripoff_stack + N_RIPS)
629 ripoff_sp->line = line;
630 ripoff_sp->hook = init;
638 ripoffline(int line, int (*init) (WINDOW *, int))
641 T((T_CALLED("ripoffline(%d,%p)"), line, init));
646 returnCode(_nc_ripoffline((line < 0) ? -1 : 1, init));