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.95 2007/03/10 23:52:01 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).
169 static ripoff_t rippedoff[5];
170 static ripoff_t *rsp = rippedoff;
171 #define N_RIPS SIZEOF(SP->_rippedoff)
174 no_mouse_event(SCREEN *sp GCC_UNUSED)
180 no_mouse_inline(SCREEN *sp GCC_UNUSED)
186 no_mouse_parse(int code GCC_UNUSED)
192 no_mouse_resume(SCREEN *sp GCC_UNUSED)
197 no_mouse_wrap(SCREEN *sp GCC_UNUSED)
201 #if NCURSES_EXT_FUNCS && USE_COLORFGBG
203 extract_fgbg(char *src, int *result)
206 long value = strtol(src, &dst, 0);
210 } else if (value >= 0) {
213 while (*dst != 0 && *dst != ';')
221 /* OS-independent screen initializations */
223 _nc_setupscreen(int slines GCC_UNUSED,
224 int scolumns GCC_UNUSED,
229 int bottom_stolen = 0;
231 bool support_cookies = USE_XMC_SUPPORT;
233 T((T_CALLED("_nc_setupscreen(%d, %d, %p, %d, %d)"),
234 slines, scolumns, output, filtered, slk_format));
236 assert(SP == 0); /* has been reset in newterm() ! */
237 if (!_nc_alloc_screen()
238 || ((SP->_acs_map = typeCalloc(chtype, ACS_LEN)) == 0)
239 || ((SP->_screen_acs_map = typeCalloc(bool, ACS_LEN)) == 0)) {
243 T(("created SP %p", SP));
244 SP->_next_screen = _nc_screen_chain;
245 _nc_screen_chain = SP;
247 if ((SP->_current_attr = typeCalloc(NCURSES_CH_T, 1)) == 0)
251 * We should always check the screensize, just in case.
253 _nc_get_screensize(&slines, &scolumns);
256 T((T_CREATE("screen %s %dx%d"), termname(), LINES, COLS));
258 SP->_filtered = filtered;
260 /* implement filter mode */
265 cursor_down = parm_down_cursor = 0;
267 cursor_up = parm_up_cursor = 0;
270 cursor_home = carriage_return;
271 T(("filter screensize %dx%d", LINES, COLS));
274 /* If we must simulate soft labels, grab off the line to be used.
275 We assume that we must simulate, if it is none of the standard
276 formats (4-4 or 3-2-3) for which there may be some hardware
278 if (num_labels <= 0 || !SLK_STDFMT(slk_format)) {
280 if (ERR == _nc_ripoffline(-SLK_LINES(slk_format),
286 T(("setting output mode to binary"));
288 setmode(output, O_BINARY);
290 _nc_set_buffer(output, TRUE);
291 SP->_term = cur_term;
293 SP->_lines_avail = slines;
294 SP->_columns = scolumns;
304 SP->_cursor = -1; /* cannot know real cursor shape */
306 #if NCURSES_NO_PADDING
307 SP->_no_padding = getenv("NCURSES_NO_PADDING") != 0;
308 TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
309 SP->_no_padding ? " not" : ""));
312 #if NCURSES_EXT_FUNCS
313 SP->_default_color = FALSE;
314 SP->_has_sgr_39_49 = FALSE;
317 * Set our assumption of the terminal's default foreground and background
318 * colors. The curs_color man-page states that we can assume that the
319 * background is black. The origin of this assumption appears to be
320 * terminals that displayed colored text, but no colored backgrounds, e.g.,
321 * the first colored terminals around 1980. More recent ones with better
322 * technology can display not only colored backgrounds, but all
323 * combinations. So a terminal might be something other than "white" on
324 * black (green/black looks monochrome too), but black on white or even
327 * White-on-black is the simplest thing to use for monochrome. Almost
328 * all applications that use color paint both text and background, so
329 * the distinction is moot. But a few do not - which is why we leave this
330 * configurable (a better solution is to use assume_default_colors() for
331 * the rare applications that do require that sort of appearance, since
332 * is appears that more users expect to be able to make a white-on-black
333 * or black-on-white display under control of the application than not).
335 #ifdef USE_ASSUMED_COLOR
336 SP->_default_fg = COLOR_WHITE;
337 SP->_default_bg = COLOR_BLACK;
339 SP->_default_fg = C_MASK;
340 SP->_default_bg = C_MASK;
344 * Allow those assumed/default color assumptions to be overridden at
347 if (getenv("NCURSES_ASSUMED_COLORS") != 0) {
348 char *p = getenv("NCURSES_ASSUMED_COLORS");
351 int count = sscanf(p, "%d%c%d%c", &fg, &sep1, &bg, &sep2);
353 SP->_default_fg = (fg >= 0 && fg < max_colors) ? fg : C_MASK;
355 SP->_default_bg = (bg >= 0 && bg < max_colors) ? bg : C_MASK;
357 TR(TRACE_CHARPUT | TRACE_MOVE,
358 ("from environment assumed fg=%d, bg=%d",
365 * If rxvt's $COLORFGBG variable is set, use it to specify the assumed
366 * default colors. Note that rxvt (mis)uses bold colors, equating a bold
367 * color to that value plus 8. We'll only use the non-bold color for now -
368 * decide later if it is worth having default attributes as well.
370 if (getenv("COLORFGBG") != 0) {
371 char *p = getenv("COLORFGBG");
372 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoding COLORFGBG %s", p));
373 p = extract_fgbg(p, &(SP->_default_fg));
374 p = extract_fgbg(p, &(SP->_default_bg));
375 if (*p) /* assume rxvt was compiled with xpm support */
376 p = extract_fgbg(p, &(SP->_default_bg));
377 TR(TRACE_CHARPUT | TRACE_MOVE, ("decoded fg=%d, bg=%d",
378 SP->_default_fg, SP->_default_bg));
379 if (SP->_default_fg >= max_colors) {
380 if (set_a_foreground != ABSENT_STRING
381 && !strcmp(set_a_foreground, "\033[3%p1%dm")) {
382 set_a_foreground = "\033[3%?%p1%{8}%>%t9%e%p1%d%;m";
384 SP->_default_fg %= max_colors;
387 if (SP->_default_bg >= max_colors) {
388 if (set_a_background != ABSENT_STRING
389 && !strcmp(set_a_background, "\033[4%p1%dm")) {
390 set_a_background = "\033[4%?%p1%{8}%>%t9%e%p1%d%;m";
392 SP->_default_bg %= max_colors;
397 #endif /* NCURSES_EXT_FUNCS */
399 SP->_maxclick = DEFAULT_MAXCLICK;
400 SP->_mouse_event = no_mouse_event;
401 SP->_mouse_inline = no_mouse_inline;
402 SP->_mouse_parse = no_mouse_parse;
403 SP->_mouse_resume = no_mouse_resume;
404 SP->_mouse_wrap = no_mouse_wrap;
407 /* initialize the panel hooks */
408 SP->_panelHook.top_panel = (struct panel *) 0;
409 SP->_panelHook.bottom_panel = (struct panel *) 0;
410 SP->_panelHook.stdscr_pseudo_panel = (struct panel *) 0;
413 * If we've no magic cookie support, we suppress attributes that xmc would
414 * affect, i.e., the attributes that affect the rendition of a space.
416 SP->_ok_attributes = termattrs();
418 SP->_ok_attributes |= A_COLOR;
422 * If we have no magic-cookie support compiled-in, or if it is suppressed
423 * in the environment, reset the support-flag.
425 if (magic_cookie_glitch >= 0) {
426 if (getenv("NCURSES_NO_MAGIC_COOKIE") != 0) {
427 support_cookies = FALSE;
432 if (!support_cookies && magic_cookie_glitch >= 0) {
433 T(("will disable attributes to work w/o magic cookies"));
436 if (magic_cookie_glitch > 0) { /* tvi, wyse */
438 SP->_xmc_triggers = SP->_ok_attributes & (
450 * We "should" treat colors as an attribute. The wyse350 (and its
451 * clones) appear to be the only ones that have both colors and magic
455 SP->_xmc_triggers |= A_COLOR;
458 SP->_xmc_suppress = SP->_xmc_triggers & (chtype) ~(A_BOLD);
460 T(("magic cookie attributes %s", _traceattr(SP->_xmc_suppress)));
462 * Supporting line-drawing may be possible. But make the regular
463 * video attributes work first.
465 acs_chars = ABSENT_STRING;
466 ena_acs = ABSENT_STRING;
467 enter_alt_charset_mode = ABSENT_STRING;
468 exit_alt_charset_mode = ABSENT_STRING;
471 * To keep the cookie support simple, suppress all of the optimization
472 * hooks except for clear_screen and the cursor addressing.
474 if (support_cookies) {
475 clr_eol = ABSENT_STRING;
476 clr_eos = ABSENT_STRING;
477 set_attributes = ABSENT_STRING;
480 } else if (magic_cookie_glitch == 0) { /* hpterm */
484 * If magic cookies are not supported, cancel the strings that set
487 if (!support_cookies && magic_cookie_glitch >= 0) {
488 magic_cookie_glitch = ABSENT_NUMERIC;
489 set_attributes = ABSENT_STRING;
490 enter_blink_mode = ABSENT_STRING;
491 enter_bold_mode = ABSENT_STRING;
492 enter_dim_mode = ABSENT_STRING;
493 enter_reverse_mode = ABSENT_STRING;
494 enter_standout_mode = ABSENT_STRING;
495 enter_underline_mode = ABSENT_STRING;
498 /* initialize normal acs before wide, since we use mapping in the latter */
499 #if !USE_WIDEC_SUPPORT
500 if (_nc_unicode_locale() && _nc_locale_breaks_acs()) {
503 enter_alt_charset_mode = NULL;
504 exit_alt_charset_mode = NULL;
505 set_attributes = NULL;
509 #if USE_WIDEC_SUPPORT
512 SP->_screen_acs_fix = (_nc_unicode_locale() && _nc_locale_breaks_acs());
514 char *env = _nc_get_locale();
515 SP->_legacy_coding = ((env == 0)
517 || !strcmp(env, "POSIX"));
524 _nc_windows = 0; /* no windows yet */
529 T(("creating newscr"));
530 if ((SP->_newscr = newwin(slines, scolumns, 0, 0)) == 0)
533 T(("creating curscr"));
534 if ((SP->_curscr = newwin(slines, scolumns, 0, 0)) == 0)
538 newscr = SP->_newscr;
539 curscr = SP->_curscr;
542 SP->_resize = resizeterm;
545 newscr->_clear = TRUE;
546 curscr->_clear = FALSE;
551 for (i = 0, rsp = rippedoff; rsp->line && (i < (int) N_RIPS); rsp++, i++) {
552 T(("ripping off line %d at %s", i, rsp->line < 0 ? "bottom" : "top"));
553 SP->_rippedoff[i] = rippedoff[i];
555 int count = (rsp->line < 0) ? -rsp->line : rsp->line;
557 SP->_rippedoff[i].w = newwin(count,
560 ? SP->_lines_avail - count
563 if (SP->_rippedoff[i].w != 0)
564 SP->_rippedoff[i].hook(SP->_rippedoff[i].w, scolumns);
568 bottom_stolen += count;
570 SP->_topstolen += count;
571 SP->_lines_avail -= count;
576 /* reset the stack */
579 T(("creating stdscr"));
580 assert((SP->_lines_avail + SP->_topstolen + bottom_stolen) == slines);
581 if ((SP->_stdscr = newwin(SP->_lines_avail, scolumns, 0, 0)) == 0)
584 SET_LINES(SP->_lines_avail);
586 stdscr = SP->_stdscr;
593 * The internal implementation interprets line as the number of lines to rip
594 * off from the top or bottom.
597 _nc_ripoffline(int line, int (*init) (WINDOW *, int))
599 T((T_CALLED("_nc_ripoffline(%d, %p)"), line, init));
603 if (rsp >= rippedoff + N_RIPS)
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));