xpath.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_xpath
#define _H_xpath
 
/*  FILE: xpath.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
30-dec-07    abb      Begun
06-jul-11    abb      add wildcard match support
11-dec-16    abb      add GET2 retrieval support
*/
 
#include <xmlstring.h>
#include <xmlreader.h>
#include <xmlregexp.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_tk
#include "tk.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_var
#include "var.h"
#endif
 
#ifndef _H_yang
#include "yang.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
/* max size of the pcb->result_cacheQ */
#define XPATH_RESULT_CACHE_MAX     16
 
/* max size of the pcb->resnode_cacheQ */
#define XPATH_RESNODE_CACHE_MAX     64
 
 
/* XPath 1.0 sec 2.2 AxisName */
#define XP_AXIS_ANCESTOR           (const xmlChar *)"ancestor"
#define XP_AXIS_ANCESTOR_OR_SELF   (const xmlChar *)"ancestor-or-self"
#define XP_AXIS_ATTRIBUTE          (const xmlChar *)"attribute"
#define XP_AXIS_CHILD              (const xmlChar *)"child"
#define XP_AXIS_DESCENDANT         (const xmlChar *)"descendant"
#define XP_AXIS_DESCENDANT_OR_SELF (const xmlChar *)"descendant-or-self"
#define XP_AXIS_FOLLOWING          (const xmlChar *)"following"
#define XP_AXIS_FOLLOWING_SIBLING  (const xmlChar *)"following-sibling"
#define XP_AXIS_NAMESPACE          (const xmlChar *)"namespace"
#define XP_AXIS_PARENT             (const xmlChar *)"parent"
#define XP_AXIS_PRECEDING          (const xmlChar *)"preceding"
#define XP_AXIS_PRECEDING_SIBLING  (const xmlChar *)"preceding-sibling"
#define XP_AXIS_SELF               (const xmlChar *)"self"
 
/* Xpath 1.0 Function library + current() from XPath 2.0 */
#define XP_FN_BOOLEAN              (const xmlChar *)"boolean"
#define XP_FN_CEILING              (const xmlChar *)"ceiling"
#define XP_FN_CONCAT               (const xmlChar *)"concat"
#define XP_FN_CONTAINS             (const xmlChar *)"contains"
#define XP_FN_COUNT                (const xmlChar *)"count"
#define XP_FN_CURRENT              (const xmlChar *)"current"
#define XP_FN_FALSE                (const xmlChar *)"false"
#define XP_FN_FLOOR                (const xmlChar *)"floor"
#define XP_FN_ID                   (const xmlChar *)"id"
#define XP_FN_LANG                 (const xmlChar *)"lang"
#define XP_FN_LAST                 (const xmlChar *)"last"
#define XP_FN_LOCAL_NAME           (const xmlChar *)"local-name"
#define XP_FN_NAME                 (const xmlChar *)"name"
#define XP_FN_NAMESPACE_URI        (const xmlChar *)"namespace-uri"
#define XP_FN_NORMALIZE_SPACE      (const xmlChar *)"normalize-space"
#define XP_FN_NOT                  (const xmlChar *)"not"
#define XP_FN_NUMBER               (const xmlChar *)"number"
#define XP_FN_POSITION             (const xmlChar *)"position"
#define XP_FN_ROUND                (const xmlChar *)"round"
#define XP_FN_STARTS_WITH          (const xmlChar *)"starts-with"
#define XP_FN_STRING               (const xmlChar *)"string"
#define XP_FN_STRING_LENGTH        (const xmlChar *)"string-length"
#define XP_FN_SUBSTRING            (const xmlChar *)"substring"
#define XP_FN_SUBSTRING_AFTER      (const xmlChar *)"substring-after"
#define XP_FN_SUBSTRING_BEFORE     (const xmlChar *)"substring-before"
#define XP_FN_SUM                  (const xmlChar *)"sum"
#define XP_FN_TRANSLATE            (const xmlChar *)"translate"
#define XP_FN_TRUE                 (const xmlChar *)"true"
 
 
/* yuma function extensions */
#define XP_FN_MODULE_LOADED        (const xmlChar *)"module-loaded"
#define XP_FN_FEATURE_ENABLED      (const xmlChar *)"feature-enabled"
 
