]> sigrok.org Git - libsigrok.git/blobdiff - bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
C++: Replace custom deleters with std::default_delete
[libsigrok.git] / bindings / cxx / include / libsigrokcxx / libsigrokcxx.hpp
index a83600aa99753d9b4a5baf83ce95a4c4b7de5eaa..a74bbfcfa5002ba665e747c17edd4f3235125710 100644 (file)
@@ -127,7 +127,7 @@ public:
 };
 
 /* Base template for classes whose resources are owned by a parent object. */
-template <class Class, class Parent, typename Struct>
+template <class Class, class Parent>
 class SR_API ParentOwned
 {
 private:
@@ -157,35 +157,23 @@ protected:
                references to both the parent and all its children are gone. */
        shared_ptr<Parent> _parent;
 
-       Struct *_structure;
-
-       explicit ParentOwned(Struct *structure) :
-               _structure(structure)
-       {
-       }
-
-public:
-       /* Get parent object that owns this object. */
-       shared_ptr<Parent> parent()
-       {
-               return _parent;
-       }
+       ParentOwned() {}
 
        /* Note, this implementation will create a new smart_ptr if none exists. */
        shared_ptr<Class> shared_from_this()
        {
-               shared_ptr<Class> shared;
+               shared_ptr<Class> shared = _weak_this.lock();
 
-               if (!(shared = _weak_this.lock()))
+               if (!shared)
                {
-                       shared = shared_ptr<Class>(static_cast<Class *>(this), reset_parent);
+                       shared.reset(static_cast<Class *>(this), &reset_parent);
                        _weak_this = shared;
                }
 
                return shared;
        }
 
-       shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent)
+       shared_ptr<Class> share_owned_by(shared_ptr<Parent> parent)
        {
                if (!parent)
                        throw Error(SR_ERR_BUG);
@@ -193,19 +181,21 @@ public:
                return shared_from_this();
        }
 
-       shared_ptr<Class> get_shared_pointer(Parent *parent)
+public:
+       /* Get parent object that owns this object. */
+       shared_ptr<Parent> parent()
        {
-               if (!parent)
-                       throw Error(SR_ERR_BUG);
-               return get_shared_pointer(parent->shared_from_this());
+               return _parent;
        }
 };
 
 /* Base template for classes whose resources are owned by the user. */
-template <class Class, typename Struct>
+template <class Class>
 class SR_API UserOwned : public enable_shared_from_this<Class>
 {
-public:
+protected:
+       UserOwned() {}
+
        shared_ptr<Class> shared_from_this()
        {
                auto shared = enable_shared_from_this<Class>::shared_from_this();
@@ -213,20 +203,6 @@ public:
                        throw Error(SR_ERR_BUG);
                return shared;
        }
-protected:
-       Struct *_structure;
-
-       explicit UserOwned(Struct *structure) :
-               _structure(structure)
-       {
-       }
-
-       /* Deleter needed to allow shared_ptr use with protected destructor. */
-       class Deleter
-       {
-       public:
-               void operator()(Class *object) { delete object; }
-       };
 };
 
 /** Type of log callback */
@@ -256,7 +232,7 @@ private:
 };
 
 /** The global libsigrok context */
