]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/decodetrace.cpp
Implement expansion marker animation and its infrastructure
[pulseview.git] / pv / views / trace / decodetrace.cpp
index 3d8a9e4513248eab0efcfa5ec90b8e9c3381bd93..61163bc2bdca727068f7384d0c455877ef5756fe 100644 (file)
@@ -58,6 +58,8 @@ extern "C" {
 #include <pv/widgets/decodermenu.hpp>
 
 using std::abs;
+using std::find_if;
+using std::lock_guard;
 using std::make_pair;
 using std::max;
 using std::min;
@@ -84,18 +86,18 @@ namespace trace {
 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
 
-const int DecodeTrace::ArrowSize = 4;
+const int DecodeTrace::ArrowSize = 6;
 const double DecodeTrace::EndCapWidth = 5;
-const int DecodeTrace::RowTitleMargin = 10;
+const int DecodeTrace::RowTitleMargin = 7;
 const int DecodeTrace::DrawPadding = 100;
 
 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
+const unsigned int DecodeTrace::AnimationDurationInTicks = 7;
 
 DecodeTrace::DecodeTrace(pv::Session &session,
        shared_ptr<data::SignalBase> signalbase, int index) :
        Trace(signalbase),
        session_(session),
-       row_height_(0),
        max_visible_rows_(0),
        delete_mapper_(this),
        show_hide_mapper_(this)
@@ -111,6 +113,9 @@ DecodeTrace::DecodeTrace(pv::Session &session,
        QFontMetrics m(QApplication::font());
        min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
 
+       default_row_height_ = (ViewItemPaintParams::text_height() * 6) / 4;
+       annotation_height_ = (ViewItemPaintParams::text_height() * 5) / 4;
+
        // For the base color, we want to start at a very different color for
        // every decoder stack, so multiply the index with a number that is
        // rather close to 180 degrees of the color circle but not a dividend of 360
@@ -140,6 +145,14 @@ DecodeTrace::DecodeTrace(pv::Session &session,
                this, SLOT(on_delayed_trace_update()));
        delayed_trace_updater_.setSingleShot(true);
        delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
+
+       connect(&animation_timer_, SIGNAL(timeout()),
+               this, SLOT(on_animation_timer()));
+       animation_timer_.setInterval(1000 / 50);
+
+       default_marker_shape_ << QPoint(0,         -ArrowSize);
+       default_marker_shape_ << QPoint(ArrowSize,  0);
+       default_marker_shape_ << QPoint(0,          ArrowSize);
 }
 
 DecodeTrace::~DecodeTrace()
@@ -159,12 +172,16 @@ shared_ptr<data::SignalBase> DecodeTrace::base() const
 
 pair<int, int> DecodeTrace::v_extents() const
 {
-       const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
-
        // Make an empty decode trace appear symmetrical
-       const int row_count = max(1, max_visible_rows_);
+       if (max_visible_rows_ == 0)
+               return make_pair(-default_row_height_, default_row_height_);
 
-       return make_pair(-row_height, row_height * row_count);
+       unsigned int height = 0;
+       for (const RowData& r : rows_)
+               if (r.currently_visible)
+                       height += r.height;
+
+       return make_pair(-default_row_height_, height);
 }
 
 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
@@ -175,15 +192,11 @@ void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
 
 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 {
-       const int text_height = ViewItemPaintParams::text_height();
-       row_height_ = (text_height * 6) / 4;
-       const int annotation_height = (text_height * 5) / 4;
+       lock_guard<mutex> lock(row_modification_mutex_);
 
        // Set default pen to allow for text width calculation
        p.setPen(Qt::black);
 
-       // Iterate through the rows
-       int y = get_visual_y();
        pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pp.left(), pp.right());
 
        // Just because the view says we see a certain sample range it
@@ -192,36 +205,39 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
        sample_range.second = min((int64_t)sample_range.second,
                decode_signal_->get_decoded_sample_count(current_segment_, false));
 
-       const vector<Row> rows = decode_signal_->get_rows(!always_show_all_rows_);
-
-       visible_rows_.clear();
-       for (const Row& row : rows) {
-               // Cache the row title widths
-               int row_title_width;
-               try {
-                       row_title_width = row_title_widths_.at(row);
-               } catch (out_of_range&) {
-                       const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
-                               RowTitleMargin;
-                       row_title_widths_[row] = w;
-                       row_title_width = w;
+       for (RowData& r : rows_)
+               r.currently_visible = false;
+       visible_rows_ = 0;
+       int y = get_visual_y();
+
+       for (RowData& r : rows_) {
+               // If an entire decoder is hidden, we don't want to fetch annotations
+               if (!r.decode_row.decoder()->shown()) {
+                       r.currently_visible = false;
+                       continue;
                }
 
                vector<Annotation> annotations;
-               decode_signal_->get_annotation_subset(annotations, row,
+               decode_signal_->get_annotation_subset(annotations, r.decode_row,
                        current_segment_, sample_range.first, sample_range.second);
-               if (always_show_all_rows_ || !annotations.empty()) {
-                       draw_annotations(annotations, p, annotation_height, pp, y,
-                               get_row_color(row.index()), row_title_width);
-                       y += row_height_;
-                       visible_rows_.push_back(row);
+
+               // Show row if there are visible annotations or when user wants to see
+               // all rows that have annotations somewhere and this one is one of them
+               size_t ann_count = decode_signal_->get_annotation_count(r.decode_row, current_segment_);
+               r.currently_visible = !annotations.empty() || (always_show_all_rows_ && (ann_count > 0));
+
+               if (r.currently_visible) {
+                       draw_annotations(annotations, p, annotation_height_, pp, y,
+                               get_row_color(r.decode_row.index()), r.title_width);
+                       y += r.height;
+                       visible_rows_++;
                }
        }
 
-       draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
+       draw_unresolved_period(p, annotation_height_, pp.left(), pp.right());
 
-       if ((int)visible_rows_.size() > max_visible_rows_) {
-               max_visible_rows_ = (int)visible_rows_.size();
+       if (visible_rows_ > max_visible_rows_) {
+               max_visible_rows_ = visible_rows_;
 
                // Call order is important, otherwise the lazy event handler won't work
                owner_->extents_changed(false, true);
@@ -235,26 +251,29 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 
 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
 {
-       assert(row_height_);
+       unsigned int y = get_visual_y();
 
-       for (size_t i = 0; i < visible_rows_.size(); i++) {
-               const int y = i * row_height_ + get_visual_y();
+       for (const RowData& r : rows_) {
+               if (!r.currently_visible)
+                       continue;
 
                p.setPen(QPen(Qt::NoPen));
-               p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 
-               if (i != 0) {
-                       const QPointF points[] = {
-                               QPointF(pp.left(), y - ArrowSize),
-                               QPointF(pp.left() + ArrowSize, y),
-                               QPointF(pp.left(), y + ArrowSize)
-                       };
-                       p.drawPolygon(points, countof(points));
-               }
+               if (r.expand_marker_highlighted)
+                       p.setBrush(QApplication::palette().brush(QPalette::Highlight));
+               else
+                       p.setBrush(QApplication::palette().brush(QPalette::WindowText));
+
+               // Draw expansion marker
+               QPolygon marker(r.expand_marker_shape);
+               marker.translate(pp.left(), y);
+               p.drawPolygon(marker);
+
+               p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 
-               const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
-                       pp.right() - pp.left(), row_height_);
-               const QString h(visible_rows_[i].title());
+               const QRect text_rect(pp.left() + ArrowSize * 2, y - r.height / 2,
+                       pp.right() - pp.left(), r.height);
+               const QString h(r.decode_row.title());
                const int f = Qt::AlignLeft | Qt::AlignVCenter |
                        Qt::TextDontClip;
 
@@ -263,11 +282,13 @@ void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
                for (int dx = -1; dx <= 1; dx++)
                        for (int dy = -1; dy <= 1; dy++)
                                if (dx != 0 && dy != 0)
-                                       p.drawText(r.translated(dx, dy), f, h);
+                                       p.drawText(text_rect.translated(dx, dy), f, h);
 
                // Draw the text
                p.setPen(QApplication::palette().color(QPalette::WindowText));
-               p.drawText(r, f, h);
+               p.drawText(text_rect, f, h);
+
+               y += r.height;
        }
 
        if (show_hover_marker_)
@@ -377,11 +398,10 @@ QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
                        menu->addSeparator();
        }
 
-       try {
-               selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
-       } catch (out_of_range&) {
-               selected_row_ = nullptr;
-       }
+       selected_row_ = nullptr;
+       const RowData* r = get_row_at_point(click_pos);
+       if (r)
+               selected_row_ = &(r->decode_row);
 
        const View *const view = owner_->view();
        assert(view);
@@ -470,6 +490,91 @@ QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
        return menu;
 }
 
+void DecodeTrace::delete_pressed()
+{
+       on_delete();
+}
+
+void DecodeTrace::hover_point_changed(const QPoint &hp)
+{
+       Trace::hover_point_changed(hp);
+
+       assert(owner_);
+
+       RowData* hover_row = get_row_at_point(hp);
+
+       // Row expansion marker handling
+       for (RowData& r : rows_)
+               r.expand_marker_highlighted = false;
+
+       if (hover_row) {
+               int row_y = get_row_y(hover_row);
+               if ((hp.x() > 0) && (hp.x() < 2 * ArrowSize) &&
+                       (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize)))
+                       hover_row->expand_marker_highlighted = true;
+       }
+
+       // Tooltip handling
+       if (hp.x() > 0) {
+               QString ann = get_annotation_at_point(hp);
+
+               if (!ann.isEmpty()) {
+                       QFontMetrics m(QToolTip::font());
+                       const QRect text_size = m.boundingRect(QRect(), 0, ann);
+
+                       // This is OS-specific and unfortunately we can't query it, so
+                       // use an approximation to at least try to minimize the error.
+                       const int padding = default_row_height_ + 8;
+
+                       // Make sure the tool tip doesn't overlap with the mouse cursor.
+                       // If it did, the tool tip would constantly hide and re-appear.
+                       // We also push it up by one row so that it appears above the
+                       // decode trace, not below.
+                       QPoint p = hp;
+                       p.setX(hp.x() - (text_size.width() / 2) - padding);
+
+                       p.setY(get_row_y(hover_row) - default_row_height_ -
+                               text_size.height() - padding);
+
+                       const View *const view = owner_->view();
+                       assert(view);
+                       QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
+
+               } else
+                       QToolTip::hideText();
+
+       } else
+               QToolTip::hideText();
+}
+
+void DecodeTrace::mouse_left_press_event(const QMouseEvent* event)
+{
+       // Handle row expansion marker
+       for (RowData& r : rows_) {
+               if (!r.expand_marker_highlighted)
+                       continue;
+
+               unsigned int y = get_row_y(&r);
+               if ((event->x() > 0) && (event->x() <= (int)(ArrowSize + 3)) &&
+                       (event->y() > (int)(y - (default_row_height_ / 2))) &&
+                       (event->y() <= (int)(y + (default_row_height_ / 2)))) {
+
+                       if (r.expanded) {
+                               r.collapsing = true;
+                               r.expanded = false;
+                               r.anim_shape = ArrowSize;
+                       } else {
+                               r.expanding = true;
+                               r.anim_shape = 0;
+                       }
+
+                       r.animation_step = 0;
+                       r.anim_height = r.height;
+                       animation_timer_.start();
+               }
+       }
+}
+
 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
                QPainter &p, int h, const ViewItemPaintParams &pp, int y,
                QColor row_color, int row_title_width)
@@ -667,7 +772,7 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
        const int ann_start = start + cap_width;
        const int ann_end = end - cap_width;
 
-       const int real_start = max(ann_start, pp.left() + row_title_width);
+       const int real_start = max(ann_start, pp.left() + ArrowSize + row_title_width);
        const int real_end = min(ann_end, pp.right());
        const int real_width = real_end - real_start;
 
@@ -816,23 +921,40 @@ QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index)
        return color;
 }
 
-int DecodeTrace::get_row_at_point(const QPoint &point)
+unsigned int DecodeTrace::get_row_y(const RowData* row) const
 {
-       if (!row_height_)
-               return -1;
+       assert(row);
 
-       const int y = (point.y() - get_visual_y() + row_height_ / 2);
+       unsigned int y = get_visual_y();
 
-       /* Integer divison of (x-1)/x would yield 0, so we check for this. */
-       if (y < 0)
-               return -1;
+       for (const RowData& r : rows_) {
+               if (!r.currently_visible)
+                       continue;
 
-       const int row = y / row_height_;
+               if (row->decode_row == r.decode_row)
+                       break;
+               else
+                       y += r.height;
+       }
 
-       if (row >= (int)visible_rows_.size())
-               return -1;
+       return y;
+}
+
+RowData* DecodeTrace::get_row_at_point(const QPoint &point)
+{
+       int y = get_visual_y() - (default_row_height_ / 2);
+
+       for (RowData& r : rows_) {
+               if (!r.currently_visible)
+                       continue;
+
+               if ((point.y() >= y) && (point.y() < (int)(y + r.height)))
+                       return &r;
+
+               y += r.height;
+       }
 
-       return row;
+       return nullptr;
 }
 
 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
@@ -844,63 +966,23 @@ const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
 
        const pair<uint64_t, uint64_t> sample_range =
                get_view_sample_range(point.x(), point.x() + 1);
-       const int row = get_row_at_point(point);
-       if (row < 0)
+       const RowData* r = get_row_at_point(point);
+
+       if (!r)
+               return QString();
+
+       if (point.y() > (int)(get_row_y(r) + (annotation_height_ / 2)))
                return QString();
 
        vector<Annotation> annotations;
 
-       decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
+       decode_signal_->get_annotation_subset(annotations, r->decode_row,
                current_segment_, sample_range.first, sample_range.second);
 
        return (annotations.empty()) ?
                QString() : annotations[0].annotations().front();
 }
 
-void DecodeTrace::hover_point_changed(const QPoint &hp)
-{
-       Trace::hover_point_changed(hp);
-
-       assert(owner_);
-
-       const View *const view = owner_->view();
-       assert(view);
-
-       if (hp.x() == 0) {
-               QToolTip::hideText();
-               return;
-       }
-
-       QString ann = get_annotation_at_point(hp);
-
-       if (!row_height_ || ann.isEmpty()) {
-               QToolTip::hideText();
-               return;
-       }
-
-       const int hover_row = get_row_at_point(hp);
-
-       QFontMetrics m(QToolTip::font());
-       const QRect text_size = m.boundingRect(QRect(), 0, ann);
-
-       // This is OS-specific and unfortunately we can't query it, so
-       // use an approximation to at least try to minimize the error.
-       const int padding = 8;
-
-       // Make sure the tool tip doesn't overlap with the mouse cursor.
-       // If it did, the tool tip would constantly hide and re-appear.
-       // We also push it up by one row so that it appears above the
-       // decode trace, not below.
-       QPoint p = hp;
-       p.setX(hp.x() - (text_size.width() / 2) - padding);
-
-       p.setY(get_visual_y() - (row_height_ / 2) +
-               (hover_row * row_height_) -
-               row_height_ - text_size.height() - padding);
-
-       QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
-}
-
 void DecodeTrace::create_decoder_form(int index,
        shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
        QFormLayout *form)
@@ -1061,7 +1143,7 @@ void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
                        QString out_text = format;
                        out_text = out_text.replace("%s", sample_range);
                        out_text = out_text.replace("%d",
-                               quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
+                               quote + QString::fromUtf8(ann.row()->decoder()->name()) + quote);
                        out_text = out_text.replace("%c", class_name);
                        out_text = out_text.replace("%1", first_ann_text);
                        out_text = out_text.replace("%a", all_ann_text);
@@ -1079,10 +1161,64 @@ void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
        msg.exec();
 }
 
+void DecodeTrace::update_rows()
+{
+       lock_guard<mutex> lock(row_modification_mutex_);
+
+       QFontMetrics m(QApplication::font());
+
+       for (RowData& r : rows_)
+               r.exists = false;
+
+       for (const Row& decode_row : decode_signal_->get_rows()) {
+               // Find row in our list
+               auto r_it = find_if(rows_.begin(), rows_.end(),
+                       [&](RowData& r){ return r.decode_row == decode_row; });
+
+               RowData* r = nullptr;
+               if (r_it == rows_.end()) {
+                       // Row doesn't exist yet, create and append it
+                       RowData nr;
+                       nr.decode_row = decode_row;
+                       nr.height = default_row_height_;
+                       nr.expanded_height = 5*default_row_height_;
+                       nr.currently_visible = false;
+                       nr.expand_marker_highlighted = false;
+                       nr.expanding = false;
+                       nr.expanded = false;
+                       nr.collapsing = false;
+                       nr.expand_marker_shape = default_marker_shape_;
+
+                       rows_.push_back(nr);
+                       r = &rows_.back();
+               } else
+                       r = &(*r_it);
+
+               r->exists = true;
+
+               const int w = m.boundingRect(r->decode_row.title()).width() + RowTitleMargin;
+               r->title_width = w;
+       }
+
+       // Remove any rows that no longer exist, obeying that iterators are invalidated
+       bool any_exists;
+       do {
+               any_exists = false;
+
+               for (unsigned int i = 0; i < rows_.size(); i++)
+                       if (!rows_[i].exists) {
+                               rows_.erase(rows_.begin() + i);
+                               any_exists = true;
+                               break;
+                       }
+       } while (any_exists);
+}
+
 void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
 {
+       Trace::on_setting_changed(key, value);
+
        if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
-               visible_rows_.clear();
                max_visible_rows_ = 0;
                always_show_all_rows_ = value.toBool();
        }
@@ -1102,8 +1238,8 @@ void DecodeTrace::on_delayed_trace_update()
 
 void DecodeTrace::on_decode_reset()
 {
-       visible_rows_.clear();
        max_visible_rows_ = 0;
+       update_rows();
 
        if (owner_)
                owner_->row_item_appearance_changed(false, true);
@@ -1123,11 +1259,6 @@ void DecodeTrace::on_pause_decode()
                decode_signal_->pause_decode();
 }
 
-void DecodeTrace::delete_pressed()
-{
-       on_delete();
-}
-
 void DecodeTrace::on_delete()
 {
        session_.remove_decode_signal(decode_signal_);
@@ -1169,6 +1300,7 @@ void DecodeTrace::on_init_state_changed(int)
 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
 {
        decode_signal_->stack_decoder(decoder);
+       update_rows();
 
        create_popup_form();
 }
@@ -1176,12 +1308,12 @@ void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
 void DecodeTrace::on_delete_decoder(int index)
 {
        decode_signal_->remove_decoder(index);
+       update_rows();
 
-       // Force re-calculation of the trace height, see paint_mid()
+       // Force re-calculation of the trace height
        max_visible_rows_ = 0;
        owner_->extents_changed(false, true);
 
-       // Update the popup
        create_popup_form();
 }
 
@@ -1217,7 +1349,7 @@ void DecodeTrace::on_copy_annotation_to_clipboard()
        if (annotations->empty())
                return;
 
-       QClipboard *clipboard = QGuiApplication::clipboard();
+       QClipboard *clipboard = QApplication::clipboard();
        clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard);
 
        if (clipboard->supportsSelection())
@@ -1324,6 +1456,59 @@ void DecodeTrace::on_export_all_rows_from_here()
        delete annotations;
 }
 
