]> sigrok.org Git - pulseview.git/blobdiff - pv/view/view.cpp
View: Update signals without destroying layout
[pulseview.git] / pv / view / view.cpp
index aac6333addd032c0adb85886c60f2fdf9b48a248..2ae0a7144cba4b9b15abbc34f3e9265e14f43250 100644 (file)
 
 #include <extdef.h>
 
+#include <algorithm>
 #include <cassert>
 #include <climits>
 #include <cmath>
+#include <iterator>
 #include <mutex>
 #include <unordered_set>
 
@@ -36,9 +38,8 @@
 #include <QMouseEvent>
 #include <QScrollBar>
 
-#include <libsigrok/libsigrok.hpp>
+#include <libsigrokcxx/libsigrokcxx.hpp>
 
-#include "cursorheader.hpp"
 #include "decodetrace.hpp"
 #include "header.hpp"
 #include "logicsignal.hpp"
 #include "viewport.hpp"
 
 #include "pv/session.hpp"
+#include "pv/devices/device.hpp"
 #include "pv/data/logic.hpp"
-#include "pv/data/logicsnapshot.hpp"
+#include "pv/data/logicsegment.hpp"
 #include "pv/util.hpp"
 
 using boost::shared_lock;
 using boost::shared_mutex;
 
 using pv::data::SignalData;
-using pv::data::Snapshot;
+using pv::data::Segment;
 using pv::util::format_time;
 
-using std::back_inserter;
 using std::deque;
 using std::dynamic_pointer_cast;
+using std::inserter;
 using std::list;
 using std::lock_guard;
 using std::max;
@@ -70,6 +72,7 @@ using std::make_pair;
 using std::min;
 using std::pair;
 using std::set;
+using std::set_difference;
 using std::shared_ptr;
 using std::unordered_map;
 using std::unordered_set;
@@ -86,31 +89,26 @@ const int View::MaxScrollValue = INT_MAX / 2;
 
 const int View::ScaleUnits[3] = {1, 2, 5};
 
-const QColor View::CursorAreaColour(220, 231, 243);
-
-const QSizeF View::LabelPadding(4, 0);
-
 View::View(Session &session, QWidget *parent) :
        QAbstractScrollArea(parent),
        session_(session),
        viewport_(new Viewport(*this)),
        ruler_(new Ruler(*this)),
-       cursorheader_(new CursorHeader(*this)),
        header_(new Header(*this)),
-       scale_(1e-6),
+       scale_(1e-3),
        offset_(0),
-       v_offset_(0),
        updating_scroll_(false),
        tick_period_(0.0),
        tick_prefix_(0),
        show_cursors_(false),
-       cursors_(*this),
+       cursors_(new CursorPair(*this)),
+       next_flag_text_('A'),
        hover_point_(-1, -1)
 {
        connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
                this, SLOT(h_scroll_value_changed(int)));
        connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
-               this, SLOT(v_scroll_value_changed(int)));
+               this, SLOT(v_scroll_value_changed()));
 
        connect(&session_, SIGNAL(signals_changed()),
                this, SLOT(signals_changed()));
@@ -121,22 +119,14 @@ View::View(Session &session, QWidget *parent) :
        connect(&session_, SIGNAL(frame_ended()),
                this, SLOT(data_updated()));
 
-       connect(cursors_.first().get(), SIGNAL(time_changed()),
-               this, SLOT(marker_time_changed()));
-       connect(cursors_.second().get(), SIGNAL(time_changed()),
-               this, SLOT(marker_time_changed()));
-
-       connect(header_, SIGNAL(signals_moved()),
-               this, SLOT(on_signals_moved()));
-
        connect(header_, SIGNAL(selection_changed()),
-               cursorheader_, SLOT(clear_selection()));
-       connect(cursorheader_, SIGNAL(selection_changed()),
+               ruler_, SLOT(clear_selection()));
+       connect(ruler_, SIGNAL(selection_changed()),
                header_, SLOT(clear_selection()));
 
        connect(header_, SIGNAL(selection_changed()),
                this, SIGNAL(selection_changed()));