-class SR_API Context : public UserOwned<Context, struct sr_context>
+class SR_API Context : public UserOwned<Context>
 {
 public:
        /** Create new context */
@@ -316,16 +292,17 @@ public:
        shared_ptr<Input> open_stream(string header);
        map<string, string> serials(shared_ptr<Driver> driver) const;
 private:
-       map<string, Driver *> _drivers;
-       map<string, InputFormat *> _input_formats;
-       map<string, OutputFormat *> _output_formats;
+       struct sr_context *_structure;
+       map<string, unique_ptr<Driver> > _drivers;
+       map<string, unique_ptr<InputFormat> > _input_formats;
+       map<string, unique_ptr<OutputFormat> > _output_formats;
        Session *_session;
        LogCallbackFunction _log_callback;
        Context();
        ~Context();
-       friend class Deleter;
        friend class Session;
        friend class Driver;
+       friend class std::default_delete<Context>;
 };
 
 enum Capability {
@@ -365,7 +342,7 @@ protected:
 
 /** A hardware driver provided by the library */
 class SR_API Driver :
-       public ParentOwned<Driver, Context, struct sr_dev_driver>,
+       public ParentOwned<Driver, Context>,
        public Configurable
 {
 public:
@@ -378,6 +355,7 @@ public:
        vector<shared_ptr<HardwareDevice> > scan(
                const map<const ConfigKey *, Glib::VariantBase> &options = {});
 private:
+       struct sr_dev_driver *_structure;
        bool _initialized;
        vector<HardwareDevice *> _devices;
        explicit Driver(struct sr_dev_driver *structure);
@@ -385,6 +363,7 @@ private:
        friend class Context;
        friend class HardwareDevice;
        friend class ChannelGroup;
+       friend class std::default_delete<Driver>;
 };
 
 /** A generic device, either hardware or virtual */
@@ -416,26 +395,21 @@ protected:
        shared_ptr<Channel> get_channel(struct sr_channel *ptr);
 
        struct sr_dev_inst *_structure;
-       map<struct sr_channel *, Channel *> _channels;
+       map<struct sr_channel *, unique_ptr<Channel> > _channels;
 private:
-       map<string, ChannelGroup *> _channel_groups;
-       /** Deleter needed to allow shared_ptr use with protected destructor. */
-       class Deleter
-       {
-       public:
-               void operator()(Device *device) { delete device; }
-       };
-       friend class Deleter;
+       map<string, unique_ptr<ChannelGroup> > _channel_groups;
+
        friend class Session;
        friend class Channel;
        friend class ChannelGroup;
        friend class Output;
        friend class Analog;
+       friend class std::default_delete<Device>;
 };
 
 /** A real hardware device, connected via a driver */
 class SR_API HardwareDevice :
-       public UserOwned<HardwareDevice, struct sr_dev_inst>,
+       public UserOwned<HardwareDevice>,
        public Device
 {
 public:
@@ -446,20 +420,15 @@ private:
        ~HardwareDevice();
        shared_ptr<Device> get_shared_from_this();
        shared_ptr<Driver> _driver;
-       /** Deleter needed to allow shared_ptr use with protected destructor. */
-       class Deleter
-       {
-       public:
-               void operator()(HardwareDevice *device) { delete device; }
-       };
-       friend class Deleter;
+
        friend class Driver;
        friend class ChannelGroup;
+       friend class std::default_delete<HardwareDevice>;
 };
 
 /** A virtual device, created by the user */
 class SR_API UserDevice :
-       public UserOwned<UserDevice, struct sr_dev_inst>,
+       public UserOwned<UserDevice>,
        public Device
 {
 public:
@@ -469,19 +438,14 @@ private:
        UserDevice(string vendor, string model, string version);
        ~UserDevice();
        shared_ptr<Device> get_shared_from_this();
-       /** Deleter needed to allow shared_ptr use with protected destructor. */
-       class Deleter
-       {
-       public:
-               void operator()(UserDevice *device) { delete device; }
-       };
+
        friend class Context;
-       friend class Deleter;
+       friend class std::default_delete<UserDevice>;
 };
 
 /** A channel on a device */
 class SR_API Channel :
-       public ParentOwned<Channel, Device, struct sr_channel>
+       public ParentOwned<Channel, Device>
 {
 public:
        /** Current name of this channel. */
@@ -501,6 +465,7 @@ public:
 private:
        explicit Channel(struct sr_channel *structure);
        ~Channel();
+       struct sr_channel *_structure;
        const ChannelType * const _type;
        friend class Device;
        friend class UserDevice;
@@ -508,11 +473,12 @@ private:
        friend class Session;
        friend class TriggerStage;
        friend class Context;
+       friend class std::default_delete<Channel>;
 };
 
 /** A group of channels on a device, which share some configuration */
 class SR_API ChannelGroup :
