-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathModule.hpp
More file actions
208 lines (173 loc) · 5.03 KB
/
Module.hpp
File metadata and controls
208 lines (173 loc) · 5.03 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
* Copyright (C) 2021 CESNET, https://photonics.cesnet.cz/
*
* Written by Václav Kubernát <[email protected]>
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include <libyang-cpp/Enum.hpp>
#include <libyang-cpp/export.h>
struct ly_ctx;
struct lys_module;
struct lysc_ident;
struct lysc_ext;
struct lysc_ext_instance;
struct lysp_feature;
struct lysp_submodule;
namespace libyang {
class Context;
class DataNode;
class DataNodeTerm;
class Extension;
class ExtensionInstance;
class Meta;
class Module;
class ChildInstanstiables;
class Identity;
class SchemaNode;
class SubmoduleParsed;
template <typename NodeType, IterationType ITER_TYPE>
class Collection;
namespace types {
class IdentityRef;
}
/**
* @brief Represents a feature of a module.
*
* Wraps `lysp_feature`.
*/
class LIBYANG_CPP_EXPORT Feature {
public:
std::string name() const;
bool isEnabled() const;
friend Module;
private:
Feature(const lysp_feature* feature, std::shared_ptr<ly_ctx> ctx);
const lysp_feature* m_feature;
std::shared_ptr<ly_ctx> m_ctx;
};
/**
* @brief Tag for enabling all features (as if using "*" from libyang).
*
* See Module::setImplemented for more information.
*/
struct LIBYANG_CPP_EXPORT AllFeatures {
};
/**
* @brief libyang module class.
*/
class LIBYANG_CPP_EXPORT Module {
public:
std::string name() const;
std::optional<std::string> revision() const;
std::string ns() const;
std::optional<std::string> org() const;
bool implemented() const;
bool featureEnabled(const std::string& featureName) const;
std::vector<Feature> features() const;
std::vector<ExtensionInstance> extensionInstances() const;
ExtensionInstance extensionInstance(const std::string& name) const;
void setImplemented();
void setImplemented(std::vector<std::string> features);
void setImplemented(const AllFeatures);
std::vector<Identity> identities() const;
std::optional<SchemaNode> child() const;
ChildInstanstiables childInstantiables() const;
libyang::Collection<SchemaNode, IterationType::Dfs> childrenDfs() const;
Collection<SchemaNode, IterationType::Sibling> immediateChildren() const;
std::vector<SchemaNode> actionRpcs() const;
std::string printStr(const SchemaOutputFormat format, const std::optional<SchemaPrintFlags> flags = std::nullopt, std::optional<size_t> lineLength = std::nullopt) const;
bool operator==(const Module& other) const;
friend Context;
friend DataNode;
friend Extension;
friend ExtensionInstance;
friend Meta;
friend Identity;
friend SchemaNode;
friend SubmoduleParsed;
private:
Module(lys_module* module, std::shared_ptr<ly_ctx> ctx);
std::shared_ptr<ly_ctx> m_ctx;
lys_module* m_module;
};
/**
* @brief libyang parsed submodule class
*
* Wraps `lysp_submodule`.
* The submodule becames part of `lys_module` in libyang. We can only wrap `lysp_submodule` which represents parsed schema of the submodule.
*/
class LIBYANG_CPP_EXPORT SubmoduleParsed {
public:
std::string name() const;
Module module() const;
std::string printStr(const SchemaOutputFormat format, const std::optional<SchemaPrintFlags> flags = std::nullopt, std::optional<size_t> lineLength = std::nullopt) const;
friend Context;
private:
SubmoduleParsed(const lysp_submodule* submodule, std::shared_ptr<ly_ctx> ctx);
std::shared_ptr<ly_ctx> m_ctx;
const lysp_submodule* m_submodule;
};
/**
* @brief Contains information about an identity.
*
* Wraps `lysc_ident`.
*/
class LIBYANG_CPP_EXPORT Identity {
public:
friend DataNodeTerm;
friend Module;
friend types::IdentityRef;
std::vector<Identity> derived() const;
std::vector<Identity> derivedRecursive() const;
Module module() const;
std::string name() const;
bool operator==(const Identity& other) const;
private:
Identity(const lysc_ident* ident, std::shared_ptr<ly_ctx> ctx);
const lysc_ident* m_ident;
std::shared_ptr<ly_ctx> m_ctx;
};
/**
* @brief Contains information about compiled extension.
*
* Wraps `lysc_ext_instance`
*/
class LIBYANG_CPP_EXPORT ExtensionInstance {
public:
Module module() const;
Extension definition() const;
std::optional<std::string> argument() const;
std::vector<ExtensionInstance> extensionInstances() const;
private:
ExtensionInstance(const lysc_ext_instance* instance, std::shared_ptr<ly_ctx> ctx);
const lysc_ext_instance* m_instance;
std::shared_ptr<ly_ctx> m_ctx;
friend Module;
friend Context;
friend DataNode;
friend Extension;
friend SchemaNode;
};
/**
* @brief Contains information about an extension definition.
*
* Wraps `lysc_ext`
*/
class LIBYANG_CPP_EXPORT Extension {
public:
Module module() const;
std::string name() const;
std::vector<ExtensionInstance> extensionInstances() const;
private:
Extension(const lysc_ext* def, std::shared_ptr<ly_ctx> ctx);
const lysc_ext* m_ext;
std::shared_ptr<ly_ctx> m_ctx;
friend ExtensionInstance;
};
}