-       connect(cursorheader_, SIGNAL(selection_changed()),
+       connect(ruler_, SIGNAL(selection_changed()),
                this, SIGNAL(selection_changed()));
 
        connect(this, SIGNAL(hover_point_changed()),
@@ -150,7 +140,6 @@ View::View(Session &session, QWidget *parent) :
 
        viewport_->installEventFilter(this);
        ruler_->installEventFilter(this);
-       cursorheader_->installEventFilter(this);
        header_->installEventFilter(this);
 
        // Trigger the initial event manually. The default device has signals
@@ -158,7 +147,7 @@ View::View(Session &session, QWidget *parent) :
        signals_changed();
 
        // make sure the transparent widgets are on the top
-       cursorheader_->raise();
+       ruler_->raise();
        header_->raise();
 
        // Update the zoom state
@@ -195,6 +184,16 @@ const Viewport* View::viewport() const
        return viewport_;
 }
 
+vector< shared_ptr<TimeItem> > View::time_items() const
+{
+       const vector<shared_ptr<Flag>> f(flags());
+       vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
+       items.push_back(cursors_);
+       items.push_back(cursors_->first());
+       items.push_back(cursors_->second());
+       return items;
+}
+
 double View::scale() const
 {
        return scale_;
@@ -207,7 +206,14 @@ double View::offset() const
 
 int View::owner_visual_v_offset() const
 {
-       return -v_offset_;
+       return -verticalScrollBar()->sliderPosition();
+}
+
+void View::set_v_offset(int offset)
+{
+       verticalScrollBar()->setSliderPosition(offset);
+       header_->update();
+       viewport_->update();
 }
 
 unsigned int View::depth() const
@@ -263,7 +269,10 @@ void View::zoom_one_to_one()
        double samplerate = 0.0;
        for (const shared_ptr<SignalData> d : visible_data) {
                assert(d);
-               samplerate = max(samplerate, d->samplerate());
+               const vector< shared_ptr<Segment> > segments =
+                       d->segments();
+               for (const shared_ptr<Segment> &s : segments)
+                       samplerate = max(samplerate, s->samplerate());
        }
 
        if (samplerate == 0.0)
@@ -286,7 +295,6 @@ void View::set_scale_offset(double scale, double offset)
 
        update_scroll();
        ruler_->update();
-       cursorheader_->update();
        viewport_->update();
        scale_offset_changed();
 }
@@ -294,7 +302,7 @@ void View::set_scale_offset(double scale, double offset)
 set< shared_ptr<SignalData> > View::get_visible_data() const
 {
        shared_lock<shared_mutex> lock(session().signals_mutex());
-       const vector< shared_ptr<Signal> > &sigs(session().signals());
+       const unordered_set< shared_ptr<Signal> > &sigs(session().signals());
 
        // Make a set of all the visible data objects
        set< shared_ptr<SignalData> > visible_data;
@@ -311,16 +319,16 @@ pair<double, double> View::get_time_extents() const
        const set< shared_ptr<SignalData> > visible_data = get_visible_data();
        for (const shared_ptr<SignalData> d : visible_data)
        {
-               double samplerate = d->samplerate();
-               samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
+               const vector< shared_ptr<Segment> > segments =
+                       d->segments();
+               for (const shared_ptr<Segment> &s : segments) {
+                       double samplerate = s->samplerate();
+                       samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 
-               const vector< shared_ptr<Snapshot> > snapshots =
-                       d->snapshots();
-               for (const shared_ptr<Snapshot> &s : snapshots) {
                        const double start_time = s->start_time();
                        left_time = min(left_time, start_time);
                        right_time = max(right_time, start_time +
-                               d->get_max_sample_count() / samplerate);
+                               d->max_sample_count() / samplerate);
                }
        }
 
@@ -339,27 +347,48 @@ bool View::cursors_shown() const
 void View::show_cursors(bool show)
 {
        show_cursors_ = show;
-       cursorheader_->update();
+       ruler_->update();
        viewport_->update();
 }
 
 void View::centre_cursors()
 {
        const double time_width = scale_ * viewport_->width();
-       cursors_.first()->set_time(offset_ + time_width * 0.4);
-       cursors_.second()->set_time(offset_ + time_width * 0.6);
-       cursorheader_->update();
+       cursors_->first()->set_time(offset_ + time_width * 0.4);
+       cursors_->second()->set_time(offset_ + time_width * 0.6);
+       ruler_->update();
        viewport_->update();
 }
 
-CursorPair& View::cursors()
+std::shared_ptr<CursorPair> View::cursors() const
 {
        return cursors_;
 }
 
-const CursorPair& View::cursors() const
+void View::add_flag(double time)
 {
-       return cursors_;
+       flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
+               QString("%1").arg(next_flag_text_))));
+       next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
+               (next_flag_text_ + 1);
+       time_item_appearance_changed(true, true);
+}
+
+void View::remove_flag(std::shared_ptr<Flag> flag)
+{
+       flags_.remove(flag);
+       time_item_appearance_changed(true, true);
+}
+
+vector< std::shared_ptr<Flag> > View::flags() const
+{
+       vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
+       stable_sort(flags.begin(), flags.end(),
+               [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
+                       return a->time() < b->time();
+               });
+
+       return flags;
 }
 
 const QPoint& View::hover_point() const
