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 "cursorheader.hpp"
42 #include "decodetrace.hpp"
44 #include "logicsignal.hpp"
47 #include "tracegroup.hpp"
49 #include "viewport.hpp"
51 #include "pv/session.hpp"
52 #include "pv/data/logic.hpp"
53 #include "pv/data/logicsegment.hpp"
54 #include "pv/util.hpp"
56 using boost::shared_lock;
57 using boost::shared_mutex;
59 using pv::data::SignalData;
60 using pv::data::Segment;
61 using pv::util::format_time;
63 using std::back_inserter;
65 using std::dynamic_pointer_cast;
67 using std::lock_guard;
73 using std::shared_ptr;
74 using std::unordered_map;
75 using std::unordered_set;
82 const double View::MaxScale = 1e9;
83 const double View::MinScale = 1e-15;
85 const int View::MaxScrollValue = INT_MAX / 2;
87 const int View::ScaleUnits[3] = {1, 2, 5};
89 const QColor View::CursorAreaColour(220, 231, 243);
91 const QSizeF View::LabelPadding(4, 0);
93 View::View(Session &session, QWidget *parent) :
94 QAbstractScrollArea(parent),
96 viewport_(new Viewport(*this)),
97 ruler_(new Ruler(*this)),
98 cursorheader_(new CursorHeader(*this)),
99 header_(new Header(*this)),
103 updating_scroll_(false),
106 show_cursors_(false),
107 cursors_(new CursorPair(*this)),
110 connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
111 this, SLOT(h_scroll_value_changed(int)));
112 connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
113 this, SLOT(v_scroll_value_changed(int)));
115 connect(&session_, SIGNAL(signals_changed()),
116 this, SLOT(signals_changed()));
117 connect(&session_, SIGNAL(capture_state_changed(int)),
118 this, SLOT(data_updated()));
119 connect(&session_, SIGNAL(data_received()),
120 this, SLOT(data_updated()));
121 connect(&session_, SIGNAL(frame_ended()),
122 this, SLOT(data_updated()));
124 connect(cursors_->first().get(), SIGNAL(time_changed()),
125 this, SLOT(marker_time_changed()));
126 connect(cursors_->second().get(), SIGNAL(time_changed()),
127 this, SLOT(marker_time_changed()));
129 connect(header_, SIGNAL(signals_moved()),
130 this, SLOT(on_signals_moved()));
132 connect(header_, SIGNAL(selection_changed()),
133 cursorheader_, SLOT(clear_selection()));
134 connect(cursorheader_, SIGNAL(selection_changed()),
135 header_, SLOT(clear_selection()));
137 connect(header_, SIGNAL(selection_changed()),
138 this, SIGNAL(selection_changed()));
139 connect(cursorheader_, SIGNAL(selection_changed()),
140 this, SIGNAL(selection_changed()));
142 connect(this, SIGNAL(hover_point_changed()),
143 this, SLOT(on_hover_point_changed()));
145 connect(&lazy_event_handler_, SIGNAL(timeout()),
146 this, SLOT(process_sticky_events()));
147 lazy_event_handler_.setSingleShot(true);
149 setViewport(viewport_);
151 viewport_->installEventFilter(this);
152 ruler_->installEventFilter(this);
153 cursorheader_->installEventFilter(this);
154 header_->installEventFilter(this);
156 // Trigger the initial event manually. The default device has signals
157 // which were created before this object came into being
160 // make sure the transparent widgets are on the top
161 cursorheader_->raise();
164 // Update the zoom state
165 calculate_tick_spacing();
168 Session& View::session()
173 const Session& View::session() const
183 const View* View::view() const
188 Viewport* View::viewport()
193 const Viewport* View::viewport() const
198 vector< shared_ptr<TimeItem> > View::time_items() const
200 vector< shared_ptr<TimeItem> > items;
201 items.push_back(cursors_->first());
202 items.push_back(cursors_->second());
206 double View::scale() const
211 double View::offset() const
216 int View::owner_visual_v_offset() const
221 unsigned int View::depth() const
226 unsigned int View::tick_prefix() const
231 double View::tick_period() const
236 void View::zoom(double steps)
238 zoom(steps, viewport_->width() / 2);
241 void View::zoom(double steps, int offset)
243 set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
246 void View::zoom_fit()
248 const pair<double, double> extents = get_time_extents();
249 const double delta = extents.second - extents.first;
254 const int w = viewport_->width();
258 const double scale = max(min(delta / w, MaxScale), MinScale);
259 set_scale_offset(scale, extents.first);
262 void View::zoom_one_to_one()
264 using pv::data::SignalData;
266 // Make a set of all the visible data objects
267 set< shared_ptr<SignalData> > visible_data = get_visible_data();
268 if (visible_data.empty())
271 double samplerate = 0.0;
272 for (const shared_ptr<SignalData> d : visible_data) {
274 const vector< shared_ptr<Segment> > segments =
276 for (const shared_ptr<Segment> &s : segments)
277 samplerate = max(samplerate, s->samplerate());
280 if (samplerate == 0.0)
284 const int w = viewport_->width();
288 set_zoom(1.0 / samplerate, w / 2);
291 void View::set_scale_offset(double scale, double offset)
296 calculate_tick_spacing();
300 cursorheader_->update();
302 scale_offset_changed();
305 set< shared_ptr<SignalData> > View::get_visible_data() const
307 shared_lock<shared_mutex> lock(session().signals_mutex());
308 const vector< shared_ptr<Signal> > &sigs(session().signals());
310 // Make a set of all the visible data objects
311 set< shared_ptr<SignalData> > visible_data;
312 for (const shared_ptr<Signal> sig : sigs)
314 visible_data.insert(sig->data());
319 pair<double, double> View::get_time_extents() const
321 double left_time = DBL_MAX, right_time = DBL_MIN;
322 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
323 for (const shared_ptr<SignalData> d : visible_data)
325 const vector< shared_ptr<Segment> > segments =
327 for (const shared_ptr<Segment> &s : segments) {
328 double samplerate = s->samplerate();
329 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
331 const double start_time = s->start_time();
332 left_time = min(left_time, start_time);
333 right_time = max(right_time, start_time +
334 d->get_max_sample_count() / samplerate);
338 if (left_time == DBL_MAX && right_time == DBL_MIN)
339 return make_pair(0.0, 0.0);
341 assert(left_time < right_time);
342 return make_pair(left_time, right_time);
345 bool View::cursors_shown() const
347 return show_cursors_;
350 void View::show_cursors(bool show)
352 show_cursors_ = show;
353 cursorheader_->update();
357 void View::centre_cursors()
359 const double time_width = scale_ * viewport_->width();
360 cursors_->first()->set_time(offset_ + time_width * 0.4);
361 cursors_->second()->set_time(offset_ + time_width * 0.6);
362 cursorheader_->update();
366 std::shared_ptr<CursorPair> View::cursors() const
371 const QPoint& View::hover_point() const
376 void View::update_viewport()
383 void View::restack_all_row_items()
385 // Make a set of owners
386 unordered_set< RowItemOwner* > owners;
387 for (const auto &r : *this)
388 owners.insert(r->owner());
390 // Make a list that is sorted from deepest first
391 vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
392 sort(sorted_owners.begin(), sorted_owners.end(),
393 [](const RowItemOwner* a, const RowItemOwner *b) {
394 return a->depth() > b->depth(); });
396 // Restack the items recursively
397 for (auto &o : sorted_owners)
400 // Animate the items to their destination
401 for (const auto &r : *this)
402 r->animate_to_layout_v_offset();
405 void View::get_scroll_layout(double &length, double &offset) const
407 const pair<double, double> extents = get_time_extents();
408 length = (extents.second - extents.first) / scale_;
409 offset = offset_ / scale_;
412 void View::set_zoom(double scale, int offset)
414 const double cursor_offset = offset_ + scale_ * offset;
415 const double new_scale = max(min(scale, MaxScale), MinScale);
416 const double new_offset = cursor_offset - new_scale * offset;
417 set_scale_offset(new_scale, new_offset);
420 void View::calculate_tick_spacing()
422 const double SpacingIncrement = 32.0f;
423 const double MinValueSpacing = 32.0f;
425 double min_width = SpacingIncrement, typical_width;
427 QFontMetrics m(QApplication::font());
430 const double min_period = scale_ * min_width;
432 const int order = (int)floorf(log10f(min_period));
433 const double order_decimal = pow(10.0, order);
435 unsigned int unit = 0;
438 tick_period_ = order_decimal * ScaleUnits[unit++];
439 } while (tick_period_ < min_period &&
440 unit < countof(ScaleUnits));
442 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
444 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
445 Qt::AlignLeft | Qt::AlignTop,
446 format_time(offset_, tick_prefix_)).width() +
449 min_width += SpacingIncrement;
451 } while(typical_width > tick_period_ / scale_);
454 void View::update_scroll()
458 const QSize areaSize = viewport_->size();
460 // Set the horizontal scroll bar
461 double length = 0, offset = 0;
462 get_scroll_layout(length, offset);
463 length = max(length - areaSize.width(), 0.0);
465 int major_tick_distance = tick_period_ / scale_;
467 horizontalScrollBar()->setPageStep(areaSize.width() / 2);
468 horizontalScrollBar()->setSingleStep(major_tick_distance);
470 updating_scroll_ = true;
472 if (length < MaxScrollValue) {
473 horizontalScrollBar()->setRange(0, length);
474 horizontalScrollBar()->setSliderPosition(offset);
476 horizontalScrollBar()->setRange(0, MaxScrollValue);
477 horizontalScrollBar()->setSliderPosition(
478 offset_ * MaxScrollValue / (scale_ * length));
481 updating_scroll_ = false;
483 // Set the vertical scrollbar
484 verticalScrollBar()->setPageStep(areaSize.height());
486 const pair<int, int> extents = v_extents();
487 const int extra_scroll_height = (extents.second - extents.first) / 4;
488 verticalScrollBar()->setRange(extents.first - extra_scroll_height,
489 extents.first + extra_scroll_height);
492 void View::update_layout()
495 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
496 ruler_->sizeHint().height(), 0, 0);
497 ruler_->setGeometry(viewport_->x(), 0,
498 viewport_->width(), viewport_->y());
499 cursorheader_->setGeometry(
501 ruler_->sizeHint().height() - cursorheader_->sizeHint().height() / 2,
502 viewport_->width(), cursorheader_->sizeHint().height());
503 header_->setGeometry(0, viewport_->y(),
504 header_->sizeHint().width(), viewport_->height());
508 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
515 QRectF View::label_rect(const QRectF &rect)
521 bool View::add_channels_to_owner(
522 const vector< shared_ptr<sigrok::Channel> > &channels,
523 RowItemOwner *owner, int &offset,
524 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
526 std::function<bool (shared_ptr<RowItem>)> filter_func)
528 bool any_added = false;
532 for (const auto &channel : channels)
534 const auto iter = signal_map.find(channel);
535 if (iter == signal_map.end() ||
536 (filter_func && !filter_func((*iter).second)))
539 shared_ptr<RowItem> row_item = (*iter).second;
540 owner->add_child_item(row_item);
541 apply_offset(row_item, offset);
542 signal_map.erase(iter);
550 void View::apply_offset(shared_ptr<RowItem> row_item, int &offset) {
552 const pair<int, int> extents = row_item->v_extents();
553 if (row_item->enabled())
554 offset += -extents.first;
555 row_item->force_to_v_offset(offset);
556 if (row_item->enabled())
557 offset += extents.second;
560 bool View::eventFilter(QObject *object, QEvent *event)
562 const QEvent::Type type = event->type();
563 if (type == QEvent::MouseMove) {
565 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
566 if (object == viewport_)
567 hover_point_ = mouse_event->pos();
568 else if (object == ruler_ || object == cursorheader_)
569 hover_point_ = QPoint(mouse_event->x(), 0);
570 else if (object == header_)
571 hover_point_ = QPoint(0, mouse_event->y());
573 hover_point_ = QPoint(-1, -1);
575 hover_point_changed();
577 } else if (type == QEvent::Leave) {
578 hover_point_ = QPoint(-1, -1);
579 hover_point_changed();
582 return QObject::eventFilter(object, event);
585 bool View::viewportEvent(QEvent *e)
589 case QEvent::MouseButtonPress:
590 case QEvent::MouseButtonRelease:
591 case QEvent::MouseButtonDblClick:
592 case QEvent::MouseMove:
594 case QEvent::TouchBegin:
595 case QEvent::TouchUpdate:
596 case QEvent::TouchEnd:
600 return QAbstractScrollArea::viewportEvent(e);
604 void View::resizeEvent(QResizeEvent*)
609 void View::appearance_changed(bool label, bool content)
617 void View::extents_changed(bool horz, bool vert)
620 (horz ? SelectableItemHExtentsChanged : 0) |
621 (vert ? SelectableItemVExtentsChanged : 0);
622 lazy_event_handler_.start();
625 void View::h_scroll_value_changed(int value)
627 if (updating_scroll_)
630 const int range = horizontalScrollBar()->maximum();
631 if (range < MaxScrollValue)
632 offset_ = scale_ * value;
634 double length = 0, offset;
635 get_scroll_layout(length, offset);
636 offset_ = scale_ * length * value / MaxScrollValue;
640 cursorheader_->update();
644 void View::v_scroll_value_changed(int value)
651 void View::signals_changed()
655 // Populate the traces
658 shared_ptr<sigrok::Device> device = session_.device();
661 // Collect a set of signals
662 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
665 shared_lock<shared_mutex> lock(session_.signals_mutex());
666 const vector< shared_ptr<Signal> > &sigs(session_.signals());
668 for (const shared_ptr<Signal> &sig : sigs)
669 signal_map[sig->channel()] = sig;
671 // Populate channel groups
672 for (auto entry : device->channel_groups())
674 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
676 if (group->channels().size() <= 1)
679 shared_ptr<TraceGroup> trace_group(new TraceGroup());
680 int child_offset = 0;
681 if (add_channels_to_owner(group->channels(),
682 trace_group.get(), child_offset, signal_map))
684 add_child_item(trace_group);
685 apply_offset(trace_group, offset);
689 // Add the remaining logic channels
690 shared_ptr<TraceGroup> logic_trace_group(new TraceGroup());
691 int child_offset = 0;
693 if (add_channels_to_owner(device->channels(),
694 logic_trace_group.get(), child_offset, signal_map,
695 [](shared_ptr<RowItem> r) -> bool {
696 return dynamic_pointer_cast<LogicSignal>(r) != nullptr;
700 add_child_item(logic_trace_group);
701 apply_offset(logic_trace_group, offset);
704 // Add the remaining channels
705 add_channels_to_owner(device->channels(), this, offset, signal_map);
706 assert(signal_map.empty());
708 // Add decode signals
710 const vector< shared_ptr<DecodeTrace> > decode_sigs(
711 session().get_decode_signals());
712 for (auto s : decode_sigs) {
714 apply_offset(s, offset);
721 void View::data_updated()
723 // Update the scroll bars
730 void View::marker_time_changed()
732 cursorheader_->update();
736 void View::on_signals_moved()
742 void View::process_sticky_events()
744 if (sticky_events_ & SelectableItemHExtentsChanged)
746 if (sticky_events_ & SelectableItemVExtentsChanged)
747 restack_all_row_items();
749 // Clear the sticky events
753 void View::on_hover_point_changed()
755 for (shared_ptr<RowItem> r : *this)
756 r->hover_point_changed();