]> sigrok.org Git - libsigrok.git/blobdiff - bindings/cxx/include/libsigrok/libsigrok.hpp
C++: Rename StructureWrapper to ParentOwned.
[libsigrok.git] / bindings / cxx / include / libsigrok / libsigrok.hpp
index 6595802e9c3e8d121043203566a50a6543be714c..0c77c9069c0e3c61cb3932b9004cfbf9bae80e45 100644 (file)
@@ -124,9 +124,9 @@ public:
        const char *what() const throw();
 };
 
-/* Base template for most classes which wrap a struct type from libsigrok. */
-template <class Parent, typename Struct> class SR_API StructureWrapper :
-       public enable_shared_from_this<StructureWrapper<Parent, Struct> >
+/* Base template for classes whose resources are owned by a parent object. */
+template <class Class, class Parent, typename Struct>
+class SR_API ParentOwned
 {
 protected:
        /*  Parent object which owns this child object's underlying structure.
@@ -144,30 +144,49 @@ protected:
                references to both the parent and all its children are gone. */
        shared_ptr<Parent> parent;
 
+       /* Weak pointer for shared_from_this() implementation. */
+       weak_ptr<Class> weak_this;
+
 public:
-       shared_ptr<StructureWrapper<Parent, Struct> >
-       get_shared_pointer(Parent *parent)
+       /* Note, this implementation will create a new smart_ptr if none exists. */
+       shared_ptr<Class> shared_from_this()
        {
-               this->parent = static_pointer_cast<Parent>(parent->shared_from_this());
-               return shared_ptr<StructureWrapper<Parent, Struct> >(
-                       this, reset_parent);
+               shared_ptr<Class> shared;
+
+               if (!(shared = weak_this.lock()))
+               {
+                       shared = shared_ptr<Class>((Class *) this, reset_parent);
+                       weak_this = shared;
+               }
+
+               return shared;
        }
-       shared_ptr<StructureWrapper<Parent, Struct> >
-       get_shared_pointer(shared_ptr<Parent> parent)
+
+       shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent)
        {
+               if (!parent)
+                       throw Error(SR_ERR_BUG);
                this->parent = parent;
-               return shared_ptr<StructureWrapper<Parent, Struct> >(
-                       this, reset_parent);
+               return shared_from_this();
+       }
+
+       shared_ptr<Class> get_shared_pointer(Parent *parent)
+       {
+               if (!parent)
+                       throw Error(SR_ERR_BUG);
+               return get_shared_pointer(parent->shared_from_this());
        }
 protected:
-       static void reset_parent(StructureWrapper<Parent, Struct> *object)
+       static void reset_parent(Class *object)
        {
+               if (!object->parent)
+                       throw Error(SR_ERR_BUG);
                object->parent.reset();
        }
 
        Struct *structure;
 
-       StructureWrapper<Parent, Struct>(Struct *structure) :
+       ParentOwned<Class, Parent, Struct>(Struct *structure) :
                structure(structure)
        {
        }
@@ -242,7 +261,8 @@ protected:
 };
 
 /** A hardware driver provided by the library */
