C++: Make StructureWrapper a recurring template, eliminating lots of casts.

This commit is contained in:
Martin Ling 2014-09-02 20:30:50 +01:00 committed by Bert Vermeulen
parent ba4eac48d4
commit bf52cc8cf2
2 changed files with 48 additions and 71 deletions

View File

@ -108,8 +108,7 @@ map<string, shared_ptr<Driver>> Context::get_drivers()
{ {
auto name = entry.first; auto name = entry.first;
auto driver = entry.second; auto driver = entry.second;
result[name] = static_pointer_cast<Driver>( result[name] = driver->get_shared_pointer(this);
driver->get_shared_pointer(this));
} }
return result; return result;
} }
@ -121,8 +120,7 @@ map<string, shared_ptr<InputFormat>> Context::get_input_formats()
{ {
auto name = entry.first; auto name = entry.first;
auto input_format = entry.second; auto input_format = entry.second;
result[name] = static_pointer_cast<InputFormat>( result[name] = input_format->get_shared_pointer(this);
input_format->get_shared_pointer(this));
} }
return result; return result;
} }
@ -134,8 +132,7 @@ map<string, shared_ptr<OutputFormat>> Context::get_output_formats()
{ {
auto name = entry.first; auto name = entry.first;
auto output_format = entry.second; auto output_format = entry.second;
result[name] = static_pointer_cast<OutputFormat>( result[name] = output_format->get_shared_pointer(this);
output_format->get_shared_pointer(this));
} }
return result; return result;
} }
@ -315,8 +312,7 @@ vector<shared_ptr<HardwareDevice>> Driver::scan(
/* Create list of shared pointers to device instances for return. */ /* Create list of shared pointers to device instances for return. */
vector<shared_ptr<HardwareDevice>> result; vector<shared_ptr<HardwareDevice>> result;
for (auto device : devices) for (auto device : devices)
result.push_back(static_pointer_cast<HardwareDevice>( result.push_back(device->get_shared_pointer(parent));
device->get_shared_pointer(parent)));
return result; return result;
} }
@ -417,15 +413,13 @@ vector<shared_ptr<Channel>> Device::get_channels()
{ {
vector<shared_ptr<Channel>> result; vector<shared_ptr<Channel>> result;
for (auto entry : channels) for (auto entry : channels)
result.push_back(static_pointer_cast<Channel>( result.push_back(entry.second->get_shared_pointer(get_shared_from_this()));
entry.second->get_shared_pointer(get_shared_from_this())));
return result; return result;
} }
shared_ptr<Channel> Device::get_channel(struct sr_channel *ptr) shared_ptr<Channel> Device::get_channel(struct sr_channel *ptr)
{ {
return static_pointer_cast<Channel>( return channels[ptr]->get_shared_pointer(get_shared_from_this());
channels[ptr]->get_shared_pointer(get_shared_from_this()));
} }
map<string, shared_ptr<ChannelGroup>> map<string, shared_ptr<ChannelGroup>>
@ -436,8 +430,7 @@ Device::get_channel_groups()
{ {
auto name = entry.first; auto name = entry.first;
auto channel_group = entry.second; auto channel_group = entry.second;
result[name] = static_pointer_cast<ChannelGroup>( result[name] = channel_group->get_shared_pointer(get_shared_from_this());
channel_group->get_shared_pointer(get_shared_from_this()));
} }
return result; return result;
} }
@ -465,13 +458,12 @@ HardwareDevice::~HardwareDevice()
shared_ptr<Device> HardwareDevice::get_shared_from_this() shared_ptr<Device> HardwareDevice::get_shared_from_this()
{ {
return static_pointer_cast<Device>( return static_pointer_cast<Device>(shared_from_this());
static_pointer_cast<HardwareDevice>(shared_from_this()));
} }
shared_ptr<Driver> HardwareDevice::get_driver() 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) : Channel::Channel(struct sr_channel *structure) :
@ -536,8 +528,7 @@ vector<shared_ptr<Channel>> ChannelGroup::get_channels()
{ {
vector<shared_ptr<Channel>> result; vector<shared_ptr<Channel>> result;
for (auto channel : channels) for (auto channel : channels)
result.push_back(static_pointer_cast<Channel>( result.push_back(channel->get_shared_pointer(parent));
channel->get_shared_pointer(parent)));
return result; return result;
} }
@ -565,8 +556,7 @@ vector<shared_ptr<TriggerStage>> Trigger::get_stages()
{ {
vector<shared_ptr<TriggerStage>> result; vector<shared_ptr<TriggerStage>> result;
for (auto stage : stages) for (auto stage : stages)
result.push_back(static_pointer_cast<TriggerStage>( result.push_back(stage->get_shared_pointer(this));
stage->get_shared_pointer(this)));
return result; return result;
} }
@ -574,8 +564,7 @@ shared_ptr<TriggerStage> Trigger::add_stage()
{ {
auto stage = new TriggerStage(sr_trigger_stage_add(structure)); auto stage = new TriggerStage(sr_trigger_stage_add(structure));
stages.push_back(stage); stages.push_back(stage);
return static_pointer_cast<TriggerStage>( return stage->get_shared_pointer(this);
stage->get_shared_pointer(this));
} }
TriggerStage::TriggerStage(struct sr_trigger_stage *structure) : TriggerStage::TriggerStage(struct sr_trigger_stage *structure) :
@ -598,8 +587,7 @@ vector<shared_ptr<TriggerMatch>> TriggerStage::get_matches()
{ {
vector<shared_ptr<TriggerMatch>> result; vector<shared_ptr<TriggerMatch>> result;
for (auto match : matches) for (auto match : matches)
result.push_back(static_pointer_cast<TriggerMatch>( result.push_back(match->get_shared_pointer(this));
match->get_shared_pointer(this)));
return result; return result;
} }
@ -1018,9 +1006,7 @@ Header::~Header()
shared_ptr<PacketPayload> Header::get_shared_pointer(Packet *parent) shared_ptr<PacketPayload> Header::get_shared_pointer(Packet *parent)
{ {
return static_pointer_cast<PacketPayload>( return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
static_pointer_cast<Header>(
StructureWrapper::get_shared_pointer(parent)));
} }
int Header::get_feed_version() int Header::get_feed_version()
@ -1047,9 +1033,7 @@ Meta::~Meta()
shared_ptr<PacketPayload> Meta::get_shared_pointer(Packet *parent) shared_ptr<PacketPayload> Meta::get_shared_pointer(Packet *parent)
{ {
return static_pointer_cast<PacketPayload>( return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
static_pointer_cast<Meta>(
StructureWrapper::get_shared_pointer(parent)));
} }
map<const ConfigKey *, Glib::VariantBase> Meta::get_config() map<const ConfigKey *, Glib::VariantBase> Meta::get_config()
@ -1075,9 +1059,7 @@ Logic::~Logic()
shared_ptr<PacketPayload> Logic::get_shared_pointer(Packet *parent) shared_ptr<PacketPayload> Logic::get_shared_pointer(Packet *parent)
{ {
return static_pointer_cast<PacketPayload>( return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
static_pointer_cast<Logic>(
StructureWrapper::get_shared_pointer(parent)));
} }
void *Logic::get_data_pointer() void *Logic::get_data_pointer()
@ -1107,9 +1089,7 @@ Analog::~Analog()
shared_ptr<PacketPayload> Analog::get_shared_pointer(Packet *parent) shared_ptr<PacketPayload> Analog::get_shared_pointer(Packet *parent)
{ {
return static_pointer_cast<PacketPayload>( return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
static_pointer_cast<Analog>(
StructureWrapper::get_shared_pointer(parent)));
} }
float *Analog::get_data_pointer() float *Analog::get_data_pointer()
@ -1204,8 +1184,7 @@ shared_ptr<InputDevice> Input::get_device()
device = new InputDevice(shared_from_this(), sdi); device = new InputDevice(shared_from_this(), sdi);
} }
return static_pointer_cast<InputDevice>( return device->get_shared_pointer(shared_from_this());
device->get_shared_pointer(shared_from_this()));
} }
void Input::send(string data) void Input::send(string data)
@ -1237,8 +1216,7 @@ InputDevice::~InputDevice()
shared_ptr<Device> InputDevice::get_shared_from_this() shared_ptr<Device> InputDevice::get_shared_from_this()
{ {
return static_pointer_cast<Device>( return static_pointer_cast<Device>(shared_from_this());
static_pointer_cast<InputDevice>(shared_from_this()));
} }
Option::Option(const struct sr_option *structure, Option::Option(const struct sr_option *structure,
@ -1315,9 +1293,7 @@ shared_ptr<Output> OutputFormat::create_output(
shared_ptr<Device> device, map<string, Glib::VariantBase> options) shared_ptr<Device> device, map<string, Glib::VariantBase> options)
{ {
return shared_ptr<Output>( return shared_ptr<Output>(
new Output( new Output(shared_from_this(), device, options),
static_pointer_cast<OutputFormat>(shared_from_this()),
device, options),
Output::Deleter()); Output::Deleter());
} }

View File

@ -125,7 +125,8 @@ public:
}; };
/* Base template for most classes which wrap a struct type from libsigrok. */ /* Base template for most classes which wrap a struct type from libsigrok. */
template <class Parent, typename Struct> class SR_API StructureWrapper template <class Class, class Parent, typename Struct>
class SR_API StructureWrapper
{ {
protected: protected:
/* Parent object which owns this child object's underlying structure. /* Parent object which owns this child object's underlying structure.
@ -144,26 +145,24 @@ protected:
shared_ptr<Parent> parent; shared_ptr<Parent> parent;
/* Weak pointer for shared_from_this() implementation. */ /* Weak pointer for shared_from_this() implementation. */
weak_ptr<StructureWrapper<Parent, Struct> > weak_this; weak_ptr<Class> weak_this;
public: public:
/* Note, this implementation will create a new smart_ptr if none exists. */ /* Note, this implementation will create a new smart_ptr if none exists. */
shared_ptr<StructureWrapper<Parent, Struct> > shared_from_this() shared_ptr<Class> shared_from_this()
{ {
shared_ptr<StructureWrapper<Parent, Struct> > shared; shared_ptr<Class> shared;
if (!(shared = weak_this.lock())) if (!(shared = weak_this.lock()))
{ {
shared = shared_ptr<StructureWrapper<Parent, Struct> >( shared = shared_ptr<Class>((Class *) this, reset_parent);
this, reset_parent);
weak_this = shared; weak_this = shared;
} }
return shared; return shared;
} }
shared_ptr<StructureWrapper<Parent, Struct> > shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent)
get_shared_pointer(shared_ptr<Parent> parent)
{ {
if (!parent) if (!parent)
throw Error(SR_ERR_BUG); throw Error(SR_ERR_BUG);
@ -171,16 +170,14 @@ public:
return shared_from_this(); return shared_from_this();
} }
shared_ptr<StructureWrapper<Parent, Struct> > shared_ptr<Class> get_shared_pointer(Parent *parent)
get_shared_pointer(Parent *parent)
{ {
if (!parent) if (!parent)
throw Error(SR_ERR_BUG); throw Error(SR_ERR_BUG);
return get_shared_pointer(static_pointer_cast<Parent>( return get_shared_pointer(parent->shared_from_this());
parent->shared_from_this()));
} }
protected: protected:
static void reset_parent(StructureWrapper<Parent, Struct> *object) static void reset_parent(Class *object)
{ {
if (!object->parent) if (!object->parent)
throw Error(SR_ERR_BUG); throw Error(SR_ERR_BUG);
@ -189,7 +186,7 @@ protected:
Struct *structure; Struct *structure;
StructureWrapper<Parent, Struct>(Struct *structure) : StructureWrapper<Class, Parent, Struct>(Struct *structure) :
structure(structure) structure(structure)
{ {
} }
@ -264,7 +261,8 @@ protected:
}; };
/** A hardware driver provided by the library */ /** A hardware driver provided by the library */
class SR_API Driver : public StructureWrapper<Context, struct sr_dev_driver> class SR_API Driver :
public StructureWrapper<Driver, Context, struct sr_dev_driver>
{ {
public: public:
/** Name of this driver. */ /** Name of this driver. */
@ -354,7 +352,7 @@ protected:
/** A real hardware device, connected via a driver */ /** A real hardware device, connected via a driver */
class SR_API HardwareDevice : class SR_API HardwareDevice :
public StructureWrapper<Context, struct sr_dev_inst>, public StructureWrapper<HardwareDevice, Context, struct sr_dev_inst>,
public Device public Device
{ {
public: public:
@ -370,7 +368,8 @@ protected:
}; };
/** A channel on a device */ /** A channel on a device */
class SR_API Channel : public StructureWrapper<Device, struct sr_channel> class SR_API Channel :
public StructureWrapper<Channel, Device, struct sr_channel>
{ {
public: public:
/** Current name of this channel. */ /** Current name of this channel. */
@ -399,7 +398,7 @@ protected:
/** A group of channels on a device, which share some configuration */ /** A group of channels on a device, which share some configuration */
class SR_API ChannelGroup : class SR_API ChannelGroup :
public StructureWrapper<Device, struct sr_channel_group>, public StructureWrapper<ChannelGroup, Device, struct sr_channel_group>,
public Configurable public Configurable
{ {
public: public:
@ -441,7 +440,8 @@ protected:
}; };
/** A stage in a trigger configuration */ /** A stage in a trigger configuration */
class SR_API TriggerStage : public StructureWrapper<Trigger, struct sr_trigger_stage> class SR_API TriggerStage :
public StructureWrapper<TriggerStage, Trigger, struct sr_trigger_stage>
{ {
public: public:
/** Index number of this stage. */ /** Index number of this stage. */
@ -465,7 +465,8 @@ protected:
}; };
/** A match condition in a trigger configuration */ /** A match condition in a trigger configuration */
class SR_API TriggerMatch : public StructureWrapper<TriggerStage, struct sr_trigger_match> class SR_API TriggerMatch :
public StructureWrapper<TriggerMatch, TriggerStage, struct sr_trigger_match>
{ {
public: public:
/** Channel this condition matches on. */ /** Channel this condition matches on. */
@ -681,7 +682,7 @@ protected:
/** Payload of a datafeed header packet */ /** Payload of a datafeed header packet */
class SR_API Header : class SR_API Header :
public StructureWrapper<Packet, const struct sr_datafeed_header>, public StructureWrapper<Header, Packet, const struct sr_datafeed_header>,
public PacketPayload public PacketPayload
{ {
public: public:
@ -698,7 +699,7 @@ protected:
/** Payload of a datafeed metadata packet */ /** Payload of a datafeed metadata packet */
class SR_API Meta : class SR_API Meta :
public StructureWrapper<Packet, const struct sr_datafeed_meta>, public StructureWrapper<Meta, Packet, const struct sr_datafeed_meta>,
public PacketPayload public PacketPayload
{ {
public: public:
@ -714,7 +715,7 @@ protected:
/** Payload of a datafeed packet with logic data */ /** Payload of a datafeed packet with logic data */
class SR_API Logic : class SR_API Logic :
public StructureWrapper<Packet, const struct sr_datafeed_logic>, public StructureWrapper<Logic, Packet, const struct sr_datafeed_logic>,
public PacketPayload public PacketPayload
{ {
public: public:
@ -733,7 +734,7 @@ protected:
/** Payload of a datafeed packet with analog data */ /** Payload of a datafeed packet with analog data */
class SR_API Analog : class SR_API Analog :
public StructureWrapper<Packet, const struct sr_datafeed_analog>, public StructureWrapper<Analog, Packet, const struct sr_datafeed_analog>,
public PacketPayload public PacketPayload
{ {
public: public:
@ -758,7 +759,7 @@ protected:
/** An input format supported by the library */ /** An input format supported by the library */
class SR_API InputFormat : class SR_API InputFormat :
public StructureWrapper<Context, const struct sr_input_module> public StructureWrapper<InputFormat, Context, const struct sr_input_module>
{ {
public: public:
/** Name of this input format. */ /** Name of this input format. */
@ -805,7 +806,7 @@ protected:
/** A virtual device associated with an input */ /** A virtual device associated with an input */
class SR_API InputDevice : class SR_API InputDevice :
public StructureWrapper<Input, struct sr_dev_inst>, public StructureWrapper<InputDevice, Input, struct sr_dev_inst>,
public Device public Device
{ {
protected: protected:
@ -856,7 +857,7 @@ protected:
/** An output format supported by the library */ /** An output format supported by the library */
class SR_API OutputFormat : class SR_API OutputFormat :
public StructureWrapper<Context, const struct sr_output_module> public StructureWrapper<OutputFormat, Context, const struct sr_output_module>
{ {
public: public:
/** Name of this output format. */ /** Name of this output format. */