]> sigrok.org Git - pulseview.git/blobdiff - pv/view/decodetrace.cpp
DecodeTrace: Let the view know when we need more space
[pulseview.git] / pv / view / decodetrace.cpp
index dd39b321b9d789208d1e341dec55260e67efd181..c2369e866fbe3b7286c602adc41735ed1c6a579b 100644 (file)
@@ -44,6 +44,7 @@ extern "C" {
 #include "decodetrace.hpp"
 
 #include <pv/session.hpp>
+#include <pv/strnatcmp.hpp>
 #include <pv/data/decoderstack.hpp>
 #include <pv/data/decode/decoder.hpp>
 #include <pv/data/logic.hpp>
@@ -86,6 +87,7 @@ const QColor DecodeTrace::NoDecodeColour = QColor(0x88, 0x8A, 0x85);
 
 const int DecodeTrace::ArrowSize = 4;
 const double DecodeTrace::EndCapWidth = 5;
+const int DecodeTrace::RowTitleMargin = 10;
 const int DecodeTrace::DrawPadding = 100;
 
 const QColor DecodeTrace::Colours[16] = {
@@ -133,11 +135,16 @@ DecodeTrace::DecodeTrace(pv::Session &session,
        session_(session),
        decoder_stack_(decoder_stack),
        row_height_(0),
+       max_visible_rows_(0),
        delete_mapper_(this),
        show_hide_mapper_(this)
 {
        assert(decoder_stack_);
 
+       // Determine shortest string we want to see displayed in full
+       QFontMetrics m(QApplication::font());
+       min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
+
        set_colour(DecodeColours[index % countof(DecodeColours)]);
 
        connect(decoder_stack_.get(), SIGNAL(new_decode_data()),
@@ -161,9 +168,11 @@ const std::shared_ptr<pv::data::DecoderStack>& DecodeTrace::decoder() const
 pair<int, int> DecodeTrace::v_extents() const
 {
        const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
-       const int rows = visible_rows_.size();
 
-       return make_pair(-row_height, row_height * rows);
+       // Make an empty decode trace appear symmetrical
+       const int row_count = max(1, max_visible_rows_);
+
+       return make_pair(-row_height, row_height * row_count);
 }
 
 void DecodeTrace::paint_back(QPainter &p, const ViewItemPaintParams &pp)
@@ -189,6 +198,9 @@ void DecodeTrace::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
                return;
        }
 
+       // 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_sample_range(
@@ -198,9 +210,19 @@ void DecodeTrace::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
        const vector<Row> rows(decoder_stack_->get_visible_rows());
 
        visible_rows_.clear();
-       for (size_t i = 0; i < rows.size(); i++) {
-               const Row &row = rows[i];
+       for (const Row& row : rows) {
+               // Cache the row title widths
+               int row_title_width;
+               try {
+                       row_title_width = row_title_widths_.at(row);
+               } catch (std::out_of_range) {
+                       const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
+                               RowTitleMargin;
+                       row_title_widths_[row] = w;
+                       row_title_width = w;
+               }
 
+               // Determine the row's color
                size_t base_colour = 0x13579BDF;
                boost::hash_combine(base_colour, this);
                boost::hash_combine(base_colour, row.decoder());
@@ -212,16 +234,22 @@ void DecodeTrace::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
                        sample_range.first, sample_range.second);
                if (!annotations.empty()) {
                        draw_annotations(annotations, p, annotation_height, pp, y,
-                               base_colour);
+                               base_colour, row_title_width);
 
                        y += row_height_;
 
-                       visible_rows_.push_back(rows[i]);
+                       visible_rows_.push_back(row);
                }
        }
 
        // Draw the hatching
        draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
+
+       if ((int)visible_rows_.size() > max_visible_rows_)
+               owner_->extents_changed(false, true);
+
+       // Update the maximum row count if needed
+       max_visible_rows_ = std::max(max_visible_rows_, (int)visible_rows_.size());
 }
 
 void DecodeTrace::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
@@ -329,49 +357,81 @@ QMenu* DecodeTrace::create_context_menu(QWidget *parent)
 
 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
                QPainter &p, int h, const ViewItemPaintParams &pp, int y,
-               size_t base_colour)
+               size_t base_colour, int row_title_width)
 {
        using namespace pv::data::decode;
 
        vector<Annotation> a_block;
-       int prev_ann_pos = INT_MIN;
+       int p_end = INT_MIN;
 
        double samples_per_pixel, pixels_offset;
        tie(pixels_offset, samples_per_pixel) =
                get_pixels_offset_samples_per_pixel();
 
+       // Sort the annotations by start sample so that decoders
+       // can't confuse us by creating annotations out of order
+       stable_sort(annotations.begin(), annotations.end(),
+               [](const Annotation &a, const Annotation &b) {
+                       return a.start_sample() < b.start_sample(); });
+
        // Gather all annotations that form a visual "block" and draw them as such
        for (const Annotation &a : annotations) {
 
-               const int end = a.end_sample() / samples_per_pixel - pixels_offset;
-               const int delta = end - prev_ann_pos;
+               const int a_start = a.start_sample() / samples_per_pixel - pixels_offset;
+               const int a_end = a.end_sample() / samples_per_pixel - pixels_offset;
+               const int a_width = a_end - a_start;
+
+               const int delta = a_end - p_end;
 
-               // Some annotations are in reverse order, so we cannot
-               // simply check for delta > 1
-               if (abs(delta) > 1) {
-                       // Block was broken, draw it
-                       if (a_block.size() == 1)
-                               draw_annotation(a_block.front(), p, h, pp, y, base_colour);
+               bool a_is_separate = false;
+
+               // Annotation wider than the threshold for a useful label width?
+               if (a_width >= min_useful_label_width_) {
+                       for (const QString &ann_text : a.annotations()) {
+                               const int w = p.boundingRect(QRectF(), 0, ann_text).width();
+                               // Annotation wide enough to fit a label? Don't put it in a block then
+                               if (w <= a_width) {
+                                       a_is_separate = true;
+                                       break;
+                               }
+                       }
+               }
+
+               // Were the previous and this annotation more than a pixel apart?
+               if ((abs(delta) > 1) || a_is_separate) {
+                       // Block was broken, draw annotations that form the current block
+                       if (a_block.size() == 1) {
+                               draw_annotation(a_block.front(), p, h, pp, y, base_colour,
+                                       row_title_width);
+                       }
                        else
-                               if (a_block.size() > 0)
-                                       draw_annotation_block(a_block, p, h, pp, y, base_colour);
+                               draw_annotation_block(a_block, p, h, y, base_colour);
 
                        a_block.clear();
                }
 
-               a_block.push_back(a);
-               prev_ann_pos = end;
+               if (a_is_separate) {
+                       draw_annotation(a, p, h, pp, y, base_colour, row_title_width);
+                       // Next annotation must start a new block. delta will be > 1
+                       // because we set p_end to INT_MIN but that's okay since
+                       // a_block will be empty, so nothing will be drawn
+                       p_end = INT_MIN;
+               } else {
+                       a_block.push_back(a);
+                       p_end = a_end;
+               }
        }
 
        if (a_block.size() == 1)
-               draw_annotation(a_block.front(), p, h, pp, y, base_colour);
+               draw_annotation(a_block.front(), p, h, pp, y, base_colour,
+                       row_title_width);
        else
-               draw_annotation_block(a_block, p, h, pp, y, base_colour);
+               draw_annotation_block(a_block, p, h, y, base_colour);
 }
 
 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
        QPainter &p, int h, const ViewItemPaintParams &pp, int y,
-       size_t base_colour) const
+       size_t base_colour, int row_title_width) const
 {
        double samples_per_pixel, pixels_offset;
        tie(pixels_offset, samples_per_pixel) =
@@ -383,47 +443,59 @@ void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
                pixels_offset;
 
        const size_t colour = (base_colour + a.format()) % countof(Colours);
-       const QColor &fill = Colours[colour];
-       const QColor &outline = OutlineColours[colour];
+       p.setPen(OutlineColours[colour]);
+       p.setBrush(Colours[colour]);
 
        if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
                return;
 
        if (a.start_sample() == a.end_sample())
-               draw_instant(a, p, fill, outline, h, start, y);
+               draw_instant(a, p, h, start, y);
        else
-               draw_range(a, p, fill, outline, h, start, end, y);
+               draw_range(a, p, h, start, end, y, pp,
+                       row_title_width);
 }
 
