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