extensions.h

Go to the documentation of this file.

#ifndef LY_EXTENSIONS_H_
#define LY_EXTENSIONS_H_

#include "libyang.h"

#ifdef __cplusplus
extern "C" {
#endif

#define LYEXT_API_VERSION 1

#ifdef STATIC
#define LYEXT_VERSION_CHECK
#else
#define LYEXT_VERSION_CHECK int lyext_api_version = LYEXT_API_VERSION;
#endif

typedef enum {
    LYEXT_PAR_MODULE,              
    LYEXT_PAR_NODE,                
    LYEXT_PAR_TPDF,                
    LYEXT_PAR_TYPE,                
    LYEXT_PAR_TYPE_BIT,            
    LYEXT_PAR_TYPE_ENUM,           
    LYEXT_PAR_FEATURE,             
    LYEXT_PAR_RESTR,               
    LYEXT_PAR_WHEN,                
    LYEXT_PAR_IDENT,               
    LYEXT_PAR_EXT,                 
    LYEXT_PAR_EXTINST,             
    LYEXT_PAR_REFINE,              
    LYEXT_PAR_DEVIATION,           
    LYEXT_PAR_DEVIATE,             
    LYEXT_PAR_IMPORT,              
    LYEXT_PAR_INCLUDE,             
    LYEXT_PAR_REVISION,            
    LYEXT_PAR_IFFEATURE            
} LYEXT_PAR;

typedef enum {
    LYEXT_SUBSTMT_ALL = -1,      
    LYEXT_SUBSTMT_SELF = 0,      
    LYEXT_SUBSTMT_ARGUMENT,      
    LYEXT_SUBSTMT_BASE,          
    LYEXT_SUBSTMT_BELONGSTO,     
    LYEXT_SUBSTMT_CONTACT,       
    LYEXT_SUBSTMT_DEFAULT,       
    LYEXT_SUBSTMT_DESCRIPTION,   
    LYEXT_SUBSTMT_ERRTAG,        
    LYEXT_SUBSTMT_ERRMSG,        
    LYEXT_SUBSTMT_KEY,           
    LYEXT_SUBSTMT_NAMESPACE,     
    LYEXT_SUBSTMT_ORGANIZATION,  
    LYEXT_SUBSTMT_PATH,          
    LYEXT_SUBSTMT_PREFIX,        
    LYEXT_SUBSTMT_PRESENCE,      
    LYEXT_SUBSTMT_REFERENCE,     
    LYEXT_SUBSTMT_REVISIONDATE,  
    LYEXT_SUBSTMT_UNITS,         
    LYEXT_SUBSTMT_VALUE,         
    LYEXT_SUBSTMT_VERSION,       
    LYEXT_SUBSTMT_MODIFIER,      
    LYEXT_SUBSTMT_REQINSTANCE,   
    LYEXT_SUBSTMT_YINELEM,       
    LYEXT_SUBSTMT_CONFIG,        
    LYEXT_SUBSTMT_MANDATORY,     
    LYEXT_SUBSTMT_ORDEREDBY,     
    LYEXT_SUBSTMT_STATUS,        
    LYEXT_SUBSTMT_DIGITS,        
    LYEXT_SUBSTMT_MAX,           
    LYEXT_SUBSTMT_MIN,           
    LYEXT_SUBSTMT_POSITION,      
    LYEXT_SUBSTMT_UNIQUE,        
} LYEXT_SUBSTMT;

typedef int (*lyext_check_position_clb)(const void *parent, LYEXT_PAR parent_type, LYEXT_SUBSTMT substmt_type);

typedef int (*lyext_check_result_clb)(struct lys_ext_instance *ext);

typedef int (*lyext_check_inherit_clb)(struct lys_ext_instance *ext, struct lys_node *node);

typedef int (*lyext_valid_data_clb)(struct lys_ext_instance *ext, struct lyd_node *node);

struct lyext_plugin {
    LYEXT_TYPE type;                          
    uint16_t flags;                           
    lyext_check_position_clb check_position;  
    lyext_check_result_clb check_result;      
    lyext_check_inherit_clb check_inherit;    
    lyext_valid_data_clb valid_data;          
};

struct lyext_plugin_complex {
    LYEXT_TYPE type;                          
    uint16_t flags;                           
    lyext_check_position_clb check_position;  
    lyext_check_result_clb check_result;      
    lyext_check_inherit_clb check_inherit;    
    lyext_valid_data_clb valid_data;          
    struct lyext_substmt *substmt;            
    size_t instance_size;                     
};

struct lyext_plugin_list {
    const char *module;          
    const char *revision;        
    const char *name;            
    struct lyext_plugin *plugin; 
};

void lyext_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, const char *plugin, const char *function, const char *format, ...);

#define LYEXT_LOG(ctx, level, plugin, str, args...)       \
    lyext_log(ctx, level, plugin, __func__, str, ##args); \


typedef enum {
    LYEXT_VLOG_NONE = 0,
    LYEXT_VLOG_XML, 
    LYEXT_VLOG_LYS, 
    LYEXT_VLOG_LYD, 
    LYEXT_VLOG_STR, 
    LYEXT_VLOG_PREV, 
} LYEXT_VLOG_ELEM;

void lyext_vlog(const struct ly_ctx *ctx, LY_VECODE vecode, const char *plugin, const char *function,
                LYEXT_VLOG_ELEM elem_type, const void *elem, const char *format, ...);

#define LYEXT_VLOG(ctx, vecode, plugin, elem_type, elem, str, args...)    \
    lyext_vlog(ctx, vecode, plugin, __func__, elem_type, elem, str, ##args)

void lys_iffeature_free(struct ly_ctx *ctx, struct lys_iffeature *iffeature, uint8_t iffeature_size, int shallow,
                        void (*private_destructor)(const struct lys_node *node, void *priv));

#ifdef __cplusplus
}
#endif

#endif /* LY_EXTENSIONS_H_ */