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::make_pair;
  36 using std::pair;
  37 using std::set;
  38 using std::shared_ptr;
  39 using std::string;
  40 using std::vector;
  41
  42 using sigrok::Capability;
  43 using sigrok::Configurable;
  44 using sigrok::ConfigKey;
  45 using sigrok::Error;
  46
  47 using pv::prop::Bool;
  48 using pv::prop::Enum;
  49 using pv::prop::Int;
  50 using pv::prop::Property;
  51
  52 namespace pv {
  53 namespace binding {
  54
  55 Device::Device(shared_ptr<sigrok::Configurable> configurable) :
  56         configurable_(configurable)
  57 {
  58
  59         auto keys = configurable->config_keys();
  60
  61         for (auto key : keys) {
  62
  63                 auto capabilities = configurable->config_capabilities(key);
  64
  65                 if (!capabilities.count(Capability::GET) ||
  66                         !capabilities.count(Capability::SET))
  67                         continue;
  68
  69                 string name_str;
  70                 try {
  71                         name_str = key->description();
  72                 } catch (Error e) {
  73                         name_str = key->name();
  74                 }
  75
  76                 const QString name = QString::fromStdString(name_str);
  77
  78                 const Property::Getter get = [&, key]() {
  79                         return configurable_->config_get(key); };
  80                 const Property::Setter set = [&, key](Glib::VariantBase value) {
  81                         configurable_->config_set(key, value);
  82                         config_changed();
  83                 };
  84
  85                 switch (key->id()) {
  86                 case SR_CONF_SAMPLERATE:
  87                         // Sample rate values are not bound because they are shown
  88                         // in the MainBar
  89                         break;
  90
  91                 case SR_CONF_CAPTURE_RATIO:
  92                         bind_int(name, "", "%", pair<int64_t, int64_t>(0, 100), get, set);
  93                         break;
  94
  95                 case SR_CONF_PATTERN_MODE:
  96                 case SR_CONF_BUFFERSIZE:
  97                 case SR_CONF_TRIGGER_SOURCE:
  98                 case SR_CONF_TRIGGER_SLOPE:
  99                 case SR_CONF_COUPLING:
 100                 case SR_CONF_CLOCK_EDGE:
 101                         bind_enum(name, "", key, capabilities, get, set);
 102                         break;
 103
 104                 case SR_CONF_FILTER:
 105                 case SR_CONF_EXTERNAL_CLOCK:
 106                 case SR_CONF_RLE:
 107                 case SR_CONF_POWER_OFF:
 108                         bind_bool(name, "", get, set);
 109                         break;
 110
 111                 case SR_CONF_TIMEBASE:
 112                         bind_enum(name, "", key, capabilities, get, set, print_timebase);
 113                         break;
 114
 115                 case SR_CONF_VDIV:
 116                         bind_enum(name, "", key, capabilities, get, set, print_vdiv);
 117                         break;
 118
 119                 case SR_CONF_VOLTAGE_THRESHOLD:
 120                         bind_enum(name, "", key, capabilities, get, set, print_voltage_threshold);
 121                         break;
 122
 123                 case SR_CONF_PROBE_FACTOR:
 124                         if (capabilities.count(Capability::LIST))
 125                                 bind_enum(name, "", key, capabilities, get, set, print_probe_factor);
 126                         else
 127                                 bind_int(name, "", "", pair<int64_t, int64_t>(1, 500), get, set);
 128                         break;
 129
 130                 default:
 131                         break;
 132                 }
 133         }
 134 }
 135
 136 void Device::bind_bool(const QString &name, const QString &desc,
 137         Property::Getter getter, Property::Setter setter)
 138 {
 139         assert(configurable_);
 140         properties_.push_back(shared_ptr<Property>(new Bool(
 141                 name, desc, getter, setter)));
 142 }
 143
 144 void Device::bind_enum(const QString &name, const QString &desc,
 145         const ConfigKey *key, set<const Capability *> capabilities,
 146         Property::Getter getter,
 147         Property::Setter setter, function<QString (Glib::VariantBase)> printer)
 148 {
 149         assert(configurable_);
 150
 151         if (!capabilities.count(Capability::LIST))
 152                 return;
 153
 154         try {
 155                 Glib::VariantContainerBase gvar = configurable_->config_list(key);
 156                 Glib::VariantIter iter(gvar);
 157
 158                 vector< pair<Glib::VariantBase, QString> > values;
 159                 while ((iter.next_value(gvar)))
 160                         values.push_back(make_pair(gvar, printer(gvar)));
 161
 162                 properties_.push_back(shared_ptr<Property>(new Enum(name, desc, values,
 163                         getter, setter)));
 164
 165         } catch (sigrok::Error& e) {
 166                 qDebug() << "Error: Listing device key" << name << "failed!";
 167                 return;
 168         }
 169 }
 170
 171 void Device::bind_int(const QString &name, const QString &desc, QString suffix,
 172         optional< pair<int64_t, int64_t> > range,
 173         Property::Getter getter, Property::Setter setter)
 174 {
 175         assert(configurable_);
 176
 177         properties_.push_back(shared_ptr<Property>(new Int(name, desc, suffix,
 178                 range, getter, setter)));
 179 }
 180
 181 QString Device::print_timebase(Glib::VariantBase gvar)
 182 {
 183         uint64_t p, q;
 184         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 185         return QString::fromUtf8(sr_period_string(p, q));
 186 }
 187
 188 QString Device::print_vdiv(Glib::VariantBase gvar)
 189 {
 190         uint64_t p, q;
 191         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 192         return QString::fromUtf8(sr_voltage_string(p, q));
 193 }
 194
 195 QString Device::print_voltage_threshold(Glib::VariantBase gvar)
 196 {
 197         gdouble lo, hi;
 198         g_variant_get(gvar.gobj(), "(dd)", &lo, &hi);
 199         return QString("L<%1V H>%2V").arg(lo, 0, 'f', 1).arg(hi, 0, 'f', 1);
 200 }
 201
 202 QString Device::print_probe_factor(Glib::VariantBase gvar)
 203 {
 204         uint64_t factor;
 205         factor = g_variant_get_uint64(gvar.gobj());
 206         return QString("%1x").arg(factor);
 207 }
 208
 209 }  // namespace binding
 210 }  // namespace pv