typ.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_typ
#define _H_typ
 
/*  FILE: typ.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
22-oct-05    abb      Begun
13-oct-08    abb      Moved pattern from typ_sval_t to ncx_pattern_t
                      to support N patterns per typdef
*/
 
// for XSD pattern: xmlRexexpPtr pattern
#include <xmlstring.h>
 
// for POSIX pattern; regex_t ocpattern
#include <regex.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
 
 
/* Heading only */
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
/* decimal64 constants */
#define TYP_DEC64_MIN_DIGITS   1
#define TYP_DEC64_MAX_DIGITS   18
 
/* typ_rangedef_t flags field */
#define TYP_FL_LBINF     bit0         /* lower bound = -INF */
#define TYP_FL_LBINF2    bit1         /* lower bound = INF */
#define TYP_FL_UBINF     bit2         /* upper bound = INF */
#define TYP_FL_UBINF2    bit3         /* upper bound = -INF */
#define TYP_FL_LBMIN     bit4         /* lower bound is set to 'min' */
#define TYP_FL_LBMAX     bit5         /* lower bound is set to 'max' */
#define TYP_FL_UBMAX     bit6         /* upper bound is set to 'max' */
#define TYP_FL_UBMIN     bit7         /* upper bound is set to 'min' */
 
#define TYP_RANGE_FLAGS  0xff
 
/* typ_enum_t flags field */
#define TYP_FL_ESET      bit0         /* value explicitly set */
#define TYP_FL_ISBITS    bit1         /* enum really used in bits */
#define TYP_FL_SEEN      bit2         /* used by yangdiff */
 
/* typ_sval_t flags field */
#define TYP_FL_USTRING   bit0         /* value is ustring, not string */
 
/* typ_simple_t flags field */
#define TYP_FL_REPLACE   bit0         /* Replace if set; extend if not */
#define TYP_FL_CONSET    bit1         /* constrained field set */
 
/* typ_def_t flags */
#define TYP_FL_RESOLVE_SKIPPED bit0
#define TYP_FL_DEVIATE_SKIPPED bit1
#define TYP_FL_FIND_SKIPPED    bit2
#define TYP_FL_FROM_ANNOTATION bit3
 
 
/* FL_RESOLVE_SKIPPED is se in yang_typ if a deviation cannot be
 * resolved while in deviation mode; The type will be resolved
 * later in the validation process
 */
#define TYP_IS_RESOLVE_SKIPPED(T)  ((T)->flags & TYP_FL_RESOLVE_SKIPPED)
 
#define TYP_SET_RESOLVE_SKIPPED(T)  (T)->flags |= TYP_FL_RESOLVE_SKIPPED
 
/* FL_DEVIATE_SKIPPED is set in yang_obj:resolve_deviation
 * if the type is not known yet and deffered for later
 */
#define TYP_IS_DEVIATE_SKIPPED(T)  ((T)->flags & TYP_FL_DEVIATE_SKIPPED)
 
#define TYP_SET_DEVIATE_SKIPPED(T)  (T)->flags |= TYP_FL_DEVIATE_SKIPPED
 
/* FL_FIND_SKIPPED is set in yang_typ:consume_type
 * if the type is not known yet and import deffered for later
 */
#define TYP_IS_FIND_SKIPPED(T)  ((T)->flags & TYP_FL_FIND_SKIPPED)
 
#define TYP_SET_FIND_SKIPPED(T)  (T)->flags |= TYP_FL_FIND_SKIPPED
 
 
 
/* FL_FROM_ANNOTATION is set in yang_typ:consume_annotation
 * indicates the metaval is a user-data-node from a
 * YANG module md:annotation-stmt
 */
#define TYP_IS_FROM_ANNOTATION(T)  ((T)->flags & TYP_FL_FROM_ANNOTATION)
 
