bindings/cxx/classes.cpp

   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
  20 /* Needed for isascii(), as used in the GNU libstdc++ headers */
  21 #ifndef _XOPEN_SOURCE
  22 #define _XOPEN_SOURCE 600
  23 #endif
  24
  25 #include <config.h>
  26 #include <libsigrokcxx/libsigrokcxx.hpp>
  27
  28 #include <sstream>
  29 #include <cmath>
  30
  31 namespace sigrok
  32 {
  33
  34 /** Helper function to translate C errors to C++ exceptions. */
  35 static void check(int result)
  36 {
  37         if (result != SR_OK)
  38                 throw Error(result);
  39 }
  40
  41 /** Helper function to obtain valid strings from possibly null input. */
  42 static inline const char *valid_string(const char *input)
  43 {
  44         return (input) ? input : "";
  45 }
  46
  47 /** Helper function to convert between map<string, VariantBase> and GHashTable */
  48 static GHashTable *map_to_hash_variant(const map<string, Glib::VariantBase> &input)
  49 {
  50         auto *const output = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
  51                         reinterpret_cast<GDestroyNotify>(&g_variant_unref));
  52         for (const auto &entry : input)
  53                 g_hash_table_insert(output,
  54                         g_strdup(entry.first.c_str()),
  55                         entry.second.gobj_copy());
  56         return output;
  57 }
  58
  59 Error::Error(int result) : result(result)
  60 {
  61 }
  62
  63 const char *Error::what() const noexcept
  64 {
  65         return sr_strerror(result);
  66 }
  67
  68 Error::~Error() noexcept
  69 {
  70 }
  71
  72 ResourceReader::~ResourceReader()
  73 {
  74 }
  75
  76 SR_PRIV int ResourceReader::open_callback(struct sr_resource *res,
  77                 const char *name, void *cb_data) noexcept
  78 {
  79         try {
  80                 auto *const reader = static_cast<ResourceReader*>(cb_data);
  81                 reader->open(res, name);
  82         } catch (const Error &err) {
  83                 return err.result;
  84         } catch (...) {
  85                 return SR_ERR;
  86         }
  87         return SR_OK;
  88 }
  89
  90 SR_PRIV int ResourceReader::close_callback(struct sr_resource *res,
  91                 void *cb_data) noexcept
  92 {
  93         try {
  94                 auto *const reader = static_cast<ResourceReader*>(cb_data);
  95                 reader->close(res);
  96         } catch (const Error &err) {
  97                 return err.result;
  98         } catch (...) {
  99                 return SR_ERR;
 100         }
 101         return SR_OK;
 102 }
 103
 104 SR_PRIV gssize ResourceReader::read_callback(const struct sr_resource *res,
 105                 void *buf, size_t count, void *cb_data) noexcept
 106 {
 107         try {
 108                 auto *const reader = static_cast<ResourceReader*>(cb_data);
 109                 return reader->read(res, buf, count);
 110         } catch (const Error &err) {
 111                 return err.result;
 112         } catch (...) {
 113                 return SR_ERR;
 114         }
 115 }
 116
 117 shared_ptr<Context> Context::create()
 118 {
 119         return shared_ptr<Context>{new Context{}, default_delete<Context>{}};
 120 }
 121
 122 Context::Context() :
 123         _structure(nullptr),
 124         _session(nullptr)
 125 {
 126         check(sr_init(&_structure));
 127
 128         if (struct sr_dev_driver **driver_list = sr_driver_list(_structure))
 129                 for (int i = 0; driver_list[i]; i++) {
 130                         unique_ptr<Driver> driver {new Driver{driver_list[i]}};
 131                         _drivers.insert(make_pair(driver->name(), move(driver)));
 132                 }
 133
 134         if (const struct sr_input_module **input_list = sr_input_list())
 135                 for (int i = 0; input_list[i]; i++) {
 136                         unique_ptr<InputFormat> input {new InputFormat{input_list[i]}};
 137                         _input_formats.insert(make_pair(input->name(), move(input)));
 138                 }
 139
 140         if (const struct sr_output_module **output_list = sr_output_list())
 141                 for (int i = 0; output_list[i]; i++) {
 142                         unique_ptr<OutputFormat> output {new OutputFormat{output_list[i]}};
 143                         _output_formats.insert(make_pair(output->name(), move(output)));
 144                 }
 145 }
 146
 147 string Context::package_version()
 148 {
 149         return sr_package_version_string_get();
 150 }
 151
 152 string Context::lib_version()
 153 {
 154         return sr_lib_version_string_get();
 155 }
 156
 157 map<string, shared_ptr<Driver>> Context::drivers()
 158 {
 159         map<string, shared_ptr<Driver>> result;
 160         for (const auto &entry: _drivers)
 161         {
 162                 const auto &name = entry.first;
 163                 const auto &driver = entry.second;
 164                 result.insert({name, driver->share_owned_by(shared_from_this())});
 165         }
 166         return result;
 167 }
 168
 169 map<string, shared_ptr<InputFormat>> Context::input_formats()
 170 {
 171         map<string, shared_ptr<InputFormat>> result;
 172         for (const auto &entry: _input_formats)
 173         {
 174                 const auto &name = entry.first;
 175                 const auto &input_format = entry.second;
 176                 result.insert({name, input_format->share_owned_by(shared_from_this())});
 177         }
 178         return result;
 179 }
 180
 181 map<string, shared_ptr<OutputFormat>> Context::output_formats()
 182 {
 183         map<string, shared_ptr<OutputFormat>> result;
 184         for (const auto &entry: _output_formats)
 185         {
 186                 const auto &name = entry.first;
 187                 const auto &output_format = entry.second;
 188                 result.insert({name, output_format->share_owned_by(shared_from_this())});
 189         }
 190         return result;
 191 }
 192
 193 Context::~Context()
 194 {
 195         check(sr_exit(_structure));
 196 }
 197
 198 const LogLevel *Context::log_level() const
 199 {
 200         return LogLevel::get(sr_log_loglevel_get());
 201 }
 202
 203 void Context::set_log_level(const LogLevel *level)
 204 {
 205         check(sr_log_loglevel_set(level->id()));
 206 }
 207
 208 static int call_log_callback(void *cb_data, int loglevel,
 209                 const char *format, va_list args) noexcept
 210 {
 211         const unique_ptr<char, decltype(&g_free)>
 212                 message {g_strdup_vprintf(format, args), &g_free};
 213
 214         auto *const callback = static_cast<LogCallbackFunction *>(cb_data);
 215
 216         try
 217         {
 218                 (*callback)(LogLevel::get(loglevel), message.get());
 219         }
 220         catch (Error e)
 221         {
 222                 return e.result;
 223         }
 224
 225         return SR_OK;
 226 }
 227
 228 void Context::set_log_callback(LogCallbackFunction callback)
 229 {
 230         _log_callback = move(callback);
 231         check(sr_log_callback_set(call_log_callback, &_log_callback));
 232 }
 233
 234 void Context::set_log_callback_default()
 235 {
 236         check(sr_log_callback_set_default());
 237         _log_callback = nullptr;
 238 }
 239
 240 void Context::set_resource_reader(ResourceReader *reader)
 241 {
 242         if (reader) {
 243                 check(sr_resource_set_hooks(_structure,
 244                                 &ResourceReader::open_callback,
 245                                 &ResourceReader::close_callback,
 246                                 &ResourceReader::read_callback, reader));
 247         } else {
 248                 check(sr_resource_set_hooks(_structure,
 249                                 nullptr, nullptr, nullptr, nullptr));
 250         }
 251 }
 252
 253 shared_ptr<Session> Context::create_session()
 254 {
 255         return shared_ptr<Session>{new Session{shared_from_this()},
 256                 default_delete<Session>{}};
 257 }
 258
 259 shared_ptr<UserDevice> Context::create_user_device(
 260                 string vendor, string model, string version)
 261 {
 262         return shared_ptr<UserDevice>{
 263                 new UserDevice{move(vendor), move(model), move(version)},
 264                 default_delete<UserDevice>{}};
 265 }
 266
 267 shared_ptr<Packet> Context::create_header_packet(Glib::TimeVal start_time)
 268 {
 269         auto header = g_new(struct sr_datafeed_header, 1);
 270         header->feed_version = 1;
 271         header->starttime.tv_sec = start_time.tv_sec;
 272         header->starttime.tv_usec = start_time.tv_usec;
 273         auto packet = g_new(struct sr_datafeed_packet, 1);
 274         packet->type = SR_DF_HEADER;
 275         packet->payload = header;
 276         return shared_ptr<Packet>{new Packet{nullptr, packet},
 277                 default_delete<Packet>{}};
 278 }
 279
 280 shared_ptr<Packet> Context::create_meta_packet(
 281         map<const ConfigKey *, Glib::VariantBase> config)
 282 {
 283         auto meta = g_new0(struct sr_datafeed_meta, 1);
 284         for (const auto &input : config)
 285         {
 286                 const auto &key = input.first;
 287                 const auto &value = input.second;
 288                 auto *const output = g_new(struct sr_config, 1);
 289                 output->key = key->id();
 290                 output->data = value.gobj_copy();
 291                 meta->config = g_slist_append(meta->config, output);
 292         }
 293         auto packet = g_new(struct sr_datafeed_packet, 1);
 294         packet->type = SR_DF_META;
 295         packet->payload = meta;
 296         return shared_ptr<Packet>{new Packet{nullptr, packet},
 297                 default_delete<Packet>{}};
 298 }
 299
 300 shared_ptr<Packet> Context::create_logic_packet(
 301         void *data_pointer, size_t data_length, unsigned int unit_size)
 302 {
 303         auto logic = g_new(struct sr_datafeed_logic, 1);
 304         logic->length = data_length;
 305         logic->unitsize = unit_size;
 306         logic->data = data_pointer;
 307         auto packet = g_new(struct sr_datafeed_packet, 1);
 308         packet->type = SR_DF_LOGIC;
 309         packet->payload = logic;
 310         return shared_ptr<Packet>{new Packet{nullptr, packet}, default_delete<Packet>{}};
 311 }
 312
 313 shared_ptr<Packet> Context::create_analog_packet(
 314         vector<shared_ptr<Channel> > channels,
 315         float *data_pointer, unsigned int num_samples, const Quantity *mq,
 316         const Unit *unit, vector<const QuantityFlag *> mqflags)
 317 {
 318         auto analog = g_new0(struct sr_datafeed_analog, 1);
 319         auto meaning = g_new0(struct sr_analog_meaning, 1);
 320         auto encoding = g_new0(struct sr_analog_encoding, 1);
 321         auto spec = g_new0(struct sr_analog_spec, 1);
 322
 323         analog->meaning = meaning;
 324
 325         for (const auto &channel : channels)
 326                 meaning->channels = g_slist_append(meaning->channels, channel->_structure);
 327         meaning->mq = static_cast<sr_mq>(mq->id());
 328         meaning->unit = static_cast<sr_unit>(unit->id());
 329         meaning->mqflags = static_cast<sr_mqflag>(QuantityFlag::mask_from_flags(move(mqflags)));
 330
 331         analog->encoding = encoding;
 332
 333         encoding->unitsize = sizeof(float);
 334         encoding->is_signed = TRUE;
 335         encoding->is_float = TRUE;
 336 #ifdef WORDS_BIGENDIAN
 337         encoding->is_bigendian = TRUE;
 338 #else
 339         encoding->is_bigendian = FALSE;
 340 #endif
 341         encoding->digits = 0;
 342         encoding->is_digits_decimal = FALSE;
 343         encoding->scale.p = 1;
 344         encoding->scale.q = 1;
 345         encoding->offset.p = 0;
 346         encoding->offset.q = 1;
 347
 348         analog->spec = spec;
 349
 350         spec->spec_digits = 0;
 351
 352         analog->num_samples = num_samples;
 353         analog->data = data_pointer;
 354         auto packet = g_new(struct sr_datafeed_packet, 1);
 355         packet->type = SR_DF_ANALOG;
 356         packet->payload = analog;
 357         return shared_ptr<Packet>{new Packet{nullptr, packet}, default_delete<Packet>{}};
 358 }
 359
 360 shared_ptr<Session> Context::load_session(string filename)
 361 {
 362         return shared_ptr<Session>{
 363                 new Session{shared_from_this(), move(filename)},
 364                 default_delete<Session>{}};
 365 }
 366
 367 shared_ptr<Trigger> Context::create_trigger(string name)
 368 {
 369         return shared_ptr<Trigger>{
 370                 new Trigger{shared_from_this(), move(name)},
 371                 default_delete<Trigger>{}};
 372 }
 373
 374 shared_ptr<Input> Context::open_file(string filename)
 375 {
 376         const struct sr_input *input;
 377
 378         check(sr_input_scan_file(filename.c_str(), &input));
 379         return shared_ptr<Input>{
 380                 new Input{shared_from_this(), input},
 381                 default_delete<Input>{}};
 382 }
 383
 384 shared_ptr<Input> Context::open_stream(string header)
 385 {
 386         const struct sr_input *input;
 387
 388         auto gstr = g_string_new(header.c_str());
 389         auto ret = sr_input_scan_buffer(gstr, &input);
 390         g_string_free(gstr, true);
 391         check(ret);
 392         return shared_ptr<Input>{
 393                 new Input{shared_from_this(), input},
 394                 default_delete<Input>{}};
 395 }
 396
 397 map<string, string> Context::serials(shared_ptr<Driver> driver) const
 398 {
 399         GSList *serial_list = sr_serial_list(driver ? driver->_structure : nullptr);
 400         map<string, string> serials;
 401
 402         for (GSList *serial = serial_list; serial; serial = serial->next) {
 403                 auto *const port = static_cast<sr_serial_port *>(serial->data);
 404                 serials[string(port->name)] = string(port->description);
 405         }
 406
 407         g_slist_free_full(serial_list,
 408                 reinterpret_cast<GDestroyNotify>(&sr_serial_free));
 409         return serials;
 410 }
 411
 412 Driver::Driver(struct sr_dev_driver *structure) :
 413         Configurable(structure, nullptr, nullptr),
 414         _structure(structure),
 415         _initialized(false)
 416 {
 417 }
 418
 419 Driver::~Driver()
 420 {
 421 }
 422
 423 string Driver::name() const
 424 {
 425         return valid_string(_structure->name);
 426 }
 427
 428 string Driver::long_name() const
 429 {
 430         return valid_string(_structure->longname);
 431 }
 432
 433 set<const ConfigKey *> Driver::scan_options() const
 434 {
 435         GArray *opts = sr_driver_scan_options_list(_structure);
 436         set<const ConfigKey *> result;
 437         if (opts) {
 438                 for (guint i = 0; i < opts->len; i++)
 439                         result.insert(ConfigKey::get(g_array_index(opts, uint32_t, i)));
 440                 g_array_free(opts, TRUE);
 441         }
 442         return result;
 443 }
 444
 445 vector<shared_ptr<HardwareDevice>> Driver::scan(
 446         map<const ConfigKey *, Glib::VariantBase> options)
 447 {
 448         /* Initialise the driver if not yet done. */
 449         if (!_initialized)
 450         {
 451                 check(sr_driver_init(_parent->_structure, _structure));
 452                 _initialized = true;
 453         }
 454
 455         /* Translate scan options to GSList of struct sr_config pointers. */
 456         GSList *option_list = nullptr;
 457         for (const auto &entry : options)
 458         {
 459                 const auto &key = entry.first;
 460                 const auto &value = entry.second;
 461                 auto *const config = g_new(struct sr_config, 1);
 462                 config->key = key->id();
 463                 config->data = const_cast<GVariant*>(value.gobj());
 464                 option_list = g_slist_append(option_list, config);
 465         }
 466
 467         /* Run scan. */
 468         GSList *device_list = sr_driver_scan(_structure, option_list);
 469
 470         /* Free option list. */
 471         g_slist_free_full(option_list, g_free);
 472
 473
 474         /* Create device objects. */
 475         vector<shared_ptr<HardwareDevice>> result;
 476         for (GSList *device = device_list; device; device = device->next)
 477         {
 478                 auto *const sdi = static_cast<struct sr_dev_inst *>(device->data);
 479                 shared_ptr<HardwareDevice> hwdev {
 480                         new HardwareDevice{shared_from_this(), sdi},
 481                         default_delete<HardwareDevice>{}};
 482                 result.push_back(move(hwdev));
 483         }
 484
 485         /* Free GSList returned from scan. */
 486         g_slist_free(device_list);
 487
 488         return result;
 489 }
 490
 491 Configurable::Configurable(
 492                 struct sr_dev_driver *driver,
 493                 struct sr_dev_inst *sdi,
 494                 struct sr_channel_group *cg) :
 495         config_driver(driver),
 496         config_sdi(sdi),
 497         config_channel_group(cg)
 498 {
 499 }
 500
 501 Configurable::~Configurable()
 502 {
 503 }
 504
 505 set<const ConfigKey *> Configurable::config_keys() const
 506 {
 507         GArray *opts;
 508         set<const ConfigKey *> result;
 509
 510         opts = sr_dev_options(config_driver, config_sdi, config_channel_group);
 511
 512         for (guint i = 0; i < opts->len; i++)
 513                 result.insert(ConfigKey::get(g_array_index(opts, uint32_t, i)));
 514
 515         g_array_free(opts, TRUE);
 516
 517         return result;
 518 }
 519
 520 Glib::VariantBase Configurable::config_get(const ConfigKey *key) const
 521 {
 522         GVariant *data;
 523         check(sr_config_get(
 524                 config_driver, config_sdi, config_channel_group,
 525                 key->id(), &data));
 526         return Glib::VariantBase(data);
 527 }
 528
 529 void Configurable::config_set(const ConfigKey *key, const Glib::VariantBase &value)
 530 {
 531         check(sr_config_set(
 532                 config_sdi, config_channel_group,
 533                 key->id(), const_cast<GVariant*>(value.gobj())));
 534 }
 535
 536 set<const Capability *> Configurable::config_capabilities(const ConfigKey *key) const
 537 {
 538         int caps = sr_dev_config_capabilities_list(config_sdi,
 539                                 config_channel_group, key->id());
 540
 541         set<const Capability *> result;
 542
 543         for (auto cap: Capability::values())
 544                 if (caps & cap->id())
 545                         result.insert(cap);
 546
 547         return result;
 548 }
 549
 550 bool Configurable::config_check(const ConfigKey *key,
 551         const Capability *capability) const
 552 {
 553         int caps = sr_dev_config_capabilities_list(config_sdi,
 554                                 config_channel_group, key->id());
 555
 556         return (caps & capability->id());
 557 }
 558
 559 Glib::VariantContainerBase Configurable::config_list(const ConfigKey *key) const
 560 {
 561         GVariant *data;
 562         check(sr_config_list(
 563                 config_driver, config_sdi, config_channel_group,
 564                 key->id(), &data));
 565         return Glib::VariantContainerBase(data);
 566 }
 567
 568 Device::Device(struct sr_dev_inst *structure) :
 569         Configurable(sr_dev_inst_driver_get(structure), structure, nullptr),
 570         _structure(structure)
 571 {
 572         for (GSList *entry = sr_dev_inst_channels_get(structure); entry; entry = entry->next)
 573         {
 574                 auto *const ch = static_cast<struct sr_channel *>(entry->data);
 575                 unique_ptr<Channel> channel {new Channel{ch}};
 576                 _channels.insert(make_pair(ch, move(channel)));
 577         }
 578
 579         for (GSList *entry = sr_dev_inst_channel_groups_get(structure); entry; entry = entry->next)
 580         {
 581                 auto *const cg = static_cast<struct sr_channel_group *>(entry->data);
 582                 unique_ptr<ChannelGroup> group {new ChannelGroup{this, cg}};
 583                 _channel_groups.insert(make_pair(group->name(), move(group)));
 584         }
 585 }
 586
 587 Device::~Device()
 588 {}
 589
 590 string Device::vendor() const
 591 {
 592         return valid_string(sr_dev_inst_vendor_get(_structure));
 593 }
 594
 595 string Device::model() const
 596 {
 597         return valid_string(sr_dev_inst_model_get(_structure));
 598 }
 599
 600 string Device::version() const
 601 {
 602         return valid_string(sr_dev_inst_version_get(_structure));
 603 }
 604
 605 string Device::serial_number() const
 606 {
 607         return valid_string(sr_dev_inst_sernum_get(_structure));
 608 }
 609
 610 string Device::connection_id() const
 611 {
 612         return valid_string(sr_dev_inst_connid_get(_structure));
 613 }
 614
 615 vector<shared_ptr<Channel>> Device::channels()
 616 {
 617         vector<shared_ptr<Channel>> result;
 618         for (auto channel = sr_dev_inst_channels_get(_structure); channel; channel = channel->next) {
 619                 auto *const ch = static_cast<struct sr_channel *>(channel->data);
 620                 result.push_back(_channels[ch]->share_owned_by(get_shared_from_this()));
 621         }
 622         return result;
 623 }
 624
 625 shared_ptr<Channel> Device::get_channel(struct sr_channel *ptr)
 626 {
 627         return _channels[ptr]->share_owned_by(get_shared_from_this());
 628 }
 629
 630 map<string, shared_ptr<ChannelGroup>>
 631 Device::channel_groups()
 632 {
 633         map<string, shared_ptr<ChannelGroup>> result;
 634         for (const auto &entry: _channel_groups)
 635         {
 636                 const auto &name = entry.first;
 637                 const auto &channel_group = entry.second;
 638                 result.insert({name, channel_group->share_owned_by(get_shared_from_this())});
 639         }
 640         return result;
 641 }
 642
 643 void Device::open()
 644 {
 645         check(sr_dev_open(_structure));
 646 }
 647
 648 void Device::close()
 649 {
 650         check(sr_dev_close(_structure));
 651 }
 652
 653 HardwareDevice::HardwareDevice(shared_ptr<Driver> driver,
 654                 struct sr_dev_inst *structure) :
 655         Device(structure),
 656         _driver(move(driver))
 657 {
 658 }
 659
 660 HardwareDevice::~HardwareDevice()
 661 {
 662 }
 663
 664 shared_ptr<Device> HardwareDevice::get_shared_from_this()
 665 {
 666         return static_pointer_cast<Device>(shared_from_this());
 667 }
 668
 669 shared_ptr<Driver> HardwareDevice::driver()
 670 {
 671         return _driver;
 672 }
 673
 674 UserDevice::UserDevice(string vendor, string model, string version) :
 675         Device(sr_dev_inst_user_new(
 676                 vendor.c_str(), model.c_str(), version.c_str()))
 677 {
 678 }
 679
 680 UserDevice::~UserDevice()
 681 {
 682 }
 683
 684 shared_ptr<Device> UserDevice::get_shared_from_this()
 685 {
 686         return static_pointer_cast<Device>(shared_from_this());
 687 }
 688
 689 shared_ptr<Channel> UserDevice::add_channel(unsigned int index,
 690         const ChannelType *type, string name)
 691 {
 692         check(sr_dev_inst_channel_add(Device::_structure,
 693                 index, type->id(), name.c_str()));
 694         GSList *const last = g_slist_last(sr_dev_inst_channels_get(Device::_structure));
 695         auto *const ch = static_cast<struct sr_channel *>(last->data);
 696         unique_ptr<Channel> channel {new Channel{ch}};
 697         _channels.insert(make_pair(ch, move(channel)));
 698         return get_channel(ch);
 699 }
 700
 701 Channel::Channel(struct sr_channel *structure) :
 702         _structure(structure),
 703         _type(ChannelType::get(_structure->type))
 704 {
 705 }
 706
 707 Channel::~Channel()
 708 {
 709 }
 710
 711 string Channel::name() const
 712 {
 713         return valid_string(_structure->name);
 714 }
 715
 716 void Channel::set_name(string name)
 717 {
 718         check(sr_dev_channel_name_set(_structure, name.c_str()));
 719 }
 720
 721 const ChannelType *Channel::type() const
 722 {
 723         return ChannelType::get(_structure->type);
 724 }
 725
 726 bool Channel::enabled() const
 727 {
 728         return _structure->enabled;
 729 }
 730
 731 void Channel::set_enabled(bool value)
 732 {
 733         check(sr_dev_channel_enable(_structure, value));
 734 }
 735
 736 unsigned int Channel::index() const
 737 {
 738         return _structure->index;
 739 }
 740
 741 ChannelGroup::ChannelGroup(const Device *device,
 742                 struct sr_channel_group *structure) :
 743         Configurable(sr_dev_inst_driver_get(device->_structure), device->_structure, structure)
 744 {
 745         for (GSList *entry = config_channel_group->channels; entry; entry = entry->next) {
 746                 auto *const ch = static_cast<struct sr_channel *>(entry->data);
 747                 /* Note: This relies on Device::_channels to keep the Channel
 748                  * objects around over the lifetime of the ChannelGroup. */
 749                 _channels.push_back(device->_channels.find(ch)->second.get());
 750         }
 751 }
 752
 753 ChannelGroup::~ChannelGroup()
 754 {
 755 }
 756
 757 string ChannelGroup::name() const
 758 {
 759         return valid_string(config_channel_group->name);
 760 }
 761
 762 vector<shared_ptr<Channel>> ChannelGroup::channels()
 763 {
 764         vector<shared_ptr<Channel>> result;
 765         for (const auto &channel : _channels)
 766                 result.push_back(channel->share_owned_by(_parent));
 767         return result;
 768 }
 769
 770 Trigger::Trigger(shared_ptr<Context> context, string name) :
 771         _structure(sr_trigger_new(name.c_str())),
 772         _context(move(context))
 773 {
 774         for (auto *stage = _structure->stages; stage; stage = stage->next) {
 775                 unique_ptr<TriggerStage> ts {new TriggerStage{
 776                                 static_cast<struct sr_trigger_stage *>(stage->data)}};
 777                 _stages.push_back(move(ts));
 778         }
 779 }
 780
 781 Trigger::~Trigger()
 782 {
 783         sr_trigger_free(_structure);
 784 }
 785
 786 string Trigger::name() const
 787 {
 788         return _structure->name;
 789 }
 790
 791 vector<shared_ptr<TriggerStage>> Trigger::stages()
 792 {
 793         vector<shared_ptr<TriggerStage>> result;
 794         for (const auto &stage : _stages)
 795                 result.push_back(stage->share_owned_by(shared_from_this()));
 796         return result;
 797 }
 798
 799 shared_ptr<TriggerStage> Trigger::add_stage()
 800 {
 801         unique_ptr<TriggerStage> stage {new TriggerStage{sr_trigger_stage_add(_structure)}};
 802         _stages.push_back(move(stage));
 803         return _stages.back()->share_owned_by(shared_from_this());
 804 }
 805
 806 TriggerStage::TriggerStage(struct sr_trigger_stage *structure) :
 807         _structure(structure)
 808 {
 809 }
 810
 811 TriggerStage::~TriggerStage()
 812 {
 813 }
 814
 815 int TriggerStage::number() const
 816 {
 817         return _structure->stage;
 818 }
 819
 820 vector<shared_ptr<TriggerMatch>> TriggerStage::matches()
 821 {
 822         vector<shared_ptr<TriggerMatch>> result;
 823         for (const auto &match : _matches)
 824                 result.push_back(match->share_owned_by(shared_from_this()));
 825         return result;
 826 }
 827
 828 void TriggerStage::add_match(shared_ptr<Channel> channel,
 829         const TriggerMatchType *type, float value)
 830 {
 831         check(sr_trigger_match_add(_structure,
 832                 channel->_structure, type->id(), value));
 833         GSList *const last = g_slist_last(_structure->matches);
 834         unique_ptr<TriggerMatch> match {new TriggerMatch{
 835                         static_cast<struct sr_trigger_match *>(last->data),
 836                         move(channel)}};
 837         _matches.push_back(move(match));
 838 }
 839
 840 void TriggerStage::add_match(shared_ptr<Channel> channel,
 841         const TriggerMatchType *type)
 842 {
 843         add_match(move(channel), type, NAN);
 844 }
 845
 846 TriggerMatch::TriggerMatch(struct sr_trigger_match *structure,
 847                 shared_ptr<Channel> channel) :
 848         _structure(structure),
 849         _channel(move(channel))
 850 {
 851 }
 852
 853 TriggerMatch::~TriggerMatch()
 854 {
 855 }
 856
 857 shared_ptr<Channel> TriggerMatch::channel()
 858 {
 859         return _channel;
 860 }
 861
 862 const TriggerMatchType *TriggerMatch::type() const
 863 {
 864         return TriggerMatchType::get(_structure->match);
 865 }
 866
 867 float TriggerMatch::value() const
 868 {
 869         return _structure->value;
 870 }
 871
 872 DatafeedCallbackData::DatafeedCallbackData(Session *session,
 873                 DatafeedCallbackFunction callback) :
 874         _callback(move(callback)),
 875         _session(session)
 876 {
 877 }
 878
 879 void DatafeedCallbackData::run(const struct sr_dev_inst *sdi,
 880         const struct sr_datafeed_packet *pkt)
 881 {
 882         auto device = _session->get_device(sdi);
 883         shared_ptr<Packet> packet {new Packet{device, pkt}, default_delete<Packet>{}};
 884         _callback(move(device), move(packet));
 885 }
 886
 887 SessionDevice::SessionDevice(struct sr_dev_inst *structure) :
 888         Device(structure)
 889 {
 890 }
 891
 892 SessionDevice::~SessionDevice()
 893 {
 894 }
 895
 896 shared_ptr<Device> SessionDevice::get_shared_from_this()
 897 {
 898         return static_pointer_cast<Device>(shared_from_this());
 899 }
 900
 901 Session::Session(shared_ptr<Context> context) :
 902         _structure(nullptr),
 903         _context(move(context))
 904 {
 905         check(sr_session_new(_context->_structure, &_structure));
 906         _context->_session = this;
 907 }
 908
 909 Session::Session(shared_ptr<Context> context, string filename) :
 910         _structure(nullptr),
 911         _context(move(context)),
 912         _filename(move(filename))
 913 {
 914         check(sr_session_load(_context->_structure, _filename.c_str(), &_structure));
 915         GSList *dev_list;
 916         check(sr_session_dev_list(_structure, &dev_list));
 917         for (GSList *dev = dev_list; dev; dev = dev->next) {
 918                 auto *const sdi = static_cast<struct sr_dev_inst *>(dev->data);
 919                 unique_ptr<SessionDevice> device {new SessionDevice{sdi}};
 920                 _owned_devices.insert(make_pair(sdi, move(device)));
 921         }
 922         _context->_session = this;
 923 }
 924
 925 Session::~Session()
 926 {
 927         check(sr_session_destroy(_structure));
 928 }
 929
 930 shared_ptr<Device> Session::get_device(const struct sr_dev_inst *sdi)
 931 {
 932         if (_owned_devices.count(sdi))
 933                 return static_pointer_cast<Device>(
 934                         _owned_devices[sdi]->share_owned_by(shared_from_this()));
 935         else if (_other_devices.count(sdi))
 936                 return _other_devices[sdi];
 937         else
 938                 throw Error(SR_ERR_BUG);
 939 }
 940
 941 void Session::add_device(shared_ptr<Device> device)
 942 {
 943         const auto dev_struct = device->_structure;
 944         check(sr_session_dev_add(_structure, dev_struct));
 945         _other_devices[dev_struct] = move(device);
 946 }
 947
 948 vector<shared_ptr<Device>> Session::devices()
 949 {
 950         GSList *dev_list;
 951         check(sr_session_dev_list(_structure, &dev_list));
 952         vector<shared_ptr<Device>> result;
 953         for (GSList *dev = dev_list; dev; dev = dev->next) {
 954                 auto *const sdi = static_cast<struct sr_dev_inst *>(dev->data);
 955                 result.push_back(get_device(sdi));
 956         }
 957         return result;
 958 }
 959
 960 void Session::remove_devices()
 961 {
 962         _other_devices.clear();
 963         check(sr_session_dev_remove_all(_structure));
 964 }
 965
 966 void Session::start()
 967 {
 968         check(sr_session_start(_structure));
 969 }
 970
 971 void Session::run()
 972 {
 973         check(sr_session_run(_structure));
 974 }
 975
 976 void Session::stop()
 977 {
 978         check(sr_session_stop(_structure));
 979 }
 980
 981 bool Session::is_running() const
 982 {
 983         const int ret = sr_session_is_running(_structure);
 984         if (ret < 0)
 985                 throw Error{ret};
 986         return (ret != 0);
 987 }
 988
 989 static void session_stopped_callback(void *data) noexcept
 990 {
 991         auto *const callback = static_cast<SessionStoppedCallback*>(data);
 992         (*callback)();
 993 }
 994
 995 void Session::set_stopped_callback(SessionStoppedCallback callback)
 996 {
 997         _stopped_callback = move(callback);
 998         if (_stopped_callback)
 999                 check(sr_session_stopped_callback_set(_structure,
1000                                 &session_stopped_callback, &_stopped_callback));
1001         else
1002                 check(sr_session_stopped_callback_set(_structure,
1003                                 nullptr, nullptr));
1004 }
1005
1006 static void datafeed_callback(const struct sr_dev_inst *sdi,
1007         const struct sr_datafeed_packet *pkt, void *cb_data) noexcept
1008 {
1009         auto callback = static_cast<DatafeedCallbackData *>(cb_data);
1010         callback->run(sdi, pkt);
1011 }
1012
1013 void Session::add_datafeed_callback(DatafeedCallbackFunction callback)
1014 {
1015         unique_ptr<DatafeedCallbackData> cb_data
1016                 {new DatafeedCallbackData{this, move(callback)}};
1017         check(sr_session_datafeed_callback_add(_structure,
1018                         &datafeed_callback, cb_data.get()));
1019         _datafeed_callbacks.push_back(move(cb_data));
1020 }
1021
1022 void Session::remove_datafeed_callbacks()
1023 {
1024         check(sr_session_datafeed_callback_remove_all(_structure));
1025         _datafeed_callbacks.clear();
1026 }
1027
1028 shared_ptr<Trigger> Session::trigger()
1029 {
1030         return _trigger;
1031 }
1032
1033 void Session::set_trigger(shared_ptr<Trigger> trigger)
1034 {
1035         if (!trigger)
1036                 // Set NULL trigger, i.e. remove any trigger from the session.
1037                 check(sr_session_trigger_set(_structure, nullptr));
1038         else
1039                 check(sr_session_trigger_set(_structure, trigger->_structure));
1040         _trigger = move(trigger);
1041 }
1042
1043 string Session::filename() const
1044 {
1045         return _filename;
1046 }
1047
1048 shared_ptr<Context> Session::context()
1049 {
1050         return _context;
1051 }
1052
1053 Packet::Packet(shared_ptr<Device> device,
1054         const struct sr_datafeed_packet *structure) :
1055         _structure(structure),
1056         _device(move(device))
1057 {
1058         switch (structure->type)
1059         {
1060                 case SR_DF_HEADER:
1061                         _payload.reset(new Header{
1062                                 static_cast<const struct sr_datafeed_header *>(
1063                                         structure->payload)});
1064                         break;
1065                 case SR_DF_META:
1066                         _payload.reset(new Meta{
1067                                 static_cast<const struct sr_datafeed_meta *>(
1068                                         structure->payload)});
1069                         break;
1070                 case SR_DF_LOGIC:
1071                         _payload.reset(new Logic{
1072                                 static_cast<const struct sr_datafeed_logic *>(
1073                                         structure->payload)});
1074                         break;
1075                 case SR_DF_ANALOG:
1076                         _payload.reset(new Analog{
1077                                 static_cast<const struct sr_datafeed_analog *>(
1078                                         structure->payload)});
1079                         break;
1080         }
1081 }
1082
1083 Packet::~Packet()
1084 {
1085 }
1086
1087 const PacketType *Packet::type() const
1088 {
1089         return PacketType::get(_structure->type);
1090 }
1091
1092 shared_ptr<PacketPayload> Packet::payload()
1093 {
1094         if (_payload)
1095                 return _payload->share_owned_by(shared_from_this());
1096         else
1097                 throw Error(SR_ERR_NA);
1098 }
1099
1100 PacketPayload::PacketPayload()
1101 {
1102 }
1103
1104 PacketPayload::~PacketPayload()
1105 {
1106 }
1107
1108 Header::Header(const struct sr_datafeed_header *structure) :
1109         PacketPayload(),
1110         _structure(structure)
1111 {
1112 }
1113
1114 Header::~Header()
1115 {
1116 }
1117
1118 shared_ptr<PacketPayload> Header::share_owned_by(shared_ptr<Packet> _parent)
1119 {
1120         return static_pointer_cast<PacketPayload>(
1121                 ParentOwned::share_owned_by(_parent));
1122 }
1123
1124 int Header::feed_version() const
1125 {
1126         return _structure->feed_version;
1127 }
1128
1129 Glib::TimeVal Header::start_time() const
1130 {
1131         return Glib::TimeVal(
1132                 _structure->starttime.tv_sec,
1133                 _structure->starttime.tv_usec);
1134 }
1135
1136 Meta::Meta(const struct sr_datafeed_meta *structure) :
1137         PacketPayload(),
1138         _structure(structure)
1139 {
1140 }
1141
1142 Meta::~Meta()
1143 {
1144 }
1145
1146 shared_ptr<PacketPayload> Meta::share_owned_by(shared_ptr<Packet> _parent)
1147 {
1148         return static_pointer_cast<PacketPayload>(
1149                 ParentOwned::share_owned_by(_parent));
1150 }
1151
1152 map<const ConfigKey *, Glib::VariantBase> Meta::config() const
1153 {
1154         map<const ConfigKey *, Glib::VariantBase> result;
1155         for (auto l = _structure->config; l; l = l->next) {
1156                 auto *const config = static_cast<struct sr_config *>(l->data);
1157                 result[ConfigKey::get(config->key)] = Glib::VariantBase(config->data, true);
1158         }
1159         return result;
1160 }
1161
1162 Logic::Logic(const struct sr_datafeed_logic *structure) :
1163         PacketPayload(),
1164         _structure(structure)
1165 {
1166 }
1167
1168 Logic::~Logic()
1169 {
1170 }
1171
1172 shared_ptr<PacketPayload> Logic::share_owned_by(shared_ptr<Packet> _parent)
1173 {
1174         return static_pointer_cast<PacketPayload>(
1175                 ParentOwned::share_owned_by(_parent));
1176 }
1177
1178 void *Logic::data_pointer()
1179 {
1180         return _structure->data;
1181 }
1182
1183 size_t Logic::data_length() const
1184 {
1185         return _structure->length;
1186 }
1187
1188 unsigned int Logic::unit_size() const
1189 {
1190         return _structure->unitsize;
1191 }
1192
1193 Analog::Analog(const struct sr_datafeed_analog *structure) :
1194         PacketPayload(),
1195         _structure(structure)
1196 {
1197 }
1198
1199 Analog::~Analog()
1200 {
1201 }
1202
1203 shared_ptr<PacketPayload> Analog::share_owned_by(shared_ptr<Packet> _parent)
1204 {
1205         return static_pointer_cast<PacketPayload>(
1206                 ParentOwned::share_owned_by(_parent));
1207 }
1208
1209 void *Analog::data_pointer()
1210 {
1211         return _structure->data;
1212 }
1213
1214 unsigned int Analog::num_samples() const
1215 {
1216         return _structure->num_samples;
1217 }
1218
1219 vector<shared_ptr<Channel>> Analog::channels()
1220 {
1221         vector<shared_ptr<Channel>> result;
1222         for (auto l = _structure->meaning->channels; l; l = l->next) {
1223                 auto *const ch = static_cast<struct sr_channel *>(l->data);
1224                 result.push_back(_parent->_device->get_channel(ch));
1225         }
1226         return result;
1227 }
1228
1229 const Quantity *Analog::mq() const
1230 {
1231         return Quantity::get(_structure->meaning->mq);
1232 }
1233
1234 const Unit *Analog::unit() const
1235 {
1236         return Unit::get(_structure->meaning->unit);
1237 }
1238
1239 vector<const QuantityFlag *> Analog::mq_flags() const
1240 {
1241         return QuantityFlag::flags_from_mask(_structure->meaning->mqflags);
1242 }
1243
1244 InputFormat::InputFormat(const struct sr_input_module *structure) :
1245         _structure(structure)
1246 {
1247 }
1248
1249 InputFormat::~InputFormat()
1250 {
1251 }
1252
1253 string InputFormat::name() const
1254 {
1255         return valid_string(sr_input_id_get(_structure));
1256 }
1257
1258 string InputFormat::description() const
1259 {
1260         return valid_string(sr_input_description_get(_structure));
1261 }
1262
1263 vector<string> InputFormat::extensions() const
1264 {
1265         vector<string> exts;
1266         for (const char *const *e = sr_input_extensions_get(_structure);
1267                 e && *e; e++)
1268                 exts.push_back(*e);
1269         return exts;
1270 }
1271
1272 map<string, shared_ptr<Option>> InputFormat::options()
1273 {
1274         map<string, shared_ptr<Option>> result;
1275
1276         if (const struct sr_option **options = sr_input_options_get(_structure))
1277         {
1278                 shared_ptr<const struct sr_option *> option_array
1279                         {options, &sr_input_options_free};
1280                 for (int i = 0; options[i]; i++) {
1281                         shared_ptr<Option> opt {
1282                                 new Option{options[i], option_array},
1283                                 default_delete<Option>{}};
1284                         result.insert({opt->id(), move(opt)});
1285                 }
1286         }
1287         return result;
1288 }
1289
1290 shared_ptr<Input> InputFormat::create_input(
1291         map<string, Glib::VariantBase> options)
1292 {
1293         auto input = sr_input_new(_structure, map_to_hash_variant(options));
1294         if (!input)
1295                 throw Error(SR_ERR_ARG);
1296         return shared_ptr<Input>{new Input{_parent, input}, default_delete<Input>{}};
1297 }
1298
1299 Input::Input(shared_ptr<Context> context, const struct sr_input *structure) :
1300         _structure(structure),
1301         _context(move(context))
1302 {
1303 }
1304
1305 shared_ptr<InputDevice> Input::device()
1306 {
1307         if (!_device)
1308         {
1309                 auto sdi = sr_input_dev_inst_get(_structure);
1310                 if (!sdi)
1311                         throw Error(SR_ERR_NA);
1312                 _device.reset(new InputDevice{shared_from_this(), sdi});
1313         }
1314
1315         return _device->share_owned_by(shared_from_this());
1316 }
1317
1318 void Input::send(void *data, size_t length)
1319 {
1320         auto gstr = g_string_new_len(static_cast<char *>(data), length);
1321         auto ret = sr_input_send(_structure, gstr);
1322         g_string_free(gstr, false);
1323         check(ret);
1324 }
1325
1326 void Input::end()
1327 {
1328         check(sr_input_end(_structure));
1329 }
1330
1331 Input::~Input()
1332 {
1333         sr_input_free(_structure);
1334 }
1335
1336 InputDevice::InputDevice(shared_ptr<Input> input,
1337                 struct sr_dev_inst *structure) :
1338         Device(structure),
1339         _input(move(input))
1340 {
1341 }
1342
1343 InputDevice::~InputDevice()
1344 {
1345 }
1346
1347 shared_ptr<Device> InputDevice::get_shared_from_this()
1348 {
1349         return static_pointer_cast<Device>(shared_from_this());
1350 }
1351
1352 Option::Option(const struct sr_option *structure,
1353                 shared_ptr<const struct sr_option *> structure_array) :
1354         _structure(structure),
1355         _structure_array(move(structure_array))
1356 {
1357 }
1358
1359 Option::~Option()
1360 {
1361 }
1362
1363 string Option::id() const
1364 {
1365         return valid_string(_structure->id);
1366 }
1367
1368 string Option::name() const
1369 {
1370         return valid_string(_structure->name);
1371 }
1372
1373 string Option::description() const
1374 {
1375         return valid_string(_structure->desc);
1376 }
1377
1378 Glib::VariantBase Option::default_value() const
1379 {
1380         return Glib::VariantBase(_structure->def, true);
1381 }
1382
1383 vector<Glib::VariantBase> Option::values() const
1384 {
1385         vector<Glib::VariantBase> result;
1386         for (auto l = _structure->values; l; l = l->next) {
1387                 auto *const var = static_cast<GVariant *>(l->data);
1388                 result.push_back(Glib::VariantBase(var, true));
1389         }
1390         return result;
1391 }
1392
1393 OutputFormat::OutputFormat(const struct sr_output_module *structure) :
1394         _structure(structure)
1395 {
1396 }
1397
1398 OutputFormat::~OutputFormat()
1399 {
1400 }
1401
1402 string OutputFormat::name() const
1403 {
1404         return valid_string(sr_output_id_get(_structure));
1405 }
1406
1407 string OutputFormat::description() const
1408 {
1409         return valid_string(sr_output_description_get(_structure));
1410 }
1411
1412 vector<string> OutputFormat::extensions() const
1413 {
1414         vector<string> exts;
1415         for (const char *const *e = sr_output_extensions_get(_structure);
1416                 e && *e; e++)
1417                 exts.push_back(*e);
1418         return exts;
1419 }
1420
1421 map<string, shared_ptr<Option>> OutputFormat::options()
1422 {
1423         map<string, shared_ptr<Option>> result;
1424
1425         if (const struct sr_option **options = sr_output_options_get(_structure))
1426         {
1427                 shared_ptr<const struct sr_option *> option_array
1428                         {options, &sr_output_options_free};
1429                 for (int i = 0; options[i]; i++) {
1430                         shared_ptr<Option> opt {
1431                                 new Option{options[i], option_array},
1432                                 default_delete<Option>{}};
1433                         result.insert({opt->id(), move(opt)});
1434                 }
1435         }
1436         return result;
1437 }
1438
1439 shared_ptr<Output> OutputFormat::create_output(
1440         shared_ptr<Device> device, map<string, Glib::VariantBase> options)
1441 {
1442         return shared_ptr<Output>{
1443                 new Output{shared_from_this(), move(device), move(options)},
1444                 default_delete<Output>{}};
1445 }
1446
1447 shared_ptr<Output> OutputFormat::create_output(string filename,
1448         shared_ptr<Device> device, map<string, Glib::VariantBase> options)
1449 {
1450         return shared_ptr<Output>{
1451                 new Output{move(filename), shared_from_this(), move(device), move(options)},
1452                 default_delete<Output>{}};
1453 }
1454
1455 bool OutputFormat::test_flag(const OutputFlag *flag) const
1456 {
1457         return sr_output_test_flag(_structure, flag->id());
1458 }
1459
1460 Output::Output(shared_ptr<OutputFormat> format,
1461                 shared_ptr<Device> device, map<string, Glib::VariantBase> options) :
1462         _structure(sr_output_new(format->_structure,
1463                 map_to_hash_variant(options), device->_structure, nullptr)),
1464         _format(move(format)),
1465         _device(move(device)),
1466         _options(move(options))
1467 {
1468 }
1469
1470 Output::Output(string filename, shared_ptr<OutputFormat> format,
1471                 shared_ptr<Device> device, map<string, Glib::VariantBase> options) :
1472         _structure(sr_output_new(format->_structure,
1473                 map_to_hash_variant(options), device->_structure, filename.c_str())),
1474         _format(move(format)),
1475         _device(move(device)),
1476         _options(move(options))
1477 {
1478 }
1479
1480 Output::~Output()
1481 {
1482         check(sr_output_free(_structure));
1483 }
1484
1485 string Output::receive(shared_ptr<Packet> packet)
1486 {
1487         GString *out;
1488         check(sr_output_send(_structure, packet->_structure, &out));
1489         if (out)
1490         {
1491                 auto result = string(out->str, out->str + out->len);
1492                 g_string_free(out, true);
1493                 return result;
1494         }
1495         else
1496         {
1497                 return string();
1498         }
1499 }
1500
1501 #include <enums.cpp>
1502
1503 }