-class SR_API Driver : public StructureWrapper<Context, struct sr_dev_driver>
+class SR_API Driver :
+       public ParentOwned<Driver, Context, struct sr_dev_driver>
 {
 public:
        /** Name of this driver. */
@@ -332,7 +352,7 @@ protected:
 
 /** A real hardware device, connected via a driver */
 class SR_API HardwareDevice :
-       public StructureWrapper<Context, struct sr_dev_inst>,
+       public ParentOwned<HardwareDevice, Context, struct sr_dev_inst>,
        public Device
 {
 public:
@@ -348,7 +368,8 @@ protected:
 };
 
 /** A channel on a device */
-class SR_API Channel : public StructureWrapper<Device, struct sr_channel>
+class SR_API Channel :
+       public ParentOwned<Channel, Device, struct sr_channel>
 {
 public:
        /** Current name of this channel. */
@@ -377,7 +398,7 @@ protected:
 
 /** A group of channels on a device, which share some configuration */
 class SR_API ChannelGroup :
-       public StructureWrapper<Device, struct sr_channel_group>,
+       public ParentOwned<ChannelGroup, Device, struct sr_channel_group>,
        public Configurable
 {
 public:
@@ -419,7 +440,8 @@ protected:
 };
 
 /** A stage in a trigger configuration */
-class SR_API TriggerStage : public StructureWrapper<Trigger, struct sr_trigger_stage>
+class SR_API TriggerStage :
+       public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage>
 {
 public:
        /** Index number of this stage. */
@@ -443,7 +465,8 @@ protected:
 };
 
 /** A match condition in a trigger configuration  */
-class SR_API TriggerMatch : public StructureWrapper<TriggerStage, struct sr_trigger_match>
+class SR_API TriggerMatch :
+       public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match>
 {
 public:
        /** Channel this condition matches on. */
@@ -645,9 +668,7 @@ class SR_API PacketPayload
 protected:
        PacketPayload();
        virtual ~PacketPayload() = 0;
-       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) {
-               return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
-       }
+       virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0;
        /** Deleter needed to allow shared_ptr use with protected destructor. */
        class Deleter
        {
@@ -660,8 +681,9 @@ protected:
 };
 
 /** Payload of a datafeed header packet */
-class SR_API Header : public PacketPayload,
-       public StructureWrapper<Packet, const struct sr_datafeed_header>
+class SR_API Header :
+       public ParentOwned<Header, Packet, const struct sr_datafeed_header>,
+       public PacketPayload
 {
 public:
        /* Feed version number. */
@@ -671,13 +693,14 @@ public:
 protected:
        Header(const struct sr_datafeed_header *structure);
        ~Header();
-       const struct sr_datafeed_header *structure;
+       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        friend class Packet;
 };
 
 /** Payload of a datafeed metadata packet */
-class SR_API Meta : public PacketPayload,
-       public StructureWrapper<Packet, const struct sr_datafeed_meta>
+class SR_API Meta :
+       public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>,
+       public PacketPayload
 {
 public:
        /* Mapping of (ConfigKey, value) pairs. */
@@ -685,14 +708,15 @@ public:
 protected:
        Meta(const struct sr_datafeed_meta *structure);
        ~Meta();
-       const struct sr_datafeed_meta *structure;
+       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        map<const ConfigKey *, Glib::VariantBase> config;
        friend class Packet;
 };
 
 /** Payload of a datafeed packet with logic data */
-class SR_API Logic : public PacketPayload,
-       public StructureWrapper<Packet, const struct sr_datafeed_logic>
+class SR_API Logic :
+       public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>,
+       public PacketPayload
 {
 public:
        /* Pointer to data. */
@@ -704,13 +728,14 @@ public:
 protected:
        Logic(const struct sr_datafeed_logic *structure);
        ~Logic();
-       const struct sr_datafeed_logic *structure;
+       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        friend class Packet;
 };
 
 /** Payload of a datafeed packet with analog data */
-class SR_API Analog : public PacketPayload,
-       public StructureWrapper<Packet, const struct sr_datafeed_analog>
+class SR_API Analog :
+       public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>,
+       public PacketPayload
 {
 public:
        /** Pointer to data. */
@@ -728,13 +753,13 @@ public:
 protected:
        Analog(const struct sr_datafeed_analog *structure);
        ~Analog();
-       const struct sr_datafeed_analog *structure;
+       shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        friend class Packet;
 };
 
 /** An input format supported by the library */
 class SR_API InputFormat :
-       public StructureWrapper<Context, const struct sr_input_module>
+       public ParentOwned<InputFormat, Context, const struct sr_input_module>
 {
 public:
        /** Name of this input format. */
@@ -765,7 +790,6 @@ public:
 protected:
        Input(shared_ptr<Context> context, const struct sr_input *structure);
        ~Input();
-       shared_ptr<Device> get_shared_from_this();
        const struct sr_input *structure;
        shared_ptr<Context> context;
        InputDevice *device;
@@ -782,7 +806,7 @@ protected:
 
 /** A virtual device associated with an input */
 class SR_API InputDevice :
-       public StructureWrapper<Input, struct sr_dev_inst>,
+       public ParentOwned<InputDevice, Input, struct sr_dev_inst>,
        public Device
 {
 protected:
@@ -833,7 +857,7 @@ protected:
 
 /** An output format supported by the library */
 class SR_API OutputFormat :
-       public StructureWrapper<Context, const struct sr_output_module>
+       public ParentOwned<OutputFormat, Context, const struct sr_output_module>
 {
 public:
        /** Name of this output format. */