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