X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fcxx%2Finclude%2Flibsigrokcxx%2Flibsigrokcxx.hpp;h=b1ab7a5bd6f6e04a06607c80017e8fc0d9473f73;hb=c5d081f721a0d99e726596d4f8afe72cf803a576;hp=c7995b8ccdd3346a1f8895c29aee809b3ef25d66;hpb=d5d7b09eb76de71a42b780b97aee5f5019d2d799;p=libsigrok.git diff --git a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp index c7995b8c..b1ab7a5b 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 + +/* 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 +G_GNUC_END_IGNORE_DEPRECATIONS #include #include @@ -93,6 +98,7 @@ class SR_API HardwareDevice; class SR_API Channel; class SR_API Session; class SR_API ConfigKey; +class SR_API Capability; class SR_API InputFormat; class SR_API OutputFormat; class SR_API OutputFlag; @@ -109,6 +115,7 @@ class SR_API PacketType; class SR_API Quantity; class SR_API Unit; class SR_API QuantityFlag; +class SR_API Rational; class SR_API Input; class SR_API InputDevice; class SR_API Output; @@ -203,13 +210,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 */ @@ -233,7 +233,7 @@ private: const char *name, void *cb_data) noexcept; static SR_PRIV int close_callback(struct sr_resource *res, void *cb_data) noexcept; - static SR_PRIV ssize_t read_callback(const struct sr_resource *res, + static SR_PRIV gssize read_callback(const struct sr_resource *res, void *buf, size_t count, void *cb_data) noexcept; friend class Context; }; @@ -276,15 +276,15 @@ public: shared_ptr create_header_packet(Glib::TimeVal start_time); /** Create a meta packet. */ shared_ptr create_meta_packet( - const map &config); + map config); /** Create a logic packet. */ shared_ptr create_logic_packet( void *data_pointer, size_t data_length, unsigned int unit_size); /** Create an analog packet. */ shared_ptr create_analog_packet( - const vector > &channels, + vector > channels, float *data_pointer, unsigned int num_samples, const Quantity *mq, - const Unit *unit, const vector &mqflags); + const Unit *unit, vector mqflags); /** Load a saved session. * @param filename File name string. */ shared_ptr load_session(string filename); @@ -300,28 +300,24 @@ public: map serials(shared_ptr driver) const; private: struct sr_context *_structure; - map _drivers; - map _input_formats; - map _output_formats; + map > _drivers; + map > _input_formats; + map > _output_formats; Session *_session; LogCallbackFunction _log_callback; Context(); ~Context(); - friend class Deleter; friend class Session; friend class Driver; -}; - -enum Capability { - GET = SR_CONF_GET, - SET = SR_CONF_SET, - LIST = SR_CONF_LIST + friend struct std::default_delete; }; /** An object that can be configured. */ class SR_API Configurable { public: + /** Supported configuration keys. */ + set config_keys() const; /** Read configuration for the given key. * @param key ConfigKey to read. */ Glib::VariantBase config_get(const ConfigKey *key) const; @@ -332,10 +328,13 @@ public: /** Enumerate available values for the given configuration key. * @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 > 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; + /** Enumerate configuration capabilities for the given configuration key. + * @param key ConfigKey to enumerate capabilities for. */ + set config_capabilities(const ConfigKey *key) const; + /** Check whether a configuration capability is supported for a given key. + * @param key ConfigKey to check. + * @param capability Capability to check for. */ + bool config_check(const ConfigKey *key, const Capability *capability) const; protected: Configurable( struct sr_dev_driver *driver, @@ -348,19 +347,19 @@ protected: }; /** A hardware driver provided by the library */ -class SR_API Driver : - public ParentOwned, - public Configurable +class SR_API Driver : public ParentOwned, public Configurable { public: /** Name of this driver. */ string name() const; /** Long name for this driver. */ string long_name() const; + /** Scan options supported by this driver. */ + set scan_options() const; /** Scan for devices and return a list of devices found. * @param options Mapping of (ConfigKey, value) pairs. */ - vector > scan( - const map &options = {}); + vector > scan(map + options = map()); private: struct sr_dev_driver *_structure; bool _initialized; @@ -370,6 +369,7 @@ private: friend class Context; friend class HardwareDevice; friend class ChannelGroup; + friend struct std::default_delete; }; /** A generic device, either hardware or virtual */ @@ -401,21 +401,16 @@ protected: shared_ptr get_channel(struct sr_channel *ptr); struct sr_dev_inst *_structure; - map _channels; + map > _channels; private: - map _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 > _channel_groups; + friend class Session; friend class Channel; friend class ChannelGroup; friend class Output; friend class Analog; + friend struct std::default_delete; }; /** A real hardware device, connected via a driver */ @@ -431,15 +426,10 @@ private: ~HardwareDevice(); shared_ptr get_shared_from_this(); shared_ptr _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; }; /** A virtual device, created by the user */ @@ -454,14 +444,9 @@ private: UserDevice(string vendor, string model, string version); ~UserDevice(); shared_ptr 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; }; /** A channel on a device */ @@ -494,6 +479,7 @@ private: friend class Session; friend class TriggerStage; friend class Context; + friend struct std::default_delete; }; /** A group of channels on a device, which share some configuration */ @@ -507,10 +493,11 @@ public: /** List of the channels in this group. */ vector > channels(); private: - ChannelGroup(Device *device, struct sr_channel_group *structure); + ChannelGroup(const Device *device, struct sr_channel_group *structure); ~ChannelGroup(); vector _channels; friend class Device; + friend struct std::default_delete; }; /** A trigger configuration */ @@ -528,10 +515,10 @@ private: ~Trigger(); struct sr_trigger *_structure; shared_ptr _context; - vector _stages; - friend class Deleter; + vector > _stages; friend class Context; friend class Session; + friend struct std::default_delete; }; /** A stage in a trigger configuration */ @@ -554,10 +541,11 @@ public: void add_match(shared_ptr channel, const TriggerMatchType *type, float value); private: struct sr_trigger_stage *_structure; - vector _matches; + vector > _matches; explicit TriggerStage(struct sr_trigger_stage *structure); ~TriggerStage(); friend class Trigger; + friend struct std::default_delete; }; /** A match condition in a trigger configuration */ @@ -577,6 +565,7 @@ private: struct sr_trigger_match *_structure; shared_ptr _channel; friend class TriggerStage; + friend struct std::default_delete; }; /** Type of session stopped callback */ @@ -609,14 +598,9 @@ private: explicit SessionDevice(struct sr_dev_inst *sdi); ~SessionDevice(); shared_ptr 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; }; /** A sigrok session */ @@ -661,16 +645,17 @@ private: shared_ptr get_device(const struct sr_dev_inst *sdi); struct sr_session *_structure; const shared_ptr _context; - map _owned_devices; + map > _owned_devices; map > _other_devices; - vector _datafeed_callbacks; + vector > _datafeed_callbacks; SessionStoppedCallback _stopped_callback; string _filename; shared_ptr _trigger; - friend class Deleter; + friend class Context; friend class DatafeedCallbackData; friend class SessionDevice; + friend struct std::default_delete; }; /** A packet on the session datafeed */ @@ -687,8 +672,8 @@ private: ~Packet(); const struct sr_datafeed_packet *_structure; shared_ptr _device; - PacketPayload *_payload; - friend class Deleter; + unique_ptr _payload; + friend class Session; friend class Output; friend class DatafeedCallbackData; @@ -697,6 +682,7 @@ private: friend class Logic; friend class Analog; friend class Context; + friend struct std::default_delete; }; /** Abstract base class for datafeed packet payloads */ @@ -708,15 +694,9 @@ protected: private: virtual shared_ptr share_owned_by(shared_ptr 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; }; /** Payload of a datafeed header packet */ @@ -788,10 +768,35 @@ class SR_API Analog : public: /** Pointer to data. */ void *data_pointer(); + /** + * Fills dest pointer with the analog data converted to float. + * The pointer must have space for num_samples() floats. + */ + void get_data_as_float(float *dest); /** Number of samples in this packet. */ unsigned int num_samples() const; /** Channels for which this packet contains data. */ vector > channels(); + /** Size of a single sample in bytes. */ + unsigned int unitsize() const; + /** Samples use a signed data type. */ + bool is_signed() const; + /** Samples use float. */ + bool is_float() const; + /** Samples are stored in big-endian order. */ + bool is_bigendian() const; + /** + * Number of significant digits after the decimal point if positive, + * or number of non-significant digits before the decimal point if negative + * (refers to the value we actually read on the wire). + */ + int digits() const; + /** TBD */ + bool is_digits_decimal() const; + /** TBD */ + shared_ptr scale(); + /** TBD */ + shared_ptr offset(); /** Measured quantity of the samples in this packet. */ const Quantity *mq() const; /** Unit of the samples in this packet. */ @@ -808,6 +813,28 @@ private: friend class Packet; }; +/** Number represented by a numerator/denominator integer pair */ +class SR_API Rational : + public ParentOwned +{ +public: + /** Numerator, i.e. the dividend. */ + int64_t numerator() const; + /** Denominator, i.e. the divider. */ + uint64_t denominator() const; + /** Actual (lossy) value. */ + float value() const; +private: + explicit Rational(const struct sr_rational *structure); + ~Rational(); + shared_ptr share_owned_by(shared_ptr parent); + + const struct sr_rational *_structure; + + friend class Analog; + friend struct std::default_delete; +}; + /** An input format supported by the library */ class SR_API InputFormat : public ParentOwned @@ -824,7 +851,8 @@ public: map > options(); /** Create an input using this input format. * @param options Mapping of (option name, value) pairs. */ - shared_ptr create_input(const map &options = {}); + shared_ptr create_input(map + options = map()); private: explicit InputFormat(const struct sr_input_module *structure); ~InputFormat(); @@ -833,6 +861,7 @@ private: friend class Context; friend class InputDevice; + friend struct std::default_delete; }; /** An input instance (an input format applied to a file or stream) */ @@ -847,15 +876,17 @@ public: void send(void *data, size_t length); /** Signal end of input data. */ void end(); + void reset(); private: Input(shared_ptr context, const struct sr_input *structure); ~Input(); const struct sr_input *_structure; shared_ptr _context; - InputDevice *_device; - friend class Deleter; + unique_ptr _device; + friend class Context; friend class InputFormat; + friend struct std::default_delete; }; /** A virtual device associated with an input */ @@ -869,6 +900,7 @@ private: shared_ptr get_shared_from_this(); shared_ptr _input; friend class Input; + friend struct std::default_delete; }; /** An option used by an output format */ @@ -891,9 +923,10 @@ private: ~Option(); const struct sr_option *_structure; shared_ptr _structure_array; - friend class Deleter; + friend class InputFormat; friend class OutputFormat; + friend struct std::default_delete