/* XPath functions added to YANG 1.1 */
#define XP_FN_REMATCH              (const xmlChar *)"re-match"
#define XP_FN_DEREF                (const xmlChar *)"deref"
#define XP_FN_DERIVED_FROM         (const xmlChar *)"derived-from"
#define XP_FN_DERIVED_FROM_OR_SELF (const xmlChar *)"derived-from-or-self"
#define XP_FN_ENUM_VALUE           (const xmlChar *)"enum-value"
#define XP_FN_BIT_IS_SET           (const xmlChar *)"bit-is-set"
 
/* XPath NodeType values */
#define XP_NT_COMMENT              (const xmlChar *)"comment"
#define XP_NT_TEXT                 (const xmlChar *)"text"
#define XP_NT_PROCESSING_INSTRUCTION \
    (const xmlChar *)"processing-instruction"
#define XP_NT_NODE                 (const xmlChar *)"node"
 
/* XPath 1.0 operator names */
#define XP_OP_AND                  (const xmlChar *)"and"
#define XP_OP_OR                   (const xmlChar *)"or"
#define XP_OP_DIV                  (const xmlChar *)"div"
#define XP_OP_MOD                  (const xmlChar *)"mod"
 
 
/* Header only */
 
#define XP_URL_ESC_WILDCARD     '-'
 
#define XP_FL_DYNNODE            bit0
 
 
#define XP_FL_SKIP_MODE          bit1
 
 
#define XP_FL_LOAD_IMPORT       bit2
 
 
#define XP_FL_ABSPATH            bit3
 
 
#define XP_FL_CONFIGONLY         bit4
 
#define XP_FL_USEROOT             bit5
 
#define XP_FL_INSTANCEID          bit6
 
 
#define XP_FL_SCHEMA_INSTANCEID          bit7
 
#define XP_FL_TOP_RPC_INPUT              bit8
 
#define XP_FL_ACTION_INPUT              bit9
 
#define XP_FL_NACM_GET2                bit10
 
#define XP_FL_KEEP_RESULT              bit11
 
 
#define XP_FL_FOUND_PRED               bit12
 
#define XP_FL_GET_WHEN                 bit13
 
/***** backptr_flags definitions *****/
 
#define XP_FL_BACKPTR_CDIRTY          bit0
 
#define XP_FL_BACKPTR_RDIRTY          bit1
 
#define XP_FL_BACKPTR_SDIRTY          bit2
 
 
/********************************************************************
*                                                                   *
*                           M A C R O S                             *
*                                                                   *
*********************************************************************/
 
#define XPATH_GET_TYPE(P)       (P)->xpath_type
 
#define XPATH_GET_RESTYPE(R)    (R)->restype
 
#define XPATH_NACM_GET2(P)      ((P)->flags & XP_FL_NACM_GET2)
 
#define XPATH_NONCONFIG_WARN(P) (P)->nonconfig_warn_obj
 
#define XPATH_VAL_CXT(P) ((P)->val || (P)->val_get2)
 
#define XPATH_ANY_CXT(P) ((P)->val || (P)->val_get2 || (P)->obj)
 
#define XPATH_SCB(P)       (P)->scb
 
#define XPATH_GET2CB_OBJ(N) (N)->cb->obj
 
#define XPATH_MHDR(P) (P)->mhdr
 
#define XPATH_EXPRSTR(P) (P)->exprstr
 
#define XPATH_SET_DISABLED_OBJ_OK(P)  (P)->disabled_obj_ok = TRUE
 
#define XPATH_DISABLED_OBJ_OK(P)  (P)->disabled_obj_ok
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef enum xpath_restype_t_ {
    XP_RT_NONE,         
    XP_RT_NODESET,      
    XP_RT_NUMBER,       
    XP_RT_STRING,       
    XP_RT_BOOLEAN       
} xpath_restype_t;
 
