]>
Commit | Line | Data |
---|---|---|
c23c8659 ML |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013-2014 Martin Ling <martin-sigrok@earth.li> | |
5 | * | |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
07443fd2 ML |
20 | /** |
21 | ||
22 | @mainpage API Reference | |
23 | ||
24 | Introduction | |
25 | ------------ | |
26 | ||
52ff4f6a UH |
27 | The libsigrokcxx API provides an object-oriented C++ interface to the |
28 | functionality in libsigrok, including automatic memory and resource management. | |
07443fd2 ML |
29 | |
30 | It is built on top of the public libsigrok C API, and is designed to be used as | |
31 | a standalone alternative API. Programs should not mix usage of the C and C++ | |
32 | APIs; the C++ interface code needs to have full control of all C API calls for | |
33 | resources to be managed correctly. | |
34 | ||
35 | Memory management | |
36 | ----------------- | |
37 | ||
38 | All runtime objects created through the C++ API are passed and accessed via | |
39 | shared pointers, using the C++11 std::shared_ptr implementation. This means | |
40 | that a reference count is kept for each object. | |
41 | ||
42 | Shared pointers can be copied and assigned in a user's program, automatically | |
43 | updating their reference count and deleting objects when they are no longer in | |
44 | use. The C++ interface code also keeps track of internal dependencies between | |
45 | libsigrok resources, and ensures that objects are not prematurely deleted when | |
46 | their resources are in use by other objects. | |
47 | ||
52ff4f6a UH |
48 | This means that management of libsigrokcxx objects and their underlying |
49 | libsigrok resources can be treated as fully automatic. As long as all shared | |
50 | pointers to objects are deleted or reassigned when no longer in use, all | |
51 | underlying resources will be released at the right time. | |
07443fd2 ML |
52 | |
53 | Getting started | |
54 | --------------- | |
55 | ||
56 | Usage of the C++ API needs to begin with a call to sigrok::Context::create(). | |
57 | This will create the global libsigrok context and returns a shared pointer to | |
58 | the sigrok::Context object. Methods on this object provide access to the | |
59 | hardware drivers, input and output formats supported by the library, as well | |
60 | as means of creating other objects such as sessions and triggers. | |
61 | ||
62 | Error handling | |
63 | -------------- | |
64 | ||
65 | When any libsigrok C API call returns an error, a sigrok::Error exception is | |
66 | raised, which provides access to the error code and description. | |
67 | ||
68 | */ | |
69 | ||
1b40fdb8 UH |
70 | #ifndef LIBSIGROKCXX_HPP |
71 | #define LIBSIGROKCXX_HPP | |
c23c8659 | 72 | |
8b2a1843 | 73 | #include <libsigrok/libsigrok.h> |
e0e6aecc | 74 | #include <glibmm.h> |
c23c8659 ML |
75 | |
76 | #include <stdexcept> | |
77 | #include <memory> | |
78 | #include <vector> | |
79 | #include <map> | |
4c7c4194 | 80 | #include <set> |
c23c8659 ML |
81 | |
82 | namespace sigrok | |
83 | { | |
84 | ||
85 | using namespace std; | |
86 | ||
87 | /* Forward declarations */ | |
88 | class SR_API Error; | |
89 | class SR_API Context; | |
90 | class SR_API Driver; | |
91 | class SR_API Device; | |
92 | class SR_API HardwareDevice; | |
93 | class SR_API Channel; | |
c23c8659 ML |
94 | class SR_API Session; |
95 | class SR_API ConfigKey; | |
96 | class SR_API InputFormat; | |
97 | class SR_API OutputFormat; | |
3cd4b381 | 98 | class SR_API OutputFlag; |
c23c8659 ML |
99 | class SR_API LogLevel; |
100 | class SR_API ChannelGroup; | |
101 | class SR_API Trigger; | |
102 | class SR_API TriggerStage; | |
103 | class SR_API TriggerMatch; | |
104 | class SR_API TriggerMatchType; | |
105 | class SR_API ChannelType; | |
106 | class SR_API Packet; | |
107 | class SR_API PacketPayload; | |
108 | class SR_API PacketType; | |
109 | class SR_API Quantity; | |
110 | class SR_API Unit; | |
111 | class SR_API QuantityFlag; | |
ca3291e3 ML |
112 | class SR_API Input; |
113 | class SR_API InputDevice; | |
c23c8659 ML |
114 | class SR_API Output; |
115 | class SR_API DataType; | |
58aa1f83 | 116 | class SR_API Option; |
9fa5b426 | 117 | class SR_API UserDevice; |
c23c8659 ML |
118 | |
119 | /** Exception thrown when an error code is returned by any libsigrok call. */ | |
120 | class SR_API Error: public exception | |
121 | { | |
122 | public: | |
6c11b496 | 123 | explicit Error(int result); |
15914cdb | 124 | ~Error() noexcept; |
c23c8659 | 125 | const int result; |
15914cdb | 126 | const char *what() const noexcept; |
c23c8659 ML |
127 | }; |
128 | ||
541c855e | 129 | /* Base template for classes whose resources are owned by a parent object. */ |
bf52cc8c | 130 | template <class Class, class Parent, typename Struct> |
541c855e | 131 | class SR_API ParentOwned |
c23c8659 | 132 | { |
21d1bec6 DE |
133 | private: |
134 | /* Weak pointer for shared_from_this() implementation. */ | |
135 | weak_ptr<Class> _weak_this; | |
136 | ||
137 | static void reset_parent(Class *object) | |
138 | { | |
139 | if (!object->_parent) | |
140 | throw Error(SR_ERR_BUG); | |
141 | object->_parent.reset(); | |
142 | } | |
143 | ||
7649683c | 144 | protected: |
07443fd2 | 145 | /* Parent object which owns this child object's underlying structure. |
c23c8659 ML |
146 | |
147 | This shared pointer will be null when this child is unused, but | |
148 | will be assigned to point to the parent before any shared pointer | |
149 | to this child is handed out to the user. | |
150 | ||
151 | When the reference count of this child falls to zero, this shared | |
152 | pointer to its parent is reset by a custom deleter on the child's | |
153 | shared pointer. | |
154 | ||
155 | This strategy ensures that the destructors for both the child and | |
156 | the parent are called at the correct time, i.e. only when all | |
157 | references to both the parent and all its children are gone. */ | |
3b161085 | 158 | shared_ptr<Parent> _parent; |
7649683c | 159 | |
21d1bec6 DE |
160 | Struct *_structure; |
161 | ||
162 | explicit ParentOwned(Struct *structure) : | |
163 | _structure(structure) | |
164 | { | |
165 | } | |
0d0170ae | 166 | |
7649683c | 167 | public: |
73a1eb01 ML |
168 | /* Get parent object that owns this object. */ |
169 | shared_ptr<Parent> parent() | |
170 | { | |
171 | return _parent; | |
172 | } | |
173 | ||
0d0170ae | 174 | /* Note, this implementation will create a new smart_ptr if none exists. */ |
bf52cc8c | 175 | shared_ptr<Class> shared_from_this() |
0d0170ae | 176 | { |
bf52cc8c | 177 | shared_ptr<Class> shared; |
0d0170ae | 178 | |
3b161085 | 179 | if (!(shared = _weak_this.lock())) |
0d0170ae | 180 | { |
ce3e1e61 | 181 | shared = shared_ptr<Class>(static_cast<Class *>(this), reset_parent); |
3b161085 | 182 | _weak_this = shared; |
0d0170ae ML |
183 | } |
184 | ||
185 | return shared; | |
186 | } | |
187 | ||
bf52cc8c | 188 | shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent) |
7649683c | 189 | { |
78132e2a ML |
190 | if (!parent) |
191 | throw Error(SR_ERR_BUG); | |
3b161085 | 192 | this->_parent = parent; |
0d0170ae | 193 | return shared_from_this(); |
7649683c | 194 | } |
0d0170ae | 195 | |
bf52cc8c | 196 | shared_ptr<Class> get_shared_pointer(Parent *parent) |
7649683c | 197 | { |
78132e2a ML |
198 | if (!parent) |
199 | throw Error(SR_ERR_BUG); | |
bf52cc8c | 200 | return get_shared_pointer(parent->shared_from_this()); |
7649683c | 201 | } |
c23c8659 ML |
202 | }; |
203 | ||
90e89c2a ML |
204 | /* Base template for classes whose resources are owned by the user. */ |
205 | template <class Class, typename Struct> | |
206 | class SR_API UserOwned : public enable_shared_from_this<Class> | |
207 | { | |
208 | public: | |
209 | shared_ptr<Class> shared_from_this() | |
210 | { | |
211 | auto shared = enable_shared_from_this<Class>::shared_from_this(); | |
212 | if (!shared) | |
213 | throw Error(SR_ERR_BUG); | |
214 | return shared; | |
215 | } | |
216 | protected: | |
3b161085 | 217 | Struct *_structure; |
90e89c2a | 218 | |
6c11b496 | 219 | explicit UserOwned(Struct *structure) : |
3b161085 | 220 | _structure(structure) |
90e89c2a ML |
221 | { |
222 | } | |
b4ed33a7 ML |
223 | |
224 | /* Deleter needed to allow shared_ptr use with protected destructor. */ | |
225 | class Deleter | |
226 | { | |
227 | public: | |
228 | void operator()(Class *object) { delete object; } | |
229 | }; | |
90e89c2a ML |
230 | }; |
231 | ||
c23c8659 ML |
232 | /** Type of log callback */ |
233 | typedef function<void(const LogLevel *, string message)> LogCallbackFunction; | |
234 | ||
e2eaf858 DE |
235 | /** Resource reader delegate. */ |
236 | class SR_API ResourceReader | |
237 | { | |
238 | public: | |
239 | ResourceReader() {} | |
240 | virtual ~ResourceReader(); | |
241 | private: | |
242 | /** Resource open hook. */ | |
243 | virtual void open(struct sr_resource *res, string name) = 0; | |
244 | /** Resource close hook. */ | |
245 | virtual void close(struct sr_resource *res) = 0; | |
246 | /** Resource read hook. */ | |
247 | virtual size_t read(const struct sr_resource *res, void *buf, size_t count) = 0; | |
248 | ||
249 | static SR_PRIV int open_callback(struct sr_resource *res, | |
0ab8e5d2 | 250 | const char *name, void *cb_data) noexcept; |
e2eaf858 | 251 | static SR_PRIV int close_callback(struct sr_resource *res, |
0ab8e5d2 | 252 | void *cb_data) noexcept; |
e2eaf858 | 253 | static SR_PRIV ssize_t read_callback(const struct sr_resource *res, |
0ab8e5d2 | 254 | void *buf, size_t count, void *cb_data) noexcept; |
e2eaf858 DE |
255 | friend class Context; |
256 | }; | |
257 | ||
07443fd2 | 258 | /** The global libsigrok context */ |
90e89c2a | 259 | class SR_API Context : public UserOwned<Context, struct sr_context> |
c23c8659 ML |
260 | { |
261 | public: | |
262 | /** Create new context */ | |
263 | static shared_ptr<Context> create(); | |
264 | /** libsigrok package version. */ | |
a73d4926 | 265 | static string package_version(); |
c23c8659 | 266 | /** libsigrok library version. */ |
a73d4926 | 267 | static string lib_version(); |
c23c8659 | 268 | /** Available hardware drivers, indexed by name. */ |
3b161085 | 269 | map<string, shared_ptr<Driver> > drivers(); |
c23c8659 | 270 | /** Available input formats, indexed by name. */ |
3b161085 | 271 | map<string, shared_ptr<InputFormat> > input_formats(); |
c23c8659 | 272 | /** Available output formats, indexed by name. */ |
3b161085 | 273 | map<string, shared_ptr<OutputFormat> > output_formats(); |
c23c8659 | 274 | /** Current log level. */ |
15bebf57 | 275 | const LogLevel *log_level() const; |
b6f411ac ML |
276 | /** Set the log level. |
277 | * @param level LogLevel to use. */ | |
c23c8659 | 278 | void set_log_level(const LogLevel *level); |
b6f411ac ML |
279 | /** Set the log callback. |
280 | * @param callback Callback of the form callback(LogLevel, string). */ | |
c23c8659 ML |
281 | void set_log_callback(LogCallbackFunction callback); |
282 | /** Set the log callback to the default handler. */ | |
283 | void set_log_callback_default(); | |
e2eaf858 DE |
284 | /** Install a delegate for reading resource files. |
285 | * @param reader The resource reader delegate, or nullptr to unset. */ | |
286 | void set_resource_reader(ResourceReader *reader); | |
c23c8659 ML |
287 | /** Create a new session. */ |
288 | shared_ptr<Session> create_session(); | |
9fa5b426 ML |
289 | /** Create a new user device. */ |
290 | shared_ptr<UserDevice> create_user_device( | |
291 | string vendor, string model, string version); | |
304be4a7 ML |
292 | /** Create a header packet. */ |
293 | shared_ptr<Packet> create_header_packet(Glib::TimeVal start_time); | |
294 | /** Create a meta packet. */ | |
295 | shared_ptr<Packet> create_meta_packet( | |
d370545d | 296 | const map<const ConfigKey *, Glib::VariantBase> &config); |
304be4a7 ML |
297 | /** Create a logic packet. */ |
298 | shared_ptr<Packet> create_logic_packet( | |
299 | void *data_pointer, size_t data_length, unsigned int unit_size); | |
300 | /** Create an analog packet. */ | |
dd13d47a | 301 | shared_ptr<Packet> create_analog_packet( |
d370545d | 302 | const vector<shared_ptr<Channel> > &channels, |
304be4a7 | 303 | float *data_pointer, unsigned int num_samples, const Quantity *mq, |
d370545d | 304 | const Unit *unit, const vector<const QuantityFlag *> &mqflags); |
b6f411ac ML |
305 | /** Load a saved session. |
306 | * @param filename File name string. */ | |
c23c8659 | 307 | shared_ptr<Session> load_session(string filename); |
b6f411ac ML |
308 | /** Create a new trigger. |
309 | * @param name Name string for new trigger. */ | |
c23c8659 | 310 | shared_ptr<Trigger> create_trigger(string name); |
ca3291e3 ML |
311 | /** Open an input file. |
312 | * @param filename File name string. */ | |
313 | shared_ptr<Input> open_file(string filename); | |
314 | /** Open an input stream based on header data. | |
315 | * @param header Initial data from stream. */ | |
316 | shared_ptr<Input> open_stream(string header); | |
15bebf57 | 317 | map<string, string> serials(shared_ptr<Driver> driver) const; |
21d1bec6 | 318 | private: |
3b161085 ML |
319 | map<string, Driver *> _drivers; |
320 | map<string, InputFormat *> _input_formats; | |
321 | map<string, OutputFormat *> _output_formats; | |
322 | Session *_session; | |
323 | LogCallbackFunction _log_callback; | |
c23c8659 ML |
324 | Context(); |
325 | ~Context(); | |
c23c8659 ML |
326 | friend class Deleter; |
327 | friend class Session; | |
328 | friend class Driver; | |
329 | }; | |
330 | ||
4c7c4194 ML |
331 | enum Capability { |
332 | GET = SR_CONF_GET, | |
333 | SET = SR_CONF_SET, | |
334 | LIST = SR_CONF_LIST | |
335 | }; | |
336 | ||
c23c8659 ML |
337 | /** An object that can be configured. */ |
338 | class SR_API Configurable | |
339 | { | |
340 | public: | |
b6f411ac ML |
341 | /** Read configuration for the given key. |
342 | * @param key ConfigKey to read. */ | |
15bebf57 | 343 | Glib::VariantBase config_get(const ConfigKey *key) const; |
b6f411ac ML |
344 | /** Set configuration for the given key to a specified value. |
345 | * @param key ConfigKey to set. | |
346 | * @param value Value to set. */ | |
d370545d | 347 | void config_set(const ConfigKey *key, const Glib::VariantBase &value); |
b6f411ac ML |
348 | /** Enumerate available values for the given configuration key. |
349 | * @param key ConfigKey to enumerate values for. */ | |
15bebf57 | 350 | Glib::VariantContainerBase config_list(const ConfigKey *key) const; |
d54190a3 | 351 | /** Enumerate available keys, according to a given index key. */ |
4c7c4194 | 352 | map<const ConfigKey *, set<Capability> > config_keys(const ConfigKey *key); |
d9eed47d | 353 | /** Check for a key in the list from a given index key. */ |
15bebf57 | 354 | bool config_check(const ConfigKey *key, const ConfigKey *index_key) const; |
c23c8659 ML |
355 | protected: |
356 | Configurable( | |
357 | struct sr_dev_driver *driver, | |
358 | struct sr_dev_inst *sdi, | |
359 | struct sr_channel_group *channel_group); | |
360 | virtual ~Configurable(); | |
361 | struct sr_dev_driver *config_driver; | |
362 | struct sr_dev_inst *config_sdi; | |
363 | struct sr_channel_group *config_channel_group; | |
364 | }; | |
365 | ||
59b74d28 ML |
366 | /** A hardware driver provided by the library */ |
367 | class SR_API Driver : | |
368 | public ParentOwned<Driver, Context, struct sr_dev_driver>, | |
369 | public Configurable | |
370 | { | |
371 | public: | |
372 | /** Name of this driver. */ | |
15bebf57 | 373 | string name() const; |
59b74d28 | 374 | /** Long name for this driver. */ |
15bebf57 | 375 | string long_name() const; |
59b74d28 ML |
376 | /** Scan for devices and return a list of devices found. |
377 | * @param options Mapping of (ConfigKey, value) pairs. */ | |
378 | vector<shared_ptr<HardwareDevice> > scan( | |
d370545d | 379 | const map<const ConfigKey *, Glib::VariantBase> &options = {}); |
21d1bec6 | 380 | private: |
3b161085 ML |
381 | bool _initialized; |
382 | vector<HardwareDevice *> _devices; | |
6c11b496 | 383 | explicit Driver(struct sr_dev_driver *structure); |
59b74d28 ML |
384 | ~Driver(); |
385 | friend class Context; | |
386 | friend class HardwareDevice; | |
387 | friend class ChannelGroup; | |
388 | }; | |
389 | ||
07443fd2 | 390 | /** A generic device, either hardware or virtual */ |
d01d2314 | 391 | class SR_API Device : public Configurable |
c23c8659 ML |
392 | { |
393 | public: | |
394 | /** Vendor name for this device. */ | |
15bebf57 | 395 | string vendor() const; |
c23c8659 | 396 | /** Model name for this device. */ |
15bebf57 | 397 | string model() const; |
c23c8659 | 398 | /** Version string for this device. */ |
15bebf57 | 399 | string version() const; |
d1075e5a | 400 | /** Serial number for this device. */ |
15bebf57 | 401 | string serial_number() const; |
d1075e5a | 402 | /** Connection ID for this device. */ |
15bebf57 | 403 | string connection_id() const; |
c23c8659 | 404 | /** List of the channels available on this device. */ |
3b161085 | 405 | vector<shared_ptr<Channel> > channels(); |
6be7a7f2 | 406 | /** Channel groups available on this device, indexed by name. */ |
3b161085 | 407 | map<string, shared_ptr<ChannelGroup> > channel_groups(); |
c23c8659 ML |
408 | /** Open device. */ |
409 | void open(); | |
410 | /** Close device. */ | |
411 | void close(); | |
412 | protected: | |
6c11b496 | 413 | explicit Device(struct sr_dev_inst *structure); |
c23c8659 | 414 | ~Device(); |
d01d2314 | 415 | virtual shared_ptr<Device> get_shared_from_this() = 0; |
4178d971 | 416 | shared_ptr<Channel> get_channel(struct sr_channel *ptr); |
21d1bec6 | 417 | |
3b161085 ML |
418 | struct sr_dev_inst *_structure; |
419 | map<struct sr_channel *, Channel *> _channels; | |
21d1bec6 | 420 | private: |
3b161085 | 421 | map<string, ChannelGroup *> _channel_groups; |
c23c8659 ML |
422 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
423 | class Deleter | |
424 | { | |
425 | public: | |
426 | void operator()(Device *device) { delete device; } | |
427 | }; | |
428 | friend class Deleter; | |
429 | friend class Session; | |
430 | friend class Channel; | |
431 | friend class ChannelGroup; | |
432 | friend class Output; | |
dd13d47a | 433 | friend class Analog; |
c23c8659 ML |
434 | }; |
435 | ||
07443fd2 | 436 | /** A real hardware device, connected via a driver */ |
6e5240f4 | 437 | class SR_API HardwareDevice : |
a4e47454 | 438 | public UserOwned<HardwareDevice, struct sr_dev_inst>, |
6e5240f4 | 439 | public Device |
c23c8659 ML |
440 | { |
441 | public: | |
442 | /** Driver providing this device. */ | |
3b161085 | 443 | shared_ptr<Driver> driver(); |
21d1bec6 | 444 | private: |
a4e47454 | 445 | HardwareDevice(shared_ptr<Driver> driver, struct sr_dev_inst *structure); |
c23c8659 | 446 | ~HardwareDevice(); |
d01d2314 | 447 | shared_ptr<Device> get_shared_from_this(); |
a4e47454 ML |
448 | shared_ptr<Driver> _driver; |
449 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
450 | class Deleter | |
451 | { | |
452 | public: | |
453 | void operator()(HardwareDevice *device) { delete device; } | |
454 | }; | |
455 | friend class Deleter; | |
c23c8659 ML |
456 | friend class Driver; |
457 | friend class ChannelGroup; | |
458 | }; | |
459 | ||
9fa5b426 ML |
460 | /** A virtual device, created by the user */ |
461 | class SR_API UserDevice : | |
462 | public UserOwned<UserDevice, struct sr_dev_inst>, | |
463 | public Device | |
464 | { | |
465 | public: | |
466 | /** Add a new channel to this device. */ | |
467 | shared_ptr<Channel> add_channel(unsigned int index, const ChannelType *type, string name); | |
21d1bec6 | 468 | private: |
9fa5b426 ML |
469 | UserDevice(string vendor, string model, string version); |
470 | ~UserDevice(); | |
471 | shared_ptr<Device> get_shared_from_this(); | |
472 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
473 | class Deleter | |
474 | { | |
475 | public: | |
476 | void operator()(UserDevice *device) { delete device; } | |
477 | }; | |
478 | friend class Context; | |
479 | friend class Deleter; | |
480 | }; | |
481 | ||
07443fd2 | 482 | /** A channel on a device */ |
bf52cc8c | 483 | class SR_API Channel : |
541c855e | 484 | public ParentOwned<Channel, Device, struct sr_channel> |
c23c8659 ML |
485 | { |
486 | public: | |
487 | /** Current name of this channel. */ | |
15bebf57 | 488 | string name() const; |
b6f411ac ML |
489 | /** Set the name of this channel. * |
490 | * @param name Name string to set. */ | |
c23c8659 ML |
491 | void set_name(string name); |
492 | /** Type of this channel. */ | |
15bebf57 | 493 | const ChannelType *type() const; |
c23c8659 | 494 | /** Enabled status of this channel. */ |
15bebf57 | 495 | bool enabled() const; |
b6f411ac ML |
496 | /** Set the enabled status of this channel. |
497 | * @param value Boolean value to set. */ | |
c23c8659 | 498 | void set_enabled(bool value); |
06bd935e | 499 | /** Get the index number of this channel. */ |
15bebf57 | 500 | unsigned int index() const; |
21d1bec6 | 501 | private: |
6c11b496 | 502 | explicit Channel(struct sr_channel *structure); |
c23c8659 | 503 | ~Channel(); |
3b161085 | 504 | const ChannelType * const _type; |
c23c8659 | 505 | friend class Device; |
9fa5b426 | 506 | friend class UserDevice; |
c23c8659 ML |
507 | friend class ChannelGroup; |
508 | friend class Session; | |
509 | friend class TriggerStage; | |
304be4a7 | 510 | friend class Context; |
c23c8659 ML |
511 | }; |
512 | ||
07443fd2 | 513 | /** A group of channels on a device, which share some configuration */ |
c23c8659 | 514 | class SR_API ChannelGroup : |
541c855e | 515 | public ParentOwned<ChannelGroup, Device, struct sr_channel_group>, |
c23c8659 ML |
516 | public Configurable |
517 | { | |
518 | public: | |
519 | /** Name of this channel group. */ | |
15bebf57 | 520 | string name() const; |
c23c8659 | 521 | /** List of the channels in this group. */ |
3b161085 | 522 | vector<shared_ptr<Channel> > channels(); |
21d1bec6 | 523 | private: |
6be7a7f2 | 524 | ChannelGroup(Device *device, struct sr_channel_group *structure); |
c23c8659 | 525 | ~ChannelGroup(); |
3b161085 | 526 | vector<Channel *> _channels; |
6be7a7f2 | 527 | friend class Device; |
c23c8659 ML |
528 | }; |
529 | ||
07443fd2 | 530 | /** A trigger configuration */ |
90e89c2a | 531 | class SR_API Trigger : public UserOwned<Trigger, struct sr_trigger> |
c23c8659 ML |
532 | { |
533 | public: | |
b6f411ac | 534 | /** Name of this trigger configuration. */ |
15bebf57 | 535 | string name() const; |
b6f411ac | 536 | /** List of the stages in this trigger. */ |
3b161085 | 537 | vector<shared_ptr<TriggerStage> > stages(); |
b6f411ac | 538 | /** Add a new stage to this trigger. */ |
c23c8659 | 539 | shared_ptr<TriggerStage> add_stage(); |
21d1bec6 | 540 | private: |
c23c8659 ML |
541 | Trigger(shared_ptr<Context> context, string name); |
542 | ~Trigger(); | |
3b161085 ML |
543 | shared_ptr<Context> _context; |
544 | vector<TriggerStage *> _stages; | |
b4ed33a7 | 545 | friend class Deleter; |
c23c8659 | 546 | friend class Context; |
6fa0eb86 | 547 | friend class Session; |
c23c8659 ML |
548 | }; |
549 | ||
07443fd2 | 550 | /** A stage in a trigger configuration */ |
bf52cc8c | 551 | class SR_API TriggerStage : |
541c855e | 552 | public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage> |
c23c8659 ML |
553 | { |
554 | public: | |
b6f411ac | 555 | /** Index number of this stage. */ |
15bebf57 | 556 | int number() const; |
b6f411ac | 557 | /** List of match conditions on this stage. */ |
3b161085 | 558 | vector<shared_ptr<TriggerMatch> > matches(); |
b6f411ac ML |
559 | /** Add a new match condition to this stage. |
560 | * @param channel Channel to match on. | |
561 | * @param type TriggerMatchType to apply. */ | |
c23c8659 | 562 | void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type); |
b6f411ac ML |
563 | /** Add a new match condition to this stage. |
564 | * @param channel Channel to match on. | |
565 | * @param type TriggerMatchType to apply. | |
566 | * @param value Threshold value. */ | |
c23c8659 | 567 | void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value); |
21d1bec6 | 568 | private: |
3b161085 | 569 | vector<TriggerMatch *> _matches; |
6c11b496 | 570 | explicit TriggerStage(struct sr_trigger_stage *structure); |
c23c8659 ML |
571 | ~TriggerStage(); |
572 | friend class Trigger; | |
573 | }; | |
574 | ||
07443fd2 | 575 | /** A match condition in a trigger configuration */ |
bf52cc8c | 576 | class SR_API TriggerMatch : |
541c855e | 577 | public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match> |
c23c8659 ML |
578 | { |
579 | public: | |
b6f411ac | 580 | /** Channel this condition matches on. */ |
3b161085 | 581 | shared_ptr<Channel> channel(); |
b6f411ac | 582 | /** Type of match. */ |
15bebf57 | 583 | const TriggerMatchType *type() const; |
b6f411ac | 584 | /** Threshold value. */ |
15bebf57 | 585 | float value() const; |
21d1bec6 | 586 | private: |
c23c8659 ML |
587 | TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel); |
588 | ~TriggerMatch(); | |
3b161085 | 589 | shared_ptr<Channel> _channel; |
c23c8659 ML |
590 | friend class TriggerStage; |
591 | }; | |
592 | ||
f91cf612 DE |
593 | /** Type of session stopped callback */ |
594 | typedef function<void()> SessionStoppedCallback; | |
595 | ||
c23c8659 ML |
596 | /** Type of datafeed callback */ |
597 | typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)> | |
598 | DatafeedCallbackFunction; | |
599 | ||
07443fd2 | 600 | /* Data required for C callback function to call a C++ datafeed callback */ |
c23c8659 ML |
601 | class SR_PRIV DatafeedCallbackData |
602 | { | |
603 | public: | |
604 | void run(const struct sr_dev_inst *sdi, | |
605 | const struct sr_datafeed_packet *pkt); | |
21d1bec6 | 606 | private: |
3b161085 | 607 | DatafeedCallbackFunction _callback; |
c23c8659 ML |
608 | DatafeedCallbackData(Session *session, |
609 | DatafeedCallbackFunction callback); | |
3b161085 | 610 | Session *_session; |
c23c8659 ML |
611 | friend class Session; |
612 | }; | |
613 | ||
cac58676 ML |
614 | /** A virtual device associated with a stored session */ |
615 | class SR_API SessionDevice : | |
616 | public ParentOwned<SessionDevice, Session, struct sr_dev_inst>, | |
617 | public Device | |
618 | { | |
21d1bec6 | 619 | private: |
6c11b496 | 620 | explicit SessionDevice(struct sr_dev_inst *sdi); |
cac58676 ML |
621 | ~SessionDevice(); |
622 | shared_ptr<Device> get_shared_from_this(); | |
623 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
624 | class Deleter | |
625 | { | |
626 | public: | |
627 | void operator()(SessionDevice *device) { delete device; } | |
628 | }; | |
629 | friend class Deleter; | |
630 | friend class Session; | |
631 | }; | |
632 | ||
07443fd2 | 633 | /** A sigrok session */ |
90e89c2a | 634 | class SR_API Session : public UserOwned<Session, struct sr_session> |
c23c8659 ML |
635 | { |
636 | public: | |
b6f411ac ML |
637 | /** Add a device to this session. |
638 | * @param device Device to add. */ | |
c23c8659 ML |
639 | void add_device(shared_ptr<Device> device); |
640 | /** List devices attached to this session. */ | |
3b161085 | 641 | vector<shared_ptr<Device> > devices(); |
c23c8659 ML |
642 | /** Remove all devices from this session. */ |
643 | void remove_devices(); | |
b6f411ac ML |
644 | /** Add a datafeed callback to this session. |
645 | * @param callback Callback of the form callback(Device, Packet). */ | |
c23c8659 ML |
646 | void add_datafeed_callback(DatafeedCallbackFunction callback); |
647 | /** Remove all datafeed callbacks from this session. */ | |
648 | void remove_datafeed_callbacks(); | |
c23c8659 ML |
649 | /** Start the session. */ |
650 | void start(); | |
651 | /** Run the session event loop. */ | |
652 | void run(); | |
653 | /** Stop the session. */ | |
654 | void stop(); | |
f91cf612 DE |
655 | /** Return whether the session is running. */ |
656 | bool is_running() const; | |
657 | /** Set callback to be invoked on session stop. */ | |
658 | void set_stopped_callback(SessionStoppedCallback callback); | |
6fa0eb86 | 659 | /** Get current trigger setting. */ |
3b161085 | 660 | shared_ptr<Trigger> trigger(); |
624d1610 UH |
661 | /** Get the context. */ |
662 | shared_ptr<Context> context(); | |
b6f411ac ML |
663 | /** Set trigger setting. |
664 | * @param trigger Trigger object to use. */ | |
6fa0eb86 | 665 | void set_trigger(shared_ptr<Trigger> trigger); |
1411f7d8 | 666 | /** Get filename this session was loaded from. */ |
15bebf57 | 667 | string filename() const; |
21d1bec6 | 668 | private: |
6c11b496 | 669 | explicit Session(shared_ptr<Context> context); |
c23c8659 ML |
670 | Session(shared_ptr<Context> context, string filename); |
671 | ~Session(); | |
ca4e307a | 672 | shared_ptr<Device> get_device(const struct sr_dev_inst *sdi); |
3b161085 | 673 | const shared_ptr<Context> _context; |
ca4e307a ML |
674 | map<const struct sr_dev_inst *, SessionDevice *> _owned_devices; |
675 | map<const struct sr_dev_inst *, shared_ptr<Device> > _other_devices; | |
3b161085 | 676 | vector<DatafeedCallbackData *> _datafeed_callbacks; |
f91cf612 | 677 | SessionStoppedCallback _stopped_callback; |
98d39b91 | 678 | string _filename; |
3b161085 | 679 | shared_ptr<Trigger> _trigger; |
c23c8659 ML |
680 | friend class Deleter; |
681 | friend class Context; | |
682 | friend class DatafeedCallbackData; | |
98d39b91 | 683 | friend class SessionDevice; |
c23c8659 ML |
684 | }; |
685 | ||
07443fd2 | 686 | /** A packet on the session datafeed */ |
90e89c2a | 687 | class SR_API Packet : public UserOwned<Packet, const struct sr_datafeed_packet> |
c23c8659 ML |
688 | { |
689 | public: | |
90ba83f2 | 690 | /** Type of this packet. */ |
15bebf57 | 691 | const PacketType *type() const; |
c23c8659 | 692 | /** Payload of this packet. */ |
3b161085 | 693 | shared_ptr<PacketPayload> payload(); |
21d1bec6 | 694 | private: |
2928f47d ML |
695 | Packet(shared_ptr<Device> device, |
696 | const struct sr_datafeed_packet *structure); | |
c23c8659 | 697 | ~Packet(); |
3b161085 ML |
698 | shared_ptr<Device> _device; |
699 | PacketPayload *_payload; | |
c23c8659 ML |
700 | friend class Deleter; |
701 | friend class Session; | |
702 | friend class Output; | |
703 | friend class DatafeedCallbackData; | |
2928f47d ML |
704 | friend class Header; |
705 | friend class Meta; | |
706 | friend class Logic; | |
dd13d47a | 707 | friend class Analog; |
304be4a7 | 708 | friend class Context; |
c23c8659 ML |
709 | }; |
710 | ||
07443fd2 | 711 | /** Abstract base class for datafeed packet payloads */ |
c23c8659 ML |
712 | class SR_API PacketPayload |
713 | { | |
714 | protected: | |
715 | PacketPayload(); | |
716 | virtual ~PacketPayload() = 0; | |
4cd883a7 | 717 | virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0; |
21d1bec6 | 718 | |
2928f47d | 719 | friend class Deleter; |
c23c8659 ML |
720 | friend class Packet; |
721 | friend class Output; | |
722 | }; | |
723 | ||
2928f47d | 724 | /** Payload of a datafeed header packet */ |
4cd883a7 | 725 | class SR_API Header : |
541c855e | 726 | public ParentOwned<Header, Packet, const struct sr_datafeed_header>, |
4cd883a7 | 727 | public PacketPayload |
2928f47d ML |
728 | { |
729 | public: | |
b6f411ac | 730 | /* Feed version number. */ |
15bebf57 | 731 | int feed_version() const; |
b6f411ac | 732 | /* Start time of this session. */ |
15bebf57 | 733 | Glib::TimeVal start_time() const; |
21d1bec6 | 734 | private: |
6c11b496 | 735 | explicit Header(const struct sr_datafeed_header *structure); |
2928f47d | 736 | ~Header(); |
4cd883a7 | 737 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
2928f47d ML |
738 | friend class Packet; |
739 | }; | |
740 | ||
741 | /** Payload of a datafeed metadata packet */ | |
4cd883a7 | 742 | class SR_API Meta : |
541c855e | 743 | public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>, |
4cd883a7 | 744 | public PacketPayload |
2928f47d ML |
745 | { |
746 | public: | |
b6f411ac | 747 | /* Mapping of (ConfigKey, value) pairs. */ |
15bebf57 | 748 | map<const ConfigKey *, Glib::VariantBase> config() const; |
21d1bec6 | 749 | private: |
6c11b496 | 750 | explicit Meta(const struct sr_datafeed_meta *structure); |
2928f47d | 751 | ~Meta(); |
4cd883a7 | 752 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
3b161085 | 753 | map<const ConfigKey *, Glib::VariantBase> _config; |
2928f47d ML |
754 | friend class Packet; |
755 | }; | |
756 | ||
07443fd2 | 757 | /** Payload of a datafeed packet with logic data */ |
4cd883a7 | 758 | class SR_API Logic : |
541c855e | 759 | public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>, |
4cd883a7 | 760 | public PacketPayload |
c23c8659 | 761 | { |
2928f47d ML |
762 | public: |
763 | /* Pointer to data. */ | |
3b161085 | 764 | void *data_pointer(); |
2928f47d | 765 | /* Data length in bytes. */ |
15bebf57 | 766 | size_t data_length() const; |
2928f47d | 767 | /* Size of each sample in bytes. */ |
15bebf57 | 768 | unsigned int unit_size() const; |
21d1bec6 | 769 | private: |
6c11b496 | 770 | explicit Logic(const struct sr_datafeed_logic *structure); |
c23c8659 | 771 | ~Logic(); |
4cd883a7 | 772 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
c23c8659 ML |
773 | friend class Packet; |
774 | }; | |
775 | ||
07443fd2 | 776 | /** Payload of a datafeed packet with analog data */ |
dd13d47a UH |
777 | class SR_API Analog : |
778 | public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>, | |
4cd883a7 | 779 | public PacketPayload |
c23c8659 ML |
780 | { |
781 | public: | |
2928f47d | 782 | /** Pointer to data. */ |
dd13d47a | 783 | void *data_pointer(); |
c23c8659 | 784 | /** Number of samples in this packet. */ |
15bebf57 | 785 | unsigned int num_samples() const; |
2928f47d | 786 | /** Channels for which this packet contains data. */ |
3b161085 | 787 | vector<shared_ptr<Channel> > channels(); |
c23c8659 | 788 | /** Measured quantity of the samples in this packet. */ |
15bebf57 | 789 | const Quantity *mq() const; |
c23c8659 | 790 | /** Unit of the samples in this packet. */ |
15bebf57 | 791 | const Unit *unit() const; |
c23c8659 | 792 | /** Measurement flags associated with the samples in this packet. */ |
15bebf57 | 793 | vector<const QuantityFlag *> mq_flags() const; |
21d1bec6 | 794 | private: |
6c11b496 | 795 | explicit Analog(const struct sr_datafeed_analog *structure); |
dd13d47a | 796 | ~Analog(); |
4cd883a7 | 797 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
c23c8659 ML |
798 | friend class Packet; |
799 | }; | |
800 | ||
07443fd2 | 801 | /** An input format supported by the library */ |
c23c8659 | 802 | class SR_API InputFormat : |
541c855e | 803 | public ParentOwned<InputFormat, Context, const struct sr_input_module> |
c23c8659 ML |
804 | { |
805 | public: | |
806 | /** Name of this input format. */ | |
15bebf57 | 807 | string name() const; |
c23c8659 | 808 | /** Description of this input format. */ |
15bebf57 | 809 | string description() const; |
c7bc82ff JH |
810 | /** A list of preferred file name extensions for this file format. |
811 | * @note This list is a recommendation only. */ | |
15bebf57 | 812 | vector<string> extensions() const; |
ca3291e3 | 813 | /** Options supported by this input format. */ |
3b161085 | 814 | map<string, shared_ptr<Option> > options(); |
ca3291e3 ML |
815 | /** Create an input using this input format. |
816 | * @param options Mapping of (option name, value) pairs. */ | |
d370545d | 817 | shared_ptr<Input> create_input(const map<string, Glib::VariantBase> &options = {}); |
21d1bec6 | 818 | private: |
6c11b496 | 819 | explicit InputFormat(const struct sr_input_module *structure); |
c23c8659 ML |
820 | ~InputFormat(); |
821 | friend class Context; | |
ca3291e3 | 822 | friend class InputDevice; |
c23c8659 ML |
823 | }; |
824 | ||
ca3291e3 | 825 | /** An input instance (an input format applied to a file or stream) */ |
90e89c2a | 826 | class SR_API Input : public UserOwned<Input, const struct sr_input> |
c23c8659 ML |
827 | { |
828 | public: | |
ca3291e3 | 829 | /** Virtual device associated with this input. */ |
3b161085 | 830 | shared_ptr<InputDevice> device(); |
ca3291e3 | 831 | /** Send next stream data. |
2b51d48b ML |
832 | * @param data Next stream data. |
833 | * @param length Length of data. */ | |
834 | void send(void *data, size_t length); | |
9c51e8ec ML |
835 | /** Signal end of input data. */ |
836 | void end(); | |
21d1bec6 | 837 | private: |
ca3291e3 ML |
838 | Input(shared_ptr<Context> context, const struct sr_input *structure); |
839 | ~Input(); | |
3b161085 ML |
840 | shared_ptr<Context> _context; |
841 | InputDevice *_device; | |
c23c8659 | 842 | friend class Deleter; |
ca3291e3 | 843 | friend class Context; |
c23c8659 ML |
844 | friend class InputFormat; |
845 | }; | |
846 | ||
ca3291e3 | 847 | /** A virtual device associated with an input */ |
6e5240f4 | 848 | class SR_API InputDevice : |
541c855e | 849 | public ParentOwned<InputDevice, Input, struct sr_dev_inst>, |
6e5240f4 | 850 | public Device |
ca3291e3 | 851 | { |
21d1bec6 | 852 | private: |
ca3291e3 ML |
853 | InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi); |
854 | ~InputDevice(); | |
d01d2314 | 855 | shared_ptr<Device> get_shared_from_this(); |
3b161085 | 856 | shared_ptr<Input> _input; |
ca3291e3 ML |
857 | friend class Input; |
858 | }; | |
859 | ||
58aa1f83 | 860 | /** An option used by an output format */ |
90e89c2a | 861 | class SR_API Option : public UserOwned<Option, const struct sr_option> |
58aa1f83 ML |
862 | { |
863 | public: | |
864 | /** Short name of this option suitable for command line usage. */ | |
15bebf57 | 865 | string id() const; |
58aa1f83 | 866 | /** Short name of this option suitable for GUI usage. */ |
15bebf57 | 867 | string name() const; |
58aa1f83 | 868 | /** Description of this option in a sentence. */ |
15bebf57 | 869 | string description() const; |
58aa1f83 | 870 | /** Default value for this option. */ |
15bebf57 | 871 | Glib::VariantBase default_value() const; |
58aa1f83 | 872 | /** Possible values for this option, if a limited set. */ |
15bebf57 | 873 | vector<Glib::VariantBase> values() const; |
21d1bec6 | 874 | private: |
58aa1f83 | 875 | Option(const struct sr_option *structure, |
70d3b20b | 876 | shared_ptr<const struct sr_option *> structure_array); |
58aa1f83 | 877 | ~Option(); |
3b161085 | 878 | shared_ptr<const struct sr_option *> _structure_array; |
58aa1f83 | 879 | friend class Deleter; |
43942280 | 880 | friend class InputFormat; |
58aa1f83 ML |
881 | friend class OutputFormat; |
882 | }; | |
883 | ||
07443fd2 | 884 | /** An output format supported by the library */ |
c23c8659 | 885 | class SR_API OutputFormat : |
541c855e | 886 | public ParentOwned<OutputFormat, Context, const struct sr_output_module> |
c23c8659 ML |
887 | { |
888 | public: | |
889 | /** Name of this output format. */ | |
15bebf57 | 890 | string name() const; |
c23c8659 | 891 | /** Description of this output format. */ |
15bebf57 | 892 | string description() const; |
8a174d23 JH |
893 | /** A list of preferred file name extensions for this file format. |
894 | * @note This list is a recommendation only. */ | |
15bebf57 | 895 | vector<string> extensions() const; |
58aa1f83 | 896 | /** Options supported by this output format. */ |
3b161085 | 897 | map<string, shared_ptr<Option> > options(); |
b6f411ac ML |
898 | /** Create an output using this format. |
899 | * @param device Device to output for. | |
900 | * @param options Mapping of (option name, value) pairs. */ | |
81b3ce37 SA |
901 | shared_ptr<Output> create_output( |
902 | shared_ptr<Device> device, | |
d370545d | 903 | const map<string, Glib::VariantBase> &options = {}); |
81b3ce37 SA |
904 | /** Create an output using this format. |
905 | * @param filename Name of destination file. | |
906 | * @param device Device to output for. | |
907 | * @param options Mapping of (option name, value) pairs. */ | |
908 | shared_ptr<Output> create_output(string filename, | |
909 | shared_ptr<Device> device, | |
d370545d | 910 | const map<string, Glib::VariantBase> &options = {}); |
3cd4b381 SA |
911 | /** |
912 | * Checks whether a given flag is set. | |
913 | * @param flag Flag to check | |
914 | * @return true if flag is set for this module | |
915 | * @see sr_output_flags | |
916 | */ | |
15bebf57 | 917 | bool test_flag(const OutputFlag *flag) const; |
21d1bec6 | 918 | private: |
6c11b496 | 919 | explicit OutputFormat(const struct sr_output_module *structure); |
c23c8659 ML |
920 | ~OutputFormat(); |
921 | friend class Context; | |
922 | friend class Output; | |
923 | }; | |
924 | ||
07443fd2 | 925 | /** An output instance (an output format applied to a device) */ |
90e89c2a | 926 | class SR_API Output : public UserOwned<Output, const struct sr_output> |
c23c8659 ML |
927 | { |
928 | public: | |
b6f411ac ML |
929 | /** Update output with data from the given packet. |
930 | * @param packet Packet to handle. */ | |
c23c8659 | 931 | string receive(shared_ptr<Packet> packet); |
21d1bec6 | 932 | private: |
c23c8659 ML |
933 | Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device); |
934 | Output(shared_ptr<OutputFormat> format, | |
d370545d | 935 | shared_ptr<Device> device, const map<string, Glib::VariantBase> &options); |
81b3ce37 | 936 | Output(string filename, shared_ptr<OutputFormat> format, |
d370545d | 937 | shared_ptr<Device> device, const map<string, Glib::VariantBase> &options); |
c23c8659 | 938 | ~Output(); |
3b161085 ML |
939 | const shared_ptr<OutputFormat> _format; |
940 | const shared_ptr<Device> _device; | |
941 | const map<string, Glib::VariantBase> _options; | |
c23c8659 ML |
942 | friend class Deleter; |
943 | friend class OutputFormat; | |
944 | }; | |
945 | ||
946 | /** Base class for objects which wrap an enumeration value from libsigrok */ | |
9d229ecb | 947 | template <class Class, typename Enum> class SR_API EnumValue |
c23c8659 ML |
948 | { |
949 | public: | |
9d229ecb ML |
950 | /** The integer constant associated with this value. */ |
951 | int id() const | |
952 | { | |
953 | return static_cast<int>(_id); | |
954 | } | |
c23c8659 | 955 | /** The name associated with this value. */ |
9d229ecb ML |
956 | string name() const |
957 | { | |
958 | return _name; | |
959 | } | |
960 | /** Get value associated with a given integer constant. */ | |
961 | static const Class *get(int id) | |
962 | { | |
15bebf57 DE |
963 | const auto pos = _values.find(static_cast<Enum>(id)); |
964 | if (pos == _values.end()) | |
9d229ecb | 965 | throw Error(SR_ERR_ARG); |
15bebf57 | 966 | return pos->second; |
9d229ecb ML |
967 | } |
968 | /** Get possible values. */ | |
969 | static std::vector<const Class *> values() | |
970 | { | |
971 | std::vector<const Class *> result; | |
972 | for (auto entry : _values) | |
973 | result.push_back(entry.second); | |
974 | return result; | |
975 | } | |
c23c8659 | 976 | protected: |
9d229ecb ML |
977 | EnumValue(Enum id, const char name[]) : _id(id), _name(name) |
978 | { | |
979 | } | |
980 | ~EnumValue() | |
981 | { | |
982 | } | |
21d1bec6 | 983 | private: |
9d229ecb ML |
984 | static const std::map<const Enum, const Class * const> _values; |
985 | const Enum _id; | |
3b161085 | 986 | const string _name; |
c23c8659 ML |
987 | }; |
988 | ||
8b2a1843 | 989 | #include <libsigrokcxx/enums.hpp> |
c23c8659 ML |
990 | |
991 | } | |
992 | ||
1b40fdb8 | 993 | #endif |