X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fcxx%2Finclude%2Flibsigrokcxx%2Flibsigrokcxx.hpp;h=3bebdd234936c246b7a559ad3569ce509d79629a;hb=HEAD;hp=80888af61c5064a81c97110af4e6568740126371;hpb=092843eb4286885be8801592cfffb449cb23ddea;p=libsigrok.git diff --git a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp index 80888af6..3bebdd23 100644 --- a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp +++ b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp @@ -78,6 +78,7 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS #include G_GNUC_END_IGNORE_DEPRECATIONS +#include #include #include #include @@ -87,8 +88,6 @@ G_GNUC_END_IGNORE_DEPRECATIONS namespace sigrok { -using namespace std; - /* Forward declarations */ class SR_API Error; class SR_API Context; @@ -124,7 +123,7 @@ class SR_API Option; class SR_API UserDevice; /** Exception thrown when an error code is returned by any libsigrok call. */ -class SR_API Error: public exception +class SR_API Error: public std::exception { public: explicit Error(int result); @@ -139,7 +138,7 @@ class SR_API ParentOwned { private: /* Weak pointer for shared_from_this() implementation. */ - weak_ptr _weak_this; + std::weak_ptr _weak_this; static void reset_parent(Class *object) { @@ -162,14 +161,14 @@ protected: This strategy ensures that the destructors for both the child and the parent are called at the correct time, i.e. only when all references to both the parent and all its children are gone. */ - shared_ptr _parent; + std::shared_ptr _parent; ParentOwned() {} /* Note, this implementation will create a new smart_ptr if none exists. */ - shared_ptr shared_from_this() + std::shared_ptr shared_from_this() { - shared_ptr shared = _weak_this.lock(); + std::shared_ptr shared = _weak_this.lock(); if (!shared) { @@ -180,7 +179,7 @@ protected: return shared; } - shared_ptr share_owned_by(shared_ptr parent) + std::shared_ptr share_owned_by(std::shared_ptr parent) { if (!parent) throw Error(SR_ERR_BUG); @@ -190,7 +189,7 @@ protected: public: /* Get parent object that owns this object. */ - shared_ptr parent() + std::shared_ptr parent() { return _parent; } @@ -198,14 +197,14 @@ public: /* Base template for classes whose resources are owned by the user. */ template -class SR_API UserOwned : public enable_shared_from_this +class SR_API UserOwned : public std::enable_shared_from_this { protected: UserOwned() {} - shared_ptr shared_from_this() + std::shared_ptr shared_from_this() { - auto shared = enable_shared_from_this::shared_from_this(); + auto shared = std::enable_shared_from_this::shared_from_this(); if (!shared) throw Error(SR_ERR_BUG); return shared; @@ -213,7 +212,7 @@ protected: }; /** Type of log callback */ -typedef function LogCallbackFunction; +typedef std::function LogCallbackFunction; /** Resource reader delegate. */ class SR_API ResourceReader @@ -223,7 +222,7 @@ public: virtual ~ResourceReader(); private: /** Resource open hook. */ - virtual void open(struct sr_resource *res, string name) = 0; + virtual void open(struct sr_resource *res, std::string name) = 0; /** Resource close hook. */ virtual void close(struct sr_resource *res) = 0; /** Resource read hook. */ @@ -243,19 +242,19 @@ class SR_API Context : public UserOwned { public: /** Create new context */ - static shared_ptr create(); + static std::shared_ptr create(); /** libsigrok package version. */ - static string package_version(); + static std::string package_version(); /** libsigrok library version. */ - static string lib_version(); + static std::string lib_version(); /** Available hardware drivers, indexed by name. */ - map > drivers(); + std::map > drivers(); /** Available input formats, indexed by name. */ - map > input_formats(); + std::map > input_formats(); /** Lookup the responsible input module for an input file. */ - shared_ptr input_format_match(string filename); + std::shared_ptr input_format_match(std::string filename); /** Available output formats, indexed by name. */ - map > output_formats(); + std::map > output_formats(); /** Current log level. */ const LogLevel *log_level() const; /** Set the log level. @@ -270,41 +269,43 @@ public: * @param reader The resource reader delegate, or nullptr to unset. */ void set_resource_reader(ResourceReader *reader); /** Create a new session. */ - shared_ptr create_session(); + std::shared_ptr create_session(); /** Create a new user device. */ - shared_ptr create_user_device( - string vendor, string model, string version); + std::shared_ptr create_user_device( + std::string vendor, std::string model, std::string version); /** Create a header packet. */ - shared_ptr create_header_packet(Glib::TimeVal start_time); + std::shared_ptr create_header_packet(Glib::DateTime start_time); /** Create a meta packet. */ - shared_ptr create_meta_packet( - map config); + std::shared_ptr create_meta_packet( + std::map config); /** Create a logic packet. */ - shared_ptr create_logic_packet( + std::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( - vector > channels, + std::shared_ptr create_analog_packet( + std::vector > channels, const float *data_pointer, unsigned int num_samples, const Quantity *mq, - const Unit *unit, vector mqflags); + const Unit *unit, std::vector mqflags); + /** Create an end packet. */ + std::shared_ptr create_end_packet(); /** Load a saved session. * @param filename File name string. */ - shared_ptr load_session(string filename); + std::shared_ptr load_session(std::string filename); /** Create a new trigger. * @param name Name string for new trigger. */ - shared_ptr create_trigger(string name); + std::shared_ptr create_trigger(std::string name); /** Open an input file. * @param filename File name string. */ - shared_ptr open_file(string filename); + std::shared_ptr open_file(std::string filename); /** Open an input stream based on header data. * @param header Initial data from stream. */ - shared_ptr open_stream(string header); - map serials(shared_ptr driver) const; + std::shared_ptr open_stream(std::string header); + std::map serials(std::shared_ptr driver) const; private: struct sr_context *_structure; - map > _drivers; - map > _input_formats; - map > _output_formats; + std::map > _drivers; + std::map > _input_formats; + std::map > _output_formats; Session *_session; LogCallbackFunction _log_callback; Context(); @@ -319,7 +320,7 @@ class SR_API Configurable { public: /** Supported configuration keys. */ - set config_keys() const; + std::set config_keys() const; /** Read configuration for the given key. * @param key ConfigKey to read. */ Glib::VariantBase config_get(const ConfigKey *key) const; @@ -332,7 +333,7 @@ public: Glib::VariantContainerBase config_list(const ConfigKey *key) const; /** Enumerate configuration capabilities for the given configuration key. * @param key ConfigKey to enumerate capabilities for. */ - set config_capabilities(const ConfigKey *key) const; + std::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. */ @@ -353,19 +354,19 @@ class SR_API Driver : public ParentOwned, public Configurable { public: /** Name of this driver. */ - string name() const; + std::string name() const; /** Long name for this driver. */ - string long_name() const; + std::string long_name() const; /** Scan options supported by this driver. */ - set scan_options() const; + std::set scan_options() const; /** Scan for devices and return a list of devices found. * @param options Mapping of (ConfigKey, value) pairs. */ - vector > scan(map - options = map()); + std::vector > scan(std::map + options = std::map()); private: struct sr_dev_driver *_structure; bool _initialized; - vector _devices; + std::vector _devices; explicit Driver(struct sr_dev_driver *structure); ~Driver(); friend class Context; @@ -379,19 +380,19 @@ class SR_API Device : public Configurable { public: /** Vendor name for this device. */ - string vendor() const; + std::string vendor() const; /** Model name for this device. */ - string model() const; + std::string model() const; /** Version string for this device. */ - string version() const; + std::string version() const; /** Serial number for this device. */ - string serial_number() const; + std::string serial_number() const; /** Connection ID for this device. */ - string connection_id() const; + std::string connection_id() const; /** List of the channels available on this device. */ - vector > channels(); + std::vector > channels(); /** Channel groups available on this device, indexed by name. */ - map > channel_groups(); + std::map > channel_groups(); /** Open device. */ void open(); /** Close device. */ @@ -399,13 +400,13 @@ public: protected: explicit Device(struct sr_dev_inst *structure); ~Device(); - virtual shared_ptr get_shared_from_this() = 0; - shared_ptr get_channel(struct sr_channel *ptr); + virtual std::shared_ptr get_shared_from_this() = 0; + std::shared_ptr get_channel(struct sr_channel *ptr); struct sr_dev_inst *_structure; - map > _channels; + std::map > _channels; private: - map > _channel_groups; + std::map > _channel_groups; friend class Session; friend class Channel; @@ -422,12 +423,12 @@ class SR_API HardwareDevice : { public: /** Driver providing this device. */ - shared_ptr driver(); + std::shared_ptr driver(); private: - HardwareDevice(shared_ptr driver, struct sr_dev_inst *structure); + HardwareDevice(std::shared_ptr driver, struct sr_dev_inst *structure); ~HardwareDevice(); - shared_ptr get_shared_from_this(); - shared_ptr _driver; + std::shared_ptr get_shared_from_this(); + std::shared_ptr _driver; friend class Driver; friend class ChannelGroup; @@ -441,11 +442,11 @@ class SR_API UserDevice : { public: /** Add a new channel to this device. */ - shared_ptr add_channel(unsigned int index, const ChannelType *type, string name); + std::shared_ptr add_channel(unsigned int index, const ChannelType *type, std::string name); private: - UserDevice(string vendor, string model, string version); + UserDevice(std::string vendor, std::string model, std::string version); ~UserDevice(); - shared_ptr get_shared_from_this(); + std::shared_ptr get_shared_from_this(); friend class Context; friend struct std::default_delete; @@ -457,10 +458,10 @@ class SR_API Channel : { public: /** Current name of this channel. */ - string name() const; + std::string name() const; /** Set the name of this channel. * * @param name Name string to set. */ - void set_name(string name); + void set_name(std::string name); /** Type of this channel. */ const ChannelType *type() const; /** Enabled status of this channel. */ @@ -491,13 +492,13 @@ class SR_API ChannelGroup : { public: /** Name of this channel group. */ - string name() const; + std::string name() const; /** List of the channels in this group. */ - vector > channels(); + std::vector > channels(); private: ChannelGroup(const Device *device, struct sr_channel_group *structure); ~ChannelGroup(); - vector _channels; + std::vector _channels; friend class Device; friend struct std::default_delete; }; @@ -507,17 +508,17 @@ class SR_API Trigger : public UserOwned { public: /** Name of this trigger configuration. */ - string name() const; + std::string name() const; /** List of the stages in this trigger. */ - vector > stages(); + std::vector > stages(); /** Add a new stage to this trigger. */ - shared_ptr add_stage(); + std::shared_ptr add_stage(); private: - Trigger(shared_ptr context, string name); + Trigger(std::shared_ptr context, std::string name); ~Trigger(); struct sr_trigger *_structure; - shared_ptr _context; - vector > _stages; + std::shared_ptr _context; + std::vector > _stages; friend class Context; friend class Session; friend struct std::default_delete; @@ -531,19 +532,19 @@ public: /** Index number of this stage. */ int number() const; /** List of match conditions on this stage. */ - vector > matches(); + std::vector > 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, const TriggerMatchType *type); + void add_match(std::shared_ptr 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, const TriggerMatchType *type, float value); + void add_match(std::shared_ptr channel, const TriggerMatchType *type, float value); private: struct sr_trigger_stage *_structure; - vector > _matches; + std::vector > _matches; explicit TriggerStage(struct sr_trigger_stage *structure); ~TriggerStage(); friend class Trigger; @@ -556,25 +557,25 @@ class SR_API TriggerMatch : { public: /** Channel this condition matches on. */ - shared_ptr channel(); + std::shared_ptr channel(); /** Type of match. */ const TriggerMatchType *type() const; /** Threshold value. */ float value() const; private: - TriggerMatch(struct sr_trigger_match *structure, shared_ptr channel); + TriggerMatch(struct sr_trigger_match *structure, std::shared_ptr channel); ~TriggerMatch(); struct sr_trigger_match *_structure; - shared_ptr _channel; + std::shared_ptr _channel; friend class TriggerStage; friend struct std::default_delete; }; /** Type of session stopped callback */ -typedef function SessionStoppedCallback; +typedef std::function SessionStoppedCallback; /** Type of datafeed callback */ -typedef function, shared_ptr)> +typedef std::function, std::shared_ptr)> DatafeedCallbackFunction; /* Data required for C callback function to call a C++ datafeed callback */ @@ -599,7 +600,7 @@ class SR_API SessionDevice : private: explicit SessionDevice(struct sr_dev_inst *sdi); ~SessionDevice(); - shared_ptr get_shared_from_this(); + std::shared_ptr get_shared_from_this(); friend class Session; friend struct std::default_delete; @@ -611,9 +612,9 @@ class SR_API Session : public UserOwned public: /** Add a device to this session. * @param device Device to add. */ - void add_device(shared_ptr device); + void add_device(std::shared_ptr device); /** List devices attached to this session. */ - vector > devices(); + std::vector > devices(); /** Remove all devices from this session. */ void remove_devices(); /** Add a datafeed callback to this session. @@ -632,27 +633,27 @@ public: /** Set callback to be invoked on session stop. */ void set_stopped_callback(SessionStoppedCallback callback); /** Get current trigger setting. */ - shared_ptr trigger(); + std::shared_ptr trigger(); /** Get the context. */ - shared_ptr context(); + std::shared_ptr context(); /** Set trigger setting. * @param trigger Trigger object to use. */ - void set_trigger(shared_ptr trigger); + void set_trigger(std::shared_ptr trigger); /** Get filename this session was loaded from. */ - string filename() const; + std::string filename() const; private: - explicit Session(shared_ptr context); - Session(shared_ptr context, string filename); + explicit Session(std::shared_ptr context); + Session(std::shared_ptr context, std::string filename); ~Session(); - shared_ptr get_device(const struct sr_dev_inst *sdi); + std::shared_ptr get_device(const struct sr_dev_inst *sdi); struct sr_session *_structure; - const shared_ptr _context; - map > _owned_devices; - map > _other_devices; - vector > _datafeed_callbacks; + const std::shared_ptr _context; + std::map > _owned_devices; + std::map > _other_devices; + std::vector > _datafeed_callbacks; SessionStoppedCallback _stopped_callback; - string _filename; - shared_ptr _trigger; + std::string _filename; + std::shared_ptr _trigger; friend class Context; friend class DatafeedCallbackData; @@ -667,14 +668,14 @@ public: /** Type of this packet. */ const PacketType *type() const; /** Payload of this packet. */ - shared_ptr payload(); + std::shared_ptr payload(); private: - Packet(shared_ptr device, + Packet(std::shared_ptr device, const struct sr_datafeed_packet *structure); ~Packet(); const struct sr_datafeed_packet *_structure; - shared_ptr _device; - unique_ptr _payload; + std::shared_ptr _device; + std::unique_ptr _payload; friend class Session; friend class Output; @@ -694,7 +695,7 @@ protected: PacketPayload(); virtual ~PacketPayload() = 0; private: - virtual shared_ptr share_owned_by(shared_ptr parent) = 0; + virtual std::shared_ptr share_owned_by(std::shared_ptr parent) = 0; friend class Packet; friend class Output; @@ -710,11 +711,11 @@ public: /* Feed version number. */ int feed_version() const; /* Start time of this session. */ - Glib::TimeVal start_time() const; + Glib::DateTime start_time() const; private: explicit Header(const struct sr_datafeed_header *structure); ~Header(); - shared_ptr share_owned_by(shared_ptr parent); + std::shared_ptr share_owned_by(std::shared_ptr parent); const struct sr_datafeed_header *_structure; @@ -728,14 +729,14 @@ class SR_API Meta : { public: /* Mapping of (ConfigKey, value) pairs. */ - map config() const; + std::map config() const; private: explicit Meta(const struct sr_datafeed_meta *structure); ~Meta(); - shared_ptr share_owned_by(shared_ptr parent); + std::shared_ptr share_owned_by(std::shared_ptr parent); const struct sr_datafeed_meta *_structure; - map _config; + std::map _config; friend class Packet; }; @@ -755,7 +756,7 @@ public: private: explicit Logic(const struct sr_datafeed_logic *structure); ~Logic(); - shared_ptr share_owned_by(shared_ptr parent); + std::shared_ptr share_owned_by(std::shared_ptr parent); const struct sr_datafeed_logic *_structure; @@ -780,7 +781,7 @@ public: /** Number of samples in this packet. */ unsigned int num_samples() const; /** Channels for which this packet contains data. */ - vector > channels(); + std::vector > channels(); /** Size of a single sample in bytes. */ unsigned int unitsize() const; /** Samples use a signed data type. */ @@ -790,23 +791,36 @@ public: /** 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). + * Number of significant digits after the decimal point, if positive. + * When negative, exponent with reversed polarity that is necessary to + * express the value with all digits without a decimal point. + * Refers to the value we actually read on the wire. + * + * Examples: + * + * | On the wire | Exponential notation | Exp. not. (normalized) | digits | + * |-------------|----------------------|------------------------|--------| + * | 12.34 MOhm | 1.234 * 10^7 Ohm | 1234 * 10^4 Ohm | -4 | + * | 1.2345 MOhm | 1.2345 * 10^6 Ohm | 12345 * 10^2 Ohm | -2 | + * | 123.4 kOhm | 1.234 * 10^5 Ohm | 1234 * 10^2 Ohm | -2 | + * | 1234 Ohm | 1.234 * 10^3 Ohm | 1234 * 10^0 Ohm | 0 | + * | 12.34 Ohm | 1.234 * 10^1 Ohm | 1234 * 10^-2 Ohm | 2 | + * | 0.0123 Ohm | 1.23 * 10^-2 Ohm | 123 * 10^-4 Ohm | 4 | + * | 1.234 pF | 1.234 * 10^-12 F | 1234 * 10^-15 F | 15 | */ int digits() const; /** TBD */ bool is_digits_decimal() const; /** TBD */ - shared_ptr scale(); + std::shared_ptr scale(); /** TBD */ - shared_ptr offset(); + std::shared_ptr offset(); /** Measured quantity of the samples in this packet. */ const Quantity *mq() const; /** Unit of the samples in this packet. */ const Unit *unit() const; /** Measurement flags associated with the samples in this packet. */ - vector mq_flags() const; + std::vector mq_flags() const; /** * Provides a Logic packet that contains a conversion of the analog * data using a simple threshold. @@ -817,7 +831,7 @@ public: * logic->data_pointer() will be allocated and must * be freed by the caller. */ - shared_ptr get_logic_via_threshold(float threshold, + std::shared_ptr get_logic_via_threshold(float threshold, uint8_t *data_ptr=nullptr) const; /** * Provides a Logic packet that contains a conversion of the analog @@ -833,12 +847,12 @@ public: * logic->data_pointer() will be allocated and must be * freed by the caller. */ - shared_ptr get_logic_via_schmitt_trigger(float lo_thr, + std::shared_ptr get_logic_via_schmitt_trigger(float lo_thr, float hi_thr, uint8_t *state, uint8_t *data_ptr=nullptr) const; private: explicit Analog(const struct sr_datafeed_analog *structure); ~Analog(); - shared_ptr share_owned_by(shared_ptr parent); + std::shared_ptr share_owned_by(std::shared_ptr parent); const struct sr_datafeed_analog *_structure; @@ -859,7 +873,7 @@ public: private: explicit Rational(const struct sr_rational *structure); ~Rational(); - shared_ptr share_owned_by(shared_ptr parent); + std::shared_ptr share_owned_by(std::shared_ptr parent); const struct sr_rational *_structure; @@ -873,18 +887,18 @@ class SR_API InputFormat : { public: /** Name of this input format. */ - string name() const; + std::string name() const; /** Description of this input format. */ - string description() const; + std::string description() const; /** A list of preferred file name extensions for this file format. * @note This list is a recommendation only. */ - vector extensions() const; + std::vector extensions() const; /** Options supported by this input format. */ - map > options(); + std::map > options(); /** Create an input using this input format. * @param options Mapping of (option name, value) pairs. */ - shared_ptr create_input(map - options = map()); + std::shared_ptr create_input(std::map + options = std::map()); private: explicit InputFormat(const struct sr_input_module *structure); ~InputFormat(); @@ -901,7 +915,7 @@ class SR_API Input : public UserOwned { public: /** Virtual device associated with this input. */ - shared_ptr device(); + std::shared_ptr device(); /** Send next stream data. * @param data Next stream data. * @param length Length of data. */ @@ -910,11 +924,11 @@ public: void end(); void reset(); private: - Input(shared_ptr context, const struct sr_input *structure); + Input(std::shared_ptr context, const struct sr_input *structure); ~Input(); const struct sr_input *_structure; - shared_ptr _context; - unique_ptr _device; + std::shared_ptr _context; + std::unique_ptr _device; friend class Context; friend class InputFormat; @@ -927,10 +941,10 @@ class SR_API InputDevice : public Device { private: - InputDevice(shared_ptr input, struct sr_dev_inst *sdi); + InputDevice(std::shared_ptr input, struct sr_dev_inst *sdi); ~InputDevice(); - shared_ptr get_shared_from_this(); - shared_ptr _input; + std::shared_ptr get_shared_from_this(); + std::shared_ptr _input; friend class Input; friend struct std::default_delete; }; @@ -940,23 +954,23 @@ class SR_API Option : public UserOwned