1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 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 /* $Id: panel.priv.h,v 1.23 2009/04/11 20:33:55 tom Exp $ */
31 #ifndef NCURSES_PANEL_PRIV_H
32 #define NCURSES_PANEL_PRIV_H 1
35 # include <ncurses_cfg.h>
42 struct screen
; /* forward declaration */
44 #include "curses.priv.h" /* includes nc_panel.h */
49 # define MODULE_ID(id) static const char Ident[] = id;
51 # define MODULE_ID(id) /*nothing*/
56 extern NCURSES_EXPORT(const char *) _nc_my_visbuf (const void *);
58 # define USER_PTR(ptr) _nc_visbuf((const char *)ptr)
60 # define USER_PTR(ptr) _nc_my_visbuf((const char *)ptr)
63 # define returnPanel(code) TRACE_RETURN(code,panel)
65 extern NCURSES_EXPORT(PANEL
*) _nc_retrace_panel (PANEL
*);
66 extern NCURSES_EXPORT(void) _nc_dPanel (const char*, const PANEL
*);
67 extern NCURSES_EXPORT(void) _nc_dStack (const char*, int, const PANEL
*);
68 extern NCURSES_EXPORT(void) _nc_Wnoutrefresh (const PANEL
*);
69 extern NCURSES_EXPORT(void) _nc_Touchpan (const PANEL
*);
70 extern NCURSES_EXPORT(void) _nc_Touchline (const PANEL
*, int, int);
72 # define dBug(x) _tracef x
73 # define dPanel(text,pan) _nc_dPanel(text,pan)
74 # define dStack(fmt,num,pan) _nc_dStack(fmt,num,pan)
75 # define Wnoutrefresh(pan) _nc_Wnoutrefresh(pan)
76 # define Touchpan(pan) _nc_Touchpan(pan)
77 # define Touchline(pan,start,count) _nc_Touchline(pan,start,count)
79 # define returnPanel(code) return code
81 # define dPanel(text,pan)
82 # define dStack(fmt,num,pan)
83 # define Wnoutrefresh(pan) wnoutrefresh((pan)->win)
84 # define Touchpan(pan) touchwin((pan)->win)
85 # define Touchline(pan,start,count) touchline((pan)->win,start,count)
89 #define GetScreenHook(sp) \
90 struct panelhook* ph = NCURSES_SP_NAME(_nc_panelhook)(sp)
91 #define GetPanelHook(pan) \
92 GetScreenHook(_nc_screen_of((pan)->win))
93 #define GetWindowHook(win) \
94 SCREEN* sp = _nc_screen_of(win); \
96 #define GetHook(pan) SCREEN* sp = _nc_screen_of(pan->win); \
99 #define _nc_stdscr_pseudo_panel ((ph)->stdscr_pseudo_panel)
100 #define _nc_top_panel ((ph)->top_panel)
101 #define _nc_bottom_panel ((ph)->bottom_panel)
103 #else /* !NCURSES_SP_FUNCS */
105 #define GetScreenHook(sp) /* nothing */
106 #define GetPanelHook(pan) /* nothing */
107 #define GetWindowHook(win) /* nothing */
108 #define GetHook(pan) /* nothing */
110 #define _nc_stdscr_pseudo_panel _nc_panelhook()->stdscr_pseudo_panel
111 #define _nc_top_panel _nc_panelhook()->top_panel
112 #define _nc_bottom_panel _nc_panelhook()->bottom_panel
114 #endif /* NCURSES_SP_FUNCS */
116 #define EMPTY_STACK() (_nc_top_panel == _nc_bottom_panel)
117 #define Is_Bottom(p) (((p) != (PANEL*)0) && !EMPTY_STACK() && (_nc_bottom_panel->above == (p)))
118 #define Is_Top(p) (((p) != (PANEL*)0) && !EMPTY_STACK() && (_nc_top_panel == (p)))
119 #define Is_Pseudo(p) (((p) != (PANEL*)0) && ((p) == _nc_bottom_panel))
121 /*+-------------------------------------------------------------------------
122 IS_LINKED(pan) - check to see if panel is in the stack
123 --------------------------------------------------------------------------*/
124 /* This works! The only case where it would fail is, when the list has
125 only one element. But this could only be the pseudo panel at the bottom */
126 #define IS_LINKED(p) (((p)->above || (p)->below ||((p)==_nc_bottom_panel)) ? TRUE : FALSE)
128 #define PSTARTX(pan) ((pan)->win->_begx)
129 #define PENDX(pan) ((pan)->win->_begx + getmaxx((pan)->win) - 1)
130 #define PSTARTY(pan) ((pan)->win->_begy)
131 #define PENDY(pan) ((pan)->win->_begy + getmaxy((pan)->win) - 1)
133 /*+-------------------------------------------------------------------------
134 PANELS_OVERLAPPED(pan1,pan2) - check panel overlapped
135 ---------------------------------------------------------------------------*/
136 #define PANELS_OVERLAPPED(pan1,pan2) \
137 (( !(pan1) || !(pan2) || \
138 PSTARTY(pan1) > PENDY(pan2) || PENDY(pan1) < PSTARTY(pan2) ||\
139 PSTARTX(pan1) > PENDX(pan2) || PENDX(pan1) < PSTARTX(pan2) ) \
143 /*+-------------------------------------------------------------------------
144 Compute the intersection rectangle of two overlapping rectangles
145 ---------------------------------------------------------------------------*/
146 #define COMPUTE_INTERSECTION(pan1,pan2,ix1,ix2,iy1,iy2)\
147 ix1 = (PSTARTX(pan1) < PSTARTX(pan2)) ? PSTARTX(pan2) : PSTARTX(pan1);\
148 ix2 = (PENDX(pan1) < PENDX(pan2)) ? PENDX(pan1) : PENDX(pan2);\
149 iy1 = (PSTARTY(pan1) < PSTARTY(pan2)) ? PSTARTY(pan2) : PSTARTY(pan1);\
150 iy2 = (PENDY(pan1) < PENDY(pan2)) ? PENDY(pan1) : PENDY(pan2);\
151 assert((ix1<=ix2) && (iy1<=iy2))
154 /*+-------------------------------------------------------------------------
155 Walk through the panel stack starting at the given location and
156 check for intersections; overlapping panels are "touched", so they
157 are incrementally overwriting cells that should be hidden.
158 If the "touch" flag is set, the panel gets touched before it is
160 ---------------------------------------------------------------------------*/
161 #define PANEL_UPDATE(pan,panstart)\
162 { PANEL* pan2 = ((panstart) ? (panstart) : _nc_bottom_panel);\
164 if ((pan2 != pan) && PANELS_OVERLAPPED(pan,pan2)) {\
165 int y, ix1, ix2, iy1, iy2;\
166 COMPUTE_INTERSECTION(pan, pan2, ix1, ix2, iy1, iy2);\
167 for(y = iy1; y <= iy2; y++) {\
168 if (is_linetouched(pan->win,y - PSTARTY(pan))) {\
169 struct ldat* line = &(pan2->win->_line[y - PSTARTY(pan2)]);\
170 CHANGED_RANGE(line, ix1 - PSTARTX(pan2), ix2 - PSTARTX(pan2));\
178 /*+-------------------------------------------------------------------------
179 Remove panel from stack.
180 ---------------------------------------------------------------------------*/
181 #define PANEL_UNLINK(pan,err) \
184 if (IS_LINKED(pan)) {\
186 (pan)->below->above = (pan)->above;\
188 (pan)->above->below = (pan)->below;\
189 if ((pan) == _nc_bottom_panel) \
190 _nc_bottom_panel = (pan)->above;\
191 if ((pan) == _nc_top_panel) \
192 _nc_top_panel = (pan)->below;\
195 (pan)->above = (pan)->below = (PANEL*)0;\
199 #define HIDE_PANEL(pan,err,err_if_unlinked)\
200 if (IS_LINKED(pan)) {\
202 PANEL_UPDATE(pan,(PANEL*)0);\
203 PANEL_UNLINK(pan,err);\
206 err = err_if_unlinked;\
210 /* These may become later renamed and part of panel.h and the public API */
211 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_update_panels
)(SCREEN
*);
214 #endif /* NCURSES_PANEL_PRIV_H */