agt_hook_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2025, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_agt_hook_util
#define _H_agt_hook_util
 
/*  FILE: agt_hook_util.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
04-jan-16    ma       Begun
 
 
*********************************************************************
*                                                                   *
*                     I N C L U D E    F I L E S                    *
*                                                                   *
*********************************************************************/
#ifndef _H_status
#include "status.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
/* Do NOT include agt_cb.h here because agt_cb.h already includes
 * agt_hook_util.h and that creates an include cycle.
 *
 * Just forward-declare the struct so we can use pointers to it.
 */
struct agt_cb_fnset_t_;          /* full definition lives in agt_cb.h */
struct agt_cfg_transaction_t_;   /* full definition lives in agt_cfg.h */
 
 
typedef enum agt_hook_fmt_t_ {
    AGT_HOOKFMT_NONE,     
    AGT_HOOKFMT_SUBTREE,  
    AGT_HOOKFMT_NODE      
} agt_hook_fmt_t;
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern boolean
    agt_hook_type_valid (agt_hook_type_t type);
 
 
extern boolean
    agt_hook_fmt_valid (agt_hook_fmt_t format);
 
 
extern const xmlChar *
    agt_hook_get_type_name (agt_hook_type_t type);
 
 
extern agt_hook_type_t
    agt_hook_get_type_enum (const xmlChar *type);
 
 
extern const xmlChar *
    agt_hook_get_format_name (agt_hook_fmt_t format);
 
 
extern agt_hook_fmt_t
    agt_hook_get_format_enum (const xmlChar *format);
 
 
extern status_t
    agt_hook_obj_ok (obj_template_t *obj,
                     agt_hook_fmt_t format,
                     agt_hook_type_t type,
                     const xmlChar *defpath);
 
 
extern status_t
    agt_hook_order_obj_ok (obj_template_t *obj,
                           const xmlChar *defpath);
 
 
extern status_t
    agt_hook_post_sethook_obj_ok (obj_template_t *obj,
                                  const xmlChar *defpath);
 
 
extern boolean
    agt_hooks_callback_set (obj_template_t *obj);
 
 
extern boolean
    agt_post_sethook_callback_set (obj_template_t *obj);
 
 
extern boolean
    agt_sethook_callback_set (obj_template_t *obj);
 
 
extern boolean
    agt_txhook_callback_set (obj_template_t *obj);
 
 
extern boolean
    agt_hook_subtree_format (obj_template_t *obj);
 
 
#ifdef WITH_YCONTROL
extern status_t
    agt_hook_post_sethook_subsys_register (const xmlChar *subsys_id,
                                           const xmlChar *defpath);
 
 
extern status_t
    agt_hook_hooks_subsys_register (const xmlChar *subsys_id,
                                    const xmlChar *defpath,
                                    agt_hook_fmt_t format,
                                    agt_hook_type_t type);
#endif  // WITH_YCONTROL
 
 
extern boolean
    agt_hook_skip_sethook (struct agt_cfg_transaction_t_ *txcb,
                           struct agt_cb_fnset_t_ *cbset);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif // _H_agt_hook_util