blob: fe5cf1c7e3c61f0f7324b4e707a3df3c1dd7b244 [file] [log] [blame]
Václav Kubernát0d4db442018-07-18 17:18:43 +02001/*
2 * Copyright (C) 2018 CESNET, https://photonics.cesnet.cz/
3 * Copyright (C) 2018 FIT CVUT, https://fit.cvut.cz/
4 *
5 * Written by Václav Kubernát <kubervac@fit.cvut.cz>
6 *
7*/
8
9#pragma once
10
Václav Kubernáta6c5fff2018-09-07 15:16:25 +020011#include <functional>
Václav Kubernátcfdb9222021-07-07 22:36:24 +020012#include <libyang-cpp/Context.hpp>
Václav Kubernátc31bd602019-03-07 11:44:48 +010013#include <optional>
Václav Kubernát0d4db442018-07-18 17:18:43 +020014#include <set>
Václav Kubernát0d4db442018-07-18 17:18:43 +020015#include "ast_path.hpp"
16#include "schema.hpp"
17
Václav Kubernát0d4db442018-07-18 17:18:43 +020018/*! \class YangSchema
19 * \brief A schema class, which uses libyang for queries.
20 * */
21class YangSchema : public Schema {
22public:
23 YangSchema();
Václav Kubernátcfdb9222021-07-07 22:36:24 +020024 YangSchema(libyang::Context lyCtx);
Václav Kubernát0d4db442018-07-18 17:18:43 +020025 ~YangSchema() override;
26
Václav Kubernát59e4ee42020-07-08 17:32:45 +020027 [[nodiscard]] yang::NodeTypes nodeType(const std::string& path) const override;
28 [[nodiscard]] yang::NodeTypes nodeType(const schemaPath_& location, const ModuleNodePair& node) const override;
29 [[nodiscard]] bool isModule(const std::string& name) const override;
30 [[nodiscard]] bool listHasKey(const schemaPath_& listPath, const std::string& key) const override;
31 [[nodiscard]] bool leafIsKey(const std::string& leafPath) const override;
32 [[nodiscard]] bool isConfig(const std::string& path) const override;
33 [[nodiscard]] std::optional<std::string> defaultValue(const std::string& leafPath) const override;
34 [[nodiscard]] const std::set<std::string> listKeys(const schemaPath_& listPath) const override;
35 [[nodiscard]] yang::TypeInfo leafType(const schemaPath_& location, const ModuleNodePair& node) const override;
36 [[nodiscard]] yang::TypeInfo leafType(const std::string& path) const override;
Václav Kubernát76ba4ec2020-05-18 13:26:56 +020037 /** @brief If the leaf type is a typedef, returns the typedef name. */
Václav Kubernát59e4ee42020-07-08 17:32:45 +020038 [[nodiscard]] std::optional<std::string> leafTypeName(const std::string& path) const override;
39 [[nodiscard]] std::string leafrefPath(const std::string& leafrefPath) const override;
40 [[nodiscard]] std::set<ModuleNodePair> availableNodes(const boost::variant<dataPath_, schemaPath_, module_>& path, const Recursion recursion) const override;
41 [[nodiscard]] std::optional<std::string> description(const std::string& path) const override;
42 [[nodiscard]] yang::Status status(const std::string& location) const override;
Václav Kubernátd8408e02020-12-02 05:13:27 +010043 [[nodiscard]] bool hasInputNodes(const std::string& path) const override;
Václav Kubernát0d4db442018-07-18 17:18:43 +020044
Jan Kundrátf59b83c2022-03-18 18:12:08 +010045 void registerModuleCallback(const std::function<std::string(const std::string_view, const std::optional<std::string_view>, const std::optional<std::string_view>, const std::optional<std::string_view>)>& clb);
Václav Kubernáta6c5fff2018-09-07 15:16:25 +020046
47 /** @short Loads a module called moduleName. */
48 void loadModule(const std::string& moduleName);
49
Václav Kubernátcfdb9222021-07-07 22:36:24 +020050 /** @short Sets enabled features. */
51 void setEnabledFeatures(const std::string& moduleName, const std::vector<std::string>& features);
Václav Kubernátbf9c6112019-11-04 16:03:35 +010052
Václav Kubernát0d4db442018-07-18 17:18:43 +020053 /** @short Adds a new module passed as a YANG string. */
54 void addSchemaString(const char* schema);
55
56 /** @short Adds a new module from a file. */
57 void addSchemaFile(const char* filename);
58
59 /** @short Adds a new directory for schema lookup. */
60 void addSchemaDirectory(const char* directoryName);
61
Václav Kubernátc31bd602019-03-07 11:44:48 +010062 /** @short Creates a new data node from a path (to be used with NETCONF edit-config) */
Václav Kubernátcfdb9222021-07-07 22:36:24 +020063 [[nodiscard]] libyang::CreatedNodes dataNodeFromPath(const std::string& path, const std::optional<const std::string> value = std::nullopt) const;
64 std::optional<libyang::Module> getYangModule(const std::string& name);
Václav Kubernátc31bd602019-03-07 11:44:48 +010065
Václav Kubernáta8789602020-07-20 15:18:19 +020066 [[nodiscard]] std::string dataPathToSchemaPath(const std::string& path);
Václav Kubernátb4e5b182020-11-16 19:55:09 +010067
Václav Kubernát0d4db442018-07-18 17:18:43 +020068private:
Václav Kubernáte7248b22020-06-26 15:38:59 +020069 friend class YangAccess;
Václav Kubernát5b8a8f32020-05-20 00:57:22 +020070 template <typename NodeType>
Václav Kubernátcfdb9222021-07-07 22:36:24 +020071 [[nodiscard]] yang::TypeInfo impl_leafType(const NodeType& node) const;
Václav Kubernát59e4ee42020-07-08 17:32:45 +020072 [[nodiscard]] std::set<std::string> modules() const;
Václav Kubernát0d4db442018-07-18 17:18:43 +020073
Václav Kubernát0d4db442018-07-18 17:18:43 +020074
Václav Kubernátcfdb9222021-07-07 22:36:24 +020075 /** @short Returns a single SchemaNode if the criteria matches only one, otherwise nullopt. */
76 [[nodiscard]] std::optional<libyang::SchemaNode> getSchemaNode(const std::string& node) const;
77 /** @short Returns a single Schema_Node if the criteria matches only one, otherwise nullopt. */
78 [[nodiscard]] std::optional<libyang::SchemaNode> getSchemaNode(const schemaPath_& listPath) const;
Václav Kubernát47a3f672019-11-08 15:42:43 +010079
80 /** @short Returns a single Schema_Node if the criteria matches only one, otherwise nullptr. */
Václav Kubernátcfdb9222021-07-07 22:36:24 +020081 [[nodiscard]] std::optional<libyang::SchemaNode> getSchemaNode(const schemaPath_& location, const ModuleNodePair& node) const;
82 libyang::Context m_context;
Václav Kubernát47a3f672019-11-08 15:42:43 +010083
Václav Kubernátcfdb9222021-07-07 22:36:24 +020084 [[nodiscard]] std::optional<libyang::SchemaNode> impl_getSchemaNode(const std::string& node) const;
Václav Kubernát0d4db442018-07-18 17:18:43 +020085};