X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;ds=inline;f=bindings%2Fcxx%2Finclude%2Flibsigrok%2Flibsigrok.hpp;h=cc57d1a026cd3e470789873fc60a233188b6a578;hb=6e5240f418a8e021a8d1272b6255a8c0f10b5af6;hp=320455978094c367441deee1e499cb1118e6dc60;hpb=2928f47d6404e51c2dda1842c43db578cb1d6cdd;p=libsigrok.git

diff --git a/bindings/cxx/include/libsigrok/libsigrok.hpp b/bindings/cxx/include/libsigrok/libsigrok.hpp
index 32045597..cc57d1a0 100644
--- a/bindings/cxx/include/libsigrok/libsigrok.hpp
+++ b/bindings/cxx/include/libsigrok/libsigrok.hpp
@@ -108,9 +108,11 @@ class SR_API PacketType;
 class SR_API Quantity;
 class SR_API Unit;
 class SR_API QuantityFlag;
-class SR_API InputFileDevice;
+class SR_API Input;
+class SR_API InputDevice;
 class SR_API Output;
 class SR_API DataType;
+class SR_API Option;
 
 /** Exception thrown when an error code is returned by any libsigrok call. */
 class SR_API Error: public exception
@@ -192,22 +194,33 @@ public:
 	map<string, shared_ptr<OutputFormat> > get_output_formats();
 	/** Current log level. */
 	const LogLevel *get_log_level();
-	/** Set the log level. */
+	/** Set the log level.
+	 * @param level LogLevel to use. */
 	void set_log_level(const LogLevel *level);
 	/** Current log domain. */
 	string get_log_domain();
-	/** Set the log domain. */
+	/** Set the log domain.
+	 * @param value Log domain prefix string. */
 	void set_log_domain(string value);
-	/** Set the log callback. */
+	/** Set the log callback.
+	 * @param callback Callback of the form callback(LogLevel, string). */
 	void set_log_callback(LogCallbackFunction callback);
 	/** Set the log callback to the default handler. */
 	void set_log_callback_default();
 	/** Create a new session. */
 	shared_ptr<Session> create_session();
-	/** Load a saved session. */
+	/** Load a saved session.
+	 * @param filename File name string. */
 	shared_ptr<Session> load_session(string filename);
-	/** Create a new trigger. */
+	/** Create a new trigger.
+	 * @param name Name string for new trigger. */
 	shared_ptr<Trigger> create_trigger(string name);
+	/** Open an input file.
+	 * @param filename File name string. */
+	shared_ptr<Input> open_file(string filename);
+	/** Open an input stream based on header data.
+	 * @param header Initial data from stream. */
+	shared_ptr<Input> open_stream(string header);
 protected:
 	struct sr_context *structure;
 	map<string, Driver *> drivers;
@@ -236,7 +249,8 @@ public:
 	string get_name();
 	/** Long name for this driver. */
 	string get_long_name();
-	/** Scan for devices and return a list of devices found. */
+	/** Scan for devices and return a list of devices found.
+	 * @param options Mapping of (ConfigKey, value) pairs. */
 	vector<shared_ptr<HardwareDevice> > scan(
 		map<const ConfigKey *, Glib::VariantBase> options = {});
 protected:
@@ -253,12 +267,16 @@ protected:
 class SR_API Configurable
 {
 public:
-	/** Read configuration for the given key. */
+	/** Read configuration for the given key.
+	 * @param key ConfigKey to read. */
 	Glib::VariantBase config_get(const ConfigKey *key);
-	/** Set configuration for the given key to a specified value. */
+	/** Set configuration for the given key to a specified value.
+	 * @param key ConfigKey to set.
+	 * @param value Value to set. */
 	void config_set(const ConfigKey *key, Glib::VariantBase value);
-	/** Enumerate available values for the given configuration key. */
-	Glib::VariantBase config_list(const ConfigKey *key);
+	/** Enumerate available values for the given configuration key.
+	 * @param key ConfigKey to enumerate values for. */
+	Glib::VariantContainerBase config_list(const ConfigKey *key);
 protected:
 	Configurable(
 		struct sr_dev_driver *driver,
@@ -272,10 +290,12 @@ protected:
 
 /** A generic device, either hardware or virtual */
 class SR_API Device :
-	public Configurable,
-	public StructureWrapper<Context, struct sr_dev_inst>
+	public enable_shared_from_this<Device>,
+	public Configurable
 {
 public:
+	/** Description identifying this device. */
+	string get_description();
 	/** Vendor name for this device. */
 	string get_vendor();
 	/** Model name for this device. */
@@ -284,6 +304,8 @@ public:
 	string get_version();
 	/** List of the channels available on this device. */
 	vector<shared_ptr<Channel> > get_channels();
+	/** Channel groups available on this device, indexed by name. */
+	map<string, shared_ptr<ChannelGroup> > get_channel_groups();
 	/** Open device. */
 	void open();
 	/** Close device. */
@@ -292,7 +314,9 @@ protected:
 	Device(struct sr_dev_inst *structure);
 	~Device();
 	shared_ptr<Channel> get_channel(struct sr_channel *ptr);
+	struct sr_dev_inst *structure;
 	map<struct sr_channel *, Channel *> channels;
+	map<string, ChannelGroup *> channel_groups;
 	/** Deleter needed to allow shared_ptr use with protected destructor. */
 	class Deleter
 	{
@@ -308,18 +332,17 @@ protected:
 };
 
 /** A real hardware device, connected via a driver */
-class SR_API HardwareDevice : public Device
+class SR_API HardwareDevice :
+	public StructureWrapper<Context, struct sr_dev_inst>,
+	public Device
 {
 public:
 	/** Driver providing this device. */
 	shared_ptr<Driver> get_driver();
-	/** Channel groups available on this device, indexed by name. */
-	map<string, shared_ptr<ChannelGroup> > get_channel_groups();
 protected:
 	HardwareDevice(Driver *driver, struct sr_dev_inst *structure);
 	~HardwareDevice();
 	Driver *driver;
-	map<string, ChannelGroup *> channel_groups;
 	friend class Driver;
 	friend class ChannelGroup;
 };
@@ -330,14 +353,18 @@ class SR_API Channel : public StructureWrapper<Device, struct sr_channel>
 public:
 	/** Current name of this channel. */
 	string get_name();
-	/** Set the name of this channel. */
+	/** Set the name of this channel. *
+	 * @param name Name string to set. */
 	void set_name(string name);
 	/** Type of this channel. */
 	const ChannelType *get_type();
 	/** Enabled status of this channel. */
 	bool get_enabled();
-	/** Set the enabled status of this channel. */
+	/** Set the enabled status of this channel.
+	 * @param value Boolean value to set. */
 	void set_enabled(bool value);
+	/** Get the index number of this channel. */
+	unsigned int get_index();
 protected:
 	Channel(struct sr_channel *structure);
 	~Channel();
@@ -350,7 +377,7 @@ protected:
 
 /** A group of channels on a device, which share some configuration */
 class SR_API ChannelGroup :
-	public StructureWrapper<HardwareDevice, struct sr_channel_group>,
+	public StructureWrapper<Device, struct sr_channel_group>,
 	public Configurable
 {
 public:
@@ -359,18 +386,21 @@ public:
 	/** List of the channels in this group. */
 	vector<shared_ptr<Channel> > get_channels();
 protected:
-	ChannelGroup(HardwareDevice *device, struct sr_channel_group *structure);
+	ChannelGroup(Device *device, struct sr_channel_group *structure);
 	~ChannelGroup();
 	vector<Channel *> channels;
-	friend class HardwareDevice;
+	friend class Device;
 };
 
 /** A trigger configuration */
 class SR_API Trigger : public enable_shared_from_this<Trigger>
 {
 public:
+	/** Name of this trigger configuration. */
 	string get_name();
+	/** List of the stages in this trigger. */
 	vector<shared_ptr<TriggerStage> > get_stages();
+	/** Add a new stage to this trigger. */
 	shared_ptr<TriggerStage> add_stage();
 protected:
 	Trigger(shared_ptr<Context> context, string name);
@@ -392,9 +422,18 @@ protected:
 class SR_API TriggerStage : public StructureWrapper<Trigger, struct sr_trigger_stage>
 {
 public:
+	/** Index number of this stage. */
 	int get_number();
+	/** List of match conditions on this stage. */
 	vector<shared_ptr<TriggerMatch> > get_matches();
+	/** Add a new match condition to this stage.
+	 * @param channel Channel to match on.
+	 * @param type TriggerMatchType to apply. */
 	void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
+	/** Add a new match condition to this stage.
+	 * @param channel Channel to match on.
+	 * @param type TriggerMatchType to apply.
+	 * @param value Threshold value. */
 	void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
 protected:
 	vector<TriggerMatch *> matches;
@@ -407,8 +446,11 @@ protected:
 class SR_API TriggerMatch : public StructureWrapper<TriggerStage, struct sr_trigger_match>
 {
 public:
+	/** Channel this condition matches on. */
 	shared_ptr<Channel> get_channel();
+	/** Type of match. */
 	const TriggerMatchType *get_type();
+	/** Threshold value. */
 	float get_value();
 protected:
 	TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
@@ -454,13 +496,24 @@ protected:
 class SR_API EventSource
 {
 public:
-	/** Create an event source from a file descriptor. */
+	/** Create an event source from a file descriptor.
+	 * @param fd File descriptor.
+	 * @param events GLib IOCondition event mask.
+	 * @param timeout Timeout in milliseconds.
+	 * @param callback Callback of the form callback(events) */
 	static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
 		int timeout, SourceCallbackFunction callback);
-	/** Create an event source from a Glib::PollFD */
+	/** Create an event source from a GLib PollFD
+	 * @param pollfd GLib PollFD
+	 * @param timeout Timeout in milliseconds.
+	 * @param callback Callback of the form callback(events) */
 	static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
 		SourceCallbackFunction callback);
-	/** Create an event source from a Glib::IOChannel */
+	/** Create an event source from a GLib IOChannel
+	 * @param channel GLib IOChannel.
+	 * @param events GLib IOCondition event mask.
+	 * @param timeout Timeout in milliseconds.
+	 * @param callback Callback of the form callback(events) */
 	static shared_ptr<EventSource> create(
 		Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
 		int timeout, SourceCallbackFunction callback);
@@ -493,19 +546,23 @@ protected:
 class SR_API Session 
 {
 public:
-	/** Add a device to this session. */
+	/** Add a device to this session.
+	 * @param device Device to add. */
 	void add_device(shared_ptr<Device> device);
 	/** List devices attached to this session. */
 	vector<shared_ptr<Device> > get_devices();
 	/** Remove all devices from this session. */
 	void remove_devices();
-	/** Add a datafeed callback to this session. */
+	/** Add a datafeed callback to this session.
+	 * @param callback Callback of the form callback(Device, Packet). */
 	void add_datafeed_callback(DatafeedCallbackFunction callback);
 	/** Remove all datafeed callbacks from this session. */
 	void remove_datafeed_callbacks();
-	/** Add an event source. */
+	/** Add an I/O event source.
+	 * @param source EventSource to add. */
 	void add_source(shared_ptr<EventSource> source);
-	/** Remove an event source. */
+	/** Remove an event source.
+	 * @param source EventSource to remove. */
 	void remove_source(shared_ptr<EventSource> source);
 	/** Start the session. */
 	void start();
@@ -513,13 +570,18 @@ public:
 	void run();
 	/** Stop the session. */
 	void stop();
-	/** Begin saving session to a file. */
+	/** Begin saving session to a file.
+	 * @param filename File name string. */
 	void begin_save(string filename);
-	/** Append a packet to the session file being saved. */
-	void append(shared_ptr<Device> device, shared_ptr<Packet> packet);
+	/** Append a packet to the session file being saved.
+	 * @param packet Packet to append. */
+	void append(shared_ptr<Packet> packet);
+	/** Append raw logic data to the session file being saved. */
+	void append(void *data, size_t length, unsigned int unit_size);
 	/** Get current trigger setting. */
 	shared_ptr<Trigger> get_trigger();
-	/** Set trigger setting. */
+	/** Set trigger setting.
+	 * @param trigger Trigger object to use. */
 	void set_trigger(shared_ptr<Trigger> trigger);
 protected:
 	Session(shared_ptr<Context> context);
@@ -602,7 +664,9 @@ class SR_API Header : public PacketPayload,
 	public StructureWrapper<Packet, const struct sr_datafeed_header>
 {
 public:
+	/* Feed version number. */
 	int get_feed_version();
+	/* Start time of this session. */
 	Glib::TimeVal get_start_time();
 protected:
 	Header(const struct sr_datafeed_header *structure);
@@ -616,6 +680,7 @@ class SR_API Meta : public PacketPayload,
 	public StructureWrapper<Packet, const struct sr_datafeed_meta>
 {
 public:
+	/* Mapping of (ConfigKey, value) pairs. */
 	map<const ConfigKey *, Glib::VariantBase> get_config();
 protected:
 	Meta(const struct sr_datafeed_meta *structure);
@@ -669,61 +734,118 @@ protected:
 
 /** An input format supported by the library */
 class SR_API InputFormat :
-	public StructureWrapper<Context, struct sr_input_format>
+	public StructureWrapper<Context, const struct sr_input_module>
 {
 public:
 	/** Name of this input format. */
 	string get_name();
 	/** Description of this input format. */
 	string get_description();
-	/** Check whether a given file matches this input format. */
-	bool format_match(string filename);
-	/** Open a file using this input format. */
-	shared_ptr<InputFileDevice> open_file(string filename,
-		map<string, string> options = {});
+	/** Options supported by this input format. */
+	map<string, shared_ptr<Option> > get_options();
+	/** Create an input using this input format.
+	 * @param options Mapping of (option name, value) pairs. */
+	shared_ptr<Input> create_input(map<string, Glib::VariantBase> options = {});
 protected:
-	InputFormat(struct sr_input_format *structure);
+	InputFormat(const struct sr_input_module *structure);
 	~InputFormat();
 	friend class Context;
-	friend class InputFileDevice;
+	friend class InputDevice;
 };
 
-/** A virtual device associated with an input file */
-class SR_API InputFileDevice : public Device
+/** An input instance (an input format applied to a file or stream) */
+class SR_API Input : public enable_shared_from_this<Input>
 {
 public:
-	/** Load data from file. */
-	void load();
+	/** Virtual device associated with this input. */
+	shared_ptr<InputDevice> get_device();
+	/** Send next stream data.
+	 * @param data Next stream data. */
+	void send(string data);
 protected:
-	InputFileDevice(shared_ptr<InputFormat> format,
-		struct sr_input *input, string filename);
-	~InputFileDevice();
-	struct sr_input *input;
-	shared_ptr<InputFormat> format;
-	string filename;
+	Input(shared_ptr<Context> context, const struct sr_input *structure);
+	~Input();
+	const struct sr_input *structure;
+	shared_ptr<Context> context;
+	InputDevice *device;
 	/** Deleter needed to allow shared_ptr use with protected destructor. */
 	class Deleter
 	{
 	public:
-		void operator()(InputFileDevice *device) { delete device; }
+		void operator()(Input *input) { delete input; }
 	};
 	friend class Deleter;
+	friend class Context;
 	friend class InputFormat;
 };
 
+/** A virtual device associated with an input */
+class SR_API InputDevice :
+	public StructureWrapper<Input, struct sr_dev_inst>,
+	public Device
+{
+protected:
+	InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi);
+	~InputDevice();
+	shared_ptr<Input> input;
+	/** Deleter needed to allow shared_ptr use with protected destructor. */
+	class Deleter
+	{
+	public:
+		void operator()(InputDevice *device) { delete device; }
+	};
+	friend class Deleter;
+	friend class Input;
+};
+
+/** An option used by an output format */
+class SR_API Option
+{
+public:
+	/** Short name of this option suitable for command line usage. */
+	string get_id();
+	/** Short name of this option suitable for GUI usage. */
+	string get_name();
+	/** Description of this option in a sentence. */
+	string get_description();
+	/** Default value for this option. */
+	Glib::VariantBase get_default_value();
+	/** Possible values for this option, if a limited set. */
+	vector<Glib::VariantBase> get_values();
+protected:
+	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;
+	/** Deleter needed to allow shared_ptr use with protected destructor. */
+	class Deleter
+	{
+	public:
+		void operator()(Option *option) { delete option; }
+	};
+	friend class Deleter;
+	friend class OutputFormat;
+};
+
 /** An output format supported by the library */
 class SR_API OutputFormat :
-	public StructureWrapper<Context, struct sr_output_format>
+	public StructureWrapper<Context, const struct sr_output_module>
 {
 public:
 	/** Name of this output format. */
 	string get_name();
 	/** Description of this output format. */
 	string get_description();
-	/** Create an output using this format. */
-	shared_ptr<Output> create_output(shared_ptr<Device> device, map<string, string> options = {});
+	/** Options supported by this output format. */
+	map<string, shared_ptr<Option> > get_options();
+	/** 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,
+		map<string, Glib::VariantBase> options = {});
 protected:
-	OutputFormat(struct sr_output_format *structure);
+	OutputFormat(const struct sr_output_module *structure);
 	~OutputFormat();
 	friend class Context;
 	friend class Output;
@@ -733,17 +855,18 @@ protected:
 class SR_API Output
 {
 public:
-	/** Update output with data from the given packet. */
+	/** Update output with data from the given packet.
+	 * @param packet Packet to handle. */
 	string receive(shared_ptr<Packet> packet);
 protected:
 	Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
 	Output(shared_ptr<OutputFormat> format,
-		shared_ptr<Device> device, map<string, string> options);
+		shared_ptr<Device> device, map<string, Glib::VariantBase> options);
 	~Output();
-	struct sr_output *structure;
+	const struct sr_output *structure;
 	const shared_ptr<OutputFormat> format;
 	const shared_ptr<Device> device;
-	const map<string, string> options;
+	const map<string, Glib::VariantBase> options;
 	/** Deleter needed to allow shared_ptr use with protected destructor. */
 	class Deleter
 	{