ncxtypes.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_ncxtypes
#define _H_ncxtypes
 
/*  FILE: ncxtypes.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************
 
  Contains NCX typedefs
 
*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
14-nov-05    abb      Begun; split from ncx.h
04-feb-06    abb      Move base/nc.h constants into this file
10-nov-07    abb      Split out from ncxconst.h
*/
 
#include <xmlstring.h>
#include <xmlregexp.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define SET_MOD_ABORTED(M)   (M)->flags |= NCX_FL_MOD_ABORTED
 
#define GET_MOD_ABORTED(M)   ((M)->flags & NCX_FL_MOD_ABORTED)
 
 
#define SET_MOD_SIL_LOADED(M)   (M)->flags |= NCX_FL_MOD_SIL_LOADED
 
#define GET_MOD_SIL_LOADED(M)   ((M)->flags & NCX_FL_MOD_SIL_LOADED)
 
#define SET_MOD_NO_SIL_CODE(M)  (M)->flags |= NCX_FL_MOD_NO_SIL_CODE
 
#define GET_MOD_NO_SIL_CODE(M)   ((M)->flags & NCX_FL_MOD_NO_SIL_CODE)
 
#define SET_MOD_SILSA_DONE(M)  (M)->flags |= NCX_FL_MOD_SILSA_DONE
 
#define GET_MOD_SILSA_DONE(M)   ((M)->flags & NCX_FL_MOD_SILSA_DONE)
 
 
#define SID_IS_UPDATE(M)   ((M)->yang_sid_flags & NCX_FL_SID_UPDATE)
 
#define SID_IS_UNSTABLE(M)   ((M)->yang_sid_flags & NCX_FL_SID_UNSTABLE)
 
#define SID_IS_OBSOLETE(M)   ((M)->yang_sid_flags & NCX_FL_SID_OBSOLETE)
 
 
 
#define NCX_YANG_SID(X) (X)->yang_sid
 
#define NCX_YANG_SID_TREE(X) (X)->yang_sid_tree
 
 
#define NCX_YANG_SID_FLAGS(X) (X)->yang_sid_flags
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
 
typedef enum ncx_access_t_ {
 
    NCX_ACCESS_NONE,    
    NCX_ACCESS_RO,      
    NCX_ACCESS_RW,      
    NCX_ACCESS_RC       
} YPACK ncx_access_t;
 
 
#define NCX_DEF_ACCESS NCX_ACCESS_RC
 
 
typedef enum ncx_data_class_t_ {
    NCX_DC_NONE,          
    NCX_DC_CONFIG,        
    NCX_DC_STATE          
} YPACK ncx_data_class_t;
 
 
typedef enum ncx_btype_t_ {
 
    NCX_BT_NONE,
 
    NCX_BT_ANY,
 
    NCX_BT_BITS,
 
    NCX_BT_ENUM,
 
    NCX_BT_EMPTY,
 
    NCX_BT_BOOLEAN,
 
    NCX_BT_INT8,
 
    NCX_BT_INT16,
 
    NCX_BT_INT32,
 
    NCX_BT_INT64,
 
    NCX_BT_UINT8,
 
    NCX_BT_UINT16,
 
    NCX_BT_UINT32,
 
    NCX_BT_UINT64,
 
    NCX_BT_DECIMAL64,
 
    NCX_BT_FLOAT64,
 
    NCX_BT_STRING,
 
    NCX_BT_BINARY,
 
    NCX_BT_INSTANCE_ID,
 
    NCX_BT_UNION,
 
    NCX_BT_LEAFREF,
 
    NCX_BT_IDREF,
 
    NCX_BT_SLIST,
 
    NCX_BT_CONTAINER,
 
    NCX_BT_CHOICE,
 
    NCX_BT_CASE,
 
    NCX_BT_LIST,
 
    NCX_BT_ANYDATA,
 
    NCX_BT_EXTERN,
 
    NCX_BT_INTERN
 
} YPACK ncx_btype_t;
 
 
#define NCX_FIRST_DATATYPE NCX_BT_ANY
#define NCX_LAST_DATATYPE  NCX_BT_ANYDATA
#define NCX_NUM_BASETYPES  (NCX_LAST_DATATYPE-NCX_FIRST_DATATYPE+1)
 
 
typedef enum ncx_tclass_t_ {
    NCX_CL_NONE,       
    NCX_CL_BASE,                         
    NCX_CL_SIMPLE,               
    NCX_CL_COMPLEX,                            
    NCX_CL_NAMED,               
    NCX_CL_REF             
} YPACK ncx_tclass_t;
 
 
typedef enum ncx_indextyp_t_ {
    NCX_IT_NONE,           
    NCX_IT_INLINE,          
    NCX_IT_NAMED,            
    NCX_IT_LOCAL,               
    NCX_IT_SLOCAL,       
    NCX_IT_REMOTE,                       
    NCX_IT_SREMOTE                         
} YPACK ncx_indextyp_t;
 
 
typedef enum ncx_node_t_ {
    NCX_NT_NONE,          
    NCX_NT_TYP,                                
    NCX_NT_GRP,                                
    NCX_NT_VAL,                                   
    NCX_NT_OBJ,                                
    NCX_NT_ERRINFO,                 
    NCX_NT_STRING,                      
    NCX_NT_CFG,                  
    NCX_NT_INDEX,                     
    NCX_NT_QNAME,                 
    NCX_NT_UINT32_PTR,                 
    NCX_NT_IMPORT_CB,                            
    NCX_NT_INCLUDE_CB,                          
    NCX_NT_REVISION_CB,                         
    NCX_NT_EXTENSION_CB,                       
    NCX_NT_FEATURE_CB,                          
    NCX_NT_IDENTITY_CB,                        
    NCX_NT_TYPDEF_CB                                
} YPACK ncx_node_t;
 
 
typedef enum ncx_iqual_t_ {
    NCX_IQUAL_NONE,                         
    NCX_IQUAL_ONE,                          
    NCX_IQUAL_OPT,                          
    NCX_IQUAL_1MORE,                     
    NCX_IQUAL_ZMORE                      
} YPACK ncx_iqual_t;
 