#define TYP_SET_FROM_ANNOTATION(T)  (T)->flags |= TYP_FL_FROM_ANNOTATION
 
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
typedef enum typ_pmode_t_ {
    TYP_PM_NONE,      
    TYP_PM_NORMAL,    
    TYP_PM_INDEX,     
    TYP_PM_MDATA      
} typ_pmode_t;
 
 
typedef struct typ_listval_t_ {
    dlq_hdr_t     qhdr;        
    dlq_hdr_t     strQ;                        
    ncx_iqual_t  iqual;   
} typ_listval_t;
 
 
typedef struct typ_rangedef_t_ {
    dlq_hdr_t   qhdr;            
    xmlChar    *rangestr;        
    ncx_num_t   lb;              
    ncx_num_t   ub;              
    ncx_btype_t btyp;            
    xmlChar    *lbstr;           
    xmlChar    *ubstr;           
    ncx_error_t tkerr;           
    uint8       flags;           
} typ_rangedef_t;
 
 
typedef struct typ_enum_t_ {
    dlq_hdr_t     qhdr;                    
    xmlChar      *name;
 
    xmlChar      *descr;
 
    xmlChar      *ref;
 
    ncx_status_t  status;
 
    int32         val;
 
    uint32        pos;
 
    dlq_hdr_t     appinfoQ;
 
    dlq_hdr_t     iffeatureQ;
 
    uint8         flags;
 
    uint8         feature_flags;
} typ_enum_t;
 
 
typedef struct typ_sval_t_ {
    dlq_hdr_t  qhdr;    
    ncx_str_t  val;     
    uint8      flags;   
} typ_sval_t;
 
 
typedef struct typ_range_t_ {
    xmlChar         *rangestr;        
    dlq_hdr_t        rangeQ;          
    ncx_errinfo_t    range_errinfo;   
    ncx_status_t     res;             
    ncx_error_t      tkerr;           
} typ_range_t;
 
 
typedef struct typ_pattern_t_ {
    dlq_hdr_t       qhdr;           
    union p_ {
        xmlRegexpPtr    pattern;     
        regex_t         ocpattern;     
    } p;
 
    xmlChar        *pat_str;
 
    ncx_errinfo_t   pat_errinfo;
 
    // YANG 1.1 allows pattern modifier invert-match;
    boolean         pat_inverted;
 
    boolean         ocpattern_mode;
 
    boolean         ocpattern_set;
 
    status_t     pat_res;
 
} typ_pattern_t;
 
 
typedef struct typ_idref_t {
    dlq_hdr_t       qhdr;            
    xmlChar        *baseprefix;      
    xmlChar        *basename;        
    ncx_identity_t *base;     
    const xmlChar  *modname;   
} typ_idref_t;
 
 
typedef struct typ_simple_t_ {
    ncx_btype_t      btyp;                             
    struct typ_template_t_ *listtyp;       
    struct xpath_pcb_t_   *xleafref;   
    struct typ_def_t_ *xrefdef;
 
    ncx_leafref_class_t leafref_class;
 
    boolean          constrained;     
    typ_range_t      range;     
    dlq_hdr_t        idrefQ;                   
    dlq_hdr_t        valQ;     
    dlq_hdr_t        metaQ;              
    dlq_hdr_t        unionQ;   
    dlq_hdr_t        patternQ;  
    ncx_strrest_t    strrest;   
    uint32           maxbit;                
    int32            maxenum;                 
    uint8            digits;           
    uint8            flags;       
} typ_simple_t;
 
 
typedef struct typ_named_t_ {
    struct typ_template_t_ *typ;               
    struct typ_def_t_      *newtyp;    
    ncx_btype_t             final_type;  
} typ_named_t;
 
 
typedef struct typ_ref_t_ {
    struct typ_def_t_ *typdef;                 
} typ_ref_t;
 
 
typedef union typ_def_u_t_ {
    ncx_btype_t     base;                
    typ_simple_t    simple;              
    typ_named_t     named;               
    typ_ref_t       ref;                 
} typ_def_u_t;
 
 
typedef struct typ_def_t_ {
    ncx_tclass_t     tclass;          
    ncx_iqual_t      iqual;           
    ncx_access_t     maxaccess;       
    ncx_data_class_t dataclass;       
    ncx_merge_t      mergetype;       
    xmlChar         *prefix;          
    xmlChar         *typenamestr;     
    const xmlChar   *yang_name;       
    dlq_hdr_t        appinfoQ;        
    ncx_error_t      tkerr;           
    typ_def_u_t      def;             
    uint32           linenum;         
    uint8            flags;           
    struct typ_userdef_t_ *userdef;   
} typ_def_t;
 
 
typedef struct typ_template_t_ {
    dlq_hdr_t    qhdr;    
    xmlChar     *name;
 
    xmlChar     *descr;
 
    xmlChar     *ref;
 
    xmlChar     *defval;
 
    xmlChar     *units;
 
    xmlns_id_t   nsid;
 
    boolean      used;
 
    ncx_status_t status;
 
    typ_def_t    typdef;
 
    dlq_hdr_t    appinfoQ;
 
    dlq_hdr_t     iffeatureQ;
 
    void        *grp;
 
    status_t     res;
 
    ncx_error_t  tkerr;
 
    boolean      is_annotation;
 
    uint8        feature_flags;
 
} typ_template_t;
 
 
typedef struct typ_unionnode_t_ {
    dlq_hdr_t     qhdr;       
    typ_template_t *typ;      
    typ_def_t      *typdef;   
    boolean         seen;     
} typ_unionnode_t;
 
 
typedef boolean
    (*typ_union_walker_fn_t) (const xmlChar *the_typename,
                              void *cookie);
 
 
 
