]> sigrok.org Git - libsigrok.git/blobdiff - bindings/cxx/classes.cpp
C++: Add UserOwned base template for objects with resources owned by user.
[libsigrok.git] / bindings / cxx / classes.cpp
index 67d490861b94503aacfd2298b01cda22bab93a5b..525e046ddcc168fad28e599345bef3c9e7d53ac7 100644 (file)
@@ -40,24 +40,11 @@ static const char *valid_string(const char *input)
                return "";
 }
 
-/** Helper function to convert between map<string, string> and GHashTable */
-static GHashTable *map_to_hash_string(map<string, string> 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;
-}
-
 /** Helper function to convert between map<string, VariantBase> and GHashTable */
 static GHashTable *map_to_hash_variant(map<string, Glib::VariantBase> input)
 {
        auto output = g_hash_table_new_full(
-               g_variant_hash, g_variant_equal, g_free,
-               (void (*)(void *))g_variant_unref);
+               g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_variant_unref);
        for (auto entry : input)
                g_hash_table_insert(output,
                        g_strdup(entry.first.c_str()),
@@ -84,18 +71,20 @@ shared_ptr<Context> Context::create()
 }
 
 Context::Context() :
+       UserOwned(structure),
        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();
+       const struct sr_input_module **input_list = sr_input_list();
        if (input_list)
                for (int i = 0; input_list[i]; i++)
-                       input_formats[input_list[i]->id] =
+                       input_formats[sr_input_id_get(input_list[i])] =
                                new InputFormat(input_list[i]);
        const struct sr_output_module **output_list = sr_output_list();
        if (output_list)
@@ -121,8 +110,7 @@ map<string, shared_ptr<Driver>> Context::get_drivers()
        {
                auto name = entry.first;
                auto driver = entry.second;
-               result[name] = static_pointer_cast<Driver>(
-                       driver->get_shared_pointer(this));
+               result[name] = driver->get_shared_pointer(this);
        }
        return result;
 }
@@ -134,8 +122,7 @@ map<string, shared_ptr<InputFormat>> Context::get_input_formats()
        {
                auto name = entry.first;
                auto input_format = entry.second;
-               result[name] = static_pointer_cast<InputFormat>(
-                       input_format->get_shared_pointer(this));
+               result[name] = input_format->get_shared_pointer(this);
        }
        return result;
 }
@@ -147,8 +134,7 @@ map<string, shared_ptr<OutputFormat>> Context::get_output_formats()
        {
                auto name = entry.first;
                auto output_format = entry.second;
-               result[name] = static_pointer_cast<OutputFormat>(
-                       output_format->get_shared_pointer(this));
+               result[name] = output_format->get_shared_pointer(this);
        }
        return result;
 }
@@ -239,8 +225,29 @@ shared_ptr<Trigger> Context::create_trigger(string name)
                new Trigger(shared_from_this(), name), Trigger::Deleter());
 }
 
+shared_ptr<Input> Context::open_file(string filename)
+{
+       const struct sr_input *input;
+
+       check( sr_input_scan_file(filename.c_str(), &input));
+       return shared_ptr<Input>(
+               new Input(shared_from_this(), input), Input::Deleter());
+}
+
+shared_ptr<Input> Context::open_stream(string header)
+{
+       const struct sr_input *input;
+
+       auto gstr = g_string_new(header.c_str());
+       auto ret = sr_input_scan_buffer(gstr, &input);
+       g_string_free(gstr, true);
+       check(ret);
+       return shared_ptr<Input>(
+               new Input(shared_from_this(), input), Input::Deleter());
+}
+
 Driver::Driver(struct sr_dev_driver *structure) :
-       StructureWrapper<Context, struct sr_dev_driver>(structure),
+       ParentOwned(structure),
        initialized(false)
 {
 }