typedef enum ncx_merge_t_ {
    NCX_MERGE_NONE,                         
    NCX_MERGE_FIRST,                  
    NCX_MERGE_LAST,                   
    NCX_MERGE_SORT                    
} YPACK ncx_merge_t;
 
 
typedef enum ncx_squal_t_ {
    NCX_SQUAL_NONE,          
    NCX_SQUAL_RANGE,         
    NCX_SQUAL_VAL,           
    NCX_SQUAL_META,          
    NCX_SQUAL_APPINFO        
} YPACK ncx_squal_t;
 
 
typedef enum ncx_strrest_t_ {
    NCX_SR_NONE,      
    NCX_SR_PATTERN,   
    NCX_SR_ENUM,      
    NCX_SR_BIT        
}  ncx_strrest_t;
 
 
typedef enum ncx_numfmt_t_ {
    NCX_NF_NONE,     
    NCX_NF_OCTAL,    
    NCX_NF_DEC,      
    NCX_NF_HEX,      
    NCX_NF_REAL      
} YPACK ncx_numfmt_t;
 
 
typedef enum ncx_layer_t_ {
    NCX_LAYER_NONE,       
    NCX_LAYER_TRANSPORT,  
    NCX_LAYER_RPC,        
    NCX_LAYER_OPERATION,  
    NCX_LAYER_CONTENT     
} YPACK ncx_layer_t;
 
 
typedef enum ncx_agttarg_t_ {
    NCX_AGT_TARG_NONE,         
    NCX_AGT_TARG_CANDIDATE,    
    NCX_AGT_TARG_RUNNING,      
    NCX_AGT_TARG_LOCAL,   
    NCX_AGT_TARG_REMOTE,   
    NCX_AGT_TARG_CAND_RUNNING  
} YPACK ncx_agttarg_t;
 
 
typedef enum ncx_agtstart_t_ {
    NCX_AGT_START_NONE,       
    NCX_AGT_START_MIRROR,     
    NCX_AGT_START_DISTINCT    
} YPACK ncx_agtstart_t;
 
 
typedef enum ncx_shutdowntyp_t_ {
    NCX_SHUT_NONE,     
    NCX_SHUT_RESET,    
    NCX_SHUT_RELOAD,   
    NCX_SHUT_RESTART,  
    NCX_SHUT_EXIT,     
    NCX_SHUT_FALLBACK  
} YPACK ncx_shutdowntyp_t;
 
 
typedef enum ncx_cfg_t_ {
    NCX_CFGID_RUNNING,      
    NCX_CFGID_CANDIDATE,    
    NCX_CFGID_STARTUP,      
    NCX_CFGID_OPERATIONAL   
} YPACK ncx_cfg_t;
 
 
#define NCX_CFGID_MIN NCX_CFGID_RUNNING
#define NCX_CFGID_MAX NCX_CFGID_OPERATIONAL
#define NCX_CFGID_CNT (NCX_CFGID_MAX+1) 
typedef enum ncx_instfmt_t_ {
    NCX_IFMT_NONE,      
    NCX_IFMT_C,         
    NCX_IFMT_XPATH1,    
    NCX_IFMT_XPATH2,    
    NCX_IFMT_CLI,       
    NCX_IFMT_CLI2,      
    NCX_IFMT_YANGAPI,   
    NCX_IFMT_RESTCONF   
} YPACK ncx_instfmt_t;
 
 
typedef enum ncx_msgtyp_t_ {
    NCX_MSGTYP_NONE,    
    NCX_MSGTYP_HELLO,   
    NCX_MSGTYP_RPCREQ,  
    NCX_MSGTYP_RPCRPY,  
    NCX_MSGTYP_NOTIF    
} YPACK ncx_msgtyp_t;
 
