X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fcxx%2Finclude%2Flibsigrokcxx%2Flibsigrokcxx.hpp;h=d8cf3bdc3f62b449e18bf58ad25968ea8f096ffa;hb=014512254abcc74d203376f2e038053b94cf1116;hp=f8e0bf4b935eb42987df52e5ff9c90d6b27c8f48;hpb=b6ab954d67b584af662323ae79ae6da0fbd3a588;p=libsigrok.git

diff --git a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
index f8e0bf4b..d8cf3bdc 100644
--- a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
+++ b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
@@ -71,7 +71,12 @@ raised, which provides access to the error code and description.
 #define LIBSIGROKCXX_HPP
 
 #include <libsigrok/libsigrok.h>
+
+/* Suppress warnings due to glibmm's use of std::auto_ptr<> in a public
+ * header file. To be removed once glibmm is fixed. */
+G_GNUC_BEGIN_IGNORE_DEPRECATIONS
 #include <glibmm.h>
+G_GNUC_END_IGNORE_DEPRECATIONS
 
 #include <stdexcept>
 #include <memory>
@@ -127,7 +132,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,12 +162,7 @@ protected:
 		references to both the parent and all its children are gone. */
 	shared_ptr<Parent> _parent;
 
-	Struct *_structure;
-
-	explicit ParentOwned(Struct *structure) :
-		_structure(structure)
-	{
-	}
+	ParentOwned() {}
 
 	/* Note, this implementation will create a new smart_ptr if none exists. */
 	shared_ptr<Class> shared_from_this()
@@ -195,16 +195,11 @@ public:
 };
 
 /* 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>
 {
 protected:
-	Struct *_structure;
-
-	explicit UserOwned(Struct *structure) :
-		_structure(structure)
-	{
-	}
+	UserOwned() {}
 
 	shared_ptr<Class> shared_from_this()
 	{
@@ -213,13 +208,6 @@ protected:
 			throw Error(SR_ERR_BUG);
 		return shared;
 	}
-
-	/* Deleter needed to allow shared_ptr use with protected destructor. */
-	class Deleter
-	{
-	public:
-		void operator()(Class *object) { delete object; }
-	};
 };
 
 /** Type of log callback */
@@ -249,7 +237,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 */
@@ -286,15 +274,15 @@ public:
 	shared_ptr<Packet> create_header_packet(Glib::TimeVal start_time);
 	/** Create a meta packet. */
 	shared_ptr<Packet> create_meta_packet(
-		const map<const ConfigKey *, Glib::VariantBase> &config);
+		map<const ConfigKey *, Glib::VariantBase> config);
 	/** Create a logic packet. */
 	shared_ptr<Packet> create_logic_packet(
 		void *data_pointer, size_t data_length, unsigned int unit_size);
 	/** Create an analog packet. */
 	shared_ptr<Packet> create_analog_packet(
-		const vector<shared_ptr<Channel> > &channels,
+		vector<shared_ptr<Channel> > channels,
 		float *data_pointer, unsigned int num_samples, const Quantity *mq,
-		const Unit *unit, const vector<const QuantityFlag *> &mqflags);
+		const Unit *unit, vector<const QuantityFlag *> mqflags);
 	/** Load a saved session.
 	 * @param filename File name string. */
 	shared_ptr<Session> load_session(string filename);
@@ -309,16 +297,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 struct std::default_delete<Context>;
 };
 
 enum Capability {
@@ -342,7 +331,7 @@ public:
 	 * @param key ConfigKey to enumerate values for. */
 	Glib::VariantContainerBase config_list(const ConfigKey *key) const;
 	/** Enumerate available keys, according to a given index key. */
-	map<const ConfigKey *, set<Capability> > config_keys(const ConfigKey *key);
+	map<const ConfigKey *, set<enum Capability> > config_keys(const ConfigKey *key);
 	/** Check for a key in the list from a given index key. */
 	bool config_check(const ConfigKey *key, const ConfigKey *index_key) const;
 protected:
@@ -358,7 +347,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:
@@ -368,9 +357,10 @@ public:
 	string long_name() const;
 	/** Scan for devices and return a list of devices found.
 	 * @param options Mapping of (ConfigKey, value) pairs. */
-	vector<shared_ptr<HardwareDevice> > scan(
-		const map<const ConfigKey *, Glib::VariantBase> &options = {});
+	vector<shared_ptr<HardwareDevice> > scan(map<const ConfigKey *, Glib::VariantBase>
+			options = map<const ConfigKey *, Glib::VariantBase>());
 private:
+	struct sr_dev_driver *_structure;
 	bool _initialized;
 	vector<HardwareDevice *> _devices;
 	explicit Driver(struct sr_dev_driver *structure);
@@ -378,6 +368,7 @@ private:
 	friend class Context;
 	friend class HardwareDevice;
 	friend class ChannelGroup;
+	friend struct std::default_delete<Driver>;
 };
 
 /** A generic device, either hardware or virtual */