@@ -307,8 +314,7 @@ vector<shared_ptr<HardwareDevice>> Driver::scan(
        /* Create list of shared pointers to device instances for return. */
        vector<shared_ptr<HardwareDevice>> result;
        for (auto device : devices)
-               result.push_back(static_pointer_cast<HardwareDevice>(
-                       device->get_shared_pointer(parent)));
+               result.push_back(device->get_shared_pointer(parent));
        return result;
 }
 
@@ -353,7 +359,7 @@ Glib::VariantContainerBase Configurable::config_list(const ConfigKey *key)
 
 Device::Device(struct sr_dev_inst *structure) :
        Configurable(structure->driver, structure, NULL),
-       StructureWrapper<Context, struct sr_dev_inst>(structure)
+       structure(structure)
 {
        for (GSList *entry = structure->channels; entry; entry = entry->next)
        {
@@ -409,15 +415,13 @@ vector<shared_ptr<Channel>> Device::get_channels()
 {
        vector<shared_ptr<Channel>> result;
        for (auto entry : channels)
-               result.push_back(static_pointer_cast<Channel>(
-                       entry.second->get_shared_pointer(this)));
+               result.push_back(entry.second->get_shared_pointer(get_shared_from_this()));
        return result;
 }
 
 shared_ptr<Channel> Device::get_channel(struct sr_channel *ptr)
 {
-       return static_pointer_cast<Channel>(
-               channels[ptr]->get_shared_pointer(this));
+       return channels[ptr]->get_shared_pointer(get_shared_from_this());
 }
 
 map<string, shared_ptr<ChannelGroup>>
@@ -428,8 +432,7 @@ Device::get_channel_groups()
        {
                auto name = entry.first;
                auto channel_group = entry.second;
-               result[name] = static_pointer_cast<ChannelGroup>(
-                       channel_group->get_shared_pointer(this));
+               result[name] = channel_group->get_shared_pointer(get_shared_from_this());
        }
        return result;
 }
@@ -445,6 +448,7 @@ void Device::close()
 }
 
 HardwareDevice::HardwareDevice(Driver *driver, struct sr_dev_inst *structure) :
+       ParentOwned(structure),
        Device(structure),
        driver(driver)
 {
@@ -454,13 +458,18 @@ HardwareDevice::~HardwareDevice()
 {
 }
 
+shared_ptr<Device> HardwareDevice::get_shared_from_this()
+{
+       return static_pointer_cast<Device>(shared_from_this());
+}
+
 shared_ptr<Driver> HardwareDevice::get_driver()
 {
-       return static_pointer_cast<Driver>(driver->get_shared_pointer(parent));
+       return driver->get_shared_pointer(parent);
 }
 
 Channel::Channel(struct sr_channel *structure) :
-       StructureWrapper<Device, struct sr_channel>(structure),
+       ParentOwned(structure),
        type(ChannelType::get(structure->type))
 {
 }
@@ -501,7 +510,7 @@ unsigned int Channel::get_index()
 
 ChannelGroup::ChannelGroup(Device *device,
                struct sr_channel_group *structure) :
-       StructureWrapper<Device, struct sr_channel_group>(structure),
+       ParentOwned(structure),
        Configurable(device->structure->driver, device->structure, structure)
 {
        for (GSList *entry = structure->channels; entry; entry = entry->next)
@@ -521,13 +530,13 @@ vector<shared_ptr<Channel>> ChannelGroup::get_channels()
 {
        vector<shared_ptr<Channel>> result;
        for (auto channel : channels)
-               result.push_back(static_pointer_cast<Channel>(
-                       channel->get_shared_pointer(parent)));
+               result.push_back(channel->get_shared_pointer(parent));
        return result;
 }
 
 Trigger::Trigger(shared_ptr<Context> context, string name) : 
-       structure(sr_trigger_new(name.c_str())), context(context)
+       UserOwned(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));
@@ -550,8 +559,7 @@ vector<shared_ptr<TriggerStage>> Trigger::get_stages()
 {
        vector<shared_ptr<TriggerStage>> result;
        for (auto stage : stages)
-               result.push_back(static_pointer_cast<TriggerStage>(
-                       stage->get_shared_pointer(this)));
+               result.push_back(stage->get_shared_pointer(this));
        return result;
 }
 
@@ -559,12 +567,11 @@ shared_ptr<TriggerStage> Trigger::add_stage()
 {
        auto stage = new TriggerStage(sr_trigger_stage_add(structure));
        stages.push_back(stage);
-       return static_pointer_cast<TriggerStage>(
-               stage->get_shared_pointer(this));
+       return stage->get_shared_pointer(this);
 }
 
 TriggerStage::TriggerStage(struct sr_trigger_stage *structure) : 
-       StructureWrapper<Trigger, struct sr_trigger_stage>(structure)
+       ParentOwned(structure)
 {
 }
 
@@ -583,8 +590,7 @@ vector<shared_ptr<TriggerMatch>> TriggerStage::get_matches()
 {
        vector<shared_ptr<TriggerMatch>> result;
        for (auto match : matches)
-               result.push_back(static_pointer_cast<TriggerMatch>(
-                       match->get_shared_pointer(this)));
+               result.push_back(match->get_shared_pointer(this));
        return result;
 }
 
@@ -601,7 +607,7 @@ void TriggerStage::add_match(shared_ptr<Channel> channel, const TriggerMatchType
 }
 
 TriggerMatch::TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel) :
