2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
22 #include <libsigrokdecode/libsigrokdecode.h>
31 #include <unordered_set>
33 #include <QApplication>
35 #include <QFontMetrics>
36 #include <QMouseEvent>
39 #include <libsigrok/libsigrok.hpp>
41 #include "decodetrace.hpp"
43 #include "logicsignal.hpp"
46 #include "tracegroup.hpp"
48 #include "viewport.hpp"
50 #include "pv/session.hpp"
51 #include "pv/data/logic.hpp"
52 #include "pv/data/logicsegment.hpp"
53 #include "pv/util.hpp"
55 using boost::shared_lock;
56 using boost::shared_mutex;
58 using pv::data::SignalData;
59 using pv::data::Segment;
60 using pv::util::format_time;
63 using std::dynamic_pointer_cast;
65 using std::lock_guard;
71 using std::shared_ptr;
72 using std::unordered_map;
73 using std::unordered_set;
80 const double View::MaxScale = 1e9;
81 const double View::MinScale = 1e-15;
83 const int View::MaxScrollValue = INT_MAX / 2;
85 const int View::ScaleUnits[3] = {1, 2, 5};
87 const QSizeF View::LabelPadding(4, 0);
89 View::View(Session &session, QWidget *parent) :
90 QAbstractScrollArea(parent),
92 viewport_(new Viewport(*this)),
93 ruler_(new Ruler(*this)),
94 header_(new Header(*this)),
98 updating_scroll_(false),
101 show_cursors_(false),
102 cursors_(new CursorPair(*this)),
103 next_flag_text_('A'),
106 connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
107 this, SLOT(h_scroll_value_changed(int)));
108 connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
109 this, SLOT(v_scroll_value_changed(int)));
111 connect(&session_, SIGNAL(signals_changed()),
112 this, SLOT(signals_changed()));
113 connect(&session_, SIGNAL(capture_state_changed(int)),
114 this, SLOT(data_updated()));
115 connect(&session_, SIGNAL(data_received()),
116 this, SLOT(data_updated()));
117 connect(&session_, SIGNAL(frame_ended()),
118 this, SLOT(data_updated()));
120 connect(header_, SIGNAL(signals_moved()),
121 this, SLOT(on_signals_moved()));
123 connect(header_, SIGNAL(selection_changed()),
124 ruler_, SLOT(clear_selection()));
125 connect(ruler_, SIGNAL(selection_changed()),
126 header_, SLOT(clear_selection()));
128 connect(header_, SIGNAL(selection_changed()),
129 this, SIGNAL(selection_changed()));
130 connect(ruler_, SIGNAL(selection_changed()),
131 this, SIGNAL(selection_changed()));
133 connect(this, SIGNAL(hover_point_changed()),
134 this, SLOT(on_hover_point_changed()));
136 connect(&lazy_event_handler_, SIGNAL(timeout()),
137 this, SLOT(process_sticky_events()));
138 lazy_event_handler_.setSingleShot(true);
140 setViewport(viewport_);
142 viewport_->installEventFilter(this);
143 ruler_->installEventFilter(this);
144 header_->installEventFilter(this);
146 // Trigger the initial event manually. The default device has signals
147 // which were created before this object came into being
150 // make sure the transparent widgets are on the top
154 // Update the zoom state
155 calculate_tick_spacing();
158 Session& View::session()
163 const Session& View::session() const
173 const View* View::view() const
178 Viewport* View::viewport()
183 const Viewport* View::viewport() const
188 vector< shared_ptr<TimeItem> > View::time_items() const
190 const vector<shared_ptr<Flag>> f(flags());
191 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
192 items.push_back(cursors_);
193 items.push_back(cursors_->first());
194 items.push_back(cursors_->second());
198 double View::scale() const
203 double View::offset() const
208 int View::owner_visual_v_offset() const
213 unsigned int View::depth() const
218 unsigned int View::tick_prefix() const
223 double View::tick_period() const
228 void View::zoom(double steps)
230 zoom(steps, viewport_->width() / 2);
233 void View::zoom(double steps, int offset)
235 set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
238 void View::zoom_fit()
240 const pair<double, double> extents = get_time_extents();
241 const double delta = extents.second - extents.first;
246 const int w = viewport_->width();
250 const double scale = max(min(delta / w, MaxScale), MinScale);
251 set_scale_offset(scale, extents.first);
254 void View::zoom_one_to_one()
256 using pv::data::SignalData;
258 // Make a set of all the visible data objects
259 set< shared_ptr<SignalData> > visible_data = get_visible_data();
260 if (visible_data.empty())
263 double samplerate = 0.0;
264 for (const shared_ptr<SignalData> d : visible_data) {
266 const vector< shared_ptr<Segment> > segments =
268 for (const shared_ptr<Segment> &s : segments)
269 samplerate = max(samplerate, s->samplerate());
272 if (samplerate == 0.0)
276 const int w = viewport_->width();
280 set_zoom(1.0 / samplerate, w / 2);
283 void View::set_scale_offset(double scale, double offset)
288 calculate_tick_spacing();
293 scale_offset_changed();
296 set< shared_ptr<SignalData> > View::get_visible_data() const
298 shared_lock<shared_mutex> lock(session().signals_mutex());
299 const vector< shared_ptr<Signal> > &sigs(session().signals());
301 // Make a set of all the visible data objects
302 set< shared_ptr<SignalData> > visible_data;
303 for (const shared_ptr<Signal> sig : sigs)
305 visible_data.insert(sig->data());
310 pair<double, double> View::get_time_extents() const
312 double left_time = DBL_MAX, right_time = DBL_MIN;
313 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
314 for (const shared_ptr<SignalData> d : visible_data)
316 const vector< shared_ptr<Segment> > segments =
318 for (const shared_ptr<Segment> &s : segments) {
319 double samplerate = s->samplerate();
320 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
322 const double start_time = s->start_time();
323 left_time = min(left_time, start_time);
324 right_time = max(right_time, start_time +
325 d->get_max_sample_count() / samplerate);
329 if (left_time == DBL_MAX && right_time == DBL_MIN)
330 return make_pair(0.0, 0.0);
332 assert(left_time < right_time);
333 return make_pair(left_time, right_time);
336 bool View::cursors_shown() const
338 return show_cursors_;
341 void View::show_cursors(bool show)
343 show_cursors_ = show;
348 void View::centre_cursors()
350 const double time_width = scale_ * viewport_->width();
351 cursors_->first()->set_time(offset_ + time_width * 0.4);
352 cursors_->second()->set_time(offset_ + time_width * 0.6);
357 std::shared_ptr<CursorPair> View::cursors() const
362 void View::add_flag(double time)
364 flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
365 QString("%1").arg(next_flag_text_))));
366 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
367 (next_flag_text_ + 1);
368 time_item_appearance_changed(true, true);
371 void View::remove_flag(std::shared_ptr<Flag> flag)
374 time_item_appearance_changed(true, true);
377 vector< std::shared_ptr<Flag> > View::flags() const
379 vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
380 stable_sort(flags.begin(), flags.end(),
381 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
382 return a->time() < b->time();
388 const QPoint& View::hover_point() const
393 void View::update_viewport()
400 void View::restack_all_row_items()
402 // Make a set of owners
403 unordered_set< RowItemOwner* > owners;
404 for (const auto &r : *this)
405 owners.insert(r->owner());
407 // Make a list that is sorted from deepest first
408 vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
409 sort(sorted_owners.begin(), sorted_owners.end(),
410 [](const RowItemOwner* a, const RowItemOwner *b) {
411 return a->depth() > b->depth(); });
413 // Restack the items recursively
414 for (auto &o : sorted_owners)
417 // Animate the items to their destination
418 for (const auto &r : *this)
419 r->animate_to_layout_v_offset();
422 void View::get_scroll_layout(double &length, double &offset) const
424 const pair<double, double> extents = get_time_extents();
425 length = (extents.second - extents.first) / scale_;
426 offset = offset_ / scale_;
429 void View::set_zoom(double scale, int offset)
431 const double cursor_offset = offset_ + scale_ * offset;
432 const double new_scale = max(min(scale, MaxScale), MinScale);
433 const double new_offset = cursor_offset - new_scale * offset;
434 set_scale_offset(new_scale, new_offset);
437 void View::calculate_tick_spacing()
439 const double SpacingIncrement = 32.0f;
440 const double MinValueSpacing = 32.0f;
442 double min_width = SpacingIncrement, typical_width;
444 QFontMetrics m(QApplication::font());
447 const double min_period = scale_ * min_width;
449 const int order = (int)floorf(log10f(min_period));
450 const double order_decimal = pow(10.0, order);
452 unsigned int unit = 0;
455 tick_period_ = order_decimal * ScaleUnits[unit++];
456 } while (tick_period_ < min_period &&
457 unit < countof(ScaleUnits));
459 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
461 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
462 Qt::AlignLeft | Qt::AlignTop,
463 format_time(offset_, tick_prefix_)).width() +
466 min_width += SpacingIncrement;
468 } while(typical_width > tick_period_ / scale_);
471 void View::update_scroll()
475 const QSize areaSize = viewport_->size();
477 // Set the horizontal scroll bar
478 double length = 0, offset = 0;
479 get_scroll_layout(length, offset);
480 length = max(length - areaSize.width(), 0.0);
482 int major_tick_distance = tick_period_ / scale_;
484 horizontalScrollBar()->setPageStep(areaSize.width() / 2);
485 horizontalScrollBar()->setSingleStep(major_tick_distance);
487 updating_scroll_ = true;
489 if (length < MaxScrollValue) {
490 horizontalScrollBar()->setRange(0, length);
491 horizontalScrollBar()->setSliderPosition(offset);
493 horizontalScrollBar()->setRange(0, MaxScrollValue);
494 horizontalScrollBar()->setSliderPosition(
495 offset_ * MaxScrollValue / (scale_ * length));
498 updating_scroll_ = false;
500 // Set the vertical scrollbar
501 verticalScrollBar()->setPageStep(areaSize.height());
502 verticalScrollBar()->setSingleStep(areaSize.height() / 8);
504 const pair<int, int> extents = v_extents();
505 verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
506 extents.second - (areaSize.height() / 2));
509 void View::update_layout()
512 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
513 ruler_->sizeHint().height(), 0, 0);
514 ruler_->setGeometry(viewport_->x(), 0,
515 viewport_->width(), ruler_->extended_size_hint().height());
516 header_->setGeometry(0, viewport_->y(),
517 header_->extended_size_hint().width(), viewport_->height());
521 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
528 QRectF View::label_rect(const QRectF &rect)
534 bool View::add_channels_to_owner(
535 const vector< shared_ptr<sigrok::Channel> > &channels,
536 RowItemOwner *owner, int &offset,
537 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
539 std::function<bool (shared_ptr<RowItem>)> filter_func)
541 bool any_added = false;
545 for (const auto &channel : channels)
547 const auto iter = signal_map.find(channel);
548 if (iter == signal_map.end() ||
549 (filter_func && !filter_func((*iter).second)))
552 shared_ptr<RowItem> row_item = (*iter).second;
553 owner->add_child_item(row_item);
554 apply_offset(row_item, offset);
555 signal_map.erase(iter);
563 void View::apply_offset(shared_ptr<RowItem> row_item, int &offset) {
565 const pair<int, int> extents = row_item->v_extents();
566 if (row_item->enabled())
567 offset += -extents.first;
568 row_item->force_to_v_offset(offset);
569 if (row_item->enabled())
570 offset += extents.second;
573 bool View::eventFilter(QObject *object, QEvent *event)
575 const QEvent::Type type = event->type();
576 if (type == QEvent::MouseMove) {
578 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
579 if (object == viewport_)
580 hover_point_ = mouse_event->pos();
581 else if (object == ruler_)
582 hover_point_ = QPoint(mouse_event->x(), 0);
583 else if (object == header_)
584 hover_point_ = QPoint(0, mouse_event->y());
586 hover_point_ = QPoint(-1, -1);
588 hover_point_changed();
590 } else if (type == QEvent::Leave) {
591 hover_point_ = QPoint(-1, -1);
592 hover_point_changed();
595 return QObject::eventFilter(object, event);
598 bool View::viewportEvent(QEvent *e)
602 case QEvent::MouseButtonPress:
603 case QEvent::MouseButtonRelease:
604 case QEvent::MouseButtonDblClick:
605 case QEvent::MouseMove:
607 case QEvent::TouchBegin:
608 case QEvent::TouchUpdate:
609 case QEvent::TouchEnd:
613 return QAbstractScrollArea::viewportEvent(e);
617 void View::resizeEvent(QResizeEvent*)
622 void View::row_item_appearance_changed(bool label, bool content)
630 void View::time_item_appearance_changed(bool label, bool content)
638 void View::extents_changed(bool horz, bool vert)
641 (horz ? RowItemHExtentsChanged : 0) |
642 (vert ? RowItemVExtentsChanged : 0);
643 lazy_event_handler_.start();
646 void View::h_scroll_value_changed(int value)
648 if (updating_scroll_)
651 const int range = horizontalScrollBar()->maximum();
652 if (range < MaxScrollValue)
653 offset_ = scale_ * value;
655 double length = 0, offset;
656 get_scroll_layout(length, offset);
657 offset_ = scale_ * length * value / MaxScrollValue;
664 void View::v_scroll_value_changed(int value)
671 void View::signals_changed()
675 // Populate the traces
678 shared_ptr<sigrok::Device> device = session_.device();
681 // Collect a set of signals
682 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
685 shared_lock<shared_mutex> lock(session_.signals_mutex());
686 const vector< shared_ptr<Signal> > &sigs(session_.signals());
688 for (const shared_ptr<Signal> &sig : sigs)
689 signal_map[sig->channel()] = sig;
691 // Populate channel groups
692 for (auto entry : device->channel_groups())
694 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
696 if (group->channels().size() <= 1)
699 shared_ptr<TraceGroup> trace_group(new TraceGroup());
700 int child_offset = 0;
701 if (add_channels_to_owner(group->channels(),
702 trace_group.get(), child_offset, signal_map))
704 add_child_item(trace_group);
705 apply_offset(trace_group, offset);
709 // Add the remaining logic channels
710 shared_ptr<TraceGroup> logic_trace_group(new TraceGroup());
711 int child_offset = 0;
713 if (add_channels_to_owner(device->channels(),
714 logic_trace_group.get(), child_offset, signal_map,
715 [](shared_ptr<RowItem> r) -> bool {
716 return dynamic_pointer_cast<LogicSignal>(r) != nullptr;
720 add_child_item(logic_trace_group);
721 apply_offset(logic_trace_group, offset);
724 // Add the remaining channels
725 add_channels_to_owner(device->channels(), this, offset, signal_map);
726 assert(signal_map.empty());
728 // Add decode signals
730 const vector< shared_ptr<DecodeTrace> > decode_sigs(
731 session().get_decode_signals());
732 for (auto s : decode_sigs) {
734 apply_offset(s, offset);
741 void View::data_updated()
743 // Update the scroll bars
750 void View::on_signals_moved()
756 void View::process_sticky_events()
758 if (sticky_events_ & RowItemHExtentsChanged)
760 if (sticky_events_ & RowItemVExtentsChanged)
761 restack_all_row_items();
763 // Clear the sticky events
767 void View::on_hover_point_changed()
769 for (shared_ptr<RowItem> r : *this)
770 r->hover_point_changed();