xref: /openbsd/lib/libmenu/m_userptr.c (revision 379777c0)
1 /* $OpenBSD: m_userptr.c,v 1.8 2023/10/17 09:52:10 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright 2020 Thomas E. Dickey                                          *
5  * Copyright 1998-2004,2010 Free Software Foundation, Inc.                  *
6  *                                                                          *
7  * Permission is hereby granted, free of charge, to any person obtaining a  *
8  * copy of this software and associated documentation files (the            *
9  * "Software"), to deal in the Software without restriction, including      *
10  * without limitation the rights to use, copy, modify, merge, publish,      *
11  * distribute, distribute with modifications, sublicense, and/or sell       *
12  * copies of the Software, and to permit persons to whom the Software is    *
13  * furnished to do so, subject to the following conditions:                 *
14  *                                                                          *
15  * The above copyright notice and this permission notice shall be included  *
16  * in all copies or substantial portions of the Software.                   *
17  *                                                                          *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25  *                                                                          *
26  * Except as contained in this notice, the name(s) of the above copyright   *
27  * holders shall not be used in advertising or otherwise to promote the     *
28  * sale, use or other dealings in this Software without prior written       *
29  * authorization.                                                           *
30  ****************************************************************************/
31 
32 /****************************************************************************
33  *   Author:  Juergen Pfeifer, 1995,1997                                    *
34  ****************************************************************************/
35 
36 /***************************************************************************
37 * Module m_userptr                                                         *
38 * Associate application data with menus                                    *
39 ***************************************************************************/
40 
41 #include "menu.priv.h"
42 
43 MODULE_ID("$Id: m_userptr.c,v 1.8 2023/10/17 09:52:10 nicm Exp $")
44 
45 /*---------------------------------------------------------------------------
46 |   Facility      :  libnmenu
47 |   Function      :  int set_menu_userptr(MENU *menu, void *userptr)
48 |
49 |   Description   :  Set the pointer that is reserved in any menu to store
50 |                    application relevant information.
51 |
52 |   Return Values :  E_OK         - success
53 +--------------------------------------------------------------------------*/
54 MENU_EXPORT(int)
55 set_menu_userptr(MENU *menu, void *userptr)
56 {
57   T((T_CALLED("set_menu_userptr(%p,%p)"), (void *)menu, (void *)userptr));
58   Normalize_Menu(menu)->userptr = userptr;
59   RETURN(E_OK);
60 }
61 
62 /*---------------------------------------------------------------------------
63 |   Facility      :  libnmenu
64 |   Function      :  void *menu_userptr(const MENU *menu)
65 |
66 |   Description   :  Return the pointer that is reserved in any menu to
67 |                    store application relevant information.
68 |
69 |   Return Values :  Value of the pointer. If no such pointer has been set,
70 |                    NULL is returned
71 +--------------------------------------------------------------------------*/
72 MENU_EXPORT(void *)
73 menu_userptr(const MENU *menu)
74 {
75   T((T_CALLED("menu_userptr(%p)"), (const void *)menu));
76   returnVoidPtr(Normalize_Menu(menu)->userptr);
77 }
78 
79 /* m_userptr.c ends here */
80