typedef enum ncx_status_t_ {
    NCX_STATUS_NONE,         
    NCX_STATUS_CURRENT,      
    NCX_STATUS_DEPRECATED,   
    NCX_STATUS_OBSOLETE      
} YPACK ncx_status_t;
 
 
typedef enum ncx_bad_data_t_ {
    NCX_BAD_DATA_NONE,   
    NCX_BAD_DATA_IGNORE,
 
    NCX_BAD_DATA_WARN,
 
    NCX_BAD_DATA_CHECK,
 
    NCX_BAD_DATA_ERROR
} YPACK ncx_bad_data_t;
 
 
typedef enum ncx_display_mode_t_ {
    NCX_DISPLAY_MODE_NONE,   
    NCX_DISPLAY_MODE_PLAIN,
 
    NCX_DISPLAY_MODE_PREFIX,
 
    NCX_DISPLAY_MODE_MODULE,
 
    NCX_DISPLAY_MODE_XML,
 
    NCX_DISPLAY_MODE_XML_NONS,
 
    NCX_DISPLAY_MODE_JSON,
 
    NCX_DISPLAY_MODE_CLI,
 
    NCX_DISPLAY_MODE_CBOR,
 
} YPACK ncx_display_mode_t;
 
typedef enum ncx_msg_encoding_t_ {
    NCX_MSG_ENCODING_NONE,   
    NCX_MSG_ENCODING_XML,
 
    NCX_MSG_ENCODING_JSON,
 
    NCX_MSG_ENCODING_CBOR
} YPACK ncx_msg_encoding_t;
 
 
typedef enum ncx_xpath_axis_t_ {
    XP_AX_NONE,                
    XP_AX_ANCESTOR,            
    XP_AX_ANCESTOR_OR_SELF,    
    XP_AX_ATTRIBUTE,           
    XP_AX_CHILD,               
    XP_AX_DESCENDANT,          
    XP_AX_DESCENDANT_OR_SELF,  
    XP_AX_FOLLOWING,
 
    XP_AX_FOLLOWING_SIBLING,
 
    XP_AX_NAMESPACE,
 
    XP_AX_PARENT,
 
    XP_AX_PRECEDING,
 
    XP_AX_PRECEDING_SIBLING,
 
    XP_AX_SELF
} YPACK ncx_xpath_axis_t;
 
 
typedef enum ncx_name_match_t_ {
    NCX_MATCH_NONE,           
    NCX_MATCH_EXACT,          
    NCX_MATCH_EXACT_NOCASE,   
    NCX_MATCH_ONE,            
    NCX_MATCH_ONE_NOCASE,
 
    NCX_MATCH_FIRST,
 
    NCX_MATCH_FIRST_NOCASE
} YPACK ncx_name_match_t;
 
 
typedef enum ncx_result_format_t {
    NCX_RF_NONE,    
    NCX_RF_TEXT,    
    NCX_RF_XML,     
    NCX_RF_JSON     
} YPACK ncx_result_format_t;
 
 
typedef uint64 ncx_transaction_id_t;
 
#define YANG_SID64 1
typedef uint64 ncx_sid_t;
#define MAX_YANG_SID 0x7fffffffffffffff
#define SID_T unsigned long long int
 
#define MAX_SID_RANGE_SIZE 0xffffffff
 
#define TXID_T long long unsigned int
 