@@ -376,12 +405,8 @@ void View::update_viewport()
 
 void View::restack_all_row_items()
 {
-       // Make a set of owners
-       unordered_set< RowItemOwner* > owners;
-       for (const auto &r : *this)
-               owners.insert(r->owner());
-
-       // Make a list that is sorted from deepest first
+       // Make a list of owners that is sorted from deepest first
+       const auto owners = list_row_item_owners();
        vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
        sort(sorted_owners.begin(), sorted_owners.end(),
                [](const RowItemOwner* a, const RowItemOwner *b) {
@@ -476,11 +501,11 @@ void View::update_scroll()
 
        // Set the vertical scrollbar
        verticalScrollBar()->setPageStep(areaSize.height());
+       verticalScrollBar()->setSingleStep(areaSize.height() / 8);
 
        const pair<int, int> extents = v_extents();
-       const int extra_scroll_height = (extents.second - extents.first) / 4;
-       verticalScrollBar()->setRange(extents.first - extra_scroll_height,
-               extents.first + extra_scroll_height);
+       verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
+               extents.second - (areaSize.height() / 2));
 }
 
 void View::update_layout()
@@ -489,66 +514,86 @@ void View::update_layout()
                header_->sizeHint().width() - pv::view::Header::BaselineOffset,
                ruler_->sizeHint().height(), 0, 0);
        ruler_->setGeometry(viewport_->x(), 0,
-               viewport_->width(), viewport_->y());
-       cursorheader_->setGeometry(
-               viewport_->x(),
-               ruler_->sizeHint().height() - cursorheader_->sizeHint().height() / 2,
-               viewport_->width(), cursorheader_->sizeHint().height());
+               viewport_->width(), ruler_->extended_size_hint().height());
        header_->setGeometry(0, viewport_->y(),
-               header_->sizeHint().width(), viewport_->height());
+               header_->extended_size_hint().width(), viewport_->height());
        update_scroll();
 }
 
-void View::paint_label(QPainter &p, int right, bool hover)
+void View::paint_label(QPainter &p, const QRect &rect, bool hover)
 {
        (void)p;
-       (void)right;
+       (void)rect;
        (void)hover;
 }
 
-QRectF View::label_rect(int right)
+QRectF View::label_rect(const QRectF &rect)
 {
-       (void)right;
+       (void)rect;
        return QRectF();
 }
 
