ncurses 5.6 - patch 20071222
[ncurses.git] / ncurses / base / lib_bkgd.c
1 /****************************************************************************
2  * Copyright (c) 1998-2005,2006 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: Juergen Pfeifer                         1997                    *
33  *     and: Sven Verdoolaege                        2000                    *
34  *     and: Thomas E. Dickey                        1996-on                 *
35  ****************************************************************************/
36
37 #include <curses.priv.h>
38
39 MODULE_ID("$Id: lib_bkgd.c,v 1.35 2006/05/27 19:20:11 tom Exp $")
40
41 /*
42  * Set the window's background information.
43  */
44 #if USE_WIDEC_SUPPORT
45 NCURSES_EXPORT(void)
46 #else
47 static NCURSES_INLINE void
48 #endif
49 wbkgrndset(WINDOW *win, const ARG_CH_T ch)
50 {
51     T((T_CALLED("wbkgdset(%p,%s)"), win, _tracech_t(ch)));
52
53     if (win) {
54         attr_t off = AttrOf(win->_nc_bkgd);
55         attr_t on = AttrOf(CHDEREF(ch));
56
57         toggle_attr_off(WINDOW_ATTRS(win), off);
58         toggle_attr_on(WINDOW_ATTRS(win), on);
59
60 #if NCURSES_EXT_COLORS
61         {
62             int pair;
63
64             if ((pair = GetPair(win->_nc_bkgd)) != 0)
65                 SET_WINDOW_PAIR(win, 0);
66             if ((pair = GetPair(CHDEREF(ch))) != 0)
67                 SET_WINDOW_PAIR(win, pair);
68         }
69 #endif
70
71         if (CharOf(CHDEREF(ch)) == L('\0')) {
72             SetChar(win->_nc_bkgd, BLANK_TEXT, AttrOf(CHDEREF(ch)));
73             SetPair(win->_nc_bkgd, GetPair(CHDEREF(ch)));
74         } else {
75             win->_nc_bkgd = CHDEREF(ch);
76         }
77 #if USE_WIDEC_SUPPORT
78         /*
79          * If we're compiled for wide-character support, _bkgrnd is the
80          * preferred location for the background information since it stores
81          * more than _bkgd.  Update _bkgd each time we modify _bkgrnd, so the
82          * macro getbkgd() will work.
83          */
84         {
85             cchar_t wch;
86             int tmp;
87
88             wgetbkgrnd(win, &wch);
89             tmp = _nc_to_char((wint_t) CharOf(wch));
90
91             win->_bkgd = (((tmp == EOF) ? ' ' : (chtype) tmp)
92                           | (AttrOf(wch) & ALL_BUT_COLOR)
93                           | COLOR_PAIR(GET_WINDOW_PAIR(win)));
94         }
95 #endif
96     }
97     returnVoid;
98 }
99
100 NCURSES_EXPORT(void)
101 wbkgdset(WINDOW *win, chtype ch)
102 {
103     NCURSES_CH_T wch;
104     SetChar2(wch, ch);
105     wbkgrndset(win, CHREF(wch));
106 }
107
108 /*
109  * Set the window's background information and apply it to each cell.
110  */
111 #if USE_WIDEC_SUPPORT
112 NCURSES_EXPORT(int)
113 #else
114 static NCURSES_INLINE int
115 #undef wbkgrnd
116 #endif
117 wbkgrnd(WINDOW *win, const ARG_CH_T ch)
118 {
119     int code = ERR;
120     int x, y;
121     NCURSES_CH_T new_bkgd = CHDEREF(ch);
122
123     T((T_CALLED("wbkgd(%p,%s)"), win, _tracech_t(ch)));
124
125     if (win) {
126         NCURSES_CH_T old_bkgrnd;
127         wgetbkgrnd(win, &old_bkgrnd);
128
129         wbkgrndset(win, CHREF(new_bkgd));
130         wattrset(win, AttrOf(win->_nc_bkgd));
131
132         for (y = 0; y <= win->_maxy; y++) {
133             for (x = 0; x <= win->_maxx; x++) {
134                 if (CharEq(win->_line[y].text[x], old_bkgrnd)) {
135                     win->_line[y].text[x] = win->_nc_bkgd;
136                 } else {
137                     NCURSES_CH_T wch = win->_line[y].text[x];
138                     RemAttr(wch, (~(A_ALTCHARSET | A_CHARTEXT)));
139                     win->_line[y].text[x] = _nc_render(win, wch);
140                 }
141             }
142         }
143         touchwin(win);
144         _nc_synchook(win);
145         code = OK;
146     }
147     returnCode(code);
148 }
149
150 NCURSES_EXPORT(int)
151 wbkgd(WINDOW *win, chtype ch)
152 {
153     NCURSES_CH_T wch;
154     SetChar2(wch, ch);
155     return wbkgrnd(win, CHREF(wch));
156 }