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         const double new_scale = max(min(_scale * pow(3.0/2.0, -steps),
 149                 MaxScale), MinScale);
 150         const double new_offset = cursor_offset - new_scale * offset;
 151         set_scale_offset(new_scale, new_offset);
 152 }
 153
 154 void View::set_scale_offset(double scale, double offset)
 155 {
 156         _scale = scale;
 157         _offset = offset;
 158
 159         update_scroll();
 160         _ruler->update();
 161         _viewport->update();
 162         scale_offset_changed();
 163 }
 164
 165 vector< shared_ptr<Trace> > View::get_traces() const
 166 {
 167         const vector< shared_ptr<Signal> > sigs(
 168                 session().get_signals());
 169         const vector< shared_ptr<DecodeSignal> > decode_sigs(
 170                 session().get_decode_signals());
 171         vector< shared_ptr<Trace> > traces(
 172                 sigs.size() + decode_sigs.size());
 173
 174         vector< shared_ptr<Trace> >::iterator i = traces.begin();
 175         i = copy(sigs.begin(), sigs.end(), i);
 176         i = copy(decode_sigs.begin(), decode_sigs.end(), i);
 177
 178         sort(traces.begin(), traces.end(), compare_trace_v_offsets);
 179         return traces;
 180 }
 181
 182 list<weak_ptr<SelectableItem> > View::selected_items() const
 183 {
 184         list<weak_ptr<SelectableItem> > items;
 185
 186         // List the selected signals
 187         const vector< shared_ptr<Trace> > traces(get_traces());
 188         BOOST_FOREACH (shared_ptr<Trace> t, traces) {
 189                 assert(t);
 190                 if (t->selected())
 191                         items.push_back(t);
 192         }
 193
 194         // List the selected cursors
 195         if (_cursors.first()->selected())
 196                 items.push_back(_cursors.first());
 197         if (_cursors.second()->selected())
 198                 items.push_back(_cursors.second());
 199
 200         return items;
 201 }
 202
 203 bool View::cursors_shown() const
 204 {
 205         return _show_cursors;
 206 }
 207
 208 void View::show_cursors(bool show)
 209 {
 210         _show_cursors = show;
 211         _ruler->update();
 212         _viewport->update();
 213 }
 214
 215 void View::centre_cursors()
 216 {
 217         const double time_width = _scale * _viewport->width();
 218         _cursors.first()->set_time(_offset + time_width * 0.4);
 219         _cursors.second()->set_time(_offset + time_width * 0.6);
 220         _ruler->update();
 221         _viewport->update();
 222 }
 223
 224 CursorPair& View::cursors()
 225 {
 226         return _cursors;
 227 }
 228
 229 const CursorPair& View::cursors() const
 230 {
 231         return _cursors;
 232 }
 233
 234 const QPoint& View::hover_point() const
 235 {
 236         return _hover_point;
 237 }
 238
 239 void View::normalize_layout()
 240 {
 241         const vector< shared_ptr<Trace> > traces(get_traces());
 242
 243         int v_min = INT_MAX;
 244         BOOST_FOREACH(const shared_ptr<Trace> t, traces)
 245                 v_min = min(t->get_v_offset(), v_min);
 246
 247         const int delta = -min(v_min, 0);
 248         BOOST_FOREACH(shared_ptr<Trace> t, traces)
 249                 t->set_v_offset(t->get_v_offset() + delta);
 250
 251         verticalScrollBar()->setSliderPosition(_v_offset + delta);
 252         v_scroll_value_changed(verticalScrollBar()->sliderPosition());
 253 }
 254
 255 void View::update_viewport()
 256 {
 257         assert(_viewport);
 258         _viewport->update();
 259 }
 260
 261 void View::get_scroll_layout(double &length, double &offset) const
 262 {
 263         const shared_ptr<data::SignalData> sig_data = _session.get_data();
 264         if (!sig_data)
 265                 return;
 266
 267         length = _data_length / (sig_data->get_samplerate() * _scale);
 268         offset = _offset / _scale;
 269 }
 270
 271 void View::update_scroll()
 272 {
 273         assert(_viewport);
 274
 275         const QSize areaSize = _viewport->size();
 276
 277         // Set the horizontal scroll bar
 278         double length = 0, offset = 0;
 279         get_scroll_layout(length, offset);
 280         length = max(length - areaSize.width(), 0.0);
 281
 282         horizontalScrollBar()->setPageStep(areaSize.width() / 2);
 283
 284         _updating_scroll = true;
 285
 286         if (length < MaxScrollValue) {
 287                 horizontalScrollBar()->setRange(0, length);
 288                 horizontalScrollBar()->setSliderPosition(offset);
 289         } else {
 290                 horizontalScrollBar()->setRange(0, MaxScrollValue);
 291                 horizontalScrollBar()->setSliderPosition(
 292                         _offset * MaxScrollValue / (_scale * length));
 293         }
 294
 295         _updating_scroll = false;
 296
 297         // Set the vertical scrollbar
 298         verticalScrollBar()->setPageStep(areaSize.height());
 299         verticalScrollBar()->setRange(0,
 300                 _viewport->get_total_height() + SignalMargin -
 301                 areaSize.height());
 302 }
 303
 304 bool View::compare_trace_v_offsets(const shared_ptr<Trace> &a,
 305         const shared_ptr<Trace> &b)
 306 {
 307         assert(a);
 308         assert(b);
 309         return a->get_v_offset() < b->get_v_offset();
 310 }
 311
 312 bool View::eventFilter(QObject *object, QEvent *event)
 313 {
 314         const QEvent::Type type = event->type();
 315         if (type == QEvent::MouseMove) {
 316
 317                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
 318                 if (object == _viewport)
 319                         _hover_point = mouse_event->pos();
 320                 else if (object == _ruler)
 321                         _hover_point = QPoint(mouse_event->x(), 0);
 322                 else if (object == _header)
 323                         _hover_point = QPoint(0, mouse_event->y());
 324                 else
 325                         _hover_point = QPoint(-1, -1);
 326
 327                 hover_point_changed();
 328
 329         } else if (type == QEvent::Leave) {
 330                 _hover_point = QPoint(-1, -1);
 331                 hover_point_changed();
 332         }
 333
 334         return QObject::eventFilter(object, event);
 335 }
 336
 337 bool View::viewportEvent(QEvent *e)
 338 {
 339         switch(e->type()) {
 340         case QEvent::Paint:
 341         case QEvent::MouseButtonPress:
 342         case QEvent::MouseButtonRelease:
 343         case QEvent::MouseButtonDblClick:
 344         case QEvent::MouseMove:
 345         case QEvent::Wheel:
 346                 return false;
 347
 348         default:
 349                 return QAbstractScrollArea::viewportEvent(e);
 350         }
 351 }
 352
 353 void View::resizeEvent(QResizeEvent*)
 354 {
 355         _ruler->setGeometry(_viewport->x(), 0,
 356                 _viewport->width(), _viewport->y());
 357         _header->setGeometry(0, _viewport->y(),
 358                 _viewport->x(), _viewport->height());
 359         update_scroll();
 360 }
 361
 362 void View::h_scroll_value_changed(int value)
 363 {
 364         if (_updating_scroll)
 365                 return;
 366
 367         const int range = horizontalScrollBar()->maximum();
 368         if (range < MaxScrollValue)
 369                 _offset = _scale * value;
 370         else {
 371                 double length = 0, offset;
 372                 get_scroll_layout(length, offset);
 373                 _offset = _scale * length * value / MaxScrollValue;
 374         }
 375
 376         _ruler->update();
 377         _viewport->update();
 378 }
 379
 380 void View::v_scroll_value_changed(int value)
 381 {
 382         _v_offset = value;
 383         _header->update();
 384         _viewport->update();
 385 }
 386
 387 void View::signals_changed()
 388 {
 389         int offset = SignalMargin + SignalHeight;
 390         const vector< shared_ptr<Trace> > traces(get_traces());
 391         BOOST_FOREACH(shared_ptr<Trace> t, traces) {
 392                 t->set_view(this);
 393                 t->set_v_offset(offset);
 394                 offset += SignalHeight + 2 * SignalMargin;
 395         }
 396
 397         normalize_layout();
 398 }
 399
 400 void View::data_updated()
 401 {
 402         // Get the new data length
 403         _data_length = 0;
 404         shared_ptr<data::Logic> sig_data = _session.get_data();
 405         if (sig_data) {
 406                 deque< shared_ptr<data::LogicSnapshot> > &snapshots =
 407                         sig_data->get_snapshots();
 408                 BOOST_FOREACH(shared_ptr<data::LogicSnapshot> s, snapshots)
 409                         if (s)
 410                                 _data_length = max(_data_length,
 411                                         s->get_sample_count());
 412         }
 413
 414         // Update the scroll bars
 415         update_scroll();
 416
 417         // Repaint the view
 418         _viewport->update();
 419 }
 420
 421 void View::marker_time_changed()
 422 {
 423         _ruler->update();
 424         _viewport->update();
 425 }
 426
 427 void View::on_signals_moved()
 428 {
 429         update_scroll();
 430         signals_moved();
 431 }
 432
 433 } // namespace view
 434 } // namespace pv