1 /****************************************************************************
2 * Copyright (c) 1998-2012,2014 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.26 2014/11/01 14:48:03 tom Exp $ */
31 #ifndef NCURSES_PANEL_PRIV_H
32 #define NCURSES_PANEL_PRIV_H 1
36 # include <ncurses_cfg.h>
43 struct screen; /* forward declaration */
45 #include "curses.priv.h" /* includes nc_panel.h */
50 # define MODULE_ID(id) static const char Ident[] = id;
52 # define MODULE_ID(id) /*nothing*/
57 extern NCURSES_EXPORT(const char *) _nc_my_visbuf (const void *);
59 # define USER_PTR(ptr) _nc_visbuf((const char *)ptr)
61 # define USER_PTR(ptr) _nc_my_visbuf((const char *)ptr)
64 # define returnPanel(code) TRACE_RETURN1(code,panel)
66 extern NCURSES_EXPORT(PANEL *) _nc_retrace_panel (PANEL *);
67 extern NCURSES_EXPORT(void) _nc_dPanel (const char*, const PANEL*);
68 extern NCURSES_EXPORT(void) _nc_dStack (const char*, int, const PANEL*);
69 extern NCURSES_EXPORT(void) _nc_Wnoutrefresh (const PANEL*);
70 extern NCURSES_EXPORT(void) _nc_Touchpan (const PANEL*);
71 extern NCURSES_EXPORT(void) _nc_Touchline (const PANEL*, int, int);
73 # define dBug(x) _tracef x
74 # define dPanel(text,pan) _nc_dPanel(text,pan)
75 # define dStack(fmt,num,pan) _nc_dStack(fmt,num,pan)
76 # define Wnoutrefresh(pan) _nc_Wnoutrefresh(pan)
77 # define Touchpan(pan) _nc_Touchpan(pan)
78 # define Touchline(pan,start,count) _nc_Touchline(pan,start,count)
80 # define returnPanel(code) return code
82 # define dPanel(text,pan)
83 # define dStack(fmt,num,pan)
84 # define Wnoutrefresh(pan) wnoutrefresh((pan)->win)
85 # define Touchpan(pan) touchwin((pan)->win)
86 # define Touchline(pan,start,count) touchline((pan)->win,start,count)
90 #define GetScreenHook(sp) \
91 struct panelhook* ph = NCURSES_SP_NAME(_nc_panelhook)(sp)
92 #define GetPanelHook(pan) \
93 GetScreenHook(pan ? _nc_screen_of((pan)->win) : 0)
94 #define GetWindowHook(win) \
95 SCREEN* sp = _nc_screen_of(win); \
97 #define GetHook(pan) SCREEN* sp = _nc_screen_of(pan->win); \
100 #define _nc_stdscr_pseudo_panel ((ph)->stdscr_pseudo_panel)
101 #define _nc_top_panel ((ph)->top_panel)
102 #define _nc_bottom_panel ((ph)->bottom_panel)
104 #else /* !NCURSES_SP_FUNCS */
106 #define GetScreenHook(sp) /* nothing */
107 #define GetPanelHook(pan) /* nothing */
108 #define GetWindowHook(win) /* nothing */
109 #define GetHook(pan) /* nothing */
111 #define _nc_stdscr_pseudo_panel _nc_panelhook()->stdscr_pseudo_panel
112 #define _nc_top_panel _nc_panelhook()->top_panel
113 #define _nc_bottom_panel _nc_panelhook()->bottom_panel
115 #endif /* NCURSES_SP_FUNCS */
117 #define EMPTY_STACK() (_nc_top_panel == _nc_bottom_panel)
118 #define Is_Bottom(p) (((p) != (PANEL*)0) && !EMPTY_STACK() && (_nc_bottom_panel->above == (p)))
119 #define Is_Top(p) (((p) != (PANEL*)0) && !EMPTY_STACK() && (_nc_top_panel == (p)))
120 #define Is_Pseudo(p) (((p) != (PANEL*)0) && ((p) == _nc_bottom_panel))
122 /*+-------------------------------------------------------------------------
123 IS_LINKED(pan) - check to see if panel is in the stack
124 --------------------------------------------------------------------------*/
125 /* This works! The only case where it would fail is, when the list has
126 only one element. But this could only be the pseudo panel at the bottom */
127 #define IS_LINKED(p) (((p)->above || (p)->below ||((p)==_nc_bottom_panel)) ? TRUE : FALSE)
129 #define PSTARTX(pan) ((pan)->win->_begx)
130 #define PENDX(pan) ((pan)->win->_begx + getmaxx((pan)->win) - 1)
131 #define PSTARTY(pan) ((pan)->win->_begy)
132 #define PENDY(pan) ((pan)->win->_begy + getmaxy((pan)->win) - 1)
134 /*+-------------------------------------------------------------------------
135 PANELS_OVERLAPPED(pan1,pan2) - check panel overlapped
136 ---------------------------------------------------------------------------*/
137 #define PANELS_OVERLAPPED(pan1,pan2) \
138 (( !(pan1) || !(pan2) || \
139 PSTARTY(pan1) > PENDY(pan2) || PENDY(pan1) < PSTARTY(pan2) ||\
140 PSTARTX(pan1) > PENDX(pan2) || PENDX(pan1) < PSTARTX(pan2) ) \
144 /*+-------------------------------------------------------------------------
145 Compute the intersection rectangle of two overlapping rectangles
146 ---------------------------------------------------------------------------*/
147 #define COMPUTE_INTERSECTION(pan1,pan2,ix1,ix2,iy1,iy2)\
148 ix1 = (PSTARTX(pan1) < PSTARTX(pan2)) ? PSTARTX(pan2) : PSTARTX(pan1);\
149 ix2 = (PENDX(pan1) < PENDX(pan2)) ? PENDX(pan1) : PENDX(pan2);\
150 iy1 = (PSTARTY(pan1) < PSTARTY(pan2)) ? PSTARTY(pan2) : PSTARTY(pan1);\
151 iy2 = (PENDY(pan1) < PENDY(pan2)) ? PENDY(pan1) : PENDY(pan2);\
152 assert((ix1<=ix2) && (iy1<=iy2))
155 /*+-------------------------------------------------------------------------
156 Walk through the panel stack starting at the given location and
157 check for intersections; overlapping panels are "touched", so they
158 are incrementally overwriting cells that should be hidden.
159 If the "touch" flag is set, the panel gets touched before it is
161 ---------------------------------------------------------------------------*/
162 #define PANEL_UPDATE(pan,panstart)\
163 { PANEL* pan2 = ((panstart) ? (panstart) : _nc_bottom_panel);\
164 while(pan2 && pan2->win) {\
165 if ((pan2 != pan) && PANELS_OVERLAPPED(pan,pan2)) {\
166 int y, ix1, ix2, iy1, iy2;\
167 COMPUTE_INTERSECTION(pan, pan2, ix1, ix2, iy1, iy2);\
168 for(y = iy1; y <= iy2; y++) {\
169 if (is_linetouched(pan->win,y - PSTARTY(pan))) {\
170 struct ldat* line = &(pan2->win->_line[y - PSTARTY(pan2)]);\
171 CHANGED_RANGE(line, ix1 - PSTARTX(pan2), ix2 - PSTARTX(pan2));\
179 /*+-------------------------------------------------------------------------
180 Remove panel from stack.
181 ---------------------------------------------------------------------------*/
182 #define PANEL_UNLINK(pan,err) \
185 if (IS_LINKED(pan)) {\
187 (pan)->below->above = (pan)->above;\
189 (pan)->above->below = (pan)->below;\
190 if ((pan) == _nc_bottom_panel) \
191 _nc_bottom_panel = (pan)->above;\
192 if ((pan) == _nc_top_panel) \
193 _nc_top_panel = (pan)->below;\
196 (pan)->above = (pan)->below = (PANEL*)0;\
200 #define HIDE_PANEL(pan,err,err_if_unlinked)\
201 if (IS_LINKED(pan)) {\
203 PANEL_UPDATE(pan,(PANEL*)0);\
204 PANEL_UNLINK(pan,err);\
207 err = err_if_unlinked;\
211 /* These may become later renamed and part of panel.h and the public API */
212 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_update_panels)(SCREEN*);
216 #endif /* NCURSES_PANEL_PRIV_H */