typedef enum xpath_curmode_t_ {
    XP_CM_NONE,        
    XP_CM_TARGET,      
    XP_CM_ALT,         
    XP_CM_KEYVAR       
} xpath_curmode_t;
 
 
typedef enum xpath_document_t_ {
    XP_DOC_NONE,             
    XP_DOC_DATABASE,         
    XP_DOC_RPC,              
    XP_DOC_RPC_REPLY,        
    XP_DOC_NOTIFICATION      
} xpath_document_t;
 
 
typedef enum xpath_source_t_ {
    XP_SRC_NONE,            
    XP_SRC_LEAFREF,         
    XP_SRC_YANG,            
    XP_SRC_INSTANCEID,      
    XP_SRC_SCHEMA_INSTANCEID,  
    XP_SRC_XML             
} xpath_source_t;
 
 
typedef enum xpath_exop_t_ {
    XP_EXOP_NONE,        
    XP_EXOP_AND,         
    XP_EXOP_OR,          
    XP_EXOP_EQUAL,       
    XP_EXOP_NOTEQUAL,    
    XP_EXOP_LT,          
    XP_EXOP_GT,          
    XP_EXOP_LEQUAL,      
    XP_EXOP_GEQUAL,      
    XP_EXOP_ADD,         
    XP_EXOP_SUBTRACT,    
    XP_EXOP_MULTIPLY,    
    XP_EXOP_DIV,         
    XP_EXOP_MOD,         
    XP_EXOP_NEGATE,      
    XP_EXOP_UNION,       
    XP_EXOP_FILTER1,     
    XP_EXOP_FILTER2      
} xpath_exop_t;
 
 
typedef enum xpath_nodetype_t_ {
    XP_EXNT_NONE,        
    XP_EXNT_COMMENT,     
    XP_EXNT_TEXT,        
    XP_EXNT_PROC_INST,   
    XP_EXNT_NODE         
} xpath_nodetype_t;
 
 
typedef enum xpath_rntype_t_ {
    XP_RNT_NONE,      
    XP_RNT_OBJ,       
    XP_RNT_VAL,       
    XP_RNT_VALHDR,    
    XP_RNT_GET2       
} xpath_rntype_t;
 
 
typedef enum xpath_get2_state_t_ {
    XP_RST_NONE,          
    XP_RST_GET2_PENDING,  
    XP_RST_GET2_SKIPPED,  
    XP_RST_GET2_START,    
    XP_RST_GET2_DONE,     
    XP_RST_GET2_ERROR     
} xpath_get2_state_t;
 
 
typedef enum xpath_get2_form_t_ {
    XP_FORM_NONE,           
    XP_FORM_GETCB,          
    XP_FORM_GETCB_TERM,     
    XP_FORM_GETCB_CHILD     
} xpath_get2_form_t;
 
 
typedef ncx_var_t *
    (*xpath_getvar_fn_t) (struct xpath_pcb_t_ *pcb,
                          const xmlChar *varname,
                          status_t *res);
 
 