typedef uint32 ncx_etag_t;
 
 
typedef struct ncx_sid_range_t_ {
    dlq_hdr_t       qhdr;
 
    ncx_sid_t       sid_range_start;
 
    ncx_sid_t       sid_range_end;
 
    uint32          sid_range_size;
 
    uint32          sid_range_used;
 
} ncx_sid_range_t;
 
 
typedef struct ncx_dec64_t_ {
    int64  val;        
    uint8  digits;      
    uint8  zeroes;      
} YPACK ncx_dec64_t;
 
 
typedef union ncx_num_t_ {
    int32  i;                            
    int64  l;                           
    uint32 u;                           
    uint64 ul;                         
#ifdef HAS_FLOAT             
    double d;                         
#else
    int64  d;                         
#endif
    ncx_dec64_t  dec;              
} YPACK ncx_num_t;
 
 
typedef xmlChar * ncx_str_t;
 
typedef const xmlChar * ncx_const_str_t;
 
typedef struct ncx_enum_t_ {
    const xmlChar *name;     
    xmlChar       *dname;    
    int32          val;      
} YPACK ncx_enum_t;
 
 
typedef struct ncx_bit_t_ {
    const xmlChar *name;     
    xmlChar       *dname;    
    uint32         pos;      
} YPACK ncx_bit_t;
 
 
typedef struct ncx_lmem_t_ {
    dlq_hdr_t     qhdr;
 
    union val_ {
        ncx_num_t    num;
 
        ncx_str_t    str;
 
        ncx_enum_t   enu;
 
        ncx_bit_t    bit;
 
        boolean      boo;
    } val;
 
    uint32   flags;
} YPACK ncx_lmem_t;
 
 
typedef struct ncx_list_t_ {
    ncx_btype_t  btyp;           
    dlq_hdr_t     memQ;          
} ncx_list_t;
 
 
typedef struct ncx_binary_t_ {
    unsigned char   *ustr;            
    uint32           ubufflen;    
    uint32           ustrlen;    
} ncx_binary_t;
 
 
typedef struct ncx_error_t_ {
    struct ncx_module_t_  *mod;       
    uint32                 linenum;   
    uint32                 linepos;   
} ncx_error_t;
 
 
typedef struct ncx_appinfo_t_ {
    dlq_hdr_t               qhdr;
 
    xmlChar                *prefix;
 
    xmlChar                *name;
 
    xmlChar                *value;
 
    struct ext_template_t_ *ext;
 
    dlq_hdr_t              *appinfoQ;
 
    boolean                 isclone;
 
    ncx_error_t             tkerr;
} YPACK ncx_appinfo_t;
 
 
typedef struct ncx_revhist_t_ {
    dlq_hdr_t           qhdr;
 
    xmlChar            *version;
 
    xmlChar            *descr;
 
    xmlChar            *ref;
 
    status_t            res;
 
    ncx_error_t         tkerr;
} YPACK ncx_revhist_t;
 
 
typedef struct ncx_iff_ref_t_ {
    dlq_hdr_t              qhdr;
 
    xmlChar               *prefix;
 
    xmlChar               *name;
 
    struct ncx_feature_t_ *feature;
} YPACK ncx_iff_ref_t;
 
 
typedef struct ncx_iffeature_t_ {
    dlq_hdr_t              qhdr;
 
    xmlChar               *prefix;
    xmlChar               *name;  
    struct ncx_feature_t_ *feature;   
    struct tk_chain_t_    *expr_tkc;
 
    dlq_hdr_t              expr_iff_refQ;  
    boolean                expr_set;    
    boolean                expr_result;  
    boolean                expr_skipmode; 
    boolean                expr_logerrors; 
    boolean                expr_evalmode; 
    ncx_error_t            tkerr;         
    boolean                seen;          
} YPACK ncx_iffeature_t;
 
 
typedef enum ncx_feature_code_t_ {
    NCX_FEATURE_CODE_NONE,    
    NCX_FEATURE_CODE_STATIC,  
    NCX_FEATURE_CODE_DYNAMIC  
} YPACK ncx_feature_code_t;
 
 
typedef enum ncx_protocol_t_ {
    NCX_PROTO_NONE,           
    NCX_PROTO_NETCONF10,      
    NCX_PROTO_NETCONF11,      
    NCX_PROTO_YUMA_YANGAPI,   
    NCX_PROTO_YUMA_CLI,       
    NCX_PROTO_YCONTROL,       
    NCX_PROTO_RESTCONF,       
    NCX_PROTO_UDPNOTIF        
} YPACK ncx_protocol_t;
 
 
typedef enum ncx_yang_version_t_ {
    NCX_YANG_VER_NONE,
    NCX_YANG_VER_10,
    NCX_YANG_VER_11
} YPACK ncx_yang_version_t;
 
 
typedef struct ncx_feature_t_ {
    dlq_hdr_t           qhdr;
 
    xmlChar            *name;
 
    xmlChar            *descr;
 
    xmlChar            *ref;
 
    ncx_status_t        status;
 
    dlq_hdr_t           iffeatureQ;     
    dlq_hdr_t           appinfoQ;       
    status_t            res;            
    boolean             enabled;        
    ncx_feature_code_t  code;           
    ncx_error_t         tkerr;          
    boolean             seen;           
    uint8               feature_flags;
 
    uint8               yang_sid_flags;
 
    ncx_sid_t          yang_sid;
 
    uint32                 yang_sid_tree;
 
} YPACK ncx_feature_t;
 