-void DecodeTrace::draw_annotation_block(vector<pv::data::decode::Annotation> a,
-       QPainter &p, int h, const ViewItemPaintParams &pp, int y,
-       size_t base_colour) const
+void DecodeTrace::draw_annotation_block(
+       vector<pv::data::decode::Annotation> annotations, QPainter &p, int h,
+       int y, size_t base_colour) const
 {
+       using namespace pv::data::decode;
+
+       if (annotations.empty())
+               return;
+
        double samples_per_pixel, pixels_offset;
        tie(pixels_offset, samples_per_pixel) =
                get_pixels_offset_samples_per_pixel();
 
-       const size_t colour =
-               (base_colour + a.front().format()) % countof(Colours);
+       const double start = annotations.front().start_sample() /
+               samples_per_pixel - pixels_offset;
+       const double end = annotations.back().end_sample() /
+               samples_per_pixel - pixels_offset;
 
-       const int start = a.front().start_sample() / samples_per_pixel -
-               pixels_offset;
-       const int end = a.back().end_sample() / samples_per_pixel -
-               pixels_offset;
+       const double top = y + .5 - h / 2;
+       const double bottom = y + .5 + h / 2;
 
-       const QRectF rect(
-               std::max(pp.left(), start),
-               y - h/2 + 0.5,
-               std::min(pp.right(), end) - std::max(pp.left(), start) + 1,
-               h);
+       const size_t colour = (base_colour + annotations.front().format()) %
+               countof(Colours);
 
-       p.setPen(OutlineColours[colour]);
-       p.setBrush(Colours[colour]);
-       p.drawRect(rect);
+       // Check if all annotations are of the same type (i.e. we can use one color)
+       // or if we should use a neutral color (i.e. gray)
+       const int format = annotations.front().format();
+       const bool single_format = std::all_of(
+               annotations.begin(), annotations.end(),
+               [&](const Annotation &a) { return a.format() == format; });
+
+       p.setPen((single_format ? OutlineColours[colour] : Qt::gray));
+       p.setBrush(QBrush((single_format ? Colours[colour] : Qt::gray),
+               Qt::Dense4Pattern));
+       p.drawRoundedRect(
+               QRectF(start, top, end - start, bottom - top), h/4, h/4);
 }
 
 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
