]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/decodetrace.cpp
Fix #1505 by always updating the DecodeTrace height when needed
[pulseview.git] / pv / views / trace / decodetrace.cpp
index 9f8b7481a6b07502468f9e337d8768a1b2bce6c9..1cc89feb67ae46af816a036b26d97e55d9a3ec87 100644 (file)
@@ -88,6 +88,7 @@ namespace trace {
 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
 const QColor DecodeTrace::ExpandMarkerWarnColor = QColor(0xFF, 0xA5, 0x00); // QColorConstants::Svg::orange
+const QColor DecodeTrace::ExpandMarkerHiddenColor = QColor(0x69, 0x69, 0x69); // QColorConstants::Svg::dimgray
 const uint8_t DecodeTrace::ExpansionAreaHeaderAlpha = 10 * 255 / 100;
 const uint8_t DecodeTrace::ExpansionAreaAlpha = 5 * 255 / 100;
 
@@ -97,8 +98,8 @@ 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;
-
+const int DecodeTrace::AnimationDurationInTicks = 7;
+const int DecodeTrace::HiddenRowHideDelay = 1000; // 1 second
 
 /**
  * Helper function for forceUpdate()
@@ -149,7 +150,7 @@ DecodeTrace::DecodeTrace(pv::Session &session,
        shared_ptr<data::SignalBase> signalbase, int index) :
        Trace(signalbase),
        session_(session),
-       max_visible_rows_(0),
+       show_hidden_rows_(false),
        delete_mapper_(this),
        show_hide_mapper_(this),
        row_show_hide_mapper_(this)
@@ -206,6 +207,11 @@ DecodeTrace::DecodeTrace(pv::Session &session,
                this, SLOT(on_animation_timer()));
        animation_timer_.setInterval(1000 / 50);
 
+       connect(&delayed_hidden_row_hider_, SIGNAL(timeout()),
+               this, SLOT(on_hide_hidden_rows()));
+       delayed_hidden_row_hider_.setSingleShot(true);
+       delayed_hidden_row_hider_.setInterval(HiddenRowHideDelay);
+
        default_marker_shape_ << QPoint(0,         -ArrowSize);
        default_marker_shape_ << QPoint(ArrowSize,  0);
        default_marker_shape_ << QPoint(0,          ArrowSize);
@@ -235,10 +241,21 @@ shared_ptr<data::SignalBase> DecodeTrace::base() const
        return base_;
 }
 
+void DecodeTrace::set_owner(TraceTreeItemOwner *owner)
+{
+       Trace::set_owner(owner);
+
+       // The owner is set in trace::View::signals_changed(), which is a slot.
+       // So after this trace was added to the view, we won't have an owner
+       // that we need to initialize in update_rows(). Once we do, we call it
+       // from on_decode_reset().
+       on_decode_reset();
+}
+
 pair<int, int> DecodeTrace::v_extents() const
 {
        // Make an empty decode trace appear symmetrical
-       if (max_visible_rows_ == 0)
+       if (visible_rows_ == 0)
                return make_pair(-default_row_height_, default_row_height_);
 
        unsigned int height = 0;
@@ -258,6 +275,7 @@ void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 {
        lock_guard<mutex> lock(row_modification_mutex_);
+       unsigned int visible_rows;
 
 #if DECODETRACE_SHOW_RENDER_TIME
        render_time_.restart();
@@ -274,14 +292,15 @@ 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));
 
-       visible_rows_ = 0;
+       visible_rows = 0;
        int y = get_visual_y();
 
        for (DecodeTraceRow& r : rows_) {
                // If the row is hidden, we don't want to fetch annotations
                assert(r.decode_row);
                assert(r.decode_row->decoder());
-               if ((!r.decode_row->decoder()->visible()) || (!r.decode_row->visible())) {
+               if ((!r.decode_row->decoder()->visible()) ||
+                       ((!r.decode_row->visible() && (!show_hidden_rows_) && (!r.expanding) && (!r.expanded) && (!r.collapsing)))) {
                        r.currently_visible = false;
                        continue;
                }
@@ -296,21 +315,21 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
                r.currently_visible = !annotations.empty();
                if (!r.currently_visible) {
                        size_t ann_count = decode_signal_->get_annotation_count(r.decode_row, current_segment_);
-                       r.currently_visible = (always_show_all_rows_ || r.has_hidden_classes) &&
-                               (ann_count > 0);
+                       r.currently_visible = ((always_show_all_rows_ || r.has_hidden_classes) &&
+                               (ann_count > 0)) || r.expanded;
                }
 
                if (r.currently_visible) {
                        draw_annotations(annotations, p, pp, y, r);
                        y += r.height;
-                       visible_rows_++;
+                       visible_rows++;
                }
        }
 
        draw_unresolved_period(p, pp.left(), pp.right());
 
-       if (visible_rows_ > max_visible_rows_) {
-               max_visible_rows_ = visible_rows_;
+       if (visible_rows != visible_rows_) {
+               visible_rows_ = visible_rows;
 
                // Call order is important, otherwise the lazy event handler won't work
                owner_->extents_changed(false, true);
@@ -340,6 +359,8 @@ void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
 
                if (r.expand_marker_highlighted)
                        p.setBrush(QApplication::palette().brush(QPalette::Highlight));
+               else if (!r.decode_row->visible())
+                       p.setBrush(ExpandMarkerHiddenColor);
                else if (r.has_hidden_classes)
                        p.setBrush(ExpandMarkerWarnColor);
                else
@@ -366,7 +387,11 @@ void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
                                        p.drawText(text_rect.translated(dx, dy), f, h);
 
                // Draw the text
-               p.setPen(QApplication::palette().color(QPalette::WindowText));
+               if (!r.decode_row->visible())
+                       p.setPen(ExpandMarkerHiddenColor);
+               else
+                       p.setPen(QApplication::palette().color(QPalette::WindowText));
+
                p.drawText(text_rect, f, h);
 
                y += r.height;
@@ -589,8 +614,12 @@ void DecodeTrace::hover_point_changed(const QPoint &hp)
        if (hover_row) {
                int row_y = get_row_y(hover_row);
                if ((hp.x() > 0) && (hp.x() < (int)(ArrowSize + 3 + hover_row->title_width)) &&
-                       (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize)))
+                       (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize))) {
+
                        hover_row->expand_marker_highlighted = true;
+                       show_hidden_rows_ = true;
+                       delayed_hidden_row_hider_.start();
+               }
        }
 
        // Tooltip handling
@@ -1191,30 +1220,54 @@ void DecodeTrace::export_annotations(deque<const Annotation*>& annotations) cons
        const QString quote = format.contains("%q") ? "\"" : "";
        format = format.remove("%q");
 
+       const bool has_sample_range   = format.contains("%s");
+       const bool has_row_name       = format.contains("%r");
+       const bool has_dec_name       = format.contains("%d");
+       const bool has_class_name     = format.contains("%c");
+       const bool has_first_ann_text = format.contains("%1");
+       const bool has_all_ann_text   = format.contains("%a");
+
        QFile file(file_name);
        if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
                QTextStream out_stream(&file);
 
                for (const Annotation* ann : annotations) {
-                       const QString sample_range = QString("%1-%2") \
-                               .arg(QString::number(ann->start_sample()), QString::number(ann->end_sample()));
+                       QString out_text = format;
 
-                       const QString row_name = quote + ann->row()->description() + quote;
+                       if (has_sample_range) {
+                               const QString sample_range = QString("%1-%2") \
+                                       .arg(QString::number(ann->start_sample()), QString::number(ann->end_sample()));
+                               out_text = out_text.replace("%s", sample_range);
+                       }
 
-                       QString all_ann_text;
-                       for (const QString &s : *(ann->annotations()))
-                               all_ann_text = all_ann_text + quote + s + quote + ",";
-                       all_ann_text.chop(1);
+                       if (has_dec_name)
+                               out_text = out_text.replace("%d",
+                                       quote + QString::fromUtf8(ann->row()->decoder()->name()) + quote);
 
-                       const QString first_ann_text = quote + ann->annotations()->front() + quote;
+                       if (has_row_name) {
+                               const QString row_name = quote + ann->row()->description() + quote;
+                               out_text = out_text.replace("%r", row_name);
+                       }
+
+                       if (has_class_name) {
+                               const QString class_name = quote + ann->ann_class_name() + quote;
+                               out_text = out_text.replace("%c", class_name);
+                       }
+
+                       if (has_first_ann_text) {
+                               const QString first_ann_text = quote + ann->annotations()->front() + quote;
+                               out_text = out_text.replace("%1", first_ann_text);
+                       }
+
+                       if (has_all_ann_text) {
+                               QString all_ann_text;
+                               for (const QString &s : *(ann->annotations()))
+                                       all_ann_text = all_ann_text + quote + s + quote + ",";
+                               all_ann_text.chop(1);
+
+                               out_text = out_text.replace("%a", all_ann_text);
+                       }
 
-                       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);
-                       out_text = out_text.replace("%r", row_name);
-                       out_text = out_text.replace("%1", first_ann_text);
-                       out_text = out_text.replace("%a", all_ann_text);
                        out_stream << out_text << '\n';
                }
 
@@ -1259,29 +1312,48 @@ void DecodeTrace::initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id)
        QVBoxLayout* vlayout = new QVBoxLayout();
        r->container->setLayout(vlayout);
 
-       // Add header container with checkbox for this row
+       // Add header container
        vlayout->addWidget(r->header_container);
        vlayout->setContentsMargins(0, 0, 0, 0);
        vlayout->setSpacing(0);
+       QHBoxLayout* header_container_layout = new QHBoxLayout();
        r->header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
        r->header_container->setMinimumSize(0, default_row_height_);
-       r->header_container->setLayout(new QVBoxLayout());
-       r->header_container->layout()->setContentsMargins(10, 2, 0, 2);
+       r->header_container->setLayout(header_container_layout);
+       r->header_container->layout()->setContentsMargins(10, 2, 10, 2);
 
        r->header_container->setAutoFillBackground(true);
        r->header_container->setPalette(header_palette);
 
+       // Add widgets inside the header container
        QCheckBox* cb = new QCheckBox();
-       r->header_container->layout()->addWidget(cb);
+       r->row_visibility_checkbox = cb;
+       header_container_layout->addWidget(cb);
        cb->setText(tr("Show this row"));
        cb->setChecked(r->decode_row->visible());
 
-       cb->setEnabled(false);
-
        row_show_hide_mapper_.setMapping(cb, row_id);
        connect(cb, SIGNAL(stateChanged(int)),
                &row_show_hide_mapper_, SLOT(map()));
 
+       QPushButton* btn = new QPushButton();
+       header_container_layout->addWidget(btn);
+       btn->setFlat(true);
+       btn->setStyleSheet(":hover { background-color: palette(button); color: palette(button-text); border:0; }");
+       btn->setText(tr("Show All"));
+       btn->setProperty("decode_trace_row_ptr", QVariant::fromValue((void*)r));
+       connect(btn, SIGNAL(clicked(bool)), this, SLOT(on_show_all_classes()));
+
+       btn = new QPushButton();
+       header_container_layout->addWidget(btn);
+       btn->setFlat(true);
+       btn->setStyleSheet(":hover { background-color: palette(button); color: palette(button-text); border:0; }");
+       btn->setText(tr("Hide All"));
+       btn->setProperty("decode_trace_row_ptr", QVariant::fromValue((void*)r));
+       connect(btn, SIGNAL(clicked(bool)), this, SLOT(on_hide_all_classes()));
+
+       header_container_layout->addStretch(); // To left-align the header widgets
+
        // Add selector container
        vlayout->addWidget(r->selector_container);
        r->selector_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
@@ -1304,6 +1376,7 @@ void DecodeTrace::initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id)
                cb->setIcon(pixmap);
 
                r->selector_container->layout()->addWidget(cb);
+               r->selectors.push_back(cb);
 
                cb->setProperty("ann_class_ptr", QVariant::fromValue((void*)ann_class));
                cb->setProperty("decode_trace_row_ptr", QVariant::fromValue((void*)r));
@@ -1316,6 +1389,9 @@ void DecodeTrace::initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id)
 
 void DecodeTrace::update_rows()
 {
+       if (!owner_)
+               return;
+
        lock_guard<mutex> lock(row_modification_mutex_);
 
        for (DecodeTraceRow& r : rows_)
@@ -1365,6 +1441,10 @@ void DecodeTrace::update_rows()
                row_id++;
        }
 
+       // If there's only one row, it must not be hidden or else it can't be un-hidden
+       if (row_id == 1)
+               rows_.front().row_visibility_checkbox->setEnabled(false);
+
        // Remove any rows that no longer exist, obeying that iterators are invalidated
        bool any_exists;
        do {
@@ -1372,6 +1452,8 @@ void DecodeTrace::update_rows()
 
                for (unsigned int i = 0; i < rows_.size(); i++)
                        if (!rows_[i].exists) {
+                               delete rows_[i].row_visibility_checkbox;
+
                                for (QCheckBox* cb : rows_[i].selectors)
                                        delete cb;
 
@@ -1399,8 +1481,6 @@ void DecodeTrace::set_row_expanded(DecodeTraceRow* r)
 
        r->container->resize(owner_->view()->viewport()->width() - r->container->pos().x(),
                r->height - 2 * default_row_height_);
-
-       max_visible_rows_ = 0;
 }
 
 void DecodeTrace::set_row_collapsed(DecodeTraceRow* r)
@@ -1413,8 +1493,6 @@ void DecodeTrace::set_row_collapsed(DecodeTraceRow* r)
 
        r->container->resize(owner_->view()->viewport()->width() - r->container->pos().x(),
                r->height - 2 * default_row_height_);
-
-       max_visible_rows_ = 0;
 }
 
 void DecodeTrace::update_expanded_rows()
@@ -1444,10 +1522,8 @@ void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
 {
        Trace::on_setting_changed(key, value);
 
-       if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
-               max_visible_rows_ = 0;
+       if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows)
                always_show_all_rows_ = value.toBool();
-       }
 }
 
 void DecodeTrace::on_new_annotations()
@@ -1464,7 +1540,6 @@ void DecodeTrace::on_delayed_trace_update()
 
 void DecodeTrace::on_decode_reset()
 {
-       max_visible_rows_ = 0;
        update_rows();
 
        if (owner_)
@@ -1536,8 +1611,6 @@ void DecodeTrace::on_delete_decoder(int index)
        decode_signal_->remove_decoder(index);
        update_rows();
 
-       // Force re-calculation of the trace height
-       max_visible_rows_ = 0;
        owner_->extents_changed(false, true);
 
        create_popup_form();
@@ -1550,11 +1623,8 @@ void DecodeTrace::on_show_hide_decoder(int index)
        assert(index < (int)decoder_forms_.size());
        decoder_forms_[index]->set_decoder_visible(state);
 
-       if (!state) {
-               // Force re-calculation of the trace height, see paint_mid()
-               max_visible_rows_ = 0;
+       if (!state)
                owner_->extents_changed(false, true);
-       }
 
        owner_->row_item_appearance_changed(false, true);
 }
@@ -1564,11 +1634,11 @@ void DecodeTrace::on_show_hide_row(int row_id)
        if (row_id >= (int)rows_.size())
                return;
 
-       set_row_collapsed(&rows_[row_id]);
        rows_[row_id].decode_row->set_visible(!rows_[row_id].decode_row->visible());
 
-       // Force re-calculation of the trace height, see paint_mid()
-       max_visible_rows_ = 0;
+       if (!rows_[row_id].decode_row->visible())
+               set_row_collapsed(&rows_[row_id]);
+
        owner_->extents_changed(false, true);
        owner_->row_item_appearance_changed(false, true);
 }
@@ -1590,6 +1660,34 @@ void DecodeTrace::on_show_hide_class(QWidget* sender)
        owner_->row_item_appearance_changed(false, true);
 }
 
+void DecodeTrace::on_show_all_classes()
+{
+       void* row_ptr = QObject::sender()->property("decode_trace_row_ptr").value<void*>();
+       assert(row_ptr);
+       DecodeTraceRow* row = (DecodeTraceRow*)row_ptr;
+
+       for (QCheckBox* cb : row->selectors)
+               cb->setChecked(true);
+
+       row->has_hidden_classes = false;
+
+       owner_->row_item_appearance_changed(false, true);
+}
+
+void DecodeTrace::on_hide_all_classes()
+{
+       void* row_ptr = QObject::sender()->property("decode_trace_row_ptr").value<void*>();
+       assert(row_ptr);
+       DecodeTraceRow* row = (DecodeTraceRow*)row_ptr;
+
+       for (QCheckBox* cb : row->selectors)
+               cb->setChecked(false);
+
+       row->has_hidden_classes = true;
+
+       owner_->row_item_appearance_changed(false, true);
+}
+
 void DecodeTrace::on_row_container_resized(QWidget* sender)
 {
        sender->update();
@@ -1722,7 +1820,7 @@ void DecodeTrace::on_animation_timer()
                if (r.expanding) {
                        if (r.height < r.expanded_height) {
                                r.anim_height += height_delta / (float)AnimationDurationInTicks;
-                               r.height = r.anim_height;
+                               r.height = min((int)r.anim_height, (int)r.expanded_height);
                                r.anim_shape += ArrowSize / (float)AnimationDurationInTicks;
                                animation_finished = false;
                        } else
@@ -1732,7 +1830,7 @@ void DecodeTrace::on_animation_timer()
                if (r.collapsing) {
                        if (r.height > default_row_height_) {
                                r.anim_height -= height_delta / (float)AnimationDurationInTicks;
-                               r.height = r.anim_height;
+                               r.height = max((int)r.anim_height, (int)0);
                                r.anim_shape -= ArrowSize / (float)AnimationDurationInTicks;
                                animation_finished = false;
                        } else
@@ -1755,6 +1853,23 @@ void DecodeTrace::on_animation_timer()
        owner_->row_item_appearance_changed(false, true);
 }
 
+void DecodeTrace::on_hide_hidden_rows()
+{
+       // Make all hidden traces invisible again unless the user is hovering over a row name
+       bool any_highlighted = false;
+
+       for (DecodeTraceRow& r : rows_)
+               if (r.expand_marker_highlighted)
+                       any_highlighted = true;
+
+       if (!any_highlighted) {
+               show_hidden_rows_ = false;
+
+               owner_->extents_changed(false, true);
+               owner_->row_item_appearance_changed(false, true);
+       }
+}
+
 } // namespace trace
 } // namespace views
 } // namespace pv