X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fcxx%2Finclude%2Flibsigrokcxx%2Flibsigrokcxx.hpp;h=d8cf3bdc3f62b449e18bf58ad25968ea8f096ffa;hb=014512254abcc74d203376f2e038053b94cf1116;hp=b000e4cddf9a002063be3511b218afa19b96f057;hpb=ee9953ef12514d833c6719777dfc285d56c0ffc1;p=libsigrok.git diff --git a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp index b000e4cd..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 + +/* 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 @@ -120,16 +125,27 @@ class SR_API UserDevice; class SR_API Error: public exception { public: - Error(int result); - ~Error() throw(); + explicit Error(int result); + ~Error() noexcept; const int result; - const char *what() const throw(); + const char *what() const noexcept; }; /* Base template for classes whose resources are owned by a parent object. */ -template +template class SR_API ParentOwned { +private: + /* Weak pointer for shared_from_this() implementation. */ + weak_ptr _weak_this; + + static void reset_parent(Class *object) + { + if (!object->_parent) + throw Error(SR_ERR_BUG); + object->_parent.reset(); + } + protected: /* Parent object which owns this child object's underlying structure. @@ -146,31 +162,23 @@ protected: references to both the parent and all its children are gone. */ shared_ptr _parent; - /* Weak pointer for shared_from_this() implementation. */ - weak_ptr _weak_this; - -public: - /* Get parent object that owns this object. */ - shared_ptr parent() - { - return _parent; - } + ParentOwned() {} /* Note, this implementation will create a new smart_ptr if none exists. */ shared_ptr shared_from_this() { - shared_ptr shared; + shared_ptr shared = _weak_this.lock(); - if (!(shared = _weak_this.lock())) + if (!shared) { - shared = shared_ptr((Class *) this, reset_parent); + shared.reset(static_cast(this), &reset_parent); _weak_this = shared; } return shared; } - shared_ptr get_shared_pointer(shared_ptr parent) + shared_ptr share_owned_by(shared_ptr parent) { if (!parent) throw Error(SR_ERR_BUG); @@ -178,33 +186,21 @@ public: return shared_from_this(); } - shared_ptr get_shared_pointer(Parent *parent) - { - if (!parent) - throw Error(SR_ERR_BUG); - return get_shared_pointer(parent->shared_from_this()); - } -protected: - static void reset_parent(Class *object) - { - if (!object->_parent) - throw Error(SR_ERR_BUG); - object->_parent.reset(); - } - - Struct *_structure; - - ParentOwned(Struct *structure) : - _structure(structure) +public: + /* Get parent object that owns this object. */ + shared_ptr parent() { + return _parent; } }; /* Base template for classes whose resources are owned by the user. */ -template +template class SR_API UserOwned : public enable_shared_from_this { -public: +protected: + UserOwned() {} + shared_ptr shared_from_this() { auto shared = enable_shared_from_this::shared_from_this(); @@ -212,20 +208,6 @@ public: throw Error(SR_ERR_BUG); return shared; } -protected: - Struct *_structure; - - UserOwned(Struct *structure) : - _structure(structure) - { - } - - /* Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Class *object) { delete object; } - }; }; /** Type of log callback */ @@ -246,24 +228,24 @@ private: virtual size_t read(const struct sr_resource *res, void *buf, size_t count) = 0; static SR_PRIV int open_callback(struct sr_resource *res, - const char *name, void *cb_data); + const char *name, void *cb_data) noexcept; static SR_PRIV int close_callback(struct sr_resource *res, - void *cb_data); + void *cb_data) noexcept; static SR_PRIV ssize_t read_callback(const struct sr_resource *res, - void *buf, size_t count, void *cb_data); + void *buf, size_t count, void *cb_data) noexcept; friend class Context; }; /** The global libsigrok context */ -class SR_API Context : public UserOwned +class SR_API Context : public UserOwned { public: /** Create new context */ static shared_ptr create(); /** libsigrok package version. */ - string package_version(); + static string package_version(); /** libsigrok library version. */ - string lib_version(); + static string lib_version(); /** Available hardware drivers, indexed by name. */ map > drivers(); /** Available input formats, indexed by name. */ @@ -271,7 +253,7 @@ public: /** Available output formats, indexed by name. */ map > output_formats(); /** Current log level. */ - const LogLevel *log_level(); + const LogLevel *log_level() const; /** Set the log level. * @param level LogLevel to use. */ void set_log_level(const LogLevel *level); @@ -313,18 +295,19 @@ public: /** 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); -protected: - map _drivers; - map _input_formats; - map _output_formats; + map serials(shared_ptr driver) const; +private: + struct sr_context *_structure; + map > _drivers; + map > _input_formats; + map > _output_formats; Session *_session; LogCallbackFunction _log_callback; Context(); ~Context(); - friend class Deleter; friend class Session; friend class Driver; + friend struct std::default_delete; }; enum Capability { @@ -339,18 +322,18 @@ class SR_API Configurable public: /** Read configuration for the given key. * @param key ConfigKey to read. */ - Glib::VariantBase config_get(const ConfigKey *key); + Glib::VariantBase config_get(const ConfigKey *key) const; /** 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); + void config_set(const ConfigKey *key, const Glib::VariantBase &value); /** Enumerate available values for the given configuration key. * @param key ConfigKey to enumerate values for. */ - Glib::VariantContainerBase config_list(const ConfigKey *key); + Glib::VariantContainerBase config_list(const ConfigKey *key) const; /** Enumerate available keys, according to a given index key. */ - map > config_keys(const ConfigKey *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); + bool config_check(const ConfigKey *key, const ConfigKey *index_key) const; protected: Configurable( struct sr_dev_driver *driver, @@ -364,27 +347,28 @@ protected: /** A hardware driver provided by the library */ class SR_API Driver : - public ParentOwned, + public ParentOwned, public Configurable { public: /** Name of this driver. */ - string name(); + string name() const; /** Long name for this driver. */ - string long_name(); + string long_name() const; /** Scan for devices and return a list of devices found. * @param options Mapping of (ConfigKey, value) pairs. */ - vector > scan( - map options = - map()); -protected: + vector > scan(map + options = map()); +private: + struct sr_dev_driver *_structure; bool _initialized; vector _devices; - Driver(struct sr_dev_driver *structure); + explicit Driver(struct sr_dev_driver *structure); ~Driver(); friend class Context; friend class HardwareDevice; friend class ChannelGroup; + friend struct std::default_delete; }; /** A generic device, either hardware or virtual */ @@ -392,15 +376,15 @@ class SR_API Device : public Configurable { public: /** Vendor name for this device. */ - string vendor(); + string vendor() const; /** Model name for this device. */ - string model(); + string model() const; /** Version string for this device. */ - string version(); + string version() const; /** Serial number for this device. */ - string serial_number(); + string serial_number() const; /** Connection ID for this device. */ - string connection_id(); + string connection_id() const; /** List of the channels available on this device. */ vector > channels(); /** Channel groups available on this device, indexed by name. */ @@ -410,95 +394,83 @@ public: /** Close device. */ void close(); protected: - Device(struct sr_dev_inst *structure); + explicit Device(struct sr_dev_inst *structure); ~Device(); virtual shared_ptr get_shared_from_this() = 0; shared_ptr get_channel(struct sr_channel *ptr); + struct sr_dev_inst *_structure; - map _channels; - 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 > _channels; +private: + 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 */ class SR_API HardwareDevice : - public UserOwned, + public UserOwned, public Device { public: /** Driver providing this device. */ shared_ptr driver(); -protected: +private: HardwareDevice(shared_ptr driver, struct sr_dev_inst *structure); ~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 */ class SR_API UserDevice : - public UserOwned, + public UserOwned, public Device { public: /** Add a new channel to this device. */ shared_ptr add_channel(unsigned int index, const ChannelType *type, string name); -protected: +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 */ class SR_API Channel : - public ParentOwned + public ParentOwned { public: /** Current name of this channel. */ - string name(); + string name() const; /** Set the name of this channel. * * @param name Name string to set. */ void set_name(string name); /** Type of this channel. */ - const ChannelType *type(); + const ChannelType *type() const; /** Enabled status of this channel. */ - bool enabled(); + bool enabled() const; /** 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 index(); -protected: - Channel(struct sr_channel *structure); + unsigned int index() const; +private: + explicit Channel(struct sr_channel *structure); ~Channel(); + struct sr_channel *_structure; const ChannelType * const _type; friend class Device; friend class UserDevice; @@ -506,52 +478,55 @@ protected: 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 */ class SR_API ChannelGroup : - public ParentOwned, + public ParentOwned, public Configurable { public: /** Name of this channel group. */ - string name(); + string name() const; /** List of the channels in this group. */ vector > channels(); -protected: - ChannelGroup(Device *device, struct sr_channel_group *structure); +private: + ChannelGroup(const Device *device, struct sr_channel_group *structure); ~ChannelGroup(); vector _channels; friend class Device; + friend struct std::default_delete; }; /** A trigger configuration */ -class SR_API Trigger : public UserOwned +class SR_API Trigger : public UserOwned { public: /** Name of this trigger configuration. */ - string name(); + string name() const; /** List of the stages in this trigger. */ vector > stages(); /** Add a new stage to this trigger. */ shared_ptr add_stage(); -protected: +private: Trigger(shared_ptr context, string name); ~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 */ class SR_API TriggerStage : - public ParentOwned + public ParentOwned { public: /** Index number of this stage. */ - int number(); + int number() const; /** List of match conditions on this stage. */ vector > matches(); /** Add a new match condition to this stage. @@ -563,29 +538,33 @@ public: * @param type TriggerMatchType to apply. * @param value Threshold value. */ void add_match(shared_ptr channel, const TriggerMatchType *type, float value); -protected: - vector _matches; - TriggerStage(struct sr_trigger_stage *structure); +private: + struct sr_trigger_stage *_structure; + 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 */ class SR_API TriggerMatch : - public ParentOwned + public ParentOwned { public: /** Channel this condition matches on. */ shared_ptr channel(); /** Type of match. */ - const TriggerMatchType *type(); + const TriggerMatchType *type() const; /** Threshold value. */ - float value(); -protected: + float value() const; +private: TriggerMatch(struct sr_trigger_match *structure, shared_ptr channel); ~TriggerMatch(); + struct sr_trigger_match *_structure; shared_ptr _channel; friend class TriggerStage; + friend struct std::default_delete; }; /** Type of session stopped callback */ @@ -601,7 +580,7 @@ class SR_PRIV DatafeedCallbackData public: void run(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *pkt); -protected: +private: DatafeedCallbackFunction _callback; DatafeedCallbackData(Session *session, DatafeedCallbackFunction callback); @@ -611,25 +590,20 @@ protected: /** A virtual device associated with a stored session */ class SR_API SessionDevice : - public ParentOwned, + public ParentOwned, public Device { -protected: - SessionDevice(struct sr_dev_inst *sdi); +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 */ -class SR_API Session : public UserOwned +class SR_API Session : public UserOwned { public: /** Add a device to this session. @@ -662,40 +636,43 @@ public: * @param trigger Trigger object to use. */ void set_trigger(shared_ptr trigger); /** Get filename this session was loaded from. */ - string filename(); -protected: - Session(shared_ptr context); + string filename() const; +private: + explicit Session(shared_ptr context); Session(shared_ptr context, string filename); ~Session(); 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 */ -class SR_API Packet : public UserOwned +class SR_API Packet : public UserOwned { public: /** Type of this packet. */ - const PacketType *type(); + const PacketType *type() const; /** Payload of this packet. */ shared_ptr payload(); -protected: +private: Packet(shared_ptr device, const struct sr_datafeed_packet *structure); ~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; @@ -704,6 +681,7 @@ protected: friend class Logic; friend class Analog; friend class Context; + friend struct std::default_delete; }; /** Abstract base class for datafeed packet payloads */ @@ -712,122 +690,134 @@ class SR_API PacketPayload protected: PacketPayload(); virtual ~PacketPayload() = 0; - virtual shared_ptr get_shared_pointer(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; +private: + virtual shared_ptr share_owned_by(shared_ptr parent) = 0; + friend class Packet; friend class Output; + friend struct std::default_delete; }; /** Payload of a datafeed header packet */ class SR_API Header : - public ParentOwned, + public ParentOwned, public PacketPayload { public: /* Feed version number. */ - int feed_version(); + int feed_version() const; /* Start time of this session. */ - Glib::TimeVal start_time(); -protected: - Header(const struct sr_datafeed_header *structure); + Glib::TimeVal start_time() const; +private: + explicit Header(const struct sr_datafeed_header *structure); ~Header(); - shared_ptr get_shared_pointer(Packet *parent); + shared_ptr share_owned_by(shared_ptr parent); + + const struct sr_datafeed_header *_structure; + friend class Packet; }; /** Payload of a datafeed metadata packet */ class SR_API Meta : - public ParentOwned, + public ParentOwned, public PacketPayload { public: /* Mapping of (ConfigKey, value) pairs. */ - map config(); -protected: - Meta(const struct sr_datafeed_meta *structure); + map config() const; +private: + explicit Meta(const struct sr_datafeed_meta *structure); ~Meta(); - shared_ptr get_shared_pointer(Packet *parent); + shared_ptr share_owned_by(shared_ptr parent); + + const struct sr_datafeed_meta *_structure; map _config; + friend class Packet; }; /** Payload of a datafeed packet with logic data */ class SR_API Logic : - public ParentOwned, + public ParentOwned, public PacketPayload { public: /* Pointer to data. */ void *data_pointer(); /* Data length in bytes. */ - size_t data_length(); + size_t data_length() const; /* Size of each sample in bytes. */ - unsigned int unit_size(); -protected: - Logic(const struct sr_datafeed_logic *structure); + unsigned int unit_size() const; +private: + explicit Logic(const struct sr_datafeed_logic *structure); ~Logic(); - shared_ptr get_shared_pointer(Packet *parent); + shared_ptr share_owned_by(shared_ptr parent); + + const struct sr_datafeed_logic *_structure; + friend class Packet; }; /** Payload of a datafeed packet with analog data */ class SR_API Analog : - public ParentOwned, + public ParentOwned, public PacketPayload { public: /** Pointer to data. */ - float *data_pointer(); + void *data_pointer(); /** Number of samples in this packet. */ - unsigned int num_samples(); + unsigned int num_samples() const; /** Channels for which this packet contains data. */ vector > channels(); /** Measured quantity of the samples in this packet. */ - const Quantity *mq(); + const Quantity *mq() const; /** Unit of the samples in this packet. */ - const Unit *unit(); + const Unit *unit() const; /** Measurement flags associated with the samples in this packet. */ - vector mq_flags(); -protected: - Analog(const struct sr_datafeed_analog *structure); + vector mq_flags() const; +private: + explicit Analog(const struct sr_datafeed_analog *structure); ~Analog(); - shared_ptr get_shared_pointer(Packet *parent); + shared_ptr share_owned_by(shared_ptr parent); + + const struct sr_datafeed_analog *_structure; + friend class Packet; }; /** An input format supported by the library */ class SR_API InputFormat : - public ParentOwned + public ParentOwned { public: /** Name of this input format. */ - string name(); + string name() const; /** Description of this input format. */ - string description(); + string description() const; /** A list of preferred file name extensions for this file format. * @note This list is a recommendation only. */ - vector extensions(); + vector extensions() const; /** Options supported by this input format. */ map > options(); /** Create an input using this input format. * @param options Mapping of (option name, value) pairs. */ - shared_ptr create_input(map options = - map()); -protected: - InputFormat(const struct sr_input_module *structure); + shared_ptr create_input(map + options = map()); +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; }; /** An input instance (an input format applied to a file or stream) */ -class SR_API Input : public UserOwned +class SR_API Input : public UserOwned { public: /** Virtual device associated with this input. */ @@ -838,115 +828,124 @@ public: void send(void *data, size_t length); /** Signal end of input data. */ void end(); -protected: +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 */ class SR_API InputDevice : - public ParentOwned, + public ParentOwned, public Device { -protected: +private: InputDevice(shared_ptr input, struct sr_dev_inst *sdi); ~InputDevice(); shared_ptr get_shared_from_this(); shared_ptr _input; friend class Input; + friend struct std::default_delete; }; /** An option used by an output format */ -class SR_API Option : public UserOwned +class SR_API Option : public UserOwned