1 /****************************************************************************
2 * Copyright (c) 1998-2005,2006 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 ****************************************************************************/
36 * vidputs(newmode, outc)
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.
42 * if the new attribute is normal
43 * if exit-alt-char-set exists
45 * emit exit-attribute-mode
46 * else if set-attributes exists
47 * use it to set exactly what you want
49 * if exit-attribute-mode exists
52 * turn off those which can be turned off and aren't in
54 * turn on each mode which should be on and isn't, one by one
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...
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.
65 #include <curses.priv.h>
68 MODULE_ID("$Id: lib_vidattr.c,v 1.46 2006/01/21 23:39:40 tom Exp $")
70 #define doPut(mode) TPUTS_TRACE(#mode); tputs(mode, 1, outc)
72 #define TurnOn(mask,mode) \
73 if ((turn_on & mask) && mode) { doPut(mode); }
75 #define TurnOff(mask,mode) \
76 if ((turn_off & mask) && mode) { doPut(mode); turn_off &= ~mask; }
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); \
91 vidputs(chtype newmode, int (*outc) (int))
93 static attr_t previous_attr = A_NORMAL;
94 attr_t turn_on, turn_off;
97 bool can_color = (SP == 0 || SP->_coloron);
99 bool fix_pair0 = (SP != 0 && SP->_coloron && !SP->_default_color);
101 #define fix_pair0 FALSE
104 T((T_CALLED("vidputs(%s)"), _traceattr(newmode)));
106 /* this allows us to go on whether or not newterm() has been called */
108 previous_attr = AttrOf(SCREEN_ATTRS(SP));
110 TR(TRACE_ATTRS, ("previous attribute was %s", _traceattr(previous_attr)));
113 && (magic_cookie_glitch > 0)) {
115 static chtype table[] =
128 int limit = (max_attributes <= 0) ? 1 : max_attributes;
132 * Limit the number of attribute bits set in the newmode according to
133 * the terminfo max_attributes value.
135 for (n = 0; n < SIZEOF(table); ++n) {
136 if ((table[n] & SP->_ok_attributes) == 0) {
137 newmode &= ~table[n];
138 } else if ((table[n] & newmode) != 0) {
139 if (used++ >= limit) {
140 newmode &= ~table[n];
141 if (newmode == retain)
149 newmode &= ~(SP->_xmc_suppress);
151 TR(TRACE_ATTRS, ("suppressed attribute is %s", _traceattr(newmode)));
155 * If we have a terminal that cannot combine color with video
156 * attributes, use the colors in preference.
158 if (((newmode & A_COLOR) != 0
160 && (no_color_video > 0)) {
162 * If we had chosen the A_xxx definitions to correspond to the
163 * no_color_video mask, we could simply shift it up and mask off the
164 * attributes. But we did not (actually copied Solaris' definitions).
165 * However, this is still simpler/faster than a lookup table.
167 * The 63 corresponds to A_STANDOUT, A_UNDERLINE, A_REVERSE, A_BLINK,
168 * A_DIM, A_BOLD which are 1:1 with no_color_video. The bits that
169 * correspond to A_INVIS, A_PROTECT (192) must be shifted up 1 and
170 * A_ALTCHARSET (256) down 2 to line up. We use the NCURSES_BITS
171 * macro so this will work properly for the wide-character layout.
173 unsigned value = no_color_video;
174 attr_t mask = NCURSES_BITS((value & 63)
175 | ((value & 192) << 1)
176 | ((value & 256) >> 2), 8);
178 if ((mask & A_REVERSE) != 0
179 && (newmode & A_REVERSE) != 0) {
186 if (newmode == previous_attr)
189 pair = PAIR_NUMBER(newmode);
192 newmode &= ~A_REVERSE;
195 turn_off = (~newmode & previous_attr) & ALL_BUT_COLOR;
196 turn_on = (newmode & ~previous_attr) & ALL_BUT_COLOR;
198 SetColorsIf(((pair == 0) && !fix_pair0), previous_attr);
200 if (newmode == A_NORMAL) {
201 if ((previous_attr & A_ALTCHARSET) && exit_alt_charset_mode) {
202 doPut(exit_alt_charset_mode);
203 previous_attr &= ~A_ALTCHARSET;
206 if (exit_attribute_mode) {
207 doPut(exit_attribute_mode);
209 if (!SP || SP->_use_rmul) {
210 TurnOff(A_UNDERLINE, exit_underline_mode);
212 if (!SP || SP->_use_rmso) {
213 TurnOff(A_STANDOUT, exit_standout_mode);
216 previous_attr &= ALL_BUT_COLOR;
219 SetColorsIf((pair != 0) || fix_pair0, previous_attr);
220 } else if (set_attributes) {
221 if (turn_on || turn_off) {
222 TPUTS_TRACE("set_attributes");
223 tputs(tparm(set_attributes,
224 (newmode & A_STANDOUT) != 0,
225 (newmode & A_UNDERLINE) != 0,
226 (newmode & A_REVERSE) != 0,
227 (newmode & A_BLINK) != 0,
228 (newmode & A_DIM) != 0,
229 (newmode & A_BOLD) != 0,
230 (newmode & A_INVIS) != 0,
231 (newmode & A_PROTECT) != 0,
232 (newmode & A_ALTCHARSET) != 0), 1, outc);
233 previous_attr &= ALL_BUT_COLOR;
235 SetColorsIf((pair != 0) || fix_pair0, previous_attr);
238 TR(TRACE_ATTRS, ("turning %s off", _traceattr(turn_off)));
240 TurnOff(A_ALTCHARSET, exit_alt_charset_mode);
242 if (!SP || SP->_use_rmul) {
243 TurnOff(A_UNDERLINE, exit_underline_mode);
246 if (!SP || SP->_use_rmso) {
247 TurnOff(A_STANDOUT, exit_standout_mode);
250 if (turn_off && exit_attribute_mode) {
251 doPut(exit_attribute_mode);
252 turn_on |= (newmode & ALL_BUT_COLOR);
253 previous_attr &= ALL_BUT_COLOR;
255 SetColorsIf((pair != 0) || fix_pair0, previous_attr);
257 TR(TRACE_ATTRS, ("turning %s on", _traceattr(turn_on)));
259 TurnOn(A_ALTCHARSET, enter_alt_charset_mode);
260 TurnOn(A_BLINK, enter_blink_mode);
261 TurnOn(A_BOLD, enter_bold_mode);
262 TurnOn(A_DIM, enter_dim_mode);
263 TurnOn(A_REVERSE, enter_reverse_mode);
264 TurnOn(A_STANDOUT, enter_standout_mode);
265 TurnOn(A_PROTECT, enter_protected_mode);
266 TurnOn(A_INVIS, enter_secure_mode);
267 TurnOn(A_UNDERLINE, enter_underline_mode);
268 #if USE_WIDEC_SUPPORT
269 TurnOn(A_HORIZONTAL, enter_horizontal_hl_mode);
270 TurnOn(A_LEFT, enter_left_hl_mode);
271 TurnOn(A_LOW, enter_low_hl_mode);
272 TurnOn(A_RIGHT, enter_right_hl_mode);
273 TurnOn(A_TOP, enter_top_hl_mode);
274 TurnOn(A_VERTICAL, enter_vertical_hl_mode);
281 newmode |= A_REVERSE;
284 SetAttr(SCREEN_ATTRS(SP), newmode);
286 previous_attr = newmode;
292 vidattr(chtype newmode)
294 T((T_CALLED("vidattr(%s)"), _traceattr(newmode)));
296 returnCode(vidputs(newmode, _nc_outch));
299 NCURSES_EXPORT(chtype)
302 chtype attrs = A_NORMAL;
304 T((T_CALLED("termattrs()")));
305 if (enter_alt_charset_mode)
306 attrs |= A_ALTCHARSET;
308 if (enter_blink_mode)
317 if (enter_reverse_mode)
320 if (enter_standout_mode)
323 if (enter_protected_mode)
326 if (enter_secure_mode)
329 if (enter_underline_mode)
330 attrs |= A_UNDERLINE;