From: Martin Ling Date: Thu, 17 Jul 2014 17:39:49 +0000 (+0100) Subject: Add C++ bindings. X-Git-Tag: libsigrok-0.4.0~1253 X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=c23c8659b8f8c4ca60bf59f6afd12bde7a0b2383;p=libsigrok.git Add C++ bindings. --- diff --git a/.gitignore b/.gitignore index eced6a65..46e91be4 100644 --- a/.gitignore +++ b/.gitignore @@ -43,6 +43,11 @@ Makefile.in # KDevelop project files *.kdev4 +# Files generated by building C++ bindings +bindings/cxx/libsigrok.xml +bindings/cxx/include/libsigrok/enums.hpp +bindings/cxx/enums.cpp + # Files generated by building Python bindings bindings/python/dist/ bindings/python/build diff --git a/Makefile.am b/Makefile.am index 322be597..efab334d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -379,6 +379,33 @@ tests_check_main_LDADD = $(top_builddir)/libsigrok.la @check_LIBS@ endif +if BINDINGS_CXX + +lib_LTLIBRARIES += bindings/cxx/libsigrokxx.la + +bindings_cxx_libsigrokxx_la_SOURCES = bindings/cxx/classes.cpp + +bindings_cxx_libsigrokxx_la_LIBADD = -lsigrok $(glibmm_LIBS) + +bindings_cxx_libsigrokxx_la_LDFLAGS = $(SR_LIB_LDFLAGS) + +library_include_HEADERS += \ + bindings/cxx/include/libsigrok/libsigrok.hpp \ + bindings/cxx/include/libsigrok/enums.hpp + +pkgconfig_DATA += bindings/cxx/libsigrokxx.pc + +bindings/cxx/classes.lo: bindings/cxx/enums.cpp + +bindings/cxx/enums.cpp: bindings/cxx/enums.py bindings/cxx/libsigrok.xml \ + bindings/cxx/ConfigKey_methods.cpp bindings/cxx/QuantityFlag_methods.cpp + python $< + +bindings/cxx/libsigrok.xml: include/libsigrok/libsigrok.h + gccxml $(CFLAGS) -DGLIB_DISABLE_DEPRECATION_WARNINGS $< -fxml=$@ + +endif + MAINTAINERCLEANFILES = ChangeLog .PHONY: ChangeLog diff --git a/bindings/cxx/ConfigKey_methods.cpp b/bindings/cxx/ConfigKey_methods.cpp new file mode 100644 index 00000000..54fa66c1 --- /dev/null +++ b/bindings/cxx/ConfigKey_methods.cpp @@ -0,0 +1,70 @@ +const DataType *ConfigKey::get_data_type() const +{ + const struct sr_config_info *info = sr_config_info_get(id); + if (!info) + throw Error(SR_ERR_NA); + return DataType::get(info->datatype); +} + +string ConfigKey::get_identifier() const +{ + const struct sr_config_info *info = sr_config_info_get(id); + if (!info) + throw Error(SR_ERR_NA); + return valid_string(info->id); +} + +string ConfigKey::get_description() const +{ + const struct sr_config_info *info = sr_config_info_get(id); + if (!info) + throw Error(SR_ERR_NA); + return valid_string(info->name); +} + +const ConfigKey *ConfigKey::get(string identifier) +{ + const struct sr_config_info *info = sr_config_info_name_get(identifier.c_str()); + if (!info) + throw Error(SR_ERR_ARG); + return get(info->key); +} + +Glib::VariantBase ConfigKey::parse_string(string value) const +{ + GVariant *variant; + uint64_t p, q; + + switch (get_data_type()->get_id()) + { + case SR_T_UINT64: + check(sr_parse_sizestring(value.c_str(), &p)); + variant = g_variant_new_uint64(p); + break; + case SR_T_STRING: + variant = g_variant_new_string(value.c_str()); + break; + case SR_T_BOOL: + variant = g_variant_new_boolean(sr_parse_boolstring(value.c_str())); + break; + case SR_T_FLOAT: + variant = g_variant_new_double(stod(value)); + break; + case SR_T_RATIONAL_PERIOD: + check(sr_parse_period(value.c_str(), &p, &q)); + variant = g_variant_new("(tt)", p, q); + break; + case SR_T_RATIONAL_VOLT: + check(sr_parse_voltage(value.c_str(), &p, &q)); + variant = g_variant_new("(tt)", p, q); + break; + case SR_T_INT32: + variant = g_variant_new_int32(stoi(value)); + break; + default: + throw Error(SR_ERR_BUG); + } + + return Glib::VariantBase(variant, true); +} + diff --git a/bindings/cxx/ConfigKey_methods.hpp b/bindings/cxx/ConfigKey_methods.hpp new file mode 100644 index 00000000..997a52ee --- /dev/null +++ b/bindings/cxx/ConfigKey_methods.hpp @@ -0,0 +1,5 @@ + const DataType *get_data_type() const; + string get_identifier() const; + string get_description() const; + static const ConfigKey *get(string identifier); + Glib::VariantBase parse_string(string value) const; diff --git a/bindings/cxx/QuantityFlag_methods.cpp b/bindings/cxx/QuantityFlag_methods.cpp new file mode 100644 index 00000000..0a537907 --- /dev/null +++ b/bindings/cxx/QuantityFlag_methods.cpp @@ -0,0 +1,13 @@ +vector + QuantityFlag::flags_from_mask(unsigned int mask) +{ + auto result = vector(); + while (mask) + { + unsigned int new_mask = mask & (mask - 1); + result.push_back(QuantityFlag::get( + static_cast(mask ^ new_mask))); + mask = new_mask; + } + return result; +} diff --git a/bindings/cxx/QuantityFlag_methods.hpp b/bindings/cxx/QuantityFlag_methods.hpp new file mode 100644 index 00000000..4bbe48db --- /dev/null +++ b/bindings/cxx/QuantityFlag_methods.hpp @@ -0,0 +1,2 @@ + static vector + flags_from_mask(unsigned int mask); diff --git a/bindings/cxx/classes.cpp b/bindings/cxx/classes.cpp new file mode 100644 index 00000000..af51e907 --- /dev/null +++ b/bindings/cxx/classes.cpp @@ -0,0 +1,1123 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2013-2014 Martin Ling + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include "libsigrok/libsigrok.hpp" + +namespace sigrok +{ + +/** Custom shared_ptr deleter for children owned by their parent object. */ +template void reset_parent(T *child) +{ + child->parent.reset(); +} + +/** Helper function to translate C errors to C++ exceptions. */ +static void check(int result) +{ + if (result != SR_OK) + throw Error(result); +} + +/** Helper function to obtain valid strings from possibly null input. */ +static const char *valid_string(const char *input) +{ + if (input != NULL) + return input; + else + return ""; +} + +/** Helper function to convert between map and GHashTable */ + +static GHashTable *map_to_hash(map input) +{ + auto output = g_hash_table_new_full( + g_str_hash, g_str_equal, g_free, g_free); + for (auto entry : input) + g_hash_table_insert(output, + g_strdup(entry.first.c_str()), + g_strdup(entry.second.c_str())); + return output; +} + +Error::Error(int result) : result(result) +{ +} + +const char *Error::what() const throw() +{ + return sr_strerror(result); +} + +Error::~Error() throw() +{ +} + +shared_ptr Context::create() +{ + return shared_ptr(new Context(), Context::Deleter()); +} + +Context::Context() : + session(NULL) +{ + check(sr_init(&structure)); + struct sr_dev_driver **driver_list = sr_driver_list(); + if (driver_list) + for (int i = 0; driver_list[i]; i++) + drivers[driver_list[i]->name] = + new Driver(driver_list[i]); + struct sr_input_format **input_list = sr_input_list(); + if (input_list) + for (int i = 0; input_list[i]; i++) + input_formats[input_list[i]->id] = + new InputFormat(input_list[i]); + struct sr_output_format **output_list = sr_output_list(); + if (output_list) + for (int i = 0; output_list[i]; i++) + output_formats[output_list[i]->id] = + new OutputFormat(output_list[i]); +} + +string Context::get_package_version() +{ + return sr_package_version_string_get(); +} + +string Context::get_lib_version() +{ + return sr_lib_version_string_get(); +} + +map> Context::get_drivers() +{ + map> result; + for (auto entry: drivers) + { + auto name = entry.first; + auto driver = entry.second; + driver->parent = static_pointer_cast(shared_from_this()); + result[name] = shared_ptr(driver, reset_parent); + } + return result; +} + +map> Context::get_input_formats() +{ + map> result; + for (auto entry: input_formats) + { + auto name = entry.first; + auto input_format = entry.second; + input_format->parent = static_pointer_cast(shared_from_this()); + result[name] = shared_ptr(input_format, + reset_parent); + } + return result; +} + +map> Context::get_output_formats() +{ + map> result; + for (auto entry: output_formats) + { + auto name = entry.first; + auto output_format = entry.second; + output_format->parent = static_pointer_cast(shared_from_this()); + result[name] = shared_ptr(output_format, + reset_parent); + } + return result; +} + +Context::~Context() +{ + for (auto entry : drivers) + delete entry.second; + for (auto entry : input_formats) + delete entry.second; + for (auto entry : output_formats) + delete entry.second; + check(sr_exit(structure)); +} + +const LogLevel *Context::get_log_level() +{ + return LogLevel::get(sr_log_loglevel_get()); +} + +void Context::set_log_level(const LogLevel *level) +{ + check(sr_log_loglevel_set(level->get_id())); +} + +string Context::get_log_domain() +{ + return valid_string(sr_log_logdomain_get()); +} + +void Context::set_log_domain(string value) +{ + check(sr_log_logdomain_set(value.c_str())); +} + +static int call_log_callback(void *cb_data, int loglevel, const char *format, va_list args) +{ + va_list args_copy; + va_copy(args_copy, args); + int length = vsnprintf(NULL, 0, format, args_copy); + va_end(args_copy); + char *buf = (char *) g_malloc(length + 1); + vsprintf(buf, format, args); + string message(buf, length); + g_free(buf); + + LogCallbackFunction callback = *((LogCallbackFunction *) cb_data); + + try + { + callback(LogLevel::get(loglevel), message); + } + catch (Error e) + { + return e.result; + } + + return SR_OK; +} + +void Context::set_log_callback(LogCallbackFunction callback) +{ + log_callback = callback; + check(sr_log_callback_set(call_log_callback, &log_callback)); +} + +void Context::set_log_callback_default() +{ + check(sr_log_callback_set_default()); + log_callback = nullptr; +} + +shared_ptr Context::create_session() +{ + return shared_ptr( + new Session(shared_from_this()), Session::Deleter()); +} + +shared_ptr Context::load_session(string filename) +{ + return shared_ptr( + new Session(shared_from_this(), filename), Session::Deleter()); +} + +shared_ptr Context::create_trigger(string name) +{ + return shared_ptr( + new Trigger(shared_from_this(), name), Trigger::Deleter()); +} + +Driver::Driver(struct sr_dev_driver *structure) : + StructureWrapper(structure), + initialized(false) +{ +} + +Driver::~Driver() +{ + for (auto device : devices) + delete device; +} + +string Driver::get_name() +{ + return valid_string(structure->name); +} + +string Driver::get_long_name() +{ + return valid_string(structure->longname); +} + +vector> Driver::scan( + map options) +{ + /* Initialise the driver if not yet done. */ + if (!initialized) + { + check(sr_driver_init(parent->structure, structure)); + initialized = true; + } + + /* Clear all existing instances. */ + for (auto device : devices) + delete device; + devices.clear(); + + /* Translate scan options to GSList of struct sr_config pointers. */ + GSList *option_list = NULL; + for (auto entry : options) + { + auto key = entry.first; + auto value = entry.second; + auto config = g_new(struct sr_config, 1); + config->key = key->get_id(); + config->data = value.gobj(); + option_list = g_slist_append(option_list, config); + } + + /* Run scan. */ + GSList *device_list = sr_driver_scan(structure, option_list); + + /* Free option list. */ + g_slist_free_full(option_list, g_free); + + /* Create device objects. */ + for (GSList *device = device_list; device; device = device->next) + { + auto sdi = (struct sr_dev_inst *) device->data; + devices.push_back(new HardwareDevice(this, sdi)); + } + + /* Free GSList returned from scan. */ + g_slist_free(device_list); + + /* Create list of shared pointers to device instances for return. */ + vector> result; + for (auto device : devices) + { + device->parent = parent->shared_from_this(); + result.push_back(shared_ptr(device, + reset_parent)); + } + return result; +} + +Configurable::Configurable( + struct sr_dev_driver *driver, + struct sr_dev_inst *sdi, + struct sr_channel_group *cg) : + config_driver(driver), + config_sdi(sdi), + config_channel_group(cg) +{ +} + +Configurable::~Configurable() +{ +} + +Glib::VariantBase Configurable::config_get(const ConfigKey *key) +{ + GVariant *data; + check(sr_config_get( + config_driver, config_sdi, config_channel_group, + key->get_id(), &data)); + return Glib::VariantBase(data); +} + +void Configurable::config_set(const ConfigKey *key, Glib::VariantBase value) +{ + check(sr_config_set( + config_sdi, config_channel_group, + key->get_id(), value.gobj())); +} + +Glib::VariantBase Configurable::config_list(const ConfigKey *key) +{ + GVariant *data; + check(sr_config_list( + config_driver, config_sdi, config_channel_group, + key->get_id(), &data)); + return Glib::VariantBase(data); +} + +Device::Device(struct sr_dev_inst *structure) : + Configurable(structure->driver, structure, NULL), + StructureWrapper(structure) +{ + for (GSList *entry = structure->channels; entry; entry = entry->next) + { + auto channel = (struct sr_channel *) entry->data; + channels.push_back(new Channel(channel)); + } +} + +Device::~Device() +{ + for (auto channel : channels) + delete channel; +} + +string Device::get_vendor() +{ + return valid_string(structure->vendor); +} + +string Device::get_model() +{ + return valid_string(structure->model); +} + +string Device::get_version() +{ + return valid_string(structure->version); +} + +vector> Device::get_channels() +{ + vector> result; + for (auto channel : channels) + { + channel->parent = static_pointer_cast(shared_from_this()); + result.push_back(shared_ptr(channel, reset_parent)); + } + return result; +} + +void Device::open() +{ + check(sr_dev_open(structure)); +} + +void Device::close() +{ + check(sr_dev_close(structure)); +} + +HardwareDevice::HardwareDevice(Driver *driver, struct sr_dev_inst *structure) : + Device(structure), + driver(driver) +{ + for (GSList *entry = structure->channel_groups; entry; entry = entry->next) + { + auto group = (struct sr_channel_group *) entry->data; + channel_groups[group->name] = new ChannelGroup(this, group); + } +} + +HardwareDevice::~HardwareDevice() +{ + for (auto entry : channel_groups) + delete entry.second; +} + +shared_ptr HardwareDevice::get_driver() +{ + return static_pointer_cast(driver->shared_from_this()); +} + +map> +HardwareDevice::get_channel_groups() +{ + map> result; + for (auto entry: channel_groups) + { + auto name = entry.first; + auto channel_group = entry.second; + channel_group->parent = + static_pointer_cast(shared_from_this()); + result[name] = shared_ptr(channel_group, + reset_parent); + } + return result; +} + +Channel::Channel(struct sr_channel *structure) : + StructureWrapper(structure), + type(ChannelType::get(structure->type)) +{ +} + +Channel::~Channel() +{ +} + +string Channel::get_name() +{ + return valid_string(structure->name); +} + +void Channel::set_name(string name) +{ + check(sr_dev_channel_name_set(parent->structure, structure->index, name.c_str())); +} + +const ChannelType *Channel::get_type() +{ + return ChannelType::get(structure->type); +} + +bool Channel::get_enabled() +{ + return structure->enabled; +} + +void Channel::set_enabled(bool value) +{ + check(sr_dev_channel_enable(parent->structure, structure->index, value)); +} + +ChannelGroup::ChannelGroup(HardwareDevice *device, + struct sr_channel_group *structure) : + StructureWrapper(structure), + Configurable(device->structure->driver, device->structure, structure) +{ + for (GSList *entry = structure->channels; entry; entry = entry->next) + { + auto channel = (struct sr_channel *) entry->data; + for (auto device_channel : device->channels) + if (channel == device_channel->structure) + channels.push_back(device_channel); + } +} + +ChannelGroup::~ChannelGroup() +{ +} + +string ChannelGroup::get_name() +{ + return valid_string(structure->name); +} + +vector> ChannelGroup::get_channels() +{ + vector> result; + for (auto channel : channels) + { + channel->parent = static_pointer_cast(parent->shared_from_this()); + result.push_back(shared_ptr(channel, reset_parent)); + } + return result; +} + +Trigger::Trigger(shared_ptr context, string name) : + structure(sr_trigger_new(name.c_str())), context(context) +{ + for (auto stage = structure->stages; stage; stage = stage->next) + stages.push_back(new TriggerStage((struct sr_trigger_stage *) stage->data)); +} + +Trigger::~Trigger() +{ + for (auto stage: stages) + delete stage; + + sr_trigger_free(structure); +} + +string Trigger::get_name() +{ + return structure->name; +} + +vector> Trigger::get_stages() +{ + vector> result; + for (auto stage : stages) + { + stage->parent = static_pointer_cast(shared_from_this()); + result.push_back(shared_ptr(stage, reset_parent)); + } + return result; +} + +shared_ptr Trigger::add_stage() +{ + auto stage = new TriggerStage(sr_trigger_stage_add(structure)); + stages.push_back(stage); + stage->parent = static_pointer_cast(shared_from_this()); + return shared_ptr(stage, reset_parent); +} + +TriggerStage::TriggerStage(struct sr_trigger_stage *structure) : + StructureWrapper(structure) +{ +} + +TriggerStage::~TriggerStage() +{ + for (auto match : matches) + delete match; +} + +int TriggerStage::get_number() +{ + return structure->stage; +} + +vector> TriggerStage::get_matches() +{ + vector> result; + for (auto match : matches) + { + match->parent = static_pointer_cast(shared_from_this()); + result.push_back(shared_ptr(match, reset_parent)); + } + return result; +} + +void TriggerStage::add_match(shared_ptr channel, const TriggerMatchType *type, float value) +{ + check(sr_trigger_match_add(structure, channel->structure, type->get_id(), value)); + matches.push_back(new TriggerMatch( + (struct sr_trigger_match *) g_slist_last(structure->matches)->data, channel)); +} + +void TriggerStage::add_match(shared_ptr channel, const TriggerMatchType *type) +{ + add_match(channel, type, NAN); +} + +TriggerMatch::TriggerMatch(struct sr_trigger_match *structure, shared_ptr channel) : + StructureWrapper(structure), channel(channel) +{ +} + +TriggerMatch::~TriggerMatch() +{ +} + +shared_ptr TriggerMatch::get_channel() +{ + return channel; +} + +const TriggerMatchType *TriggerMatch::get_type() +{ + return TriggerMatchType::get(structure->match); +} + +float TriggerMatch::get_value() +{ + return structure->value; +} + +DatafeedCallbackData::DatafeedCallbackData(Session *session, + DatafeedCallbackFunction callback) : + callback(callback), session(session) +{ +} + +void DatafeedCallbackData::run(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *pkt) +{ + auto device = session->devices[sdi]; + auto packet = shared_ptr(new Packet(pkt), Packet::Deleter()); + callback(device, packet); +} + +SourceCallbackData::SourceCallbackData(shared_ptr source) : + source(source) +{ +} + +bool SourceCallbackData::run(int revents) +{ + return source->callback((Glib::IOCondition) revents); +} + +shared_ptr EventSource::create(int fd, Glib::IOCondition events, + int timeout, SourceCallbackFunction callback) +{ + auto result = new EventSource(timeout, callback); + result->type = EventSource::SOURCE_FD; + result->fd = fd; + result->events = events; + return shared_ptr(result, EventSource::Deleter()); +} + +shared_ptr EventSource::create(Glib::PollFD pollfd, int timeout, + SourceCallbackFunction callback) +{ + auto result = new EventSource(timeout, callback); + result->type = EventSource::SOURCE_POLLFD; + result->pollfd = pollfd; + return shared_ptr(result, EventSource::Deleter()); +} + +shared_ptr EventSource::create(Glib::RefPtr channel, + Glib::IOCondition events, int timeout, SourceCallbackFunction callback) +{ + auto result = new EventSource(timeout, callback); + result->type = EventSource::SOURCE_IOCHANNEL; + result->channel = channel; + result->events = events; + return shared_ptr(result, EventSource::Deleter()); +} + +EventSource::EventSource(int timeout, SourceCallbackFunction callback) : + timeout(timeout), callback(callback) +{ +} + +EventSource::~EventSource() +{ +} + +Session::Session(shared_ptr context) : + context(context), saving(false) +{ + check(sr_session_new(&structure)); + context->session = this; +} + +Session::Session(shared_ptr context, string filename) : + context(context), saving(false) +{ + check(sr_session_load(filename.c_str(), &structure)); + context->session = this; +} + +Session::~Session() +{ + check(sr_session_destroy(structure)); + + for (auto callback : datafeed_callbacks) + delete callback; + + for (auto entry : source_callbacks) + delete entry.second; +} + +void Session::add_device(shared_ptr device) +{ + check(sr_session_dev_add(structure, device->structure)); + devices[device->structure] = device; +} + +vector> Session::get_devices() +{ + GSList *dev_list; + check(sr_session_dev_list(structure, &dev_list)); + vector> result; + for (GSList *dev = dev_list; dev; dev = dev->next) + { + auto sdi = (struct sr_dev_inst *) dev->data; + if (devices.count(sdi) == 0) + devices[sdi] = shared_ptr( + new Device(sdi), Device::Deleter()); + result.push_back(devices[sdi]); + } + return result; +} + +void Session::remove_devices() +{ + devices.clear(); + check(sr_session_dev_remove_all(structure)); +} + +void Session::start() +{ + check(sr_session_start(structure)); +} + +void Session::run() +{ + check(sr_session_run(structure)); +} + +void Session::stop() +{ + check(sr_session_stop(structure)); +} + +void Session::begin_save(string filename) +{ + saving = true; + save_initialized = false; + save_filename = filename; + save_samplerate = 0; +} + +void Session::append(shared_ptr device, shared_ptr packet) +{ + if (!saving) + throw Error(SR_ERR); + + switch (packet->structure->type) + { + case SR_DF_META: + { + auto meta = (const struct sr_datafeed_meta *) + packet->structure->payload; + + for (auto l = meta->config; l; l = l->next) + { + auto config = (struct sr_config *) l->data; + if (config->key == SR_CONF_SAMPLERATE) + save_samplerate = g_variant_get_uint64(config->data); + } + + break; + } + case SR_DF_LOGIC: + { + if (save_samplerate == 0) + { + GVariant *samplerate; + + check(sr_config_get(device->structure->driver, + device->structure, NULL, SR_CONF_SAMPLERATE, &samplerate)); + + save_samplerate = g_variant_get_uint64(samplerate); + + g_variant_unref(samplerate); + } + + if (!save_initialized) + { + vector> save_channels; + + for (auto channel : device->get_channels()) + if (channel->structure->enabled && + channel->structure->type == SR_CHANNEL_LOGIC) + save_channels.push_back(channel); + + auto channels = g_new(char *, save_channels.size()); + + int i = 0; + for (auto channel : save_channels) + channels[i++] = channel->structure->name; + channels[i] = NULL; + + int ret = sr_session_save_init(structure, save_filename.c_str(), + save_samplerate, channels); + + g_free(channels); + + if (ret != SR_OK) + throw Error(ret); + + save_initialized = true; + } + + auto logic = (const struct sr_datafeed_logic *) + packet->structure->payload; + + check(sr_session_append(structure, save_filename.c_str(), + (uint8_t *) logic->data, logic->unitsize, + logic->length / logic->unitsize)); + } + } +} + +static void datafeed_callback(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *pkt, void *cb_data) +{ + auto callback = static_cast(cb_data); + callback->run(sdi, pkt); +} + +void Session::add_datafeed_callback(DatafeedCallbackFunction callback) +{ + auto cb_data = new DatafeedCallbackData(this, callback); + check(sr_session_datafeed_callback_add(structure, datafeed_callback, cb_data)); + datafeed_callbacks.push_back(cb_data); +} + +void Session::remove_datafeed_callbacks(void) +{ + check(sr_session_datafeed_callback_remove_all(structure)); + for (auto callback : datafeed_callbacks) + delete callback; + datafeed_callbacks.clear(); +} + +static int source_callback(int fd, int revents, void *cb_data) +{ + (void) fd; + auto callback = (SourceCallbackData *) cb_data; + return callback->run(revents); +} + +void Session::add_source(shared_ptr source) +{ + if (source_callbacks.count(source) == 1) + throw Error(SR_ERR_ARG); + + auto cb_data = new SourceCallbackData(source); + + switch (source->type) + { + case EventSource::SOURCE_FD: + check(sr_session_source_add(structure, source->fd, source->events, + source->timeout, source_callback, cb_data)); + break; + case EventSource::SOURCE_POLLFD: + check(sr_session_source_add_pollfd(structure, + source->pollfd.gobj(), source->timeout, source_callback, + cb_data)); + break; + case EventSource::SOURCE_IOCHANNEL: + check(sr_session_source_add_channel(structure, + source->channel->gobj(), source->events, source->timeout, + source_callback, cb_data)); + break; + } + + source_callbacks[source] = cb_data; +} + +void Session::remove_source(shared_ptr source) +{ + if (source_callbacks.count(source) == 0) + throw Error(SR_ERR_ARG); + + switch (source->type) + { + case EventSource::SOURCE_FD: + check(sr_session_source_remove(structure, source->fd)); + break; + case EventSource::SOURCE_POLLFD: + check(sr_session_source_remove_pollfd(structure, + source->pollfd.gobj())); + break; + case EventSource::SOURCE_IOCHANNEL: + check(sr_session_source_remove_channel(structure, + source->channel->gobj())); + break; + } + + delete source_callbacks[source]; + + source_callbacks.erase(source); +} + +Packet::Packet(const struct sr_datafeed_packet *structure) : + structure(structure) +{ + switch (structure->type) + { + case SR_DF_LOGIC: + payload = new Logic( + static_cast( + structure->payload)); + break; + case SR_DF_ANALOG: + payload = new Analog( + static_cast( + structure->payload)); + break; + default: + payload = NULL; + break; + } +} + +Packet::~Packet() +{ + delete payload; +} + +PacketPayload *Packet::get_payload() +{ + return payload; +} + +PacketPayload::PacketPayload() +{ +} + +PacketPayload::~PacketPayload() +{ +} + +Logic::Logic(const struct sr_datafeed_logic *structure) : PacketPayload(), + structure(structure), + data(static_cast(structure->data), + static_cast(structure->data) + structure->length) {} + +Logic::~Logic() +{ +} + +void *Logic::get_data() +{ + return structure->data; +} + +size_t Logic::get_data_size() +{ + return structure->length; +} + +Analog::Analog(const struct sr_datafeed_analog *structure) : + PacketPayload(), + structure(structure) +{ +} + +Analog::~Analog() +{ +} + +void *Analog::get_data() +{ + return structure->data; +} + +size_t Analog::get_data_size() +{ + return structure->num_samples * sizeof(float); +} + +unsigned int Analog::get_num_samples() +{ + return structure->num_samples; +} + +const Quantity *Analog::get_mq() +{ + return Quantity::get(structure->mq); +} + +const Unit *Analog::get_unit() +{ + return Unit::get(structure->unit); +} + +vector Analog::get_mq_flags() +{ + return QuantityFlag::flags_from_mask(structure->mqflags); +} + +InputFormat::InputFormat(struct sr_input_format *structure) : + StructureWrapper(structure) +{ +} + +InputFormat::~InputFormat() +{ +} + +string InputFormat::get_name() +{ + return valid_string(structure->id); +} + +string InputFormat::get_description() +{ + return valid_string(structure->description); +} + +bool InputFormat::format_match(string filename) +{ + return structure->format_match(filename.c_str()); +} + +shared_ptr InputFormat::open_file(string filename, + map options) +{ + auto input = g_new(struct sr_input, 1); + input->param = map_to_hash(options); + + /** Run initialisation. */ + check(structure->init(input, filename.c_str())); + + /** Create virtual device. */ + return shared_ptr(new InputFileDevice( + static_pointer_cast(shared_from_this()), input, filename), + InputFileDevice::Deleter()); +} + +InputFileDevice::InputFileDevice(shared_ptr format, + struct sr_input *input, string filename) : + Device(input->sdi), + input(input), + format(format), + filename(filename) +{ +} + +InputFileDevice::~InputFileDevice() +{ + g_hash_table_unref(input->param); + g_free(input); +} + +void InputFileDevice::load() +{ + check(format->structure->loadfile(input, filename.c_str())); +} + +OutputFormat::OutputFormat(struct sr_output_format *structure) : + StructureWrapper(structure) +{ +} + +OutputFormat::~OutputFormat() +{ +} + +string OutputFormat::get_name() +{ + return valid_string(structure->id); +} + +string OutputFormat::get_description() +{ + return valid_string(structure->description); +} + +shared_ptr OutputFormat::create_output( + shared_ptr device, map options) +{ + return shared_ptr( + new Output( + static_pointer_cast(shared_from_this()), + device, options), + Output::Deleter()); +} + +Output::Output(shared_ptr format, + shared_ptr device, map options) : + structure(sr_output_new(format->structure, + map_to_hash(options), device->structure)), + format(format), device(device), options(options) +{ +} + +Output::~Output() +{ + g_hash_table_unref(structure->params); + check(sr_output_free(structure)); +} + +string Output::receive(shared_ptr packet) +{ + GString *out; + check(sr_output_send(structure, packet->structure, &out)); + if (out) + { + auto result = string(out->str, out->str + out->len); + g_string_free(out, true); + return result; + } + else + { + return string(); + } +} + +#include "enums.cpp" + +} diff --git a/bindings/cxx/enums.py b/bindings/cxx/enums.py new file mode 100644 index 00000000..f5f6e58d --- /dev/null +++ b/bindings/cxx/enums.py @@ -0,0 +1,142 @@ +## +## This file is part of the libsigrok project. +## +## Copyright (C) 2014 Martin Ling +## +## This program is free software: you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation, either version 3 of the License, or +## (at your option) any later version. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program. If not, see . +## + +from pygccxml import parser, declarations +from collections import OrderedDict +import sys, os, re + +# Get directory this script is in. +dirname = os.path.dirname(os.path.realpath(__file__)) + +# Parse GCCXML output to get declaration tree. +decls = parser.parse_xml_file( + os.path.join(dirname, "libsigrok.xml"), parser.config_t()) + +# Get global namespace from declaration tree. +ns = declarations.get_global_namespace(decls) + +mapping = dict([ + ('sr_loglevel', 'LogLevel'), + ('sr_packettype', 'PacketType'), + ('sr_mq', 'Quantity'), + ('sr_unit', 'Unit'), + ('sr_mqflag', 'QuantityFlag'), + ('sr_configkey', 'ConfigKey'), + ('sr_datatype', 'DataType'), + ('sr_channeltype', 'ChannelType'), + ('sr_trigger_matches', 'TriggerMatchType')]) + +classes = OrderedDict() + +# Build mapping between class names and enumerations. +for enum in ns.enumerations(): + if enum.name in mapping: + classname = mapping[enum.name] + classes[classname] = enum + +header = open(os.path.join(dirname, 'include/libsigrok/enums.hpp'), 'w') +code = open(os.path.join(dirname, 'enums.cpp'), 'w') + +for file in (header, code): + print >> file, "/* Generated file - edit enums.py instead! */" + +# Template for beginning of class declaration and public members. +header_public_template = """ +class SR_API {classname} : public EnumValue +{{ +public: + static const {classname} *get(int id); +""" + +# Template for beginning of private members. +header_private_template = """ +private: + static const std::map values; + {classname}(enum {enumname} id, const char name[]); +""" + +# Template for class method definitions. +code_template = """ +{classname}::{classname}(enum {enumname} id, const char name[]) : + EnumValue(id, name) +{{ +}} + +const {classname} *{classname}::get(int id) +{{ + return {classname}::values.at(static_cast<{enumname}>(id)); +}} +""" + +for classname, enum in classes.items(): + + # Begin class and public declarations + print >> header, header_public_template.format( + classname=classname, enumname=enum.name) + + # Declare public pointers for each enum value + for name, value in enum.values: + trimmed_name = re.sub("^SR_[A-Z]+_", "", name) + print >> header, '\tstatic const %s * const %s;' % (classname, trimmed_name) + + # Declare additional methods if present + filename = os.path.join(dirname, "%s_methods.hpp" % classname) + if os.path.exists(filename): + print >> header, str.join('', open(filename).readlines()) + + # Begin private declarations + print >> header, header_private_template.format( + classname=classname, enumname=enum.name) + + # Declare private constants for each enum value + for name, value in enum.values: + trimmed_name = re.sub("^SR_[A-Z]+_", "", name) + print >> header, '\tstatic const %s _%s;' % (classname, trimmed_name) + + # End class declaration + print >> header, '};' + + # Begin class code + print >> code, code_template.format( + classname=classname, enumname=enum.name) + + # Define private constants for each enum value + for name, value in enum.values: + trimmed_name = re.sub("^SR_[A-Z]+_", "", name) + print >> code, 'const %s %s::_%s = %s(%s, "%s");' % ( + classname, classname, trimmed_name, classname, name, trimmed_name) + + # Define public pointers for each enum value + for name, value in enum.values: + trimmed_name = re.sub("^SR_[A-Z]+_", "", name) + print >> code, 'const %s * const %s::%s = &%s::_%s;' % ( + classname, classname, trimmed_name, classname, trimmed_name) + + # Define map of enum values to constants + print >> code, 'const std::map %s::values = {' % ( + enum.name, classname, classname) + for name, value in enum.values: + trimmed_name = re.sub("^SR_[A-Z]+_", "", name) + print >> code, '\t{%s, %s::%s},' % (name, classname, trimmed_name) + print >> code, '};' + + # Define additional methods if present + filename = os.path.join(dirname, "%s_methods.cpp" % classname) + if os.path.exists(filename): + print >> code, str.join('', open(filename).readlines()) diff --git a/bindings/cxx/include/libsigrok/libsigrok.hpp b/bindings/cxx/include/libsigrok/libsigrok.hpp new file mode 100644 index 00000000..d29a7a65 --- /dev/null +++ b/bindings/cxx/include/libsigrok/libsigrok.hpp @@ -0,0 +1,645 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2013-2014 Martin Ling + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#ifndef LIBSIGROK_HPP +#define LIBSIGROK_HPP + +#include "libsigrok/libsigrok.h" +#include + +#include +#include +#include +#include + +namespace sigrok +{ + +using namespace std; + +/* Forward declarations */ +class SR_API Error; +class SR_API Context; +class SR_API Driver; +class SR_API Device; +class SR_API HardwareDevice; +class SR_API Channel; +class SR_API EventSource; +class SR_API Session; +class SR_API ConfigKey; +class SR_API InputFormat; +class SR_API OutputFormat; +class SR_API LogLevel; +class SR_API ChannelGroup; +class SR_API Trigger; +class SR_API TriggerStage; +class SR_API TriggerMatch; +class SR_API TriggerMatchType; +class SR_API ChannelType; +class SR_API Packet; +class SR_API PacketPayload; +class SR_API PacketType; +class SR_API Quantity; +class SR_API Unit; +class SR_API QuantityFlag; +class SR_API InputFileDevice; +class SR_API Output; +class SR_API DataType; + +/** Exception thrown when an error code is returned by any libsigrok call. */ +class SR_API Error: public exception +{ +public: + Error(int result); + ~Error() throw(); + const int result; + const char *what() const throw(); +}; + +/** Base template for most classes which wrap a struct type from libsigrok. */ +template class SR_API StructureWrapper : + public enable_shared_from_this > +{ +public: + /** Parent object which owns this child object's underlying structure. + + This shared pointer will be null when this child is unused, but + will be assigned to point to the parent before any shared pointer + to this child is handed out to the user. + + When the reference count of this child falls to zero, this shared + pointer to its parent is reset by a custom deleter on the child's + shared pointer. + + This strategy ensures that the destructors for both the child and + the parent are called at the correct time, i.e. only when all + references to both the parent and all its children are gone. */ + shared_ptr parent; +protected: + Struct *structure; + + StructureWrapper(Struct *structure) : + structure(structure) + { + } +}; + +/** Type of log callback */ +typedef function LogCallbackFunction; + +/** Context */ +class SR_API Context : public enable_shared_from_this +{ +public: + /** Create new context */ + static shared_ptr create(); + /** libsigrok package version. */ + string get_package_version(); + /** libsigrok library version. */ + string get_lib_version(); + /** Available hardware drivers, indexed by name. */ + map > get_drivers(); + /** Available input formats, indexed by name. */ + map > get_input_formats(); + /** Available output formats, indexed by name. */ + map > get_output_formats(); + /** Current log level. */ + const LogLevel *get_log_level(); + /** Set the log level. */ + void set_log_level(const LogLevel *level); + /** Current log domain. */ + string get_log_domain(); + /** Set the log domain. */ + void set_log_domain(string value); + /** Set the log callback. */ + void set_log_callback(LogCallbackFunction callback); + /** Set the log callback to the default handler. */ + void set_log_callback_default(); + /** Create a new session. */ + shared_ptr create_session(); + /** Load a saved session. */ + shared_ptr load_session(string filename); + /** Create a new trigger. */ + shared_ptr create_trigger(string name); +protected: + struct sr_context *structure; + map drivers; + map input_formats; + map output_formats; + Session *session; + LogCallbackFunction log_callback; + Context(); + ~Context(); + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(Context *context) { delete context; } + }; + friend class Deleter; + friend class Session; + friend class Driver; +}; + +/** Hardware driver */ +class SR_API Driver : public StructureWrapper +{ +public: + /** Name of this driver. */ + string get_name(); + /** Long name for this driver. */ + string get_long_name(); + /** Scan for devices and return a list of devices found. */ + vector > scan( + map options = {}); +protected: + bool initialized; + vector devices; + Driver(struct sr_dev_driver *structure); + ~Driver(); + friend class Context; + friend class HardwareDevice; + friend class ChannelGroup; +}; + +/** An object that can be configured. */ +class SR_API Configurable +{ +public: + /** Read configuration for the given key. */ + Glib::VariantBase config_get(const ConfigKey *key); + /** Set configuration for the given key to a specified value. */ + void config_set(const ConfigKey *key, Glib::VariantBase value); + /** Enumerate available values for the given configuration key. */ + Glib::VariantBase config_list(const ConfigKey *key); +protected: + Configurable( + struct sr_dev_driver *driver, + struct sr_dev_inst *sdi, + struct sr_channel_group *channel_group); + virtual ~Configurable(); + struct sr_dev_driver *config_driver; + struct sr_dev_inst *config_sdi; + struct sr_channel_group *config_channel_group; +}; + +/** Generic device (may be real or from an input file) */ +class SR_API Device : + public Configurable, + public StructureWrapper +{ +public: + /** Vendor name for this device. */ + string get_vendor(); + /** Model name for this device. */ + string get_model(); + /** Version string for this device. */ + string get_version(); + /** List of the channels available on this device. */ + vector > get_channels(); + /** Open device. */ + void open(); + /** Close device. */ + void close(); +protected: + Device(struct sr_dev_inst *structure); + ~Device(); + vector channels; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(Device *device) { delete device; } + }; + friend class Deleter; + friend class Session; + friend class Channel; + friend class ChannelGroup; + friend class Output; +}; + +/** Hardware device (connected via a driver) */ +class SR_API HardwareDevice : public Device +{ +public: + /** Driver providing this device. */ + shared_ptr get_driver(); + /** Channel groups available on this device, indexed by name. */ + map > get_channel_groups(); +protected: + HardwareDevice(Driver *driver, struct sr_dev_inst *structure); + ~HardwareDevice(); + Driver *driver; + map channel_groups; + friend class Driver; + friend class ChannelGroup; +}; + +/** Channel */ +class SR_API Channel : public StructureWrapper +{ +public: + /** Current name of this channel. */ + string get_name(); + /** Set the name of this channel. */ + void set_name(string name); + /** Type of this channel. */ + const ChannelType *get_type(); + /** Enabled status of this channel. */ + bool get_enabled(); + /** Set the enabled status of this channel. */ + void set_enabled(bool value); +protected: + Channel(struct sr_channel *structure); + ~Channel(); + const ChannelType * const type; + friend class Device; + friend class ChannelGroup; + friend class Session; + friend class TriggerStage; +}; + +/** Channel group */ +class SR_API ChannelGroup : + public StructureWrapper, + public Configurable +{ +public: + /** Name of this channel group. */ + string get_name(); + /** List of the channels in this group. */ + vector > get_channels(); +protected: + ChannelGroup(HardwareDevice *device, struct sr_channel_group *structure); + ~ChannelGroup(); + vector channels; + friend class HardwareDevice; +}; + +/** Trigger */ +class SR_API Trigger : public enable_shared_from_this +{ +public: + string get_name(); + vector > get_stages(); + shared_ptr add_stage(); +protected: + Trigger(shared_ptr context, string name); + ~Trigger(); + struct sr_trigger *structure; + shared_ptr context; + vector stages; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(Trigger *trigger) { delete trigger; } + }; + friend class Context; +}; + +/** Trigger stage */ +class SR_API TriggerStage : public StructureWrapper +{ +public: + int get_number(); + vector > get_matches(); + void add_match(shared_ptr channel, const TriggerMatchType *type); + void add_match(shared_ptr channel, const TriggerMatchType *type, float value); +protected: + vector matches; + TriggerStage(struct sr_trigger_stage *structure); + ~TriggerStage(); + friend class Trigger; +}; + +/** Trigger match */ +class SR_API TriggerMatch : public StructureWrapper +{ +public: + shared_ptr get_channel(); + const TriggerMatchType *get_type(); + float get_value(); +protected: + TriggerMatch(struct sr_trigger_match *structure, shared_ptr channel); + ~TriggerMatch(); + shared_ptr channel; + friend class TriggerStage; +}; + +/** Type of datafeed callback */ +typedef function, shared_ptr)> + DatafeedCallbackFunction; + +/** Data required for C callback function to call a C++ datafeed callback */ +class SR_PRIV DatafeedCallbackData +{ +public: + void run(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *pkt); +protected: + DatafeedCallbackFunction callback; + DatafeedCallbackData(Session *session, + DatafeedCallbackFunction callback); + Session *session; + friend class Session; +}; + +/** Type of source callback */ +typedef function + SourceCallbackFunction; + +/** Data required for C callback function to call a C++ source callback */ +class SR_PRIV SourceCallbackData +{ +public: + bool run(int revents); +protected: + SourceCallbackData(shared_ptr source); + shared_ptr source; + friend class Session; +}; + +/** Event source. */ +class SR_API EventSource +{ +public: + /** Create an event source from a file descriptor. */ + static shared_ptr create(int fd, Glib::IOCondition events, + int timeout, SourceCallbackFunction callback); + /** Create an event source from a Glib::PollFD */ + static shared_ptr create(Glib::PollFD pollfd, int timeout, + SourceCallbackFunction callback); + /** Create an event source from a Glib::IOChannel */ + static shared_ptr create( + Glib::RefPtr channel, Glib::IOCondition events, + int timeout, SourceCallbackFunction callback); +protected: + EventSource(int timeout, SourceCallbackFunction callback); + ~EventSource(); + enum source_type { + SOURCE_FD, + SOURCE_POLLFD, + SOURCE_IOCHANNEL + } type; + int fd; + Glib::PollFD pollfd; + Glib::RefPtr channel; + Glib::IOCondition events; + int timeout; + SourceCallbackFunction callback; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(EventSource *source) { delete source; } + }; + friend class Deleter; + friend class Session; + friend class SourceCallbackData; +}; + +/** Session */ +class SR_API Session +{ +public: + /** Add a device to this session. */ + void add_device(shared_ptr device); + /** List devices attached to this session. */ + vector > get_devices(); + /** Remove all devices from this session. */ + void remove_devices(); + /** Add a datafeed callback to this session. */ + void add_datafeed_callback(DatafeedCallbackFunction callback); + /** Remove all datafeed callbacks from this session. */ + void remove_datafeed_callbacks(); + /** Add an event source. */ + void add_source(shared_ptr source); + /** Remove an event source. */ + void remove_source(shared_ptr source); + /** Start the session. */ + void start(); + /** Run the session event loop. */ + void run(); + /** Stop the session. */ + void stop(); + /** Begin saving session to a file. */ + void begin_save(string filename); + /** Append a packet to the session file being saved. */ + void append(shared_ptr device, shared_ptr packet); +protected: + Session(shared_ptr context); + Session(shared_ptr context, string filename); + ~Session(); + struct sr_session *structure; + const shared_ptr context; + map > devices; + vector datafeed_callbacks; + map, SourceCallbackData *> source_callbacks; + bool saving; + bool save_initialized; + string save_filename; + uint64_t save_samplerate; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(Session *session) { delete session; } + }; + friend class Deleter; + friend class Context; + friend class DatafeedCallbackData; +}; + +/** Datafeed packet */ +class SR_API Packet +{ +public: + /** Payload of this packet. */ + PacketPayload *get_payload(); +protected: + Packet(const struct sr_datafeed_packet *structure); + ~Packet(); + const struct sr_datafeed_packet *structure; + PacketPayload *payload; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(Packet *packet) { delete packet; } + }; + friend class Deleter; + friend class Session; + friend class Output; + friend class DatafeedCallbackData; +}; + +/** Abstract base class for datafeed packet payloads. */ +class SR_API PacketPayload +{ +protected: + PacketPayload(); + virtual ~PacketPayload() = 0; + virtual void *get_data() = 0; + virtual size_t get_data_size() = 0; + friend class Packet; + friend class Output; +}; + +/** Logic data payload */ +class SR_API Logic : public PacketPayload +{ +protected: + Logic(const struct sr_datafeed_logic *structure); + ~Logic(); + const struct sr_datafeed_logic *structure; + vector data; + void *get_data(); + size_t get_data_size(); + friend class Packet; +}; + +/** Analog data payload */ +class SR_API Analog : public PacketPayload +{ +public: + /** Number of samples in this packet. */ + unsigned int get_num_samples(); + /** Measured quantity of the samples in this packet. */ + const Quantity *get_mq(); + /** Unit of the samples in this packet. */ + const Unit *get_unit(); + /** Measurement flags associated with the samples in this packet. */ + vector get_mq_flags(); +protected: + Analog(const struct sr_datafeed_analog *structure); + ~Analog(); + const struct sr_datafeed_analog *structure; + void *get_data(); + size_t get_data_size(); + friend class Packet; +}; + +/** Input format */ +class SR_API InputFormat : + public StructureWrapper +{ +public: + /** Name of this input format. */ + string get_name(); + /** Description of this input format. */ + string get_description(); + /** Check whether a given file matches this input format. */ + bool format_match(string filename); + /** Open a file using this input format. */ + shared_ptr open_file(string filename, + map options = {}); +protected: + InputFormat(struct sr_input_format *structure); + ~InputFormat(); + friend class Context; + friend class InputFileDevice; +}; + +/** Virtual device associated with an input file */ +class SR_API InputFileDevice : public Device +{ +public: + /** Load data from file. */ + void load(); +protected: + InputFileDevice(shared_ptr format, + struct sr_input *input, string filename); + ~InputFileDevice(); + struct sr_input *input; + shared_ptr format; + string filename; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(InputFileDevice *device) { delete device; } + }; + friend class Deleter; + friend class InputFormat; +}; + +/** Output format */ +class SR_API OutputFormat : + public StructureWrapper +{ +public: + /** Name of this output format. */ + string get_name(); + /** Description of this output format. */ + string get_description(); + /** Create an output using this format. */ + shared_ptr create_output(shared_ptr device, map options = {}); +protected: + OutputFormat(struct sr_output_format *structure); + ~OutputFormat(); + friend class Context; + friend class Output; +}; + +/** Output instance (an output format applied to a device) */ +class SR_API Output +{ +public: + /** Update output with data from the given packet. */ + string receive(shared_ptr packet); +protected: + Output(shared_ptr format, shared_ptr device); + Output(shared_ptr format, + shared_ptr device, map options); + ~Output(); + struct sr_output *structure; + const shared_ptr format; + const shared_ptr device; + const map options; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(Output *output) { delete output; } + }; + friend class Deleter; + friend class OutputFormat; +}; + +/** Base class for objects which wrap an enumeration value from libsigrok */ +template class SR_API EnumValue +{ +public: + /** The enum constant associated with this value. */ + T get_id() const { return id; } + /** The name associated with this value. */ + string get_name() const { return name; } +protected: + EnumValue(T id, const char name[]) : id(id), name(name) {} + ~EnumValue() {} + const T id; + const string name; +}; + +#include "enums.hpp" + +} + +#endif // LIBSIGROK_HPP diff --git a/bindings/cxx/libsigrokxx.pc.in b/bindings/cxx/libsigrokxx.pc.in new file mode 100644 index 00000000..ab4c3782 --- /dev/null +++ b/bindings/cxx/libsigrokxx.pc.in @@ -0,0 +1,15 @@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + +Name: libsigrokxx +Description: C++ bindings for libsigrok +URL: http://www.sigrok.org +Requires: libsigrok glibmm-2.4 +Requires.private: @SR_PKGLIBS@ +Version: @VERSION@ +Libs: -L${libdir} -lsigrokxx +Libs.private: -lm +Cflags: -I${includedir} + diff --git a/configure.ac b/configure.ac index cd9fc124..aa79dca4 100644 --- a/configure.ac +++ b/configure.ac @@ -46,10 +46,12 @@ AH_BOTTOM([#endif /* SR_CONFIG_H */]) # and enforce use of SR_API to explicitly mark all public API functions. COMMON_FLAGS="$CFLAGS -Wall -Wextra -fvisibility=hidden" CFLAGS="$COMMON_FLAGS -Wmissing-prototypes" +CXXFLAGS="-std=c++11 $COMMON_FLAGS" # Checks for programs. AC_PROG_CC AC_PROG_CPP +AC_PROG_CXX AC_PROG_INSTALL AC_PROG_LN_S @@ -152,6 +154,21 @@ AC_ARG_ENABLE(libusb, AC_HELP_STRING([--disable-libusb], [disable libusb support [default=detect]])) +# Language binding '--enable' options + +AC_ARG_ENABLE(c++, + AC_HELP_STRING([--enable-cxx], + [build C++ bindings [default=yes]]), + [BINDINGS_CXX="$enableval"], [BINDINGS_CXX="yes"]) + +# Check if the C++ compiler supports the C++11 standard. + +AX_CXX_COMPILE_STDCXX_11(,[optional]) + +if test "x$HAVE_CXX11" != "x1"; then + BINDINGS_CXX="no" +fi + # Checks for libraries. case "$host" in @@ -301,6 +318,11 @@ if test "x$have_libftdi" = "xno"; then HW_ASIX_SIGMA="no"; HW_CHRONOVU_LA="no"; HW_IKALOGIC_SCANAPLUS="no"; fi +# glibmm-2.4 is needed for the C++ bindings. +PKG_CHECK_MODULES([glibmm], [glibmm-2.4 >= 2.32.0], + [CXXFLAGS="$CXXFLAGS $glibmm_CFLAGS"; + CXXLIBS="$CXXLIBS $glibmm_LIBS"], [BINDINGS_CXX="no"]) + # The Check unit testing framework is optional. Disable if not found. PKG_CHECK_MODULES([check], [check >= 0.9.4], [have_check="yes"], [have_check="no"]) @@ -317,6 +339,7 @@ esac AC_SUBST(SR_PKGLIBS) CFLAGS="$CFLAGS -I./include/libsigrok $LIB_CFLAGS" +CXXFLAGS="$CXXFLAGS -I./include -I./bindings/cxx/include $LIB_CFLAGS" # Now set AM_CONDITIONALs and AC_DEFINEs for the enabled/disabled drivers. @@ -505,6 +528,8 @@ if test "x$HW_ZEROPLUS_LOGIC_CUBE" = "xyes"; then AC_DEFINE(HAVE_HW_ZEROPLUS_LOGIC_CUBE, 1, [ZEROPLUS Logic Cube support]) fi +AM_CONDITIONAL(BINDINGS_CXX, test x$BINDINGS_CXX = xyes) + # Checks for header files. # These are already checked: inttypes.h stdint.h stdlib.h string.h unistd.h. @@ -525,7 +550,8 @@ AC_SUBST(SR_PACKAGE_VERSION_MINOR) AC_SUBST(SR_PACKAGE_VERSION_MICRO) AC_SUBST(SR_PACKAGE_VERSION) -AC_CONFIG_FILES([Makefile include/libsigrok/version.h libsigrok.pc]) +AC_CONFIG_FILES([Makefile include/libsigrok/version.h libsigrok.pc + bindings/cxx/libsigrokxx.pc]) AC_OUTPUT @@ -557,3 +583,6 @@ done echo -e "\nEnabled hardware drivers:\n${driver_summary}" +echo -e "\nEnabled language bindings:\n" +echo " - C++............................. $BINDINGS_CXX" +echo