X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fcxx%2Finclude%2Flibsigrokcxx%2Flibsigrokcxx.hpp;h=6fdb153fe14a6af86310f2ada0783cd24e8ba1bf;hb=a73d49263611b0d65a3ca1ad85bbee592cf1a234;hp=0701688db5f46bacdfa373749c6a679c2b0d0444;hpb=161dc24d845acfc00108dd33eac7c42430d21e17;p=libsigrok.git diff --git a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp index 0701688d..6fdb153f 100644 --- a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp +++ b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp @@ -70,7 +70,7 @@ raised, which provides access to the error code and description. #ifndef LIBSIGROKCXX_HPP #define LIBSIGROKCXX_HPP -#include "libsigrok/libsigrok.h" +#include #include #include @@ -91,11 +91,11 @@ 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; class SR_API OutputFormat; +class SR_API OutputFlag; class SR_API LogLevel; class SR_API ChannelGroup; class SR_API Trigger; @@ -120,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. */ @@ -163,7 +163,7 @@ public: if (!(shared = _weak_this.lock())) { - shared = shared_ptr((Class *) this, reset_parent); + shared = shared_ptr(static_cast(this), reset_parent); _weak_this = shared; } @@ -194,7 +194,7 @@ protected: Struct *_structure; - ParentOwned(Struct *structure) : + explicit ParentOwned(Struct *structure) : _structure(structure) { } @@ -215,7 +215,7 @@ public: protected: Struct *_structure; - UserOwned(Struct *structure) : + explicit UserOwned(Struct *structure) : _structure(structure) { } @@ -231,6 +231,29 @@ protected: /** Type of log callback */ typedef function LogCallbackFunction; +/** Resource reader delegate. */ +class SR_API ResourceReader +{ +public: + ResourceReader() {} + virtual ~ResourceReader(); +private: + /** Resource open hook. */ + virtual void open(struct sr_resource *res, string name) = 0; + /** Resource close hook. */ + virtual void close(struct sr_resource *res) = 0; + /** Resource read hook. */ + 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) 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, + void *buf, size_t count, void *cb_data) noexcept; + friend class Context; +}; + /** The global libsigrok context */ class SR_API Context : public UserOwned { @@ -238,9 +261,9 @@ 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. */ @@ -252,16 +275,14 @@ public: /** Set the log level. * @param level LogLevel to use. */ void set_log_level(const LogLevel *level); - /** Current log domain. */ - string log_domain(); - /** Set the log domain. - * @param value Log domain prefix string. */ - void set_log_domain(string value); /** Set the log callback. * @param callback Callback of the form callback(LogLevel, string). */ void set_log_callback(LogCallbackFunction callback); /** Set the log callback to the default handler. */ void set_log_callback_default(); + /** Install a delegate for reading resource files. + * @param reader The resource reader delegate, or nullptr to unset. */ + void set_resource_reader(ResourceReader *reader); /** Create a new session. */ shared_ptr create_session(); /** Create a new user device. */ @@ -271,15 +292,15 @@ public: shared_ptr create_header_packet(Glib::TimeVal start_time); /** Create a meta packet. */ shared_ptr create_meta_packet( - map config); + const 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( - vector > channels, + const vector > &channels, float *data_pointer, unsigned int num_samples, const Quantity *mq, - const Unit *unit, vector mqflags); + const Unit *unit, const vector &mqflags); /** Load a saved session. * @param filename File name string. */ shared_ptr load_session(string filename); @@ -322,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); @@ -354,12 +375,11 @@ public: /** Scan for devices and return a list of devices found. * @param options Mapping of (ConfigKey, value) pairs. */ vector > scan( - map options = - map()); + const map &options = {}); protected: bool _initialized; vector _devices; - Driver(struct sr_dev_driver *structure); + explicit Driver(struct sr_dev_driver *structure); ~Driver(); friend class Context; friend class HardwareDevice; @@ -389,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 get_shared_from_this() = 0; shared_ptr get_channel(struct sr_channel *ptr); @@ -476,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; @@ -544,7 +564,7 @@ public: void add_match(shared_ptr channel, const TriggerMatchType *type, float value); protected: vector _matches; - TriggerStage(struct sr_trigger_stage *structure); + explicit TriggerStage(struct sr_trigger_stage *structure); ~TriggerStage(); friend class Trigger; }; @@ -567,6 +587,9 @@ protected: friend class TriggerStage; }; +/** Type of session stopped callback */ +typedef function SessionStoppedCallback; + /** Type of datafeed callback */ typedef function, shared_ptr)> DatafeedCallbackFunction; @@ -585,78 +608,13 @@ protected: friend class Session; }; -/** Type of source callback */ -typedef function - 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 source); - shared_ptr _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 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 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 create( - Glib::RefPtr 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 _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, public Device { protected: - SessionDevice(struct sr_dev_inst *sdi); + explicit SessionDevice(struct sr_dev_inst *sdi); ~SessionDevice(); shared_ptr get_shared_from_this(); /** Deleter needed to allow shared_ptr use with protected destructor. */ @@ -685,26 +643,16 @@ 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 source); - /** Remove an event source. - * @param source EventSource to remove. */ - void remove_source(shared_ptr source); /** Start the session. */ void start(); /** Run the session event loop. */ void run(); /** Stop the session. */ void stop(); - /** Begin saving session to a file. - * @param filename File name string. */ - void begin_save(string filename); - /** Append a packet to the session file being saved. - * @param packet Packet to append. */ - void append(shared_ptr packet); - /** Append raw logic data to the session file being saved. */ - void append(void *data, size_t length, unsigned int unit_size); + /** Return whether the session is running. */ + bool is_running() const; + /** Set callback to be invoked on session stop. */ + void set_stopped_callback(SessionStoppedCallback callback); /** Get current trigger setting. */ shared_ptr trigger(); /** Get the context. */ @@ -715,7 +663,7 @@ public: /** Get filename this session was loaded from. */ string filename(); protected: - Session(shared_ptr context); + explicit Session(shared_ptr context); Session(shared_ptr context, string filename); ~Session(); shared_ptr get_device(const struct sr_dev_inst *sdi); @@ -723,12 +671,8 @@ protected: map _owned_devices; map > _other_devices; vector _datafeed_callbacks; - map, SourceCallbackData *> _source_callbacks; + SessionStoppedCallback _stopped_callback; string _filename; - bool _saving; - bool _save_initialized; - string _save_filename; - uint64_t _save_samplerate; shared_ptr _trigger; friend class Deleter; friend class Context; @@ -790,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 get_shared_pointer(Packet *parent); friend class Packet; @@ -805,7 +749,7 @@ public: /* Mapping of (ConfigKey, value) pairs. */ map config(); protected: - Meta(const struct sr_datafeed_meta *structure); + explicit Meta(const struct sr_datafeed_meta *structure); ~Meta(); shared_ptr get_shared_pointer(Packet *parent); map _config; @@ -825,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 get_shared_pointer(Packet *parent); friend class Packet; @@ -838,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 > channels(); /** Measured quantity of the samples in this packet. */ @@ -850,7 +794,7 @@ public: /** Measurement flags associated with the samples in this packet. */ vector mq_flags(); protected: - Analog(const struct sr_datafeed_analog *structure); + explicit Analog(const struct sr_datafeed_analog *structure); ~Analog(); shared_ptr get_shared_pointer(Packet *parent); friend class Packet; @@ -865,14 +809,16 @@ public: string name(); /** Description of this input format. */ string description(); + /** A list of preferred file name extensions for this file format. + * @note This list is a recommendation only. */ + vector extensions(); /** 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()); + shared_ptr create_input(const map &options = {}); protected: - InputFormat(const struct sr_input_module *structure); + explicit InputFormat(const struct sr_input_module *structure); ~InputFormat(); friend class Context; friend class InputDevice; @@ -885,8 +831,9 @@ public: /** Virtual device associated with this input. */ shared_ptr device(); /** Send next stream data. - * @param data Next stream data. */ - void send(string data); + * @param data Next stream data. + * @param length Length of data. */ + void send(void *data, size_t length); /** Signal end of input data. */ void end(); protected: @@ -945,16 +892,33 @@ public: string name(); /** Description of this output format. */ string description(); + /** A list of preferred file name extensions for this file format. + * @note This list is a recommendation only. */ + vector extensions(); /** Options supported by this output format. */ map > options(); /** Create an output using this format. * @param device Device to output for. * @param options Mapping of (option name, value) pairs. */ - shared_ptr create_output(shared_ptr device, - map options = - map()); -protected: - OutputFormat(const struct sr_output_module *structure); + shared_ptr create_output( + shared_ptr device, + const map &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 create_output(string filename, + shared_ptr device, + const map &options = {}); + /** + * Checks whether a given flag is set. + * @param flag Flag to check + * @return true if flag is set for this module + * @see sr_output_flags + */ + bool test_flag(const OutputFlag *flag); +protected: + explicit OutputFormat(const struct sr_output_module *structure); ~OutputFormat(); friend class Context; friend class Output; @@ -970,7 +934,9 @@ public: protected: Output(shared_ptr format, shared_ptr device); Output(shared_ptr format, - shared_ptr device, map options); + shared_ptr device, const map &options); + Output(string filename, shared_ptr format, + shared_ptr device, const map &options); ~Output(); const shared_ptr _format; const shared_ptr _device; @@ -1021,7 +987,7 @@ protected: const string _name; }; -#include "enums.hpp" +#include }