pv/binding/device.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <cstdint>
  21
  22 #include <QDebug>
  23
  24 #include "device.hpp"
  25
  26 #include <pv/prop/bool.hpp>
  27 #include <pv/prop/enum.hpp>
  28 #include <pv/prop/int.hpp>
  29
  30 #include <libsigrokcxx/libsigrokcxx.hpp>
  31
  32 using boost::optional;
  33
  34 using std::function;
  35 using std::pair;
  36 using std::set;
  37 using std::shared_ptr;
  38 using std::string;
  39 using std::vector;
  40
  41 using sigrok::Capability;
  42 using sigrok::Configurable;
  43 using sigrok::ConfigKey;
  44 using sigrok::Error;
  45
  46 using pv::prop::Bool;
  47 using pv::prop::Enum;
  48 using pv::prop::Int;
  49 using pv::prop::Property;
  50
  51 namespace pv {
  52 namespace binding {
  53
  54 Device::Device(shared_ptr<sigrok::Configurable> configurable) :
  55         configurable_(configurable)
  56 {
  57
  58         auto keys = configurable->config_keys();
  59
  60         for (auto key : keys) {
  61
  62                 auto capabilities = configurable->config_capabilities(key);
  63
  64                 if (!capabilities.count(Capability::GET) ||
  65                         !capabilities.count(Capability::SET))
  66                         continue;
  67
  68                 string name_str;
  69                 try {
  70                         name_str = key->description();
  71                 } catch (Error& e) {
  72                         name_str = key->name();
  73                 }
  74
  75                 const QString name = QString::fromStdString(name_str);
  76
  77                 const Property::Getter get = [&, key]() {
  78                         return configurable_->config_get(key); };
  79                 const Property::Setter set = [&, key](Glib::VariantBase value) {
  80                         configurable_->config_set(key, value);
  81                         config_changed();
  82                 };
  83
  84                 switch (key->id()) {
  85                 case SR_CONF_SAMPLERATE:
  86                         // Sample rate values are not bound because they are shown
  87                         // in the MainBar
  88                         break;
  89
  90                 case SR_CONF_CAPTURE_RATIO:
  91                         bind_int(name, "", "%", pair<int64_t, int64_t>(0, 100), get, set);
  92                         break;
  93
  94                 case SR_CONF_LIMIT_FRAMES:
  95                         // Value 0 means that there is no limit
  96                         bind_int(name, "", "", pair<int64_t, int64_t>(0, 1000000), get, set,
  97                                 tr("No Limit"));
  98                         break;
  99
 100                 case SR_CONF_PATTERN_MODE:
 101                 case SR_CONF_BUFFERSIZE:
 102                 case SR_CONF_TRIGGER_SOURCE:
 103                 case SR_CONF_TRIGGER_SLOPE:
 104                 case SR_CONF_COUPLING:
 105                 case SR_CONF_CLOCK_EDGE:
 106                 case SR_CONF_DATA_SOURCE:
 107                 case SR_CONF_EXTERNAL_CLOCK_SOURCE:
 108                         bind_enum(name, "", key, capabilities, get, set);
 109                         break;
 110
 111                 case SR_CONF_FILTER:
 112                 case SR_CONF_EXTERNAL_CLOCK:
 113                 case SR_CONF_RLE:
 114                 case SR_CONF_POWER_OFF:
 115                 case SR_CONF_AVERAGING:
 116                         bind_bool(name, "", get, set);
 117                         break;
 118
 119                 case SR_CONF_TIMEBASE:
 120                         bind_enum(name, "", key, capabilities, get, set, print_timebase);
 121                         break;
 122
 123                 case SR_CONF_VDIV:
 124                         bind_enum(name, "", key, capabilities, get, set, print_vdiv);
 125                         break;
 126
 127                 case SR_CONF_VOLTAGE_THRESHOLD:
 128                         bind_enum(name, "", key, capabilities, get, set, print_voltage_threshold);
 129                         break;
 130
 131                 case SR_CONF_PROBE_FACTOR:
 132                         if (capabilities.count(Capability::LIST))
 133                                 bind_enum(name, "", key, capabilities, get, set, print_probe_factor);
 134                         else
 135                                 bind_int(name, "", "", pair<int64_t, int64_t>(1, 500), get, set);
 136                         break;
 137
 138                 case SR_CONF_AVG_SAMPLES:
 139                         if (capabilities.count(Capability::LIST))
 140                                 bind_enum(name, "", key, capabilities, get, set, print_averages);
 141                         else
 142                                 bind_int(name, "", "", pair<int64_t, int64_t>(0, INT32_MAX), get, set);
 143                         break;
 144
 145                 default:
 146                         break;
 147                 }
 148         }
 149 }
 150
 151 void Device::bind_bool(const QString &name, const QString &desc,
 152         Property::Getter getter, Property::Setter setter)
 153 {
 154         assert(configurable_);
 155         properties_.push_back(shared_ptr<Property>(new Bool(
 156                 name, desc, getter, setter)));
 157 }
 158
 159 void Device::bind_enum(const QString &name, const QString &desc,
 160         const ConfigKey *key, set<const Capability *> capabilities,
 161         Property::Getter getter,
 162         Property::Setter setter, function<QString (Glib::VariantBase)> printer)
 163 {
 164         assert(configurable_);
 165
 166         if (!capabilities.count(Capability::LIST))
 167                 return;
 168
 169         try {
 170                 Glib::VariantContainerBase gvar = configurable_->config_list(key);
 171                 Glib::VariantIter iter(gvar);
 172
 173                 vector< pair<Glib::VariantBase, QString> > values;
 174                 while ((iter.next_value(gvar)))
 175                         values.emplace_back(gvar, printer(gvar));
 176
 177                 properties_.push_back(shared_ptr<Property>(new Enum(name, desc, values,
 178                         getter, setter)));
 179
 180         } catch (sigrok::Error& e) {
 181                 qDebug() << "Error: Listing device key" << name << "failed!";
 182                 return;
 183         }
 184 }
 185
 186 void Device::bind_int(const QString &name, const QString &desc, QString suffix,
 187         optional< pair<int64_t, int64_t> > range, Property::Getter getter,
 188         Property::Setter setter, QString special_value_text)
 189 {
 190         assert(configurable_);
 191
 192         properties_.push_back(shared_ptr<Property>(new Int(name, desc, suffix,
 193                 range, getter, setter, special_value_text)));
 194 }
 195
 196 QString Device::print_timebase(Glib::VariantBase gvar)
 197 {
 198         uint64_t p, q;
 199         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 200         return QString::fromUtf8(sr_period_string(p, q));
 201 }
 202
 203 QString Device::print_vdiv(Glib::VariantBase gvar)
 204 {
 205         uint64_t p, q;
 206         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 207         return QString::fromUtf8(sr_voltage_string(p, q));
 208 }
 209
 210 QString Device::print_voltage_threshold(Glib::VariantBase gvar)
 211 {
 212         gdouble lo, hi;
 213         g_variant_get(gvar.gobj(), "(dd)", &lo, &hi);
 214         return QString("L<%1V H>%2V").arg(lo, 0, 'f', 1).arg(hi, 0, 'f', 1);
 215 }
 216
 217 QString Device::print_probe_factor(Glib::VariantBase gvar)
 218 {
 219         uint64_t factor;
 220         factor = g_variant_get_uint64(gvar.gobj());
 221         return QString("%1x").arg(factor);
 222 }
 223
 224 QString Device::print_averages(Glib::VariantBase gvar)
 225 {
 226         uint64_t avg;
 227         avg = g_variant_get_uint64(gvar.gobj());
 228         return QString("%1").arg(avg);
 229 }
 230
 231 }  // namespace binding
 232 }  // namespace pv