yang_patch.h

Go to the documentation of this file.

/*
 * 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_yang_patch
#define _H_yang_patch
 
/*  FILE: yang_patch.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-nov-14    abb      Begun
 
*/
 
#include <xmlstring.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_op
#include "op.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define YANG_PATCH_DEF_SKIP_SIL TRUE
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef enum yang_patch_op_t_ {
    YANG_PATCH_OP_NONE,       
    YANG_PATCH_OP_CREATE,     
    YANG_PATCH_OP_DELETE,     
    YANG_PATCH_OP_INSERT,     
    YANG_PATCH_OP_MERGE,      
    YANG_PATCH_OP_MOVE,       
    YANG_PATCH_OP_REPLACE,    
    YANG_PATCH_OP_REMOVE      
} yang_patch_op_t;
 
 
typedef enum yang_patch_edit_type_t_ {
    YANG_PATCH_EDIT_TYPE_NONE,    
    YANG_PATCH_EDIT_TYPE_USER,    
    YANG_PATCH_EDIT_TYPE_SYSTEM   
} yang_patch_edit_type_t;
 
 
typedef enum yang_patch_where_t_ {
    YANG_PATCH_WHERE_NONE,     
    YANG_PATCH_WHERE_BEFORE,   
    YANG_PATCH_WHERE_AFTER,    
    YANG_PATCH_WHERE_FIRST,    
    YANG_PATCH_WHERE_LAST      
} yang_patch_where_t;
 
 
typedef struct yang_patch_edit_t_ {
    dlq_hdr_t qhdr;
 
    xmlChar *edit_id;
 
    yang_patch_op_t operation;
 
    xmlChar *target;
 
    xmlChar *point;
 
    yang_patch_where_t insert_where;
 
    val_value_t *value;
 
    val_value_t *configval;
 
    val_value_t *targval;
 
    boolean lastedit;
 
} yang_patch_edit_t;
 
 
typedef struct yang_patch_cb_t_ {
    dlq_hdr_t qhdr;
 
    xmlChar *patch_id;
 
    yang_patch_edit_type_t edit_type;
 
    boolean skip_sil;
 
    xmlChar *comment;
 
    xmlChar *target;
 
    dlq_hdr_t editQ;
} yang_patch_cb_t;
 
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern status_t
    yang_patch_init (void);
 
 
extern void
    yang_patch_cleanup (void);
 
 
extern yang_patch_cb_t *
    yang_patch_new_cb (const xmlChar *patch_id,
                       const xmlChar *the_comment,
                       const xmlChar *target);
 
 
extern void
    yang_patch_free_cb (yang_patch_cb_t *pcb);
 
 
extern void
    yang_patch_free_edit (yang_patch_edit_t *edit);
 
 
extern yang_patch_edit_t *
    yang_patch_new_edit (const xmlChar *edit_id,
                         yang_patch_op_t operation,
                         const xmlChar *target,
                         const xmlChar *point,
                         yang_patch_where_t insert_where,
                         val_value_t *value);
 
 
extern yang_patch_edit_t *
    yang_patch_new_edit2 (const xmlChar *edit_id,
                          yang_patch_op_t operation,
                          const xmlChar *target,
                          const xmlChar *point,
                          yang_patch_where_t insert_where,
                          val_value_t *value,
                          boolean plain_clone);
 
 
extern void
    yang_patch_add_edit (yang_patch_cb_t *pcb,
                         yang_patch_edit_t *edit);
 
 
extern yang_patch_edit_t *
    yang_patch_find_edit (yang_patch_cb_t *pcb,
                          const xmlChar *edit_id);
 
 
extern uint32
    yang_patch_edit_count (yang_patch_cb_t *pcb);
 
 
extern yang_patch_op_t
    yang_patch_str_to_op (const xmlChar *opstr);
 
 
extern const xmlChar *
    yang_patch_op_to_str (yang_patch_op_t op);
 
 
extern yang_patch_edit_type_t
    yang_patch_str_to_edit_type (const xmlChar *str);
 
 
extern const xmlChar *
    yang_patch_edit_type_to_str (yang_patch_edit_type_t typ);
 
 
extern yang_patch_where_t
    yang_patch_str_to_where (const xmlChar *wherestr);
 
 
extern const xmlChar *
    yang_patch_where_to_str (yang_patch_where_t wh);
 
 
extern val_value_t *
    yang_patch_edit_to_value (obj_template_t *edit_obj,
                              yang_patch_edit_t *edit,
                              status_t *res);
 
 
extern val_value_t *
    yang_patch_to_value (obj_template_t *patch_obj,
                         yang_patch_cb_t *pcb,
                         status_t *res);
 
 
extern yang_patch_edit_t *
    yang_patch_value_to_edit (val_value_t *edit_val,
                              boolean preserve_editval,
                              status_t *res);
 
 
extern yang_patch_cb_t *
    yang_patch_value_to_patch (val_value_t *patch_val,
                               const xmlChar *target,
                               boolean preserve_patchval,
                               status_t *res);
 
 
extern op_editop_t
    yang_patch_op_to_editop (yang_patch_op_t op,
                             boolean *is_insert);
 
 
extern yang_patch_op_t
    yang_patch_editop_to_op (op_editop_t edit_op);
 
 
extern void
    yang_patch_dump_pcb (yang_patch_cb_t *pcb);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_yang_patch */