-       StructureWrapper<TriggerStage, struct sr_trigger_match>(structure), channel(channel)
+       ParentOwned(structure), channel(channel)
 {
 }
 
@@ -687,6 +693,7 @@ EventSource::~EventSource()
 }
 
 Session::Session(shared_ptr<Context> context) :
+       UserOwned(structure),
        context(context), saving(false)
 {
        check(sr_session_new(&structure));
@@ -694,6 +701,7 @@ Session::Session(shared_ptr<Context> context) :
 }
 
 Session::Session(shared_ptr<Context> context, string filename) :
+       UserOwned(structure),
        context(context), saving(false)
 {
        check(sr_session_load(filename.c_str(), &structure));
@@ -725,9 +733,6 @@ vector<shared_ptr<Device>> Session::get_devices()
        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<Device>(
-                               new Device(sdi), Device::Deleter());
                result.push_back(devices[sdi]);
        }
        return result;
@@ -936,7 +941,7 @@ void Session::set_trigger(shared_ptr<Trigger> trigger)
 
 Packet::Packet(shared_ptr<Device> device,
        const struct sr_datafeed_packet *structure) :
-       structure(structure),
+       UserOwned(structure),
        device(device)
 {
        switch (structure->type)
@@ -961,6 +966,9 @@ Packet::Packet(shared_ptr<Device> device,
                                static_cast<const struct sr_datafeed_analog *>(
                                        structure->payload));
                        break;
+               default:
+                       payload = nullptr;
+                       break;
        }
 }
 
@@ -977,7 +985,10 @@ const PacketType *Packet::get_type()
 
 shared_ptr<PacketPayload> Packet::get_payload()
 {
-       return payload->get_shared_pointer(this);
+       if (payload)
+               return payload->get_shared_pointer(this);
+       else
+               throw Error(SR_ERR_NA);
 }
 
 PacketPayload::PacketPayload()
@@ -989,8 +1000,8 @@ PacketPayload::~PacketPayload()
 }
 
 Header::Header(const struct sr_datafeed_header *structure) :
-       PacketPayload(),
-       StructureWrapper<Packet, const struct sr_datafeed_header>(structure)
+       ParentOwned(structure),
+       PacketPayload()
 {
 }
 
@@ -998,6 +1009,11 @@ Header::~Header()
 {
 }
 
+shared_ptr<PacketPayload> Header::get_shared_pointer(Packet *parent)
+{
+       return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
+}
+
 int Header::get_feed_version()
 {
        return structure->feed_version;
@@ -1011,8 +1027,8 @@ Glib::TimeVal Header::get_start_time()
 }
 
 Meta::Meta(const struct sr_datafeed_meta *structure) :