-bool View::add_channels_to_owner(
-       const vector< shared_ptr<sigrok::Channel> > &channels,
-       RowItemOwner *owner, int &offset,
-       unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
-               &signal_map,
-       std::function<bool (shared_ptr<RowItem>)> filter_func)
+RowItemOwner* View::find_prevalent_trace_group(
+       const shared_ptr<sigrok::ChannelGroup> &group,
+       const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
+               &signal_map)
 {
-       bool any_added = false;
+       assert(group);
 
-       assert(owner);
+       unordered_set<RowItemOwner*> owners;
+       vector<RowItemOwner*> owner_list;
 
-       for (const auto &channel : channels)
-       {
+       // Make a set and a list of all the owners
+       for (const auto &channel : group->channels()) {
                const auto iter = signal_map.find(channel);
-               if (iter == signal_map.end() ||
-                       (filter_func && !filter_func((*iter).second)))
+               if (iter == signal_map.end())
                        continue;
 
-               shared_ptr<RowItem> row_item = (*iter).second;
-               owner->add_child_item(row_item);
-               apply_offset(row_item, offset);
-               signal_map.erase(iter);
+               RowItemOwner *const o = (*iter).second->owner();
+               owner_list.push_back(o);
+               owners.insert(o);
+       }
 
-               any_added = true;
+       // Iterate through the list of owners, and find the most prevalent
+       size_t max_prevalence = 0;
+       RowItemOwner *prevalent_owner = nullptr;
+       for (RowItemOwner *owner : owners) {
+               const size_t prevalence = std::count_if(
+                       owner_list.begin(), owner_list.end(),
+                       [&](RowItemOwner *o) { return o == owner; });
+               if (prevalence > max_prevalence) {
+                       max_prevalence = prevalence;
+                       prevalent_owner = owner;
+               }
        }
 
-       return any_added;
+       return prevalent_owner;
 }
 
-void View::apply_offset(shared_ptr<RowItem> row_item, int &offset) {
-       assert(row_item);
-       const pair<int, int> extents = row_item->v_extents();
-       if (row_item->enabled())
-               offset += -extents.first;
-       row_item->force_to_v_offset(offset);
-       if (row_item->enabled())
-               offset += extents.second;
+vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
+       const vector< shared_ptr<sigrok::Channel> > &channels,
+       const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
+               &signal_map,
+       set< shared_ptr<Trace> > &add_list)
+{
+       vector< shared_ptr<Trace> > filtered_traces;
+
+       for (const auto &channel : channels)
+       {
+               const auto map_iter = signal_map.find(channel);
+               if (map_iter == signal_map.end())
+                       continue;
+
+               shared_ptr<Trace> trace = (*map_iter).second;
+               const auto list_iter = add_list.find(trace);
+               if (list_iter == add_list.end())
+                       continue;
+
+               filtered_traces.push_back(trace);
+               add_list.erase(list_iter);
+       }
+
+       return filtered_traces;
 }
 
 bool View::eventFilter(QObject *object, QEvent *event)
@@ -559,7 +604,7 @@ bool View::eventFilter(QObject *object, QEvent *event)
                const QMouseEvent *const mouse_event = (QMouseEvent*)event;
                if (object == viewport_)
                        hover_point_ = mouse_event->pos();
-               else if (object == ruler_ || object == cursorheader_)
+               else if (object == ruler_)
                        hover_point_ = QPoint(mouse_event->x(), 0);
                else if (object == header_)
                        hover_point_ = QPoint(0, mouse_event->y());
@@ -600,7 +645,7 @@ void View::resizeEvent(QResizeEvent*)
        update_layout();
 }
 
-void View::appearance_changed(bool label, bool content)
+void View::row_item_appearance_changed(bool label, bool content)
 {
        if (label)
                header_->update();
@@ -608,11 +653,19 @@ void View::appearance_changed(bool label, bool content)
                viewport_->update();
 }
 