-       public ParentOwned<ChannelGroup, Device, struct sr_channel_group>,
+       public ParentOwned<ChannelGroup, Device>,
        public Configurable
 {
 public:
@@ -521,14 +487,15 @@ public:
        /** List of the channels in this group. */
        vector<shared_ptr<Channel> > channels();
 private:
-       ChannelGroup(Device *device, struct sr_channel_group *structure);
+       ChannelGroup(const Device *device, struct sr_channel_group *structure);
        ~ChannelGroup();
        vector<Channel *> _channels;
        friend class Device;
+       friend class std::default_delete<ChannelGroup>;
 };
 
 /** A trigger configuration */
-class SR_API Trigger : public UserOwned<Trigger, struct sr_trigger>
+class SR_API Trigger : public UserOwned<Trigger>
 {
 public:
        /** Name of this trigger configuration. */
@@ -540,16 +507,17 @@ public:
 private:
        Trigger(shared_ptr<Context> context, string name);
        ~Trigger();
+       struct sr_trigger *_structure;
        shared_ptr<Context> _context;
-       vector<TriggerStage *> _stages;
-       friend class Deleter;
+       vector<unique_ptr<TriggerStage> > _stages;
        friend class Context;
        friend class Session;
+       friend class std::default_delete<Trigger>;
 };
 
 /** A stage in a trigger configuration */
 class SR_API TriggerStage :
-       public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage>
+       public ParentOwned<TriggerStage, Trigger>
 {
 public:
        /** Index number of this stage. */
@@ -566,15 +534,17 @@ public:
         * @param value Threshold value. */
        void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
 private:
-       vector<TriggerMatch *> _matches;
+       struct sr_trigger_stage *_structure;
+       vector<unique_ptr<TriggerMatch> > _matches;
        explicit TriggerStage(struct sr_trigger_stage *structure);
        ~TriggerStage();
        friend class Trigger;
+       friend class std::default_delete<TriggerStage>;
 };
 
 /** A match condition in a trigger configuration  */
 class SR_API TriggerMatch :
-       public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match>
+       public ParentOwned<TriggerMatch, TriggerStage>
 {
 public:
        /** Channel this condition matches on. */
@@ -586,8 +556,10 @@ public:
 private:
        TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
        ~TriggerMatch();
+       struct sr_trigger_match *_structure;
        shared_ptr<Channel> _channel;
        friend class TriggerStage;
+       friend class std::default_delete<TriggerMatch>;
 };
 
 /** Type of session stopped callback */
@@ -613,25 +585,20 @@ private:
 
 /** A virtual device associated with a stored session */
 class SR_API SessionDevice :
-       public ParentOwned<SessionDevice, Session, struct sr_dev_inst>,
+       public ParentOwned<SessionDevice, Session>,
        public Device
 {
 private:
        explicit SessionDevice(struct sr_dev_inst *sdi);
        ~SessionDevice();
        shared_ptr<Device> get_shared_from_this();
-       /** Deleter needed to allow shared_ptr use with protected destructor. */
-       class Deleter
-       {
-       public:
-               void operator()(SessionDevice *device) { delete device; }
-       };
-       friend class Deleter;
+
        friend class Session;
+       friend class std::default_delete<SessionDevice>;
 };
 
 /** A sigrok session */
