8ef39847b343cc460805be66d27c6c4d5c704882
[ncurses.git] / panel / panel.c
1 /****************************************************************************
2  * Copyright (c) 1998-2005,2009 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 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Juergen Pfeifer                         1996-1999,2008          *
33  *     and: Thomas E. Dickey                                                *
34  ****************************************************************************/
35
36 /* panel.c -- implementation of panels library, some core routines */
37 #include "panel.priv.h"
38
39 MODULE_ID("$Id: panel.c,v 1.24 2009/04/11 21:29:10 tom Exp $")
40
41 /*+-------------------------------------------------------------------------
42         _nc_retrace_panel (pan)
43 --------------------------------------------------------------------------*/
44 #ifdef TRACE
45 NCURSES_EXPORT(PANEL *)
46 _nc_retrace_panel(PANEL * pan)
47 {
48   T((T_RETURN("%p"), pan));
49   return pan;
50 }
51 #endif
52
53 /*+-------------------------------------------------------------------------
54         _nc_my_visbuf(ptr)
55 --------------------------------------------------------------------------*/
56 #ifdef TRACE
57 #ifndef TRACE_TXT
58 NCURSES_EXPORT(const char *)
59 _nc_my_visbuf(const void *ptr)
60 {
61   char temp[32];
62
63   if (ptr != 0)
64     sprintf(temp, "ptr:%p", ptr);
65   else
66     strcpy(temp, "<null>");
67   return _nc_visbuf(temp);
68 }
69 #endif
70 #endif
71
72 /*+-------------------------------------------------------------------------
73         dPanel(text,pan)
74 --------------------------------------------------------------------------*/
75 #ifdef TRACE
76 NCURSES_EXPORT(void)
77 _nc_dPanel(const char *text, const PANEL * pan)
78 {
79   _tracef("%s id=%s b=%s a=%s y=%d x=%d",
80           text, USER_PTR(pan->user),
81           (pan->below) ? USER_PTR(pan->below->user) : "--",
82           (pan->above) ? USER_PTR(pan->above->user) : "--",
83           PSTARTY(pan), PSTARTX(pan));
84 }
85 #endif
86
87 /*+-------------------------------------------------------------------------
88         dStack(fmt,num,pan)
89 --------------------------------------------------------------------------*/
90 #ifdef TRACE
91 NCURSES_EXPORT(void)
92 _nc_dStack(const char *fmt, int num, const PANEL * pan)
93 {
94   char s80[80];
95
96   GetPanelHook(pan);
97
98   sprintf(s80, fmt, num, pan);
99   _tracef("%s b=%s t=%s", s80,
100           (_nc_bottom_panel) ? USER_PTR(_nc_bottom_panel->user) : "--",
101           (_nc_top_panel) ? USER_PTR(_nc_top_panel->user) : "--");
102   if (pan)
103     _tracef("pan id=%s", USER_PTR(pan->user));
104   pan = _nc_bottom_panel;
105   while (pan)
106     {
107       dPanel("stk", pan);
108       pan = pan->above;
109     }
110 }
111 #endif
112
113 /*+-------------------------------------------------------------------------
114         Wnoutrefresh(pan) - debugging hook for wnoutrefresh
115 --------------------------------------------------------------------------*/
116 #ifdef TRACE
117 NCURSES_EXPORT(void)
118 _nc_Wnoutrefresh(const PANEL * pan)
119 {
120   dPanel("wnoutrefresh", pan);
121   wnoutrefresh(pan->win);
122 }
123 #endif
124
125 /*+-------------------------------------------------------------------------
126         Touchpan(pan)
127 --------------------------------------------------------------------------*/
128 #ifdef TRACE
129 NCURSES_EXPORT(void)
130 _nc_Touchpan(const PANEL * pan)
131 {
132   dPanel("Touchpan", pan);
133   touchwin(pan->win);
134 }
135 #endif
136
137 /*+-------------------------------------------------------------------------
138         Touchline(pan,start,count)
139 --------------------------------------------------------------------------*/
140 #ifdef TRACE
141 NCURSES_EXPORT(void)
142 _nc_Touchline(const PANEL * pan, int start, int count)
143 {
144   char s80[80];
145
146   sprintf(s80, "Touchline s=%d c=%d", start, count);
147   dPanel(s80, pan);
148   touchline(pan->win, start, count);
149 }
150 #endif
151
152 #ifndef TRACE
153 #  ifndef __GNUC__
154      /* Some C compilers need something defined in a source file */
155 extern void _nc_dummy_panel(void);
156 void
157 _nc_dummy_panel(void)
158 {
159 }
160 #  endif
161 #endif