bindings: New configuration enumeration API.

[libsigrok.git] / bindings / cxx / include / libsigrokcxx / libsigrokcxx.hpp

diff --git a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
index cf86bfc3170fd3daf05593e0eb558b520f3efd11..1db6c7dfecf0cd502ed646266fc46cc5ff62148b 100644 (file)
--- 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 <libsigrok/libsigrok.h>
+
+/* 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 <glibmm.h>
+G_GNUC_END_IGNORE_DEPRECATIONS
 
 #include <stdexcept>
 #include <memory>
@@ -93,6 +98,7 @@ class SR_API HardwareDevice;
 class SR_API Channel;
 class SR_API Session;
 class SR_API ConfigKey;
+class SR_API Capability;
 class SR_API InputFormat;
 class SR_API OutputFormat;
 class SR_API OutputFlag;
@@ -302,19 +308,15 @@ private:
        ~Context();
        friend class Session;
        friend class Driver;
-       friend class std::default_delete<Context>;
-};
-
-enum Capability {
-       GET = SR_CONF_GET,
-       SET = SR_CONF_SET,
-       LIST = SR_CONF_LIST
+       friend struct std::default_delete<Context>;
 };
 
 /** An object that can be configured. */
 class SR_API Configurable
 {
 public:
+       /** Supported configuration keys. */
+       set<const ConfigKey *> config_keys() const;
        /** Read configuration for the given key.
         * @param key ConfigKey to read. */
        Glib::VariantBase config_get(const ConfigKey *key) const;
@@ -325,10 +327,13 @@ public:
        /** Enumerate available values for the given configuration key.
         * @param key ConfigKey to enumerate values for. */
        Glib::VariantContainerBase config_list(const ConfigKey *key) const;
-       /** Enumerate available keys, according to a given index key. */
-       map<const ConfigKey *, set<enum Capability> > 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) const;
+       /** Enumerate configuration capabilities for the given configuration key.
+        * @param key ConfigKey to enumerate capabilities for. */
+       set<const Capability *> 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. */
+       bool config_check(const ConfigKey *key, const Capability *capability) const;
 protected:
        Configurable(
                struct sr_dev_driver *driver,
@@ -341,15 +346,15 @@ protected:
 };
 
 /** A hardware driver provided by the library */
-class SR_API Driver :
-       public ParentOwned<Driver, Context>,
-       public Configurable
+class SR_API Driver : public ParentOwned<Driver, Context>, public Configurable
 {
 public:
        /** Name of this driver. */
        string name() const;
        /** Long name for this driver. */
        string long_name() const;
+       /** Scan options supported by this driver. */
+       set<const ConfigKey *> scan_options() const;
        /** 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>
@@ -363,7 +368,7 @@ private:
        friend class Context;
        friend class HardwareDevice;
        friend class ChannelGroup;
-       friend class std::default_delete<Driver>;
+       friend struct std::default_delete<Driver>;
 };
 
 /** A generic device, either hardware or virtual */
@@ -404,7 +409,7 @@ private:
        friend class ChannelGroup;
        friend class Output;
        friend class Analog;
-       friend class std::default_delete<Device>;
+       friend struct std::default_delete<Device>;
 };
 
 /** A real hardware device, connected via a driver */
@@ -423,7 +428,7 @@ private:
 
        friend class Driver;
        friend class ChannelGroup;
-       friend class std::default_delete<HardwareDevice>;
+       friend struct std::default_delete<HardwareDevice>;
 };
 
 /** A virtual device, created by the user */
@@ -440,7 +445,7 @@ private:
        shared_ptr<Device> get_shared_from_this();
 
        friend class Context;
-       friend class std::default_delete<UserDevice>;
+       friend struct std::default_delete<UserDevice>;
 };
 
 /** A channel on a device */
@@ -473,7 +478,7 @@ private:
        friend class Session;
        friend class TriggerStage;
        friend class Context;
-       friend class std::default_delete<Channel>;
+       friend struct std::default_delete<Channel>;
 };
 
 /** A group of channels on a device, which share some configuration */
