lib_set_term.c revision 98503 
1/****************************************************************************
2 * Copyright (c) 1998-2001,2002 Free Software Foundation, Inc.              *
3 *                                                                          *
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:                 *
11 *                                                                          *
12 * The above copyright notice and this permission notice shall be included  *
13 * in all copies or substantial portions of the Software.                   *
14 *                                                                          *
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.                               *
22 *                                                                          *
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       *
26 * authorization.                                                           *
27 ****************************************************************************/
28
29/****************************************************************************
30 *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31 *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32 ****************************************************************************/
33
34/*
35**	lib_set_term.c
36**
37**	The routine set_term().
38**
39*/
40
41#include <curses.priv.h>
42
43#include <term.h>		/* cur_term */
44#include <tic.h>
45
46MODULE_ID("$Id: lib_set_term.c,v 1.65 2002/06/15 18:40:20 tom Exp $")
47
48NCURSES_EXPORT(SCREEN *)
49set_term(SCREEN * screenp)
50{
51    SCREEN *oldSP;
52
53    T((T_CALLED("set_term(%p)"), screenp));
54
55    oldSP = SP;
56    _nc_set_screen(screenp);
57
58    set_curterm(SP->_term);
59    curscr = SP->_curscr;
60    newscr = SP->_newscr;
61    stdscr = SP->_stdscr;
62    COLORS = SP->_color_count;
63    COLOR_PAIRS = SP->_pair_count;
64    memcpy(acs_map, SP->_acs_map, sizeof(chtype) * ACS_LEN);
65
66    T((T_RETURN("%p"), oldSP));
67    return (oldSP);
68}
69
70static void
71_nc_free_keytry(struct tries *kt)
72{
73    if (kt != 0) {
74	_nc_free_keytry(kt->child);
75	_nc_free_keytry(kt->sibling);
76	free(kt);
77    }
78}
79
80/*
81 * Free the storage associated with the given SCREEN sp.
82 */
83NCURSES_EXPORT(void)
84delscreen(SCREEN * sp)
85{
86    SCREEN **scan = &_nc_screen_chain;
87
88    T((T_CALLED("delscreen(%p)"), sp));
89
90    while (*scan) {
91	if (*scan == sp) {
92	    *scan = sp->_next_screen;
93	    break;
94	}
95	scan = &(*scan)->_next_screen;
96    }
97
98    (void) _nc_freewin(sp->_curscr);
99    (void) _nc_freewin(sp->_newscr);
100    (void) _nc_freewin(sp->_stdscr);
101    _nc_free_keytry(sp->_keytry);
102    _nc_free_keytry(sp->_key_ok);
103
104    FreeIfNeeded(sp->_color_table);
105    FreeIfNeeded(sp->_color_pairs);
106
107    FreeIfNeeded(sp->oldhash);
108    FreeIfNeeded(sp->newhash);
109
110    del_curterm(sp->_term);
111
112    /*
113     * If the associated output stream has been closed, we can discard the
114     * set-buffer.  Limit the error check to EBADF, since fflush may fail
115     * for other reasons than trying to operate upon a closed stream.
116     */
117    if (sp->_ofp != 0
118	&& sp->_setbuf != 0
119	&& fflush(sp->_ofp) != 0
120	&& errno == EBADF) {
121	free(sp->_setbuf);
122    }
123
124    free(sp);
125
126    /*
127     * If this was the current screen, reset everything that the
128     * application might try to use (except cur_term, which may have
129     * multiple references in different screens).
130     */
131    if (sp == SP) {
132	curscr = 0;
133	newscr = 0;
134	stdscr = 0;
135	COLORS = 0;
136	COLOR_PAIRS = 0;
137	_nc_set_screen(0);
138    }
139    returnVoid;
140}
141
142static ripoff_t rippedoff[5];
143static ripoff_t *rsp = rippedoff;
144#define N_RIPS SIZEOF(rippedoff)
145
146static bool
147no_mouse_event(SCREEN * sp GCC_UNUSED)
148{
149    return FALSE;
150}
151
152static bool
153no_mouse_inline(SCREEN * sp GCC_UNUSED)
154{
155    return FALSE;
156}
157
158static bool
159no_mouse_parse(int code GCC_UNUSED)
160{
161    return TRUE;
162}
163
164static void
165no_mouse_resume(SCREEN * sp GCC_UNUSED)
166{
167}
168
169static void
170no_mouse_wrap(SCREEN * sp GCC_UNUSED)
171{
172}
173
174#if NCURSES_EXT_FUNCS && USE_COLORFGBG
175static char *
176extract_fgbg(char *src, int *result)
177{
178    char *dst = 0;
179    long value = strtol(src, &dst, 0);
180
181    if (dst == 0) {
182	dst = src;
183    } else if (value >= 0) {
184	*result = value;
185    }
186    while (*dst != 0 && *dst != ';')
187	dst++;
188    if (*dst == ';')
189	dst++;
190    return dst;
191}
192#endif
193
194NCURSES_EXPORT(int)
195_nc_setupscreen
196(short slines, short const scolumns, FILE * output)
197/* OS-independent screen initializations */
198{
199    int bottom_stolen = 0;
200    size_t i;
201
202    assert(SP == 0);		/* has been reset in newterm() ! */
203    if (!_nc_alloc_screen())
204	return ERR;
205
206    SP->_next_screen = _nc_screen_chain;
207    _nc_screen_chain = SP;
208
209    _nc_set_buffer(output, TRUE);
210    SP->_term = cur_term;
211    SP->_lines = slines;
212    SP->_lines_avail = slines;
213    SP->_columns = scolumns;
214    SP->_cursrow = -1;
215    SP->_curscol = -1;
216    SP->_nl = TRUE;
217    SP->_raw = FALSE;
218    SP->_cbreak = 0;
219    SP->_echo = TRUE;
220    SP->_fifohead = -1;
221    SP->_endwin = TRUE;
222    SP->_ofp = output;
223    SP->_cursor = -1;		/* cannot know real cursor shape */
224
225#if NCURSES_NO_PADDING
226    SP->_no_padding = getenv("NCURSES_NO_PADDING") != 0;
227    TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
228				    SP->_no_padding ? " not" : ""));
229#endif
230
231#if NCURSES_EXT_FUNCS
232    SP->_default_color = FALSE;
233    SP->_has_sgr_39_49 = FALSE;
234
235    /*
236     * Set our assumption of the terminal's default foreground and background
237     * colors.  The curs_color man-page states that we can assume that the
238     * background is black.  The origin of this assumption appears to be
239     * terminals that displayed colored text, but no colored backgrounds, e.g.,
240     * the first colored terminals around 1980.  More recent ones with better
241     * technology can display not only colored backgrounds, but all
242     * combinations.  So a terminal might be something other than "white" on
243     * black (green/black looks monochrome too), but black on white or even
244     * on ivory.
245     *
246     * White-on-black is the simplest thing to use for monochrome.  Almost
247     * all applications that use color paint both text and background, so
248     * the distinction is moot.  But a few do not - which is why we leave this
249     * configurable (a better solution is to use assume_default_colors() for
250     * the rare applications that do require that sort of appearance, since
251     * is appears that more users expect to be able to make a white-on-black
252     * or black-on-white display under control of the application than not).
253     */
254#ifdef USE_ASSUMED_COLOR
255    SP->_default_fg = COLOR_WHITE;
256    SP->_default_bg = COLOR_BLACK;
257#else
258    SP->_default_fg = C_MASK;
259    SP->_default_bg = C_MASK;
260#endif
261
262#if USE_COLORFGBG
263    /*
264     * If rxvt's $COLORFGBG variable is set, use it to specify the assumed
265     * default colors.  Note that rxvt (mis)uses bold colors, equating a bold
266     * color to that value plus 8.  We'll only use the non-bold color for now -
267     * decide later if it is worth having default attributes as well.
268     */
269    if (getenv("COLORFGBG") != 0) {
270	char *p = getenv("COLORFGBG");
271	TR(TRACE_CHARPUT | TRACE_MOVE, ("decoding COLORFGBG %s", p));
272	p = extract_fgbg(p, &(SP->_default_fg));
273	p = extract_fgbg(p, &(SP->_default_bg));
274	if (*p)			/* assume rxvt was compiled with xpm support */
275	    p = extract_fgbg(p, &(SP->_default_bg));
276	TR(TRACE_CHARPUT | TRACE_MOVE, ("decoded fg=%d, bg=%d",
277					SP->_default_fg, SP->_default_bg));
278	if (SP->_default_fg > max_colors) {
279	    if (set_a_foreground != ABSENT_STRING
280		&& !strcmp(set_a_foreground, "\033[3%p1%dm")) {
281		set_a_foreground = "\033[3%?%p1%{8}%>%t9%e%p1%d%;m";
282	    } else {
283		SP->_default_fg %= max_colors;
284	    }
285	}
286	if (SP->_default_bg > max_colors) {
287	    if (set_a_background != ABSENT_STRING
288		&& !strcmp(set_a_background, "\033[4%p1%dm")) {
289		set_a_background = "\033[4%?%p1%{8}%>%t9%e%p1%d%;m";
290	    } else {
291		SP->_default_bg %= max_colors;
292	    }
293	}
294    }
295#endif
296#endif /* NCURSES_EXT_FUNCS */
297
298    SP->_maxclick = DEFAULT_MAXCLICK;
299    SP->_mouse_event = no_mouse_event;
300    SP->_mouse_inline = no_mouse_inline;
301    SP->_mouse_parse = no_mouse_parse;
302    SP->_mouse_resume = no_mouse_resume;
303    SP->_mouse_wrap = no_mouse_wrap;
304    SP->_mouse_fd = -1;
305
306    /* initialize the panel hooks */
307    SP->_panelHook.top_panel = (struct panel *) 0;
308    SP->_panelHook.bottom_panel = (struct panel *) 0;
309    SP->_panelHook.stdscr_pseudo_panel = (struct panel *) 0;
310
311    /*
312     * If we've no magic cookie support, we suppress attributes that xmc
313     * would affect, i.e., the attributes that affect the rendition of a
314     * space.  Note that this impacts the alternate character set mapping
315     * as well.
316     */
317    if (magic_cookie_glitch > 0) {
318
319	SP->_xmc_triggers = termattrs() & (
320					      A_ALTCHARSET |
321					      A_BLINK |
322					      A_BOLD |
323					      A_REVERSE |
324					      A_STANDOUT |
325					      A_UNDERLINE
326	    );
327	SP->_xmc_suppress = SP->_xmc_triggers & (chtype) ~ (A_BOLD);
328
329	T(("magic cookie attributes %s", _traceattr(SP->_xmc_suppress)));
330#if USE_XMC_SUPPORT
331	/*
332	 * To keep this simple, suppress all of the optimization hooks
333	 * except for clear_screen and the cursor addressing.
334	 */
335	clr_eol = 0;
336	clr_eos = 0;
337	set_attributes = 0;
338#else
339	magic_cookie_glitch = ABSENT_NUMERIC;
340	acs_chars = 0;
341#endif
342    }
343#if USE_WIDEC_SUPPORT
344    _nc_init_wacs();
345#endif
346    _nc_init_acs();
347    memcpy(SP->_acs_map, acs_map, sizeof(chtype) * ACS_LEN);
348
349    _nc_idcok = TRUE;
350    _nc_idlok = FALSE;
351
352    _nc_windows = 0;		/* no windows yet */
353
354    SP->oldhash = 0;
355    SP->newhash = 0;
356
357    T(("creating newscr"));
358    if ((newscr = newwin(slines, scolumns, 0, 0)) == 0)
359	return ERR;
360
361    T(("creating curscr"));
362    if ((curscr = newwin(slines, scolumns, 0, 0)) == 0)
363	return ERR;
364
365    SP->_newscr = newscr;
366    SP->_curscr = curscr;
367#if USE_SIZECHANGE
368    SP->_resize = resizeterm;
369#endif
370
371    newscr->_clear = TRUE;
372    curscr->_clear = FALSE;
373
374    def_shell_mode();
375    def_prog_mode();
376
377    for (i = 0, rsp = rippedoff; rsp->line && (i < N_RIPS); rsp++, i++) {
378	if (rsp->hook) {
379	    WINDOW *w;
380	    int count = (rsp->line < 0) ? -rsp->line : rsp->line;
381
382	    if (rsp->line < 0) {
383		w = newwin(count, scolumns, SP->_lines_avail - count, 0);
384		if (w) {
385		    rsp->w = w;
386		    rsp->hook(w, scolumns);
387		    bottom_stolen += count;
388		} else
389		    return ERR;
390	    } else {
391		w = newwin(count, scolumns, 0, 0);
392		if (w) {
393		    rsp->w = w;
394		    rsp->hook(w, scolumns);
395		    SP->_topstolen += count;
396		} else
397		    return ERR;
398	    }
399	    SP->_lines_avail -= count;
400	}
401	rsp->line = 0;
402    }
403    /* reset the stack */
404    rsp = rippedoff;
405
406    T(("creating stdscr"));
407    assert((SP->_lines_avail + SP->_topstolen + bottom_stolen) == slines);
408    if ((stdscr = newwin(LINES = SP->_lines_avail, scolumns, 0, 0)) == 0)
409	return ERR;
410    SP->_stdscr = stdscr;
411
412    return OK;
413}
414
415/* The internal implementation interprets line as the number of
416   lines to rip off from the top or bottom.
417   */
418NCURSES_EXPORT(int)
419_nc_ripoffline(int line, int (*init) (WINDOW *, int))
420{
421    if (line == 0)
422	return (OK);
423
424    if (rsp >= rippedoff + N_RIPS)
425	return (ERR);
426
427    rsp->line = line;
428    rsp->hook = init;
429    rsp->w = 0;
430    rsp++;
431
432    return (OK);
433}
434
435NCURSES_EXPORT(int)
436ripoffline(int line, int (*init) (WINDOW *, int))
437{
438    T((T_CALLED("ripoffline(%d,%p)"), line, init));
439
440    if (line == 0)
441	returnCode(OK);
442
443    returnCode(_nc_ripoffline((line < 0) ? -1 : 1, init));
444}
445