typedef boolean
    (*typ_union_walker2_fn_t) (ncx_btype_t the_btype,
                               void *cookie);
 
 
typedef boolean
    (*typ_union_walker3_fn_t) (ncx_btype_t the_btype,
                               typ_def_t *the_typdef,
                               void *cookie);
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
extern status_t
    typ_load_basetypes (void);
 
 
extern void
    typ_unload_basetypes (void);
 
 
extern typ_template_t *
    typ_new_template (void);
 
 
extern void
    typ_free_template (typ_template_t *typ);
 
 
extern typ_def_t *
    typ_new_typdef (void);
 
 
extern void
    typ_init_typdef (typ_def_t *typdef);
 
 
extern void
    typ_init_simple (typ_def_t  *tdef,
             ncx_btype_t btyp);
 
 
extern void
    typ_init_named (typ_def_t  *tdef);
 
 
extern void
    typ_free_typdef (typ_def_t *typdef);
 
 
extern void
    typ_clean_typdef (typ_def_t  *typdef);
 
 
extern void
    typ_set_named_typdef (typ_def_t *typdef,
              typ_template_t *imptyp);
 
 
extern void
    typ_unset_named_typdef (typ_def_t *typdef);
 
 
extern const xmlChar *
    typ_get_named_typename (const typ_def_t  *typdef);
 
 
extern const xmlChar *
    typ_get_named_type_modname (const typ_def_t  *typdef);
 
 
extern uint32
    typ_get_named_type_linenum (const typ_def_t  *typdef);
 
 
extern status_t
    typ_set_new_named (typ_def_t  *typdef,
               ncx_btype_t btyp);
 
 
extern typ_def_t *
    typ_get_new_named (typ_def_t  *typdef);
 
 
extern const typ_def_t *
    typ_cget_new_named (const typ_def_t  *typdef);
 
 
extern void
    typ_set_simple_typdef (typ_template_t *typ,
               ncx_btype_t btyp);
 
 
extern typ_enum_t *
    typ_new_enum (const xmlChar *name);
 
 
extern typ_enum_t *
    typ_new_enum2 (xmlChar *name);
 
 
extern void
    typ_free_enum (typ_enum_t *en);
 
 
extern typ_rangedef_t *
    typ_new_rangedef (void);
 
 
extern void
    typ_free_rangedef (typ_rangedef_t *rv,
               ncx_btype_t  btyp);
 
 
