ncurses 6.2 - patch 20210522
[ncurses.git] / menu / m_items.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2005,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_items                                                           *
36 * Connect and disconnect items to and from menus                           *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_items.c,v 1.20 2020/12/12 00:38:08 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu  
45 |   Function      :  int set_menu_items(MENU *menu, ITEM **items)
46 |   
47 |   Description   :  Sets the item pointer array connected to menu.
48 |
49 |   Return Values :  E_OK           - success
50 |                    E_POSTED       - menu is already posted
51 |                    E_CONNECTED    - one or more items are already connected
52 |                                     to another menu.
53 |                    E_BAD_ARGUMENT - An incorrect menu or item array was
54 |                                     passed to the function
55 +--------------------------------------------------------------------------*/
56 MENU_EXPORT(int)
57 set_menu_items(MENU *menu, ITEM **items)
58 {
59   T((T_CALLED("set_menu_items(%p,%p)"), (void *)menu, (void *)items));
60
61   if (!menu || (items && !(*items)))
62     RETURN(E_BAD_ARGUMENT);
63
64   if (menu->status & _POSTED)
65     RETURN(E_POSTED);
66
67   if (menu->items)
68     _nc_Disconnect_Items(menu);
69
70   if (items)
71     {
72       if (!_nc_Connect_Items(menu, items))
73         RETURN(E_CONNECTED);
74     }
75
76   menu->items = items;
77   RETURN(E_OK);
78 }
79
80 /*---------------------------------------------------------------------------
81 |   Facility      :  libnmenu  
82 |   Function      :  ITEM **menu_items(const MENU *menu)
83 |   
84 |   Description   :  Returns a pointer to the item pointer array of the menu
85 |
86 |   Return Values :  NULL on error
87 +--------------------------------------------------------------------------*/
88 MENU_EXPORT(ITEM **)
89 menu_items(const MENU *menu)
90 {
91   T((T_CALLED("menu_items(%p)"), (const void *)menu));
92   returnItemPtr(menu ? menu->items : (ITEM **)0);
93 }
94
95 /*---------------------------------------------------------------------------
96 |   Facility      :  libnmenu  
97 |   Function      :  int item_count(const MENU *menu)
98 |   
99 |   Description   :  Get the number of items connected to the menu. If the
100 |                    menu pointer is NULL we return -1.         
101 |
102 |   Return Values :  Number of items or -1 to indicate error.
103 +--------------------------------------------------------------------------*/
104 MENU_EXPORT(int)
105 item_count(const MENU *menu)
106 {
107   T((T_CALLED("item_count(%p)"), (const void *)menu));
108   returnCode(menu ? menu->nitems : -1);
109 }
110
111 /* m_items.c ends here */