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
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/*
* Copyright © 2012 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Thomas Voß <thomas.voss@canonical.com>
*/
#ifndef CORE_DBUS_INTROSPECTION_PARSER_H_
#define CORE_DBUS_INTROSPECTION_PARSER_H_
#include <functional>
#include <memory>
#include <string>
namespace core
{
namespace dbus
{
/**
* @brief Parses the DBus XML introspection file format and maps it to an intermediate code model.
*/
class IntrospectionParser
{
public:
/**
* \brief Models an annotation as parsed from the introspection XML.
*/
struct Annotation
{
inline static const char* element_name() { return "annotation"; }
inline static const char* name_attribute_name() { return "name"; }
inline static const char* value_attribute_name() { return "value"; }
std::string name; ///< Name of the annotation, never empty.
std::string value; ///< Value of the annotation, never empty.
};
/**
* \brief Models a node as parsed from the introspection XML.
*/
struct Node
{
inline static const char* element_name() { return "node"; }
inline static const char* name_attribute_name() { return "name"; }
std::string name; ///< Name of the node, never empty.
};
/**
* \brief Models an interface as parsed from the introspection XML.
*/
struct Interface
{
inline static const char* element_name() { return "interface"; }
inline static const char* name_attribute_name() { return "name"; }
std::string name; ///< Name of the interface, never empty.
};
/**
* \brief Models an argument as parsed from the introspection XML.
*/
struct Argument
{
inline static const char* element_name() { return "arg"; }
inline static const char* name_attribute_name() { return "name"; }
inline static const char* type_attribute_name() { return "type"; }
inline static const char* direction_attribute_name() { return "direction"; }
/**
* \brief Direction of the argument.
*/
enum class Direction
{
context, ///< Direction depends on context, i.e., whether it's an arg to a method or a signal.
in, ///< Argument is passed in.
out ///< Argument is returned.
};
std::string name; ///< Name of the argument, never empty.
std::string type; ///< Type of the argument, never empty.
Direction direction; ///< Direction of the argument.
};
/**
* \brief Models a method as parsed from the introspection XML.
*/
struct Method
{
inline static const char* element_name() { return "method"; }
inline static const char* name_attribute_name() { return "name"; }
std::string name; ///< Name of the method, never empty.
};
/**
* \brief Models a signal as parsed from the introspection XML.
*/
struct Signal
{
inline static const char* element_name() { return "signal"; }
inline static const char* name_attribute_name() { return "name"; }
std::string name; ///< Name of the signal, never empty.
};
/**
* \brief Models a property as parsed from the introspection XML.
*/
struct Property
{
inline static const char* element_name() { return "property"; }
inline static const char* name_attribute_name() { return "name"; }
inline static const char* type_attribute_name() { return "type"; }
inline static const char* access_attribute_name() { return "access"; }
/**
* \brief Access qualifier.
*/
enum class Access
{
read, ///< Property is readable.
write, ///< Property is writable.
read_write ///< Property is both readable and writable.
};
std::string name; ///< Name of the property, never empty.
std::string type; ///< Type of the argument, never empty.
Access access; ///< Access specification.
};
IntrospectionParser();
IntrospectionParser(const IntrospectionParser&) = delete;
virtual ~IntrospectionParser();
bool operator==(const IntrospectionParser&) const = delete;
IntrospectionParser& operator=(const IntrospectionParser&) = delete;
/**
* \brief Invokes the parser for the file referred to by filename.
* \returns True in case of success, false otherwise.
*/
virtual bool invoke_for(const std::string& filename);
/**
* \brief Registers the supplied lambda function which is then invoked for every node.
*/
virtual void on_node(const std::function<void(const Node&)>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every node done.
*/
virtual void on_node_done(const std::function<void()>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every interface.
*/
virtual void on_interface(const std::function<void(const Interface&)>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every interface done.
*/
virtual void on_interface_done(const std::function<void()>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every method.
*/
virtual void on_method(const std::function<void(const Method&)>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every method done.
*/
virtual void on_method_done(const std::function<void()>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every property.
*/
virtual void on_property(const std::function<void(const Property&)>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every signal.
*/
virtual void on_signal(const std::function<void(const Signal&)>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every signal done.
*/
virtual void on_signal_done(const std::function<void()>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every argument.
*/
virtual void on_argument(const std::function<void(const Argument&)>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every argument done.
*/
virtual void on_argument_done(const std::function<void()>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every annotation.
*/
virtual void on_annotation(const std::function<void(const Annotation&)>& f);
/**
* \brief Registers the supplied lambda function which is then invoked for every annotation done.
*/
virtual void on_annotation_done(const std::function<void()>& f);
private:
struct Private;
std::unique_ptr<Private> d;
};
}
}
#endif // CORE_DBUS_INTROSPECTION_PARSER_H_
|