+void DecodeTrace::on_animation_timer()
+{
+       bool animation_finished = true;
+
+       for (RowData& r : rows_) {
+               if (!(r.expanding || r.collapsing))
+                       continue;
+
+               unsigned int height_delta = r.expanded_height - default_row_height_;
+
+               if (r.expanding) {
+                       if (r.height < r.expanded_height) {
+                               r.anim_height += height_delta / (float)AnimationDurationInTicks;
+                               r.height = r.anim_height;
+                               r.anim_shape += ArrowSize / (float)AnimationDurationInTicks;
+                               animation_finished = false;
+                       } else {
+                               r.height = std::min(r.height, r.expanded_height);
+                               r.expanding = false;
+                               r.expanded = true;
+                       }
+               }
+
+               if (r.collapsing) {
+                       if (r.height > default_row_height_) {
+                               r.anim_height -= height_delta / (float)AnimationDurationInTicks;
+                               r.height = r.anim_height;
+                               r.anim_shape -= ArrowSize / (float)AnimationDurationInTicks;
+                               animation_finished = false;
+                       } else {
+                               r.height = std::max(r.height, default_row_height_);
+                               r.collapsing = false;
+                               r.expanded = false;
+                               r.expand_marker_shape = default_marker_shape_;
+                       }
+               }
+
+               // The expansion marker shape switches between
+               // 0/-A, A/0,  0/A (default state; anim_shape=0) and
+               // 0/ 0, A/A, 2A/0 (expanded state; anim_shape=ArrowSize)
+
+               r.expand_marker_shape.setPoint(0, 0, -ArrowSize + r.anim_shape);
+               r.expand_marker_shape.setPoint(1, ArrowSize, r.anim_shape);
+               r.expand_marker_shape.setPoint(2, 2*r.anim_shape, ArrowSize - r.anim_shape);
+       }
+
+       if (animation_finished)
+               animation_timer_.stop();
+
+       if (owner_)
+               owner_->row_item_appearance_changed(false, true);
+}
+
 } // namespace trace
 } // namespace views
 } // namespace pv