]> sigrok.org Git - pulseview.git/blobdiff - pv/view/view.cpp
Use bool literals for boolean values.
[pulseview.git] / pv / view / view.cpp
index 3f832474cebdf9415df879dc3592a7de27a25f7d..cc0ceb79cabfadaa68fa1396997de3ba79930b78 100644 (file)
@@ -14,8 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifdef ENABLE_DECODE
 #include <cassert>
 #include <climits>
 #include <cmath>
+#include <iostream>
 #include <iterator>
 #include <mutex>
 #include <unordered_set>
 
+#include <boost/archive/text_iarchive.hpp>
+#include <boost/archive/text_oarchive.hpp>
+#include <boost/serialization/serialization.hpp>
 #include <boost/thread/locks.hpp>
 
 #include <QApplication>
+#include <QHBoxLayout>
 #include <QEvent>
 #include <QFontMetrics>
 #include <QMouseEvent>
@@ -53,6 +57,7 @@
 #include "viewport.hpp"
 
 #include "pv/session.hpp"
+#include "pv/globalsettings.hpp"
 #include "pv/devices/device.hpp"
 #include "pv/data/logic.hpp"
 #include "pv/data/logicsegment.hpp"
@@ -91,7 +96,8 @@ using std::vector;
 using std::weak_ptr;
 
 namespace pv {
-namespace view {
+namespace views {
+namespace TraceView {
 
 const Timestamp View::MaxScale("1e9");
 const Timestamp View::MinScale("1e-12");
@@ -101,12 +107,41 @@ const int View::MaxViewAutoUpdateRate = 25; // No more than 25 Hz with sticky sc
 
 const int View::ScaleUnits[3] = {1, 2, 5};
 
-View::View(Session &session, QWidget *parent) :
-       QAbstractScrollArea(parent),
-       session_(session),
+
+CustomAbstractScrollArea::CustomAbstractScrollArea(QWidget *parent) :
+       QAbstractScrollArea(parent)
+{
+}
+
+void CustomAbstractScrollArea::setViewportMargins(int left, int top, int right, int bottom)
+{
+       QAbstractScrollArea::setViewportMargins(left, top, right, bottom);
+}
+
+bool CustomAbstractScrollArea::viewportEvent(QEvent *event)
+{
+       switch (event->type()) {
+       case QEvent::Paint:
+       case QEvent::MouseButtonPress:
+       case QEvent::MouseButtonRelease:
+       case QEvent::MouseButtonDblClick:
+       case QEvent::MouseMove:
+       case QEvent::Wheel:
+       case QEvent::TouchBegin:
+       case QEvent::TouchUpdate:
+       case QEvent::TouchEnd:
+               return false;
+       default:
+               return QAbstractScrollArea::viewportEvent(event);
+       }
+}
+
+View::View(Session &session, bool is_main_view, QWidget *parent) :
+       ViewBase(session, is_main_view, parent),
        viewport_(new Viewport(*this)),
        ruler_(new Ruler(*this)),
        header_(new Header(*this)),
+       scrollarea_(this),
        scale_(1e-3),
        offset_(0),
        updating_scroll_(false),
@@ -120,22 +155,19 @@ View::View(Session &session, QWidget *parent) :
        cursors_(new CursorPair(*this)),
        next_flag_text_('A'),
        trigger_markers_(),
-       hover_point_(-1, -1)
+       hover_point_(-1, -1),
+       scroll_needs_defaults_(false),
+       saved_v_offset_(0),
+       size_finalized_(false)
 {
-       connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
+       GlobalSettings settings;
+       coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
+
+       connect(scrollarea_.horizontalScrollBar(), SIGNAL(valueChanged(int)),
                this, SLOT(h_scroll_value_changed(int)));
-       connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
+       connect(scrollarea_.verticalScrollBar(), SIGNAL(valueChanged(int)),
                this, SLOT(v_scroll_value_changed()));
 
-       connect(&session_, SIGNAL(signals_changed()),
-               this, SLOT(signals_changed()));
-       connect(&session_, SIGNAL(capture_state_changed(int)),
-               this, SLOT(capture_state_updated(int)));
-       connect(&session_, SIGNAL(data_received()),
-               this, SLOT(data_updated()));
-       connect(&session_, SIGNAL(frame_ended()),
-               this, SLOT(data_updated()));
-
        connect(header_, SIGNAL(selection_changed()),
                ruler_, SLOT(clear_selection()));
        connect(ruler_, SIGNAL(selection_changed()),
@@ -158,7 +190,13 @@ View::View(Session &session, QWidget *parent) :
        delayed_view_updater_.setSingleShot(true);
        delayed_view_updater_.setInterval(1000 / MaxViewAutoUpdateRate);
 
-       setViewport(viewport_);
+       /* To let the scroll area fill up the parent QWidget (this), we need a layout */
+       QHBoxLayout *layout = new QHBoxLayout(this);
+       setLayout(layout);
+       layout->setContentsMargins(0, 0, 0, 0);
+       layout->addWidget(&scrollarea_);
+
+       scrollarea_.setViewport(viewport_);
 
        viewport_->installEventFilter(this);
        ruler_->installEventFilter(this);
@@ -186,7 +224,7 @@ const Session& View::session() const
        return session_;
 }
 
-std::unordered_set< std::shared_ptr<view::Signal> > View::signals() const
+std::unordered_set< std::shared_ptr<Signal> > View::signals() const
 {
        return signals_;
 }
@@ -196,25 +234,25 @@ void View::clear_signals()
        signals_.clear();
 }
 
-void View::add_signal(const shared_ptr<view::Signal> signal)
+void View::add_signal(const shared_ptr<Signal> signal)
 {
        signals_.insert(signal);
 }
 
 #ifdef ENABLE_DECODE
-void View::clear_decode_traces()
+void View::clear_decode_signals()
 {
        decode_traces_.clear();
 }
 
-void View::add_decode_trace(shared_ptr<data::SignalBase> signalbase)
+void View::add_decode_signal(shared_ptr<data::SignalBase> signalbase)
 {
-       shared_ptr<view::DecodeTrace> d(
-               new view::DecodeTrace(session_, signalbase, decode_traces_.size()));
+       shared_ptr<DecodeTrace> d(
+               new DecodeTrace(session_, signalbase, decode_traces_.size()));
        decode_traces_.push_back(d);
 }
 
-void View::remove_decode_trace(shared_ptr<data::SignalBase> signalbase)
+void View::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
 {
        for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
                if ((*i)->base() == signalbase) {
@@ -245,6 +283,57 @@ const Viewport* View::viewport() const
        return viewport_;
 }
 
+void View::save_settings(QSettings &settings) const
+{
+       settings.setValue("scale", scale_);
+       settings.setValue("v_offset",
+               scrollarea_.verticalScrollBar()->sliderPosition());
+
+       std::stringstream ss;
+       boost::archive::text_oarchive oa(ss);
+       oa << boost::serialization::make_nvp("offset", offset_);
+       settings.setValue("offset", QString::fromStdString(ss.str()));
+
+       for (shared_ptr<Signal> signal : signals_) {
+               settings.beginGroup(signal->base()->internal_name());
+               signal->save_settings(settings);
+               settings.endGroup();
+       }
+}
+
+void View::restore_settings(QSettings &settings)
+{
+       // Note: It is assumed that this function is only called once,
+       // immediately after restoring a previous session.
+
+       if (settings.contains("scale"))
+               set_scale(settings.value("scale").toDouble());
+
+       if (settings.contains("offset")) {
+               util::Timestamp offset;
+               std::stringstream ss;
+               ss << settings.value("offset").toString().toStdString();
+
+               boost::archive::text_iarchive ia(ss);
+               ia >> boost::serialization::make_nvp("offset", offset);
+
+               set_offset(offset);
+       }
+
+       for (shared_ptr<Signal> signal : signals_) {
+               settings.beginGroup(signal->base()->internal_name());
+               signal->restore_settings(settings);
+               settings.endGroup();
+       }
+
+       if (settings.contains("v_offset")) {
+               saved_v_offset_ = settings.value("v_offset").toInt();
+               set_v_offset(saved_v_offset_);
+               scroll_needs_defaults_ = false;
+               // Note: see resizeEvent() for additional information
+       }
+}
+
 vector< shared_ptr<TimeItem> > View::time_items() const
 {
        const vector<shared_ptr<Flag>> f(flags());
@@ -287,12 +376,12 @@ void View::set_offset(const pv::util::Timestamp& offset)
 
 int View::owner_visual_v_offset() const
 {
-       return -verticalScrollBar()->sliderPosition();
+       return -scrollarea_.verticalScrollBar()->sliderPosition();
 }
 
 void View::set_v_offset(int offset)
 {
-       verticalScrollBar()->setSliderPosition(offset);
+       scrollarea_.verticalScrollBar()->setSliderPosition(offset);
        header_->update();
        viewport_->update();
 }
@@ -478,6 +567,11 @@ void View::enable_sticky_scrolling(bool state)
        sticky_scrolling_ = state;
 }
 
+void View::toggle_sticky_scrolling()
+{
+       sticky_scrolling_ = !sticky_scrolling_;
+}
+
 void View::enable_coloured_bg(bool state)
 {
        const vector<shared_ptr<TraceTreeItem>> items(
@@ -533,8 +627,8 @@ std::shared_ptr<CursorPair> View::cursors() const
 
 void View::add_flag(const Timestamp& time)
 {
-       flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
-               QString("%1").arg(next_flag_text_))));
+       flags_.push_back(make_shared<Flag>(*this, time,
+               QString("%1").arg(next_flag_text_)));
 
        next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
                (next_flag_text_ + 1);
@@ -582,7 +676,7 @@ void View::restack_all_trace_tree_items()
                o->restack_items();
 
        // Re-assign background colors
-       bool next_bgcolour_state = 0;
+       bool next_bgcolour_state = false;
 
        for (auto &o : sorted_owners)
                next_bgcolour_state = o->reassign_bgcolour_states(next_bgcolour_state);
@@ -594,8 +688,7 @@ void View::restack_all_trace_tree_items()
 
 void View::trigger_event(util::Timestamp location)
 {
-       trigger_markers_.push_back(shared_ptr<TriggerMarker>(
-               new TriggerMarker(*this, location)));
+       trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
 }
 
 void View::get_scroll_layout(double &length, Timestamp &offset) const
@@ -687,6 +780,8 @@ void View::calculate_tick_spacing()
 void View::update_scroll()
 {
        assert(viewport_);
+       QScrollBar *hscrollbar = scrollarea_.horizontalScrollBar();
+       QScrollBar *vscrollbar = scrollarea_.verticalScrollBar();
 
        const QSize areaSize = viewport_->size();
 
@@ -698,40 +793,40 @@ void View::update_scroll()
 
        int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
 
-       horizontalScrollBar()->setPageStep(areaSize.width() / 2);
-       horizontalScrollBar()->setSingleStep(major_tick_distance);
+       hscrollbar->setPageStep(areaSize.width() / 2);
+       hscrollbar->setSingleStep(major_tick_distance);
 
        updating_scroll_ = true;
 
        if (length < MaxScrollValue) {
-               horizontalScrollBar()->setRange(0, length);
-               horizontalScrollBar()->setSliderPosition(offset.convert_to<double>());
+               hscrollbar->setRange(0, length);
+               hscrollbar->setSliderPosition(offset.convert_to<double>());
        } else {
-               horizontalScrollBar()->setRange(0, MaxScrollValue);
-               horizontalScrollBar()->setSliderPosition(
+               hscrollbar->setRange(0, MaxScrollValue);
+               hscrollbar->setSliderPosition(
                        (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
        }
 
        updating_scroll_ = false;
 
        // Set the vertical scrollbar
-       verticalScrollBar()->setPageStep(areaSize.height());
-       verticalScrollBar()->setSingleStep(areaSize.height() / 8);
+       vscrollbar->setPageStep(areaSize.height());
+       vscrollbar->setSingleStep(areaSize.height() / 8);
 
        const pair<int, int> extents = v_extents();
 
        // Don't change the scrollbar range if there are no traces
        if (extents.first != extents.second)
-               verticalScrollBar()->setRange(extents.first - areaSize.height(),
+               vscrollbar->setRange(extents.first - areaSize.height(),
                        extents.second);
 
-       if (scroll_needs_defaults)
+       if (scroll_needs_defaults_)
                set_scroll_default();
 }
 
 void View::reset_scroll()
 {
-       verticalScrollBar()->setRange(0, 0);
+       scrollarea_.verticalScrollBar()->setRange(0, 0);
 }
 
 void View::set_scroll_default()
@@ -740,15 +835,6 @@ void View::set_scroll_default()
 
        const QSize areaSize = viewport_->size();
 
-       // Special case: when starting up and the window isn't visible yet,
-       // areaSize is [0, 0]. In this case we want to be called again later
-       if (areaSize.height() == 0) {
-               scroll_needs_defaults = true;
-               return;
-       } else {
-               scroll_needs_defaults = false;
-       }
-
        const pair<int, int> extents = v_extents();
        const int trace_height = extents.second - extents.first;
 
@@ -760,12 +846,17 @@ void View::set_scroll_default()
        else
                // Put the first trace at the top, letting the bottom ones overflow
                set_v_offset(extents.first);
+
+       // If we're not sure whether setting the defaults worked as
+       // the window wasn't set up entirely yet, we want to be called
+       // again later to make sure
+       scroll_needs_defaults_ = !size_finalized_;
 }
 
 void View::update_layout()
 {
-       setViewportMargins(
-               header_->sizeHint().width() - pv::view::Header::BaselineOffset,
+       scrollarea_.setViewportMargins(
+               header_->sizeHint().width() - Header::BaselineOffset,
                ruler_->sizeHint().height(), 0, 0);
        ruler_->setGeometry(viewport_->x(), 0,
                viewport_->width(), ruler_->extended_size_hint().height());
@@ -880,27 +971,30 @@ bool View::eventFilter(QObject *object, QEvent *event)
        return QObject::eventFilter(object, event);
 }
 
-bool View::viewportEvent(QEvent *event)
-{
-       switch (event->type()) {
-       case QEvent::Paint:
-       case QEvent::MouseButtonPress:
-       case QEvent::MouseButtonRelease:
-       case QEvent::MouseButtonDblClick:
-       case QEvent::MouseMove:
-       case QEvent::Wheel:
-       case QEvent::TouchBegin:
-       case QEvent::TouchUpdate:
-       case QEvent::TouchEnd:
-               return false;
-       default:
-               return QAbstractScrollArea::viewportEvent(event);
-       }
-}
-
 void View::resizeEvent(QResizeEvent*)
 {
        update_layout();
+
+       // This is somewhat of a hack, unfortunately. We cannot use
+       // set_v_offset() from within restore_settings() as the view
+       // at that point is neither visible nor properly sized.
+       // This is the least intrusive workaround I could come up
+       // with: set the vertical offset (or scroll defaults) when
+       // the view is visible and resized to its final size.
+       // Resize events that are sent when the view is not visible
+       // must be ignored as they have wrong sizes, potentially
+       // preventing the v offset from being set successfully.
+
+       if (isVisible())
+               size_finalized_ = true;
+
+       if (size_finalized_ && saved_v_offset_) {
+               set_v_offset(saved_v_offset_);
+               saved_v_offset_ = 0;
+       }
+
+       if (size_finalized_ && scroll_needs_defaults_)
+               set_scroll_default();
 }
 
 void View::row_item_appearance_changed(bool label, bool content)
@@ -939,7 +1033,7 @@ void View::h_scroll_value_changed(int value)
                sticky_scrolling_changed(false);
        }
 
-       const int range = horizontalScrollBar()->maximum();
+       const int range = scrollarea_.horizontalScrollBar()->maximum();
        if (range < MaxScrollValue)
                set_offset(scale_ * value);
        else {
@@ -969,7 +1063,8 @@ void View::signals_changed()
        // Do we need to set the vertical scrollbar to its default position later?
        // We do if there are no traces, i.e. the scroll bar has no range set
        bool reset_scrollbar =
-               verticalScrollBar()->minimum() == verticalScrollBar()->maximum();
+               (scrollarea_.verticalScrollBar()->minimum() ==
+                       scrollarea_.verticalScrollBar()->maximum());
 
        if (!session_.device()) {
                reset_scroll();
@@ -1105,11 +1200,11 @@ void View::signals_changed()
                }
 
        // Add and position the pending top levels items
+       int offset = v_extents().second;
        for (auto item : new_top_level_items) {
                add_child_item(item);
 
                // Position the item after the last item or at the top if there is none
-               int offset = v_extents().second;
                const pair<int, int> extents = item->v_extents();
 
                if (item->enabled())
@@ -1136,6 +1231,16 @@ void View::capture_state_updated(int state)
                set_time_unit(util::TimeUnit::Samples);
 
                trigger_markers_.clear();
+
+               // Activate "always zoom to fit" if the setting is enabled and we're
+               // the main view of this session (other trace views may be used for
+               // zooming and we don't want to mess them up)
+               GlobalSettings settings;
+               bool state = settings.value(GlobalSettings::Key_View_AlwaysZoomToFit).toBool();
+               if (is_main_view_ && state) {
+                       always_zoom_to_fit_ = true;
+                       always_zoom_to_fit_changed(always_zoom_to_fit_);
+               }
        }
 
        if (state == Session::Stopped) {
@@ -1145,8 +1250,10 @@ void View::capture_state_updated(int state)
 
                // Reset "always zoom to fit", the acquisition has stopped
                if (always_zoom_to_fit_) {
+                       // Perform a final zoom-to-fit before disabling
+                       zoom_fit(always_zoom_to_fit_);
                        always_zoom_to_fit_ = false;
-                       always_zoom_to_fit_changed(false);
+                       always_zoom_to_fit_changed(always_zoom_to_fit_);
                }
        }
 }
@@ -1166,10 +1273,9 @@ void View::data_updated()
 
 void View::perform_delayed_view_update()
 {
-       if (always_zoom_to_fit_)
+       if (always_zoom_to_fit_) {
                zoom_fit(true);
-
-       if (sticky_scrolling_) {
+       } else if (sticky_scrolling_) {
                // Make right side of the view sticky
                double length = 0;
                Timestamp offset;
@@ -1208,5 +1314,6 @@ void View::on_hover_point_changed()
                r->hover_point_changed();
 }
 
-} // namespace view
+} // namespace TraceView
+} // namespace views
 } // namespace pv