typedef struct ncx_filptr_t_ {
    dlq_hdr_t               qhdr;      
    struct val_value_t_    *node;      
    struct val_value_t_    *filnode;   
    struct obj_template_t_ *objnode;   
    struct val_value_t_    *useval;    
    struct getcb_get2_t_   *get2cb;    
    dlq_hdr_t               lookupQ;   
    dlq_hdr_t               matchQ;    
    dlq_hdr_t               selectQ;   
    dlq_hdr_t               childQ;    
} YPACK ncx_filptr_t;
 
 
typedef struct ncx_idlink_t_ {
    dlq_hdr_t  qhdr;            
    struct ncx_identity_t_ *identity;  
    boolean    inq;          
} YPACK ncx_idlink_t;
 
 
typedef struct ncx_identity_base_t_ {
    dlq_hdr_t             qhdr;       
    struct ncx_identity_t_ *base;      
    xmlChar              *baseprefix;  
    xmlChar              *basename;   
} YPACK ncx_identity_base_t;
 
 
typedef struct ncx_identity_t_ {
    dlq_hdr_t             qhdr;    
    dlq_hdr_t             baseQ;   
    xmlChar              *name;    
    xmlChar              *descr;
 
    xmlChar              *ref;
 
    const xmlChar        *modname;   
    xmlns_id_t            nsid;      
    ncx_status_t          status;    
    dlq_hdr_t             childQ;          
    dlq_hdr_t             appinfoQ;       
    dlq_hdr_t             iffeatureQ; 
    uint8                 feature_flags;  
    status_t              res;     
    boolean               isroot;    
    ncx_idlink_t          idlink;    
    ncx_error_t           tkerr;    
    boolean               seen;                  
    uint8               yang_sid_flags;
 
    ncx_sid_t             yang_sid;
 
    uint32                 yang_sid_tree;
 
} YPACK ncx_identity_t;
 
 
typedef struct ncx_module_t_ {
    dlq_hdr_t         qhdr;       
    xmlChar          *name;       
    xmlChar          *version;
    xmlChar          *ocversion;  
    xmlChar          *ietfversion;  
    xmlChar          *organization;
 
    xmlChar          *contact_info;
 
    xmlChar          *descr;
 
    xmlChar          *ref;
 
    xmlChar          *ns;       
    xmlChar          *prefix;   
    xmlChar          *xmlprefix;   
    xmlChar          *source;
 
    xmlChar          *sid_source;
 
    xmlChar          *sid_old_source;
 
    xmlChar          *belongs;             
    struct ncx_module_t_ *parentmod;   
    const xmlChar    *sourcefn;      
    const xmlChar    *belongsver;    
    xmlns_id_t        nsid;            
    ncx_yang_version_t langver;      
    uint32            flags;      
    boolean           ismod;     
    boolean           stmtmode;       
    boolean           added;         
    boolean           supported;  
    boolean           defaultrev;  
    boolean           defaults_added;   
    boolean           dev_module; 
    boolean           ocpattern_mode; 
    status_t          status;         
    uint32            errors;            
    uint32            warnings;          
    dlq_hdr_t         revhistQ;        
    dlq_hdr_t         importQ;          
    dlq_hdr_t         includeQ;        
    dlq_hdr_t         annotQ;         
    dlq_hdr_t         typeQ;          
    dlq_hdr_t         groupingQ;      
    dlq_hdr_t         datadefQ;       
    dlq_hdr_t         extensionQ;     
    dlq_hdr_t         deviationQ;    
    dlq_hdr_t         featureQ;        
    dlq_hdr_t         identityQ;      
    dlq_hdr_t         appinfoQ;        
    dlq_hdr_t         typnameQ;        
    dlq_hdr_t         saveimpQ;    
    dlq_hdr_t         stmtQ;             
    struct ncx_module_t_ *parent;  
    dlq_hdr_t         allincQ;     
    dlq_hdr_t         incchainQ;   
    ncx_list_t        devmodlist;     
    uint32            line_count;        
    boolean           unloadable;       
    boolean           unload_active; 
    boolean           mounted;         
    struct ncx_sm_rootcb_t_ *rootcb;        
    boolean           sid_file_done;
 
    uint8               yang_sid_flags;
 
    ncx_sid_t        yang_sid;
 
    uint32                 yang_sid_tree;
 
    boolean           redo_loadmod;
 
} YPACK ncx_module_t;
 
 
typedef enum ncx_cvttyp_t_ {
    NCX_CVTTYP_NONE,    
    NCX_CVTTYP_XSD,     
    NCX_CVTTYP_SQL,     
    NCX_CVTTYP_SQLDB,   
    NCX_CVTTYP_HTML,    
    NCX_CVTTYP_YANG,    
    NCX_CVTTYP_COPY,    
    NCX_CVTTYP_H,       
    NCX_CVTTYP_C,       
    NCX_CVTTYP_CPP_TEST,  
    NCX_CVTTYP_YIN,     
    NCX_CVTTYP_TG2,     
    NCX_CVTTYP_YH,      
    NCX_CVTTYP_YC,      
    NCX_CVTTYP_UH,      
    NCX_CVTTYP_UC,      
    NCX_CVTTYP_BC,      
    NCX_CVTTYP_BH       
} YPACK ncx_cvttyp_t;
 
 
typedef enum ncx_withdefaults_t_ {
    NCX_WITHDEF_NONE,               
    NCX_WITHDEF_REPORT_ALL,         
    NCX_WITHDEF_REPORT_ALL_TAGGED,  
    NCX_WITHDEF_TRIM,               
    NCX_WITHDEF_EXPLICIT            
} YPACK ncx_withdefaults_t;
 
