obj.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_obj
#define _H_obj

/*  FILE: obj.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/

/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************

date         init     comment
----------------------------------------------------------------------
09-dec-07    abb      Begun
21jul08      abb      start obj-based rewrite

*/

#include <xmlstring.h>
#include <xmlregexp.h>

#include "log.h"
#include "grp.h"
#include "ncxconst.h"
#include "ncxtypes.h"
#include "status.h"
#include "tk.h"
#include "rpc.h"
#include "typ.h"
#include "xmlns.h"
#include "xml_util.h"

#ifdef __cplusplus
extern "C" {
#endif

/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/

/* object pointer inside obj_key_t struct */
#define OBJ_KEYOBJ(KO) (KO)->keyobj

/* default vaule for config statement */
#define OBJ_DEF_CONFIG      TRUE

/* default vaule for mandatory statement */
#define OBJ_DEF_MANDATORY   FALSE

/* number of static xpath backptrs to have in each object node */
/*** CHANGED FROM 4 to 2 23oct19  ***/
#define OBJ_NUM_XPATH_BACKPTRS 2

/* each object can have a SIL callback priority 1..255 */
#define OBJ_DEF_SIL_PRIORITY   255
#define OBJ_MIN_SIL_PRIORITY   1
#define OBJ_MAX_SIL_PRIORITY   255


/********* flags field in obj_template_t *************/

/* object is cloned from a grouping, for a uses statement */
#define OBJ_FL_CLONE        bit0

/* def is a CLI text block */
#define OBJ_FL_CLI_TEXT_BLOCK      bit1

/* clone source
 *   == 0 : cloned object from uses
 *   == 1 : cloned object from augment
 */
#define OBJ_FL_AUGCLONE     bit2

/* object is marked for deletion -- dynamic flag */
#define OBJ_FL_DELETED      bit3

/* object is dirty in the candidate datastore; used by server only */
#define OBJ_FL_CDIRTY        bit4

/* object is a top-level definition within a module or submodule */
#define OBJ_FL_TOP          bit5

/* object was entered with a 'kw name;' format and is
 * considered empty by the yangdump program
 */
#define OBJ_FL_EMPTY        bit6

/* object has been visited by the yangdiff program */
#define OBJ_FL_SEEN         bit7

/* bit7 is reused in the server since the 'seen' bit only
 * applies to the yangdiff-pro program
 * object is dirty in the running datastore; used by server only
 */
#define OBJ_FL_RDIRTY       bit7

/* object marked as changed by the yangdiff program */
#define OBJ_FL_DIFF         bit8

/* object is marked as ncx:hidden */
#define OBJ_FL_HIDDEN       bit9

/* object is marked as ncx:root */
#define OBJ_FL_ROOT         bit10

/* object is marked as a password */
#define OBJ_FL_PASSWD       bit11

/* object is marked as a CLI-only node */
#define OBJ_FL_CLI          bit12

/* object is marked as an XSD list data type */
#define OBJ_FL_XSDLIST      bit13

/* OBJ_TYP_LEAF object is being uses as a key */
#define OBJ_FL_KEY          bit14

/* object is marked as abstract: not CLI or config data */
#define OBJ_FL_ABSTRACT     bit15

/* object is marked as config set so OBJ_FL_CONFIG is valid */
#define OBJ_FL_CONFSET      bit16

/* object config value */
#define OBJ_FL_CONFIG       bit17

/* object is marked as mandatory set so OBJ_FL_MANDATORY is valid */
#define OBJ_FL_MANDSET      bit18

/* object mandatory value */
#define OBJ_FL_MANDATORY    bit19

/* object used in a unique-stmt within a list */
#define OBJ_FL_UNIQUE       bit20

/* object data type is an XPath string */
#define OBJ_FL_XPATH        bit21

/* object data type is a QName string */
#define OBJ_FL_QNAME        bit22

/* object data type is a schema-instance string */
#define OBJ_FL_SCHEMAINST   bit23

/* object is tagged ncx:secure */
#define OBJ_FL_SECURE       bit24

/* object is tagged ncx:very-secure */
#define OBJ_FL_VERY_SECURE  bit25

/* object is tagged ncx:default-parm-equals-ok */
#define OBJ_FL_CLI_EQUALS_OK  bit26

/* object is tagged ncx:sil-delete-children-first */
#define OBJ_FL_SIL_DELETE_CHILDREN_FIRST  bit27

/* object is tagged as ncx:user-write with no create access */
#define OBJ_FL_BLOCK_CREATE bit28

/* object is tagged as ncx:user-write with no update access */
#define OBJ_FL_BLOCK_UPDATE bit29

/* object is tagged as ncx:user-write with no delete access */
#define OBJ_FL_BLOCK_DELETE bit30

/* object is tagged as ywx:rpc-root operation container */
#define OBJ_FL_RPC_ROOT     bit31


/********* xflags field in obj_template_t *************/

/* object is a default NP-container */
#define OBJ_FL_DEF_NPCON    bit0

/* object has been checked for enabled;
 * this flag needs to be cleared if dynamic
 *  features are used and the feature becomes disabled!!!
 */
#define OBJ_FL_ENABLED_CHK  bit1

/* indicates that the object is enabled, which just means
 * any if-features statements for this object are true
 */
#define OBJ_FL_ENABLED      bit2

/* indicates that this visible object has a visible sibling
 * object with the same local-name but from another module
 */
#define OBJ_FL_DUP_LOCAL    bit3

/* indicates that this object is an RPC operation that is
 * not allowed to be called concurrently by multiple sessions
 * at once
 */
#define OBJ_FL_EXCLUSIVE_RPC bit4

/* indicates that this object is has the sil-force-replay
 * flag set
 */
#define OBJ_FL_SIL_FORCE_REPLAY bit5

/* indicates that this object is has the sil-force-replay
 * flag set for a replace operation
 */
#define OBJ_FL_SIL_FORCE_REPLACE_REPLAY bit6

/* indicates that this object is an anyxml object that is
 * really a ywx:datapath node. The object path-expr will
 * be sent in XML instances of the object.
 * (Like object Location header)
 */
#define OBJ_FL_DATAPATH    bit7

/* indicates that is object has get2 callbacks registered
 * either for 1 or more submodules.  This flag is
 * set and cleared dynamically so do not cache the value
 */
#define OBJ_FL_REMOTE_GET2    bit8

/* indicates the 'units' field has been replaced with
 * a malloced string via deviations, could be a clone
*/
#define OBJ_FL_FREE_UNITS    bit9

/* indicates the 'typdef' field has been replaced with
 * a malloced struct via deviations, could be a clone
*/
#define OBJ_FL_FREE_TYPDEF   bit10


/* indicates the object uses the edit2 callback mode */
#define OBJ_FL_EDIT2_MODE    bit11

/* indicates that leafref validation has been disabled for the
 * object.  The leafref will be treated as if it had a
 * require-instance false; sub-statement
 */
#define OBJ_FL_SKIP_LEAFREF   bit12

/* indicates that the object yang_hash field contains
 * the YANG HASH value for the node; hash can be zero
 * so set this flag to make sure obj->yang_hash field is set
 */
#define OBJ_FL_YANG_HASH    bit13

/* indicates that the object yang_hash field contains
 * the rehashed value for the node because of a clash
 */
#define OBJ_FL_YANG_REHASH    bit14

/* indicates that the cbset (callback set) is malloced
 * and a simple m__free(cbset) is needed to clean up
 */
#define OBJ_FL_CBSET_MALLOCED  bit15

/* indicates the object is 1 of the ncx generic templates */
#define OBJ_FL_GENERIC         bit16

/* indicates the object has defaults has been checked */
#define OBJ_FL_DEF_DONE       bit17

/* indicates the object has defaults (valid if bit17 set) */
#define OBJ_FL_DEF            bit18

/* indicates the object is an RPC that is OK for library mode */
#define OBJ_FL_LIBMODE        bit19

/* indicates the object contains a smiv2 object identifier */
#define OBJ_FL_SMIV2_OID      bit20

/* indicates object is tagged ywx:no-nvstore */
#define OBJ_FL_NO_NVSTORE     bit21

/* object is tagged ncx:no-sil-delete-children-first */
#define OBJ_FL_NO_SIL_DELETE_CHILDREN_FIRST  bit22

/* object is tagged as a source node in a yangmap nodemap */
#define OBJ_FL_YANGMAP_SOURCE  bit23

/* object is tagged as a target node in a yangmap nodemap */
#define OBJ_FL_YANGMAP_TARGET  bit24

/* object is tagged as a child node in a yangmap nodemap */
#define OBJ_FL_YANGMAP_CHILD   bit25

/* object is tagged as a keymap node in a yangmap nodemap */
#define OBJ_FL_YANGMAP_KEY     bit26

/* indicates that DUP_LOCAL test has been done */
#define OBJ_FL_DUP_LOCAL_DONE  bit27

/* This bit is set in the agt_val_silcall to indicate that the
 * Transaction Hook is already setup for the object and that
 * any consecutive attempts to assign the hook to this object
 * should be skipped
 */
#define OBJ_FL_TRANS_HOOK_SET  bit29

/* This bit is set to indicate that the sil-test-get-when
 * override flag is set for the object which is expected
 * to be an  operational data node
 */
#define OBJ_FL_GET_WHEN_SET    bit30

/* This bit is set to indicate the value of the
 * override flag and is only used if OBJ_FL_GET_WHEN_SET
 * bit is set to 1
 */
#define OBJ_FL_GET_WHEN        bit31


/********* xflags2 field in obj_template_t *************/
 /* xflags2 is a continuation of xflags bits */

/* This bit is set to indicate that the sil-aio-get2
 * All in One extension flag is set for the object.
 */
#define OBJ_FL_AIO_GET2        bit0

/* This flag indicates that this object has All in One children
 * But itself it does not have this extension setup.
 * Will be set only if the current object is GET2 object with
 * GET2 flags setup.
 *
 * GET2 object but not All in One object, but a parent of AIO
 */
#define OBJ_FL_AIO_PARENT      bit1

/* This bit is set to indicate that the sil-aio-get2
 * All in One extension flag is set for the object and has XML
 * parameter setup.
 */
#define OBJ_FL_AIO_GET2_XML   bit2

/* This bit is set to indicate that the sil-aio-get2
 * All in One extension flag is set for the object and has JSON
 * parameter setup.
 */
#define OBJ_FL_AIO_GET2_JSON   bit3

/* This bit is set to check whether the object has Set Default
 * Hook callback and should invoke it in order to set custom
 * system default value BUT only if there is no any YANG defaults.
 */
#define OBJ_FL_DEF_HOOK   bit4

/* This bit indicates that the leaf or leaf-list is really
 * an openconfig-hashed-value string not a plain string
 * and not an ncx:password
 */
#define OBJ_FL_OC_HASHED_VALUE bit5

/* This bit is set to indicate that the object is NOT OK for nolock-get
 * Use on config=false nodes that it is not safe to GET in the
 * PTHREADS build without a rdlock on running
 */
#define OBJ_FL_BAN_NOLOCK_GET  bit6


/********* uflags field in obj_template_t *************/

/* This field represents the user flags and no system bits
 * are defined for this field. It is used by yang_obj_cb
 * callback functions to set user-specific flags
 */

/********* silflags field in obj_template_t *************/

/* This bit is set in agt_rpc to indicate the RPC is
 * currently being invoked;  If another session attempts
 * to invoke the RPC while busy, and the obj_is_exclusive_rpc
 * the RPC request will be rejected by the server
 */
#define OBJ_FL_SIL_BUSY      bit0

#define OBJ_TYPE(OBJ)   (OBJ)->objtype

#define OBJ_INDEX(OBJ)   (OBJ)->index

/* mark the object as a top object since the yang_obj does
 * not catch top-level uses from a grouping as a top object
 */
#define OBJ_SET_TOP(OBJ)  (OBJ)->flags |= OBJ_FL_TOP

#define OBJ_SET_SIL_BUSY(OBJ)  (OBJ)->silflags |= OBJ_FL_SIL_BUSY

#define OBJ_CLEAR_SIL_BUSY(OBJ)  (OBJ)->silflags &= ~OBJ_FL_SIL_BUSY

#define OBJ_IS_SIL_BUSY(OBJ)  ((OBJ)->silflags & OBJ_FL_SIL_BUSY)

#define OBJ_GET_CBSET(OBJ) (OBJ)->cbset


/* Get2 support */
#define OBJ_SET_REMOTE_GET2(OBJ)  (OBJ)->xflags |= OBJ_FL_REMOTE_GET2

#define OBJ_CLEAR_REMOTE_GET2(OBJ)  (OBJ)->xflags &= ~OBJ_FL_REMOTE_GET2

#define OBJ_HAS_REMOTE_GET2(OBJ)  ((OBJ)->xflags & OBJ_FL_REMOTE_GET2)

#define OBJ_SET_GET2CB(OBJ, CB) (OBJ)->get2cb = CB

#define OBJ_GET_GET2CB(OBJ) (getcb_fn2_t)(OBJ)->get2cb

#define OBJ_SET_EDIT2_MODE(OBJ) (OBJ)->xflags |= OBJ_FL_EDIT2_MODE

#define OBJ_IS_EDIT2_MODE(OBJ) ((OBJ)->xflags & OBJ_FL_EDIT2_MODE)


/* XPath tuning */
#define OBJ_SET_SKIP_LEAFREF(OBJ) (OBJ)->xflags |= OBJ_FL_SKIP_LEAFREF

#define OBJ_IS_SKIP_LEAFREF(OBJ) ((OBJ)->xflags & OBJ_FL_SKIP_LEAFREF)



/* Object YANG Hash */
#define OBJ_SET_YANG_HASH(OBJ) (OBJ)->xflags |= OBJ_FL_YANG_HASH

#define OBJ_IS_YANG_HASH(OBJ) ((OBJ)->xflags & OBJ_FL_YANG_HASH)


/* Object Rehash */
#define OBJ_SET_YANG_REHASH(OBJ) (OBJ)->xflags |= OBJ_FL_YANG_REHASH

#define OBJ_IS_YANG_REHASH(OBJ) ((OBJ)->xflags & OBJ_FL_YANG_REHASH)


/* CBSET Malloced */
#define OBJ_SET_CBSET_MALLOCED(OBJ) (OBJ)->xflags |= OBJ_FL_CBSET_MALLOCED

#define OBJ_IS_CBSET_MALLOCED(OBJ) ((OBJ)->xflags & OBJ_FL_CBSET_MALLOCED)

#define OBJ_CLEAR_CBSET_MALLOCED(OBJ)  (OBJ)->xflags &= ~OBJ_FL_CBSET_MALLOCED

/* Object is generic */
#define OBJ_SET_GENERIC(OBJ) (OBJ)->xflags |= OBJ_FL_GENERIC

#define OBJ_IS_GENERIC(OBJ) ((OBJ)->xflags & OBJ_FL_GENERIC)


/* Object or children have a default value */
#define OBJ_SET_DEF_DONE(OBJ) (OBJ)->xflags |= OBJ_FL_DEF_DONE

#define OBJ_IS_DEF_DONE(OBJ) ((OBJ)->xflags & OBJ_FL_DEF_DONE)

#define OBJ_SET_DEF(OBJ) (OBJ)->xflags |= OBJ_FL_DEF

#define OBJ_IS_DEF(OBJ) ((OBJ)->xflags & OBJ_FL_DEF)

/* Object is an RPC that is allowed in library mode */
#define OBJ_SET_LIBMODE(OBJ) (OBJ)->xflags |= OBJ_FL_LIBMODE

#define OBJ_IS_LIBMODE(OBJ) ((OBJ)->xflags & OBJ_FL_LIBMODE)

#define OBJ_USER_FLAGS(OBJ) (OBJ)->uflags

/* get the object pointer in an obj_key_t */
#define OBJ_KEY_OBJ(K) (K)->keyobj

/* get the current edit transaction id;
 *  -- changed on each transaction this object is tested
 */
#define OBJ_EDIT_TXID(OBJ) (OBJ)->edit_txid

#define OBJ_EXTR_MUST_TXID(OBJ) (OBJ)->must_txid
#define OBJ_EXTR_WHEN_TXID(OBJ) (OBJ)->when_txid
#define OBJ_EXTR_LEAFREF_TXID(OBJ) (OBJ)->leafref_txid


/* Object is flagged no-nvstore */
#define OBJ_SET_NO_NVSTORE(OBJ) (OBJ)->xflags |= OBJ_FL_NO_NVSTORE

#define OBJ_IS_NO_NVSTORE(OBJ) ((OBJ)->xflags & OBJ_FL_NO_NVSTORE)


/* Object is flagged yangmap-source */
#define OBJ_SET_YANGMAP_SOURCE(OBJ) \
    (OBJ)->xflags |= OBJ_FL_YANGMAP_SOURCE

#define OBJ_IS_YANGMAP_SOURCE(OBJ) \
    ((OBJ)->xflags & OBJ_FL_YANGMAP_SOURCE)


/* Object is flagged yangmap-target */
#define OBJ_SET_YANGMAP_TARGET(OBJ) \
    (OBJ)->xflags |= OBJ_FL_YANGMAP_TARGET

#define OBJ_IS_YANGMAP_TARGET(OBJ) \
    ((OBJ)->xflags & OBJ_FL_YANGMAP_TARGET)

/* Object is flagged yangmap-childmap */
#define OBJ_SET_YANGMAP_CHILD(OBJ) \
    (OBJ)->xflags |= OBJ_FL_YANGMAP_CHILD

#define OBJ_IS_YANGMAP_CHILD(OBJ) \
    ((OBJ)->xflags & OBJ_FL_YANGMAP_CHILD)

/* Object is flagged yangmap-keymap */
#define OBJ_SET_YANGMAP_KEY(OBJ) \
    (OBJ)->xflags |= OBJ_FL_YANGMAP_KEY

#define OBJ_IS_YANGMAP_KEY(OBJ) \
    ((OBJ)->xflags & OBJ_FL_YANGMAP_KEY)

/* if OBJ_IS_YANGMAP_SOURCE : yangmap_cb == nodemap_t
 * if OBJ_IS_YANGMAP_TARGET : yangmap_cb == nodemap_t
 * if OBJ_IS_YANGMAP_CHILD  : yangmap_cb == childmap_t
 * if OBJ_IS_YANGMAP_KEY    : yangmap_cb == keymap_t
 */
#define OBJ_YANGMAP_CB(OBJ) (OBJ)->yangmap_cb

/* Object DUP_LOCAL test has been done */
#define OBJ_SET_DUP_LOCAL_DONE(OBJ) \
    (OBJ)->xflags |= OBJ_FL_DUP_LOCAL_DONE

#define OBJ_IS_DUP_LOCAL_DONE(OBJ) \
    ((OBJ)->xflags & OBJ_FL_DUP_LOCAL_DONE)


#define OBJ_RPC_SUPPORTED(OBJ) (OBJ)->def.rpc->supported


/* Trans Hook assignment bits */
#define OBJ_SET_TRANS_HOOK_SET(OBJ) (OBJ)->xflags |= OBJ_FL_TRANS_HOOK_SET
#define OBJ_IS_TRANS_HOOK_SET(OBJ) ((OBJ)->xflags & OBJ_FL_TRANS_HOOK_SET)
#define OBJ_CLEAR_TRANS_HOOK_SET(OBJ) (OBJ)->xflags &= ~OBJ_FL_TRANS_HOOK_SET


/* All in One assignment bits */
#define OBJ_SET_AIO_GET2(OBJ) (OBJ)->xflags2 |= OBJ_FL_AIO_GET2
#define OBJ_IS_AIO_GET2(OBJ) ((OBJ)->xflags2 & OBJ_FL_AIO_GET2)

/* GET2 object but not All in One object, but a parent of AIO */
#define OBJ_SET_AIO_PARENT(OBJ) (OBJ)->xflags2 |= OBJ_FL_AIO_PARENT
#define OBJ_IS_AIO_PARENT(OBJ) ((OBJ)->xflags2 & OBJ_FL_AIO_PARENT)

/* AIO with XML/JSON support flags*/
#define OBJ_SET_AIO_GET2_XML(OBJ) (OBJ)->xflags2 |= OBJ_FL_AIO_GET2_XML
#define OBJ_IS_AIO_GET2_XML(OBJ) ((OBJ)->xflags2 & OBJ_FL_AIO_GET2_XML)

#define OBJ_SET_AIO_GET2_JSON(OBJ) (OBJ)->xflags2 |= OBJ_FL_AIO_GET2_JSON
#define OBJ_IS_AIO_GET2_JSON(OBJ) ((OBJ)->xflags2 & OBJ_FL_AIO_GET2_JSON)

/* Dynamic Default Hook assignment bits */
#define OBJ_SET_DEF_HOOK(OBJ)   (OBJ)->xflags2 |= OBJ_FL_DEF_HOOK
#define OBJ_IS_DEF_HOOK(OBJ)    ((OBJ)->xflags2 & OBJ_FL_DEF_HOOK)
#define OBJ_CLEAR_DEF_HOOK(OBJ) (OBJ)->xflags2 &= ~OBJ_FL_DEF_HOOK
#define OBJ_GET_DEF_HOOK_CB(OBJ) (ncx_def_hook_cbfn_t)(OBJ)->def_hook_cb

/* openconfig-hashed-value bit */
#define OBJ_SET_OC_HASHED_VALUE(OBJ)   (OBJ)->xflags2 |= OBJ_FL_OC_HASHED_VALUE
#define OBJ_IS_OC_HASHED_VALUE(OBJ)    ((OBJ)->xflags2 & OBJ_FL_OC_HASHED_VALUE)

/* Static Ban Nock GET assignment bits */
#define OBJ_SET_BAN_NOLOCK_GET(OBJ)   (OBJ)->xflags2 |= OBJ_FL_BAN_NOLOCK_GET
#define OBJ_IS_BAN_NOLOCK_GET(OBJ)    ((OBJ)->xflags2 & OBJ_FL_BAN_NOLOCK_GET)


/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/

// Header Only
typedef enum obj_type_t_ {
    OBJ_TYP_NONE,          
    OBJ_TYP_ANYXML,

    OBJ_TYP_CONTAINER,

    OBJ_TYP_LEAF,

    OBJ_TYP_LEAF_LIST,

    OBJ_TYP_LIST,

    OBJ_TYP_CHOICE,

    OBJ_TYP_CASE,          
    OBJ_TYP_USES,

    OBJ_TYP_REFINE,

    OBJ_TYP_AUGMENT,

    OBJ_TYP_RPC,


    OBJ_TYP_RPCIO,         
    OBJ_TYP_NOTIF,

    OBJ_TYP_ANYDATA,

    OBJ_TYP_ACTION         
} YPACK obj_type_t;


#define OBJ_TYP_LAST OBJ_TYP_ACTION

typedef uint16  obj_index_t;


typedef enum obj_augtype_t_ {
    OBJ_AUGTYP_NONE,     
    OBJ_AUGTYP_RPCIN,    
    OBJ_AUGTYP_RPCOUT,   
    OBJ_AUGTYP_CASE,     
    OBJ_AUGTYP_DATA      
} obj_augtype_t;


typedef struct obj_key_t_ {
    dlq_hdr_t       qhdr;           
    struct obj_template_t_ *keyobj; 
    boolean         seen;   
} YPACK obj_key_t;


typedef struct obj_defval_tk_t_ {
    dlq_hdr_t       qhdr;           
    xmlChar        *def;            
    ncx_error_t     def_tkerr;      
} YPACK obj_defval_tk_t;


typedef struct obj_unique_comp_t_ {
    dlq_hdr_t               qhdr;       
    struct obj_template_t_ *unobj;      
    xmlChar                 *xpath;     
    boolean                  isduplicate;  
} YPACK obj_unique_comp_t;


typedef struct obj_unique_t_ {
    dlq_hdr_t       qhdr;        
    xmlChar        *xpath;       
    dlq_hdr_t       compQ;       
    boolean         seen;        
    boolean         isconfig;    
    ncx_error_t     tkerr;       
} YPACK obj_unique_t;


typedef struct obj_container_t_ {
    xmlChar       *name;

    xmlChar       *descr;

    xmlChar       *ref;

    xmlChar       *presence;
    dlq_hdr_t     *typedefQ;       
    dlq_hdr_t     *groupingQ;      
    dlq_hdr_t     *datadefQ;       
    ncx_status_t   status;         
    dlq_hdr_t      mustQ;          
    struct obj_template_t_ *defaultparm;  
    obj_index_t    last_index;
} YPACK obj_container_t;


typedef struct obj_leaf_t_ {
    xmlChar       *name;

    xmlChar       *units;

    xmlChar       *defval;

    xmlChar       *descr;

    xmlChar       *ref;

    typ_def_t     *typdef;

    ncx_status_t   status;

    uint16         keynum;

    dlq_hdr_t      mustQ;     
    dlq_hdr_t      leafrefQ;  
    struct obj_template_t_ *leafrefobj;
} YPACK obj_leaf_t;


typedef struct obj_leaflist_t_ {
    xmlChar       *name;

    xmlChar       *units;

    xmlChar       *descr;

    xmlChar       *ref;

    typ_def_t     *typdef;

    boolean        defset;   
    boolean        ordersys; 
    boolean        minset;   
    uint32         minelems; 
    boolean        maxset;   
    uint32         maxelems; 
    ncx_status_t   status;   
    dlq_hdr_t      mustQ;    
    dlq_hdr_t      leafrefQ;  
    dlq_hdr_t      defvalQ;   
    struct obj_template_t_ *leafrefobj;
} YPACK obj_leaflist_t;


typedef struct obj_list_t_ {
    xmlChar       *name;

    xmlChar       *keystr;

    xmlChar       *descr;

    xmlChar       *ref;
    dlq_hdr_t     *typedefQ;      
    dlq_hdr_t     *groupingQ;     
    dlq_hdr_t     *datadefQ;      
    dlq_hdr_t      keyQ;          
    dlq_hdr_t      uniqueQ;       
    boolean        ordersys;      
    boolean        minset;   
    uint32         minelems; 
    boolean        maxset;   
    uint32         maxelems; 
    ncx_status_t   status;   
    dlq_hdr_t      mustQ;    
    ncx_error_t    keytkerr;

    obj_index_t    last_index;
} YPACK obj_list_t;


typedef struct obj_choice_t_ {
    xmlChar       *name;          
    xmlChar       *defval;        
    xmlChar       *descr;

    xmlChar       *ref;
    dlq_hdr_t     *caseQ;         
    boolean        caseQclone;    
    ncx_status_t   status;        
} YPACK obj_choice_t;


typedef struct obj_case_t_ {
    xmlChar        *name;            
    xmlChar       *descr;

    xmlChar       *ref;

    dlq_hdr_t      *datadefQ;         
    boolean         nameclone;
    ncx_status_t    status;   
} YPACK obj_case_t;


typedef struct obj_uses_t_ {
    xmlChar          *prefix;    
    xmlChar          *name;      
    xmlChar       *descr;

    xmlChar       *ref;
    grp_template_t   *grp;      
    dlq_hdr_t        *datadefQ;     
    ncx_status_t      status;   
    boolean           expand_done;  
} YPACK obj_uses_t;


typedef struct obj_refine_t_ {
    xmlChar          *target;

    struct obj_template_t_ *targobj;

    xmlChar          *descr;

    ncx_error_t       descr_tkerr;

    xmlChar          *ref;

    ncx_error_t       ref_tkerr;

    xmlChar          *presence;

    ncx_error_t       presence_tkerr;

    dlq_hdr_t           defval_tkQ;   
    ncx_error_t       config_tkerr;

    ncx_error_t       mandatory_tkerr;
    uint32            minelems;       
    ncx_error_t       minelems_tkerr;   
    uint32            maxelems;      
    ncx_error_t       maxelems_tkerr;   
    dlq_hdr_t         mustQ;        
} YPACK obj_refine_t;


typedef struct obj_rpcio_t_ {
    xmlChar           *name;            
    dlq_hdr_t         *typedefQ;        
    dlq_hdr_t         *groupingQ;       
    dlq_hdr_t          datadefQ;        
    dlq_hdr_t          mustQ;           
    boolean            is_input;

    struct obj_template_t_ *defaultparm;
} YPACK obj_rpcio_t;


typedef struct obj_rpc_t_ {
    xmlChar           *name;

    xmlChar       *descr;

    xmlChar       *ref;

    ncx_status_t       status;           
    dlq_hdr_t         *typedefQ;         
    dlq_hdr_t         *groupingQ;        
    dlq_hdr_t          datadefQ;         
    boolean            is_action;        
    xmlns_id_t      nsid;
    boolean         supported;    
} YPACK obj_rpc_t;


typedef struct obj_augment_t_ {
    xmlChar          *target;

    xmlChar       *descr;

    xmlChar       *ref;

    struct obj_template_t_ *targobj;

    obj_augtype_t     augtype;
    ncx_status_t      status;       
    dlq_hdr_t         datadefQ;     
    uint16            depth;        
} YPACK obj_augment_t;


typedef struct obj_notif_t_ {
    xmlChar          *name;

    xmlChar       *descr;

    xmlChar       *ref;
    ncx_status_t      status;        
    dlq_hdr_t        *typedefQ;      
    dlq_hdr_t        *groupingQ;     
    dlq_hdr_t         datadefQ;      
    dlq_hdr_t         mustQ;         
    boolean           notif_enabled; 
    boolean           notif_log_drops;  
    boolean           in_data;       
} YPACK obj_notif_t;


typedef struct obj_iffeature_ptr_t_ {
    dlq_hdr_t            qhdr;       
    ncx_iffeature_t     *iffeature;  
} YPACK obj_iffeature_ptr_t;


typedef struct obj_errmsg_filter_t_ {
    dlq_hdr_t qhdr;        
    xmlChar *matchstr;     
    boolean  is_errortag;  
} YPACK obj_errmsg_filter_t;


typedef struct obj_errmsg_parm_t_ {
    dlq_hdr_t qhdr;       
    xmlChar *path;        
    uint32 len;

    xmlChar *valstr;
} YPACK obj_errmsg_parm_t;


typedef struct obj_errmsg_t_ {
    dlq_hdr_t qhdr;      
    xmlChar *basestr;    
    xmlChar *langstr;    
    dlq_hdr_t parmQ;     
    dlq_hdr_t filterQ;   
} YPACK obj_errmsg_t;


typedef unsigned long oid_t;

typedef struct obj_oid_t_ {
    uint8           cnt;       
    oid_t           *oidc;     
} YPACK obj_oid_t;


typedef uint8 obj_testflags_t;


typedef struct obj_template_t_ {
    dlq_hdr_t               qhdr;          
    obj_type_t              objtype;       
    uint32                  yang_hash;     
    uint32                  flags;             
    uint32                  xflags;            
    uint32                  xflags2;           
    uint32                  uflags;            
    uint8                   silflags;          
    uint8                   sil_priority;      
    obj_testflags_t         testflags;         
    obj_testflags_t         desc_testflags;    
    ncx_error_t             tkerr;             
    grp_template_t          *grp;              
    obj_index_t             index;             
    obj_oid_t               *oid;              
    boolean                 set_snmp_flags;    
    boolean                 xpath_oper_ok;     
    struct obj_template_t_  *parent;           
    struct obj_template_t_  *usesobj;          
    struct obj_template_t_  *augobj;           
    struct xpath_pcb_t_     *when;             
    dlq_hdr_t               metadataQ;         
    dlq_hdr_t               appinfoQ;          
    dlq_hdr_t               iffeatureQ;        
    dlq_hdr_t               inherited_iffeatureQ;   
    dlq_hdr_t               inherited_whenQ;

    dlq_hdr_t               *dataruleQ;

    void                    *cbset;

    void                    *get2cb;

    struct ncx_module_t_    *mod;

    xmlns_id_t              nsid;

    struct xpath_pcb_t_     *xpath_backptr[OBJ_NUM_XPATH_BACKPTRS];

    dlq_hdr_t               xpath_backptrQ;  // backptr to xpath_pcb_t

    void                    *commit_test_cb;

    dlq_hdr_t               *errmsgQ;    // Q of obj_errmsg_t

    void                    *yangmap_cb;

    ncx_transaction_id_t    edit_txid;

    ncx_transaction_id_t    must_txid;

    ncx_transaction_id_t    when_txid;

    ncx_transaction_id_t    leafref_txid;

    union def_ {
        obj_container_t   *container;
        obj_leaf_t        *leaf;
        obj_leaflist_t    *leaflist;
        obj_list_t        *list;
        obj_choice_t      *choic;
        obj_case_t        *cas;
        obj_uses_t        *uses;
        obj_refine_t      *refine;
        obj_augment_t     *augment;
        obj_rpc_t         *rpc;
        obj_rpcio_t       *rpcio;
        obj_notif_t       *notif;
    } def;

    void                    *def_hook_cb;

} YPACK obj_template_t;


typedef struct obj_metadata_t_ {
    dlq_hdr_t      qhdr;              
    struct obj_template_t_ *parent;   
    xmlChar       *name;              
    typ_def_t     *typdef;            
    xmlns_id_t     nsid;              
    ncx_error_t    tkerr;             
    boolean        typdef_copy;   
} YPACK obj_metadata_t;


typedef enum obj_deviate_arg_t_ {
    OBJ_DARG_NONE,           
    OBJ_DARG_ADD,            
    OBJ_DARG_DELETE,         
    OBJ_DARG_REPLACE,        
    OBJ_DARG_NOT_SUPPORTED   
}  YPACK obj_deviate_arg_t;


typedef struct obj_deviate_t_ {
    dlq_hdr_t          qhdr;     
    ncx_error_t       tkerr;

    boolean           empty;

    obj_deviate_arg_t arg;

    ncx_error_t       arg_tkerr;

    typ_def_t        *typdef;

    ncx_error_t       type_tkerr;

    xmlChar          *units;

    ncx_error_t       units_tkerr;

    dlq_hdr_t         defval_tkQ;

    boolean           config;

    ncx_error_t       config_tkerr;

    boolean           mandatory;

    ncx_error_t       mandatory_tkerr;

    uint32            minelems;
    ncx_error_t       minelems_tkerr;   
    uint32            maxelems;
    ncx_error_t       maxelems_tkerr;   
    dlq_hdr_t         mustQ;     
    dlq_hdr_t         uniqueQ;   
    dlq_hdr_t         appinfoQ;  
} YPACK obj_deviate_t;


typedef struct obj_deviation_t_ {
    dlq_hdr_t             qhdr;        
    xmlChar              *target;      
    xmlChar              *targmodname; 
    obj_template_t       *targobj;     
    xmlChar       *descr;

    xmlChar       *ref;

    ncx_error_t           tkerr;
    xmlChar              *devmodname;  
    boolean               empty;       
    boolean               annotation;  
    status_t              res;         
    dlq_hdr_t             deviateQ;    
    dlq_hdr_t             appinfoQ;    
} YPACK obj_deviation_t;


typedef boolean
    (*obj_walker_fn_t) (obj_template_t *obj,
                        void *cookie1,
                        void *cookie2,
                        boolean nonconfig_warn);


#define OBJ_SET_TESTFLAGS(OBJ, FL) (OBJ)->testflags = FL

#define OBJ_GET_TESTFLAGS(OBJ) (OBJ)->testflags

#define OBJ_SET_DESC_TESTFLAGS(OBJ, FL) (OBJ)->desc_testflags = FL

#define OBJ_GET_DESC_TESTFLAGS(OBJ) (OBJ)->desc_testflags

#define OBJ_UPDATE_DESC_TESTFLAGS(OBJ, FL) (OBJ)->desc_testflags |= FL

/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/

extern obj_template_t *
    obj_new_template (obj_type_t objtype);


extern void
    obj_free_template (obj_template_t *obj);


extern obj_template_t *
    obj_find_template (dlq_hdr_t  *que,
                       const xmlChar *modname,
                       const xmlChar *objname);


extern obj_template_t *
    obj_find_schema_template ( dlq_hdr_t  *que,
                               const xmlChar *modname,
                               const xmlChar *objname );


extern const obj_template_t *
    obj_find_template_con (dlq_hdr_t  *que,
                           const xmlChar *modname,
                           const xmlChar *objname);


extern obj_template_t *
    obj_find_template_test (dlq_hdr_t  *que,
                            const xmlChar *modname,
                            const xmlChar *objname);


extern obj_template_t *
    obj_find_template_top (ncx_module_t *mod,
                           const xmlChar *modname,
                           const xmlChar *objname);


extern obj_template_t *
    obj_find_template_top_lrcheck (ncx_module_t *mod,
                                   const xmlChar *modname,
                                   const xmlChar *objname);


extern obj_template_t *
    obj_find_template_top_ex (ncx_module_t *mod,
                              const xmlChar *modname,
                              const xmlChar *objname,
                              ncx_name_match_t match_names,
                              boolean alt_names,
                              boolean dataonly,
                              status_t *retres);


extern obj_template_t *
    obj_find_template_all (ncx_module_t *mod,
                           const xmlChar *modname,
                           const xmlChar *objname);


extern obj_template_t *
    obj_find_child (obj_template_t  *obj,
                    const xmlChar *modname,
                    const xmlChar *objname);


extern obj_template_t *
    obj_find_child_lrcheck (obj_template_t *obj,
                            const xmlChar *modname,
                            const xmlChar *objname);


extern obj_template_t *
    obj_find_child_choice_case (obj_template_t *obj,
                                const xmlChar *modname,
                                const xmlChar *objname);


extern obj_template_t *
    obj_find_child_fast (obj_template_t *obj,
                         xmlns_id_t nsid,
                         const xmlChar *objname);


extern obj_template_t *
    obj_find_child_ex (obj_template_t  *obj,
                       const xmlChar *modname,
                       const xmlChar *objname,
                       ncx_name_match_t match_names,
                       boolean alt_names,
                       boolean dataonly,
                       status_t *retres);


extern obj_template_t *
    obj_find_child_str (obj_template_t  *obj,
                        const xmlChar *modname,
                        const xmlChar *objname,
                        uint32 objnamelen);


extern obj_template_t *
    obj_match_child_str (obj_template_t *obj,
                         const xmlChar *modname,
                         const xmlChar *objname,
                         uint32 objnamelen,
                         uint32 *matchcount);


extern obj_template_t *
    obj_first_child (obj_template_t *obj);


extern obj_template_t *
    obj_first_terminal_child (obj_template_t *obj);


extern obj_template_t *
    obj_first_terminal_child_nokey (obj_template_t *obj);


extern obj_template_t *
    obj_last_child (obj_template_t *obj);


extern obj_template_t *
    obj_next_child (obj_template_t *obj);


extern obj_template_t *
    obj_next_terminal_child (obj_template_t *obj);


extern obj_template_t *
    obj_next_terminal_child_nokey (obj_template_t *obj);


extern obj_template_t *
    obj_first_child_augok (obj_template_t *obj);


extern obj_template_t *
    obj_next_child_augok (obj_template_t *obj);


extern obj_template_t *
    obj_previous_child (obj_template_t *obj);


extern obj_template_t *
    obj_first_child_deep (obj_template_t *obj);


extern obj_template_t *
    obj_next_child_deep (obj_template_t *obj);


extern obj_template_t *
    obj_next_child_deep_ex (obj_template_t *obj,
                            boolean stopnext);


extern boolean
    obj_find_all_children (ncx_module_t *exprmod,
                           obj_walker_fn_t walkerfn,
                           void *cookie1,
                           void *cookie2,
                           obj_template_t *startnode,
                           const xmlChar *modname,
                           const xmlChar *childname,
                           boolean configonly,
                           boolean textmode,
                           boolean useroot);


extern boolean
    obj_find_all_ancestors (ncx_module_t *exprmod,
                            obj_walker_fn_t walkerfn,
                            void *cookie1,
                            void *cookie2,
                            obj_template_t *startnode,
                            const xmlChar *modname,
                            const xmlChar *name,
                            boolean configonly,
                            boolean textmode,
                            boolean useroot,
                            boolean orself,
                            boolean *fncalled);


extern boolean
    obj_find_all_descendants (ncx_module_t *exprmod,
                              obj_walker_fn_t walkerfn,
                              void *cookie1,
                              void *cookie2,
                              obj_template_t *startnode,
                              const xmlChar *modname,
                              const xmlChar *name,
                              boolean configonly,
                              boolean textmode,
                              boolean useroot,
                              boolean orself,
                              boolean *fncalled);


extern boolean
    obj_find_all_pfaxis (ncx_module_t *exprmod,
                         obj_walker_fn_t walkerfn,
                         void *cookie1,
                         void *cookie2,
                         obj_template_t *startnode,
                         const xmlChar *modname,
                         const xmlChar *name,
                         boolean configonly,
                         boolean dblslash,
                         boolean textmode,
                         boolean useroot,
                         ncx_xpath_axis_t axis,
                         boolean *fncalled);


extern obj_case_t *
    obj_find_case (obj_choice_t *choic,
                   const xmlChar *modname,
                   const xmlChar *casname);



extern obj_template_t *
    obj_new_rpcio (obj_template_t *rpcobj,
                   const xmlChar *name);


extern void
    obj_clean_datadefQ (dlq_hdr_t *que);


extern typ_template_t *
    obj_find_type (obj_template_t *obj,
                   const xmlChar *typname);


extern typ_template_t *
    obj_first_typedef (obj_template_t *obj);


extern grp_template_t *
    obj_find_grouping (obj_template_t *obj,
                       const xmlChar *grpname);

extern grp_template_t *
    obj_first_grouping (obj_template_t *obj);


extern status_t
    obj_set_named_type (void *pcb,  // yang_pcb_t
                        tk_chain_t *tkc,
                        ncx_module_t *mod,
                        const xmlChar *typname,
                        typ_def_t *typdef,
                        obj_template_t *parent,
                        grp_template_t *grp);


extern obj_template_t *
    obj_clone_template (ncx_module_t *mod,
                        obj_template_t *srcobj,
                        dlq_hdr_t *mobjQ);


extern obj_template_t *
    obj_clone_template_case (ncx_module_t *mod,
                             obj_template_t *srcobj,
                             dlq_hdr_t *mobjQ);


/********************    obj_unique_t   ********************/


extern obj_unique_t *
    obj_new_unique (void);


extern void
    obj_init_unique (obj_unique_t *un);


extern void
    obj_free_unique (obj_unique_t *un);


extern void
    obj_clean_unique (obj_unique_t *un);


extern obj_unique_comp_t *
    obj_new_unique_comp (void);


extern void
    obj_free_unique_comp (obj_unique_comp_t *unc);


extern obj_unique_t *
    obj_find_unique (dlq_hdr_t *que,
                     const xmlChar *xpath);


extern obj_unique_t *
    obj_first_unique (obj_template_t *listobj);


extern obj_unique_t *
    obj_next_unique (obj_unique_t *un);


extern obj_unique_comp_t *
    obj_first_unique_comp (obj_unique_t *un);


extern obj_unique_comp_t *
    obj_next_unique_comp (obj_unique_comp_t *uncomp);


extern obj_key_t *
    obj_new_key (void);


extern void
    obj_free_key (obj_key_t *key);


extern obj_key_t *
    obj_find_key (dlq_hdr_t *que,
                  const xmlChar *keycompname);


extern obj_key_t *
    obj_find_key2 (dlq_hdr_t *que,
                   obj_template_t *keyobj);


extern obj_key_t *
    obj_first_key (obj_template_t *obj);


extern obj_key_t *
    obj_last_key (obj_template_t *obj);


extern const obj_key_t *
    obj_first_ckey (const obj_template_t *obj);


extern obj_key_t *
    obj_next_key (obj_key_t *objkey);


extern obj_key_t *
    obj_prev_key (obj_key_t *objkey);


extern const obj_key_t *
    obj_next_ckey (const obj_key_t *objkey);


extern uint32
    obj_key_count (const obj_template_t *obj);


extern uint32
    obj_key_count_to_root (obj_template_t *obj);


extern void
    obj_traverse_keys (obj_template_t *obj,
                       void *cookie1,
                       void *cookie2,
                       obj_walker_fn_t walkerfn);


extern boolean
    obj_any_rpcs (const dlq_hdr_t *datadefQ);


extern boolean
    obj_any_notifs (const dlq_hdr_t *datadefQ);


extern obj_deviate_t *
    obj_new_deviate (void);


extern void
    obj_free_deviate (obj_deviate_t *deviate);


extern const xmlChar *
    obj_get_deviate_arg (obj_deviate_arg_t devarg);


extern obj_deviation_t *
    obj_new_deviation (void);


extern void
    obj_free_deviation (obj_deviation_t *deviation);


extern void
    obj_clean_deviationQ (dlq_hdr_t *deviationQ);


extern status_t
    obj_gen_object_id (const obj_template_t *obj,
                       xmlChar  **buff);


extern status_t
    obj_gen_object_id_prefix (const obj_template_t *obj, xmlChar **buff);


extern status_t
    obj_gen_object_id_oid (ncx_module_t *mod,
                           const obj_template_t *obj,
                           xmlChar  **buff);


extern status_t
    obj_gen_object_id_xpath (const obj_template_t *obj,
                             xmlChar  **buff);


extern status_t obj_gen_object_id_error (const obj_template_t *obj,
                                         xmlChar  **buff);


extern status_t obj_gen_object_id_unique (const obj_template_t *obj,
                                          const obj_template_t *stopobj,
                                          xmlChar  **buff);


extern status_t
    obj_gen_object_id_code (ncx_module_t *mod,
                            const obj_template_t *obj,
                            xmlChar  **buff);


extern status_t
    obj_copy_object_id (const obj_template_t *obj,
                        xmlChar  *buff,
                        uint32 bufflen,
                        uint32 *reallen);


extern status_t
    obj_copy_object_id_mod (const obj_template_t *obj,
                            xmlChar  *buff,
                            uint32 bufflen,
                            uint32 *reallen);


extern status_t
    obj_gen_aughook_id (const obj_template_t *obj,
                        xmlChar  **buff);


extern const xmlChar *
    obj_get_name (const obj_template_t *obj);


extern status_t
    obj_set_name (obj_template_t *obj,
                  const xmlChar *objname);


extern boolean
    obj_has_name (const obj_template_t *obj);


extern boolean
    obj_has_text_content (const obj_template_t *obj);


extern ncx_status_t
    obj_get_status (const obj_template_t *obj);


extern const xmlChar *
    obj_get_description (const obj_template_t *obj);


extern const xmlChar *
    obj_get_alt_description (const obj_template_t *obj);


extern const xmlChar *
    obj_get_help_description (const obj_template_t *obj);


extern const xmlChar *
    obj_get_info_description (const obj_template_t *obj);


extern const void *
    obj_get_description_addr (const obj_template_t *obj);


extern const xmlChar *
    obj_get_reference (const obj_template_t *obj);


extern const void *
    obj_get_reference_addr (const obj_template_t *obj);


#define obj_is_config obj_get_config_flag_deep


extern boolean
    obj_get_config_flag (const obj_template_t *obj);


extern boolean
    obj_get_config_flag2 (const obj_template_t *obj,
                          boolean *setflag);


extern ncx_access_t
    obj_get_max_access (const obj_template_t *obj);


extern dlq_hdr_t *
    obj_get_appinfoQ (obj_template_t *obj);


extern dlq_hdr_t *
    obj_get_mustQ (const obj_template_t *obj);


extern dlq_hdr_t *
    obj_get_leafrefQ (const obj_template_t *obj);


extern const xmlChar *
    obj_get_typestr (const obj_template_t *obj);


extern dlq_hdr_t *
    obj_get_datadefQ (obj_template_t *obj);


extern const dlq_hdr_t *
    obj_get_cdatadefQ (const obj_template_t *obj);


extern const xmlChar *
    obj_get_default (const obj_template_t *obj);


extern const xmlChar *
    obj_get_first_default (const obj_template_t *obj,
                           ncx_backptr_t **thisdef);


extern const xmlChar *
    obj_get_next_default (const obj_template_t *obj,
                          ncx_backptr_t *lastdef,
                          ncx_backptr_t **thisdef);


extern obj_template_t *
    obj_get_default_case (obj_template_t *obj);


extern boolean
    obj_npcon_has_defaults (obj_template_t *obj);


extern boolean
    obj_npcon_has_defaults_slow (obj_template_t *obj);


extern uint32
    obj_get_level (const obj_template_t *obj);


extern uint32
    obj_get_real_level (const obj_template_t *obj);


extern boolean
    obj_has_typedefs (const obj_template_t *obj);


extern typ_def_t *
    obj_get_typdef (obj_template_t  *obj);


extern typ_def_t *
    obj_get_base_typdef (obj_template_t  *obj);


extern const typ_def_t *
    obj_get_ctypdef (const obj_template_t  *obj);


extern ncx_btype_t
    obj_get_basetype (const obj_template_t  *obj);


extern const xmlChar *
    obj_get_mod_prefix (const obj_template_t *obj);


extern const xmlChar *
    obj_get_mod_xmlprefix (const obj_template_t  *obj);


extern const xmlChar *
    obj_get_mod_name (const obj_template_t  *obj);


extern ncx_module_t *
    obj_get_mod (obj_template_t  *obj);


extern boolean
    obj_in_submodule (obj_template_t  *obj);


extern ncx_module_t *
    obj_get_mod_for_dump (obj_template_t  *obj);


extern const xmlChar *
    obj_get_mod_version (const obj_template_t  *obj);


extern const xmlChar *
    obj_get_type_name (const obj_template_t  *obj);


extern xmlns_id_t
    obj_get_nsid (const obj_template_t *obj);


extern ncx_iqual_t
    obj_get_iqualval (obj_template_t  *obj);


extern ncx_iqual_t
    obj_get_iqualval_ex (obj_template_t  *obj,
                         boolean required);


extern boolean
    obj_get_min_elements (obj_template_t  *obj,
                          uint32 *minelems);


extern boolean
    obj_get_max_elements (obj_template_t  *obj,
                          uint32 *maxelems);


extern const xmlChar *
    obj_get_units (obj_template_t *obj);


extern obj_template_t *
    obj_get_parent (obj_template_t *obj);


extern const obj_template_t *
    obj_get_cparent (const obj_template_t *obj);


extern obj_template_t *
    obj_get_real_parent (obj_template_t *obj);


extern const obj_template_t *
    obj_get_real_cparent (const obj_template_t *obj);


extern const xmlChar *
    obj_get_presence_string (const obj_template_t *obj);


extern void *
    obj_get_presence_string_field (const obj_template_t *obj);


extern status_t
    obj_get_child_node (obj_template_t *obj,
                        obj_template_t *chobj,
                        const xml_node_t *curnode,
                        boolean xmlorder,
                        dlq_hdr_t *force_modQ,
                        obj_template_t **rettop,
                        obj_template_t **retobj);


extern uint32
    obj_get_child_count (const obj_template_t *obj);


extern obj_template_t *
    obj_get_default_parm (obj_template_t *obj);


extern boolean
    obj_get_config_flag_deep (const obj_template_t *obj);


extern boolean
    obj_get_config_flag_check (const obj_template_t *obj,
                               boolean *ingrp);


extern uint8
    obj_get_fraction_digits (const obj_template_t  *obj);


extern const ncx_iffeature_t *
    obj_get_first_iffeature (const obj_template_t *obj);


extern const ncx_iffeature_t *
    obj_get_next_iffeature (const ncx_iffeature_t *iffeature);


extern boolean
    obj_is_anyxml (const obj_template_t *obj);


extern boolean
    obj_is_anydata (const obj_template_t *obj);


extern boolean
    obj_is_any (const obj_template_t *obj);


extern boolean
    obj_is_leaf (const obj_template_t  *obj);


extern boolean
    obj_is_leaf_list (const obj_template_t  *obj);


extern boolean
    obj_is_list (const obj_template_t  *obj);


extern boolean obj_in_list (const obj_template_t  *obj);


extern boolean
    obj_is_container (const obj_template_t  *obj);


extern boolean
    obj_is_choice (const obj_template_t  *obj);


extern boolean
    obj_is_case (const obj_template_t  *obj);


extern boolean
    obj_is_uses (const obj_template_t  *obj);


extern boolean
    obj_is_leafy (const obj_template_t  *obj);


extern boolean obj_is_terminal (const obj_template_t  *obj);


extern boolean
    obj_is_mandatory (obj_template_t *obj);


extern boolean
    obj_is_mandatory_when_ex (obj_template_t *obj,
                              boolean config_only);


extern boolean
    obj_is_mandatory_when (obj_template_t *obj);


extern boolean
    obj_is_cloned (const obj_template_t *obj);


extern boolean
    obj_is_augclone (const obj_template_t *obj);


extern boolean
    obj_is_augment (const obj_template_t *obj);


extern boolean obj_in_augment (const obj_template_t *obj);


extern boolean
    obj_is_refine (const obj_template_t *obj);


extern boolean
    obj_is_data (const obj_template_t *obj);


extern boolean
    obj_is_data_db (const obj_template_t *obj);


extern boolean
    obj_is_data_node (const obj_template_t *obj);


extern boolean
    obj_in_rpc (const obj_template_t *obj);


extern boolean
    obj_in_rpc_reply (const obj_template_t *obj);


extern boolean
    obj_in_notif (const obj_template_t *obj);


extern boolean
    obj_is_rpc (const obj_template_t *obj);


extern boolean obj_is_rpcio (const obj_template_t *obj);


extern boolean obj_is_rpcio_input (const obj_template_t *obj);


extern boolean
    obj_is_action (const obj_template_t *obj);


extern boolean obj_in_action (const obj_template_t *obj);


extern boolean
    obj_is_notif (const obj_template_t *obj);


extern boolean
    obj_is_empty (const obj_template_t *obj);


extern boolean
    obj_is_match (const obj_template_t  *obj1,
                  const obj_template_t *obj2);


extern boolean
    obj_is_hidden (const obj_template_t *obj);


extern boolean
    obj_is_root (const obj_template_t *obj);


extern void
    obj_force_root (obj_template_t *obj);


extern boolean
    obj_is_rpc_root (const obj_template_t *obj);


extern boolean
    obj_is_password (const obj_template_t *obj);


extern boolean
    obj_is_xsdlist (const obj_template_t *obj);


extern boolean
    obj_is_cli (const obj_template_t *obj);


extern boolean obj_is_dirty (const obj_template_t *obj,
                             ncx_cfg_t cfgid);


extern boolean
    obj_is_key (const obj_template_t *obj);


extern boolean
    obj_is_abstract (const obj_template_t *obj);


extern boolean obj_in_abstract (const obj_template_t *obj);


extern boolean
    obj_is_deleted (const obj_template_t *obj);


extern boolean
    obj_is_deleted_ex (const obj_template_t *obj);


extern boolean
    obj_is_xpath_string (const obj_template_t *obj);


extern boolean
    obj_is_schema_instance_string (const obj_template_t *obj);


extern boolean
    obj_is_secure (const obj_template_t *obj);


extern boolean
    obj_is_very_secure (const obj_template_t *obj);


extern boolean
    obj_is_system_ordered (const obj_template_t *obj);


extern boolean
    obj_is_np_container (const obj_template_t *obj);


extern boolean
    obj_is_p_container (const obj_template_t *obj);


extern boolean
    obj_is_enabled (obj_template_t *obj);


extern boolean
    obj_has_iffeature (obj_template_t *obj);


extern boolean
    obj_is_single_instance (obj_template_t *obj);


extern boolean
    obj_is_short_case (obj_template_t *obj);


extern boolean
    obj_is_top (const obj_template_t *obj);


extern boolean
    obj_is_datapath (const obj_template_t *obj);


extern boolean
    obj_ok_for_cli (obj_template_t *obj);


extern boolean
    obj_has_children (obj_template_t *obj);


extern boolean
    obj_has_ro_children (obj_template_t *obj);


extern boolean obj_has_ro_descendants (obj_template_t *obj);


extern boolean obj_has_rw_children (obj_template_t *obj);


extern boolean obj_has_rw_children_ex (obj_template_t *obj,
                                       boolean term_only);


extern boolean
    obj_rpc_has_input (obj_template_t *obj);


extern boolean
    obj_rpc_has_output (obj_template_t *obj);


extern boolean
    obj_has_when_stmts (obj_template_t *obj);


extern obj_metadata_t *
    obj_new_metadata (void);


extern void
    obj_free_metadata (obj_metadata_t *meta);


extern status_t
    obj_add_metadata (obj_metadata_t *meta,
                      obj_template_t *obj);


extern obj_metadata_t *
    obj_find_metadata (const obj_template_t *obj,
                       const xmlChar *name);


extern obj_metadata_t *
    obj_first_metadata (const obj_template_t *obj);


extern obj_metadata_t *
    obj_next_metadata (const obj_metadata_t *meta);


extern void
    obj_sort_children (obj_template_t *obj);


extern void
    obj_set_ncx_flags (obj_template_t *obj);


extern uint32
    obj_enabled_child_count (obj_template_t *obj);


extern void
    obj_dump_child_list (log_debug_t lvl,
                         dlq_hdr_t *datadefQ,
                         uint32  startindent,
                         uint32 indent);


extern const xmlChar *
    obj_get_keystr (obj_template_t *obj);


extern void
    obj_delete_obsolete (dlq_hdr_t  *objQ);


extern const xmlChar *
    obj_get_altname (const obj_template_t *obj);


extern obj_template_t *
    obj_get_leafref_targobj (obj_template_t  *obj);


extern obj_template_t *
    obj_get_augment_targobj (obj_template_t  *obj);


extern const xmlChar *
    obj_get_augment_target (obj_template_t  *obj);


extern boolean
    obj_is_external_augment (obj_template_t  *obj);


extern boolean
    obj_is_external_data_augment (obj_template_t  *obj);


extern boolean
    obj_is_cli_equals_ok (const obj_template_t *obj);


extern boolean
    obj_is_cli_text_block (const obj_template_t *obj);


extern boolean
    obj_is_sil_delete_children_first (const obj_template_t *obj);


extern boolean
    obj_is_no_sil_delete_children_first (const obj_template_t *obj);


extern void
    obj_add_child (obj_template_t *child, obj_template_t *parent);


extern boolean
    obj_is_block_user_create (const obj_template_t *obj);


extern boolean
    obj_is_block_user_update (const obj_template_t *obj);


extern boolean
    obj_is_block_user_delete (const obj_template_t *obj);


extern obj_iffeature_ptr_t *
    obj_new_iffeature_ptr (ncx_iffeature_t *iff);


extern void obj_free_iffeature_ptr (obj_iffeature_ptr_t *iffptr);


extern obj_iffeature_ptr_t *
    obj_first_iffeature_ptr (obj_template_t *obj);


extern obj_iffeature_ptr_t *
    obj_next_iffeature_ptr (obj_iffeature_ptr_t *iffptr);


extern ncx_backptr_t *
    obj_first_inherit_when_ptr (obj_template_t *obj);


extern ncx_backptr_t *
    obj_next_inherit_when_ptr (ncx_backptr_t *ptr);


extern boolean
    obj_find_xpath_backptr (obj_template_t *obj,
                            struct xpath_pcb_t_ *xpath);


extern struct xpath_pcb_t_ *
    obj_next_xpath_backptr (obj_template_t *obj,
                            struct xpath_pcb_t_ *xpath);


extern struct xpath_pcb_t_ *
    obj_first_xpath_backptr (obj_template_t *obj);



extern status_t
    obj_assign_xpath_backptr (obj_template_t *obj,
                              struct xpath_pcb_t_ *xpath);


extern void
    obj_clear_xpath_backptr (obj_template_t *obj,
                             struct xpath_pcb_t_ *xpath);


extern status_t
    obj_set_xpath_backptrs (obj_template_t *obj);


extern void
    obj_flag_xpath_backptrs_dirty (obj_template_t *obj,
                                   ncx_cfg_t cfg_id,
                                   boolean flag);


extern boolean
    obj_is_target_template (obj_template_t *obj);


extern boolean
    obj_maybe_target_template (obj_template_t *obj);


extern boolean
    obj_is_supported (obj_template_t *obj);


extern void
    obj_delete_mod_children (obj_template_t *obj,
                             ncx_module_t *mod);


extern void
    obj_set_dup_local (obj_template_t *obj);


extern boolean
    obj_is_dup_local (obj_template_t *obj);


extern void
    obj_set_key_leaf (obj_template_t *obj,
                      uint16 keynum);


extern uint16
    obj_get_key_num (obj_template_t *obj);


extern boolean
    obj_is_exclusive_rpc (const obj_template_t *obj);


extern boolean
    obj_is_sil_force_replay (const obj_template_t *obj);


extern boolean
    obj_is_sil_force_replace_replay (const obj_template_t *obj);


extern void
    obj_set_sil_force_replace_replay (obj_template_t *obj);


extern boolean obj_notif_enabled (const obj_template_t *obj);


extern boolean obj_notif_log_drops (const obj_template_t *obj);


extern void obj_set_notif_enabled (obj_template_t *obj,
                                   boolean enabled);


extern void obj_set_notif_log_drops (const obj_template_t *obj,
                                     boolean enabled);


extern boolean
    obj_unload_active (const obj_template_t *obj);


extern boolean
    obj_is_obsolete (const obj_template_t *obj);


extern boolean
    obj_parent_same_module (const obj_template_t *obj);


extern void
    obj_set_sil_priority (obj_template_t *obj,
                          uint8 prio);


extern uint8
    obj_get_sil_priority (obj_template_t *obj);


extern boolean
    obj_in_edit2_mode (obj_template_t *obj);


extern ncx_leafref_class_t
    obj_get_leafref_class (obj_template_t *obj);


extern boolean
    obj_delete_all_supported (obj_template_t *obj);


extern boolean
    obj_is_crypt_hash (const obj_template_t *obj);


extern void
    obj_number_data_object (obj_template_t *obj);


extern obj_defval_tk_t *
    obj_new_defval_tk (void);


extern void
    obj_free_defval_tk (obj_defval_tk_t *def);


extern dlq_hdr_t *
    obj_get_defvalQ (obj_template_t *obj);


extern obj_defval_tk_t *
    obj_first_defval_tk (const obj_refine_t *ref);


extern obj_defval_tk_t *
    obj_next_defval_tk (const obj_defval_tk_t *defval_tk);

#define obj_next_dev_defval_tk(D) obj_next_defval_tk(D)


extern obj_defval_tk_t *
    obj_first_dev_defval_tk (const obj_deviate_t *dev);


extern boolean
    obj_get_leaf_list_defset (const obj_template_t *obj);


extern void
    obj_find_delete_defval (obj_template_t *obj,
                            const xmlChar *defval);


extern boolean
    obj_find_defval (obj_template_t *obj,
                     const xmlChar *find_defval);


extern void
    obj_delete_all_defvals (obj_template_t *obj);


extern void
    obj_enter_xpath_mode (void);


extern void
    obj_exit_xpath_mode (void);


extern obj_key_t *
    obj_get_key_by_name (obj_template_t *obj,
                         const xmlChar *keyname);


extern ncx_yang_version_t
    obj_get_langver (obj_template_t *obj);


extern boolean
    obj_is_abstract_ex (const obj_template_t *obj);


extern void
    obj_set_abstract (obj_template_t *obj);


extern boolean
    obj_is_final (obj_template_t *obj);


extern void
    obj_force_disabled (obj_template_t *obj);



#if defined(WITH_SNMP) && defined(WITH_RESTCONF)

extern const xmlChar *
    obj_get_oid_string (obj_template_t *obj);


extern obj_oid_t *
    obj_get_oid_struct (obj_template_t *obj,
                        boolean *malloced);

#endif // WITH_SNMP and WITH_RESTCONF


extern status_t obj_fill_keystackQ (obj_template_t *obj,
                                    dlq_hdr_t *keystackQ);


extern void obj_dump_keystackQ (dlq_hdr_t *keystackQ);


extern void obj_clr_enable_chk (obj_template_t *obj);


extern status_t
    obj_cache_datarule (obj_template_t *obj,
                        void *rule);


extern void
    obj_clear_datarule (obj_template_t *obj,
                        const void *rule);


extern boolean
    obj_match_datarule (obj_template_t *obj,
                        void *rule);


extern status_t
    obj_add_errmsg (obj_template_t *obj,
                    const xmlChar *basestr,
                    obj_errmsg_t **ret_errmsg);


extern status_t
    obj_add_errmsg_parm (obj_errmsg_t *errmsg,
                         const xmlChar *parmstr);


extern status_t
    obj_add_errmsg_filter (obj_errmsg_t *errmsg,
                           const xmlChar *parmstr,
                           boolean is_errortag);


extern boolean
    obj_has_get2cb (obj_template_t *obj);


extern boolean
    obj_is_singular (const obj_template_t *obj);


extern boolean
    obj_get_top_config_flag (const obj_template_t *obj);


extern boolean
    obj_ok_for_nolock (const obj_template_t *obj);


extern boolean
    obj_use_get_when_check (const obj_template_t *obj);


extern boolean
    obj_has_mandatory_children (obj_template_t *obj);


extern boolean obj_get_xpath_oper_ok (const obj_template_t *obj);


extern void obj_set_xpath_oper_ok (obj_template_t *obj);


extern boolean
    obj_is_in_aio_get2 (obj_template_t *obj);


extern boolean
    obj_is_top_aio_get2 (obj_template_t *obj);


extern obj_template_t *
    obj_get_top_aio_get2 (obj_template_t *child);


extern boolean
    obj_has_aio_list (obj_template_t *obj);


extern ncx_module_t *
    obj_get_real_mod (obj_template_t *obj);


extern obj_template_t *
    obj_get_real_parent_aug (obj_template_t *obj);


extern boolean
    obj_is_ancestor (const obj_template_t *ancestor,
                     const obj_template_t *obj);


extern void
    obj_ban_nolock_get (obj_template_t *obj);


#ifdef __cplusplus
}  /* end extern 'C' */
#endif

#endif      /* _H_obj */