1 /****************************************************************************
2 * Copyright (c) 1998-2001,2005 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.20 2005/02/19 17:16:54 tom Exp $ */
31 #ifndef NCURSES_PANEL_PRIV_H
32 #define NCURSES_PANEL_PRIV_H 1
35 # include <ncurses_cfg.h>
43 # include <dmalloc.h> /* Gray Watson's library */
47 # include <dbmalloc.h> /* Conor Cahill's library */
50 #include "curses.priv.h"
54 #if ( CC_HAS_INLINE_FUNCS && !defined(TRACE) )
55 # define INLINE inline
61 # define MODULE_ID(id) static const char Ident[] = id;
63 # define MODULE_ID(id) /*nothing*/
68 extern NCURSES_EXPORT(const char *) _nc_my_visbuf (const void *);
70 # define USER_PTR(ptr) _nc_visbuf((const char *)ptr)
72 # define USER_PTR(ptr) _nc_my_visbuf((const char *)ptr)
75 # define returnPanel(code) TRACE_RETURN(code,panel)
77 extern NCURSES_EXPORT(PANEL *) _nc_retrace_panel (PANEL *);
78 extern NCURSES_EXPORT(void) _nc_dPanel (const char*, const PANEL*);
79 extern NCURSES_EXPORT(void) _nc_dStack (const char*, int, const PANEL*);
80 extern NCURSES_EXPORT(void) _nc_Wnoutrefresh (const PANEL*);
81 extern NCURSES_EXPORT(void) _nc_Touchpan (const PANEL*);
82 extern NCURSES_EXPORT(void) _nc_Touchline (const PANEL*, int, int);
84 # define dBug(x) _tracef x
85 # define dPanel(text,pan) _nc_dPanel(text,pan)
86 # define dStack(fmt,num,pan) _nc_dStack(fmt,num,pan)
87 # define Wnoutrefresh(pan) _nc_Wnoutrefresh(pan)
88 # define Touchpan(pan) _nc_Touchpan(pan)
89 # define Touchline(pan,start,count) _nc_Touchline(pan,start,count)
91 # define returnPanel(code) return code
93 # define dPanel(text,pan)
94 # define dStack(fmt,num,pan)
95 # define Wnoutrefresh(pan) wnoutrefresh((pan)->win)
96 # define Touchpan(pan) touchwin((pan)->win)
97 # define Touchline(pan,start,count) touchline((pan)->win,start,count)
100 #define _nc_stdscr_pseudo_panel _nc_panelhook()->stdscr_pseudo_panel
101 #define _nc_top_panel _nc_panelhook()->top_panel
102 #define _nc_bottom_panel _nc_panelhook()->bottom_panel
104 #define EMPTY_STACK() (_nc_top_panel==_nc_bottom_panel)
105 #define Is_Bottom(p) (((p)!=(PANEL*)0) && !EMPTY_STACK() && (_nc_bottom_panel->above==(p)))
106 #define Is_Top(p) (((p)!=(PANEL*)0) && !EMPTY_STACK() && (_nc_top_panel==(p)))
107 #define Is_Pseudo(p) ((p) && ((p)==_nc_bottom_panel))
109 /*+-------------------------------------------------------------------------
110 IS_LINKED(pan) - check to see if panel is in the stack
111 --------------------------------------------------------------------------*/
112 /* This works! The only case where it would fail is, when the list has
113 only one element. But this could only be the pseudo panel at the bottom */
114 #define IS_LINKED(p) (((p)->above || (p)->below ||((p)==_nc_bottom_panel)) ? TRUE : FALSE)
116 #define PSTARTX(pan) ((pan)->win->_begx)
117 #define PENDX(pan) ((pan)->win->_begx + getmaxx((pan)->win) - 1)
118 #define PSTARTY(pan) ((pan)->win->_begy)
119 #define PENDY(pan) ((pan)->win->_begy + getmaxy((pan)->win) - 1)
121 /*+-------------------------------------------------------------------------
122 PANELS_OVERLAPPED(pan1,pan2) - check panel overlapped
123 ---------------------------------------------------------------------------*/
124 #define PANELS_OVERLAPPED(pan1,pan2) \
125 (( !(pan1) || !(pan2) || \
126 PSTARTY(pan1) > PENDY(pan2) || PENDY(pan1) < PSTARTY(pan2) ||\
127 PSTARTX(pan1) > PENDX(pan2) || PENDX(pan1) < PSTARTX(pan2) ) \
131 /*+-------------------------------------------------------------------------
132 Compute the intersection rectangle of two overlapping rectangles
133 ---------------------------------------------------------------------------*/
134 #define COMPUTE_INTERSECTION(pan1,pan2,ix1,ix2,iy1,iy2)\
135 ix1 = (PSTARTX(pan1) < PSTARTX(pan2)) ? PSTARTX(pan2) : PSTARTX(pan1);\
136 ix2 = (PENDX(pan1) < PENDX(pan2)) ? PENDX(pan1) : PENDX(pan2);\
137 iy1 = (PSTARTY(pan1) < PSTARTY(pan2)) ? PSTARTY(pan2) : PSTARTY(pan1);\
138 iy2 = (PENDY(pan1) < PENDY(pan2)) ? PENDY(pan1) : PENDY(pan2);\
139 assert((ix1<=ix2) && (iy1<=iy2));\
142 /*+-------------------------------------------------------------------------
143 Walk through the panel stack starting at the given location and
144 check for intersections; overlapping panels are "touched", so they
145 are incrementally overwriting cells that should be hidden.
146 If the "touch" flag is set, the panel gets touched before it is
148 ---------------------------------------------------------------------------*/
149 #define PANEL_UPDATE(pan,panstart)\
150 { PANEL* pan2 = ((panstart) ? (panstart) : _nc_bottom_panel);\
152 if ((pan2 != pan) && PANELS_OVERLAPPED(pan,pan2)) {\
153 int y,ix1,ix2,iy1,iy2;\
154 COMPUTE_INTERSECTION(pan,pan2,ix1,ix2,iy1,iy2);\
155 for(y = iy1; y <= iy2; y++) {\
156 if (is_linetouched(pan->win,y - PSTARTY(pan))) {\
157 struct ldat* line = &(pan2->win->_line[y - PSTARTY(pan2)]);\
158 CHANGED_RANGE(line,ix1-PSTARTX(pan2),ix2-PSTARTX(pan2));\
166 /*+-------------------------------------------------------------------------
167 Remove panel from stack.
168 ---------------------------------------------------------------------------*/
169 #define PANEL_UNLINK(pan,err) \
172 if (IS_LINKED(pan)) {\
174 (pan)->below->above = (pan)->above;\
176 (pan)->above->below = (pan)->below;\
177 if ((pan) == _nc_bottom_panel) \
178 _nc_bottom_panel = (pan)->above;\
179 if ((pan) == _nc_top_panel) \
180 _nc_top_panel = (pan)->below;\
183 (pan)->above = (pan)->below = (PANEL*)0;\
187 #define HIDE_PANEL(pan,err,err_if_unlinked)\
188 if (IS_LINKED(pan)) {\
190 PANEL_UPDATE(pan,(PANEL*)0);\
191 PANEL_UNLINK(pan,err);\
194 err = err_if_unlinked;\
197 #endif /* NCURSES_PANEL_PRIV_H */