f0da8b06fab367d1099b8d60b3d8958adda3f8bc
[ncurses.git] / menu / m_item_cur.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2004,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_item_cur                                                        *
36 * Set and get current menus item                                           *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_item_cur.c,v 1.20 2020/05/24 01:40:20 anonymous.maarten Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu  
45 |   Function      :  int set_current_item(MENU *menu, const ITEM *item)
46 |   
47 |   Description   :  Make the item the current item
48 |
49 |   Return Values :  E_OK                - success
50 +--------------------------------------------------------------------------*/
51 MENU_EXPORT(int)
52 set_current_item(MENU * menu, ITEM * item)
53 {
54   T((T_CALLED("set_current_item(%p,%p)"), (void *)menu, (void *)item));
55
56   if (menu && item && (item->imenu == menu))
57     {
58       if (menu->status & _IN_DRIVER)
59         RETURN(E_BAD_STATE);
60
61       assert(menu->curitem);
62       if (item != menu->curitem)
63         {
64           if (menu->status & _LINK_NEEDED)
65             {
66               /*
67                * Items are available, but they are not linked together.
68                * So we have to link here.
69                */
70               _nc_Link_Items(menu);
71             }
72           assert(menu->pattern);
73           Reset_Pattern(menu);
74           /* adjust the window to make item visible and update the menu */
75           Adjust_Current_Item(menu, menu->toprow, item);
76         }
77     }
78   else
79     RETURN(E_BAD_ARGUMENT);
80
81   RETURN(E_OK);
82 }
83
84 /*---------------------------------------------------------------------------
85 |   Facility      :  libnmenu  
86 |   Function      :  ITEM *current_item(const MENU *menu)
87 |   
88 |   Description   :  Return the menus current item
89 |
90 |   Return Values :  Item pointer or NULL if failure
91 +--------------------------------------------------------------------------*/
92 MENU_EXPORT(ITEM *)
93 current_item(const MENU * menu)
94 {
95   T((T_CALLED("current_item(%p)"), (const void *)menu));
96   returnItem((menu && menu->items) ? menu->curitem : (ITEM *) 0);
97 }
98
99 /*---------------------------------------------------------------------------
100 |   Facility      :  libnmenu  
101 |   Function      :  int item_index(const ITEM *)
102 |   
103 |   Description   :  Return the logical index of this item.
104 |
105 |   Return Values :  The index or ERR if this is an invalid item pointer
106 +--------------------------------------------------------------------------*/
107 MENU_EXPORT(int)
108 item_index(const ITEM * item)
109 {
110   T((T_CALLED("item_index(%p)"), (const void *)item));
111   returnCode((item && item->imenu) ? item->index : ERR);
112 }
113
114 /* m_item_cur.c ends here */