10e3d5408SPeter Wemm /**************************************************************************** 2*21817992SBaptiste Daroussin * Copyright 2018-2020,2021 Thomas E. Dickey * 3e1865124SBaptiste Daroussin * Copyright 1998-2012,2016 Free Software Foundation, Inc. * 40e3d5408SPeter Wemm * * 50e3d5408SPeter Wemm * Permission is hereby granted, free of charge, to any person obtaining a * 60e3d5408SPeter Wemm * copy of this software and associated documentation files (the * 70e3d5408SPeter Wemm * "Software"), to deal in the Software without restriction, including * 80e3d5408SPeter Wemm * without limitation the rights to use, copy, modify, merge, publish, * 90e3d5408SPeter Wemm * distribute, distribute with modifications, sublicense, and/or sell * 100e3d5408SPeter Wemm * copies of the Software, and to permit persons to whom the Software is * 110e3d5408SPeter Wemm * furnished to do so, subject to the following conditions: * 120e3d5408SPeter Wemm * * 130e3d5408SPeter Wemm * The above copyright notice and this permission notice shall be included * 140e3d5408SPeter Wemm * in all copies or substantial portions of the Software. * 150e3d5408SPeter Wemm * * 160e3d5408SPeter Wemm * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 170e3d5408SPeter Wemm * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 180e3d5408SPeter Wemm * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 190e3d5408SPeter Wemm * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 200e3d5408SPeter Wemm * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 210e3d5408SPeter Wemm * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 220e3d5408SPeter Wemm * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 230e3d5408SPeter Wemm * * 240e3d5408SPeter Wemm * Except as contained in this notice, the name(s) of the above copyright * 250e3d5408SPeter Wemm * holders shall not be used in advertising or otherwise to promote the * 260e3d5408SPeter Wemm * sale, use or other dealings in this Software without prior written * 270e3d5408SPeter Wemm * authorization. * 280e3d5408SPeter Wemm ****************************************************************************/ 290e3d5408SPeter Wemm 300e3d5408SPeter Wemm /**************************************************************************** 314a1a9510SRong-En Fan * Author: Juergen Pfeifer, 1995,1997 * 320e3d5408SPeter Wemm ****************************************************************************/ 330e3d5408SPeter Wemm 340e3d5408SPeter Wemm /*************************************************************************** 350e3d5408SPeter Wemm * Module m_hook * 360e3d5408SPeter Wemm * Assign application specific routines for automatic invocation by menus * 370e3d5408SPeter Wemm ***************************************************************************/ 380e3d5408SPeter Wemm 390e3d5408SPeter Wemm #include "menu.priv.h" 400e3d5408SPeter Wemm 41*21817992SBaptiste Daroussin MODULE_ID("$Id: m_hook.c,v 1.21 2021/06/17 21:26:02 tom Exp $") 420e3d5408SPeter Wemm 430e3d5408SPeter Wemm /* "Template" macro to generate function to set application specific hook */ 440e3d5408SPeter Wemm #define GEN_HOOK_SET_FUNCTION( typ, name ) \ 457a656419SBaptiste Daroussin MENU_EXPORT(int) NCURSES_API set_ ## typ ## _ ## name (MENU *menu, Menu_Hook func )\ 460e3d5408SPeter Wemm {\ 47aae38d10SBaptiste Daroussin TR_FUNC_BFR(1);\ 48aae38d10SBaptiste Daroussin T((T_CALLED("set_" #typ "_" #name "(%p,%s)"), (void *) menu, TR_FUNC_ARG(0, func)));\ 490e3d5408SPeter Wemm (Normalize_Menu(menu) -> typ ## name = func );\ 500e3d5408SPeter Wemm RETURN(E_OK);\ 510e3d5408SPeter Wemm } 520e3d5408SPeter Wemm 530e3d5408SPeter Wemm /* "Template" macro to generate function to get application specific hook */ 540e3d5408SPeter Wemm #define GEN_HOOK_GET_FUNCTION( typ, name ) \ 557a656419SBaptiste Daroussin MENU_EXPORT(Menu_Hook) NCURSES_API typ ## _ ## name ( const MENU *menu )\ 560e3d5408SPeter Wemm {\ 5706bfebdeSXin LI T((T_CALLED(#typ "_" #name "(%p)"), (const void *) menu));\ 584a1a9510SRong-En Fan returnMenuHook(Normalize_Menu(menu) -> typ ## name);\ 590e3d5408SPeter Wemm } 600e3d5408SPeter Wemm 610e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 620e3d5408SPeter Wemm | Facility : libnmenu 630e3d5408SPeter Wemm | Function : int set_menu_init(MENU *menu, void (*f)(MENU *)) 640e3d5408SPeter Wemm | 650e3d5408SPeter Wemm | Description : Set user-exit which is called when menu is posted 660e3d5408SPeter Wemm | or just after the top row changes. 670e3d5408SPeter Wemm | 680e3d5408SPeter Wemm | Return Values : E_OK - success 690e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 700e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(menu, init) 710e3d5408SPeter Wemm 720e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 730e3d5408SPeter Wemm | Facility : libnmenu 740e3d5408SPeter Wemm | Function : void (*)(MENU *) menu_init(const MENU *menu) 750e3d5408SPeter Wemm | 760e3d5408SPeter Wemm | Description : Return address of user-exit function which is called 770e3d5408SPeter Wemm | when a menu is posted or just after the top row 780e3d5408SPeter Wemm | changes. 790e3d5408SPeter Wemm | 800e3d5408SPeter Wemm | Return Values : Menu init function address or NULL 810e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 820e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(menu, init) 830e3d5408SPeter Wemm 840e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 850e3d5408SPeter Wemm | Facility : libnmenu 860e3d5408SPeter Wemm | Function : int set_menu_term (MENU *menu, void (*f)(MENU *)) 870e3d5408SPeter Wemm | 880e3d5408SPeter Wemm | Description : Set user-exit which is called when menu is unposted 890e3d5408SPeter Wemm | or just before the top row changes. 900e3d5408SPeter Wemm | 910e3d5408SPeter Wemm | Return Values : E_OK - success 920e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 930e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(menu, term) 940e3d5408SPeter Wemm 950e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 960e3d5408SPeter Wemm | Facility : libnmenu 970e3d5408SPeter Wemm | Function : void (*)(MENU *) menu_term(const MENU *menu) 980e3d5408SPeter Wemm | 990e3d5408SPeter Wemm | Description : Return address of user-exit function which is called 1000e3d5408SPeter Wemm | when a menu is unposted or just before the top row 1010e3d5408SPeter Wemm | changes. 1020e3d5408SPeter Wemm | 1030e3d5408SPeter Wemm | Return Values : Menu finalization function address or NULL 1040e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1050e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(menu, term) 1060e3d5408SPeter Wemm 1070e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1080e3d5408SPeter Wemm | Facility : libnmenu 1090e3d5408SPeter Wemm | Function : int set_item_init (MENU *menu, void (*f)(MENU *)) 1100e3d5408SPeter Wemm | 1110e3d5408SPeter Wemm | Description : Set user-exit which is called when menu is posted 1120e3d5408SPeter Wemm | or just after the current item changes. 1130e3d5408SPeter Wemm | 1140e3d5408SPeter Wemm | Return Values : E_OK - success 1150e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1160e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(item, init) 1170e3d5408SPeter Wemm 1180e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1190e3d5408SPeter Wemm | Facility : libnmenu 1200e3d5408SPeter Wemm | Function : void (*)(MENU *) item_init (const MENU *menu) 1210e3d5408SPeter Wemm | 1220e3d5408SPeter Wemm | Description : Return address of user-exit function which is called 1230e3d5408SPeter Wemm | when a menu is posted or just after the current item 1240e3d5408SPeter Wemm | changes. 1250e3d5408SPeter Wemm | 1260e3d5408SPeter Wemm | Return Values : Item init function address or NULL 1270e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1280e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(item, init) 1290e3d5408SPeter Wemm 1300e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1310e3d5408SPeter Wemm | Facility : libnmenu 1320e3d5408SPeter Wemm | Function : int set_item_term (MENU *menu, void (*f)(MENU *)) 1330e3d5408SPeter Wemm | 1340e3d5408SPeter Wemm | Description : Set user-exit which is called when menu is unposted 1350e3d5408SPeter Wemm | or just before the current item changes. 1360e3d5408SPeter Wemm | 1370e3d5408SPeter Wemm | Return Values : E_OK - success 1380e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1390e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(item, term) 1400e3d5408SPeter Wemm 1410e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1420e3d5408SPeter Wemm | Facility : libnmenu 1430e3d5408SPeter Wemm | Function : void (*)(MENU *) item_init (const MENU *menu) 1440e3d5408SPeter Wemm | 1450e3d5408SPeter Wemm | Description : Return address of user-exit function which is called 1460e3d5408SPeter Wemm | when a menu is unposted or just before the current item 1470e3d5408SPeter Wemm | changes. 1480e3d5408SPeter Wemm | 1490e3d5408SPeter Wemm | Return Values : Item finalization function address or NULL 1500e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1510e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(item, term) 1520e3d5408SPeter Wemm 1530e3d5408SPeter Wemm /* m_hook.c ends here */ 154