pv/view/view.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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifdef ENABLE_DECODE
  22 #include <libsigrokdecode/libsigrokdecode.h>
  23 #endif
  24
  25 #include <assert.h>
  26 #include <limits.h>
  27 #include <math.h>
  28
  29 #include <QEvent>
  30 #include <QMouseEvent>
  31 #include <QScrollBar>
  32
  33 #include "cursorheader.h"
  34 #include "decodetrace.h"
  35 #include "header.h"
  36 #include "ruler.h"
  37 #include "signal.h"
  38 #include "view.h"
  39 #include "viewport.h"
  40
  41 #include "pv/sigsession.h"
  42 #include "pv/data/logic.h"
  43 #include "pv/data/logicsnapshot.h"
  44
  45 using pv::data::SignalData;
  46 using std::back_inserter;
  47 using std::deque;
  48 using std::list;
  49 using std::max;
  50 using std::make_pair;
  51 using std::min;
  52 using std::pair;
  53 using std::set;
  54 using std::shared_ptr;
  55 using std::vector;
  56 using std::weak_ptr;
  57
  58 namespace pv {
  59 namespace view {
  60
  61 const double View::MaxScale = 1e9;
  62 const double View::MinScale = 1e-15;
  63
  64 const int View::MaxScrollValue = INT_MAX / 2;
  65
  66 const int View::SignalHeight = 30;
  67 const int View::SignalMargin = 10;
  68 const int View::SignalSnapGridSize = 10;
  69
  70 const QColor View::CursorAreaColour(220, 231, 243);
  71
  72 const QSizeF View::LabelPadding(4, 0);
  73
  74 View::View(SigSession &session, QWidget *parent) :
  75         QAbstractScrollArea(parent),
  76         _session(session),
  77         _viewport(new Viewport(*this)),
  78         _ruler(new Ruler(*this)),
  79         _cursorheader(new CursorHeader(*this)),
  80         _header(new Header(*this)),
  81         _scale(1e-6),
  82         _offset(0),
  83         _v_offset(0),
  84         _updating_scroll(false),
  85         _show_cursors(false),
  86         _cursors(*this),
  87         _hover_point(-1, -1)
  88 {
  89         connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
  90                 this, SLOT(h_scroll_value_changed(int)));
  91         connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
  92                 this, SLOT(v_scroll_value_changed(int)));
  93
  94         connect(&_session, SIGNAL(signals_changed()),
  95                 this, SLOT(signals_changed()));
  96         connect(&_session, SIGNAL(capture_state_changed(int)),
  97                 this, SLOT(data_updated()));
  98         connect(&_session, SIGNAL(data_received()),
  99                 this, SLOT(data_updated()));
 100         connect(&_session, SIGNAL(frame_ended()),
 101                 this, SLOT(data_updated()));
 102
 103         connect(_cursors.first().get(), SIGNAL(time_changed()),
 104                 this, SLOT(marker_time_changed()));
 105         connect(_cursors.second().get(), SIGNAL(time_changed()),
 106                 this, SLOT(marker_time_changed()));
 107
 108         connect(_header, SIGNAL(geometry_updated()),
 109                 this, SLOT(on_geometry_updated()));
 110         connect(_header, SIGNAL(signals_moved()),
 111                 this, SLOT(on_signals_moved()));
 112
 113         connect(_header, SIGNAL(selection_changed()),
 114                 _cursorheader, SLOT(clear_selection()));
 115         connect(_cursorheader, SIGNAL(selection_changed()),
 116                 _header, SLOT(clear_selection()));
 117
 118         connect(_header, SIGNAL(selection_changed()),
 119                 this, SIGNAL(selection_changed()));
 120         connect(_cursorheader, SIGNAL(selection_changed()),
 121                 this, SIGNAL(selection_changed()));
 122
 123         connect(this, SIGNAL(hover_point_changed()),
 124                 this, SLOT(on_hover_point_changed()));
 125
 126         setViewport(_viewport);
 127
 128         _viewport->installEventFilter(this);
 129         _ruler->installEventFilter(this);
 130         _cursorheader->installEventFilter(this);
 131         _header->installEventFilter(this);
 132
 133         // Trigger the initial event manually. The default device has signals
 134         // which were created before this object came into being
 135         signals_changed();
 136
 137         // make sure the transparent widgets are on the top
 138         _cursorheader->raise();
 139         _header->raise();
 140 }
 141
 142 SigSession& View::session()
 143 {
 144         return _session;
 145 }
 146
 147 const SigSession& View::session() const
 148 {
 149         return _session;
 150 }
 151
 152 Viewport* View::viewport()
 153 {
 154         return _viewport;
 155 }
 156
 157 const Viewport* View::viewport() const
 158 {
 159         return _viewport;
 160 }
 161
 162 double View::scale() const
 163 {
 164         return _scale;
 165 }
 166
 167 double View::offset() const
 168 {
 169         return _offset;
 170 }
 171
 172 int View::v_offset() const
 173 {
 174         return _v_offset;
 175 }
 176
 177 void View::zoom(double steps)
 178 {
 179         zoom(steps, _viewport->width() / 2);
 180 }
 181
 182 void View::zoom(double steps, int offset)
 183 {
 184         set_zoom(_scale * pow(3.0/2.0, -steps), offset);
 185 }
 186
 187 void View::zoom_fit()
 188 {
 189         const pair<double, double> extents = get_time_extents();
 190         const double delta = extents.second - extents.first;
 191         if (delta < 1e-12)
 192                 return;
 193
 194         assert(_viewport);
 195         const int w = _viewport->width();
 196         if (w <= 0)
 197                 return;
 198
 199         const double scale = max(min(delta / w, MaxScale), MinScale);
 200         set_scale_offset(scale, extents.first);
 201 }
 202
 203 void View::zoom_one_to_one()
 204 {
 205         using pv::data::SignalData;
 206
 207         const vector< shared_ptr<Signal> > sigs(
 208                 session().get_signals());
 209
 210         // Make a set of all the visible data objects
 211         set< shared_ptr<SignalData> > visible_data = get_visible_data();
 212         if (visible_data.empty())
 213                 return;
 214
 215         double samplerate = 0.0;
 216         for (const shared_ptr<SignalData> d : visible_data) {
 217                 assert(d);
 218                 samplerate = max(samplerate, d->samplerate());
 219         }
 220
 221         if (samplerate == 0.0)
 222                 return;
 223
 224         assert(_viewport);
 225         const int w = _viewport->width();
 226         if (w <= 0)
 227                 return;
 228
 229         set_zoom(1.0 / samplerate, w / 2);
 230 }
 231
 232 void View::set_scale_offset(double scale, double offset)
 233 {
 234         _scale = scale;
 235         _offset = offset;
 236
 237         update_scroll();
 238         _ruler->update();
 239         _cursorheader->update();
 240         _viewport->update();
 241         scale_offset_changed();
 242 }
 243
 244 vector< shared_ptr<Trace> > View::get_traces() const
 245 {
 246         vector< shared_ptr<Trace> > traces;
 247
 248         const vector< shared_ptr<Signal> > sigs(
 249                 session().get_signals());
 250         copy(sigs.begin(), sigs.end(), back_inserter(traces));
 251
 252 #ifdef ENABLE_DECODE
 253         const vector< shared_ptr<DecodeTrace> > decode_sigs(
 254                 session().get_decode_signals());
 255         copy(decode_sigs.begin(), decode_sigs.end(), back_inserter(traces));
 256 #endif
 257
 258         stable_sort(traces.begin(), traces.end(),
 259                 [](const shared_ptr<Trace> &a, const shared_ptr<Trace> &b) {
 260                         return a->get_v_offset() < b->get_v_offset(); });
 261
 262         return traces;
 263 }
 264
 265 list<weak_ptr<SelectableItem> > View::selected_items() const
 266 {
 267         list<weak_ptr<SelectableItem> > items;
 268
 269         // List the selected signals
 270         const vector< shared_ptr<Trace> > traces(get_traces());
 271         for (shared_ptr<Trace> t : traces) {
 272                 assert(t);
 273                 if (t->selected())
 274                         items.push_back(t);
 275         }
 276
 277         // List the selected cursors
 278         if (_cursors.first()->selected())
 279                 items.push_back(_cursors.first());
 280         if (_cursors.second()->selected())
 281                 items.push_back(_cursors.second());
 282
 283         return items;
 284 }
 285
 286 set< shared_ptr<SignalData> > View::get_visible_data() const
 287 {
 288         const vector< shared_ptr<Signal> > sigs(
 289                 session().get_signals());
 290
 291         // Make a set of all the visible data objects
 292         set< shared_ptr<SignalData> > visible_data;
 293         for (const shared_ptr<Signal> sig : sigs)
 294                 if (sig->enabled())
 295                         visible_data.insert(sig->data());
 296
 297         return visible_data;
 298 }
 299
 300 pair<double, double> View::get_time_extents() const
 301 {
 302         const set< shared_ptr<SignalData> > visible_data = get_visible_data();
 303         if (visible_data.empty())
 304                 return make_pair(0.0, 0.0);
 305
 306         double left_time = DBL_MAX, right_time = DBL_MIN;
 307         for (const shared_ptr<SignalData> d : visible_data)
 308         {
 309                 const double start_time = d->get_start_time();
 310                 double samplerate = d->samplerate();
 311                 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 312
 313                 left_time = min(left_time, start_time);
 314                 right_time = max(right_time, start_time +
 315                         d->get_max_sample_count() / samplerate);
 316         }
 317
 318         assert(left_time < right_time);
 319         return make_pair(left_time, right_time);
 320 }
 321
 322 bool View::cursors_shown() const
 323 {
 324         return _show_cursors;
 325 }
 326
 327 void View::show_cursors(bool show)
 328 {
 329         _show_cursors = show;
 330         _cursorheader->update();
 331         _viewport->update();
 332 }
 333
 334 void View::centre_cursors()
 335 {
 336         const double time_width = _scale * _viewport->width();
 337         _cursors.first()->set_time(_offset + time_width * 0.4);
 338         _cursors.second()->set_time(_offset + time_width * 0.6);
 339         _cursorheader->update();
 340         _viewport->update();
 341 }
 342
 343 CursorPair& View::cursors()
 344 {
 345         return _cursors;
 346 }
 347
 348 const CursorPair& View::cursors() const
 349 {
 350         return _cursors;
 351 }
 352
 353 const QPoint& View::hover_point() const
 354 {
 355         return _hover_point;
 356 }
 357
 358 void View::normalize_layout()
 359 {
 360         const vector< shared_ptr<Trace> > traces(get_traces());
 361
 362         int v_min = INT_MAX;
 363         for (const shared_ptr<Trace> t : traces)
 364                 v_min = min(t->get_v_offset(), v_min);
 365
 366         const int delta = -min(v_min, 0);
 367         for (shared_ptr<Trace> t : traces)
 368                 t->set_v_offset(t->get_v_offset() + delta);
 369
 370         verticalScrollBar()->setSliderPosition(_v_offset + delta);
 371         v_scroll_value_changed(verticalScrollBar()->sliderPosition());
 372 }
 373
 374 void View::update_viewport()
 375 {
 376         assert(_viewport);
 377         _viewport->update();
 378 }
 379
 380 void View::get_scroll_layout(double &length, double &offset) const
 381 {
 382         const pair<double, double> extents = get_time_extents();
 383         length = (extents.second - extents.first) / _scale;
 384         offset = _offset / _scale;
 385 }
 386
 387 void View::set_zoom(double scale, int offset)
 388 {
 389         const double cursor_offset = _offset + _scale * offset;
 390         const double new_scale = max(min(scale, MaxScale), MinScale);
 391         const double new_offset = cursor_offset - new_scale * offset;
 392         set_scale_offset(new_scale, new_offset);
 393 }
 394
 395 void View::update_scroll()
 396 {
 397         assert(_viewport);
 398
 399         const QSize areaSize = _viewport->size();
 400
 401         // Set the horizontal scroll bar
 402         double length = 0, offset = 0;
 403         get_scroll_layout(length, offset);
 404         length = max(length - areaSize.width(), 0.0);
 405
 406         horizontalScrollBar()->setPageStep(areaSize.width() / 2);
 407
 408         _updating_scroll = true;
 409
 410         if (length < MaxScrollValue) {
 411                 horizontalScrollBar()->setRange(0, length);
 412                 horizontalScrollBar()->setSliderPosition(offset);
 413         } else {
 414                 horizontalScrollBar()->setRange(0, MaxScrollValue);
 415                 horizontalScrollBar()->setSliderPosition(
 416                         _offset * MaxScrollValue / (_scale * length));
 417         }
 418
 419         _updating_scroll = false;
 420
 421         // Set the vertical scrollbar
 422         verticalScrollBar()->setPageStep(areaSize.height());
 423         verticalScrollBar()->setRange(0,
 424                 _viewport->get_total_height() + SignalMargin -
 425                 areaSize.height());
 426 }
 427
 428 void View::update_layout()
 429 {
 430         setViewportMargins(
 431                 _header->sizeHint().width() - pv::view::Header::BaselineOffset,
 432                 _ruler->sizeHint().height(), 0, 0);
 433         _ruler->setGeometry(_viewport->x(), 0,
 434                 _viewport->width(), _viewport->y());
 435         _cursorheader->setGeometry(
 436                 _viewport->x(),
 437                 _ruler->sizeHint().height() - _cursorheader->sizeHint().height() / 2,
 438                 _viewport->width(), _cursorheader->sizeHint().height());
 439         _header->setGeometry(0, _viewport->y(),
 440                 _header->sizeHint().width(), _viewport->height());
 441         update_scroll();
 442 }
 443
 444 bool View::eventFilter(QObject *object, QEvent *event)
 445 {
 446         const QEvent::Type type = event->type();
 447         if (type == QEvent::MouseMove) {
 448
 449                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
 450                 if (object == _viewport)
 451                         _hover_point = mouse_event->pos();
 452                 else if (object == _ruler || object == _cursorheader)
 453                         _hover_point = QPoint(mouse_event->x(), 0);
 454                 else if (object == _header)
 455                         _hover_point = QPoint(0, mouse_event->y());
 456                 else
 457                         _hover_point = QPoint(-1, -1);
 458
 459                 hover_point_changed();
 460
 461         } else if (type == QEvent::Leave) {
 462                 _hover_point = QPoint(-1, -1);
 463                 hover_point_changed();
 464         }
 465
 466         return QObject::eventFilter(object, event);
 467 }
 468
 469 bool View::viewportEvent(QEvent *e)
 470 {
 471         switch(e->type()) {
 472         case QEvent::Paint:
 473         case QEvent::MouseButtonPress:
 474         case QEvent::MouseButtonRelease:
 475         case QEvent::MouseButtonDblClick:
 476         case QEvent::MouseMove:
 477         case QEvent::Wheel:
 478         case QEvent::TouchBegin:
 479         case QEvent::TouchUpdate:
 480         case QEvent::TouchEnd:
 481                 return false;
 482
 483         default:
 484                 return QAbstractScrollArea::viewportEvent(e);
 485         }
 486 }
 487
 488 void View::resizeEvent(QResizeEvent*)
 489 {
 490         update_layout();
 491 }
 492
 493 void View::h_scroll_value_changed(int value)
 494 {
 495         if (_updating_scroll)
 496                 return;
 497
 498         const int range = horizontalScrollBar()->maximum();
 499         if (range < MaxScrollValue)
 500                 _offset = _scale * value;
 501         else {
 502                 double length = 0, offset;
 503                 get_scroll_layout(length, offset);
 504                 _offset = _scale * length * value / MaxScrollValue;
 505         }
 506
 507         _ruler->update();
 508         _cursorheader->update();
 509         _viewport->update();
 510 }
 511
 512 void View::v_scroll_value_changed(int value)
 513 {
 514         _v_offset = value;
 515         _header->update();
 516         _viewport->update();
 517 }
 518
 519 void View::signals_changed()
 520 {
 521         int offset = SignalMargin + SignalHeight;
 522         const vector< shared_ptr<Trace> > traces(get_traces());
 523         for (shared_ptr<Trace> t : traces) {
 524                 t->set_view(this);
 525                 t->set_v_offset(offset);
 526                 offset += SignalHeight + 2 * SignalMargin;
 527         }
 528
 529         update_layout();
 530         normalize_layout();
 531 }
 532
 533 void View::data_updated()
 534 {
 535         // Update the scroll bars
 536         update_scroll();
 537
 538         // Repaint the view
 539         _viewport->update();
 540 }
 541
 542 void View::marker_time_changed()
 543 {
 544         _cursorheader->update();
 545         _viewport->update();
 546 }
 547
 548 void View::on_signals_moved()
 549 {
 550         update_scroll();
 551         signals_moved();
 552 }
 553
 554 void View::on_geometry_updated()
 555 {
 556         update_layout();
 557 }
 558
 559 void View::on_hover_point_changed()
 560 {
 561         const vector< shared_ptr<Trace> > traces(get_traces());
 562         for (shared_ptr<Trace> t : traces)
 563                 t->hover_point_changed();
 564 }
 565
 566 } // namespace view
 567 } // namespace pv