cbor_wr.h

Go to the documentation of this file.

#ifdef WITH_YANG_CBOR
/*
 * 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_cbor_wr
#define _H_cbor_wr
 
/*  FILE: cbor_wr.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
11-dec-21    abb      Begun; copied from cbor_wr.c
 
*/
 
#include <stdio.h>
 
/* used for xmlChar type */
#include <xmlstring.h>
 
 
#ifndef _H_getcb
#include "getcb.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_val_util
#include "val_util.h"
#endif
 
#ifndef _H_xml_msg
#include "xml_msg.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
#define CBOR_WR_TESTFN(T) (T)->testfn
#define CBOR_WR_EXPAND_VAREXPR(T) (T)->expand_varexpr
#define CBOR_WR_PARENT_NSID(T) (T)->parent_nsid
#define CBOR_WR_PARENT_SID(T) (T)->parent_sid
#define CBOR_WR_FORCE_PARENT_SID(T) (T)->force_parent_sid
#define CBOR_WR_IS_EMPTY(T) (T)->is_empty
#define CBOR_WR_CONTENT_ONLY(T) (T)->content_only
#define CBOR_WR_ACM_CHECK(T) (T)->acm_check
#define CBOR_WR_FORCE_NAMES(T) (T)->force_names
 
 
/********************************************************************
*                                                                   *
*                           T Y P E S                               *
*                                                                   *
*********************************************************************/
 
 
typedef struct cbor_wr_parms_t_ {
    val_nodetest_fn_t testfn;
 
    boolean expand_varexpr;
 
    xmlns_id_t parent_nsid;
 
    ncx_sid_t parent_sid;
 
    boolean force_parent_sid;
 
    boolean file_write;
 
    boolean with_origin;
 
    boolean with_owners;
 
    ncx_nmda_origin_t parent_origin;
 
    ncx_nmda_origin_t origin;
 
    boolean maxmode;
 
    boolean content_only;
 
    boolean  is_empty;
 
    boolean  acm_check;
 
    boolean force_names;
 
}  cbor_wr_parms_t;
 
 
 
typedef struct cbor_walker_cookie_t_ {
    ses_cb_t *scb;
 
    xml_msg_hdr_t *msg;
 
    cbor_wr_parms_t *parms;
 
}  cbor_walker_cookie_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern void
    cbor_wr_begin_elem (ses_cb_t *scb,
                        xml_msg_hdr_t *msg,
                        obj_template_t *obj,
                        cbor_wr_parms_t *parms);
 
 
 
 
extern void
    cbor_wr_begin_list (ses_cb_t *scb,
                        xml_msg_hdr_t *msg);
 
 
 
#define cbor_wr_end_list cbor_wr_end_elem
 
 
extern void
    cbor_wr_end_elem (ses_cb_t *scb,
                      xml_msg_hdr_t *msg,
                      obj_template_t *obj);
 
 
 
extern void
    cbor_wr_string_elem (ses_cb_t *scb,
                         xml_msg_hdr_t *msg,
                         const xmlChar *strval,
                         obj_template_t *obj,
                         cbor_wr_parms_t *parms);
 
 
extern void
    cbor_wr_uint_elem (ses_cb_t *scb,
                       xml_msg_hdr_t *msg,
                       uint64 val,
                       obj_template_t *obj,
                       cbor_wr_parms_t *parms);
 
 
 
extern void
    cbor_wr_val (ses_cb_t *scb,
                 xml_msg_hdr_t *msg,
                 val_value_t *val,
                 cbor_wr_parms_t *parms);
 
 
extern void
    cbor_wr_child_obj (ses_cb_t *scb,
                       xml_msg_hdr_t *msg,
                       getcb_get2_t *parent_get2cb,
                       obj_template_t *objnode,
                       cbor_wr_parms_t *parms);
 
 
 
extern void
    cbor_wr_start_msg (ses_cb_t *scb);
 
 
 
extern status_t
    cbor_wr_file (const xmlChar *filespec,
                  xml_msg_hdr_t *hdr,
                  val_value_t *val,
                  cbor_wr_parms_t *parms);
 
 
extern status_t
    cbor_wr_open_file (FILE *fp,
                       xml_msg_hdr_t *hdr,
                       val_value_t *val,
                       cbor_wr_parms_t *parms);
 
 
/*
* @brief Initialize a cbor_wr_parms_t struct
*
* @param parms parameter block to initialize
*/
extern void
    cbor_wr_init_parms (cbor_wr_parms_t *parms);
 
/*
* @brief Clean a cbor_wr_parms_t struct
*
* The parms will be left in initialized state so no
* need to call cbor_wr_init_parms after this function
*
* @param parms parameter block to clean
*/
extern void
    cbor_wr_clean_parms (cbor_wr_parms_t *parms);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_cbor_wr */
#endif  // WITH_YANG_CBOR