typedef enum ncx_xpath_type_t_ {
    NCX_XPATH_TYPE_NONE,    
    NCX_XPATH_TYPE_MUST,    
    NCX_XPATH_TYPE_WHEN,    
    NCX_XPATH_TYPE_NACM,    
    NCX_XPATH_TYPE_LEAFREF, 
    NCX_XPATH_TYPE_OTHER    
} YPACK ncx_xpath_type_t;
 
 
typedef struct ncx_import_t_ {
    dlq_hdr_t           qhdr;    
    xmlChar            *module;
 
    xmlChar            *prefix;
 
    xmlChar            *revision;
 
    xmlChar            *descr;
 
    xmlChar            *ref;
 
    ncx_module_t       *mod;                   
    boolean             used;        
    boolean             usexsd;        
    boolean       force_yuma_nc; 
    dlq_hdr_t           appinfoQ;   
    ncx_error_t         tkerr;   
    status_t            res;   
} YPACK ncx_import_t;
 
 
typedef struct ncx_include_t_ {
    dlq_hdr_t             qhdr;          
    xmlChar              *submodule;     
    xmlChar              *revision;
 
    xmlChar              *descr;
 
    xmlChar              *ref;
 
    struct ncx_module_t_ *submod;                 
    boolean               usexsd;       
    dlq_hdr_t             appinfoQ; 
    ncx_error_t           tkerr;    
} YPACK ncx_include_t;
 
 
typedef enum ncx_opt_t_ {
    NCX_REQ,                              
    NCX_OPT                               
} YPACK ncx_opt_t;
 
 
typedef enum ncx_strtyp_t_ {
    NCX_WSP,                 
    NCX_NO_WSP         
} YPACK ncx_strtyp_t;
 
 
typedef struct ncx_errinfo_t_ {
    dlq_hdr_t         qhdr;            
    xmlChar          *descr;
 
    xmlChar          *ref;
 
    xmlChar          *error_app_tag;
 
    xmlChar          *error_message;
    boolean           seen;                     
} YPACK ncx_errinfo_t;
 
 
typedef struct ncx_typname_t_ {
    dlq_hdr_t                        qhdr;           
    struct typ_template_t_          *typ;            
    const xmlChar                   *typname;        
    xmlChar                         *typname_malloc; 
} YPACK ncx_typname_t;
 
 
typedef void (*ncx_load_cbfn_t) (ncx_module_t *mod);
 
 
typedef void (*ncx_unload_cbfn_t) (ncx_module_t *mod);
 
 
typedef void
    (*ncx_yang_obj_cbfn_t) (ncx_module_t *mod,
                            struct obj_template_t_ *obj);
 
 
 
typedef boolean (*ncx_object_cbfn_t) (const ncx_module_t *mod,
                                      struct obj_template_t_ *object,
                                      void *cookie);
 
 
 
 
