Blame swig/cpp/src/Libyang.hpp

Packit 8fb591
/**
Packit 8fb591
 * @file Libyang.hpp
Packit 8fb591
 * @author Mislav Novakovic <mislav.novakovic@sartura.hr>
Packit 8fb591
 * @brief Class implementation for libyang C header libyang.h.
Packit 8fb591
 *
Packit 8fb591
 * Copyright (c) 2017 Deutsche Telekom AG.
Packit 8fb591
 *
Packit 8fb591
 * This source code is licensed under BSD 3-Clause License (the "License").
Packit 8fb591
 * You may not use this file except in compliance with the License.
Packit 8fb591
 * You may obtain a copy of the License at
Packit 8fb591
 *
Packit 8fb591
 *     https://opensource.org/licenses/BSD-3-Clause
Packit 8fb591
 */
Packit 8fb591
Packit 8fb591
#ifndef LIBYANG_CPP_H
Packit 8fb591
#define LIBYANG_CPP_H
Packit 8fb591
Packit 8fb591
#include <iostream>
Packit 8fb591
#include <memory>
Packit 8fb591
#include <exception>
Packit 8fb591
#include <functional>
Packit 8fb591
#include <vector>
Packit 8fb591
Packit 8fb591
#include "Internal.hpp"
Packit 8fb591
Packit 8fb591
extern "C" {
Packit 8fb591
#include "libyang.h"
Packit 8fb591
}
Packit 8fb591
Packit 8fb591
namespace libyang {
Packit 8fb591
Packit 8fb591
/**
Packit 8fb591
 * @defgroup classes C++/Python
Packit 8fb591
 * @{
Packit 8fb591
 *
Packit 8fb591
 * Class wrappers for data structures and functions to manipulate and access instance data tree.
Packit 8fb591
 */
Packit 8fb591
Packit 8fb591
/**
Packit 8fb591
 * @brief class for wrapping ly_ctx.
Packit 8fb591
 * @class Context
Packit 8fb591
 */
Packit 8fb591
class Context
Packit 8fb591
{
Packit 8fb591
public:
Packit 8fb591
    /** wrapper for struct ly_ctx, for internal use only */
Packit 8fb591
    Context(struct ly_ctx *ctx, S_Deleter deleter);
Packit 8fb591
    /** wrapper for [ly_ctx_new](@ref ly_ctx_new) */
Packit 8fb591
    explicit Context(const char *search_dir = nullptr, int options = 0);
Packit 8fb591
    /** wrapper for [ly_ctx_new_ylpath](@ref ly_ctx_new_ylpath) */
Packit 8fb591
    Context(const char *search_dir, const char *path, LYD_FORMAT format, int options = 0);
Packit 8fb591
    /** wrapper for [ly_ctx_new_ylmem](@ref ly_ctx_new_ylmem) */
Packit 8fb591
    Context(const char *search_dir, LYD_FORMAT format, const char *data, int options = 0);
Packit 8fb591
    ~Context();
Packit 8fb591
    /** wrapper for [ly_ctx_set_searchdir](@ref ly_ctx_set_searchdir) */
Packit 8fb591
    int set_searchdir(const char *search_dir);
Packit 8fb591
    /** wrapper for [ly_ctx_unset_searchdirs](@ref ly_ctx_unset_searchdirs) */
Packit 8fb591
    void unset_searchdirs(int idx) {return ly_ctx_unset_searchdirs(ctx, idx);};
Packit 8fb591
    /** wrapper for [ly_ctx_get_searchdirs](@ref ly_ctx_get_searchdirs) */
Packit 8fb591
    std::vector<std::string> get_searchdirs();
Packit 8fb591
    /** wrapper for [ly_ctx_set_allimplemented](@ref ly_ctx_set_allimplemented) */
Packit 8fb591
    void set_allimplemented() {return ly_ctx_set_allimplemented(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_unset_allimplemented](@ref ly_ctx_unset_allimplemented) */
Packit 8fb591
    void unset_allimplemented() {return ly_ctx_unset_allimplemented(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_set_disable_searchdirs](@ref ly_ctx_set_disable_searchdirs) */
Packit 8fb591
    void set_disable_searchdirs() {return ly_ctx_set_disable_searchdirs(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_unset_disable_searchdirs](@ref ly_ctx_unset_disable_searchdirs) */
Packit 8fb591
    void unset_disable_searchdirs() {return ly_ctx_unset_disable_searchdirs(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_set_disable_searchdir_cwd](@ref ly_ctx_set_disable_searchdir_cwd) */
Packit 8fb591
    void set_disable_searchdir_cwd() {return ly_ctx_set_disable_searchdir_cwd(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_unset_disable_searchdir_cwd](@ref ly_ctx_unset_disable_searchdir_cwd) */
Packit 8fb591
    void unset_disable_searchdir_cwd() {return ly_ctx_unset_disable_searchdir_cwd(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_set_prefer_searchdirs](@ref ly_ctx_set_disable_searchdirs) */
Packit 8fb591
    void set_prefer_searchdirs() {return ly_ctx_set_prefer_searchdirs(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_unset_prefer_searchdirs](@ref ly_ctx_unset_prefer_searchdirs) */
Packit 8fb591
    void unset_prefer_searchdirs() {return ly_ctx_unset_prefer_searchdirs(ctx);};
Packit 8fb591
    /** wrapper for [ly_ctx_info](@ref ly_ctx_info) */
Packit 8fb591
    S_Data_Node info();
Packit 8fb591
    /** wrapper for [ly_ctx_get_module_iter](@ref ly_ctx_get_module_iter) */
Packit 8fb591
    std::vector<S_Module> get_module_iter();
Packit 8fb591
    /** wrapper for [ly_ctx_get_disabled_module_iter](@ref ly_ctx_get_disabled_module_iter) */
Packit 8fb591
    std::vector<S_Module> get_disabled_module_iter();
Packit 8fb591
    /** wrapper for [ly_ctx_get_module](@ref ly_ctx_get_module) */
Packit 8fb591
    S_Module get_module(const char *name, const char *revision = nullptr, int implemented = 0);
Packit 8fb591
    /** wrapper for [ly_ctx_get_module_older](@ref ly_ctx_get_module_older) */
Packit 8fb591
    S_Module get_module_older(S_Module module);
Packit 8fb591
    /** wrapper for [ly_ctx_load_module](@ref ly_ctx_load_module) */
Packit 8fb591
    S_Module load_module(const char *name, const char *revision = nullptr);
Packit 8fb591
    /** wrapper for [ly_ctx_get_module_by_ns](@ref ly_ctx_get_module_by_ns) */
Packit 8fb591
    S_Module get_module_by_ns(const char *ns, const char *revision = nullptr, int implemented = 0);
Packit 8fb591
    /** wrapper for [ly_ctx_get_submodule](@ref ly_ctx_get_submodule) */
Packit 8fb591
    S_Submodule get_submodule(const char *module, const char *revision = nullptr, const char *submodule = nullptr, const char *sub_revision = nullptr);
Packit 8fb591
    /** wrapper for [ly_ctx_get_submodule2](@ref ly_ctx_get_submodule2) */
Packit 8fb591
    S_Submodule get_submodule2(S_Module main_module, const char *submodule = nullptr);
Packit 8fb591
    /** wrapper for [ly_ctx_get_node](@ref ly_ctx_get_node) */
Packit 8fb591
    S_Schema_Node get_node(S_Schema_Node start, const char *data_path, int output = 0);
Packit 8fb591
    /** wrapper for [lys_getnext](@ref lys_getnext) */
Packit 8fb591
    std::vector<S_Schema_Node> data_instantiables(int options);
Packit 8fb591
    /** wrapper for [ly_ctx_find_path](@ref ly_ctx_find_path) */
Packit 8fb591
    S_Set find_path(const char *schema_path);
Packit 8fb591
    /** wrapper for [ly_ctx_clean](@ref ly_ctx_clean) */
Packit 8fb591
    void clean();
Packit 8fb591
Packit 8fb591
    struct mod_missing_cb_return {
Packit 8fb591
        LYS_INFORMAT format;
Packit 8fb591
        const char *data;
Packit 8fb591
    };
Packit 8fb591
    using mod_missing_cb_t = std::function<mod_missing_cb_return(const char *mod_name, const char *mod_rev, const char *submod_name, const char *sub_rev)>;
Packit 8fb591
    using mod_missing_deleter_t = std::function<void(void *)>;
Packit 8fb591
    /** @short Add a missing include or import module callback
Packit 8fb591
Packit 8fb591
    When libyang hits a missing module, the @arg callback will be called. If it can accommodate this request, it should return an
Packit 8fb591
    appropriate mod_missing_cb_return struct. If it is needed to free the actual module "source code", then @arg deleter should be
Packit 8fb591
    provided; it is then responsible for deallocation of the resulting mod_missing_cb_return::data.
Packit 8fb591
    */
Packit 8fb591
    void add_missing_module_callback(const mod_missing_cb_t &callback, const mod_missing_deleter_t &deleter = mod_missing_deleter_t());
Packit 8fb591
Packit 8fb591
    /* functions */
Packit 8fb591
    /** wrapper for [lyd_parse_mem](@ref lyd_parse_mem) */
Packit 8fb591
    S_Data_Node parse_data_mem(const char *data, LYD_FORMAT format, int options = 0);
Packit 8fb591
    /** wrapper for [lyd_parse_fd](@ref lyd_parse_fd) */
Packit 8fb591
    S_Data_Node parse_data_fd(int fd, LYD_FORMAT format, int options = 0);
Packit 8fb591
    /** wrapper for [lyd_parse_path](@ref lyd_parse_path) */
Packit 8fb591
    S_Data_Node parse_data_path(const char *path, LYD_FORMAT format, int options = 0);
Packit 8fb591
    /** wrapper for [lyd_parse_xml](@ref lyd_parse_xml) */
Packit 8fb591
    S_Data_Node parse_data_xml(S_Xml_Elem elem, int options = 0);
Packit 8fb591
    /** wrapper for [lys_parse_mem](@ref lys_parse_mem) */
Packit 8fb591
    S_Module parse_module_mem(const char *data, LYS_INFORMAT format);
Packit 8fb591
    /** wrapper for [lys_parse_fd](@ref lys_parse_fd) */
Packit 8fb591
    S_Module parse_module_fd(int fd, LYS_INFORMAT format);
Packit 8fb591
    /** wrapper for [lys_parse_path](@ref lys_parse_path) */
Packit 8fb591
    S_Module parse_module_path(const char *path, LYS_INFORMAT format);
Packit 8fb591
Packit 8fb591
    friend std::vector<S_Error> get_ly_errors(S_Context context);
Packit 8fb591
    friend Data_Node;
Packit 8fb591
    friend Deleter;
Packit 8fb591
    friend Error;
Packit 8fb591
Packit 8fb591
    std::vector<std::pair<mod_missing_cb_t, mod_missing_deleter_t>> mod_missing_cb;
Packit 8fb591
    std::vector<const mod_missing_deleter_t *> mod_missing_deleter;
Packit 8fb591
    static const char* cpp_mod_missing_cb(const char *mod_name, const char *mod_rev, const char *submod_name, const char *sub_rev, void *user_data, LYS_INFORMAT *format, void(**free_module_data)(void *model_data, void *user_data));
Packit 8fb591
    static void cpp_mod_missing_deleter(void *data, void *user_data);
Packit 8fb591
Packit 8fb591
    /* SWIG specific */
Packit 8fb591
    struct ly_ctx *swig_ctx() {return ctx;};
Packit 8fb591
    std::vector<void*> wrap_cb_l;
Packit 8fb591
private:
Packit 8fb591
    struct ly_ctx *ctx;
Packit 8fb591
    S_Deleter deleter;
Packit 8fb591
};
Packit 8fb591
Packit 8fb591
S_Context create_new_Context(struct ly_ctx *ctx);
Packit 8fb591
Packit 8fb591
/**
Packit 8fb591
 * @brief class for wrapping [ly_err_item](@ref ly_err_item).
Packit 8fb591
 * @class Error
Packit 8fb591
 */
Packit 8fb591
class Error
Packit 8fb591
{
Packit 8fb591
public:
Packit 8fb591
    /** wrapper for [ly_err_item](@ref ly_err_item) */
Packit 8fb591
    Error(struct ly_err_item *eitem);
Packit 8fb591
    ~Error() {};
Packit 8fb591
    /** get no variable from [ly_err_item](@ref ly_err_item) */
Packit 8fb591
    LY_ERR err() throw() {return eitem->no;};
Packit 8fb591
    /** get vecode variable from [ly_err_item](@ref ly_err_item)*/
Packit 8fb591
    LY_VECODE vecode() throw() {return eitem->vecode;};
Packit 8fb591
    /** get errmsg variable from [ly_err_item](@ref ly_err_item)*/
Packit 8fb591
    const char *errmsg() const throw() {return eitem->msg ? eitem->msg : "";};
Packit 8fb591
    /** get errpath variable from [ly_err_item](@ref ly_err_item)*/
Packit 8fb591
    const char *errpath() const throw() {return eitem->path ? eitem->path : "";};
Packit 8fb591
    /** get errapptag variable from [ly_err_item](@ref ly_err_item)*/
Packit 8fb591
    const char *errapptag() const throw() {return eitem->apptag ? eitem->path : "";};
Packit 8fb591
private:
Packit 8fb591
	struct ly_err_item *eitem;
Packit 8fb591
};
Packit 8fb591
Packit 8fb591
std::vector<S_Error> get_ly_errors(S_Context context);
Packit 8fb591
int set_log_options(int options);
Packit 8fb591
LY_LOG_LEVEL set_log_verbosity(LY_LOG_LEVEL level);
Packit 8fb591
Packit 8fb591
/**
Packit 8fb591
 * @brief class for wrapping [ly_set](@ref ly_set).
Packit 8fb591
 * @class Set
Packit 8fb591
 */
Packit 8fb591
class Set
Packit 8fb591
{
Packit 8fb591
public:
Packit 8fb591
    /** wrapper for [ly_set_new](@ref ly_set_new) */
Packit 8fb591
    Set(struct ly_set *set, S_Deleter);
Packit 8fb591
    Set();
Packit 8fb591
    ~Set();
Packit 8fb591
    /** get size variable from [ly_set](@ref ly_set)*/
Packit 8fb591
    unsigned int size() {return set->size;};
Packit 8fb591
    /** get number variable from [ly_set](@ref ly_set)*/
Packit 8fb591
    unsigned int number() {return set->number;};
Packit 8fb591
    /** get d variable from [ly_set_set](@ref ly_set_set)*/
Packit 8fb591
    std::vector<S_Data_Node> data();
Packit 8fb591
    /** get s variable from [ly_set_set](@ref ly_set_set)*/
Packit 8fb591
    std::vector<S_Schema_Node> schema();
Packit 8fb591
Packit 8fb591
    /* functions */
Packit 8fb591
    /** wrapper for [ly_set_dup](@ref ly_set_dup) */
Packit 8fb591
    S_Set dup();
Packit 8fb591
    /** wrapper for [ly_set_add](@ref ly_set_add) */
Packit 8fb591
    int add(S_Data_Node node, int options = 0);
Packit 8fb591
    /** wrapper for [ly_set_add](@ref ly_set_add) */
Packit 8fb591
    int add(S_Schema_Node node, int options = 0);
Packit 8fb591
    /** wrapper for [ly_set_contains](@ref ly_set_contains) */
Packit 8fb591
    int contains(S_Data_Node node);
Packit 8fb591
    /** wrapper for [ly_set_contains](@ref ly_set_contains) */
Packit 8fb591
    int contains(S_Schema_Node node);
Packit 8fb591
    /** wrapper for [ly_set_clean](@ref ly_set_clean) */
Packit 8fb591
    int clean();
Packit 8fb591
    /** wrapper for [ly_set_rm](@ref ly_set_rm) */
Packit 8fb591
    int rm(S_Data_Node node);
Packit 8fb591
    /** wrapper for [ly_set_rm](@ref ly_set_rm) */
Packit 8fb591
    int rm(S_Schema_Node node);
Packit 8fb591
    /** wrapper for [ly_set_rm_index](@ref ly_set_rm_index) */
Packit 8fb591
    int rm_index(unsigned int index);
Packit 8fb591
Packit 8fb591
private:
Packit 8fb591
    struct ly_set *set;
Packit 8fb591
    S_Deleter deleter;
Packit 8fb591
};
Packit 8fb591
Packit 8fb591
/**@} */
Packit 8fb591
Packit 8fb591
}
Packit 8fb591
Packit 8fb591
#endif