extern void
    typ_normalize_rangeQ (dlq_hdr_t *rangeQ,
              ncx_btype_t  btyp);
 
 
extern dlq_hdr_t *
    typ_get_rangeQ (typ_def_t *typdef);
 
 
extern dlq_hdr_t *
    typ_get_rangeQ_con (typ_def_t *typdef);
 
 
extern const dlq_hdr_t *
    typ_get_crangeQ (const typ_def_t *typdef);
 
 
extern const dlq_hdr_t *
    typ_get_crangeQ_con (const typ_def_t *typdef);
 
 
extern typ_range_t *
    typ_get_range_con (typ_def_t *typdef);
 
 
extern const typ_range_t *
    typ_get_crange_con (const typ_def_t *typdef);
 
 
extern const xmlChar *
    typ_get_rangestr (const typ_def_t *typdef);
 
 
extern const typ_rangedef_t *
    typ_first_rangedef (const typ_def_t *typdef);
 
 
extern const typ_rangedef_t *
    typ_first_rangedef_con (const typ_def_t *typdef);
 
 
extern status_t
    typ_get_rangebounds_con (const typ_def_t *typdef,
                 ncx_btype_t *btyp,
                 const ncx_num_t **lb,
                 const ncx_num_t **ub);
 
 
extern ncx_strrest_t
    typ_get_strrest (const typ_def_t *typdef);
 
 
extern void
    typ_set_strrest (typ_def_t *typdef,
             ncx_strrest_t strrest);
 
 
extern typ_sval_t *
    typ_new_sval (const xmlChar *str,
          ncx_btype_t  btyp);
 
 
extern void
    typ_free_sval (typ_sval_t *sv);
 
 
extern typ_listval_t *
    typ_new_listval (void);
 
 
extern void
    typ_free_listval (typ_listval_t *lv);
 
 
extern ncx_btype_t
    typ_get_range_type (ncx_btype_t btyp);
 
 
extern ncx_btype_t
    typ_get_basetype (const typ_def_t  *typdef);
 
 
extern ncx_btype_t
    typ_get_basetype2 (typ_def_t  *typdef);
 
 
extern const xmlChar *
    typ_get_name (const typ_def_t  *typdef);
 
 
extern const xmlChar *
    typ_get_basetype_name (const typ_template_t  *typ);
 
 
extern const xmlChar *
    typ_get_parenttype_name (const typ_template_t  *typ);
 
 
extern ncx_tclass_t
    typ_get_base_class (const typ_def_t  *typdef);
 
 
extern typ_template_t *
    typ_get_basetype_typ (ncx_btype_t  btyp);
 
 
extern typ_def_t *
    typ_get_basetype_typdef (ncx_btype_t  btyp);
 
 
extern typ_def_t *
    typ_get_parent_typdef (typ_def_t  *typdef);
 
 
extern const typ_template_t *
    typ_get_parent_type (const typ_template_t  *typ);
 
 
extern const typ_def_t *
    typ_get_cparent_typdef (const typ_def_t  *typdef);
 
 
extern typ_def_t *
    typ_get_next_typdef (typ_def_t  *typdef);
 
 
extern typ_def_t *
    typ_get_base_typdef (typ_def_t  *typdef);
 
 
extern typ_def_t *
    typ_get_userdef_typdef (typ_def_t  *typdef);
 
 
extern const typ_def_t *
    typ_get_cuserdef_typdef (const typ_def_t  *typdef);
 
 
extern const typ_def_t *
    typ_get_cbase_typdef (const typ_def_t  *typdef);
 
 
extern typ_def_t *
    typ_get_qual_typdef (typ_def_t  *typdef,
             ncx_squal_t squal);
 
 
extern const typ_def_t *
    typ_get_cqual_typdef (const typ_def_t  *typdef,
              ncx_squal_t  squal);
 
 
extern const ncx_appinfo_t *
    typ_find_appinfo (const typ_def_t *typdef,
              const xmlChar *prefix,
              const xmlChar *name);
 
 
