pv/popups/channels.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 <map>
  21
  22 #include <QApplication>
  23 #include <QCheckBox>
  24 #include <QFontMetrics>
  25 #include <QFormLayout>
  26 #include <QGridLayout>
  27 #include <QHBoxLayout>
  28 #include <QLabel>
  29
  30 #include "channels.hpp"
  31
  32 #include <pv/session.hpp>
  33 #include <pv/binding/device.hpp>
  34 #include <pv/data/logic.hpp>
  35 #include <pv/data/logicsegment.hpp>
  36 #include <pv/data/signalbase.hpp>
  37 #include <pv/devices/device.hpp>
  38
  39 using std::make_shared;
  40 using std::map;
  41 using std::out_of_range;
  42 using std::shared_ptr;
  43 using std::unordered_set;
  44 using std::vector;
  45
  46 using pv::data::SignalBase;
  47 using pv::data::Logic;
  48 using pv::data::LogicSegment;
  49
  50 using sigrok::Channel;
  51 using sigrok::ChannelGroup;
  52 using sigrok::Device;
  53
  54 namespace pv {
  55 namespace popups {
  56
  57 Channels::Channels(Session &session, QWidget *parent) :
  58         Popup(parent),
  59         session_(session),
  60         updating_channels_(false),
  61         enable_all_channels_(tr("All"), this),
  62         disable_all_channels_(tr("All"), this),
  63         enable_all_logic_channels_(tr("Logic"), this),
  64         enable_all_analog_channels_(tr("Analog"), this),
  65         enable_all_named_channels_(tr("Named"), this),
  66         enable_all_changing_channels_(tr("Changing"), this),
  67         check_box_mapper_(this)
  68 {
  69         // Create the layout
  70         setLayout(&layout_);
  71
  72         const shared_ptr<sigrok::Device> device = session_.device()->device();
  73         assert(device);
  74
  75         // Collect a set of signals
  76         map<shared_ptr<Channel>, shared_ptr<SignalBase> > signal_map;
  77
  78         unordered_set< shared_ptr<SignalBase> > sigs;
  79         for (const shared_ptr<data::SignalBase> b : session_.signalbases())
  80                 sigs.insert(b);
  81
  82         for (const shared_ptr<SignalBase> &sig : sigs)
  83                 signal_map[sig->channel()] = sig;
  84
  85         // Populate channel groups
  86         for (auto entry : device->channel_groups()) {
  87                 const shared_ptr<ChannelGroup> group = entry.second;
  88                 // Make a set of signals and remove these signals from the signal map
  89                 vector< shared_ptr<SignalBase> > group_sigs;
  90                 for (auto channel : group->channels()) {
  91                         const auto iter = signal_map.find(channel);
  92
  93                         if (iter == signal_map.end())
  94                                 break;
  95
  96                         group_sigs.push_back((*iter).second);
  97                         signal_map.erase(iter);
  98                 }
  99
 100                 populate_group(group, group_sigs);
 101         }
 102
 103         // Make a vector of the remaining channels
 104         vector< shared_ptr<SignalBase> > global_analog_sigs, global_logic_sigs;
 105         for (auto channel : device->channels()) {
 106                 const map<shared_ptr<Channel>, shared_ptr<SignalBase> >::
 107                         const_iterator iter = signal_map.find(channel);
 108
 109                 if (iter != signal_map.end()) {
 110                         const shared_ptr<SignalBase> signal = (*iter).second;
 111                         if (signal->type() == SignalBase::AnalogChannel)
 112                                 global_analog_sigs.push_back(signal);
 113                         else
 114                                 global_logic_sigs.push_back(signal);
 115                 }
 116         }
 117
 118         // Create the groups for the ungrouped channels
 119         populate_group(nullptr, global_logic_sigs);
 120         populate_group(nullptr, global_analog_sigs);
 121
 122         // Create the enable/disable all buttons
 123         connect(&enable_all_channels_, SIGNAL(clicked()), this, SLOT(enable_all_channels()));
 124         connect(&disable_all_channels_, SIGNAL(clicked()), this, SLOT(disable_all_channels()));
 125         connect(&enable_all_logic_channels_, SIGNAL(clicked()), this, SLOT(enable_all_logic_channels()));
 126         connect(&enable_all_analog_channels_, SIGNAL(clicked()), this, SLOT(enable_all_analog_channels()));
 127         connect(&enable_all_named_channels_, SIGNAL(clicked()), this, SLOT(enable_all_named_channels()));
 128         connect(&enable_all_changing_channels_, SIGNAL(clicked()),
 129                 this, SLOT(enable_all_changing_channels()));
 130
 131         QLabel *label1 = new QLabel(tr("Disable: "));
 132         buttons_bar_.addWidget(label1);
 133         buttons_bar_.addWidget(&disable_all_channels_);
 134         QLabel *label2 = new QLabel(tr("Enable: "));
 135         buttons_bar_.addWidget(label2);
 136         buttons_bar_.addWidget(&enable_all_channels_);
 137         buttons_bar_.addWidget(&enable_all_logic_channels_);
 138         buttons_bar_.addWidget(&enable_all_analog_channels_);
 139         buttons_bar_.addWidget(&enable_all_named_channels_);
 140         buttons_bar_.addWidget(&enable_all_changing_channels_);
 141         buttons_bar_.addStretch();
 142
 143         layout_.addRow(&buttons_bar_);
 144
 145         // Connect the check-box signal mapper
 146         connect(&check_box_mapper_, SIGNAL(mapped(QWidget*)),
 147                 this, SLOT(on_channel_checked(QWidget*)));
 148 }
 149
 150 void Channels::set_all_channels(bool set)
 151 {
 152         updating_channels_ = true;
 153
 154         for (auto entry : check_box_signal_map_) {
 155                 QCheckBox *cb = entry.first;
 156                 const shared_ptr<SignalBase> sig = entry.second;
 157                 assert(sig);
 158
 159                 sig->set_enabled(set);
 160                 cb->setChecked(set);
 161         }
 162
 163         updating_channels_ = false;
 164 }
 165
 166 void Channels::set_all_channels_conditionally(
 167         function<bool (const shared_ptr<data::SignalBase>)> cond_func)
 168 {
 169         updating_channels_ = true;
 170
 171         for (auto entry : check_box_signal_map_) {
 172                 QCheckBox *cb = entry.first;
 173                 const shared_ptr<SignalBase> sig = entry.second;
 174                 assert(sig);
 175
 176                 const bool state = cond_func(sig);
 177                 sig->set_enabled(state);
 178                 cb->setChecked(state);
 179         }
 180
 181         updating_channels_ = false;
 182 }
 183
 184 void Channels::populate_group(shared_ptr<ChannelGroup> group,
 185         const vector< shared_ptr<SignalBase> > sigs)
 186 {
 187         using pv::binding::Device;
 188
 189         // Only bind options if this is a group. We don't do it for general
 190         // options, because these properties are shown in the device config
 191         // popup.
 192         shared_ptr<Device> binding;
 193         if (group)
 194                 binding = make_shared<Device>(group);
 195
 196         // Create a title if the group is going to have any content
 197         if ((!sigs.empty() || (binding && !binding->properties().empty())) && group)
 198         {
 199                 QLabel *label = new QLabel(
 200                         QString("<h3>%1</h3>").arg(group->name().c_str()));
 201                 layout_.addRow(label);
 202                 group_label_map_[group] = label;
 203         }
 204
 205         // Create the channel group grid
 206         QGridLayout *const channel_grid = create_channel_group_grid(sigs);
 207         layout_.addRow(channel_grid);
 208
 209         // Create the channel group options
 210         if (binding) {
 211                 binding->add_properties_to_form(&layout_, true);
 212                 group_bindings_.push_back(binding);
 213         }
 214 }
 215
 216 QGridLayout* Channels::create_channel_group_grid(
 217         const vector< shared_ptr<SignalBase> > sigs)
 218 {
 219         int row = 0, col = 0;
 220         QGridLayout *const grid = new QGridLayout();
 221
 222         for (const shared_ptr<SignalBase>& sig : sigs) {
 223                 assert(sig);
 224
 225                 QCheckBox *const checkbox = new QCheckBox(sig->display_name());
 226                 check_box_mapper_.setMapping(checkbox, checkbox);
 227                 connect(checkbox, SIGNAL(toggled(bool)),
 228                         &check_box_mapper_, SLOT(map()));
 229
 230                 grid->addWidget(checkbox, row, col);
 231
 232                 check_box_signal_map_[checkbox] = sig;
 233
 234                 if (++col >= 8)
 235                         col = 0, row++;
 236         }
 237
 238         return grid;
 239 }
 240
 241 void Channels::showEvent(QShowEvent *event)
 242 {
 243         pv::widgets::Popup::showEvent(event);
 244
 245         const shared_ptr<sigrok::Device> device = session_.device()->device();
 246         assert(device);
 247
 248         // Update group labels
 249         for (auto entry : device->channel_groups()) {
 250                 const shared_ptr<ChannelGroup> group = entry.second;
 251
 252                 try {
 253                         QLabel* label = group_label_map_.at(group);
 254                         label->setText(QString("<h3>%1</h3>").arg(group->name().c_str()));
 255                 } catch (out_of_range&) {
 256                         // Do nothing
 257                 }
 258         }
 259
 260         updating_channels_ = true;
 261
 262         for (auto entry : check_box_signal_map_) {
 263                 QCheckBox *cb = entry.first;
 264                 const shared_ptr<SignalBase> sig = entry.second;
 265                 assert(sig);
 266
 267                 // Update the check box
 268                 cb->setChecked(sig->enabled());
 269                 cb->setText(sig->display_name());
 270         }
 271
 272         updating_channels_ = false;
 273 }
 274
 275 void Channels::on_channel_checked(QWidget *widget)
 276 {
 277         if (updating_channels_)
 278                 return;
 279
 280         QCheckBox *const check_box = (QCheckBox*)widget;
 281         assert(check_box);
 282
 283         // Look up the signal of this check-box
 284         map< QCheckBox*, shared_ptr<SignalBase> >::const_iterator iter =
 285                 check_box_signal_map_.find((QCheckBox*)check_box);
 286         assert(iter != check_box_signal_map_.end());
 287
 288         const shared_ptr<SignalBase> s = (*iter).second;
 289         assert(s);
 290
 291         s->set_enabled(check_box->isChecked());
 292 }
 293
 294 void Channels::enable_all_channels()
 295 {
 296         set_all_channels(true);
 297 }
 298
 299 void Channels::disable_all_channels()
 300 {
 301         set_all_channels(false);
 302 }
 303
 304 void Channels::enable_all_logic_channels()
 305 {
 306         set_all_channels_conditionally([](const shared_ptr<SignalBase> signal)
 307                 { return signal->type() == SignalBase::LogicChannel; });
 308 }
 309
 310 void Channels::enable_all_analog_channels()
 311 {
 312         set_all_channels_conditionally([](const shared_ptr<SignalBase> signal)
 313                 { return signal->type() == SignalBase::AnalogChannel; });
 314 }
 315
 316 void Channels::enable_all_named_channels()
 317 {
 318         set_all_channels_conditionally([](const shared_ptr<SignalBase> signal)
 319                 { return signal->name() != signal->internal_name(); });
 320 }
 321
 322 void Channels::enable_all_changing_channels()
 323 {
 324         set_all_channels_conditionally([](const shared_ptr<SignalBase> signal)
 325                 {
 326                         // Never enable channels without sample data
 327                         if (!signal->has_samples())
 328                                 return false;
 329
 330                         // Non-logic channels are considered to always have a signal
 331                         if (signal->type() != SignalBase::LogicChannel)
 332                                 return true;
 333
 334                         const shared_ptr<Logic> logic = signal->logic_data();
 335                         assert(logic);
 336
 337                         // If any of the segments has edges, enable this channel
 338                         for (shared_ptr<LogicSegment> segment : logic->logic_segments()) {
 339                                 vector<LogicSegment::EdgePair> edges;
 340
 341                                 segment->get_subsampled_edges(edges,
 342                                         0, segment->get_sample_count() - 1,
 343                                         LogicSegment::MipMapScaleFactor,
 344                                         signal->index());
 345
 346                                 if (edges.size() > 2)
 347                                         return true;
 348                         }
 349
 350                         // No edges detected in any of the segments
 351                         return false;
 352                 });
 353 }
 354
 355 }  // namespace popups
 356 }  // namespace pv