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 ssize_t 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.emplace(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.emplace(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.emplace(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.emplace(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.emplace(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.emplace(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
 321         analog->meaning = meaning;
 322
 323         for (const auto &channel : channels)
 324                 meaning->channels = g_slist_append(meaning->channels, channel->_structure);
 325         analog->num_samples = num_samples;
 326         meaning->mq = static_cast<sr_mq>(mq->id());
 327         meaning->unit = static_cast<sr_unit>(unit->id());
 328         meaning->mqflags = static_cast<sr_mqflag>(QuantityFlag::mask_from_flags(move(mqflags)));
 329         analog->data = data_pointer;
 330         auto packet = g_new(struct sr_datafeed_packet, 1);
 331         packet->type = SR_DF_ANALOG;
 332         packet->payload = analog;
 333         return shared_ptr<Packet>{new Packet{nullptr, packet}, default_delete<Packet>{}};
 334 }
 335
 336 shared_ptr<Session> Context::load_session(string filename)
 337 {
 338         return shared_ptr<Session>{
 339                 new Session{shared_from_this(), move(filename)},
 340                 default_delete<Session>{}};
 341 }
 342
 343 shared_ptr<Trigger> Context::create_trigger(string name)
 344 {
 345         return shared_ptr<Trigger>{
 346                 new Trigger{shared_from_this(), move(name)},
 347                 default_delete<Trigger>{}};
 348 }
 349
 350 shared_ptr<Input> Context::open_file(string filename)
 351 {
 352         const struct sr_input *input;
 353
 354         check(sr_input_scan_file(filename.c_str(), &input));
 355         return shared_ptr<Input>{
 356                 new Input{shared_from_this(), input},
 357                 default_delete<Input>{}};
 358 }
 359
 360 shared_ptr<Input> Context::open_stream(string header)
 361 {
 362         const struct sr_input *input;
 363
 364         auto gstr = g_string_new(header.c_str());
 365         auto ret = sr_input_scan_buffer(gstr, &input);
 366         g_string_free(gstr, true);
 367         check(ret);
 368         return shared_ptr<Input>{
 369                 new Input{shared_from_this(), input},
 370                 default_delete<Input>{}};
 371 }
 372
 373 map<string, string> Context::serials(shared_ptr<Driver> driver) const
 374 {
 375         GSList *serial_list = sr_serial_list(driver ? driver->_structure : nullptr);
 376         map<string, string> serials;
 377
 378         for (GSList *serial = serial_list; serial; serial = serial->next) {
 379                 auto *const port = static_cast<sr_serial_port *>(serial->data);
 380                 serials[string(port->name)] = string(port->description);
 381         }
 382
 383         g_slist_free_full(serial_list,
 384                 reinterpret_cast<GDestroyNotify>(&sr_serial_free));
 385         return serials;
 386 }
 387
 388 Driver::Driver(struct sr_dev_driver *structure) :
 389         Configurable(structure, nullptr, nullptr),
 390         _structure(structure),
 391         _initialized(false)
 392 {
 393 }
 394
 395 Driver::~Driver()
 396 {
 397 }
 398
 399 string Driver::name() const
 400 {
 401         return valid_string(_structure->name);
 402 }
 403
 404 string Driver::long_name() const
 405 {
 406         return valid_string(_structure->longname);
 407 }
 408
 409 vector<shared_ptr<HardwareDevice>> Driver::scan(
 410         map<const ConfigKey *, Glib::VariantBase> options)
 411 {
 412         /* Initialise the driver if not yet done. */
 413         if (!_initialized)
 414         {
 415                 check(sr_driver_init(_parent->_structure, _structure));
 416                 _initialized = true;
 417         }
 418
 419         /* Translate scan options to GSList of struct sr_config pointers. */
 420         GSList *option_list = nullptr;
 421         for (const auto &entry : options)
 422         {
 423                 const auto &key = entry.first;
 424                 const auto &value = entry.second;
 425                 auto *const config = g_new(struct sr_config, 1);
 426                 config->key = key->id();
 427                 config->data = const_cast<GVariant*>(value.gobj());
 428                 option_list = g_slist_append(option_list, config);
 429         }
 430
 431         /* Run scan. */
 432         GSList *device_list = sr_driver_scan(_structure, option_list);
 433
 434         /* Free option list. */
 435         g_slist_free_full(option_list, g_free);
 436
 437
 438         /* Create device objects. */
 439         vector<shared_ptr<HardwareDevice>> result;
 440         for (GSList *device = device_list; device; device = device->next)
 441         {
 442                 auto *const sdi = static_cast<struct sr_dev_inst *>(device->data);
 443                 shared_ptr<HardwareDevice> hwdev {
 444                         new HardwareDevice{shared_from_this(), sdi},
 445                         default_delete<HardwareDevice>{}};
 446                 result.push_back(move(hwdev));
 447         }
 448
 449         /* Free GSList returned from scan. */
 450         g_slist_free(device_list);
 451
 452         return result;
 453 }
 454
 455 Configurable::Configurable(
 456                 struct sr_dev_driver *driver,
 457                 struct sr_dev_inst *sdi,
 458                 struct sr_channel_group *cg) :
 459         config_driver(driver),
 460         config_sdi(sdi),
 461         config_channel_group(cg)
 462 {
 463 }
 464
 465 Configurable::~Configurable()
 466 {
 467 }
 468
 469 Glib::VariantBase Configurable::config_get(const ConfigKey *key) const
 470 {
 471         GVariant *data;
 472         check(sr_config_get(
 473                 config_driver, config_sdi, config_channel_group,
 474                 key->id(), &data));
 475         return Glib::VariantBase(data);
 476 }
 477
 478 void Configurable::config_set(const ConfigKey *key, const Glib::VariantBase &value)
 479 {
 480         check(sr_config_set(
 481                 config_sdi, config_channel_group,
 482                 key->id(), const_cast<GVariant*>(value.gobj())));
 483 }
 484
 485 Glib::VariantContainerBase Configurable::config_list(const ConfigKey *key) const
 486 {
 487         GVariant *data;
 488         check(sr_config_list(
 489                 config_driver, config_sdi, config_channel_group,
 490                 key->id(), &data));
 491         return Glib::VariantContainerBase(data);
 492 }
 493
 494 map<const ConfigKey *, set<Capability>> Configurable::config_keys(const ConfigKey *key)
 495 {
 496         GVariant *gvar_opts;
 497         gsize num_opts;
 498         const uint32_t *opts;
 499         map<const ConfigKey *, set<Capability>> result;
 500
 501         check(sr_config_list(
 502                 config_driver, config_sdi, config_channel_group,
 503                 key->id(), &gvar_opts));
 504
 505         opts = static_cast<const uint32_t *>(g_variant_get_fixed_array(
 506                 gvar_opts, &num_opts, sizeof(uint32_t)));
 507
 508         for (gsize i = 0; i < num_opts; i++)
 509         {
 510                 auto key = ConfigKey::get(opts[i] & SR_CONF_MASK);
 511                 set<Capability> capabilities;
 512                 if (opts[i] & SR_CONF_GET)
 513                         capabilities.insert(GET);
 514                 if (opts[i] & SR_CONF_SET)
 515                         capabilities.insert(SET);
 516                 if (opts[i] & SR_CONF_LIST)
 517                         capabilities.insert(LIST);
 518                 result[key] = capabilities;
 519         }
 520
 521         g_variant_unref(gvar_opts);
 522
 523         return result;
 524 }
 525
 526 bool Configurable::config_check(const ConfigKey *key,
 527         const ConfigKey *index_key) const
 528 {
 529         GVariant *gvar_opts;
 530         gsize num_opts;
 531         const uint32_t *opts;
 532
 533         if (sr_config_list(config_driver, config_sdi, config_channel_group,
 534                         index_key->id(), &gvar_opts) != SR_OK)
 535                 return false;
 536
 537         opts = static_cast<const uint32_t *>(g_variant_get_fixed_array(
 538                 gvar_opts, &num_opts, sizeof(uint32_t)));
 539
 540         for (gsize i = 0; i < num_opts; i++)
 541         {
 542                 if ((opts[i] & SR_CONF_MASK) == unsigned(key->id()))
 543                 {
 544                         g_variant_unref(gvar_opts);
 545                         return true;
 546                 }
 547         }
 548
 549         g_variant_unref(gvar_opts);
 550
 551         return false;
 552 }
 553
 554 Device::Device(struct sr_dev_inst *structure) :
 555         Configurable(sr_dev_inst_driver_get(structure), structure, nullptr),
 556         _structure(structure)
 557 {
 558         for (GSList *entry = sr_dev_inst_channels_get(structure); entry; entry = entry->next)
 559         {
 560                 auto *const ch = static_cast<struct sr_channel *>(entry->data);
 561                 unique_ptr<Channel> channel {new Channel{ch}};
 562                 _channels.emplace(ch, move(channel));
 563         }
 564
 565         for (GSList *entry = sr_dev_inst_channel_groups_get(structure); entry; entry = entry->next)
 566         {
 567                 auto *const cg = static_cast<struct sr_channel_group *>(entry->data);
 568                 unique_ptr<ChannelGroup> group {new ChannelGroup{this, cg}};
 569                 _channel_groups.emplace(group->name(), move(group));
 570         }
 571 }
 572
 573 Device::~Device()
 574 {}
 575
 576 string Device::vendor() const
 577 {
 578         return valid_string(sr_dev_inst_vendor_get(_structure));
 579 }
 580
 581 string Device::model() const
 582 {
 583         return valid_string(sr_dev_inst_model_get(_structure));
 584 }
 585
 586 string Device::version() const
 587 {
 588         return valid_string(sr_dev_inst_version_get(_structure));
 589 }
 590
 591 string Device::serial_number() const
 592 {
 593         return valid_string(sr_dev_inst_sernum_get(_structure));
 594 }
 595
 596 string Device::connection_id() const
 597 {
 598         return valid_string(sr_dev_inst_connid_get(_structure));
 599 }
 600
 601 vector<shared_ptr<Channel>> Device::channels()
 602 {
 603         vector<shared_ptr<Channel>> result;
 604         for (auto channel = sr_dev_inst_channels_get(_structure); channel; channel = channel->next) {
 605                 auto *const ch = static_cast<struct sr_channel *>(channel->data);
 606                 result.push_back(_channels[ch]->share_owned_by(get_shared_from_this()));
 607         }
 608         return result;
 609 }
 610
 611 shared_ptr<Channel> Device::get_channel(struct sr_channel *ptr)
 612 {
 613         return _channels[ptr]->share_owned_by(get_shared_from_this());
 614 }
 615
 616 map<string, shared_ptr<ChannelGroup>>
 617 Device::channel_groups()
 618 {
 619         map<string, shared_ptr<ChannelGroup>> result;
 620         for (const auto &entry: _channel_groups)
 621         {
 622                 const auto &name = entry.first;
 623                 const auto &channel_group = entry.second;
 624                 result.emplace(name, channel_group->share_owned_by(get_shared_from_this()));
 625         }
 626         return result;
 627 }
 628
 629 void Device::open()
 630 {
 631         check(sr_dev_open(_structure));
 632 }
 633
 634 void Device::close()
 635 {
 636         check(sr_dev_close(_structure));
 637 }
 638
 639 HardwareDevice::HardwareDevice(shared_ptr<Driver> driver,
 640                 struct sr_dev_inst *structure) :
 641         Device(structure),
 642         _driver(move(driver))
 643 {
 644 }
 645
 646 HardwareDevice::~HardwareDevice()
 647 {
 648 }
 649
 650 shared_ptr<Device> HardwareDevice::get_shared_from_this()
 651 {
 652         return static_pointer_cast<Device>(shared_from_this());
 653 }
 654
 655 shared_ptr<Driver> HardwareDevice::driver()
 656 {
 657         return _driver;
 658 }
 659
 660 UserDevice::UserDevice(string vendor, string model, string version) :
 661         Device(sr_dev_inst_user_new(
 662                 vendor.c_str(), model.c_str(), version.c_str()))
 663 {
 664 }
 665
 666 UserDevice::~UserDevice()
 667 {
 668 }
 669
 670 shared_ptr<Device> UserDevice::get_shared_from_this()
 671 {
 672         return static_pointer_cast<Device>(shared_from_this());
 673 }
 674
 675 shared_ptr<Channel> UserDevice::add_channel(unsigned int index,
 676         const ChannelType *type, string name)
 677 {
 678         check(sr_dev_inst_channel_add(Device::_structure,
 679                 index, type->id(), name.c_str()));
 680         GSList *const last = g_slist_last(sr_dev_inst_channels_get(Device::_structure));
 681         auto *const ch = static_cast<struct sr_channel *>(last->data);
 682         unique_ptr<Channel> channel {new Channel{ch}};
 683         _channels.emplace(ch, move(channel));
 684         return get_channel(ch);
 685 }
 686
 687 Channel::Channel(struct sr_channel *structure) :
 688         _structure(structure),
 689         _type(ChannelType::get(_structure->type))
 690 {
 691 }
 692
 693 Channel::~Channel()
 694 {
 695 }
 696
 697 string Channel::name() const
 698 {
 699         return valid_string(_structure->name);
 700 }
 701
 702 void Channel::set_name(string name)
 703 {
 704         check(sr_dev_channel_name_set(_structure, name.c_str()));
 705 }
 706
 707 const ChannelType *Channel::type() const
 708 {
 709         return ChannelType::get(_structure->type);
 710 }
 711
 712 bool Channel::enabled() const
 713 {
 714         return _structure->enabled;
 715 }
 716
 717 void Channel::set_enabled(bool value)
 718 {
 719         check(sr_dev_channel_enable(_structure, value));
 720 }
 721
 722 unsigned int Channel::index() const
 723 {
 724         return _structure->index;
 725 }
 726
 727 ChannelGroup::ChannelGroup(const Device *device,
 728                 struct sr_channel_group *structure) :
 729         Configurable(sr_dev_inst_driver_get(device->_structure), device->_structure, structure)
 730 {
 731         for (GSList *entry = config_channel_group->channels; entry; entry = entry->next) {
 732                 auto *const ch = static_cast<struct sr_channel *>(entry->data);
 733                 /* Note: This relies on Device::_channels to keep the Channel
 734                  * objects around over the lifetime of the ChannelGroup. */
 735                 _channels.push_back(device->_channels.find(ch)->second.get());
 736         }
 737 }
 738
 739 ChannelGroup::~ChannelGroup()
 740 {
 741 }
 742
 743 string ChannelGroup::name() const
 744 {
 745         return valid_string(config_channel_group->name);
 746 }
 747
 748 vector<shared_ptr<Channel>> ChannelGroup::channels()
 749 {
 750         vector<shared_ptr<Channel>> result;
 751         for (const auto &channel : _channels)
 752                 result.push_back(channel->share_owned_by(_parent));
 753         return result;
 754 }
 755
 756 Trigger::Trigger(shared_ptr<Context> context, string name) :
 757         _structure(sr_trigger_new(name.c_str())),
 758         _context(move(context))
 759 {
 760         for (auto *stage = _structure->stages; stage; stage = stage->next) {
 761                 unique_ptr<TriggerStage> ts {new TriggerStage{
 762                                 static_cast<struct sr_trigger_stage *>(stage->data)}};
 763                 _stages.push_back(move(ts));
 764         }
 765 }
 766
 767 Trigger::~Trigger()
 768 {
 769         sr_trigger_free(_structure);
 770 }
 771
 772 string Trigger::name() const
 773 {
 774         return _structure->name;
 775 }
 776
 777 vector<shared_ptr<TriggerStage>> Trigger::stages()
 778 {
 779         vector<shared_ptr<TriggerStage>> result;
 780         for (const auto &stage : _stages)
 781                 result.push_back(stage->share_owned_by(shared_from_this()));
 782         return result;
 783 }
 784
 785 shared_ptr<TriggerStage> Trigger::add_stage()
 786 {
 787         unique_ptr<TriggerStage> stage {new TriggerStage{sr_trigger_stage_add(_structure)}};
 788         _stages.push_back(move(stage));
 789         return _stages.back()->share_owned_by(shared_from_this());
 790 }
 791
 792 TriggerStage::TriggerStage(struct sr_trigger_stage *structure) :
 793         _structure(structure)
 794 {
 795 }
 796
 797 TriggerStage::~TriggerStage()
 798 {
 799 }
 800
 801 int TriggerStage::number() const
 802 {
 803         return _structure->stage;
 804 }
 805
 806 vector<shared_ptr<TriggerMatch>> TriggerStage::matches()
 807 {
 808         vector<shared_ptr<TriggerMatch>> result;
 809         for (const auto &match : _matches)
 810                 result.push_back(match->share_owned_by(shared_from_this()));
 811         return result;
 812 }
 813
 814 void TriggerStage::add_match(shared_ptr<Channel> channel,
 815         const TriggerMatchType *type, float value)
 816 {
 817         check(sr_trigger_match_add(_structure,
 818                 channel->_structure, type->id(), value));
 819         GSList *const last = g_slist_last(_structure->matches);
 820         unique_ptr<TriggerMatch> match {new TriggerMatch{
 821                         static_cast<struct sr_trigger_match *>(last->data),
 822                         move(channel)}};
 823         _matches.push_back(move(match));
 824 }
 825
 826 void TriggerStage::add_match(shared_ptr<Channel> channel,
 827         const TriggerMatchType *type)
 828 {
 829         add_match(move(channel), type, NAN);
 830 }
 831
 832 TriggerMatch::TriggerMatch(struct sr_trigger_match *structure,
 833                 shared_ptr<Channel> channel) :
 834         _structure(structure),
 835         _channel(move(channel))
 836 {
 837 }
 838
 839 TriggerMatch::~TriggerMatch()
 840 {
 841 }
 842
 843 shared_ptr<Channel> TriggerMatch::channel()
 844 {
 845         return _channel;
 846 }
 847
 848 const TriggerMatchType *TriggerMatch::type() const
 849 {
 850         return TriggerMatchType::get(_structure->match);
 851 }
 852
 853 float TriggerMatch::value() const
 854 {
 855         return _structure->value;
 856 }
 857
 858 DatafeedCallbackData::DatafeedCallbackData(Session *session,
 859                 DatafeedCallbackFunction callback) :
 860         _callback(move(callback)),
 861         _session(session)
 862 {
 863 }
 864
 865 void DatafeedCallbackData::run(const struct sr_dev_inst *sdi,
 866         const struct sr_datafeed_packet *pkt)
 867 {
 868         auto device = _session->get_device(sdi);
 869         shared_ptr<Packet> packet {new Packet{device, pkt}, default_delete<Packet>{}};
 870         _callback(move(device), move(packet));
 871 }
 872
 873 SessionDevice::SessionDevice(struct sr_dev_inst *structure) :
 874         Device(structure)
 875 {
 876 }
 877
 878 SessionDevice::~SessionDevice()
 879 {
 880 }
 881
 882 shared_ptr<Device> SessionDevice::get_shared_from_this()
 883 {
 884         return static_pointer_cast<Device>(shared_from_this());
 885 }
 886
 887 Session::Session(shared_ptr<Context> context) :
 888         _structure(nullptr),
 889         _context(move(context))
 890 {
 891         check(sr_session_new(_context->_structure, &_structure));
 892         _context->_session = this;
 893 }
 894
 895 Session::Session(shared_ptr<Context> context, string filename) :
 896         _structure(nullptr),
 897         _context(move(context)),
 898         _filename(move(filename))
 899 {
 900         check(sr_session_load(_context->_structure, _filename.c_str(), &_structure));
 901         GSList *dev_list;
 902         check(sr_session_dev_list(_structure, &dev_list));
 903         for (GSList *dev = dev_list; dev; dev = dev->next) {
 904                 auto *const sdi = static_cast<struct sr_dev_inst *>(dev->data);
 905                 unique_ptr<SessionDevice> device {new SessionDevice{sdi}};
 906                 _owned_devices.emplace(sdi, move(device));
 907         }
 908         _context->_session = this;
 909 }
 910
 911 Session::~Session()
 912 {
 913         check(sr_session_destroy(_structure));
 914 }
 915
 916 shared_ptr<Device> Session::get_device(const struct sr_dev_inst *sdi)
 917 {
 918         if (_owned_devices.count(sdi))
 919                 return static_pointer_cast<Device>(
 920                         _owned_devices[sdi]->share_owned_by(shared_from_this()));
 921         else if (_other_devices.count(sdi))
 922                 return _other_devices[sdi];
 923         else
 924                 throw Error(SR_ERR_BUG);
 925 }
 926
 927 void Session::add_device(shared_ptr<Device> device)
 928 {
 929         const auto dev_struct = device->_structure;
 930         check(sr_session_dev_add(_structure, dev_struct));
 931         _other_devices[dev_struct] = move(device);
 932 }
 933
 934 vector<shared_ptr<Device>> Session::devices()
 935 {
 936         GSList *dev_list;
 937         check(sr_session_dev_list(_structure, &dev_list));
 938         vector<shared_ptr<Device>> result;
 939         for (GSList *dev = dev_list; dev; dev = dev->next) {
 940                 auto *const sdi = static_cast<struct sr_dev_inst *>(dev->data);
 941                 result.push_back(get_device(sdi));
 942         }
 943         return result;
 944 }
 945
 946 void Session::remove_devices()
 947 {
 948         _other_devices.clear();
 949         check(sr_session_dev_remove_all(_structure));
 950 }
 951
 952 void Session::start()
 953 {
 954         check(sr_session_start(_structure));
 955 }
 956
 957 void Session::run()
 958 {
 959         check(sr_session_run(_structure));
 960 }
 961
 962 void Session::stop()
 963 {
 964         check(sr_session_stop(_structure));
 965 }
 966
 967 bool Session::is_running() const
 968 {
 969         const int ret = sr_session_is_running(_structure);
 970         if (ret < 0)
 971                 throw Error{ret};
 972         return (ret != 0);
 973 }
 974
 975 static void session_stopped_callback(void *data) noexcept
 976 {
 977         auto *const callback = static_cast<SessionStoppedCallback*>(data);
 978         (*callback)();
 979 }
 980
 981 void Session::set_stopped_callback(SessionStoppedCallback callback)
 982 {
 983         _stopped_callback = move(callback);
 984         if (_stopped_callback)
 985                 check(sr_session_stopped_callback_set(_structure,
 986                                 &session_stopped_callback, &_stopped_callback));
 987         else
 988                 check(sr_session_stopped_callback_set(_structure,
 989                                 nullptr, nullptr));
 990 }
 991
 992 static void datafeed_callback(const struct sr_dev_inst *sdi,
 993         const struct sr_datafeed_packet *pkt, void *cb_data) noexcept
 994 {
 995         auto callback = static_cast<DatafeedCallbackData *>(cb_data);
 996         callback->run(sdi, pkt);
 997 }
 998
 999 void Session::add_datafeed_callback(DatafeedCallbackFunction callback)
1000 {
1001         unique_ptr<DatafeedCallbackData> cb_data
1002                 {new DatafeedCallbackData{this, move(callback)}};
1003         check(sr_session_datafeed_callback_add(_structure,
1004                         &datafeed_callback, cb_data.get()));
1005         _datafeed_callbacks.push_back(move(cb_data));
1006 }
1007
1008 void Session::remove_datafeed_callbacks()
1009 {
1010         check(sr_session_datafeed_callback_remove_all(_structure));
1011         _datafeed_callbacks.clear();
1012 }
1013
1014 shared_ptr<Trigger> Session::trigger()
1015 {
1016         return _trigger;
1017 }
1018
1019 void Session::set_trigger(shared_ptr<Trigger> trigger)
1020 {
1021         if (!trigger)
1022                 // Set NULL trigger, i.e. remove any trigger from the session.
1023                 check(sr_session_trigger_set(_structure, nullptr));
1024         else
1025                 check(sr_session_trigger_set(_structure, trigger->_structure));
1026         _trigger = move(trigger);
1027 }
1028
1029 string Session::filename() const
1030 {
1031         return _filename;
1032 }
1033
1034 shared_ptr<Context> Session::context()
1035 {
1036         return _context;
1037 }
1038
1039 Packet::Packet(shared_ptr<Device> device,
1040         const struct sr_datafeed_packet *structure) :
1041         _structure(structure),
1042         _device(move(device))
1043 {
1044         switch (structure->type)
1045         {
1046                 case SR_DF_HEADER:
1047                         _payload.reset(new Header{
1048                                 static_cast<const struct sr_datafeed_header *>(
1049                                         structure->payload)});
1050                         break;
1051                 case SR_DF_META:
1052                         _payload.reset(new Meta{
1053                                 static_cast<const struct sr_datafeed_meta *>(
1054                                         structure->payload)});
1055                         break;
1056                 case SR_DF_LOGIC:
1057                         _payload.reset(new Logic{
1058                                 static_cast<const struct sr_datafeed_logic *>(
1059                                         structure->payload)});
1060                         break;
1061                 case SR_DF_ANALOG:
1062                         _payload.reset(new Analog{
1063                                 static_cast<const struct sr_datafeed_analog *>(
1064                                         structure->payload)});
1065                         break;
1066         }
1067 }
1068
1069 Packet::~Packet()
1070 {
1071 }
1072
1073 const PacketType *Packet::type() const
1074 {
1075         return PacketType::get(_structure->type);
1076 }
1077
1078 shared_ptr<PacketPayload> Packet::payload()
1079 {
1080         if (_payload)
1081                 return _payload->share_owned_by(shared_from_this());
1082         else
1083                 throw Error(SR_ERR_NA);
1084 }
1085
1086 PacketPayload::PacketPayload()
1087 {
1088 }
1089
1090 PacketPayload::~PacketPayload()
1091 {
1092 }
1093
1094 Header::Header(const struct sr_datafeed_header *structure) :
1095         PacketPayload(),
1096         _structure(structure)
1097 {
1098 }
1099
1100 Header::~Header()
1101 {
1102 }
1103
1104 shared_ptr<PacketPayload> Header::share_owned_by(shared_ptr<Packet> _parent)
1105 {
1106         return static_pointer_cast<PacketPayload>(
1107                 ParentOwned::share_owned_by(_parent));
1108 }
1109
1110 int Header::feed_version() const
1111 {
1112         return _structure->feed_version;
1113 }
1114
1115 Glib::TimeVal Header::start_time() const
1116 {
1117         return Glib::TimeVal(
1118                 _structure->starttime.tv_sec,
1119                 _structure->starttime.tv_usec);
1120 }
1121
1122 Meta::Meta(const struct sr_datafeed_meta *structure) :
1123         PacketPayload(),
1124         _structure(structure)
1125 {
1126 }
1127
1128 Meta::~Meta()
1129 {
1130 }
1131
1132 shared_ptr<PacketPayload> Meta::share_owned_by(shared_ptr<Packet> _parent)
1133 {
1134         return static_pointer_cast<PacketPayload>(
1135                 ParentOwned::share_owned_by(_parent));
1136 }
1137
1138 map<const ConfigKey *, Glib::VariantBase> Meta::config() const
1139 {
1140         map<const ConfigKey *, Glib::VariantBase> result;
1141         for (auto l = _structure->config; l; l = l->next) {
1142                 auto *const config = static_cast<struct sr_config *>(l->data);
1143                 result[ConfigKey::get(config->key)] = Glib::VariantBase(config->data);
1144         }
1145         return result;
1146 }
1147
1148 Logic::Logic(const struct sr_datafeed_logic *structure) :
1149         PacketPayload(),
1150         _structure(structure)
1151 {
1152 }
1153
1154 Logic::~Logic()
1155 {
1156 }
1157
1158 shared_ptr<PacketPayload> Logic::share_owned_by(shared_ptr<Packet> _parent)
1159 {
1160         return static_pointer_cast<PacketPayload>(
1161                 ParentOwned::share_owned_by(_parent));
1162 }
1163
1164 void *Logic::data_pointer()
1165 {
1166         return _structure->data;
1167 }
1168
1169 size_t Logic::data_length() const
1170 {
1171         return _structure->length;
1172 }
1173
1174 unsigned int Logic::unit_size() const
1175 {
1176         return _structure->unitsize;
1177 }
1178
1179 Analog::Analog(const struct sr_datafeed_analog *structure) :
1180         PacketPayload(),
1181         _structure(structure)
1182 {
1183 }
1184
1185 Analog::~Analog()
1186 {
1187 }
1188
1189 shared_ptr<PacketPayload> Analog::share_owned_by(shared_ptr<Packet> _parent)
1190 {
1191         return static_pointer_cast<PacketPayload>(
1192                 ParentOwned::share_owned_by(_parent));
1193 }
1194
1195 void *Analog::data_pointer()
1196 {
1197         return _structure->data;
1198 }
1199
1200 unsigned int Analog::num_samples() const
1201 {
1202         return _structure->num_samples;
1203 }
1204
1205 vector<shared_ptr<Channel>> Analog::channels()
1206 {
1207         vector<shared_ptr<Channel>> result;
1208         for (auto l = _structure->meaning->channels; l; l = l->next) {
1209                 auto *const ch = static_cast<struct sr_channel *>(l->data);
1210                 result.push_back(_parent->_device->get_channel(ch));
1211         }
1212         return result;
1213 }
1214
1215 const Quantity *Analog::mq() const
1216 {
1217         return Quantity::get(_structure->meaning->mq);
1218 }
1219
1220 const Unit *Analog::unit() const
1221 {
1222         return Unit::get(_structure->meaning->unit);
1223 }
1224
1225 vector<const QuantityFlag *> Analog::mq_flags() const
1226 {
1227         return QuantityFlag::flags_from_mask(_structure->meaning->mqflags);
1228 }
1229
1230 InputFormat::InputFormat(const struct sr_input_module *structure) :
1231         _structure(structure)
1232 {
1233 }
1234
1235 InputFormat::~InputFormat()
1236 {
1237 }
1238
1239 string InputFormat::name() const
1240 {
1241         return valid_string(sr_input_id_get(_structure));
1242 }
1243
1244 string InputFormat::description() const
1245 {
1246         return valid_string(sr_input_description_get(_structure));
1247 }
1248
1249 vector<string> InputFormat::extensions() const
1250 {
1251         vector<string> exts;
1252         for (const char *const *e = sr_input_extensions_get(_structure);
1253                 e && *e; e++)
1254                 exts.push_back(*e);
1255         return exts;
1256 }
1257
1258 map<string, shared_ptr<Option>> InputFormat::options()
1259 {
1260         map<string, shared_ptr<Option>> result;
1261
1262         if (const struct sr_option **options = sr_input_options_get(_structure))
1263         {
1264                 shared_ptr<const struct sr_option *> option_array
1265                         {options, &sr_input_options_free};
1266                 for (int i = 0; options[i]; i++) {
1267                         shared_ptr<Option> opt {
1268                                 new Option{options[i], option_array},
1269                                 default_delete<Option>{}};
1270                         result.emplace(opt->id(), move(opt));
1271                 }
1272         }
1273         return result;
1274 }
1275
1276 shared_ptr<Input> InputFormat::create_input(
1277         map<string, Glib::VariantBase> options)
1278 {
1279         auto input = sr_input_new(_structure, map_to_hash_variant(options));
1280         if (!input)
1281                 throw Error(SR_ERR_ARG);
1282         return shared_ptr<Input>{new Input{_parent, input}, default_delete<Input>{}};
1283 }
1284
1285 Input::Input(shared_ptr<Context> context, const struct sr_input *structure) :
1286         _structure(structure),
1287         _context(move(context))
1288 {
1289 }
1290
1291 shared_ptr<InputDevice> Input::device()
1292 {
1293         if (!_device)
1294         {
1295                 auto sdi = sr_input_dev_inst_get(_structure);
1296                 if (!sdi)
1297                         throw Error(SR_ERR_NA);
1298                 _device.reset(new InputDevice{shared_from_this(), sdi});
1299         }
1300
1301         return _device->share_owned_by(shared_from_this());
1302 }
1303
1304 void Input::send(void *data, size_t length)
1305 {
1306         auto gstr = g_string_new_len(static_cast<char *>(data), length);
1307         auto ret = sr_input_send(_structure, gstr);
1308         g_string_free(gstr, false);
1309         check(ret);
1310 }
1311
1312 void Input::end()
1313 {
1314         check(sr_input_end(_structure));
1315 }
1316
1317 Input::~Input()
1318 {
1319         sr_input_free(_structure);
1320 }
1321
1322 InputDevice::InputDevice(shared_ptr<Input> input,
1323                 struct sr_dev_inst *structure) :
1324         Device(structure),
1325         _input(move(input))
1326 {
1327 }
1328
1329 InputDevice::~InputDevice()
1330 {
1331 }
1332
1333 shared_ptr<Device> InputDevice::get_shared_from_this()
1334 {
1335         return static_pointer_cast<Device>(shared_from_this());
1336 }
1337
1338 Option::Option(const struct sr_option *structure,
1339                 shared_ptr<const struct sr_option *> structure_array) :
1340         _structure(structure),
1341         _structure_array(move(structure_array))
1342 {
1343 }
1344
1345 Option::~Option()
1346 {
1347 }
1348
1349 string Option::id() const
1350 {
1351         return valid_string(_structure->id);
1352 }
1353
1354 string Option::name() const
1355 {
1356         return valid_string(_structure->name);
1357 }
1358
1359 string Option::description() const
1360 {
1361         return valid_string(_structure->desc);
1362 }
1363
1364 Glib::VariantBase Option::default_value() const
1365 {
1366         return Glib::VariantBase(_structure->def, true);
1367 }
1368
1369 vector<Glib::VariantBase> Option::values() const
1370 {
1371         vector<Glib::VariantBase> result;
1372         for (auto l = _structure->values; l; l = l->next) {
1373                 auto *const var = static_cast<GVariant *>(l->data);
1374                 result.push_back(Glib::VariantBase(var, true));
1375         }
1376         return result;
1377 }
1378
1379 OutputFormat::OutputFormat(const struct sr_output_module *structure) :
1380         _structure(structure)
1381 {
1382 }
1383
1384 OutputFormat::~OutputFormat()
1385 {
1386 }
1387
1388 string OutputFormat::name() const
1389 {
1390         return valid_string(sr_output_id_get(_structure));
1391 }
1392
1393 string OutputFormat::description() const
1394 {
1395         return valid_string(sr_output_description_get(_structure));
1396 }
1397
1398 vector<string> OutputFormat::extensions() const
1399 {
1400         vector<string> exts;
1401         for (const char *const *e = sr_output_extensions_get(_structure);
1402                 e && *e; e++)
1403                 exts.push_back(*e);
1404         return exts;
1405 }
1406
1407 map<string, shared_ptr<Option>> OutputFormat::options()
1408 {
1409         map<string, shared_ptr<Option>> result;
1410
1411         if (const struct sr_option **options = sr_output_options_get(_structure))
1412         {
1413                 shared_ptr<const struct sr_option *> option_array
1414                         {options, &sr_output_options_free};
1415                 for (int i = 0; options[i]; i++) {
1416                         shared_ptr<Option> opt {
1417                                 new Option{options[i], option_array},
1418                                 default_delete<Option>{}};
1419                         result.emplace(opt->id(), move(opt));
1420                 }
1421         }
1422         return result;
1423 }
1424
1425 shared_ptr<Output> OutputFormat::create_output(
1426         shared_ptr<Device> device, map<string, Glib::VariantBase> options)
1427 {
1428         return shared_ptr<Output>{
1429                 new Output{shared_from_this(), move(device), move(options)},
1430                 default_delete<Output>{}};
1431 }
1432
1433 shared_ptr<Output> OutputFormat::create_output(string filename,
1434         shared_ptr<Device> device, map<string, Glib::VariantBase> options)
1435 {
1436         return shared_ptr<Output>{
1437                 new Output{move(filename), shared_from_this(), move(device), move(options)},
1438                 default_delete<Output>{}};
1439 }
1440
1441 bool OutputFormat::test_flag(const OutputFlag *flag) const
1442 {
1443         return sr_output_test_flag(_structure, flag->id());
1444 }
1445
1446 Output::Output(shared_ptr<OutputFormat> format,
1447                 shared_ptr<Device> device, map<string, Glib::VariantBase> options) :
1448         _structure(sr_output_new(format->_structure,
1449                 map_to_hash_variant(options), device->_structure, nullptr)),
1450         _format(move(format)),
1451         _device(move(device)),
1452         _options(move(options))
1453 {
1454 }
1455
1456 Output::Output(string filename, shared_ptr<OutputFormat> format,
1457                 shared_ptr<Device> device, map<string, Glib::VariantBase> options) :
1458         _structure(sr_output_new(format->_structure,
1459                 map_to_hash_variant(options), device->_structure, filename.c_str())),
1460         _format(move(format)),
1461         _device(move(device)),
1462         _options(move(options))
1463 {
1464 }
1465
1466 Output::~Output()
1467 {
1468         check(sr_output_free(_structure));
1469 }
1470
1471 string Output::receive(shared_ptr<Packet> packet)
1472 {
1473         GString *out;
1474         check(sr_output_send(_structure, packet->_structure, &out));
1475         if (out)
1476         {
1477                 auto result = string(out->str, out->str + out->len);
1478                 g_string_free(out, true);
1479                 return result;
1480         }
1481         else
1482         {
1483                 return string();
1484         }
1485 }
1486
1487 #include <enums.cpp>
1488
1489 }