-       QColor fill, QColor outline, int h, double x, int y) const
+       int h, double x, int y) const
 {
        const QString text = a.annotations().empty() ?
                QString() : a.annotations().back();
@@ -431,8 +503,6 @@ void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &
                0.0) + h;
        const QRectF rect(x - w / 2, y - h / 2, w, h);
 
-       p.setPen(outline);
-       p.setBrush(fill);
        p.drawRoundedRect(rect, h / 2, h / 2);
 
        p.setPen(Qt::black);
@@ -440,16 +510,13 @@ void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &
 }
 
 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
-       QColor fill, QColor outline, int h, double start,
-       double end, int y) const
+       int h, double start, double end, int y, const ViewItemPaintParams &pp,
+       int row_title_width) const
 {
        const double top = y + .5 - h / 2;
        const double bottom = y + .5 + h / 2;
        const vector<QString> annotations = a.annotations();
 
-       p.setPen(outline);
-       p.setBrush(fill);
-
        // If the two ends are within 1 pixel, draw a vertical line
        if (start + 1.0 > end) {
                p.drawLine(QPointF(start, top), QPointF(start, bottom));
@@ -472,8 +539,14 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
        if (annotations.empty())
                return;
 
-       QRectF rect(start + cap_width, y - h / 2,
-               end - start - cap_width * 2, h);
+       const int ann_start = start + cap_width;
+       const int ann_end = end - cap_width;
+
+       const int real_start = std::max(ann_start, pp.left() + row_title_width);
+       const int real_end = std::min(ann_end, pp.right());
+       const int real_width = real_end - real_start;
+
+       QRectF rect(real_start, y - h / 2, real_width, h);
        if (rect.width() <= 4)
                return;
 
@@ -732,8 +805,8 @@ void DecodeTrace::create_decoder_form(int index,
                connect(combo, SIGNAL(currentIndexChanged(int)),
                        this, SLOT(on_channel_selected(int)));
                decoder_form->addRow(tr("<b>%1</b> (%2) *")
-                       .arg(QString::fromUtf8(pdch->name))
-                       .arg(QString::fromUtf8(pdch->desc)), combo);
+                       .arg(QString::fromUtf8(pdch->name),
+                            QString::fromUtf8(pdch->desc)), combo);
 
                const ChannelSelector s = {combo, dec, pdch};
                channel_selectors_.push_back(s);
@@ -747,8 +820,8 @@ void DecodeTrace::create_decoder_form(int index,
                connect(combo, SIGNAL(currentIndexChanged(int)),
                        this, SLOT(on_channel_selected(int)));
                decoder_form->addRow(tr("<b>%1</b> (%2)")
-                       .arg(QString::fromUtf8(pdch->name))
-                       .arg(QString::fromUtf8(pdch->desc)), combo);
+                       .arg(QString::fromUtf8(pdch->name),
+                            QString::fromUtf8(pdch->desc)), combo);
 
                const ChannelSelector s = {combo, dec, pdch};
                channel_selectors_.push_back(s);
@@ -776,7 +849,8 @@ QComboBox* DecodeTrace::create_channel_selector(
        vector< shared_ptr<Signal> > sig_list(sigs.begin(), sigs.end());
        std::sort(sig_list.begin(), sig_list.end(),
                [](const shared_ptr<Signal> &a, const shared_ptr<Signal> b) {
-                       return a->name().compare(b->name()) < 0; });
+                       return strnatcasecmp(a->name().toStdString(),
+                               b->name().toStdString()) < 0; });
 
        assert(decoder_stack_);
        const auto channel_iter = dec->channels().find(pdch);