Fix #1607 by ignoring common read-only config keys

[pulseview.git] / pv / binding / device.cpp

diff --git a/pv/binding/device.cpp b/pv/binding/device.cpp
index 401644fd0672fa616c5c21586f619590e8b1cff1..7bbc1bbf52839618a3e5905a82bf29fb1794689c 100644 (file)
--- a/pv/binding/device.cpp
+++ b/pv/binding/device.cpp
@@ -32,7 +32,6 @@
 using boost::optional;
 
 using std::function;
-using std::make_pair;
 using std::pair;
 using std::set;
 using std::shared_ptr;
@@ -60,20 +59,28 @@ Device::Device(shared_ptr<sigrok::Configurable> configurable) :
 
        for (auto key : keys) {
 
+               string descr_str;
+               try {
+                       descr_str = key->description();
+               } catch (Error& e) {
+                       descr_str = key->name();
+               }
+               const QString descr = QString::fromStdString(descr_str);
+
                auto capabilities = configurable->config_capabilities(key);
 
                if (!capabilities.count(Capability::GET) ||
-                       !capabilities.count(Capability::SET))
-                       continue;
+                       !capabilities.count(Capability::SET)) {
 
-               string name_str;
-               try {
-                       name_str = key->description();
-               } catch (Error e) {
-                       name_str = key->name();
-               }
+                       // Ignore common read-only keys
+                       if ((key->id() == SR_CONF_CONTINUOUS) || (key->id() == SR_CONF_TRIGGER_MATCH) ||
+                           (key->id() == SR_CONF_CONN) || (key->id() == SR_CONF_SERIALCOMM))
+                               continue;
 
-               const QString name = QString::fromStdString(name_str);
+                       qDebug() << QString(tr("Note for device developers: Ignoring device configuration capability '%1' " \
+                               "as it is missing GET and/or SET")).arg(descr);
+                       continue;
+               }
 
                const Property::Getter get = [&, key]() {
                        return configurable_->config_get(key); };
@@ -89,8 +96,13 @@ Device::Device(shared_ptr<sigrok::Configurable> configurable) :
                        break;
 
                case SR_CONF_CAPTURE_RATIO:
-                       bind_int(name, "", "%", pair<int64_t, int64_t>(0, 100),
-                               get, set);
+                       bind_int(descr, "", "%", pair<int64_t, int64_t>(0, 100), get, set);
+                       break;
+
+               case SR_CONF_LIMIT_FRAMES:
+                       // Value 0 means that there is no limit
+                       bind_int(descr, "", "", pair<int64_t, int64_t>(0, 1000000), get, set,
+                               tr("No Limit"));
                        break;
 
                case SR_CONF_PATTERN_MODE:
@@ -99,33 +111,43 @@ Device::Device(shared_ptr<sigrok::Configurable> configurable) :
                case SR_CONF_TRIGGER_SLOPE:
                case SR_CONF_COUPLING:
                case SR_CONF_CLOCK_EDGE:
-                       bind_enum(name, "", key, capabilities, get, set);
+               case SR_CONF_DATA_SOURCE:
+               case SR_CONF_EXTERNAL_CLOCK_SOURCE:
+                       bind_enum(descr, "", key, capabilities, get, set);
                        break;
 
                case SR_CONF_FILTER:
                case SR_CONF_EXTERNAL_CLOCK:
                case SR_CONF_RLE:
                case SR_CONF_POWER_OFF:
-                       bind_bool(name, "", get, set);
+               case SR_CONF_AVERAGING:
+                       bind_bool(descr, "", get, set);
                        break;
 
                case SR_CONF_TIMEBASE:
-                       bind_enum(name, "", key, capabilities, get, set, print_timebase);
+                       bind_enum(descr, "", key, capabilities, get, set, print_timebase);
                        break;
 
                case SR_CONF_VDIV:
-                       bind_enum(name, "", key, capabilities, get, set, print_vdiv);
+                       bind_enum(descr, "", key, capabilities, get, set, print_vdiv);
                        break;
 
                case SR_CONF_VOLTAGE_THRESHOLD:
-                       bind_enum(name, "", key, capabilities, get, set, print_voltage_threshold);
+                       bind_enum(descr, "", key, capabilities, get, set, print_voltage_threshold);
                        break;
 
                case SR_CONF_PROBE_FACTOR:
                        if (capabilities.count(Capability::LIST))
-                               bind_enum(name, "", key, capabilities, get, set, print_probe_factor);
+                               bind_enum(descr, "", key, capabilities, get, set, print_probe_factor);
                        else
-                               bind_int(name, "", "", pair<int64_t, int64_t>(1, 500), get, set);
+                               bind_int(descr, "", "", pair<int64_t, int64_t>(1, 500), get, set);
+                       break;
+
+               case SR_CONF_AVG_SAMPLES:
+                       if (capabilities.count(Capability::LIST))
+                               bind_enum(descr, "", key, capabilities, get, set, print_averages);
+                       else
+                               bind_int(descr, "", "", pair<int64_t, int64_t>(0, INT32_MAX), get, set);
                        break;
 
                default:
@@ -147,30 +169,36 @@ void Device::bind_enum(const QString &name, const QString &desc,
        Property::Getter getter,
        Property::Setter setter, function<QString (Glib::VariantBase)> printer)
 {
-       Glib::VariantBase gvar;
-       vector< pair<Glib::VariantBase, QString> > values;
-
        assert(configurable_);
 
        if (!capabilities.count(Capability::LIST))
                return;
 
-       Glib::VariantIter iter(configurable_->config_list(key));
-       while ((iter.next_value(gvar)))
-               values.push_back(make_pair(gvar, printer(gvar)));
+       try {
+               Glib::VariantContainerBase gvar = configurable_->config_list(key);
+               Glib::VariantIter iter(gvar);
 
-       properties_.push_back(shared_ptr<Property>(new Enum(name, desc, values,
-               getter, setter)));
+               vector< pair<Glib::VariantBase, QString> > values;
+               while ((iter.next_value(gvar)))
+                       values.emplace_back(gvar, printer(gvar));
+
+               properties_.push_back(shared_ptr<Property>(new Enum(name, desc, values,
+                       getter, setter)));
+
+       } catch (sigrok::Error& e) {
+               qDebug() << "Error: Listing device key" << name << "failed!";
+               return;
+       }
 }
 
 void Device::bind_int(const QString &name, const QString &desc, QString suffix,
-       optional< pair<int64_t, int64_t> > range,
-       Property::Getter getter, Property::Setter setter)
+       optional< pair<int64_t, int64_t> > range, Property::Getter getter,
+       Property::Setter setter, QString special_value_text)
 {
        assert(configurable_);
 
        properties_.push_back(shared_ptr<Property>(new Int(name, desc, suffix,
-               range, getter, setter)));
+               range, getter, setter, special_value_text)));
 }
 
 QString Device::print_timebase(Glib::VariantBase gvar)
@@ -201,5 +229,12 @@ QString Device::print_probe_factor(Glib::VariantBase gvar)
        return QString("%1x").arg(factor);
 }
 
+QString Device::print_averages(Glib::VariantBase gvar)
+{
+       uint64_t avg;
+       avg = g_variant_get_uint64(gvar.gobj());
+       return QString("%1").arg(avg);
+}
+
 }  // namespace binding
 }  // namespace pv