Fix #1607 by ignoring common read-only config keys
[pulseview.git] / 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                 string descr_str;
63                 try {
64                         descr_str = key->description();
65                 } catch (Error& e) {
66                         descr_str = key->name();
67                 }
68                 const QString descr = QString::fromStdString(descr_str);
69
70                 auto capabilities = configurable->config_capabilities(key);
71
72                 if (!capabilities.count(Capability::GET) ||
73                         !capabilities.count(Capability::SET)) {
74
75                         // Ignore common read-only keys
76                         if ((key->id() == SR_CONF_CONTINUOUS) || (key->id() == SR_CONF_TRIGGER_MATCH) ||
77                             (key->id() == SR_CONF_CONN) || (key->id() == SR_CONF_SERIALCOMM))
78                                 continue;
79
80                         qDebug() << QString(tr("Note for device developers: Ignoring device configuration capability '%1' " \
81                                 "as it is missing GET and/or SET")).arg(descr);
82                         continue;
83                 }
84
85                 const Property::Getter get = [&, key]() {
86                         return configurable_->config_get(key); };
87                 const Property::Setter set = [&, key](Glib::VariantBase value) {
88                         configurable_->config_set(key, value);
89                         config_changed();
90                 };
91
92                 switch (key->id()) {
93                 case SR_CONF_SAMPLERATE:
94                         // Sample rate values are not bound because they are shown
95                         // in the MainBar
96                         break;
97
98                 case SR_CONF_CAPTURE_RATIO:
99                         bind_int(descr, "", "%", pair<int64_t, int64_t>(0, 100), get, set);
100                         break;
101
102                 case SR_CONF_LIMIT_FRAMES:
103                         // Value 0 means that there is no limit
104                         bind_int(descr, "", "", pair<int64_t, int64_t>(0, 1000000), get, set,
105                                 tr("No Limit"));
106                         break;
107
108                 case SR_CONF_PATTERN_MODE:
109                 case SR_CONF_BUFFERSIZE:
110                 case SR_CONF_TRIGGER_SOURCE:
111                 case SR_CONF_TRIGGER_SLOPE:
112                 case SR_CONF_COUPLING:
113                 case SR_CONF_CLOCK_EDGE:
114                 case SR_CONF_DATA_SOURCE:
115                 case SR_CONF_EXTERNAL_CLOCK_SOURCE:
116                         bind_enum(descr, "", key, capabilities, get, set);
117                         break;
118
119                 case SR_CONF_FILTER:
120                 case SR_CONF_EXTERNAL_CLOCK:
121                 case SR_CONF_RLE:
122                 case SR_CONF_POWER_OFF:
123                 case SR_CONF_AVERAGING:
124                         bind_bool(descr, "", get, set);
125                         break;
126
127                 case SR_CONF_TIMEBASE:
128                         bind_enum(descr, "", key, capabilities, get, set, print_timebase);
129                         break;
130
131                 case SR_CONF_VDIV:
132                         bind_enum(descr, "", key, capabilities, get, set, print_vdiv);
133                         break;
134
135                 case SR_CONF_VOLTAGE_THRESHOLD:
136                         bind_enum(descr, "", key, capabilities, get, set, print_voltage_threshold);
137                         break;
138
139                 case SR_CONF_PROBE_FACTOR:
140                         if (capabilities.count(Capability::LIST))
141                                 bind_enum(descr, "", key, capabilities, get, set, print_probe_factor);
142                         else
143                                 bind_int(descr, "", "", pair<int64_t, int64_t>(1, 500), get, set);
144                         break;
145
146                 case SR_CONF_AVG_SAMPLES:
147                         if (capabilities.count(Capability::LIST))
148                                 bind_enum(descr, "", key, capabilities, get, set, print_averages);
149                         else
150                                 bind_int(descr, "", "", pair<int64_t, int64_t>(0, INT32_MAX), get, set);
151                         break;
152
153                 default:
154                         break;
155                 }
156         }
157 }
158
159 void Device::bind_bool(const QString &name, const QString &desc,
160         Property::Getter getter, Property::Setter setter)
161 {
162         assert(configurable_);
163         properties_.push_back(shared_ptr<Property>(new Bool(
164                 name, desc, getter, setter)));
165 }
166
167 void Device::bind_enum(const QString &name, const QString &desc,
168         const ConfigKey *key, set<const Capability *> capabilities,
169         Property::Getter getter,
170         Property::Setter setter, function<QString (Glib::VariantBase)> printer)
171 {
172         assert(configurable_);
173
174         if (!capabilities.count(Capability::LIST))
175                 return;
176
177         try {
178                 Glib::VariantContainerBase gvar = configurable_->config_list(key);
179                 Glib::VariantIter iter(gvar);
180
181                 vector< pair<Glib::VariantBase, QString> > values;
182                 while ((iter.next_value(gvar)))
183                         values.emplace_back(gvar, printer(gvar));
184
185                 properties_.push_back(shared_ptr<Property>(new Enum(name, desc, values,
186                         getter, setter)));
187
188         } catch (sigrok::Error& e) {
189                 qDebug() << "Error: Listing device key" << name << "failed!";
190                 return;
191         }
192 }
193
194 void Device::bind_int(const QString &name, const QString &desc, QString suffix,
195         optional< pair<int64_t, int64_t> > range, Property::Getter getter,
196         Property::Setter setter, QString special_value_text)
197 {
198         assert(configurable_);
199
200         properties_.push_back(shared_ptr<Property>(new Int(name, desc, suffix,
201                 range, getter, setter, special_value_text)));
202 }
203
204 QString Device::print_timebase(Glib::VariantBase gvar)
205 {
206         uint64_t p, q;
207         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
208         return QString::fromUtf8(sr_period_string(p, q));
209 }
210
211 QString Device::print_vdiv(Glib::VariantBase gvar)
212 {
213         uint64_t p, q;
214         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
215         return QString::fromUtf8(sr_voltage_string(p, q));
216 }
217
218 QString Device::print_voltage_threshold(Glib::VariantBase gvar)
219 {
220         gdouble lo, hi;
221         g_variant_get(gvar.gobj(), "(dd)", &lo, &hi);
222         return QString("L<%1V H>%2V").arg(lo, 0, 'f', 1).arg(hi, 0, 'f', 1);
223 }
224
225 QString Device::print_probe_factor(Glib::VariantBase gvar)
226 {
227         uint64_t factor;
228         factor = g_variant_get_uint64(gvar.gobj());
229         return QString("%1x").arg(factor);
230 }
231
232 QString Device::print_averages(Glib::VariantBase gvar)
233 {
234         uint64_t avg;
235         avg = g_variant_get_uint64(gvar.gobj());
236         return QString("%1").arg(avg);
237 }
238
239 }  // namespace binding
240 }  // namespace pv