typedef boolean (*ncx_feature_cbfn_t) (const ncx_module_t *mod,
                                       ncx_feature_t *feature,
                                       void *cookie);
 
 
typedef enum ncx_modformat_t_ {
    NCX_MODFORMAT_NONE,      
    NCX_MODFORMAT_XSD,       
    NCX_MODFORMAT_YANG,      
    NCX_MODFORMAT_YIN,       
    NCX_MODFORMAT_RNG,       
    NCX_MODFORMAT_RNC        
} YPACK ncx_modformat_t;
 
 
typedef struct ncx_save_deviations_t_ {
    dlq_hdr_t    qhdr;          
    struct ncx_module_t_  *devmod;  
    boolean      annotation;   
} YPACK ncx_save_deviations_t;
 
 
typedef enum ncx_confirm_event_t_ {
    NCX_CC_EVENT_NONE,     
    NCX_CC_EVENT_START,    
    NCX_CC_EVENT_CANCEL,   
    NCX_CC_EVENT_TIMEOUT,  
    NCX_CC_EVENT_EXTEND,   
    NCX_CC_EVENT_COMPLETE  
} YPACK ncx_confirm_event_t;
 
 
typedef struct ncx_backptr_t_ {
    dlq_hdr_t    qhdr;    
    void        *node;    
} YPACK ncx_backptr_t;
 
 
typedef boolean (*ncx_identity_cbfn_t) (ncx_identity_t *identity,
                                        void *cookie);
 
typedef uint8  ncx_owner_id_t;
 
 
typedef const xmlChar *
    (*ncx_get_owner_fn_t) (ncx_owner_id_t owner_id);
 
 
typedef enum ncx_leafref_class_t_ {
    NCX_LEAFREF_CLASS_NONE,
 
    NCX_LEAFREF_CLASS_KEY,
 
    NCX_LEAFREF_CLASS_GLOBAL,
 
    NCX_LEAFREF_CLASS_LOCAL,
 
    NCX_LEAFREF_CLASS_INSTANCE
 
} YPACK ncx_leafref_class_t;
 
 
typedef enum ncx_snmp_agt_role_t_ {
    NCX_SNMP_AGT_ROLE_NONE,     
    NCX_SNMP_AGT_ROLE_MASTER,   
    NCX_SNMP_AGT_ROLE_SUBAGENT  
} YPACK ncx_snmp_agt_role_t;
 
 
typedef struct ncx_modcache_t_ {
    dlq_hdr_t qhdr;
    const xmlChar *modname;   
    boolean hidemod;
    //ncx_module_t *modptr;   // not used yet
} YPACK ncx_modcache_t;
 
 
typedef struct ncx_errmsg_t_ {
    status_t res;            
    const xmlChar *errmsg;   
} YPACK ncx_errmsg_t;
 
 
typedef enum ncx_nmda_ds_t_ {
    NCX_NMDA_DS_NONE,          
    NCX_NMDA_DS_CANDIDATE,     
    NCX_NMDA_DS_RUNNING,       
    NCX_NMDA_DS_STARTUP,       
    NCX_NMDA_DS_INTENDED,      
    NCX_NMDA_DS_OPERATIONAL,   
} YPACK ncx_nmda_ds_t;
 
 
typedef enum ncx_nmda_origin_t_ {
    NCX_NMDA_ORIGIN_NONE,        
    NCX_NMDA_ORIGIN_INTENDED,    
    NCX_NMDA_ORIGIN_DYNAMIC,     
    NCX_NMDA_ORIGIN_SYSTEM,      
    NCX_NMDA_ORIGIN_LEARNED,     
    NCX_NMDA_ORIGIN_DEFAULT,     
    NCX_NMDA_ORIGIN_UNKNOWN,     
} YPACK ncx_nmda_origin_t;
 
 
typedef struct ncx_origin_filter_t_ {
    dlq_hdr_t qhdr;            
    ncx_nmda_origin_t origin;  
} YPACK ncx_origin_filter_t;
 
 
typedef struct ncx_nmda_params_t_ {
    dlq_hdr_t       origin_filterQ;
 
    boolean         origin_filter_set;
 
    boolean         origin_filter_negated;
 
    boolean         config_filter_set;
 
    boolean         config_filter;
 
    boolean         with_origin;
 
    ncx_nmda_ds_t   nmda_ds;
 
    ncx_cfg_t       cfg_ds;
} YPACK ncx_nmda_params_t;
 
 
typedef enum ncx_nmda_filtyp_t_ {
    NCX_NMDA_FILTYP_NONE,
    NCX_NMDA_FILTYP_STREAM,
    NCX_NMDA_FILTYP_SELECTION,
} YPACK ncx_nmda_filtyp_t;
 
 
typedef enum ncx_ses_event_t_ {
    NCX_SES_EVENT_NONE,    
    NCX_SES_EVENT_START,   
    NCX_SES_EVENT_END,    
} YPACK ncx_ses_event_t;
 
 
typedef enum ncx_config_state_t_ {
    NCX_CFG_STATE_NONE,     
    NCX_CFG_STATE_INIT,     
    NCX_CFG_STATE_OK,       
    NCX_CFG_STATE_BAD       
} YPACK ncx_config_state_t;
 
 
typedef status_t
    (*ncx_def_hook_cbfn_t) (struct val_value_t_ *parentval,
                            struct obj_template_t_ *obj,
                            xmlChar **buff);
 
 
