ncurses 6.2 - patch 20210418
[ncurses.git] / panel / p_new.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2009,2010 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *     and: Juergen Pfeifer                         1997-1999               *
34  *     and: Thomas E. Dickey                        2000-on                 *
35  ****************************************************************************/
36
37 /* p_new.c
38  * Creation of a new panel 
39  */
40 #include "panel.priv.h"
41
42 MODULE_ID("$Id: p_new.c,v 1.22 2020/12/26 18:25:48 tom Exp $")
43
44 #ifdef TRACE
45 static char *stdscr_id;
46 static char *new_id;
47
48 static PANEL *
49 AllocPanel(const char *name)
50 {
51   PANEL *result = typeMalloc(PANEL, 1);
52
53   _tracef("create :%s %p", name, (void *)result);
54   return result;
55 }
56 #define InitUser(name) \
57         if (!name ## _id) \
58             name ## _id = strdup(#name); \
59         pan->user = name ## _id; \
60         _tracef("create :user_ptr %p", pan->user)
61 #else
62 #define AllocPanel(name) typeMalloc(PANEL, 1)
63 #define InitUser(name) \
64           pan->user = (void *)0
65 #endif
66
67 /*+-------------------------------------------------------------------------
68   Get root (i.e. stdscr's) panel.
69   Establish the pseudo panel for stdscr if necessary.
70 --------------------------------------------------------------------------*/
71 static PANEL *
72 root_panel(NCURSES_SP_DCL0)
73 {
74 #if NCURSES_SP_FUNCS
75   struct panelhook *ph = NCURSES_SP_NAME(_nc_panelhook) (sp);
76
77 #elif NO_LEAKS
78   struct panelhook *ph = _nc_panelhook();
79 #endif
80
81   if (_nc_stdscr_pseudo_panel == (PANEL *)0)
82     {
83
84       assert(SP_PARM && SP_PARM->_stdscr && !_nc_bottom_panel && !_nc_top_panel);
85 #if NO_LEAKS
86       ph->destroy = del_panel;
87 #endif
88       _nc_stdscr_pseudo_panel = AllocPanel("root_panel");
89       if (_nc_stdscr_pseudo_panel != 0)
90         {
91           PANEL *pan = _nc_stdscr_pseudo_panel;
92           WINDOW *win = SP_PARM->_stdscr;
93
94           pan->win = win;
95           pan->below = (PANEL *)0;
96           pan->above = (PANEL *)0;
97           InitUser(stdscr);
98           _nc_bottom_panel = _nc_top_panel = pan;
99         }
100     }
101   return _nc_stdscr_pseudo_panel;
102 }
103
104 PANEL_EXPORT(PANEL *)
105 new_panel(WINDOW *win)
106 {
107   PANEL *pan = (PANEL *)0;
108
109   GetWindowHook(win);
110
111   T((T_CALLED("new_panel(%p)"), (void *)win));
112
113   if (!win)
114     returnPanel(pan);
115
116   if (!_nc_stdscr_pseudo_panel)
117     (void)root_panel(NCURSES_SP_ARG);
118   assert(_nc_stdscr_pseudo_panel);
119
120   if (!(win->_flags & _ISPAD) && (pan = AllocPanel("new_panel")))
121     {
122       pan->win = win;
123       pan->above = (PANEL *)0;
124       pan->below = (PANEL *)0;
125       InitUser(new);
126       (void)show_panel(pan);
127     }
128   returnPanel(pan);
129 }