xref: /freebsd/contrib/ncurses/menu/m_sub.c (revision 7a7741af18d6c8a804cc643cb7ecda9d730c6aa6)
1 /****************************************************************************
2  * Copyright 2020,2021 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:  Juergen Pfeifer, 1995,1997                                    *
32  ****************************************************************************/
33 
34 /***************************************************************************
35 * Module m_sub                                                             *
36 * Menus subwindow association routines                                     *
37 ***************************************************************************/
38 
39 #include "menu.priv.h"
40 
41 MODULE_ID("$Id: m_sub.c,v 1.16 2021/06/17 21:20:30 tom Exp $")
42 
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu
45 |   Function      :  int set_menu_sub(MENU *menu, WINDOW *win)
46 |
47 |   Description   :  Sets the subwindow of the menu.
48 |
49 |   Return Values :  E_OK           - success
50 |                    E_POSTED       - menu is already posted
51 +--------------------------------------------------------------------------*/
52 MENU_EXPORT(int)
53 set_menu_sub(MENU *menu, WINDOW *win)
54 {
55   T((T_CALLED("set_menu_sub(%p,%p)"), (void *)menu, (void *)win));
56 
57   if (menu)
58     {
59       if (menu->status & _POSTED)
60 	RETURN(E_POSTED);
61       else
62 #if NCURSES_SP_FUNCS
63 	{
64 	  /* We ensure that usersub is never null. So even if a null
65 	     WINDOW parameter is passed, we store the SCREENS stdscr.
66 	     The only MENU that can have a null usersub is the static
67 	     _nc_default_Menu.
68 	   */
69 	  SCREEN *sp = _nc_screen_of(menu->usersub);
70 
71 	  menu->usersub = win ? win : sp->_stdscr;
72 	  _nc_Calculate_Item_Length_and_Width(menu);
73 	}
74 #else
75 	menu->usersub = win;
76 #endif
77     }
78   else
79     _nc_Default_Menu.usersub = win;
80 
81   RETURN(E_OK);
82 }
83 
84 /*---------------------------------------------------------------------------
85 |   Facility      :  libnmenu
86 |   Function      :  WINDOW* menu_sub(const MENU *menu)
87 |
88 |   Description   :  Returns a pointer to the subwindow of the menu
89 |
90 |   Return Values :  NULL on error, otherwise a pointer to the window
91 +--------------------------------------------------------------------------*/
92 MENU_EXPORT(WINDOW *)
93 menu_sub(const MENU *menu)
94 {
95   const MENU *m = Normalize_Menu(menu);
96 
97   T((T_CALLED("menu_sub(%p)"), (const void *)menu));
98   returnWin(Get_Menu_Window(m));
99 }
100 
101 /* m_sub.c ends here */
102