Rename create_context_menu() to create_header_context_menu()
[pulseview.git] / 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::enable_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                 if (state) {
178                         sig->set_enabled(state);
179                         cb->setChecked(state);
180                 }
181         }
182
183         updating_channels_ = false;
184 }
185
186 void Channels::populate_group(shared_ptr<ChannelGroup> group,
187         const vector< shared_ptr<SignalBase> > sigs)
188 {
189         using pv::binding::Device;
190
191         // Only bind options if this is a group. We don't do it for general
192         // options, because these properties are shown in the device config
193         // popup.
194         shared_ptr<Device> binding;
195         if (group)
196                 binding = make_shared<Device>(group);
197
198         // Create a title if the group is going to have any content
199         if ((!sigs.empty() || (binding && !binding->properties().empty())) && group)
200         {
201                 QLabel *label = new QLabel(
202                         QString("<h3>%1</h3>").arg(group->name().c_str()));
203                 layout_.addRow(label);
204                 group_label_map_[group] = label;
205         }
206
207         // Create the channel group grid
208         QGridLayout *const channel_grid = create_channel_group_grid(sigs);
209         layout_.addRow(channel_grid);
210
211         // Create the channel group options
212         if (binding) {
213                 binding->add_properties_to_form(&layout_, true);
214                 group_bindings_.push_back(binding);
215         }
216 }
217
218 QGridLayout* Channels::create_channel_group_grid(
219         const vector< shared_ptr<SignalBase> > sigs)
220 {
221         int row = 0, col = 0;
222         QGridLayout *const grid = new QGridLayout();
223
224         for (const shared_ptr<SignalBase>& sig : sigs) {
225                 assert(sig);
226
227                 QCheckBox *const checkbox = new QCheckBox(sig->display_name());
228                 check_box_mapper_.setMapping(checkbox, checkbox);
229                 connect(checkbox, SIGNAL(toggled(bool)),
230                         &check_box_mapper_, SLOT(map()));
231
232                 grid->addWidget(checkbox, row, col);
233
234                 check_box_signal_map_[checkbox] = sig;
235
236                 if (++col >= 8)
237                         col = 0, row++;
238         }
239
240         return grid;
241 }
242
243 void Channels::showEvent(QShowEvent *event)
244 {
245         pv::widgets::Popup::showEvent(event);
246
247         const shared_ptr<sigrok::Device> device = session_.device()->device();
248         assert(device);
249
250         // Update group labels
251         for (auto entry : device->channel_groups()) {
252                 const shared_ptr<ChannelGroup> group = entry.second;
253
254                 try {
255                         QLabel* label = group_label_map_.at(group);
256                         label->setText(QString("<h3>%1</h3>").arg(group->name().c_str()));
257                 } catch (out_of_range&) {
258                         // Do nothing
259                 }
260         }
261
262         updating_channels_ = true;
263
264         for (auto entry : check_box_signal_map_) {
265                 QCheckBox *cb = entry.first;
266                 const shared_ptr<SignalBase> sig = entry.second;
267                 assert(sig);
268
269                 // Update the check box
270                 cb->setChecked(sig->enabled());
271                 cb->setText(sig->display_name());
272         }
273
274         updating_channels_ = false;
275 }
276
277 void Channels::on_channel_checked(QWidget *widget)
278 {
279         if (updating_channels_)
280                 return;
281
282         QCheckBox *const check_box = (QCheckBox*)widget;
283         assert(check_box);
284
285         // Look up the signal of this check-box
286         map< QCheckBox*, shared_ptr<SignalBase> >::const_iterator iter =
287                 check_box_signal_map_.find((QCheckBox*)check_box);
288         assert(iter != check_box_signal_map_.end());
289
290         const shared_ptr<SignalBase> s = (*iter).second;
291         assert(s);
292
293         s->set_enabled(check_box->isChecked());
294 }
295
296 void Channels::enable_all_channels()
297 {
298         set_all_channels(true);
299 }
300
301 void Channels::disable_all_channels()
302 {
303         set_all_channels(false);
304 }
305
306 void Channels::enable_all_logic_channels()
307 {
308         enable_channels_conditionally([](const shared_ptr<SignalBase> signal)
309                 { return signal->type() == SignalBase::LogicChannel; });
310 }
311
312 void Channels::enable_all_analog_channels()
313 {
314         enable_channels_conditionally([](const shared_ptr<SignalBase> signal)
315                 { return signal->type() == SignalBase::AnalogChannel; });
316 }
317
318 void Channels::enable_all_named_channels()
319 {
320         enable_channels_conditionally([](const shared_ptr<SignalBase> signal)
321                 { return signal->name() != signal->internal_name(); });
322 }
323
324 void Channels::enable_all_changing_channels()
325 {
326         enable_channels_conditionally([](const shared_ptr<SignalBase> signal)
327                 {
328                         // Never enable channels without sample data
329                         if (!signal->has_samples())
330                                 return false;
331
332                         // Non-logic channels are considered to always have a signal
333                         if (signal->type() != SignalBase::LogicChannel)
334                                 return true;
335
336                         const shared_ptr<Logic> logic = signal->logic_data();
337                         assert(logic);
338
339                         // If any of the segments has edges, enable this channel
340                         for (shared_ptr<LogicSegment> segment : logic->logic_segments()) {
341                                 vector<LogicSegment::EdgePair> edges;
342
343                                 segment->get_subsampled_edges(edges,
344                                         0, segment->get_sample_count() - 1,
345                                         LogicSegment::MipMapScaleFactor,
346                                         signal->index());
347
348                                 if (edges.size() > 2)
349                                         return true;
350                         }
351
352                         // No edges detected in any of the segments
353                         return false;
354                 });
355 }
356
357 }  // namespace popups
358 }  // namespace pv