ext.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, 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_ext
#define _H_ext
 
/*  FILE: ext.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
05-jan-08    abb      Begun
 
*/
 
#include <xmlstring.h>
#include <xmlregexp.h>
 
#ifndef _H_ncxconst
#include "ncxconst.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_tk
#include "tk.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
#define EXT_CBFN_COOKIE(E) (E)->cbfn_cookie
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
 
typedef status_t (*ext_cbfn_t)
    (void *rawpcb,    // struct yang_pcb_t_ *pcb
     ncx_module_t *mod,
     tk_chain_t *tkc,
     struct ext_template_t_ *ext,
     void *cookie,
     const xmlChar *arg,
     ncx_node_t node_type,
     void *node);
 
 
typedef struct ext_template_t_ {
    dlq_hdr_t        qhdr;                
    xmlChar         *name;                
    xmlChar         *descr;               
    xmlChar         *ref;                 
    xmlChar         *arg;                 
    xmlns_id_t       nsid;                
    ncx_status_t     status;              
    boolean          argel;           
    boolean          used;               
    dlq_hdr_t        appinfoQ;           
    ncx_error_t      tkerr;            
    ext_cbfn_t       cbfn;               
    void            *cbfn_cookie;         
} ext_template_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern ext_template_t *
    ext_new_template (void);
 
 
extern void
    ext_free_template (ext_template_t *ext);
 
 
extern void
    ext_clean_extensionQ (dlq_hdr_t *que);
 
 
extern ext_template_t *
    ext_find_extension (ncx_module_t *mod,
                        const xmlChar *name);
 
 
extern ext_template_t *
    ext_find_extension_que (dlq_hdr_t *extensionQ,
                            const xmlChar *name);
 
 
extern ext_template_t *
    ext_find_extension_all (ncx_module_t *mod,
                            const xmlChar *name);
 
 
extern void
    ext_init (void);
 
extern void
    ext_cleanup (void);
 
 
extern status_t
    ext_register_cbfn (const xmlChar *modname,
                       const xmlChar *extname,
                       ext_cbfn_t cbfn,
                       void *cbfn_cookie);
 
 
extern void
    ext_find_cbfn (const xmlChar *modname,
                   const xmlChar *extname,
                   ext_template_t *ext);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_ext */