typedef struct xpath_get2_cb_t_ {
    dlq_hdr_t             qhdr;   
    xpath_get2_state_t    get2_state;
 
    obj_template_t       *obj;
 
    val_value_t         *val;
 
    val_value_t          *parent_val;
 
    struct xpath_get2_cb_t_ *parent_cb;
 
    struct getcb_get2_t_ *get2cb;
 
    dlq_hdr_t            return_keyQ;  
    dlq_hdr_t            return_termQ; 
    dlq_hdr_t            lookupQ;      
} xpath_get2_cb_t;
 
 
typedef struct xpath_get2_node_t_ {
    xpath_get2_cb_t      *cb;
 
    val_value_t          *val;
 
    xpath_get2_form_t    form;
 
} xpath_get2_node_t;
 
 
typedef struct xpath_resnode_t_ {
    dlq_hdr_t             qhdr;
 
    boolean               dblslash;
 
    xpath_rntype_t        rntype;
 
    union node_ {
        obj_template_t *objptr;    
        val_value_t    *valptr;    
        val_child_hdr_t *valhdr;   
        xpath_get2_node_t get2node;  
    } node;
} xpath_resnode_t;
 
 
typedef struct xpath_result_t_ {
    dlq_hdr_t            qhdr;
 
    xpath_restype_t      restype;
 
    /* flag to identify node types in the nodeQ if XP_RT_NODESET */
    boolean              isval;
 
    union r_ {
        /* result node Q of xpath_resnode_t */
        dlq_hdr_t         nodeQ;
 
        boolean           boo;
 
        ncx_num_t         num;
 
        xmlChar          *str;
    } r;
 
} xpath_result_t;
 
 
typedef struct xpath_pred_ent_t_ {
    dlq_hdr_t           qhdr;    
    obj_template_t     *keyobj;  
    const xmlChar      *keyval;  
} xpath_pred_ent_t;
 
 
typedef struct xpath_pcb_t_ {
    dlq_hdr_t            qhdr;
 
    tk_chain_t          *tkc;
 
    /* XPath expression to evaluate provided by the caller.
     * This is a mandatory parameter.
     */
    xmlChar             *exprstr;
 
    /* XmlTextReader is needed when the evaluation is inside
     * an XML instance document (rpc request)
     */
    xmlTextReaderPtr     reader;
 
    xpath_source_t       source;
 
    ncx_errinfo_t        errinfo;
 
    boolean              logerrors;
 
    boolean              missing_errors;
 
    obj_template_t  *targobj;
 
    obj_template_t  *altobj;
 
    obj_template_t  *varobj;
 
    xpath_curmode_t  curmode;
 
    obj_template_t    *obj;
 
    ncx_module_t      *objmod;
 
    ncx_module_t      *impmod;
 
    ncx_module_t      *rootmod;   
    obj_template_t    *docroot;
 
    obj_template_t    *startobj;
 
    val_value_t       *val;
 
    val_value_t       *val_docroot;
 
    xpath_document_t   doctype;
 
    struct xpath_get2_node_t_ *val_get2;
 
    uint32              flags;
 
    xpath_result_t     *result;
 
    xpath_resnode_t      context;      
    /* Need to save original context for current() fn */
    xpath_resnode_t      orig_context;
 
    xpath_result_t      *context_result;
 
    xpath_getvar_fn_t    getvar_fn;
 
    void                *cookie;
 
    dlq_hdr_t            varbindQ;
 
    const struct xpath_fncb_t_ *functions;
 
    dlq_hdr_t           result_cacheQ;
 
    dlq_hdr_t           resnode_cacheQ;
 
    uint32              result_count;
 
    uint32              resnode_count;
 
    boolean             backptrs_mode;
 
    boolean             backptrs_manual_clear;
 
    uint8               backptrs_flags;
 
    ncx_xpath_type_t    xpath_type;
 
    boolean             xpath_predicate;
 
    status_t             parseres;
 
    status_t             validateres;
 
    status_t             valueres;
 
    ncx_error_t          tkerr;
 
    boolean              seen;
 
    void                *yang_pcb;
 
    dlq_hdr_t           get2_cbQ;  /* Q of xpath_get2_cb_t */
 
    ses_cb_t            *scb;
 
    xml_msg_hdr_t       *mhdr;
 
    struct getcb_get2_t_ *get2cb;
 
    dlq_hdr_t             pred_entQ;
 
    obj_template_t       *nonconfig_warn_obj;
 
    dlq_hdr_t           get2_aio_cbQ;  
    boolean       disabled_obj_ok;
 
} xpath_pcb_t;
 
 
typedef xpath_result_t *
    (*xpath_fn_t) (xpath_pcb_t *pcb,
                   dlq_hdr_t *parmQ,
                   status_t *res);
 
 
typedef struct xpath_fncb_t_ {
    const xmlChar     *name;
 
    xpath_restype_t    restype;
 
    int32              parmcnt;
 
    xpath_fn_t         fn;
} xpath_fncb_t;
 
 
typedef struct xpath_walkerparms_t_ {
    dlq_hdr_t         *resnodeQ;
 
    status_t           res;
} xpath_walkerparms_t;
 
 
typedef struct xpath_compwalkerparms_t_ {
    xpath_result_t    *result2;
 
    xmlChar           *cmpstring;
 
    ncx_num_t         *cmpnum;
 
    xmlChar           *buffer;
 
    uint32             buffsize;
 
    xpath_exop_t       exop;
 
    boolean            cmpresult;
 
    status_t           res;
} xpath_compwalkerparms_t;
 
 
typedef struct xpath_stringwalkerparms_t_ {
    xmlChar           *buffer;
 
    uint32             buffsize;
 
    uint32             buffpos;
 
    status_t           res;
} xpath_stringwalkerparms_t;
 
 
typedef struct xpath_aio_cb_t_ {
    dlq_hdr_t                  qhdr;
 
    struct xpath_aio_cb_t_    *parent_cb;
 
    obj_template_t            *obj;
 
    dlq_hdr_t                  valQ;
 
} xpath_aio_cb_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
extern status_t
    xpath_find_schema_target (yang_pcb_t *pcb,
                              tk_chain_t *tkc,
                              ncx_module_t *mod,
                              obj_template_t *obj,
                              dlq_hdr_t  *datadefQ,
                              const xmlChar *target,
                              obj_template_t **targobj,
                              dlq_hdr_t **targQ);
 
 
