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;
64 using std::dynamic_pointer_cast;
66 using std::lock_guard;
72 using std::shared_ptr;
73 using std::unordered_map;
74 using std::unordered_set;
81 const double View::MaxScale = 1e9;
82 const double View::MinScale = 1e-15;
84 const int View::MaxScrollValue = INT_MAX / 2;
86 const int View::ScaleUnits[3] = {1, 2, 5};
88 const QColor View::CursorAreaColour(220, 231, 243);
90 const QSizeF View::LabelPadding(4, 0);
92 View::View(Session &session, QWidget *parent) :
93 QAbstractScrollArea(parent),
95 viewport_(new Viewport(*this)),
96 ruler_(new Ruler(*this)),
97 cursorheader_(new CursorHeader(*this)),
98 header_(new Header(*this)),
102 updating_scroll_(false),
105 show_cursors_(false),
106 cursors_(new CursorPair(*this)),
107 next_flag_text_('A'),
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(header_, SIGNAL(signals_moved()),
125 this, SLOT(on_signals_moved()));
127 connect(header_, SIGNAL(selection_changed()),
128 cursorheader_, SLOT(clear_selection()));
129 connect(cursorheader_, SIGNAL(selection_changed()),
130 header_, SLOT(clear_selection()));
132 connect(header_, SIGNAL(selection_changed()),
133 this, SIGNAL(selection_changed()));
134 connect(cursorheader_, SIGNAL(selection_changed()),
135 this, SIGNAL(selection_changed()));
137 connect(this, SIGNAL(hover_point_changed()),
138 this, SLOT(on_hover_point_changed()));
140 connect(&lazy_event_handler_, SIGNAL(timeout()),
141 this, SLOT(process_sticky_events()));
142 lazy_event_handler_.setSingleShot(true);
144 setViewport(viewport_);
146 viewport_->installEventFilter(this);
147 ruler_->installEventFilter(this);
148 cursorheader_->installEventFilter(this);
149 header_->installEventFilter(this);
151 // Trigger the initial event manually. The default device has signals
152 // which were created before this object came into being
155 // make sure the transparent widgets are on the top
156 cursorheader_->raise();
159 // Update the zoom state
160 calculate_tick_spacing();
163 Session& View::session()
168 const Session& View::session() const
178 const View* View::view() const
183 Viewport* View::viewport()
188 const Viewport* View::viewport() const
193 vector< shared_ptr<TimeItem> > View::time_items() const
195 const vector<shared_ptr<Flag>> f(flags());
196 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
197 items.push_back(cursors_);
198 items.push_back(cursors_->first());
199 items.push_back(cursors_->second());
203 double View::scale() const
208 double View::offset() const
213 int View::owner_visual_v_offset() const
218 unsigned int View::depth() const
223 unsigned int View::tick_prefix() const
228 double View::tick_period() const
233 void View::zoom(double steps)
235 zoom(steps, viewport_->width() / 2);
238 void View::zoom(double steps, int offset)
240 set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
243 void View::zoom_fit()
245 const pair<double, double> extents = get_time_extents();
246 const double delta = extents.second - extents.first;
251 const int w = viewport_->width();
255 const double scale = max(min(delta / w, MaxScale), MinScale);
256 set_scale_offset(scale, extents.first);
259 void View::zoom_one_to_one()
261 using pv::data::SignalData;
263 // Make a set of all the visible data objects
264 set< shared_ptr<SignalData> > visible_data = get_visible_data();
265 if (visible_data.empty())
268 double samplerate = 0.0;
269 for (const shared_ptr<SignalData> d : visible_data) {
271 const vector< shared_ptr<Segment> > segments =
273 for (const shared_ptr<Segment> &s : segments)
274 samplerate = max(samplerate, s->samplerate());
277 if (samplerate == 0.0)
281 const int w = viewport_->width();
285 set_zoom(1.0 / samplerate, w / 2);
288 void View::set_scale_offset(double scale, double offset)
293 calculate_tick_spacing();
297 cursorheader_->update();
299 scale_offset_changed();
302 set< shared_ptr<SignalData> > View::get_visible_data() const
304 shared_lock<shared_mutex> lock(session().signals_mutex());
305 const vector< shared_ptr<Signal> > &sigs(session().signals());
307 // Make a set of all the visible data objects
308 set< shared_ptr<SignalData> > visible_data;
309 for (const shared_ptr<Signal> sig : sigs)
311 visible_data.insert(sig->data());
316 pair<double, double> View::get_time_extents() const
318 double left_time = DBL_MAX, right_time = DBL_MIN;
319 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
320 for (const shared_ptr<SignalData> d : visible_data)
322 const vector< shared_ptr<Segment> > segments =
324 for (const shared_ptr<Segment> &s : segments) {
325 double samplerate = s->samplerate();
326 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
328 const double start_time = s->start_time();
329 left_time = min(left_time, start_time);
330 right_time = max(right_time, start_time +
331 d->get_max_sample_count() / samplerate);
335 if (left_time == DBL_MAX && right_time == DBL_MIN)
336 return make_pair(0.0, 0.0);
338 assert(left_time < right_time);
339 return make_pair(left_time, right_time);
342 bool View::cursors_shown() const
344 return show_cursors_;
347 void View::show_cursors(bool show)
349 show_cursors_ = show;
350 cursorheader_->update();
354 void View::centre_cursors()
356 const double time_width = scale_ * viewport_->width();
357 cursors_->first()->set_time(offset_ + time_width * 0.4);
358 cursors_->second()->set_time(offset_ + time_width * 0.6);
359 cursorheader_->update();
363 std::shared_ptr<CursorPair> View::cursors() const
368 void View::add_flag(double time)
370 flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
371 QString("%1").arg(next_flag_text_))));
372 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
373 (next_flag_text_ + 1);
374 time_item_appearance_changed(true, true);
377 void View::remove_flag(std::shared_ptr<Flag> flag)
380 time_item_appearance_changed(true, true);
383 vector< std::shared_ptr<Flag> > View::flags() const
385 vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
386 stable_sort(flags.begin(), flags.end(),
387 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
388 return a->time() < b->time();
394 const QPoint& View::hover_point() const
399 void View::update_viewport()
406 void View::restack_all_row_items()
408 // Make a set of owners
409 unordered_set< RowItemOwner* > owners;
410 for (const auto &r : *this)
411 owners.insert(r->owner());
413 // Make a list that is sorted from deepest first
414 vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
415 sort(sorted_owners.begin(), sorted_owners.end(),
416 [](const RowItemOwner* a, const RowItemOwner *b) {
417 return a->depth() > b->depth(); });
419 // Restack the items recursively
420 for (auto &o : sorted_owners)
423 // Animate the items to their destination
424 for (const auto &r : *this)
425 r->animate_to_layout_v_offset();
428 void View::get_scroll_layout(double &length, double &offset) const
430 const pair<double, double> extents = get_time_extents();
431 length = (extents.second - extents.first) / scale_;
432 offset = offset_ / scale_;
435 void View::set_zoom(double scale, int offset)
437 const double cursor_offset = offset_ + scale_ * offset;
438 const double new_scale = max(min(scale, MaxScale), MinScale);
439 const double new_offset = cursor_offset - new_scale * offset;
440 set_scale_offset(new_scale, new_offset);
443 void View::calculate_tick_spacing()
445 const double SpacingIncrement = 32.0f;
446 const double MinValueSpacing = 32.0f;
448 double min_width = SpacingIncrement, typical_width;
450 QFontMetrics m(QApplication::font());
453 const double min_period = scale_ * min_width;
455 const int order = (int)floorf(log10f(min_period));
456 const double order_decimal = pow(10.0, order);
458 unsigned int unit = 0;
461 tick_period_ = order_decimal * ScaleUnits[unit++];
462 } while (tick_period_ < min_period &&
463 unit < countof(ScaleUnits));
465 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
467 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
468 Qt::AlignLeft | Qt::AlignTop,
469 format_time(offset_, tick_prefix_)).width() +
472 min_width += SpacingIncrement;
474 } while(typical_width > tick_period_ / scale_);
477 void View::update_scroll()
481 const QSize areaSize = viewport_->size();
483 // Set the horizontal scroll bar
484 double length = 0, offset = 0;
485 get_scroll_layout(length, offset);
486 length = max(length - areaSize.width(), 0.0);
488 int major_tick_distance = tick_period_ / scale_;
490 horizontalScrollBar()->setPageStep(areaSize.width() / 2);
491 horizontalScrollBar()->setSingleStep(major_tick_distance);
493 updating_scroll_ = true;
495 if (length < MaxScrollValue) {
496 horizontalScrollBar()->setRange(0, length);
497 horizontalScrollBar()->setSliderPosition(offset);
499 horizontalScrollBar()->setRange(0, MaxScrollValue);
500 horizontalScrollBar()->setSliderPosition(
501 offset_ * MaxScrollValue / (scale_ * length));
504 updating_scroll_ = false;
506 // Set the vertical scrollbar
507 verticalScrollBar()->setPageStep(areaSize.height());
508 verticalScrollBar()->setSingleStep(areaSize.height() / 8);
510 const pair<int, int> extents = v_extents();
511 verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
512 extents.second - (areaSize.height() / 2));
515 void View::update_layout()
518 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
519 ruler_->sizeHint().height(), 0, 0);
520 ruler_->setGeometry(viewport_->x(), 0,
521 viewport_->width(), viewport_->y());
522 cursorheader_->setGeometry(
524 ruler_->sizeHint().height() - cursorheader_->sizeHint().height() / 2,
525 viewport_->width(), cursorheader_->sizeHint().height());
526 header_->setGeometry(0, viewport_->y(),
527 header_->sizeHint().width(), viewport_->height());
531 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
538 QRectF View::label_rect(const QRectF &rect)
544 bool View::add_channels_to_owner(
545 const vector< shared_ptr<sigrok::Channel> > &channels,
546 RowItemOwner *owner, int &offset,
547 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
549 std::function<bool (shared_ptr<RowItem>)> filter_func)
551 bool any_added = false;
555 for (const auto &channel : channels)
557 const auto iter = signal_map.find(channel);
558 if (iter == signal_map.end() ||
559 (filter_func && !filter_func((*iter).second)))
562 shared_ptr<RowItem> row_item = (*iter).second;
563 owner->add_child_item(row_item);
564 apply_offset(row_item, offset);
565 signal_map.erase(iter);
573 void View::apply_offset(shared_ptr<RowItem> row_item, int &offset) {
575 const pair<int, int> extents = row_item->v_extents();
576 if (row_item->enabled())
577 offset += -extents.first;
578 row_item->force_to_v_offset(offset);
579 if (row_item->enabled())
580 offset += extents.second;
583 bool View::eventFilter(QObject *object, QEvent *event)
585 const QEvent::Type type = event->type();
586 if (type == QEvent::MouseMove) {
588 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
589 if (object == viewport_)
590 hover_point_ = mouse_event->pos();
591 else if (object == ruler_ || object == cursorheader_)
592 hover_point_ = QPoint(mouse_event->x(), 0);
593 else if (object == header_)
594 hover_point_ = QPoint(0, mouse_event->y());
596 hover_point_ = QPoint(-1, -1);
598 hover_point_changed();
600 } else if (type == QEvent::Leave) {
601 hover_point_ = QPoint(-1, -1);
602 hover_point_changed();
605 return QObject::eventFilter(object, event);
608 bool View::viewportEvent(QEvent *e)
612 case QEvent::MouseButtonPress:
613 case QEvent::MouseButtonRelease:
614 case QEvent::MouseButtonDblClick:
615 case QEvent::MouseMove:
617 case QEvent::TouchBegin:
618 case QEvent::TouchUpdate:
619 case QEvent::TouchEnd:
623 return QAbstractScrollArea::viewportEvent(e);
627 void View::resizeEvent(QResizeEvent*)
632 void View::row_item_appearance_changed(bool label, bool content)
640 void View::time_item_appearance_changed(bool label, bool content)
643 cursorheader_->update();
648 void View::extents_changed(bool horz, bool vert)
651 (horz ? RowItemHExtentsChanged : 0) |
652 (vert ? RowItemVExtentsChanged : 0);
653 lazy_event_handler_.start();
656 void View::h_scroll_value_changed(int value)
658 if (updating_scroll_)
661 const int range = horizontalScrollBar()->maximum();
662 if (range < MaxScrollValue)
663 offset_ = scale_ * value;
665 double length = 0, offset;
666 get_scroll_layout(length, offset);
667 offset_ = scale_ * length * value / MaxScrollValue;
671 cursorheader_->update();
675 void View::v_scroll_value_changed(int value)
682 void View::signals_changed()
686 // Populate the traces
689 shared_ptr<sigrok::Device> device = session_.device();
692 // Collect a set of signals
693 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
696 shared_lock<shared_mutex> lock(session_.signals_mutex());
697 const vector< shared_ptr<Signal> > &sigs(session_.signals());
699 for (const shared_ptr<Signal> &sig : sigs)
700 signal_map[sig->channel()] = sig;
702 // Populate channel groups
703 for (auto entry : device->channel_groups())
705 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
707 if (group->channels().size() <= 1)
710 shared_ptr<TraceGroup> trace_group(new TraceGroup());
711 int child_offset = 0;
712 if (add_channels_to_owner(group->channels(),
713 trace_group.get(), child_offset, signal_map))
715 add_child_item(trace_group);
716 apply_offset(trace_group, offset);
720 // Add the remaining logic channels
721 shared_ptr<TraceGroup> logic_trace_group(new TraceGroup());
722 int child_offset = 0;
724 if (add_channels_to_owner(device->channels(),
725 logic_trace_group.get(), child_offset, signal_map,
726 [](shared_ptr<RowItem> r) -> bool {
727 return dynamic_pointer_cast<LogicSignal>(r) != nullptr;
731 add_child_item(logic_trace_group);
732 apply_offset(logic_trace_group, offset);
735 // Add the remaining channels
736 add_channels_to_owner(device->channels(), this, offset, signal_map);
737 assert(signal_map.empty());
739 // Add decode signals
741 const vector< shared_ptr<DecodeTrace> > decode_sigs(
742 session().get_decode_signals());
743 for (auto s : decode_sigs) {
745 apply_offset(s, offset);
752 void View::data_updated()
754 // Update the scroll bars
761 void View::on_signals_moved()
767 void View::process_sticky_events()
769 if (sticky_events_ & RowItemHExtentsChanged)
771 if (sticky_events_ & RowItemVExtentsChanged)
772 restack_all_row_items();
774 // Clear the sticky events
778 void View::on_hover_point_changed()
780 for (shared_ptr<RowItem> r : *this)
781 r->hover_point_changed();