@@ -491,7 +496,7 @@ private:
        ~ChannelGroup();
        vector<Channel *> _channels;
        friend class Device;
-       friend class std::default_delete<ChannelGroup>;
+       friend struct std::default_delete<ChannelGroup>;
 };
 
 /** A trigger configuration */
@@ -512,7 +517,7 @@ private:
        vector<unique_ptr<TriggerStage> > _stages;
        friend class Context;
        friend class Session;
-       friend class std::default_delete<Trigger>;
+       friend struct std::default_delete<Trigger>;
 };
 
 /** A stage in a trigger configuration */
@@ -539,7 +544,7 @@ private:
        explicit TriggerStage(struct sr_trigger_stage *structure);
        ~TriggerStage();
        friend class Trigger;
-       friend class std::default_delete<TriggerStage>;
+       friend struct std::default_delete<TriggerStage>;
 };
 
 /** A match condition in a trigger configuration  */
@@ -559,7 +564,7 @@ private:
        struct sr_trigger_match *_structure;
        shared_ptr<Channel> _channel;
        friend class TriggerStage;
-       friend class std::default_delete<TriggerMatch>;
+       friend struct std::default_delete<TriggerMatch>;
 };
 
 /** Type of session stopped callback */
@@ -594,7 +599,7 @@ private:
        shared_ptr<Device> get_shared_from_this();
 
        friend class Session;
-       friend class std::default_delete<SessionDevice>;
+       friend struct std::default_delete<SessionDevice>;
 };
 
 /** A sigrok session */
@@ -649,7 +654,7 @@ private:
        friend class Context;
        friend class DatafeedCallbackData;
        friend class SessionDevice;
-       friend class std::default_delete<Session>;
+       friend struct std::default_delete<Session>;
 };
 
 /** A packet on the session datafeed */
@@ -676,7 +681,7 @@ private:
        friend class Logic;
        friend class Analog;
        friend class Context;
-       friend class std::default_delete<Packet>;
+       friend struct std::default_delete<Packet>;
 };
 
 /** Abstract base class for datafeed packet payloads */
@@ -690,7 +695,7 @@ private:
 
        friend class Packet;
        friend class Output;
-       friend class std::default_delete<PacketPayload>;
+       friend struct std::default_delete<PacketPayload>;
 };
 
 /** Payload of a datafeed header packet */
@@ -808,7 +813,7 @@ private:
 
        friend class Context;
        friend class InputDevice;
-       friend class std::default_delete<InputFormat>;
+       friend struct std::default_delete<InputFormat>;
 };
 
 /** An input instance (an input format applied to a file or stream) */
@@ -832,7 +837,7 @@ private:
 
        friend class Context;
        friend class InputFormat;
-       friend class std::default_delete<Input>;
+       friend struct std::default_delete<Input>;
 };
 
 /** A virtual device associated with an input */
@@ -846,7 +851,7 @@ private:
        shared_ptr<Device> get_shared_from_this();
        shared_ptr<Input> _input;
        friend class Input;
-       friend class std::default_delete<InputDevice>;
+       friend struct std::default_delete<InputDevice>;
 };
 
 /** An option used by an output format */
@@ -872,7 +877,7 @@ private:
 
        friend class InputFormat;
        friend class OutputFormat;
-       friend class std::default_delete<Option>;
+       friend struct std::default_delete<Option>;
 };
 
 /** An output format supported by the library */
@@ -916,7 +921,7 @@ private:
 
        friend class Context;
        friend class Output;
-       friend class std::default_delete<OutputFormat>;
+       friend struct std::default_delete<OutputFormat>;
 };
 
 /** An output instance (an output format applied to a device) */
@@ -940,7 +945,7 @@ private:
        const map<string, Glib::VariantBase> _options;
 
        friend class OutputFormat;
-       friend class std::default_delete<Output>;
+       friend struct std::default_delete<Output>;
 };
 
 /** Base class for objects which wrap an enumeration value from libsigrok */