1 /****************************************************************************
2 * Copyright (c) 1998-2006,2007 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.98 2007/05/12 19:37:04 tom Exp $")
49 NCURSES_EXPORT(SCREEN *)
50 set_term(SCREEN *screenp)
54 T((T_CALLED("set_term(%p)"), screenp));
57 _nc_set_screen(screenp);
59 set_curterm(SP->_term);
64 COLORS = SP->_color_count;
65 COLOR_PAIRS = SP->_pair_count;
68 T((T_RETURN("%p"), oldSP));
73 _nc_free_keytry(TRIES * kt)
76 _nc_free_keytry(kt->child);
77 _nc_free_keytry(kt->sibling);
83 * Free the storage associated with the given SCREEN sp.
88 SCREEN **scan = &_nc_screen_chain;
91 T((T_CALLED("delscreen(%p)"), sp));
95 *scan = sp->_next_screen;
98 scan = &(*scan)->_next_screen;
101 (void) _nc_freewin(sp->_curscr);
102 (void) _nc_freewin(sp->_newscr);
103 (void) _nc_freewin(sp->_stdscr);
106 if (sp->_slk->ent != 0) {
107 for (i = 0; i < sp->_slk->labcnt; ++i) {
108 FreeIfNeeded(sp->_slk->ent[i].ent_text);
109 FreeIfNeeded(sp->_slk->ent[i].form_text);
117 _nc_free_keytry(sp->_keytry);
120 _nc_free_keytry(sp->_key_ok);
123 FreeIfNeeded(sp->_current_attr);
125 FreeIfNeeded(sp->_color_table);
126 FreeIfNeeded(sp->_color_pairs);
128 FreeIfNeeded(sp->oldhash);
129 FreeIfNeeded(sp->newhash);
130 FreeIfNeeded(sp->hashtab);
132 FreeIfNeeded(sp->_acs_map);
133 FreeIfNeeded(sp->_screen_acs_map);
135 del_curterm(sp->_term);
138 * If the associated output stream has been closed, we can discard the
139 * set-buffer. Limit the error check to EBADF, since fflush may fail
140 * for other reasons than trying to operate upon a closed stream.
144 && fflush(sp->_ofp) != 0
152 * If this was the current screen, reset everything that the
153 * application might try to use (except cur_term, which may have
154 * multiple references in different screens).
170 no_mouse_event(SCREEN *sp GCC_UNUSED)
176 no_mouse_inline(SCREEN *sp GCC_UNUSED)
182 no_mouse_parse(int code GCC_UNUSED)
188 no_mouse_resume(SCREEN *sp GCC_UNUSED)
193 no_mouse_wrap(SCREEN *sp GCC_UNUSED)
197 #if NCURSES_EXT_FUNCS && USE_COLORFGBG
199 extract_fgbg(char *src, int *result)
202 long value = strtol(src, &dst, 0);
206 } else if (value >= 0) {
209 while (*dst != 0 && *dst != ';')
217 #define ripoff_sp _nc_prescreen.rsp
218 #define ripoff_stack _nc_prescreen.rippedoff
220 /* OS-independent screen initializations */
222 _nc_setupscreen(int slines GCC_UNUSED,
223 int scolumns GCC_UNUSED,
228 int bottom_stolen = 0;
229 bool support_cookies = USE_XMC_SUPPORT;
232 T((T_CALLED("_nc_setupscreen(%d, %d, %p, %d, %d)"),
233 slines, scolumns, output, filtered, slk_format));
235 assert(SP == 0); /* has been reset in newterm() ! */
236 if (!_nc_alloc_screen()
237 || ((SP->_acs_map = typeCalloc(chtype, ACS_LEN)) == 0)
238 || ((SP->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == 0)) {
242 T(("created SP %p", SP));
243 SP->_next_screen = _nc_screen_chain;
244 _nc_screen_chain = SP;
246 if ((SP->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0)
250 * We should always check the screensize, just in case.
252 _nc_get_screensize(&slines, &scolumns);
255 T((T_CREATE("screen %s %dx%d"), termname(), LINES, COLS));
257 SP->_filtered = filtered;
259 /* implement filter mode */
264 cursor_down = parm_down_cursor = 0;
266 cursor_up = parm_up_cursor = 0;
269 cursor_home = carriage_return;
270 T(("filter screensize %dx%d", LINES, COLS));
273 T(("setting output mode to binary"));
275 setmode(output, O_BINARY);
277 _nc_set_buffer(output, TRUE);
278 SP->_term = cur_term;
280 SP->_lines_avail = slines;
281 SP->_columns = scolumns;
291 SP->_cursor = -1; /* cannot know real cursor shape */
293 #if NCURSES_NO_PADDING
294 SP->_no_padding = getenv("NCURSES_NO_PADDING") != 0;
295 TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
296 SP->_no_padding ? " not" : ""));
299 #if NCURSES_EXT_FUNCS
300 SP->_default_color = FALSE;
301 SP->_has_sgr_39_49 = FALSE;
304 * Set our assumption of the terminal's default foreground and background
305 * colors. The curs_color man-page states that we can assume that the
306 * background is black. The origin of this assumption appears to be
307 * terminals that displayed colored text, but no colored backgrounds, e.g.,
308 * the first colored terminals around 1980. More recent ones with better
309 * technology can display not only colored backgrounds, but all
310 * combinations. So a terminal might be something other than "white" on
311 * black (green/black looks monochrome too), but black on white or even
314 * White-on-black is the simplest thing to use for monochrome. Almost
315 * all applications that use color paint both text and background, so
316 * the distinction is moot. But a few do not - which is why we leave this
317 * configurable (a better solution is to use assume_default_colors() for
318 * the rare applications that do require that sort of appearance, since
319 * is appears that more users expect to be able to make a white-on-black
320 * or black-on-white display under control of the application than not).
322 #ifdef USE_ASSUMED_COLOR
323 SP->_default_fg = COLOR_WHITE;
324 SP->_default_bg = COLOR_BLACK;
326 SP->_default_fg = C_MASK;
327 SP->_default_bg = C_MASK;
331 * Allow those assumed/default color assumptions to be overridden at
334 if (getenv("NCURSES_ASSUMED_COLORS") != 0) {
335 char *p = getenv("NCURSES_ASSUMED_COLORS");
338 int count = sscanf(p, "%d%c%d%c", &fg, &sep1, &bg, &sep2);
340 SP->_default_fg = (fg >= 0 && fg < max_colors) ? fg : C_MASK;
342 SP->_default_bg = (bg >= 0 && bg < max_colors) ? bg : C_MASK;
344 TR(TRACE_CHARPUT | TRACE_MOVE,
345 ("from environment assumed fg=%d, bg=%d",
352 * If rxvt's $COLORFGBG variable is set, use it to specify the assumed
353 * default colors. Note that rxvt (mis)uses bold colors, equating a bold
354 * color to that value plus 8. We'll only use the non-bold color for now -
355 * decide later if it is worth having default attributes as well.
357 if (getenv("COLORFGBG") != 0) {
358 char *p = getenv("COLORFGBG");
359 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoding COLORFGBG %s", p));
360 p = extract_fgbg(p, &(SP->_default_fg));
361 p = extract_fgbg(p, &(SP->_default_bg));
362 if (*p) /* assume rxvt was compiled with xpm support */
363 p = extract_fgbg(p, &(SP->_default_bg));
364 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoded fg=%d, bg=%d",
365 SP->_default_fg, SP->_default_bg));
366 if (SP->_default_fg >= max_colors) {
367 if (set_a_foreground != ABSENT_STRING
368 && !strcmp(set_a_foreground, "\033[3%p1%dm")) {
369 set_a_foreground = "\033[3%?%p1%{8}%>%t9%e%p1%d%;m";
371 SP->_default_fg %= max_colors;
374 if (SP->_default_bg >= max_colors) {
375 if (set_a_background != ABSENT_STRING
376 && !strcmp(set_a_background, "\033[4%p1%dm")) {
377 set_a_background = "\033[4%?%p1%{8}%>%t9%e%p1%d%;m";
379 SP->_default_bg %= max_colors;
384 #endif /* NCURSES_EXT_FUNCS */
386 SP->_maxclick = DEFAULT_MAXCLICK;
387 SP->_mouse_event = no_mouse_event;
388 SP->_mouse_inline = no_mouse_inline;
389 SP->_mouse_parse = no_mouse_parse;
390 SP->_mouse_resume = no_mouse_resume;
391 SP->_mouse_wrap = no_mouse_wrap;
394 /* initialize the panel hooks */
395 SP->_panelHook.top_panel = (struct panel *) 0;
396 SP->_panelHook.bottom_panel = (struct panel *) 0;
397 SP->_panelHook.stdscr_pseudo_panel = (struct panel *) 0;
400 * If we've no magic cookie support, we suppress attributes that xmc would
401 * affect, i.e., the attributes that affect the rendition of a space.
403 SP->_ok_attributes = termattrs();
405 SP->_ok_attributes |= A_COLOR;
409 * If we have no magic-cookie support compiled-in, or if it is suppressed
410 * in the environment, reset the support-flag.
412 if (magic_cookie_glitch >= 0) {
413 if (getenv("NCURSES_NO_MAGIC_COOKIE") != 0) {
414 support_cookies = FALSE;
419 if (!support_cookies && magic_cookie_glitch >= 0) {
420 T(("will disable attributes to work w/o magic cookies"));
423 if (magic_cookie_glitch > 0) { /* tvi, wyse */
425 SP->_xmc_triggers = SP->_ok_attributes & (
437 * We "should" treat colors as an attribute. The wyse350 (and its
438 * clones) appear to be the only ones that have both colors and magic
442 SP->_xmc_triggers |= A_COLOR;
445 SP->_xmc_suppress = SP->_xmc_triggers & (chtype) ~(A_BOLD);
447 T(("magic cookie attributes %s", _traceattr(SP->_xmc_suppress)));
449 * Supporting line-drawing may be possible. But make the regular
450 * video attributes work first.
452 acs_chars = ABSENT_STRING;
453 ena_acs = ABSENT_STRING;
454 enter_alt_charset_mode = ABSENT_STRING;
455 exit_alt_charset_mode = ABSENT_STRING;
458 * To keep the cookie support simple, suppress all of the optimization
459 * hooks except for clear_screen and the cursor addressing.
461 if (support_cookies) {
462 clr_eol = ABSENT_STRING;
463 clr_eos = ABSENT_STRING;
464 set_attributes = ABSENT_STRING;
467 } else if (magic_cookie_glitch == 0) { /* hpterm */
471 * If magic cookies are not supported, cancel the strings that set
474 if (!support_cookies && magic_cookie_glitch >= 0) {
475 magic_cookie_glitch = ABSENT_NUMERIC;
476 set_attributes = ABSENT_STRING;
477 enter_blink_mode = ABSENT_STRING;
478 enter_bold_mode = ABSENT_STRING;
479 enter_dim_mode = ABSENT_STRING;
480 enter_reverse_mode = ABSENT_STRING;
481 enter_standout_mode = ABSENT_STRING;
482 enter_underline_mode = ABSENT_STRING;
485 /* initialize normal acs before wide, since we use mapping in the latter */
486 #if !USE_WIDEC_SUPPORT
487 if (_nc_unicode_locale() && _nc_locale_breaks_acs()) {
490 enter_alt_charset_mode = NULL;
491 exit_alt_charset_mode = NULL;
492 set_attributes = NULL;
496 #if USE_WIDEC_SUPPORT
499 SP->_screen_acs_fix = (_nc_unicode_locale() && _nc_locale_breaks_acs());
501 char *env = _nc_get_locale();
502 SP->_legacy_coding = ((env == 0)
504 || !strcmp(env, "POSIX"));
511 _nc_windows = 0; /* no windows yet */
516 T(("creating newscr"));
517 if ((SP->_newscr = newwin(slines, scolumns, 0, 0)) == 0)
520 T(("creating curscr"));
521 if ((SP->_curscr = newwin(slines, scolumns, 0, 0)) == 0)
525 newscr = SP->_newscr;
526 curscr = SP->_curscr;
529 SP->_resize = resizeterm;
532 newscr->_clear = TRUE;
533 curscr->_clear = FALSE;
538 for (rop = ripoff_stack;
539 rop != ripoff_sp && (rop - ripoff_stack) < N_RIPS;
542 /* If we must simulate soft labels, grab off the line to be used.
543 We assume that we must simulate, if it is none of the standard
544 formats (4-4 or 3-2-3) for which there may be some hardware
546 if (rop->hook == _nc_slk_initialize)
547 if (!(num_labels <= 0 || !SLK_STDFMT(slk_format)))
553 count = (rop->line < 0) ? -rop->line : rop->line;
554 T(("ripping off %i lines at %s", count,
559 w = newwin(count, scolumns,
561 ? SP->_lines_avail - count
565 rop->hook(w, scolumns);
569 bottom_stolen += count;
571 SP->_topstolen += count;
572 SP->_lines_avail -= count;
575 /* reset the stack */
576 ripoff_sp = ripoff_stack;
578 T(("creating stdscr"));
579 assert((SP->_lines_avail + SP->_topstolen + bottom_stolen) == slines);
580 if ((SP->_stdscr = newwin(SP->_lines_avail, scolumns, 0, 0)) == 0)
583 SET_LINES(SP->_lines_avail);
585 stdscr = SP->_stdscr;
592 * The internal implementation interprets line as the number of lines to rip
593 * off from the top or bottom.
596 _nc_ripoffline(int line, int (*init) (WINDOW *, int))
598 T((T_CALLED("_nc_ripoffline(%d, %p)"), line, init));
603 ripoff_sp = ripoff_stack;
604 if (ripoff_sp >= ripoff_stack + N_RIPS)
607 ripoff_sp->line = line;
608 ripoff_sp->hook = init;
616 ripoffline(int line, int (*init) (WINDOW *, int))
618 T((T_CALLED("ripoffline(%d,%p)"), line, init));
623 returnCode(_nc_ripoffline((line < 0) ? -1 : 1, init));