]> sigrok.org Git - libsigrok.git/blobdiff - bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
C++: Make some methods static to match the C API
[libsigrok.git] / bindings / cxx / include / libsigrokcxx / libsigrokcxx.hpp
index 2441c2c37b9933f3f602498bf422d79f0938645c..6fdb153fe14a6af86310f2ada0783cd24e8ba1bf 100644 (file)
@@ -91,7 +91,6 @@ class SR_API Driver;
 class SR_API Device;
 class SR_API HardwareDevice;
 class SR_API Channel;
-class SR_API EventSource;
 class SR_API Session;
 class SR_API ConfigKey;
 class SR_API InputFormat;
@@ -121,10 +120,10 @@ 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. */
@@ -164,7 +163,7 @@ public:
 
                if (!(shared = _weak_this.lock()))
                {
-                       shared = shared_ptr<Class>((Class *) this, reset_parent);
+                       shared = shared_ptr<Class>(static_cast<Class *>(this), reset_parent);
                        _weak_this = shared;
                }
 
@@ -195,7 +194,7 @@ protected:
 
        Struct *_structure;
 
-       ParentOwned<Class, Parent, Struct>(Struct *structure) :
+       explicit ParentOwned(Struct *structure) :
                _structure(structure)
        {
        }
@@ -216,7 +215,7 @@ public:
 protected:
        Struct *_structure;
 
-       UserOwned<Class, Struct>(Struct *structure) :
+       explicit UserOwned(Struct *structure) :
                _structure(structure)
        {
        }
@@ -247,11 +246,11 @@ 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;
 };
 
@@ -262,9 +261,9 @@ public:
        /** Create new context */
        static shared_ptr<Context> 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<string, shared_ptr<Driver> > drivers();
        /** Available input formats, indexed by name. */
@@ -293,15 +292,15 @@ public:
        shared_ptr<Packet> create_header_packet(Glib::TimeVal start_time);
        /** Create a meta packet. */
        shared_ptr<Packet> create_meta_packet(
-               map<const ConfigKey *, Glib::VariantBase> config);
+               const map<const ConfigKey *, Glib::VariantBase> &config);
        /** Create a logic packet. */
        shared_ptr<Packet> create_logic_packet(
                void *data_pointer, size_t data_length, unsigned int unit_size);
        /** Create an analog packet. */
        shared_ptr<Packet> create_analog_packet(
-               vector<shared_ptr<Channel> > channels,
+               const vector<shared_ptr<Channel> > &channels,
                float *data_pointer, unsigned int num_samples, const Quantity *mq,
-               const Unit *unit, vector<const QuantityFlag *> mqflags);
+               const Unit *unit, const vector<const QuantityFlag *> &mqflags);
        /** Load a saved session.
         * @param filename File name string. */
        shared_ptr<Session> load_session(string filename);
@@ -344,7 +343,7 @@ public:
        /** 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);
@@ -376,12 +375,11 @@ public:
        /** 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 =
-                       map<const ConfigKey *, Glib::VariantBase>());
+               const map<const ConfigKey *, Glib::VariantBase> &options = {});
 protected:
        bool _initialized;
        vector<HardwareDevice *> _devices;
-       Driver(struct sr_dev_driver *structure);
+       explicit Driver(struct sr_dev_driver *structure);
        ~Driver();
        friend class Context;
        friend class HardwareDevice;
@@ -411,7 +409,7 @@ public:
        /** Close device. */
        void close();
 protected:
-       Device(struct sr_dev_inst *structure);
+       explicit Device(struct sr_dev_inst *structure);
        ~Device();
        virtual shared_ptr<Device> get_shared_from_this() = 0;
        shared_ptr<Channel> get_channel(struct sr_channel *ptr);
@@ -498,7 +496,7 @@ public:
        /** Get the index number of this channel. */
        unsigned int index();
 protected:
-       Channel(struct sr_channel *structure);
+       explicit Channel(struct sr_channel *structure);
        ~Channel();
        const ChannelType * const _type;
        friend class Device;
@@ -566,7 +564,7 @@ public:
        void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
 protected:
        vector<TriggerMatch *> _matches;
-       TriggerStage(struct sr_trigger_stage *structure);
+       explicit TriggerStage(struct sr_trigger_stage *structure);
        ~TriggerStage();
        friend class Trigger;
 };
@@ -610,78 +608,13 @@ protected:
        friend class Session;
 };
 
