1/****************************************************************************
2 * Copyright (c) 1998-2006,2007 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.49 2007/06/30 21:58:04 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
90#define PreviousAttr _nc_prescreen.previous_attr
91
92NCURSES_EXPORT(int)
93vidputs(chtype newmode, int (*outc) (int))
94{
95    attr_t turn_on, turn_off;
96    int pair;
97    bool reverse = FALSE;
98    bool can_color = (SP == 0 || SP->_coloron);
99#if NCURSES_EXT_FUNCS
100    bool fix_pair0 = (SP != 0 && SP->_coloron && !SP->_default_color);
101#else
102#define fix_pair0 FALSE
103#endif
104
105    newmode &= A_ATTRIBUTES;
106    T((T_CALLED("vidputs(%s)"), _traceattr(newmode)));
107
108    /* this allows us to go on whether or not newterm() has been called */
109    if (SP)
110	PreviousAttr = AttrOf(SCREEN_ATTRS(SP));
111
112    TR(TRACE_ATTRS, ("previous attribute was %s", _traceattr(PreviousAttr)));
113
114    if ((SP != 0)
115	&& (magic_cookie_glitch > 0)) {
116#if USE_XMC_SUPPORT
117	static const chtype table[] =
118	{
119	    A_STANDOUT,
120	    A_UNDERLINE,
121	    A_REVERSE,
122	    A_BLINK,
123	    A_DIM,
124	    A_BOLD,
125	    A_INVIS,
126	    A_PROTECT,
127	};
128	unsigned n;
129	int used = 0;
130	int limit = (max_attributes <= 0) ? 1 : max_attributes;
131	chtype retain = 0;
132
133	/*
134	 * Limit the number of attribute bits set in the newmode according to
135	 * the terminfo max_attributes value.
136	 */
137	for (n = 0; n < SIZEOF(table); ++n) {
138	    if ((table[n] & SP->_ok_attributes) == 0) {
139		newmode &= ~table[n];
140	    } else if ((table[n] & newmode) != 0) {
141		if (used++ >= limit) {
142		    newmode &= ~table[n];
143		    if (newmode == retain)
144			break;
145		} else {
146		    retain = newmode;
147		}
148	    }
149	}
150#else
151	newmode &= ~(SP->_xmc_suppress);
152#endif
153	TR(TRACE_ATTRS, ("suppressed attribute is %s", _traceattr(newmode)));
154    }
155
156    /*
157     * If we have a terminal that cannot combine color with video
158     * attributes, use the colors in preference.
159     */
160    if (((newmode & A_COLOR) != 0
161	 || fix_pair0)
162	&& (no_color_video > 0)) {
163	/*
164	 * If we had chosen the A_xxx definitions to correspond to the
165	 * no_color_video mask, we could simply shift it up and mask off the
166	 * attributes.  But we did not (actually copied Solaris' definitions).
167	 * However, this is still simpler/faster than a lookup table.
168	 *
169	 * The 63 corresponds to A_STANDOUT, A_UNDERLINE, A_REVERSE, A_BLINK,
170	 * A_DIM, A_BOLD which are 1:1 with no_color_video.  The bits that
171	 * correspond to A_INVIS, A_PROTECT (192) must be shifted up 1 and
172	 * A_ALTCHARSET (256) down 2 to line up.  We use the NCURSES_BITS
173	 * macro so this will work properly for the wide-character layout.
174	 */
175	unsigned value = no_color_video;
176	attr_t mask = NCURSES_BITS((value & 63)
177				   | ((value & 192) << 1)
178				   | ((value & 256) >> 2), 8);
179
180	if ((mask & A_REVERSE) != 0
181	    && (newmode & A_REVERSE) != 0) {
182	    reverse = TRUE;
183	    mask &= ~A_REVERSE;
184	}
185	newmode &= ~mask;
186    }
187
188    if (newmode == PreviousAttr)
189	returnCode(OK);
190
191    pair = PAIR_NUMBER(newmode);
192
193    if (reverse) {
194	newmode &= ~A_REVERSE;
195    }
196
197    turn_off = (~newmode & PreviousAttr) & ALL_BUT_COLOR;
198    turn_on = (newmode & ~PreviousAttr) & ALL_BUT_COLOR;
199
200    SetColorsIf(((pair == 0) && !fix_pair0), PreviousAttr);
201
202    if (newmode == A_NORMAL) {
203	if ((PreviousAttr & A_ALTCHARSET) && exit_alt_charset_mode) {
204	    doPut(exit_alt_charset_mode);
205	    PreviousAttr &= ~A_ALTCHARSET;
206	}
207	if (PreviousAttr) {
208	    if (exit_attribute_mode) {
209		doPut(exit_attribute_mode);
210	    } else {
211		if (!SP || SP->_use_rmul) {
212		    TurnOff(A_UNDERLINE, exit_underline_mode);
213		}
214		if (!SP || SP->_use_rmso) {
215		    TurnOff(A_STANDOUT, exit_standout_mode);
216		}
217	    }
218	    PreviousAttr &= ALL_BUT_COLOR;
219	}
220
221	SetColorsIf((pair != 0) || fix_pair0, PreviousAttr);
222    } else if (set_attributes) {
223	if (turn_on || turn_off) {
224	    TPUTS_TRACE("set_attributes");
225	    tputs(tparm(set_attributes,
226			(newmode & A_STANDOUT) != 0,
227			(newmode & A_UNDERLINE) != 0,
228			(newmode & A_REVERSE) != 0,
229			(newmode & A_BLINK) != 0,
230			(newmode & A_DIM) != 0,
231			(newmode & A_BOLD) != 0,
232			(newmode & A_INVIS) != 0,
233			(newmode & A_PROTECT) != 0,
234			(newmode & A_ALTCHARSET) != 0), 1, outc);
235	    PreviousAttr &= ALL_BUT_COLOR;
236	}
237	SetColorsIf((pair != 0) || fix_pair0, PreviousAttr);
238    } else {
239
240	TR(TRACE_ATTRS, ("turning %s off", _traceattr(turn_off)));
241
242	TurnOff(A_ALTCHARSET, exit_alt_charset_mode);
243
244	if (!SP || SP->_use_rmul) {
245	    TurnOff(A_UNDERLINE, exit_underline_mode);
246	}
247
248	if (!SP || SP->_use_rmso) {
249	    TurnOff(A_STANDOUT, exit_standout_mode);
250	}
251
252	if (turn_off && exit_attribute_mode) {
253	    doPut(exit_attribute_mode);
254	    turn_on |= (newmode & ALL_BUT_COLOR);
255	    PreviousAttr &= ALL_BUT_COLOR;
256	}
257	SetColorsIf((pair != 0) || fix_pair0, PreviousAttr);
258
259	TR(TRACE_ATTRS, ("turning %s on", _traceattr(turn_on)));
260	/* *INDENT-OFF* */
261	TurnOn(A_ALTCHARSET,	enter_alt_charset_mode);
262	TurnOn(A_BLINK,		enter_blink_mode);
263	TurnOn(A_BOLD,		enter_bold_mode);
264	TurnOn(A_DIM,		enter_dim_mode);
265	TurnOn(A_REVERSE,	enter_reverse_mode);
266	TurnOn(A_STANDOUT,	enter_standout_mode);
267	TurnOn(A_PROTECT,	enter_protected_mode);
268	TurnOn(A_INVIS,		enter_secure_mode);
269	TurnOn(A_UNDERLINE,	enter_underline_mode);
270#if USE_WIDEC_SUPPORT
271	TurnOn(A_HORIZONTAL,	enter_horizontal_hl_mode);
272	TurnOn(A_LEFT,		enter_left_hl_mode);
273	TurnOn(A_LOW,		enter_low_hl_mode);
274	TurnOn(A_RIGHT,		enter_right_hl_mode);
275	TurnOn(A_TOP,		enter_top_hl_mode);
276	TurnOn(A_VERTICAL,	enter_vertical_hl_mode);
277#endif
278	/* *INDENT-ON* */
279
280    }
281
282    if (reverse)
283	newmode |= A_REVERSE;
284
285    if (SP)
286	SetAttr(SCREEN_ATTRS(SP), newmode);
287    else
288	PreviousAttr = newmode;
289
290    returnCode(OK);
291}
292
293NCURSES_EXPORT(int)
294vidattr(chtype newmode)
295{
296    T((T_CALLED("vidattr(%s)"), _traceattr(newmode)));
297
298    returnCode(vidputs(newmode, _nc_outch));
299}
300
301NCURSES_EXPORT(chtype)
302termattrs(void)
303{
304    chtype attrs = A_NORMAL;
305
306    T((T_CALLED("termattrs()")));
307    if (enter_alt_charset_mode)
308	attrs |= A_ALTCHARSET;
309
310    if (enter_blink_mode)
311	attrs |= A_BLINK;
312
313    if (enter_bold_mode)
314	attrs |= A_BOLD;
315
316    if (enter_dim_mode)
317	attrs |= A_DIM;
318
319    if (enter_reverse_mode)
320	attrs |= A_REVERSE;
321
322    if (enter_standout_mode)
323	attrs |= A_STANDOUT;
324
325    if (enter_protected_mode)
326	attrs |= A_PROTECT;
327
328    if (enter_secure_mode)
329	attrs |= A_INVIS;
330
331    if (enter_underline_mode)
332	attrs |= A_UNDERLINE;
333
334    if (SP->_coloron)
335	attrs |= A_COLOR;
336
337    returnChar(attrs);
338}
339