extern status_t
    xpath_find_schema_target_force_mod (yang_pcb_t *pcb,
                                        tk_chain_t *tkc,
                                        ncx_module_t *mod,
                                        ncx_module_t *force_mod,
                                        obj_template_t *obj,
                                        dlq_hdr_t  *datadefQ,
                                        const xmlChar *target,
                                        obj_template_t **targobj,
                                        dlq_hdr_t **targQ);
 
 
extern status_t
    xpath_find_schema_target_err (yang_pcb_t *pcb,
                                  tk_chain_t *tkc,
                                  ncx_module_t *mod,
                                  obj_template_t *obj,
                                  dlq_hdr_t  *datadefQ,
                                  const xmlChar *target,
                                  obj_template_t **targobj,
                                  dlq_hdr_t **targQ,
                                  ncx_error_t *tkerr);
 
 
extern status_t
    xpath_find_schema_target_int (const xmlChar *target,
                                  obj_template_t **targobj);
 
 
extern status_t
    xpath_find_val_target (val_value_t *startval,
                           ncx_module_t *mod,
                           const xmlChar *target,
                           val_value_t **targval);
 
 
extern status_t
    xpath_find_schema_target_restconf (const xmlChar *target,
                                       obj_template_t **targobj);
 
 
 
extern status_t
    xpath_find_data_target_pcb (xpath_pcb_t *pcb,
                                obj_template_t **targobj);
 
 
extern status_t
    xpath_find_val_unique (val_value_t *startval,
                           ncx_module_t *mod,
                           const xmlChar *target,
                           val_value_t *root,
                           boolean logerrors,
                           boolean configonly,
                           xpath_pcb_t **retpcb);
 
 
extern xpath_pcb_t *
    xpath_new_pcb (const xmlChar *xpathstr,
                   xpath_getvar_fn_t  getvar_fn);
 
 
extern xpath_pcb_t *
    xpath_new_pcb_ex (const xmlChar *xpathstr,
                      xpath_getvar_fn_t  getvar_fn,
                      void *cookie);
 
 
extern xpath_pcb_t *
    xpath_clone_pcb (const xpath_pcb_t *srcpcb);
 
 
extern xpath_pcb_t *
    xpath_find_pcb (dlq_hdr_t *pcbQ,
                    const xmlChar *exprstr);
 
 
extern void
    xpath_free_pcb (xpath_pcb_t *pcb);
 
 
extern xpath_result_t *
    xpath_new_result (xpath_restype_t restype);
 
 
extern void
    xpath_init_result (xpath_result_t *result,
                       xpath_restype_t restype);
 
 
extern void
    xpath_free_result (xpath_result_t *result);
 
 
extern void
    xpath_clean_result (xpath_result_t *result);
 
 
extern xpath_resnode_t *
    xpath_new_resnode (void);
 
 
extern void
    xpath_init_resnode (xpath_resnode_t *resnode);
 
 
extern void
    xpath_free_resnode (xpath_resnode_t *resnode);
 
 
extern void
    xpath_delete_resnode (xpath_resnode_t *resnode);
 
 
extern void
    xpath_clean_resnode (xpath_resnode_t *resnode);
 
 
extern status_t
    xpath_get_curmod_from_prefix (const xmlChar *prefix,
                                  ncx_module_t *mod,
                                  ncx_module_t **targmod);
 
 
extern status_t
    xpath_get_curmod_from_prefix2 (const xmlChar *prefix,
                                   ncx_module_t *mod,
                                   ncx_module_t **targmod,
                                   const xmlChar **modname);
 
 
extern status_t
    xpath_get_modinfo_from_prefix (const xmlChar *prefix,
                                   ncx_module_t *mod,
                                   const xmlChar **modname,
                                   const xmlChar **modrev);
 
 
extern status_t
    xpath_get_curmod_from_prefix_str (const xmlChar *prefix,
                                      uint32 prefixlen,
                                      ncx_module_t *mod,
                                      ncx_module_t **targmod);
 
 
extern status_t
    xpath_parse_token (xpath_pcb_t *pcb,
                       tk_type_t  tktype);
 
 
extern boolean
    xpath_cvt_boolean (const xpath_result_t *result);
 
 
extern void
    xpath_cvt_number (const xpath_result_t *result,
                      ncx_num_t *num);
 
 
extern status_t
    xpath_cvt_string (xpath_pcb_t *pcb,
                      const xpath_result_t *result,
                      xmlChar **str);
 
 
