X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fcxx%2Finclude%2Flibsigrok%2Flibsigrok.hpp;h=15509c9c5803ac805956a8f7f648fe98502e95a1;hb=3b161085731fc6e86f7decedee34f55096282581;hp=2a819b09c9649ff0a16636ac2296e936b60c7be8;hpb=edbd09250b185950646ee5928b2e7112161168cc;p=libsigrok.git diff --git a/bindings/cxx/include/libsigrok/libsigrok.hpp b/bindings/cxx/include/libsigrok/libsigrok.hpp index 2a819b09..15509c9c 100644 --- a/bindings/cxx/include/libsigrok/libsigrok.hpp +++ b/bindings/cxx/include/libsigrok/libsigrok.hpp @@ -142,10 +142,10 @@ 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; + shared_ptr _parent; /* Weak pointer for shared_from_this() implementation. */ - weak_ptr weak_this; + weak_ptr _weak_this; public: /* Note, this implementation will create a new smart_ptr if none exists. */ @@ -153,10 +153,10 @@ public: { shared_ptr shared; - if (!(shared = weak_this.lock())) + if (!(shared = _weak_this.lock())) { shared = shared_ptr((Class *) this, reset_parent); - weak_this = shared; + _weak_this = shared; } return shared; @@ -166,7 +166,7 @@ public: { if (!parent) throw Error(SR_ERR_BUG); - this->parent = parent; + this->_parent = parent; return shared_from_this(); } @@ -179,15 +179,15 @@ public: protected: static void reset_parent(Class *object) { - if (!object->parent) + if (!object->_parent) throw Error(SR_ERR_BUG); - object->parent.reset(); + object->_parent.reset(); } - Struct *structure; + Struct *_structure; ParentOwned(Struct *structure) : - structure(structure) + _structure(structure) { } }; @@ -205,10 +205,10 @@ public: return shared; } protected: - Struct *structure; + Struct *_structure; UserOwned(Struct *structure) : - structure(structure) + _structure(structure) { } @@ -230,22 +230,22 @@ public: /** Create new context */ static shared_ptr create(); /** libsigrok package version. */ - string get_package_version(); + string package_version(); /** libsigrok library version. */ - string get_lib_version(); + string lib_version(); /** Available hardware drivers, indexed by name. */ - map > get_drivers(); + map > drivers(); /** Available input formats, indexed by name. */ - map > get_input_formats(); + map > input_formats(); /** Available output formats, indexed by name. */ - map > get_output_formats(); + map > output_formats(); /** Current log level. */ - const LogLevel *get_log_level(); + const LogLevel *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(); + string log_domain(); /** Set the log domain. * @param value Log domain prefix string. */ void set_log_domain(string value); @@ -269,11 +269,11 @@ public: * @param header Initial data from stream. */ shared_ptr open_stream(string header); protected: - map drivers; - map input_formats; - map output_formats; - Session *session; - LogCallbackFunction log_callback; + map _drivers; + map _input_formats; + map _output_formats; + Session *_session; + LogCallbackFunction _log_callback; Context(); ~Context(); friend class Deleter; @@ -317,16 +317,16 @@ class SR_API Driver : { public: /** Name of this driver. */ - string get_name(); + string name(); /** Long name for this driver. */ - string get_long_name(); + string long_name(); /** Scan for devices and return a list of devices found. * @param options Mapping of (ConfigKey, value) pairs. */ vector > scan( map options = {}); protected: - bool initialized; - vector devices; + bool _initialized; + vector _devices; Driver(struct sr_dev_driver *structure); ~Driver(); friend class Context; @@ -339,17 +339,17 @@ class SR_API Device : public Configurable { public: /** Description identifying this device. */ - string get_description(); + string description(); /** Vendor name for this device. */ - string get_vendor(); + string vendor(); /** Model name for this device. */ - string get_model(); + string model(); /** Version string for this device. */ - string get_version(); + string version(); /** List of the channels available on this device. */ - vector > get_channels(); + vector > channels(); /** Channel groups available on this device, indexed by name. */ - map > get_channel_groups(); + map > channel_groups(); /** Open device. */ void open(); /** Close device. */ @@ -359,9 +359,9 @@ protected: ~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; + struct sr_dev_inst *_structure; + map _channels; + map _channel_groups; /** Deleter needed to allow shared_ptr use with protected destructor. */ class Deleter { @@ -383,12 +383,12 @@ class SR_API HardwareDevice : { public: /** Driver providing this device. */ - shared_ptr get_driver(); + shared_ptr driver(); protected: HardwareDevice(Driver *driver, struct sr_dev_inst *structure); ~HardwareDevice(); shared_ptr get_shared_from_this(); - Driver *driver; + Driver *_driver; friend class Driver; friend class ChannelGroup; }; @@ -399,23 +399,23 @@ class SR_API Channel : { public: /** Current name of this channel. */ - string get_name(); + string name(); /** 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(); + const ChannelType *type(); /** Enabled status of this channel. */ - bool get_enabled(); + bool enabled(); /** 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(); + unsigned int index(); protected: Channel(struct sr_channel *structure); ~Channel(); - const ChannelType * const type; + const ChannelType * const _type; friend class Device; friend class ChannelGroup; friend class Session; @@ -429,13 +429,13 @@ class SR_API ChannelGroup : { public: /** Name of this channel group. */ - string get_name(); + string name(); /** List of the channels in this group. */ - vector > get_channels(); + vector > channels(); protected: ChannelGroup(Device *device, struct sr_channel_group *structure); ~ChannelGroup(); - vector channels; + vector _channels; friend class Device; }; @@ -444,16 +444,16 @@ class SR_API Trigger : public UserOwned { public: /** Name of this trigger configuration. */ - string get_name(); + string name(); /** List of the stages in this trigger. */ - vector > get_stages(); + vector > stages(); /** Add a new stage to this trigger. */ shared_ptr add_stage(); protected: Trigger(shared_ptr context, string name); ~Trigger(); - shared_ptr context; - vector stages; + shared_ptr _context; + vector _stages; friend class Deleter; friend class Context; friend class Session; @@ -465,9 +465,9 @@ class SR_API TriggerStage : { public: /** Index number of this stage. */ - int get_number(); + int number(); /** List of match conditions on this stage. */ - vector > get_matches(); + vector > matches(); /** Add a new match condition to this stage. * @param channel Channel to match on. * @param type TriggerMatchType to apply. */ @@ -478,7 +478,7 @@ public: * @param value Threshold value. */ void add_match(shared_ptr channel, const TriggerMatchType *type, float value); protected: - vector matches; + vector _matches; TriggerStage(struct sr_trigger_stage *structure); ~TriggerStage(); friend class Trigger; @@ -490,15 +490,15 @@ class SR_API TriggerMatch : { public: /** Channel this condition matches on. */ - shared_ptr get_channel(); + shared_ptr channel(); /** Type of match. */ - const TriggerMatchType *get_type(); + const TriggerMatchType *type(); /** Threshold value. */ - float get_value(); + float value(); protected: TriggerMatch(struct sr_trigger_match *structure, shared_ptr channel); ~TriggerMatch(); - shared_ptr channel; + shared_ptr _channel; friend class TriggerStage; }; @@ -513,10 +513,10 @@ public: void run(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *pkt); protected: - DatafeedCallbackFunction callback; + DatafeedCallbackFunction _callback; DatafeedCallbackData(Session *session, DatafeedCallbackFunction callback); - Session *session; + Session *_session; friend class Session; }; @@ -531,7 +531,7 @@ public: bool run(int revents); protected: SourceCallbackData(shared_ptr source); - shared_ptr source; + shared_ptr _source; friend class Session; }; @@ -567,13 +567,13 @@ protected: SOURCE_FD, SOURCE_POLLFD, SOURCE_IOCHANNEL - } type; - int fd; - Glib::PollFD pollfd; - Glib::RefPtr channel; - Glib::IOCondition events; - int timeout; - SourceCallbackFunction callback; + } _type; + int _fd; + Glib::PollFD _pollfd; + Glib::RefPtr _channel; + Glib::IOCondition _events; + int _timeout; + SourceCallbackFunction _callback; /** Deleter needed to allow shared_ptr use with protected destructor. */ class Deleter { @@ -612,7 +612,7 @@ public: * @param device Device to add. */ void add_device(shared_ptr device); /** List devices attached to this session. */ - vector > get_devices(); + vector > devices(); /** Remove all devices from this session. */ void remove_devices(); /** Add a datafeed callback to this session. @@ -641,7 +641,7 @@ public: /** 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 get_trigger(); + shared_ptr trigger(); /** Set trigger setting. * @param trigger Trigger object to use. */ void set_trigger(shared_ptr trigger); @@ -649,15 +649,15 @@ protected: Session(shared_ptr context); Session(shared_ptr context, string filename); ~Session(); - const shared_ptr context; - map > devices; - vector datafeed_callbacks; - map, SourceCallbackData *> source_callbacks; - bool saving; - bool save_initialized; - string save_filename; - uint64_t save_samplerate; - shared_ptr trigger; + const shared_ptr _context; + map > _devices; + vector _datafeed_callbacks; + map, SourceCallbackData *> _source_callbacks; + bool _saving; + bool _save_initialized; + string _save_filename; + uint64_t _save_samplerate; + shared_ptr _trigger; friend class Deleter; friend class Context; friend class DatafeedCallbackData; @@ -668,15 +668,15 @@ class SR_API Packet : public UserOwned { public: /** Type of this packet. */ - const PacketType *get_type(); + const PacketType *type(); /** Payload of this packet. */ - shared_ptr get_payload(); + shared_ptr payload(); protected: Packet(shared_ptr device, const struct sr_datafeed_packet *structure); ~Packet(); - shared_ptr device; - PacketPayload *payload; + shared_ptr _device; + PacketPayload *_payload; friend class Deleter; friend class Session; friend class Output; @@ -712,9 +712,9 @@ class SR_API Header : { public: /* Feed version number. */ - int get_feed_version(); + int feed_version(); /* Start time of this session. */ - Glib::TimeVal get_start_time(); + Glib::TimeVal start_time(); protected: Header(const struct sr_datafeed_header *structure); ~Header(); @@ -729,12 +729,12 @@ class SR_API Meta : { public: /* Mapping of (ConfigKey, value) pairs. */ - map get_config(); + map config(); protected: Meta(const struct sr_datafeed_meta *structure); ~Meta(); shared_ptr get_shared_pointer(Packet *parent); - map config; + map _config; friend class Packet; }; @@ -745,11 +745,11 @@ class SR_API Logic : { public: /* Pointer to data. */ - void *get_data_pointer(); + void *data_pointer(); /* Data length in bytes. */ - size_t get_data_length(); + size_t data_length(); /* Size of each sample in bytes. */ - unsigned int get_unit_size(); + unsigned int unit_size(); protected: Logic(const struct sr_datafeed_logic *structure); ~Logic(); @@ -764,17 +764,17 @@ class SR_API Analog : { public: /** Pointer to data. */ - float *get_data_pointer(); + float *data_pointer(); /** Number of samples in this packet. */ - unsigned int get_num_samples(); + unsigned int num_samples(); /** Channels for which this packet contains data. */ - vector > get_channels(); + vector > channels(); /** Measured quantity of the samples in this packet. */ - const Quantity *get_mq(); + const Quantity *mq(); /** Unit of the samples in this packet. */ - const Unit *get_unit(); + const Unit *unit(); /** Measurement flags associated with the samples in this packet. */ - vector get_mq_flags(); + vector mq_flags(); protected: Analog(const struct sr_datafeed_analog *structure); ~Analog(); @@ -788,11 +788,11 @@ class SR_API InputFormat : { public: /** Name of this input format. */ - string get_name(); + string name(); /** Description of this input format. */ - string get_description(); + string description(); /** Options supported by this input format. */ - map > get_options(); + map > options(); /** Create an input using this input format. * @param options Mapping of (option name, value) pairs. */ shared_ptr create_input(map options = {}); @@ -808,15 +808,15 @@ class SR_API Input : public UserOwned { public: /** Virtual device associated with this input. */ - shared_ptr get_device(); + shared_ptr device(); /** Send next stream data. * @param data Next stream data. */ void send(string data); protected: Input(shared_ptr context, const struct sr_input *structure); ~Input(); - shared_ptr context; - InputDevice *device; + shared_ptr _context; + InputDevice *_device; friend class Deleter; friend class Context; friend class InputFormat; @@ -831,7 +831,7 @@ protected: InputDevice(shared_ptr input, struct sr_dev_inst *sdi); ~InputDevice(); shared_ptr get_shared_from_this(); - shared_ptr input; + shared_ptr _input; friend class Input; }; @@ -840,20 +840,20 @@ class SR_API Option : public UserOwned { public: /** Short name of this option suitable for command line usage. */ - string get_id(); + string id(); /** Short name of this option suitable for GUI usage. */ - string get_name(); + string name(); /** Description of this option in a sentence. */ - string get_description(); + string description(); /** Default value for this option. */ - Glib::VariantBase get_default_value(); + Glib::VariantBase default_value(); /** Possible values for this option, if a limited set. */ - vector get_values(); + vector values(); protected: Option(const struct sr_option *structure, shared_ptr structure_array); ~Option(); - shared_ptr structure_array; + shared_ptr _structure_array; friend class Deleter; friend class InputFormat; friend class OutputFormat; @@ -865,11 +865,11 @@ class SR_API OutputFormat : { public: /** Name of this output format. */ - string get_name(); + string name(); /** Description of this output format. */ - string get_description(); + string description(); /** Options supported by this output format. */ - map > get_options(); + map > options(); /** Create an output using this format. * @param device Device to output for. * @param options Mapping of (option name, value) pairs. */ @@ -894,9 +894,9 @@ protected: Output(shared_ptr format, shared_ptr device, map options); ~Output(); - const shared_ptr format; - const shared_ptr device; - const map options; + const shared_ptr _format; + const shared_ptr _device; + const map _options; friend class Deleter; friend class OutputFormat; }; @@ -906,14 +906,14 @@ template class SR_API EnumValue { public: /** The enum constant associated with this value. */ - T get_id() const { return id; } + T id() const { return _id; } /** The name associated with this value. */ - string get_name() const { return name; } + string name() const { return _name; } protected: - EnumValue(T id, const char name[]) : id(id), name(name) {} + EnumValue(T id, const char name[]) : _id(id), _name(name) {} ~EnumValue() {} - const T id; - const string name; + const T _id; + const string _name; }; #include "enums.hpp"