1/****************************************************************************
2 * Copyright (c) 1998-2004,2005 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 *     and: Thomas E. Dickey                        1996 on                 *
33 ****************************************************************************/
34
35/*
36 *	vidputs(newmode, outc)
37 *
38 *	newmode is taken to be the logical 'or' of the symbols in curses.h
39 *	representing graphic renditions.  The terminal is set to be in all of
40 *	the given modes, if possible.
41 *
42 *	if the new attribute is normal
43 *		if exit-alt-char-set exists
44 *			emit it
45 *		emit exit-attribute-mode
46 *	else if set-attributes exists
47 *		use it to set exactly what you want
48 *	else
49 *		if exit-attribute-mode exists
50 *			turn off everything
51 *		else
52 *			turn off those which can be turned off and aren't in
53 *			newmode.
54 *		turn on each mode which should be on and isn't, one by one
55 *
56 *	NOTE that this algorithm won't achieve the desired mix of attributes
57 *	in some cases, but those are probably just those cases in which it is
58 *	actually impossible, anyway, so...
59 *
60 * 	NOTE that we cannot assume that there's no interaction between color
61 *	and other attribute resets.  So each time we reset color (or other
62 *	attributes) we'll have to be prepared to restore the other.
63 */
64
65#include <curses.priv.h>
66#include <term.h>
67
68MODULE_ID("$Id: lib_vidattr.c,v 1.44 2005/01/22 22:15:44 tom Exp $")
69
70#define doPut(mode) TPUTS_TRACE(#mode); tputs(mode, 1, outc)
71
72#define TurnOn(mask,mode) \
73	if ((turn_on & mask) && mode) { doPut(mode); }
74
75#define TurnOff(mask,mode) \
76	if ((turn_off & mask) && mode) { doPut(mode); turn_off &= ~mask; }
77
78	/* if there is no current screen, assume we *can* do color */
79#define SetColorsIf(why,old_attr) \
80	if (can_color && (why)) { \
81		int old_pair = PAIR_NUMBER(old_attr); \
82		TR(TRACE_ATTRS, ("old pair = %d -- new pair = %d", old_pair, pair)); \
83		if ((pair != old_pair) \
84		 || (fix_pair0 && (pair == 0)) \
85		 || (reverse ^ ((old_attr & A_REVERSE) != 0))) { \
86			_nc_do_color(old_pair, pair, reverse, outc); \
87		} \
88	}
89
90NCURSES_EXPORT(int)
91vidputs(chtype newmode, int (*outc) (int))
92{
93    static attr_t previous_attr = A_NORMAL;
94    attr_t turn_on, turn_off;
95    int pair;
96    bool reverse = FALSE;
97    bool can_color = (SP == 0 || SP->_coloron);
98#if NCURSES_EXT_FUNCS
99    bool fix_pair0 = (SP != 0 && SP->_coloron && !SP->_default_color);
100#else
101#define fix_pair0 FALSE
102#endif
103
104    T((T_CALLED("vidputs(%s)"), _traceattr(newmode)));
105
106    /* this allows us to go on whether or not newterm() has been called */
107    if (SP)
108	previous_attr = AttrOf(SCREEN_ATTRS(SP));
109
110    TR(TRACE_ATTRS, ("previous attribute was %s", _traceattr(previous_attr)));
111
112#if !USE_XMC_SUPPORT
113    if ((SP != 0)
114	&& (magic_cookie_glitch > 0))
115	newmode &= ~(SP->_xmc_suppress);
116#endif
117
118    /*
119     * If we have a terminal that cannot combine color with video
120     * attributes, use the colors in preference.
121     */
122    if (((newmode & A_COLOR) != 0
123	 || fix_pair0)
124	&& (no_color_video > 0)) {
125	/*
126	 * If we had chosen the A_xxx definitions to correspond to the
127	 * no_color_video mask, we could simply shift it up and mask off the
128	 * attributes.  But we did not (actually copied Solaris' definitions).
129	 * However, this is still simpler/faster than a lookup table.
130	 *
131	 * The 63 corresponds to A_STANDOUT, A_UNDERLINE, A_REVERSE, A_BLINK,
132	 * A_DIM, A_BOLD which are 1:1 with no_color_video.  The bits that
133	 * correspond to A_INVIS, A_PROTECT (192) must be shifted up 1 and
134	 * A_ALTCHARSET (256) down 2 to line up.  We use the NCURSES_BITS
135	 * macro so this will work properly for the wide-character layout.
136	 */
137	unsigned value = no_color_video;
138	attr_t mask = NCURSES_BITS((value & 63)
139				   | ((value & 192) << 1)
140				   | ((value & 256) >> 2), 8);
141
142	if ((mask & A_REVERSE) != 0
143	    && (newmode & A_REVERSE) != 0) {
144	    reverse = TRUE;
145	    mask &= ~A_REVERSE;
146	}
147	newmode &= ~mask;
148    }
149
150    if (newmode == previous_attr)
151	returnCode(OK);
152
153    pair = PAIR_NUMBER(newmode);
154
155    if (reverse) {
156	newmode &= ~A_REVERSE;
157    }
158
159    turn_off = (~newmode & previous_attr) & ALL_BUT_COLOR;
160    turn_on = (newmode & ~previous_attr) & ALL_BUT_COLOR;
161
162    SetColorsIf(((pair == 0) && !fix_pair0), previous_attr);
163
164    if (newmode == A_NORMAL) {
165	if ((previous_attr & A_ALTCHARSET) && exit_alt_charset_mode) {
166	    doPut(exit_alt_charset_mode);
167	    previous_attr &= ~A_ALTCHARSET;
168	}
169	if (previous_attr) {
170	    if (exit_attribute_mode) {
171		doPut(exit_attribute_mode);
172	    } else {
173		if (!SP || SP->_use_rmul) {
174		    TurnOff(A_UNDERLINE, exit_underline_mode);
175		}
176		if (!SP || SP->_use_rmso) {
177		    TurnOff(A_STANDOUT, exit_standout_mode);
178		}
179	    }
180	    previous_attr &= ALL_BUT_COLOR;
181	}
182
183	SetColorsIf((pair != 0) || fix_pair0, previous_attr);
184    } else if (set_attributes) {
185	if (turn_on || turn_off) {
186	    TPUTS_TRACE("set_attributes");
187	    tputs(tparm(set_attributes,
188			(newmode & A_STANDOUT) != 0,
189			(newmode & A_UNDERLINE) != 0,
190			(newmode & A_REVERSE) != 0,
191			(newmode & A_BLINK) != 0,
192			(newmode & A_DIM) != 0,
193			(newmode & A_BOLD) != 0,
194			(newmode & A_INVIS) != 0,
195			(newmode & A_PROTECT) != 0,
196			(newmode & A_ALTCHARSET) != 0), 1, outc);
197	    previous_attr &= ALL_BUT_COLOR;
198	}
199	SetColorsIf((pair != 0) || fix_pair0, previous_attr);
200    } else {
201
202	TR(TRACE_ATTRS, ("turning %s off", _traceattr(turn_off)));
203
204	TurnOff(A_ALTCHARSET, exit_alt_charset_mode);
205
206	if (!SP || SP->_use_rmul) {
207	    TurnOff(A_UNDERLINE, exit_underline_mode);
208	}
209
210	if (!SP || SP->_use_rmso) {
211	    TurnOff(A_STANDOUT, exit_standout_mode);
212	}
213
214	if (turn_off && exit_attribute_mode) {
215	    doPut(exit_attribute_mode);
216	    turn_on |= (newmode & ALL_BUT_COLOR);
217	    previous_attr &= ALL_BUT_COLOR;
218	}
219	SetColorsIf((pair != 0) || fix_pair0, previous_attr);
220
221	TR(TRACE_ATTRS, ("turning %s on", _traceattr(turn_on)));
222	/* *INDENT-OFF* */
223	TurnOn(A_ALTCHARSET,	enter_alt_charset_mode);
224	TurnOn(A_BLINK,		enter_blink_mode);
225	TurnOn(A_BOLD,		enter_bold_mode);
226	TurnOn(A_DIM,		enter_dim_mode);
227	TurnOn(A_REVERSE,	enter_reverse_mode);
228	TurnOn(A_STANDOUT,	enter_standout_mode);
229	TurnOn(A_PROTECT,	enter_protected_mode);
230	TurnOn(A_INVIS,		enter_secure_mode);
231	TurnOn(A_UNDERLINE,	enter_underline_mode);
232#if USE_WIDEC_SUPPORT
233	TurnOn(A_HORIZONTAL,	enter_horizontal_hl_mode);
234	TurnOn(A_LEFT,		enter_left_hl_mode);
235	TurnOn(A_LOW,		enter_low_hl_mode);
236	TurnOn(A_RIGHT,		enter_right_hl_mode);
237	TurnOn(A_TOP,		enter_top_hl_mode);
238	TurnOn(A_VERTICAL,	enter_vertical_hl_mode);
239#endif
240	/* *INDENT-ON* */
241
242    }
243
244    if (reverse)
245	newmode |= A_REVERSE;
246
247    if (SP)
248	SetAttr(SCREEN_ATTRS(SP), newmode);
249    else
250	previous_attr = newmode;
251
252    returnCode(OK);
253}
254
255NCURSES_EXPORT(int)
256vidattr(chtype newmode)
257{
258    T((T_CALLED("vidattr(%s)"), _traceattr(newmode)));
259
260    returnCode(vidputs(newmode, _nc_outch));
261}
262
263NCURSES_EXPORT(chtype)
264termattrs(void)
265{
266    chtype attrs = A_NORMAL;
267
268    T((T_CALLED("termattrs()")));
269    if (enter_alt_charset_mode)
270	attrs |= A_ALTCHARSET;
271
272    if (enter_blink_mode)
273	attrs |= A_BLINK;
274
275    if (enter_bold_mode)
276	attrs |= A_BOLD;
277
278    if (enter_dim_mode)
279	attrs |= A_DIM;
280
281    if (enter_reverse_mode)
282	attrs |= A_REVERSE;
283
284    if (enter_standout_mode)
285	attrs |= A_STANDOUT;
286
287    if (enter_protected_mode)
288	attrs |= A_PROTECT;
289
290    if (enter_secure_mode)
291	attrs |= A_INVIS;
292
293    if (enter_underline_mode)
294	attrs |= A_UNDERLINE;
295
296    if (SP->_coloron)
297	attrs |= A_COLOR;
298
299    returnChar(attrs);
300}
301