-class SR_API Session : public UserOwned<Session, struct sr_session>
+class SR_API Session : public UserOwned<Session>
 {
 public:
        /** Add a device to this session.
@@ -670,21 +637,23 @@ private:
        Session(shared_ptr<Context> context, string filename);
        ~Session();
        shared_ptr<Device> get_device(const struct sr_dev_inst *sdi);
+       struct sr_session *_structure;
        const shared_ptr<Context> _context;
-       map<const struct sr_dev_inst *, SessionDevice *> _owned_devices;
+       map<const struct sr_dev_inst *, unique_ptr<SessionDevice> > _owned_devices;
        map<const struct sr_dev_inst *, shared_ptr<Device> > _other_devices;
-       vector<DatafeedCallbackData *> _datafeed_callbacks;
+       vector<unique_ptr<DatafeedCallbackData> > _datafeed_callbacks;
        SessionStoppedCallback _stopped_callback;
        string _filename;
        shared_ptr<Trigger> _trigger;
-       friend class Deleter;
+
        friend class Context;
        friend class DatafeedCallbackData;
        friend class SessionDevice;
+       friend class std::default_delete<Session>;
 };
 
 /** A packet on the session datafeed */
-class SR_API Packet : public UserOwned<Packet, const struct sr_datafeed_packet>
+class SR_API Packet : public UserOwned<Packet>
 {
 public:
        /** Type of this packet. */
@@ -695,9 +664,10 @@ private:
        Packet(shared_ptr<Device> device,
                const struct sr_datafeed_packet *structure);
        ~Packet();
+       const struct sr_datafeed_packet *_structure;
        shared_ptr<Device> _device;
-       PacketPayload *_payload;
-       friend class Deleter;
+       unique_ptr<PacketPayload> _payload;
+
        friend class Session;
        friend class Output;
        friend class DatafeedCallbackData;
@@ -706,6 +676,7 @@ private:
        friend class Logic;
        friend class Analog;
        friend class Context;
+       friend class std::default_delete<Packet>;
 };
 
 /** Abstract base class for datafeed packet payloads */
@@ -714,16 +685,17 @@ class SR_API PacketPayload
 protected:
        PacketPayload();
        virtual ~PacketPayload() = 0;
-       virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0;
+private:
+       virtual shared_ptr<PacketPayload> share_owned_by(shared_ptr<Packet> parent) = 0;
 
-       friend class Deleter;
        friend class Packet;
        friend class Output;
+       friend class std::default_delete<PacketPayload>;
 };
 
 /** Payload of a datafeed header packet */
 class SR_API Header :
-       public ParentOwned<Header, Packet, const struct sr_datafeed_header>,
+       public ParentOwned<Header, Packet>,
        public PacketPayload
 {
 public:
@@ -734,13 +706,16 @@ public:
 private:
        explicit Header(const struct sr_datafeed_header *structure);
        ~Header();
-       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
+       shared_ptr<PacketPayload> share_owned_by(shared_ptr<Packet> parent);
+
+       const struct sr_datafeed_header *_structure;
+
        friend class Packet;
 };
 
 /** Payload of a datafeed metadata packet */
 class SR_API Meta :
-       public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>,
+       public ParentOwned<Meta, Packet>,
        public PacketPayload
 {
 public:
@@ -749,14 +724,17 @@ public:
 private:
        explicit Meta(const struct sr_datafeed_meta *structure);
        ~Meta();
-       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
+       shared_ptr<PacketPayload> share_owned_by(shared_ptr<Packet> parent);
+
+       const struct sr_datafeed_meta *_structure;
        map<const ConfigKey *, Glib::VariantBase> _config;
+
        friend class Packet;
 };
 
 /** Payload of a datafeed packet with logic data */
 class SR_API Logic :
-       public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>,
+       public ParentOwned<Logic, Packet>,
        public PacketPayload
 {
 public:
@@ -769,13 +747,16 @@ public:
 private:
        explicit Logic(const struct sr_datafeed_logic *structure);
        ~Logic();
-       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
+       shared_ptr<PacketPayload> share_owned_by(shared_ptr<Packet> parent);
+
+       const struct sr_datafeed_logic *_structure;
+
        friend class Packet;
 };
 
 /** Payload of a datafeed packet with analog data */
 class SR_API Analog :