extern const ncx_appinfo_t *
    typ_find_appinfo_con (const typ_def_t *typdef,
              const xmlChar *prefix,
              const xmlChar *name);
 
 
extern boolean
    typ_is_xpath_string (const typ_def_t *typdef);
 
 
extern boolean
    typ_is_qname_string (const typ_def_t *typdef);
 
 
extern boolean
    typ_is_schema_instance_string (const typ_def_t *typdef);
 
 
extern const xmlChar *
    typ_get_defval (const typ_template_t *typ);
 
 
extern const xmlChar *
    typ_get_default (const typ_def_t *typdef);
 
 
extern ncx_iqual_t
    typ_get_iqualval (const typ_template_t *typ);
 
 
extern ncx_iqual_t
    typ_get_iqualval_def (const typ_def_t *typdef);
 
 
extern const xmlChar *
    typ_get_units (const typ_template_t *typ);
 
 
extern const xmlChar *
    typ_get_units_from_typdef (const typ_def_t *typdef);
 
 
extern boolean
    typ_has_children (ncx_btype_t btyp);
 
 
extern boolean
    typ_has_index (ncx_btype_t btyp);
 
 
extern boolean
    typ_is_simple (ncx_btype_t btyp);
 
 
extern boolean
    typ_is_xsd_simple (ncx_btype_t btyp);
 
 
extern typ_enum_t *
    typ_first_enumdef (typ_def_t *typdef);
 
 
extern typ_enum_t *
    typ_next_enumdef (typ_enum_t *enumdef);
 
 
extern typ_enum_t *
    typ_get_enumdef_n (typ_def_t *typdef,
                       uint32 num);
 
 
extern const typ_enum_t *
    typ_first_con_enumdef (const typ_def_t *typdef);
 
 
extern typ_enum_t *
    typ_find_enumdef (dlq_hdr_t *ebQ,
              const xmlChar *name);
 
 
extern uint32
    typ_enumdef_count (const typ_def_t *typdef);
 
 
extern boolean
    typ_enumdef_conditional (typ_def_t *typdef,
                             const xmlChar *valstr);
 
 
extern typ_def_t *
    typ_get_correct_enumdef (typ_def_t *typdef);
 
 
extern typ_enum_t *
    typ_get_enumdef (typ_def_t *typdef,
                     const xmlChar *valstr);
 
 
extern const typ_sval_t *
    typ_first_strdef (const typ_def_t *typdef);
 
 
extern uint32
    typ_get_maxrows (const typ_def_t *typdef);
 
 
extern ncx_access_t
    typ_get_maxaccess (const typ_def_t *typdef);
 
 
extern ncx_data_class_t
    typ_get_dataclass (const typ_def_t *typdef);
 
 
extern ncx_merge_t
    typ_get_mergetype (const typ_def_t *typdef);
 
 
extern xmlns_id_t
    typ_get_nsid (const typ_template_t *typ);
 
 
extern typ_template_t *
    typ_get_listtyp (typ_def_t *typdef);
 
 
extern const typ_template_t *
    typ_get_clisttyp (const typ_def_t *typdef);
 
 
extern typ_unionnode_t *
    typ_new_unionnode (typ_template_t *typ);
 
 
extern void
    typ_free_unionnode (typ_unionnode_t *un);
 
 
extern typ_def_t *
    typ_get_unionnode_ptr (typ_unionnode_t *un);
 
 
extern typ_unionnode_t *
    typ_first_unionnode (typ_def_t *typdef);
 
 
extern const typ_unionnode_t *
    typ_first_con_unionnode (const typ_def_t *typdef);
 
 
extern boolean
    typ_is_number (ncx_btype_t btyp);
 
 
extern boolean
    typ_is_string (ncx_btype_t btyp);
 
 
extern boolean
    typ_is_enum (ncx_btype_t btyp);
 
 
extern typ_pattern_t *
    typ_new_pattern (const xmlChar *pat_str,
                     boolean ocmode);
 
 
extern void
    typ_free_pattern (typ_pattern_t *pat);
 
 