+void View::time_item_appearance_changed(bool label, bool content)
+{
+       if (label)
+               ruler_->update();
+       if (content)
+               viewport_->update();
+}
+
 void View::extents_changed(bool horz, bool vert)
 {
        sticky_events_ |=
-               (horz ? SelectableItemHExtentsChanged : 0) |
-               (vert ? SelectableItemVExtentsChanged : 0);
+               (horz ? RowItemHExtentsChanged : 0) |
+               (vert ? RowItemVExtentsChanged : 0);
        lazy_event_handler_.start();
 }
 
@@ -631,85 +684,139 @@ void View::h_scroll_value_changed(int value)
        }
 
        ruler_->update();
-       cursorheader_->update();
        viewport_->update();
 }
 
-void View::v_scroll_value_changed(int value)
+void View::v_scroll_value_changed()
 {
-       v_offset_ = value;
        header_->update();
        viewport_->update();
 }
 
 void View::signals_changed()
 {
-       int offset = 0;
+       vector< shared_ptr<RowItem> > new_top_level_items;
 
-       // Populate the traces
-       clear_child_items();
+       const auto device = session_.device();
+       if (!device)
+               return;
 
-       shared_ptr<sigrok::Device> device = session_.device();
-       assert(device);
+       shared_ptr<sigrok::Device> sr_dev = device->device();
+       assert(sr_dev);
 
-       // Collect a set of signals
-       unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
-               signal_map;
+       // Make a list of traces that are being added, and a list of traces
+       // that are being removed
+       const set<shared_ptr<Trace>> prev_traces = list_by_type<Trace>();
 
        shared_lock<shared_mutex> lock(session_.signals_mutex());
-       const vector< shared_ptr<Signal> > &sigs(session_.signals());
+       const unordered_set< shared_ptr<Signal> > &sigs(session_.signals());
 
+       set< shared_ptr<Trace> > traces(sigs.begin(), sigs.end());
+
+#ifdef ENABLE_DECODE
+       const vector< shared_ptr<DecodeTrace> > decode_traces(
+               session().get_decode_signals());
+       traces.insert(decode_traces.begin(), decode_traces.end());
+#endif
+
+       set< shared_ptr<Trace> > add_traces;
+       set_difference(traces.begin(), traces.end(),
+               prev_traces.begin(), prev_traces.end(),
+               inserter(add_traces, add_traces.begin()));
+
+       set< shared_ptr<Trace> > remove_traces;
+       set_difference(prev_traces.begin(), prev_traces.end(),
+               traces.begin(), traces.end(),
+               inserter(remove_traces, remove_traces.begin()));
+
+       // Make a look-up table of sigrok Channels to pulseview Signals
+       unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
+               signal_map;
        for (const shared_ptr<Signal> &sig : sigs)
                signal_map[sig->channel()] = sig;
 
        // Populate channel groups
-       for (auto entry : device->channel_groups())
+       for (auto entry : sr_dev->channel_groups())
        {
                const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
 
                if (group->channels().size() <= 1)
                        continue;
 
-               shared_ptr<TraceGroup> trace_group(new TraceGroup());
-               int child_offset = 0;
-               if (add_channels_to_owner(group->channels(),
-                       trace_group.get(), child_offset, signal_map))
-               {
-                       add_child_item(trace_group);
-                       apply_offset(trace_group, offset);
-               }
-       }
+               // Find best trace group to add to
+               RowItemOwner *owner = find_prevalent_trace_group(
+                       group, signal_map);
 
-       // Add the remaining logic channels
-       shared_ptr<TraceGroup> logic_trace_group(new TraceGroup());
-       int child_offset = 0;
+               // If there is no trace group, create one
+               shared_ptr<TraceGroup> new_trace_group;
+               if (!owner) {
+                       new_trace_group.reset(new TraceGroup());
+                       owner = new_trace_group.get();
+               }
 
-       if (add_channels_to_owner(device->channels(),
-               logic_trace_group.get(), child_offset, signal_map,
-               [](shared_ptr<RowItem> r) -> bool {
-                       return dynamic_pointer_cast<LogicSignal>(r) != nullptr;
-                       }))
+               // Extract traces for the trace group, removing them from
+               // the add list
+               const vector< shared_ptr<Trace> > new_traces_in_group =
+                       extract_new_traces_for_channels(group->channels(),
+                               signal_map, add_traces);
+
+               // Add the traces to the group
+               const pair<int, int> prev_v_extents = owner->v_extents();
+               int offset = prev_v_extents.second - prev_v_extents.first;
+               for (shared_ptr<Trace> trace : new_traces_in_group) {
+                       assert(trace);
+                       owner->add_child_item(trace);
+
+                       const pair<int, int> extents = trace->v_extents();
+                       if (trace->enabled())
+                               offset += -extents.first;
+                       trace->force_to_v_offset(offset);
+                       if (trace->enabled())
+                               offset += extents.second;
+               }
 
-       {
-               add_child_item(logic_trace_group);
-               apply_offset(logic_trace_group, offset);
+               // If this is a new group, enqueue it in the new top level
+               // items list
+               if (!new_traces_in_group.empty() && new_trace_group)
+                       new_top_level_items.push_back(new_trace_group);
        }
 
-       // Add the remaining channels
-       add_channels_to_owner(device->channels(), this, offset, signal_map);
-       assert(signal_map.empty());
+       // Enqueue the remaining channels as free ungrouped traces
+       const vector< shared_ptr<Trace> > new_top_level_signals =
+               extract_new_traces_for_channels(sr_dev->channels(),
+                       signal_map, add_traces);
+       new_top_level_items.insert(new_top_level_items.end(),
+               new_top_level_signals.begin(), new_top_level_signals.end());
+
+       // Enqueue any remaining traces i.e. decode traces
+       new_top_level_items.insert(new_top_level_items.end(),
+               add_traces.begin(), add_traces.end());
+
+       // Remove any removed traces
+       for (shared_ptr<Trace> trace : remove_traces) {
+               RowItemOwner *const owner = trace->owner();
+               assert(owner);
+               owner->remove_child_item(trace);
+       }
 
-       // Add decode signals
-#ifdef ENABLE_DECODE
-       const vector< shared_ptr<DecodeTrace> > decode_sigs(
-               session().get_decode_signals());
-       for (auto s : decode_sigs) {
-               add_child_item(s);
-               apply_offset(s, offset);
+       // Add and position the pending top levels items
+       for (auto item : new_top_level_items) {
+               add_child_item(item);
+
+               // Position the item after the last present item
+               int offset = v_extents().second;
+               const pair<int, int> extents = item->v_extents();
+               if (item->enabled())
+                       offset += -extents.first;
+               item->force_to_v_offset(offset);
+               if (item->enabled())
+                       offset += extents.second;
        }
-#endif
 
        update_layout();
+
+       header_->update();
+       viewport_->update();
 }
 
 void View::data_updated()
@@ -721,24 +828,14 @@ void View::data_updated()
        viewport_->update();
 }
 
-void View::marker_time_changed()
-{
-       cursorheader_->update();
-       viewport_->update();
-}
-
-void View::on_signals_moved()
-{
-       update_scroll();
-       signals_moved();
-}
-
 void View::process_sticky_events()
 {
-       if (sticky_events_ & SelectableItemHExtentsChanged)
+       if (sticky_events_ & RowItemHExtentsChanged)
                update_layout();
-       if (sticky_events_ & SelectableItemVExtentsChanged)
+       if (sticky_events_ & RowItemVExtentsChanged) {
                restack_all_row_items();
+               update_scroll();
+       }
 
        // Clear the sticky events
        sticky_events_ = 0;