-       PacketPayload(),
-       StructureWrapper<Packet, const struct sr_datafeed_meta>(structure)
+       ParentOwned(structure),
+       PacketPayload()
 {
 }
 
@@ -1020,6 +1036,11 @@ Meta::~Meta()
 {
 }
 
+shared_ptr<PacketPayload> Meta::get_shared_pointer(Packet *parent)
+{
+       return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
+}
+
 map<const ConfigKey *, Glib::VariantBase> Meta::get_config()
 {
        map<const ConfigKey *, Glib::VariantBase> result;
@@ -1032,8 +1053,8 @@ map<const ConfigKey *, Glib::VariantBase> Meta::get_config()
 }
 
 Logic::Logic(const struct sr_datafeed_logic *structure) :
-       PacketPayload(),
-       StructureWrapper<Packet, const struct sr_datafeed_logic>(structure)
+       ParentOwned(structure),
+       PacketPayload()
 {
 }
 
@@ -1041,6 +1062,11 @@ Logic::~Logic()
 {
 }
 
+shared_ptr<PacketPayload> Logic::get_shared_pointer(Packet *parent)
+{
+       return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
+}
+
 void *Logic::get_data_pointer()
 {
        return structure->data;
@@ -1057,8 +1083,8 @@ unsigned int Logic::get_unit_size()
 }
 
 Analog::Analog(const struct sr_datafeed_analog *structure) :
-       PacketPayload(),
-       StructureWrapper<Packet, const struct sr_datafeed_analog>(structure)
+       ParentOwned(structure),
+       PacketPayload()
 {
 }
 
@@ -1066,6 +1092,11 @@ Analog::~Analog()
 {
 }
 
+shared_ptr<PacketPayload> Analog::get_shared_pointer(Packet *parent)
+{
+       return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
+}
+
 float *Analog::get_data_pointer()
 {
        return structure->data;
@@ -1100,8 +1131,8 @@ vector<const QuantityFlag *> Analog::get_mq_flags()
        return QuantityFlag::flags_from_mask(structure->mqflags);
 }
 
-InputFormat::InputFormat(struct sr_input_format *structure) :
-       StructureWrapper<Context, struct sr_input_format>(structure)
+InputFormat::InputFormat(const struct sr_input_module *structure) :
+       ParentOwned(structure)
 {
 }
 
@@ -1111,57 +1142,91 @@ InputFormat::~InputFormat()
 
 string InputFormat::get_name()
 {
-       return valid_string(structure->id);
+       return valid_string(sr_input_id_get(structure));
 }
 
 string InputFormat::get_description()
 {
-       return valid_string(structure->description);
+       return valid_string(sr_input_description_get(structure));
 }
 
-bool InputFormat::format_match(string filename)
+map<string, shared_ptr<Option>> InputFormat::get_options()
 {
-       return structure->format_match(filename.c_str());
+       const struct sr_option **options = sr_input_options_get(structure);
+       auto option_array = shared_ptr<const struct sr_option *>(
+               options, sr_input_options_free);
+       map<string, shared_ptr<Option>> result;
+       for (int i = 0; options[i]; i++)
+               result[options[i]->id] = shared_ptr<Option>(
+                       new Option(options[i], option_array), Option::Deleter());
+       return result;
 }
 
-shared_ptr<InputFileDevice> InputFormat::open_file(string filename,
-               map<string, string> options)
+shared_ptr<Input> InputFormat::create_input(
+       map<string, Glib::VariantBase> options)
 {
-       auto input = g_new(struct sr_input, 1);
-       input->param = map_to_hash_string(options);
+       auto input = sr_input_new(structure, map_to_hash_variant(options));
+       if (!input)
+               throw Error(SR_ERR_ARG);
+       return shared_ptr<Input>(
+               new Input(parent->shared_from_this(), input), Input::Deleter());
+}
 
-       /** Run initialisation. */
-       check(structure->init(input, filename.c_str()));
+Input::Input(shared_ptr<Context> context, const struct sr_input *structure) :
+       UserOwned(structure),
+       context(context),
+       device(nullptr)
+{
+}
 
