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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <stdint.h>
  22
  23 #include <QDebug>
  24
  25 #include "device.hpp"
  26
  27 #include <pv/prop/bool.hpp>
  28 #include <pv/prop/double.hpp>
  29 #include <pv/prop/enum.hpp>
  30 #include <pv/prop/int.hpp>
  31
  32 #include <libsigrokcxx/libsigrokcxx.hpp>
  33
  34 using boost::optional;
  35 using std::function;
  36 using std::make_pair;
  37 using std::pair;
  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::Double;
  49 using pv::prop::Enum;
  50 using pv::prop::Int;
  51 using pv::prop::Property;
  52
  53 namespace pv {
  54 namespace binding {
  55
  56 Device::Device(shared_ptr<sigrok::Configurable> configurable) :
  57         configurable_(configurable)
  58 {
  59         std::map< const ConfigKey*, std::set<Capability> > keys;
  60
  61         try {
  62                 keys = configurable->config_keys(ConfigKey::DEVICE_OPTIONS);
  63         } catch (const Error) {
  64                 return;
  65         }
  66
  67         for (auto entry : keys) {
  68                 auto key = entry.first;
  69                 auto capabilities = entry.second;
  70
  71                 if (!capabilities.count(Capability::GET) ||
  72                         !capabilities.count(Capability::SET))
  73                         continue;
  74
  75                 string name_str;
  76                 try {
  77                         name_str = key->description();
  78                 } catch (Error e) {
  79                         name_str = key->name();
  80                 }
  81
  82                 const QString name = QString::fromStdString(name_str);
  83
  84                 const Property::Getter get = [&, key]() {
  85                         return configurable_->config_get(key); };
  86                 const Property::Setter set = [&, key](Glib::VariantBase value) {
  87                         configurable_->config_set(key, value);
  88                         config_changed();
  89                 };
  90
  91                 switch (key->id()) {
  92                 case SR_CONF_SAMPLERATE:
  93                         // Sample rate values are not bound because they are shown
  94                         // in the MainBar
  95                         break;
  96
  97                 case SR_CONF_CAPTURE_RATIO:
  98                         bind_int(name, "%", pair<int64_t, int64_t>(0, 100),
  99                                 get, set);
 100                         break;
 101
 102                 case SR_CONF_PATTERN_MODE:
 103                 case SR_CONF_BUFFERSIZE:
 104                 case SR_CONF_TRIGGER_SOURCE:
 105                 case SR_CONF_TRIGGER_SLOPE:
 106                 case SR_CONF_FILTER:
 107                 case SR_CONF_COUPLING:
 108                 case SR_CONF_CLOCK_EDGE:
 109                         bind_enum(name, key, capabilities, get, set);
 110                         break;
 111
 112                 case SR_CONF_EXTERNAL_CLOCK:
 113                 case SR_CONF_RLE:
 114                 case SR_CONF_POWER_OFF:
 115                         bind_bool(name, get, set);
 116                         break;
 117
 118                 case SR_CONF_TIMEBASE:
 119                         bind_enum(name, key, capabilities, get, set, print_timebase);
 120                         break;
 121
 122                 case SR_CONF_VDIV:
 123                         bind_enum(name, key, capabilities, get, set, print_vdiv);
 124                         break;
 125
 126                 case SR_CONF_VOLTAGE_THRESHOLD:
 127                         bind_enum(name, key, capabilities, get, set, print_voltage_threshold);
 128                         break;
 129
 130                 case SR_CONF_PROBE_FACTOR:
 131                         bind_int(name, "", pair<int64_t, int64_t>(1, 500), get, set);
 132                         break;
 133
 134                 default:
 135                         break;
 136                 }
 137         }
 138 }
 139
 140 void Device::bind_bool(const QString &name,
 141         Property::Getter getter, Property::Setter setter)
 142 {
 143         assert(configurable_);
 144         properties_.push_back(shared_ptr<Property>(new Bool(
 145                 name, getter, setter)));
 146 }
 147
 148 void Device::bind_enum(const QString &name,
 149         const ConfigKey *key, std::set<Capability> capabilities,
 150         Property::Getter getter,
 151         Property::Setter setter, function<QString (Glib::VariantBase)> printer)
 152 {
 153         Glib::VariantBase gvar;
 154         vector< pair<Glib::VariantBase, QString> > values;
 155
 156         assert(configurable_);
 157
 158         if (!capabilities.count(Capability::LIST))
 159                 return;
 160
 161         Glib::VariantIter iter(configurable_->config_list(key));
 162         while ((iter.next_value(gvar)))
 163                 values.push_back(make_pair(gvar, printer(gvar)));
 164
 165         properties_.push_back(shared_ptr<Property>(new Enum(name, values,
 166                 getter, setter)));
 167 }
 168
 169 void Device::bind_int(const QString &name, QString suffix,
 170         optional< std::pair<int64_t, int64_t> > range,
 171         Property::Getter getter, Property::Setter setter)
 172 {
 173         assert(configurable_);
 174
 175         properties_.push_back(shared_ptr<Property>(new Int(name, suffix, range,
 176                 getter, setter)));
 177 }
 178
 179 QString Device::print_timebase(Glib::VariantBase gvar)
 180 {
 181         uint64_t p, q;
 182         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 183         return QString::fromUtf8(sr_period_string(p * q));
 184 }
 185
 186 QString Device::print_vdiv(Glib::VariantBase gvar)
 187 {
 188         uint64_t p, q;
 189         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 190         return QString::fromUtf8(sr_voltage_string(p, q));
 191 }
 192
 193 QString Device::print_voltage_threshold(Glib::VariantBase gvar)
 194 {
 195         gdouble lo, hi;
 196         g_variant_get(gvar.gobj(), "(dd)", &lo, &hi);
 197         return QString("L<%1V H>%2V").arg(lo, 0, 'f', 1).arg(hi, 0, 'f', 1);
 198 }
 199
 200 } // binding
 201 } // pv