ncurses 5.3
[ncurses.git] / panel / panel.priv.h
1 /****************************************************************************
2  * Copyright (c) 2000 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 /* $Id: panel.priv.h,v 1.19 2001/06/02 23:31:05 tom Exp $ */
30
31 #ifndef NCURSES_PANEL_PRIV_H
32 #define NCURSES_PANEL_PRIV_H 1
33
34 #if HAVE_CONFIG_H
35 #  include <ncurses_cfg.h>
36 #endif
37
38 #include <stdlib.h>
39 #include <string.h>
40 #include <assert.h>
41
42 #if HAVE_LIBDMALLOC
43 #  include <dmalloc.h>    /* Gray Watson's library */
44 #endif
45
46 #if HAVE_LIBDBMALLOC
47 #  include <dbmalloc.h>   /* Conor Cahill's library */
48 #endif
49
50 #include "curses.priv.h"
51 #include "panel.h"
52 #include <nc_panel.h>
53
54 #if ( CC_HAS_INLINE_FUNCS && !defined(TRACE) )
55 #  define INLINE inline
56 #else
57 #  define INLINE
58 #endif
59
60 #if USE_RCS_IDS
61 #  define MODULE_ID(id) static const char Ident[] = id;
62 #else
63 #  define MODULE_ID(id) /*nothing*/
64 #endif
65
66
67 #ifdef TRACE
68    extern NCURSES_EXPORT(const char *) _nc_my_visbuf (const void *);
69 #  ifdef TRACE_TXT
70 #    define USER_PTR(ptr) _nc_visbuf((const char *)ptr)
71 #  else
72 #    define USER_PTR(ptr) _nc_my_visbuf((const char *)ptr)
73 #  endif
74
75    extern NCURSES_EXPORT(void) _nc_dPanel (const char*, const PANEL*);
76    extern NCURSES_EXPORT(void) _nc_dStack (const char*, int, const PANEL*);
77    extern NCURSES_EXPORT(void) _nc_Wnoutrefresh (const PANEL*);
78    extern NCURSES_EXPORT(void) _nc_Touchpan (const PANEL*);
79    extern NCURSES_EXPORT(void) _nc_Touchline (const PANEL*, int, int);
80
81 #  define dBug(x) _tracef x
82 #  define dPanel(text,pan) _nc_dPanel(text,pan)
83 #  define dStack(fmt,num,pan) _nc_dStack(fmt,num,pan)
84 #  define Wnoutrefresh(pan) _nc_Wnoutrefresh(pan)
85 #  define Touchpan(pan) _nc_Touchpan(pan)
86 #  define Touchline(pan,start,count) _nc_Touchline(pan,start,count)
87 #else /* !TRACE */
88 #  define dBug(x)
89 #  define dPanel(text,pan)
90 #  define dStack(fmt,num,pan)
91 #  define Wnoutrefresh(pan) wnoutrefresh((pan)->win)
92 #  define Touchpan(pan) touchwin((pan)->win)
93 #  define Touchline(pan,start,count) touchline((pan)->win,start,count)
94 #endif
95
96 #define _nc_stdscr_pseudo_panel _nc_panelhook()->stdscr_pseudo_panel
97 #define _nc_top_panel _nc_panelhook()->top_panel
98 #define _nc_bottom_panel _nc_panelhook()->bottom_panel
99
100 #define EMPTY_STACK() (_nc_top_panel==_nc_bottom_panel)
101 #define Is_Bottom(p)  (((p)!=(PANEL*)0) && !EMPTY_STACK() && (_nc_bottom_panel->above==(p))) 
102 #define Is_Top(p) (((p)!=(PANEL*)0) && !EMPTY_STACK() && (_nc_top_panel==(p)))
103 #define Is_Pseudo(p) ((p) && ((p)==_nc_bottom_panel))
104
105 /*+-------------------------------------------------------------------------
106         IS_LINKED(pan) - check to see if panel is in the stack
107 --------------------------------------------------------------------------*/
108 /* This works! The only case where it would fail is, when the list has
109    only one element. But this could only be the pseudo panel at the bottom */
110 #define IS_LINKED(p) (((p)->above || (p)->below ||((p)==_nc_bottom_panel)) ? TRUE : FALSE)
111
112 #define PSTARTX(pan) ((pan)->win->_begx)
113 #define PENDX(pan)   ((pan)->win->_begx + getmaxx((pan)->win) - 1)
114 #define PSTARTY(pan) ((pan)->win->_begy)
115 #define PENDY(pan)   ((pan)->win->_begy + getmaxy((pan)->win) - 1)
116
117 /*+-------------------------------------------------------------------------
118         PANELS_OVERLAPPED(pan1,pan2) - check panel overlapped
119 ---------------------------------------------------------------------------*/
120 #define PANELS_OVERLAPPED(pan1,pan2) \
121 (( !(pan1) || !(pan2) || \
122        PSTARTY(pan1) > PENDY(pan2) || PENDY(pan1) < PSTARTY(pan2) ||\
123        PSTARTX(pan1) > PENDX(pan2) || PENDX(pan1) < PSTARTX(pan2) ) \
124      ? FALSE : TRUE)
125
126
127 /*+-------------------------------------------------------------------------
128         Compute the intersection rectangle of two overlapping rectangles
129 ---------------------------------------------------------------------------*/
130 #define COMPUTE_INTERSECTION(pan1,pan2,ix1,ix2,iy1,iy2)\
131    ix1 = (PSTARTX(pan1) < PSTARTX(pan2)) ? PSTARTX(pan2) : PSTARTX(pan1);\
132    ix2 = (PENDX(pan1)   < PENDX(pan2))   ? PENDX(pan1)   : PENDX(pan2);\
133    iy1 = (PSTARTY(pan1) < PSTARTY(pan2)) ? PSTARTY(pan2) : PSTARTY(pan1);\
134    iy2 = (PENDY(pan1)   < PENDY(pan2))   ? PENDY(pan1)   : PENDY(pan2);\
135    assert((ix1<=ix2) && (iy1<=iy2));\
136
137
138 /*+-------------------------------------------------------------------------
139         Walk through the panel stack starting at the given location and
140         check for intersections; overlapping panels are "touched", so they
141         are incrementally overwriting cells that should be hidden. 
142         If the "touch" flag is set, the panel gets touched before it is
143         updated. 
144 ---------------------------------------------------------------------------*/
145 #define PANEL_UPDATE(pan,panstart)\
146 {  PANEL* pan2 = ((panstart) ? (panstart) : _nc_bottom_panel);\
147    while(pan2) {\
148       if ((pan2 != pan) && PANELS_OVERLAPPED(pan,pan2)) {\
149         int y,ix1,ix2,iy1,iy2;\
150         COMPUTE_INTERSECTION(pan,pan2,ix1,ix2,iy1,iy2);\
151         for(y = iy1; y <= iy2; y++) {\
152           if (is_linetouched(pan->win,y - PSTARTY(pan))) {\
153             struct ldat* line = &(pan2->win->_line[y - PSTARTY(pan2)]);\
154             CHANGED_RANGE(line,ix1-PSTARTX(pan2),ix2-PSTARTX(pan2));\
155           }\
156         }\
157       }\
158       pan2 = pan2->above;\
159    }\
160 }
161
162 /*+-------------------------------------------------------------------------
163         Remove panel from stack.
164 ---------------------------------------------------------------------------*/
165 #define PANEL_UNLINK(pan,err) \
166 {  err = ERR;\
167    if (pan) {\
168      if (IS_LINKED(pan)) {\
169        if ((pan)->below)\
170          (pan)->below->above = (pan)->above;\
171        if ((pan)->above)\
172          (pan)->above->below = (pan)->below;\
173        if ((pan) == _nc_bottom_panel) \
174          _nc_bottom_panel = (pan)->above;\
175        if ((pan) == _nc_top_panel) \
176          _nc_top_panel = (pan)->below;\
177        err = OK;\
178      }\
179      (pan)->above = (pan)->below = (PANEL*)0;\
180    }\
181 }
182
183 #define HIDE_PANEL(pan,err,err_if_unlinked)\
184   if (IS_LINKED(pan)) {\
185     Touchpan(pan);\
186     PANEL_UPDATE(pan,(PANEL*)0);\
187     PANEL_UNLINK(pan,err);\
188   } \
189   else {\
190       err = err_if_unlinked;\
191   }
192
193 #endif /* NCURSES_PANEL_PRIV_H */