extern dlq_hdr_t *
    xpath_get_resnodeQ (xpath_result_t *result);
 
 
extern xpath_resnode_t *
    xpath_get_first_resnode (xpath_result_t *result);
 
 
extern xpath_resnode_t *
    xpath_get_next_resnode (xpath_resnode_t *resnode);
 
 
extern val_value_t *
    xpath_first_resnode_valptr (xpath_resnode_t *resnode);
 
 
extern val_value_t *
    xpath_next_resnode_valptr (xpath_resnode_t *resnode,
                               val_value_t *valptr);
 
 
extern obj_template_t *
    xpath_get_resnode_obj (xpath_resnode_t *resnode);
 
 
extern obj_template_t *
    xpath_get_cxt_obj (xpath_pcb_t *pcb);
 
 
extern val_value_t *
    xpath_get_resnode_val (xpath_resnode_t *resnode);
 
 
extern obj_template_t *
    xpath_get_resnode_objptr (xpath_resnode_t *resnode);
 
 
extern dlq_hdr_t *
    xpath_get_varbindQ (xpath_pcb_t *pcb);
 
 
extern void
    xpath_move_nodeset (xpath_result_t *srcresult,
                        xpath_result_t *destresult);
 
 
 
extern boolean
    xpath_nodeset_empty (const xpath_result_t *result);
 
 
extern void
    xpath_nodeset_swap_valptr (xpath_result_t *result,
                               val_value_t *oldval,
                               val_value_t *newval);
 
 
extern void
    xpath_nodeset_delete_valptr (xpath_result_t *result,
                                 val_value_t *oldval);
 
 
extern xmlChar *
    xpath_convert_url_to_path (const xmlChar *urlpath,
                               ncx_name_match_t match_names,
                               boolean alt_naming,
                               boolean wildcards,
                               boolean withkeys,
                               boolean fullkeys,
                               boolean withmod,
                               ncx_protocol_t proto,
                               status_t *res);
 
 
extern void
    xpath_set_backptrs_dirty (xpath_pcb_t *pcb,
                              ncx_cfg_t cfg_id,
                              boolean dirty);
 
 
extern boolean
    xpath_check_backptrs_dirty (xpath_pcb_t *pcb,
                                ncx_cfg_t cfg_id);
 
 
extern boolean
    xpath_check_manual_clear (xpath_pcb_t *pcb);
 
 
extern void
    xpath_set_manual_clear (xpath_pcb_t *pcb);
 
 
extern status_t
    xpath_add_to_result (xpath_result_t *source,
                         xpath_result_t *target);
 
 
extern uint32
    xpath_resnode_count (xpath_result_t *result);
 
 
extern void
    xpath_discard_resnode (xpath_resnode_t *resnode);
 
 
extern void
    xpath_clear_nodeset_result (xpath_result_t *result);
 
 
extern xpath_pcb_t *
    xpath_new_session_pcb (ses_cb_t *scb,
                           const xmlChar *expr,
                           status_t *res);
 
 
extern void
    xpath_set_load_import (xpath_pcb_t *pcb,
                           void *yang_pcb);
 
 
extern void
    xpath_clear_load_import (xpath_pcb_t *pcb);
 
 
extern void *
    xpath_get_load_import (xpath_pcb_t *pcb);
 
 
extern boolean
    xpath_need_get2_processing (xpath_result_t *result);
 
 
extern const xmlChar *
    xpath_get_restype_str (xpath_restype_t restype);
 
 
extern void
    xpath_set_keep_result (xpath_pcb_t *pcb);
 
 
extern boolean
    xpath_find_obj_in_result (xpath_result_t *result,
                              obj_template_t *obj);
 
 
extern boolean
    xpath_expr_has_predicates (xpath_pcb_t *pcb);
 
 
extern boolean
    xpath_expr_scan_predicates (xpath_pcb_t *pcb);
 
 
extern xpath_pred_ent_t *
    xpath_new_pred_ent (obj_template_t *keyobj,
                        const xmlChar *keyval);
 
 
extern void xpath_free_pred_ent (xpath_pred_ent_t *ent);
 
 
extern boolean xpath_expr_ok_for_nolock_get (xpath_pcb_t *pcb);
 
 
extern xpath_resnode_t *
    xpath_get_first_real_resnode (xpath_result_t *result);
 
 
extern boolean
    xpath_result_is_get2 (xpath_result_t *result);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_xpath */