]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/decodetrace.cpp
Add row colors and some fixes
[pulseview.git] / pv / views / trace / decodetrace.cpp
index a91f5e03985504a585e0f5dfe08f1c78ce47d7c2..53998b2ea7a0dc30f0728fdc9d895dd557425127 100644 (file)
@@ -82,12 +82,10 @@ namespace pv {
 namespace views {
 namespace trace {
 
-#define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
-#define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
-
 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 +95,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 +147,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)
@@ -174,11 +172,14 @@ DecodeTrace::DecodeTrace(pv::Session &session,
        // Note: The offset equals the color of the first annotation
        QColor color;
        const int h = (120 + 160 * index) % 360;
-       const int s = DECODETRACE_COLOR_SATURATION;
-       const int v = DECODETRACE_COLOR_VALUE;
+       const int s = DECODE_COLOR_SATURATION;
+       const int v = DECODE_COLOR_VALUE;
        color.setHsv(h, s, v);
        base_->set_color(color);
 
+       connect(decode_signal_.get(), SIGNAL(color_changed(QColor)),
+               this, SLOT(on_color_changed(QColor)));
+
        connect(decode_signal_.get(), SIGNAL(new_annotations()),
                this, SLOT(on_new_annotations()));
        connect(decode_signal_.get(), SIGNAL(decode_reset()),
@@ -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
@@ -760,8 +789,8 @@ void DecodeTrace::draw_annotation(const Annotation* a, QPainter &p,
        const double start = a->start_sample() / samples_per_pixel - pixels_offset;
        const double end = a->end_sample() / samples_per_pixel - pixels_offset;
 
-       p.setPen(row.ann_class_dark_color.at(a->ann_class_id()));
-       p.setBrush(row.ann_class_color.at(a->ann_class_id()));
+       p.setPen(a->dark_color());
+       p.setBrush(a->color());
 
        if ((start > (pp.right() + DrawPadding)) || (end < (pp.left() - DrawPadding)))
                return;
@@ -784,8 +813,8 @@ void DecodeTrace::draw_annotation_block(qreal start, qreal end,
        // one format that all of these annotations have. Otherwise, we should use
        // a neutral color (i.e. gray)
        if (use_ann_format) {
-               p.setPen(row.ann_class_dark_color.at(ann_class));
-               p.setBrush(QBrush(row.ann_class_color.at(ann_class), Qt::Dense4Pattern));
+               p.setPen(row.decode_row->get_dark_class_color(ann_class));
+               p.setBrush(QBrush(row.decode_row->get_class_color(ann_class), Qt::Dense4Pattern));
        } else {
                p.setPen(QColor(Qt::darkGray));
                p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
@@ -966,34 +995,6 @@ pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
        return make_pair(start, end);
 }
 
-QColor DecodeTrace::get_row_color(int row_index) const
-{
-       // For each row color, use the base color hue and add an offset that's
-       // not a dividend of 360
-
-       QColor color;
-       const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
-       const int s = DECODETRACE_COLOR_SATURATION;
-       const int v = DECODETRACE_COLOR_VALUE;
-       color.setHsl(h, s, v);
-
-       return color;
-}
-
-QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
-{
-       // For each row color, use the base color hue and add an offset that's
-       // not a dividend of 360 and not a multiple of the row offset
-
-       QColor color(row_color);
-       const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
-       const int s = DECODETRACE_COLOR_SATURATION;
-       const int v = DECODETRACE_COLOR_VALUE;
-       color.setHsl(h, s, v);
-
-       return color;
-}
-
 unsigned int DecodeTrace::get_row_y(const DecodeTraceRow* row) const
 {
        assert(row);
@@ -1191,30 +1192,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';
                }
 
@@ -1274,6 +1299,7 @@ void DecodeTrace::initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id)
 
        // Add widgets inside the header container
        QCheckBox* cb = new QCheckBox();
+       r->row_visibility_checkbox = cb;
        header_container_layout->addWidget(cb);
        cb->setText(tr("Show this row"));
        cb->setChecked(r->decode_row->visible());
@@ -1282,8 +1308,6 @@ void DecodeTrace::initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id)
        connect(cb, SIGNAL(stateChanged(int)),
                &row_show_hide_mapper_, SLOT(map()));
 
-       cb->setEnabled(false);
-
        QPushButton* btn = new QPushButton();
        header_container_layout->addWidget(btn);
        btn->setFlat(true);
@@ -1320,7 +1344,7 @@ void DecodeTrace::initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id)
 
                int dim = ViewItemPaintParams::text_height() - 2;
                QPixmap pixmap(dim, dim);
-               pixmap.fill(r->ann_class_color[ann_class->id]);
+               pixmap.fill(r->decode_row->get_class_color(ann_class->id));
                cb->setIcon(pixmap);
 
                r->selector_container->layout()->addWidget(cb);
@@ -1337,6 +1361,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_)
@@ -1353,6 +1380,7 @@ void DecodeTrace::update_rows()
                        // Row doesn't exist yet, create and append it
                        DecodeTraceRow nr;
                        nr.decode_row = decode_row;
+                       nr.decode_row->set_base_color(base_->color());
                        nr.height = default_row_height_;
                        nr.expanded_height = default_row_height_;
                        nr.currently_visible = false;
@@ -1366,16 +1394,6 @@ void DecodeTrace::update_rows()
                        nr.header_container = new QWidget(nr.container);
                        nr.selector_container = new QWidget(nr.container);
 
-                       nr.row_color = get_row_color(decode_row->index());
-
-                       vector<AnnotationClass*> ann_classes = decode_row->ann_classes();
-                       for (const AnnotationClass* ann_class : ann_classes) {
-                               nr.ann_class_color[ann_class->id] =
-                                       get_annotation_color(nr.row_color, ann_class->id);
-                               nr.ann_class_dark_color[ann_class->id] =
-                                       nr.ann_class_color[ann_class->id].darker();
-                       }
-
                        rows_.push_back(nr);
                        r = &rows_.back();
                        initialize_row_widgets(r, row_id);
@@ -1386,6 +1404,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 {
@@ -1393,6 +1415,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;
 
@@ -1420,8 +1444,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)
@@ -1434,8 +1456,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()
@@ -1465,10 +1485,17 @@ 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_color_changed(const QColor &color)
+{
+       for (DecodeTraceRow& r : rows_)
+               r.decode_row->set_base_color(color);
+
+       if (owner_)
+               owner_->row_item_appearance_changed(false, true);
 }
 
 void DecodeTrace::on_new_annotations()
@@ -1485,7 +1512,6 @@ void DecodeTrace::on_delayed_trace_update()
 
 void DecodeTrace::on_decode_reset()
 {
-       max_visible_rows_ = 0;
        update_rows();
 
        if (owner_)
@@ -1557,8 +1583,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();
@@ -1571,11 +1595,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);
 }
@@ -1585,11 +1606,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);
 }
@@ -1771,7 +1792,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
@@ -1781,7 +1802,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
@@ -1804,6 +1825,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