10e3d5408SPeter Wemm /**************************************************************************** 24a1a9510SRong-En Fan * Copyright 2018,2020 Thomas E. Dickey * 30e3d5408SPeter Wemm * 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 304a1a9510SRong-En Fan /**************************************************************************** 310e3d5408SPeter Wemm * Author: Juergen Pfeifer, 1995,1997 * 320e3d5408SPeter Wemm ****************************************************************************/ 330e3d5408SPeter Wemm 340e3d5408SPeter Wemm #include "form.priv.h" 354a1a9510SRong-En Fan 360e3d5408SPeter Wemm MODULE_ID("$Id: frm_hook.c,v 1.20 2020/05/24 01:40:20 anonymous.maarten Exp $") 370e3d5408SPeter Wemm 380e3d5408SPeter Wemm /* "Template" macro to generate function to set application specific hook */ 397a69bbfbSPeter Wemm #define GEN_HOOK_SET_FUNCTION( typ, name ) \ 400e3d5408SPeter Wemm FORM_IMPEXP int NCURSES_API set_ ## typ ## _ ## name (FORM *form, Form_Hook func)\ 414a1a9510SRong-En Fan {\ 420e3d5408SPeter Wemm TR_FUNC_BFR(1); \ 430e3d5408SPeter Wemm T((T_CALLED("set_" #typ"_"#name"(%p,%s)"), (void *) form, TR_FUNC_ARG(0, func)));\ 440e3d5408SPeter Wemm (Normalize_Form( form ) -> typ ## name) = func ;\ 450e3d5408SPeter Wemm RETURN(E_OK);\ 460e3d5408SPeter Wemm } 470e3d5408SPeter Wemm 487a69bbfbSPeter Wemm /* "Template" macro to generate function to get application specific hook */ 490e3d5408SPeter Wemm #define GEN_HOOK_GET_FUNCTION( typ, name ) \ 504a1a9510SRong-En Fan FORM_IMPEXP Form_Hook NCURSES_API typ ## _ ## name ( const FORM *form )\ 514a1a9510SRong-En Fan {\ 520e3d5408SPeter Wemm T((T_CALLED(#typ "_" #name "(%p)"), (const void *) form));\ 534a1a9510SRong-En Fan returnFormHook( Normalize_Form( form ) -> typ ## name );\ 540e3d5408SPeter Wemm } 550e3d5408SPeter Wemm 560e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 570e3d5408SPeter Wemm | Facility : libnform 580e3d5408SPeter Wemm | Function : int set_field_init(FORM *form, Form_Hook f) 590e3d5408SPeter Wemm | 600e3d5408SPeter Wemm | Description : Assigns an application defined initialization function 610e3d5408SPeter Wemm | to be called when the form is posted and just after 620e3d5408SPeter Wemm | the current field changes. 630e3d5408SPeter Wemm | 640e3d5408SPeter Wemm | Return Values : E_OK - success 650e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 660e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(field, init) 670e3d5408SPeter Wemm 680e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 690e3d5408SPeter Wemm | Facility : libnform 700e3d5408SPeter Wemm | Function : Form_Hook field_init(const FORM *form) 710e3d5408SPeter Wemm | 720e3d5408SPeter Wemm | Description : Retrieve field initialization routine address. 730e3d5408SPeter Wemm | 740e3d5408SPeter Wemm | Return Values : The address or NULL if no hook defined. 750e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 760e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(field, init) 770e3d5408SPeter Wemm 780e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 790e3d5408SPeter Wemm | Facility : libnform 800e3d5408SPeter Wemm | Function : int set_field_term(FORM *form, Form_Hook f) 810e3d5408SPeter Wemm | 820e3d5408SPeter Wemm | Description : Assigns an application defined finalization function 830e3d5408SPeter Wemm | to be called when the form is unposted and just before 840e3d5408SPeter Wemm | the current field changes. 850e3d5408SPeter Wemm | 860e3d5408SPeter Wemm | Return Values : E_OK - success 870e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 880e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(field, term) 890e3d5408SPeter Wemm 900e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 910e3d5408SPeter Wemm | Facility : libnform 920e3d5408SPeter Wemm | Function : Form_Hook field_term(const FORM *form) 930e3d5408SPeter Wemm | 940e3d5408SPeter Wemm | Description : Retrieve field finalization routine address. 950e3d5408SPeter Wemm | 960e3d5408SPeter Wemm | Return Values : The address or NULL if no hook defined. 970e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 980e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(field, term) 990e3d5408SPeter Wemm 1000e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1010e3d5408SPeter Wemm | Facility : libnform 1020e3d5408SPeter Wemm | Function : int set_form_init(FORM *form, Form_Hook f) 1030e3d5408SPeter Wemm | 1040e3d5408SPeter Wemm | Description : Assigns an application defined initialization function 1050e3d5408SPeter Wemm | to be called when the form is posted and just after 1060e3d5408SPeter Wemm | a page change. 1070e3d5408SPeter Wemm | 1080e3d5408SPeter Wemm | Return Values : E_OK - success 1090e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1100e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(form, init) 1110e3d5408SPeter Wemm 1120e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1130e3d5408SPeter Wemm | Facility : libnform 1140e3d5408SPeter Wemm | Function : Form_Hook form_init(const FORM *form) 1150e3d5408SPeter Wemm | 1160e3d5408SPeter Wemm | Description : Retrieve form initialization routine address. 1170e3d5408SPeter Wemm | 1180e3d5408SPeter Wemm | Return Values : The address or NULL if no hook defined. 1190e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1200e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(form, init) 1210e3d5408SPeter Wemm 1220e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1230e3d5408SPeter Wemm | Facility : libnform 1240e3d5408SPeter Wemm | Function : int set_form_term(FORM *form, Form_Hook f) 1250e3d5408SPeter Wemm | 1260e3d5408SPeter Wemm | Description : Assigns an application defined finalization function 1270e3d5408SPeter Wemm | to be called when the form is unposted and just before 1280e3d5408SPeter Wemm | a page change. 1290e3d5408SPeter Wemm | 1300e3d5408SPeter Wemm | Return Values : E_OK - success 1310e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1320e3d5408SPeter Wemm GEN_HOOK_SET_FUNCTION(form, term) 1330e3d5408SPeter Wemm 1340e3d5408SPeter Wemm /*--------------------------------------------------------------------------- 1350e3d5408SPeter Wemm | Facility : libnform 1360e3d5408SPeter Wemm | Function : Form_Hook form_term(const FORM *form) 1370e3d5408SPeter Wemm | 1380e3d5408SPeter Wemm | Description : Retrieve form finalization routine address. 1390e3d5408SPeter Wemm | 1400e3d5408SPeter Wemm | Return Values : The address or NULL if no hook defined. 1410e3d5408SPeter Wemm +--------------------------------------------------------------------------*/ 1420e3d5408SPeter Wemm GEN_HOOK_GET_FUNCTION(form, term) 143 144 /* frm_hook.c ends here */ 145