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 #include <assert.h>
  22 #include <limits.h>
  23 #include <math.h>
  24
  25 #include <boost/foreach.hpp>
  26
  27 #include <QEvent>
  28 #include <QMouseEvent>
  29 #include <QScrollBar>
  30
  31 #include "decodesignal.h"
  32 #include "header.h"
  33 #include "ruler.h"
  34 #include "signal.h"
  35 #include "view.h"
  36 #include "viewport.h"
  37
  38 #include "pv/sigsession.h"
  39 #include "pv/data/logic.h"
  40 #include "pv/data/logicsnapshot.h"
  41
  42 using namespace boost;
  43 using namespace std;
  44
  45 namespace pv {
  46 namespace view {
  47
  48 const double View::MaxScale = 1e9;
  49 const double View::MinScale = 1e-15;
  50
  51 const int View::LabelMarginWidth = 70;
  52 const int View::RulerHeight = 30;
  53
  54 const int View::MaxScrollValue = INT_MAX / 2;
  55
  56 const int View::SignalHeight = 30;
  57 const int View::SignalMargin = 10;
  58 const int View::SignalSnapGridSize = 10;
  59
  60 const QColor View::CursorAreaColour(220, 231, 243);
  61
  62 const QSizeF View::LabelPadding(4, 0);
  63
  64 View::View(SigSession &session, QWidget *parent) :
  65         QAbstractScrollArea(parent),
  66         _session(session),
  67         _viewport(new Viewport(*this)),
  68         _ruler(new Ruler(*this)),
  69         _header(new Header(*this)),
  70         _data_length(0),
  71         _scale(1e-6),
  72         _offset(0),
  73         _v_offset(0),
  74         _updating_scroll(false),
  75         _show_cursors(false),
  76         _cursors(*this),
  77         _hover_point(-1, -1)
  78 {
  79         connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
  80                 this, SLOT(h_scroll_value_changed(int)));
  81         connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
  82                 this, SLOT(v_scroll_value_changed(int)));
  83
  84         connect(&_session, SIGNAL(signals_changed()),
  85                 this, SLOT(signals_changed()));
  86         connect(&_session, SIGNAL(data_updated()),
  87                 this, SLOT(data_updated()));
  88
  89         connect(_cursors.first().get(), SIGNAL(time_changed()),
  90                 this, SLOT(marker_time_changed()));
  91         connect(_cursors.second().get(), SIGNAL(time_changed()),
  92                 this, SLOT(marker_time_changed()));
  93
  94         connect(_header, SIGNAL(signals_moved()),
  95                 this, SLOT(on_signals_moved()));
  96
  97         connect(_header, SIGNAL(selection_changed()),
  98                 _ruler, SLOT(clear_selection()));
  99         connect(_ruler, SIGNAL(selection_changed()),
 100                 _header, SLOT(clear_selection()));
 101
 102         connect(_header, SIGNAL(selection_changed()),
 103                 this, SIGNAL(selection_changed()));
 104         connect(_ruler, SIGNAL(selection_changed()),
 105                 this, SIGNAL(selection_changed()));
 106
 107         setViewportMargins(LabelMarginWidth, RulerHeight, 0, 0);
 108         setViewport(_viewport);
 109
 110         _viewport->installEventFilter(this);
 111         _ruler->installEventFilter(this);
 112         _header->installEventFilter(this);
 113 }
 114
 115 SigSession& View::session()
 116 {
 117         return _session;
 118 }
 119
 120 const SigSession& View::session() const
 121 {
 122         return _session;
 123 }
 124
 125 double View::scale() const
 126 {
 127         return _scale;
 128 }
 129
 130 double View::offset() const
 131 {
 132         return _offset;
 133 }
 134
 135 int View::v_offset() const
 136 {
 137         return _v_offset;
 138 }
 139
 140 void View::zoom(double steps)
 141 {
 142         zoom(steps, (width() - LabelMarginWidth) / 2);
 143 }
 144
 145 void View::zoom(double steps, int offset)
 146 {
 147         const double cursor_offset = _offset + _scale * offset;
 148         _scale *= pow(3.0/2.0, -steps);
 149         _scale = max(min(_scale, MaxScale), MinScale);
 150         _offset = cursor_offset - _scale * offset;
 151
 152         _ruler->update();
 153         _viewport->update();
 154         update_scroll();
 155 }
 156
 157
 158 void View::set_scale_offset(double scale, double offset)
 159 {
 160         _scale = scale;
 161         _offset = offset;
 162
 163         update_scroll();
 164         _ruler->update();
 165         _viewport->update();
 166 }
 167
 168 vector< shared_ptr<Trace> > View::get_traces() const
 169 {
 170         const vector< shared_ptr<Signal> > sigs(
 171                 session().get_signals());
 172         const vector< shared_ptr<DecodeSignal> > decode_sigs(
 173                 session().get_decode_signals());
 174         vector< shared_ptr<Trace> > traces(
 175                 sigs.size() + decode_sigs.size());
 176
 177         vector< shared_ptr<Trace> >::iterator i = traces.begin();
 178         i = copy(sigs.begin(), sigs.end(), i);
 179         i = copy(decode_sigs.begin(), decode_sigs.end(), i);
 180
 181         sort(traces.begin(), traces.end(), compare_trace_v_offsets);
 182         return traces;
 183 }
 184
 185 list<weak_ptr<SelectableItem> > View::selected_items() const
 186 {
 187         list<weak_ptr<SelectableItem> > items;
 188
 189         // List the selected signals
 190         const vector< shared_ptr<Trace> > traces(get_traces());
 191         BOOST_FOREACH (shared_ptr<Trace> t, traces) {
 192                 assert(t);
 193                 if (t->selected())
 194                         items.push_back(t);
 195         }
 196
 197         // List the selected cursors
 198         if (_cursors.first()->selected())
 199                 items.push_back(_cursors.first());
 200         if (_cursors.second()->selected())
 201                 items.push_back(_cursors.second());
 202
 203         return items;
 204 }
 205
 206 bool View::cursors_shown() const
 207 {
 208         return _show_cursors;
 209 }
 210
 211 void View::show_cursors(bool show)
 212 {
 213         _show_cursors = show;
 214         _ruler->update();
 215         _viewport->update();
 216 }
 217
 218 void View::centre_cursors()
 219 {
 220         const double time_width = _scale * _viewport->width();
 221         _cursors.first()->set_time(_offset + time_width * 0.4);
 222         _cursors.second()->set_time(_offset + time_width * 0.6);
 223         _ruler->update();
 224         _viewport->update();
 225 }
 226
 227 CursorPair& View::cursors()
 228 {
 229         return _cursors;
 230 }
 231
 232 const CursorPair& View::cursors() const
 233 {
 234         return _cursors;
 235 }
 236
 237 const QPoint& View::hover_point() const
 238 {
 239         return _hover_point;
 240 }
 241
 242 void View::normalize_layout()
 243 {
 244         const vector< shared_ptr<Trace> > traces(get_traces());
 245
 246         int v_min = INT_MAX;
 247         BOOST_FOREACH(const shared_ptr<Trace> t, traces)
 248                 v_min = min(t->get_v_offset(), v_min);
 249
 250         const int delta = -min(v_min, 0);
 251         BOOST_FOREACH(shared_ptr<Trace> t, traces)
 252                 t->set_v_offset(t->get_v_offset() + delta);
 253
 254         verticalScrollBar()->setSliderPosition(_v_offset + delta);
 255         v_scroll_value_changed(verticalScrollBar()->sliderPosition());
 256 }
 257
 258 void View::get_scroll_layout(double &length, double &offset) const
 259 {
 260         const shared_ptr<data::SignalData> sig_data = _session.get_data();
 261         if (!sig_data)
 262                 return;
 263
 264         length = _data_length / (sig_data->get_samplerate() * _scale);
 265         offset = _offset / _scale;
 266 }
 267
 268 void View::update_scroll()
 269 {
 270         assert(_viewport);
 271
 272         const QSize areaSize = _viewport->size();
 273
 274         // Set the horizontal scroll bar
 275         double length = 0, offset = 0;
 276         get_scroll_layout(length, offset);
 277         length = max(length - areaSize.width(), 0.0);
 278
 279         horizontalScrollBar()->setPageStep(areaSize.width() / 2);
 280
 281         _updating_scroll = true;
 282
 283         if (length < MaxScrollValue) {
 284                 horizontalScrollBar()->setRange(0, length);
 285                 horizontalScrollBar()->setSliderPosition(offset);
 286         } else {
 287                 horizontalScrollBar()->setRange(0, MaxScrollValue);
 288                 horizontalScrollBar()->setSliderPosition(
 289                         _offset * MaxScrollValue / (_scale * length));
 290         }
 291
 292         _updating_scroll = false;
 293
 294         // Set the vertical scrollbar
 295         verticalScrollBar()->setPageStep(areaSize.height());
 296         verticalScrollBar()->setRange(0,
 297                 _viewport->get_total_height() + SignalMargin -
 298                 areaSize.height());
 299 }
 300
 301 bool View::compare_trace_v_offsets(const shared_ptr<Trace> &a,
 302         const shared_ptr<Trace> &b)
 303 {
 304         assert(a);
 305         assert(b);
 306         return a->get_v_offset() < b->get_v_offset();
 307 }
 308
 309 bool View::eventFilter(QObject *object, QEvent *event)
 310 {
 311         const QEvent::Type type = event->type();
 312         if (type == QEvent::MouseMove) {
 313
 314                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
 315                 if (object == _viewport)
 316                         _hover_point = mouse_event->pos();
 317                 else if (object == _ruler)
 318                         _hover_point = QPoint(mouse_event->x(), 0);
 319                 else if (object == _header)
 320                         _hover_point = QPoint(0, mouse_event->y());
 321                 else
 322                         _hover_point = QPoint(-1, -1);
 323
 324                 hover_point_changed();
 325
 326         } else if (type == QEvent::Leave) {
 327                 _hover_point = QPoint(-1, -1);
 328                 hover_point_changed();
 329         }
 330
 331         return QObject::eventFilter(object, event);
 332 }
 333
 334 bool View::viewportEvent(QEvent *e)
 335 {
 336         switch(e->type()) {
 337         case QEvent::Paint:
 338         case QEvent::MouseButtonPress:
 339         case QEvent::MouseButtonRelease:
 340         case QEvent::MouseButtonDblClick:
 341         case QEvent::MouseMove:
 342         case QEvent::Wheel:
 343                 return false;
 344
 345         default:
 346                 return QAbstractScrollArea::viewportEvent(e);
 347         }
 348 }
 349
 350 void View::resizeEvent(QResizeEvent*)
 351 {
 352         _ruler->setGeometry(_viewport->x(), 0,
 353                 _viewport->width(), _viewport->y());
 354         _header->setGeometry(0, _viewport->y(),
 355                 _viewport->x(), _viewport->height());
 356         update_scroll();
 357 }
 358
 359 void View::h_scroll_value_changed(int value)
 360 {
 361         if (_updating_scroll)
 362                 return;
 363
 364         const int range = horizontalScrollBar()->maximum();
 365         if (range < MaxScrollValue)
 366                 _offset = _scale * value;
 367         else {
 368                 double length = 0, offset;
 369                 get_scroll_layout(length, offset);
 370                 _offset = _scale * length * value / MaxScrollValue;
 371         }
 372
 373         _ruler->update();
 374         _viewport->update();
 375 }
 376
 377 void View::v_scroll_value_changed(int value)
 378 {
 379         _v_offset = value;
 380         _header->update();
 381         _viewport->update();
 382 }
 383
 384 void View::signals_changed()
 385 {
 386         int offset = SignalMargin + SignalHeight;
 387         const vector< shared_ptr<Signal> > sigs(_session.get_signals());
 388         BOOST_FOREACH(shared_ptr<Signal> s, sigs) {
 389                 s->init_context_bar_actions(NULL);
 390                 s->set_v_offset(offset);
 391                 offset += SignalHeight + 2 * SignalMargin;
 392         }
 393
 394         normalize_layout();
 395 }
 396
 397 void View::data_updated()
 398 {
 399         // Get the new data length
 400         _data_length = 0;
 401         shared_ptr<data::Logic> sig_data = _session.get_data();
 402         if (sig_data) {
 403                 deque< shared_ptr<data::LogicSnapshot> > &snapshots =
 404                         sig_data->get_snapshots();
 405                 BOOST_FOREACH(shared_ptr<data::LogicSnapshot> s, snapshots)
 406                         if (s)
 407                                 _data_length = max(_data_length,
 408                                         s->get_sample_count());
 409         }
 410
 411         // Update the scroll bars
 412         update_scroll();
 413
 414         // Repaint the view
 415         _viewport->update();
 416 }
 417
 418 void View::marker_time_changed()
 419 {
 420         _ruler->update();
 421         _viewport->update();
 422 }
 423
 424 void View::on_signals_moved()
 425 {
 426         update_scroll();
 427         signals_moved();
 428 }
 429
 430 } // namespace view
 431 } // namespace pv