1/****************************************************************************
2 * Copyright (c) 1998-2009,2010 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:  Juergen Pfeifer, 1995,1997                                    *
31 ****************************************************************************/
32
33/***************************************************************************
34* Module m_new                                                             *
35* Creation and destruction of new menus                                    *
36***************************************************************************/
37
38#include "menu.priv.h"
39
40MODULE_ID("$Id: m_new.c,v 1.21 2010/01/23 21:20:11 tom Exp $")
41
42/*---------------------------------------------------------------------------
43|   Facility      :  libnmenu
44|   Function      :  MENU* _nc_new_menu(SCREEN*, ITEM **items)
45|
46|   Description   :  Creates a new menu connected to the item pointer
47|                    array items and returns a pointer to the new menu.
48|                    The new menu is initialized with the values from the
49|                    default menu.
50|
51|   Return Values :  NULL on error
52+--------------------------------------------------------------------------*/
53NCURSES_EXPORT(MENU *)
54NCURSES_SP_NAME(new_menu) (NCURSES_SP_DCLx ITEM ** items)
55{
56  int err = E_SYSTEM_ERROR;
57  MENU *menu = typeCalloc(MENU, 1);
58
59  T((T_CALLED("new_menu(%p,%p)"), (void *)SP_PARM, (void *)items));
60  if (menu)
61    {
62      *menu = _nc_Default_Menu;
63      menu->status = 0;
64      menu->rows = menu->frows;
65      menu->cols = menu->fcols;
66#if NCURSES_SP_FUNCS
67      /* This ensures userwin and usersub are always non-null,
68         so we can derive always the SCREEN that this menu is
69         running on. */
70      menu->userwin = SP_PARM->_stdscr;
71      menu->usersub = SP_PARM->_stdscr;
72#endif
73      if (items && *items)
74	{
75	  if (!_nc_Connect_Items(menu, items))
76	    {
77	      err = E_NOT_CONNECTED;
78	      free(menu);
79	      menu = (MENU *) 0;
80	    }
81	  else
82	    err = E_OK;
83	}
84    }
85
86  if (!menu)
87    SET_ERROR(err);
88
89  returnMenu(menu);
90}
91
92/*---------------------------------------------------------------------------
93|   Facility      :  libnmenu
94|   Function      :  MENU *new_menu(ITEM **items)
95|
96|   Description   :  Creates a new menu connected to the item pointer
97|                    array items and returns a pointer to the new menu.
98|                    The new menu is initialized with the values from the
99|                    default menu.
100|
101|   Return Values :  NULL on error
102+--------------------------------------------------------------------------*/
103#if NCURSES_SP_FUNCS
104NCURSES_EXPORT(MENU *)
105new_menu(ITEM ** items)
106{
107  return NCURSES_SP_NAME(new_menu) (CURRENT_SCREEN, items);
108}
109#endif
110
111/*---------------------------------------------------------------------------
112|   Facility      :  libnmenu
113|   Function      :  int free_menu(MENU *menu)
114|
115|   Description   :  Disconnects menu from its associated item pointer
116|                    array and frees the storage allocated for the menu.
117|
118|   Return Values :  E_OK               - success
119|                    E_BAD_ARGUMENT     - Invalid menu pointer passed
120|                    E_POSTED           - Menu is already posted
121+--------------------------------------------------------------------------*/
122NCURSES_EXPORT(int)
123free_menu(MENU * menu)
124{
125  T((T_CALLED("free_menu(%p)"), (void *)menu));
126  if (!menu)
127    RETURN(E_BAD_ARGUMENT);
128
129  if (menu->status & _POSTED)
130    RETURN(E_POSTED);
131
132  if (menu->items)
133    _nc_Disconnect_Items(menu);
134
135  if ((menu->status & _MARK_ALLOCATED) && menu->mark)
136    free(menu->mark);
137
138  free(menu);
139  RETURN(E_OK);
140}
141
142/* m_new.c ends here */
143