@@ -409,26 +400,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 struct 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:
@@ -439,20 +425,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 struct 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:
@@ -462,19 +443,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 struct 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. */
@@ -494,6 +470,7 @@ public:
 private:
 	explicit Channel(struct sr_channel *structure);
 	~Channel();
+	struct sr_channel *_structure;
 	const ChannelType * const _type;
 	friend class Device;
 	friend class UserDevice;
@@ -501,11 +478,12 @@ private:
 	friend class Session;
 	friend class TriggerStage;
 	friend class Context;
+	friend struct 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:
@@ -514,14 +492,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 struct 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. */
@@ -533,16 +512,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 struct 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. */
@@ -559,15 +539,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 struct 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. */
@@ -579,8 +561,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 struct std::default_delete<TriggerMatch>;
 };
 
 /** Type of session stopped callback */
@@ -606,25 +590,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 struct 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.
@@ -663,21 +642,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 struct 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. */
@@ -688,9 +669,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;
@@ -699,6 +681,7 @@ private:
 	friend class Logic;
 	friend class Analog;
 	friend class Context;
+	friend struct std::default_delete<Packet>;
 };
 
 /** Abstract base class for datafeed packet payloads */
@@ -710,20 +693,14 @@ protected:
 private:
 	virtual shared_ptr<PacketPayload> share_owned_by(shared_ptr<Packet> parent) = 0;
 
-	/** Deleter needed to allow shared_ptr use with protected destructor. */
-	class Deleter
-	{
-	public:
-		void operator()(PacketPayload *payload) { delete payload; }
-	};
-	friend class Deleter;
 	friend class Packet;
 	friend class Output;
+	friend struct 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:
@@ -735,12 +712,15 @@ private:
 	explicit Header(const struct sr_datafeed_header *structure);
 	~Header();
 	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:
@@ -750,13 +730,16 @@ private:
 	explicit Meta(const struct sr_datafeed_meta *structure);
 	~Meta();
 	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:
@@ -770,12 +753,15 @@ private:
 	explicit Logic(const struct sr_datafeed_logic *structure);
 	~Logic();
 	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:
@@ -795,12 +781,15 @@ private:
 	explicit Analog(const struct sr_datafeed_analog *structure);
 	~Analog();
 	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. */
@@ -814,16 +803,21 @@ public:
 	map<string, shared_ptr<Option> > options();
 	/** Create an input using this input format.
 	 * @param options Mapping of (option name, value) pairs. */
-	shared_ptr<Input> create_input(const map<string, Glib::VariantBase> &options = {});
+	shared_ptr<Input> create_input(map<string, Glib::VariantBase>
+			options = map<string, Glib::VariantBase>());
 private:
 	explicit InputFormat(const struct sr_input_module *structure);
 	~InputFormat();
+
+	const struct sr_input_module *_structure;
+
 	friend class Context;
 	friend class InputDevice;
+	friend struct 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 +831,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 struct 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 +851,11 @@ private:
 	shared_ptr<Device> get_shared_from_this();
 	shared_ptr<Input> _input;
 	friend class Input;
+	friend struct 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 +872,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 struct 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. */
@@ -898,16 +897,15 @@ public:
 	/** Create an output using this format.
 	 * @param device Device to output for.
 	 * @param options Mapping of (option name, value) pairs. */
-	shared_ptr<Output> create_output(
-		shared_ptr<Device> device,
-		const map<string, Glib::VariantBase> &options = {});
+	shared_ptr<Output> create_output(shared_ptr<Device> device,
+		map<string, Glib::VariantBase> options = map<string, Glib::VariantBase>());
 	/** Create an output using this format.
 	 * @param filename Name of destination file.
 	 * @param device Device to output for.
 	 * @param options Mapping of (option name, value) pairs. */
 	shared_ptr<Output> create_output(string filename,
 		shared_ptr<Device> device,
-		const map<string, Glib::VariantBase> &options = {});
+		map<string, Glib::VariantBase> options = map<string, Glib::VariantBase>());
 	/**
 	 * Checks whether a given flag is set.
 	 * @param flag Flag to check
@@ -918,12 +916,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 struct 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.
@@ -932,15 +934,18 @@ public:
 private:
 	Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
 	Output(shared_ptr<OutputFormat> format,
-		shared_ptr<Device> device, const map<string, Glib::VariantBase> &options);
+		shared_ptr<Device> device, map<string, Glib::VariantBase> options);
 	Output(string filename, shared_ptr<OutputFormat> format,
-		shared_ptr<Device> device, const map<string, Glib::VariantBase> &options);
+		shared_ptr<Device> device, 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 struct std::default_delete<Output>;
 };
 
 /** Base class for objects which wrap an enumeration value from libsigrok */
@@ -986,8 +991,8 @@ private:
 	const string _name;
 };
 
-#include <libsigrokcxx/enums.hpp>
-
 }
 
+#include <libsigrokcxx/enums.hpp>
+
 #endif