agt_tree.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_agt_tree
#define _H_agt_tree
 
/*  FILE: agt_tree.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
16-jun-06    abb      Begun
 
*/
 
#ifdef WITH_YANG_CBOR
#ifndef _H_cbor_wr
#include "cbor_wr.h"
#endif
#endif
 
#ifndef _H_cfg
#include "cfg.h"
#endif
 
#ifndef _H_rpc
#include "rpc.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern ncx_filptr_t *
    agt_tree_prune_filter (ses_cb_t *scb,
                           rpc_msg_t *msg,
                           const cfg_template_t *cfg,
                           boolean getop,
                           boolean *do_all);
 
 
extern ncx_filptr_t *
    agt_tree_prune_filter2 (ses_cb_t *scb,
                            rpc_msg_t *msg,
                            val_value_t *root,
                            obj_template_t *root_obj,
                            val_value_t *filter,
                            boolean getop,
                            boolean *do_all);
 
 
extern void
    agt_tree_output_filter (ses_cb_t *scb,
                            rpc_msg_t *msg,
                            ncx_filptr_t *top,
                            int32 indent,
                            boolean getop);
 
 
extern boolean
    agt_tree_test_filter (xml_msg_hdr_t *msghdr,
                          ses_cb_t *scb,
                          val_value_t *filter,
                          val_value_t *topval);
 
 
extern void
    agt_tree_output_node_from_obj_xml (ses_cb_t *scb,
                                       xml_msg_hdr_t *msg,
                                       ncx_filptr_t *filptr,
                                       obj_template_t *obj,
                                       int32 indent,
                                       boolean getop);
 
 
extern void
    agt_tree_output_node_from_obj_json (ses_cb_t *scb,
                                        xml_msg_hdr_t *msg,
                                        ncx_filptr_t *filptr,
                                        obj_template_t *obj,
                                        int32 indent,
                                        boolean getop,
                                        boolean isfirst,
                                        boolean islast,
                                        boolean isfirstchild,
                                        boolean isfirstsibling,
                                        boolean force_lastsibling,
                                        boolean force_lastsib_value,
                                        boolean force_array_obj);
 
 
 
#ifdef WITH_YANG_CBOR
extern void
    agt_tree_output_node_from_obj_cbor (ses_cb_t *scb,
                                        xml_msg_hdr_t *msg,
                                        ncx_filptr_t *filptr,
                                        obj_template_t *obj,
                                        boolean getop,
                                        cbor_wr_parms_t *parms);
 
#endif  // WITH_YANG_CBOR
 
 
extern boolean
    agt_tree_attr_test (val_value_t *filval,
                        val_value_t  *targval);
 
 
extern boolean
    agt_tree_content_match_test (ses_cb_t *scb,
                                 const xmlChar *testval,
                                 val_value_t *curval);
 
 
extern obj_template_t *
    agt_tree_find_child_object (xmlns_id_t obj_id,
                                const xmlChar *obj_name,
                                obj_template_t *parent_obj,
                                boolean *more_matches);
 
 
#ifdef PTHREADS
extern boolean
    agt_tree_filter_ok_for_nolock (val_value_t *filterval);
#endif  // PTHREADS
 
 
extern status_t
    agt_tree_cvt_subtree_xpath (ses_cb_t *scb,
                                rpc_msg_t *msg,
                                const cfg_template_t *cfg,
                                boolean getop,
                                val_value_t *filter,
                                boolean *skiptop,
                                xmlChar **xpathstr);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_tree */