typedef struct ncx_prefix_info_t_ {
    const xmlChar *prefix;   
    xmlns_id_t nsid;         
} YPACK ncx_prefix_info_t;
 
 
typedef enum ncx_bad_reply_enum_t_ {
    NCX_BAD_REPLY_NONE,       
    NCX_BAD_REPLY_ADAPT,      
    NCX_BAD_REPLY_PRUNE,      
    NCX_BAD_REPLY_ERROR       
} YPACK ncx_bad_reply_enum;
 
 
typedef enum ncx_sid_ns_t_ {
    NCX_SID_NS_NONE,          
    NCX_SID_NS_MODULE,        
    NCX_SID_NS_IDENTITY,      
    NCX_SID_NS_FEATURE,       
    NCX_SID_NS_DATA,          
} YPACK ncx_sid_ns_t;
 
 
typedef enum ncx_yang_sid_mode_t_ {
    NCX_YANG_SID_MODE_NONE,      
    NCX_YANG_SID_MODE_SID_FILE,  
    NCX_YANG_SID_MODE_LSID,      
    NCX_YANG_SID_MODE_LSID_FILE, 
} YPACK ncx_yang_sid_mode_t;
 
 
typedef enum ncx_sm_state_t_ {
    NCX_SM_ST_NONE,              
    NCX_SM_ST_PENDING,           
    NCX_SM_ST_SETUP,             
    NCX_SM_ST_DONE,              
    NCX_SM_ST_ERROR,             
} YPACK ncx_sm_state_t;
 
 
typedef enum ncx_sort_type_t_ {
    NCX_SORT_NONE,           
    NCX_SORT_OFF,            
    NCX_SORT_ASCENDING,      
    NCX_SORT_DESCENDING,     
} YPACK ncx_sort_type_t;
 
 
typedef struct ncx_sm_mpid_t_ {
    dlq_hdr_t qhdr;          
    dlq_hdr_t anckeyQ; // Q of val_value_t
 
    struct val_value_t_  *valroot;
 
    ncx_backptr_t backptr;
 
    boolean backptr_queued;
 
    xmlChar *module;
 
    xmlChar *label;
 
    xmlChar *objpath;
 
} YPACK ncx_sm_mpid_t;
 
 
typedef struct ncx_yanglib_cb_t_ {
 
    struct val_value_t_ *mymodules_val;
 
    uint32 myhash_val;
 
    struct val_value_t_ *mymoduleid_val;
 
    struct val_value_t_ *yanglib_val;
 
    struct val_value_t_ *modset_val;
 
    struct val_value_t_ *content_id_val;
 
    boolean free_mymodules_val;
 
    boolean free_yanglib_val;
 
} ncx_yanglib_cb_t;
 
 
typedef struct ncx_sm_rootcb_t_ {
    dlq_hdr_t                    qhdr;          
    xmlChar                     *label;
 
    xmlChar                     *modname;
 
    xmlChar                     *objpath;
 
    boolean                      config;
 
    boolean                      toproot;
 
    boolean                      active;
 
    uint16                       bundles_waiting;
 
    ncx_sm_state_t               sm_state;
 
    struct obj_template_t_      *rootobj;
 
    ncx_yanglib_cb_t             yanglib_cb;
 
    dlq_hdr_t                    mpidQ;
 
    dlq_hdr_t                    modQ;
 
    dlq_hdr_t                    devQ;
 
    xmlChar                     *loadpath;       
    struct cap_list_t_          *caplist;
 
} YPACK ncx_sm_rootcb_t;
 
 
   // END ncxtypes
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_ncxtypes */