-/** Type of source callback */
-typedef function<bool(Glib::IOCondition)>
-       SourceCallbackFunction;
-
-/* Data required for C callback function to call a C++ source callback */
-class SR_PRIV SourceCallbackData
-{
-public:
-       bool run(int revents);
-protected:
-       SourceCallbackData(shared_ptr<EventSource> source);
-       shared_ptr<EventSource> _source;
-       friend class Session;
-};
-
-/** An I/O event source */
-class SR_API EventSource
-{
-public:
-       /** 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
-        * @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
-        * @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);
-protected:
-       EventSource(int timeout, SourceCallbackFunction callback);
-       ~EventSource();
-       enum source_type {
-               SOURCE_FD,
-               SOURCE_POLLFD,
-               SOURCE_IOCHANNEL
-       } _type;
-       int _fd;
-       Glib::PollFD _pollfd;
-       Glib::RefPtr<Glib::IOChannel> _channel;
-       Glib::IOCondition _events;
-       int _timeout;
-       SourceCallbackFunction _callback;
-       /** Deleter needed to allow shared_ptr use with protected destructor. */
-       class Deleter
-       {
-       public:
-               void operator()(EventSource *source) { delete source; }
-       };
-       friend class Deleter;
-       friend class Session;
-       friend class SourceCallbackData;
-};
-
 /** A virtual device associated with a stored session */
 class SR_API SessionDevice :
        public ParentOwned<SessionDevice, Session, struct sr_dev_inst>,
        public Device
 {
 protected:
-       SessionDevice(struct sr_dev_inst *sdi);
+       explicit SessionDevice(struct sr_dev_inst *sdi);
        ~SessionDevice();
        shared_ptr<Device> get_shared_from_this();
        /** Deleter needed to allow shared_ptr use with protected destructor. */
@@ -710,12 +643,6 @@ public:
        void add_datafeed_callback(DatafeedCallbackFunction callback);
        /** Remove all datafeed callbacks from this session. */
        void remove_datafeed_callbacks();
-       /** Add an I/O event source.
-        * @param source EventSource to add. */
-       void add_source(shared_ptr<EventSource> source);
-       /** Remove an event source.
-        * @param source EventSource to remove. */
-       void remove_source(shared_ptr<EventSource> source);
        /** Start the session. */
        void start();
        /** Run the session event loop. */
@@ -736,7 +663,7 @@ public:
        /** Get filename this session was loaded from. */
        string filename();
 protected:
-       Session(shared_ptr<Context> context);
+       explicit Session(shared_ptr<Context> context);
        Session(shared_ptr<Context> context, string filename);
        ~Session();
        shared_ptr<Device> get_device(const struct sr_dev_inst *sdi);
@@ -745,7 +672,6 @@ protected:
        map<const struct sr_dev_inst *, shared_ptr<Device> > _other_devices;
        vector<DatafeedCallbackData *> _datafeed_callbacks;
        SessionStoppedCallback _stopped_callback;
-       map<shared_ptr<EventSource>, SourceCallbackData *> _source_callbacks;
        string _filename;
        shared_ptr<Trigger> _trigger;
        friend class Deleter;
@@ -808,7 +734,7 @@ public:
        /* Start time of this session. */
        Glib::TimeVal start_time();
 protected:
-       Header(const struct sr_datafeed_header *structure);
+       explicit Header(const struct sr_datafeed_header *structure);
        ~Header();
        shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        friend class Packet;
@@ -823,7 +749,7 @@ public:
        /* Mapping of (ConfigKey, value) pairs. */
        map<const ConfigKey *, Glib::VariantBase> config();
 protected:
-       Meta(const struct sr_datafeed_meta *structure);
+       explicit Meta(const struct sr_datafeed_meta *structure);
        ~Meta();
        shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        map<const ConfigKey *, Glib::VariantBase> _config;
@@ -843,7 +769,7 @@ public:
        /* Size of each sample in bytes. */
        unsigned int unit_size();
 protected:
-       Logic(const struct sr_datafeed_logic *structure);
+       explicit Logic(const struct sr_datafeed_logic *structure);
        ~Logic();
        shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        friend class Packet;
@@ -856,9 +782,9 @@ class SR_API Analog :
 {
 public:
        /** Pointer to data. */
-       float *data_pointer();
+       void *data_pointer();
        /** Number of samples in this packet. */
-       unsigned int num_samples();
+       uint32_t num_samples();
        /** Channels for which this packet contains data. */
        vector<shared_ptr<Channel> > channels();
        /** Measured quantity of the samples in this packet. */
@@ -868,7 +794,7 @@ public:
        /** Measurement flags associated with the samples in this packet. */
        vector<const QuantityFlag *> mq_flags();
 protected:
-       Analog(const struct sr_datafeed_analog *structure);
+       explicit Analog(const struct sr_datafeed_analog *structure);
        ~Analog();
        shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
        friend class Packet;
@@ -890,10 +816,9 @@ public:
        map<string, shared_ptr<Option> > 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 =
-               map<string, Glib::VariantBase>());
+       shared_ptr<Input> create_input(const map<string, Glib::VariantBase> &options = {});
 protected:
-       InputFormat(const struct sr_input_module *structure);
+       explicit InputFormat(const struct sr_input_module *structure);
        ~InputFormat();
        friend class Context;
        friend class InputDevice;
@@ -977,16 +902,14 @@ public:
         * @param options Mapping of (option name, value) pairs. */
        shared_ptr<Output> create_output(
                shared_ptr<Device> device,
-               map<string, Glib::VariantBase> options =
-                       map<string, Glib::VariantBase>());
+               const map<string, Glib::VariantBase> &options = {});
        /** Create an output using this format.
         * @param filename Name of destination file.
         * @param device Device to output for.
         * @param options Mapping of (option name, value) pairs. */
        shared_ptr<Output> create_output(string filename,
                shared_ptr<Device> device,
-               map<string, Glib::VariantBase> options =
-                       map<string, Glib::VariantBase>());
+               const map<string, Glib::VariantBase> &options = {});
        /**
         * Checks whether a given flag is set.
         * @param flag Flag to check
@@ -995,7 +918,7 @@ public:
         */
        bool test_flag(const OutputFlag *flag);
 protected:
-       OutputFormat(const struct sr_output_module *structure);
+       explicit OutputFormat(const struct sr_output_module *structure);
        ~OutputFormat();
        friend class Context;
        friend class Output;
@@ -1011,9 +934,9 @@ public:
 protected:
        Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
        Output(shared_ptr<OutputFormat> format,
-               shared_ptr<Device> device, map<string, Glib::VariantBase> options);
+               shared_ptr<Device> device, const map<string, Glib::VariantBase> &options);
        Output(string filename, shared_ptr<OutputFormat> format,
-               shared_ptr<Device> device, map<string, Glib::VariantBase> options);
+               shared_ptr<Device> device, const map<string, Glib::VariantBase> &options);
        ~Output();
        const shared_ptr<OutputFormat> _format;
        const shared_ptr<Device> _device;