-       public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>,
+       public ParentOwned<Analog, Packet>,
        public PacketPayload
 {
 public:
@@ -794,13 +775,16 @@ public:
 private:
        explicit Analog(const struct sr_datafeed_analog *structure);
        ~Analog();
-       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
+       shared_ptr<PacketPayload> share_owned_by(shared_ptr<Packet> parent);
+
+       const struct sr_datafeed_analog *_structure;
+
        friend class Packet;
 };
 
 /** An input format supported by the library */
 class SR_API InputFormat :
-       public ParentOwned<InputFormat, Context, const struct sr_input_module>
+       public ParentOwned<InputFormat, Context>
 {
 public:
        /** Name of this input format. */
@@ -818,12 +802,16 @@ public:
 private:
        explicit InputFormat(const struct sr_input_module *structure);
        ~InputFormat();
+
+       const struct sr_input_module *_structure;
+
        friend class Context;
        friend class InputDevice;
+       friend class std::default_delete<InputFormat>;
 };
 
 /** An input instance (an input format applied to a file or stream) */
-class SR_API Input : public UserOwned<Input, const struct sr_input>
+class SR_API Input : public UserOwned<Input>
 {
 public:
        /** Virtual device associated with this input. */
@@ -837,16 +825,18 @@ public:
 private:
        Input(shared_ptr<Context> context, const struct sr_input *structure);
        ~Input();
+       const struct sr_input *_structure;
        shared_ptr<Context> _context;
-       InputDevice *_device;
-       friend class Deleter;
+       unique_ptr<InputDevice> _device;
+
        friend class Context;
        friend class InputFormat;
+       friend class std::default_delete<Input>;
 };
 
 /** A virtual device associated with an input */
 class SR_API InputDevice :
-       public ParentOwned<InputDevice, Input, struct sr_dev_inst>,
+       public ParentOwned<InputDevice, Input>,
        public Device
 {
 private:
@@ -855,10 +845,11 @@ private:
        shared_ptr<Device> get_shared_from_this();
        shared_ptr<Input> _input;
        friend class Input;
+       friend class std::default_delete<InputDevice>;
 };
 
 /** An option used by an output format */
-class SR_API Option : public UserOwned<Option, const struct sr_option>
+class SR_API Option : public UserOwned<Option>
 {
 public:
        /** Short name of this option suitable for command line usage. */
@@ -875,15 +866,17 @@ private:
        Option(const struct sr_option *structure,
                shared_ptr<const struct sr_option *> structure_array);
        ~Option();
+       const struct sr_option *_structure;
        shared_ptr<const struct sr_option *> _structure_array;
-       friend class Deleter;
+
        friend class InputFormat;
        friend class OutputFormat;
+       friend class std::default_delete<Option>;
 };
 
 /** An output format supported by the library */
 class SR_API OutputFormat :
-       public ParentOwned<OutputFormat, Context, const struct sr_output_module>
+       public ParentOwned<OutputFormat, Context>
 {
 public:
        /** Name of this output format. */
@@ -918,12 +911,16 @@ public:
 private:
        explicit OutputFormat(const struct sr_output_module *structure);
        ~OutputFormat();
+
+       const struct sr_output_module *_structure;
+
        friend class Context;
        friend class Output;
+       friend class std::default_delete<OutputFormat>;
 };
 
 /** An output instance (an output format applied to a device) */
-class SR_API Output : public UserOwned<Output, const struct sr_output>
+class SR_API Output : public UserOwned<Output>
 {
 public:
        /** Update output with data from the given packet.
@@ -936,11 +933,14 @@ private:
        Output(string filename, shared_ptr<OutputFormat> format,
                shared_ptr<Device> device, const map<string, Glib::VariantBase> &options);
        ~Output();
+
+       const struct sr_output *_structure;
        const shared_ptr<OutputFormat> _format;
        const shared_ptr<Device> _device;
        const map<string, Glib::VariantBase> _options;
-       friend class Deleter;
+
        friend class OutputFormat;
+       friend class std::default_delete<Output>;
 };
 
 /** Base class for objects which wrap an enumeration value from libsigrok */