extern status_t
    typ_compile_pattern (typ_pattern_t *pat);
 
 
extern typ_pattern_t *
    typ_get_first_pattern (typ_def_t *typdef);
 
 
extern typ_pattern_t *
    typ_get_next_pattern (typ_pattern_t *curpat);
 
 
extern const typ_pattern_t *
    typ_get_first_cpattern (const typ_def_t *typdef);
 
 
extern const typ_pattern_t *
    typ_get_next_cpattern (const typ_pattern_t *curpat);
 
 
extern uint32
    typ_get_pattern_count (const typ_def_t *typdef);
 
 
extern ncx_errinfo_t *
    typ_get_range_errinfo (typ_def_t *typdef);
 
 
extern void
    typ_clean_typeQ (dlq_hdr_t *que);
 
 
extern boolean
    typ_ok_for_inline_index (ncx_yang_version_t langver,
                             ncx_btype_t btyp);
 
 
extern boolean
    typ_ok_for_metadata (ncx_btype_t btyp);
 
 
extern boolean
    typ_ok_for_union (ncx_yang_version_t langver,
                      ncx_btype_t btyp);
 
 
extern boolean
    typ_ok (const typ_def_t *typdef);
 
 
extern boolean
    typ_ok_for_xsdlist (ncx_btype_t btyp);
 
 
extern const xmlChar *
    typ_get_leafref_path (const typ_def_t *typdef);
 
 
extern const void *
    typ_get_leafref_path_addr (const typ_def_t *typdef);
 
 
extern struct xpath_pcb_t_ *
    typ_get_leafref_pcb (typ_def_t *typdef);
 
 
extern ncx_leafref_class_t
    typ_get_leafref_class (typ_def_t *typdef);
 
 
extern void
    typ_set_leafref_class_key (typ_def_t *typdef);
 
 
extern boolean
    typ_get_constrained (const typ_def_t *typdef);
 
 
extern boolean
    typ_get_constrained_set (const typ_def_t *typdef);
 
 
extern void
    typ_set_xref_typdef (typ_def_t *typdef,
                         typ_def_t *target);
 
 
extern typ_def_t *
    typ_get_xref_typdef (typ_def_t *typdef);
 
 
extern boolean
    typ_has_subclauses (const typ_def_t *typdef);
 
 
extern typ_idref_t *
    typ_get_first_idref (typ_def_t *typdef);
 
 
extern typ_idref_t *
    typ_get_next_idref (typ_def_t *typdef,
                        typ_idref_t *curdef);
 
 
extern const typ_idref_t *
    typ_get_first_cidref (typ_def_t  *typdef);
 
 
extern const typ_idref_t *
    typ_get_next_cidref (const typ_def_t *typdef,
                         const typ_idref_t *curdef);
 
extern uint8
    typ_get_fraction_digits (const typ_def_t *typdef);
 
 
extern status_t
    typ_set_fraction_digits (typ_def_t *typdef,
                 uint8 digits);
 
 
extern uint32
    typ_get_typ_linenum (const typ_template_t  *typ);
 
 
extern uint32
    typ_get_typdef_linenum (const typ_def_t  *typdef);
 
 
extern void
    typ_get_union_types (typ_def_t *typdef,
                         typ_union_walker_fn_t walkerfn,
                         void *cookie);
 
 
extern void
    typ_get_union_basetypes (typ_def_t *typdef,
                             typ_union_walker2_fn_t walkerfn,
                             void *cookie);
 
 
extern void
    typ_get_union_typdefs (typ_def_t *typdef,
                           typ_union_walker3_fn_t walkerfn,
                           void *cookie);
 
 
extern const xmlChar *
    typ_get_yang_typename (const typ_def_t  *typdef);
 
 
extern boolean
    typ_union_needs_xpath_check (typ_def_t *checkdef);
 
 
extern typ_idref_t *
    typ_new_idref (void);
 
 
extern void
    typ_free_idref (typ_idref_t *idref);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_typ */