blob: 3621c177c9324b94c9fba38ec02806598253a8d0 [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átc31bd602019-03-07 11:44:48 +010012#include <optional>
Václav Kubernát0d4db442018-07-18 17:18:43 +020013#include <set>
Václav Kubernát0d4db442018-07-18 17:18:43 +020014#include "ast_path.hpp"
15#include "schema.hpp"
16
Jan Kundrát4ed0e9f2018-08-23 16:56:58 +020017namespace libyang {
Václav Kubernát0d4db442018-07-18 17:18:43 +020018class Context;
19class Set;
20class Schema_Node;
Václav Kubernátc31bd602019-03-07 11:44:48 +010021class Data_Node;
22class Module;
Jan Kundrát4ed0e9f2018-08-23 16:56:58 +020023}
Václav Kubernát0d4db442018-07-18 17:18:43 +020024
25/*! \class YangSchema
26 * \brief A schema class, which uses libyang for queries.
27 * */
28class YangSchema : public Schema {
29public:
30 YangSchema();
31 ~YangSchema() override;
32
Václav Kubernát2eaceb82018-10-08 19:56:30 +020033 bool isContainer(const schemaPath_& location, const ModuleNodePair& node) const override;
34 bool isLeaf(const schemaPath_& location, const ModuleNodePair& node) const override;
35 bool isModule(const schemaPath_& location, const std::string& name) const override;
36 bool isList(const schemaPath_& location, const ModuleNodePair& node) const override;
37 bool isPresenceContainer(const schemaPath_& location, const ModuleNodePair& node) const override;
38 bool leafEnumHasValue(const schemaPath_& location, const ModuleNodePair& node, const std::string& value) const override;
Václav Kubernáteeb38842019-03-20 19:46:05 +010039 bool leafIdentityIsValid(const schemaPath_& location, const ModuleNodePair& node, const ModuleValuePair& value) const override;
Václav Kubernát2eaceb82018-10-08 19:56:30 +020040 bool listHasKey(const schemaPath_& location, const ModuleNodePair& node, const std::string& key) const override;
Václav Kubernát2eaceb82018-10-08 19:56:30 +020041 const std::set<std::string> listKeys(const schemaPath_& location, const ModuleNodePair& node) const override;
42 yang::LeafDataTypes leafType(const schemaPath_& location, const ModuleNodePair& node) const override;
Václav Kubernáteeb38842019-03-20 19:46:05 +010043 const std::set<std::string> validIdentities(const schemaPath_& location, const ModuleNodePair& node, const Prefixes prefixes) const override;
Václav Kubernát989b5de2019-02-20 16:28:35 +010044 const std::set<std::string> enumValues(const schemaPath_& location, const ModuleNodePair& node) const override;
Václav Kubernát2eaceb82018-10-08 19:56:30 +020045 std::set<std::string> childNodes(const schemaPath_& path, const Recursion recursion) const override;
Václav Kubernát0d4db442018-07-18 17:18:43 +020046
Václav Kubernáta6c5fff2018-09-07 15:16:25 +020047 void registerModuleCallback(const std::function<std::string(const char*, const char*, const char*)>& clb);
48
49 /** @short Loads a module called moduleName. */
50 void loadModule(const std::string& moduleName);
51
Václav Kubernát0d4db442018-07-18 17:18:43 +020052 /** @short Adds a new module passed as a YANG string. */
53 void addSchemaString(const char* schema);
54
55 /** @short Adds a new module from a file. */
56 void addSchemaFile(const char* filename);
57
58 /** @short Adds a new directory for schema lookup. */
59 void addSchemaDirectory(const char* directoryName);
60
Václav Kubernátc31bd602019-03-07 11:44:48 +010061 /** @short Creates a new data node from a path (to be used with NETCONF edit-config) */
62 std::shared_ptr<libyang::Data_Node> dataNodeFromPath(const std::string& path, const std::optional<const std::string> value = std::nullopt) const;
63 std::shared_ptr<libyang::Module> getYangModule(const std::string& name);
64
Václav Kubernát0d4db442018-07-18 17:18:43 +020065private:
66 std::set<std::string> modules() const;
Václav Kubernát0d4db442018-07-18 17:18:43 +020067
68 /** @short Returns a set of nodes, that match the location and name criteria. */
Václav Kubernát2eaceb82018-10-08 19:56:30 +020069 std::shared_ptr<libyang::Set> getNodeSet(const schemaPath_& location, const ModuleNodePair& node) const;
Václav Kubernát0d4db442018-07-18 17:18:43 +020070
71 /** @short Returns a single Schema_Node if the criteria matches only one, otherwise nullptr. */
Václav Kubernát2eaceb82018-10-08 19:56:30 +020072 std::shared_ptr<libyang::Schema_Node> getSchemaNode(const schemaPath_& location, const ModuleNodePair& node) const;
Jan Kundrát4ed0e9f2018-08-23 16:56:58 +020073 std::shared_ptr<libyang::Context> m_context;
Václav Kubernát0d4db442018-07-18 17:18:43 +020074};