-       /** Create virtual device. */
-       return shared_ptr<InputFileDevice>(new InputFileDevice(
-               static_pointer_cast<InputFormat>(shared_from_this()), input, filename),
-               InputFileDevice::Deleter());
+shared_ptr<InputDevice> Input::get_device()
+{
+       if (!device)
+       {
+               auto sdi = sr_input_dev_inst_get(structure);
+               if (!sdi)
+                       throw Error(SR_ERR_NA);
+               device = new InputDevice(shared_from_this(), sdi);
+       }
+
+       return device->get_shared_pointer(shared_from_this());
 }
 
-InputFileDevice::InputFileDevice(shared_ptr<InputFormat> format,
-               struct sr_input *input, string filename) :
-       Device(input->sdi),
-       input(input),
-       format(format),
-       filename(filename)
+void Input::send(string data)
+{
+       auto gstr = g_string_new(data.c_str());
+       auto ret = sr_input_send(structure, gstr);
+       g_string_free(gstr, false);
+       check(ret);
+}
+
+Input::~Input()
+{
+       if (device)
+               delete device;
+       check(sr_input_free(structure));
+}
+
+InputDevice::InputDevice(shared_ptr<Input> input,
+               struct sr_dev_inst *structure) :
+       ParentOwned(structure),
+       Device(structure),
+       input(input)
 {
 }
 
-InputFileDevice::~InputFileDevice()
+InputDevice::~InputDevice()
 {
-       g_hash_table_unref(input->param);
-       g_free(input);
 }
 
-void InputFileDevice::load()
+shared_ptr<Device> InputDevice::get_shared_from_this()
 {
-       check(format->structure->loadfile(input, filename.c_str()));
+       return static_pointer_cast<Device>(shared_from_this());
 }
 
 Option::Option(const struct sr_option *structure,
-               shared_ptr<const struct sr_option> structure_array) :
-       structure(structure),
+               shared_ptr<const struct sr_option *> structure_array) :
+       UserOwned(structure),
        structure_array(structure_array)
 {
 }
@@ -1199,7 +1264,7 @@ vector<Glib::VariantBase> Option::get_values()
 }
 
 OutputFormat::OutputFormat(const struct sr_output_module *structure) :
-       StructureWrapper<Context, const struct sr_output_module>(structure)
+       ParentOwned(structure)
 {
 }
 
@@ -1219,14 +1284,13 @@ string OutputFormat::get_description()
 
 map<string, shared_ptr<Option>> OutputFormat::get_options()
 {
-       const struct sr_option *option = sr_output_options_get(structure);
-       auto option_array = shared_ptr<const struct sr_option>(
-               option, [=](const struct sr_option *) {
-                       sr_output_options_free(structure); });
+       const struct sr_option **options = sr_output_options_get(structure);
+       auto option_array = shared_ptr<const struct sr_option *>(
+               options, sr_output_options_free);
        map<string, shared_ptr<Option>> result;
-       for (; option->id; option++)
-               result[option->id] = shared_ptr<Option>(
-                       new Option(option, option_array), Option::Deleter());
+       for (int i = 0; options[i]; i++)
+               result[options[i]->id] = shared_ptr<Option>(
+                       new Option(options[i], option_array), Option::Deleter());
        return result;
 }
 
@@ -1234,15 +1298,13 @@ shared_ptr<Output> OutputFormat::create_output(
        shared_ptr<Device> device, map<string, Glib::VariantBase> options)
 {
        return shared_ptr<Output>(
-               new Output(
-                       static_pointer_cast<OutputFormat>(shared_from_this()),
-                               device, options),
+               new Output(shared_from_this(), device, options),
                Output::Deleter());
 }
 
 Output::Output(shared_ptr<OutputFormat> format,
                shared_ptr<Device> device, map<string, Glib::VariantBase> options) :
-       structure(sr_output_new(format->structure,
+       UserOwned(sr_output_new(format->structure,
                map_to_hash_variant(options), device->structure)),
        format(format), device(device), options(options)
 {