]> sigrok.org Git - pulseview.git/blobdiff - pv/view/decodetrace.cpp
DecodeTrace: Try to keep annotation labels within the view
[pulseview.git] / pv / view / decodetrace.cpp
index 0a2afbfa67f4e16474cb9330e0800f0d361ee03f..eb1f7f83d01324d1527e81ffdb890e17a2194dcd 100644 (file)
@@ -29,6 +29,8 @@ extern "C" {
 #include <tuple>
 
 #include <boost/functional/hash.hpp>
+#include <boost/thread/locks.hpp>
+#include <boost/thread/shared_mutex.hpp>
 
 #include <QAction>
 #include <QApplication>
@@ -66,6 +68,7 @@ using std::min;
 using std::pair;
 using std::shared_ptr;
 using std::tie;
+using std::unordered_set;
 using std::vector;
 
 namespace pv {
@@ -129,14 +132,14 @@ DecodeTrace::DecodeTrace(pv::Session &session,
                decoder_stack->stack().front()->decoder()->name)),
        session_(session),
        decoder_stack_(decoder_stack),
-       text_height_(0),
        row_height_(0),
+       max_visible_rows_(0),
        delete_mapper_(this),
        show_hide_mapper_(this)
 {
        assert(decoder_stack_);
 
-       colour_ = DecodeColours[index % countof(DecodeColours)];
+       set_colour(DecodeColours[index % countof(DecodeColours)]);
 
        connect(decoder_stack_.get(), SIGNAL(new_decode_data()),
                this, SLOT(on_new_decode_data()));
@@ -158,30 +161,28 @@ const std::shared_ptr<pv::data::DecoderStack>& DecodeTrace::decoder() const
 
 pair<int, int> DecodeTrace::v_extents() const
 {
-       /// @todo Replace this with an implementation that knows the true
-       /// height of the trace
-       const int row_height = (RowItemPaintParams::text_height() * 6) / 4;
-       return make_pair(-row_height / 2, row_height * 7 / 2);
+       const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
+
+       return make_pair(-row_height, row_height * max_visible_rows_);
 }
 
-void DecodeTrace::paint_back(QPainter &p, const RowItemPaintParams &pp)
+void DecodeTrace::paint_back(QPainter &p, const ViewItemPaintParams &pp)
 {
        Trace::paint_back(p, pp);
        paint_axis(p, pp, get_visual_y());
 }
 
-void DecodeTrace::paint_mid(QPainter &p, const RowItemPaintParams &pp)
+void DecodeTrace::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
 {
        using namespace pv::data::decode;
 
-       text_height_ = RowItemPaintParams::text_height();
-       row_height_ = (text_height_ * 6) / 4;
-       const int annotation_height = (text_height_ * 5) / 4;
+       const int text_height = ViewItemPaintParams::text_height();
+       row_height_ = (text_height * 6) / 4;
+       const int annotation_height = (text_height * 5) / 4;
 
        assert(decoder_stack_);
        const QString err = decoder_stack_->error_message();
-       if (!err.isEmpty())
-       {
+       if (!err.isEmpty()) {
                draw_unresolved_period(
                        p, annotation_height, pp.left(), pp.right());
                draw_error(p, err, pp);
@@ -197,8 +198,7 @@ void DecodeTrace::paint_mid(QPainter &p, const RowItemPaintParams &pp)
        const vector<Row> rows(decoder_stack_->get_visible_rows());
 
        visible_rows_.clear();
-       for (size_t i = 0; i < rows.size(); i++)
-       {
+       for (size_t i = 0; i < rows.size(); i++) {
                const Row &row = rows[i];
 
                size_t base_colour = 0x13579BDF;
@@ -211,9 +211,9 @@ void DecodeTrace::paint_mid(QPainter &p, const RowItemPaintParams &pp)
                decoder_stack_->get_annotation_subset(annotations, row,
                        sample_range.first, sample_range.second);
                if (!annotations.empty()) {
-                       for (const Annotation &a : annotations)
-                               draw_annotation(a, p, annotation_height,
-                                       pp, y, base_colour);
+                       draw_annotations(annotations, p, annotation_height, pp, y,
+                               base_colour);
+
                        y += row_height_;
 
                        visible_rows_.push_back(rows[i]);
@@ -222,23 +222,24 @@ void DecodeTrace::paint_mid(QPainter &p, const RowItemPaintParams &pp)
 
        // Draw the hatching
        draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
+
+       // 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 RowItemPaintParams &pp)
+void DecodeTrace::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
 {
        using namespace pv::data::decode;
 
        assert(row_height_);
 
-       for (size_t i = 0; i < visible_rows_.size(); i++)
-       {
+       for (size_t i = 0; i < visible_rows_.size(); i++) {
                const int y = i * row_height_ + get_visual_y();
 
                p.setPen(QPen(Qt::NoPen));
                p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 
-               if (i != 0)
-               {
+               if (i != 0) {
                        const QPointF points[] = {
                                QPointF(pp.left(), y - ArrowSize),
                                QPointF(pp.left() + ArrowSize, y),
@@ -284,15 +285,12 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
 
        const list< shared_ptr<Decoder> >& stack = decoder_stack_->stack();
 
-       if (stack.empty())
-       {
+       if (stack.empty()) {
                QLabel *const l = new QLabel(
                        tr("<p><i>No decoders in the stack</i></p>"));
                l->setAlignment(Qt::AlignCenter);
                form->addRow(l);
-       }
-       else
-       {
+       } else {
                auto iter = stack.cbegin();
                for (int i = 0; i < (int)stack.size(); i++, iter++) {
                        shared_ptr<Decoder> dec(*iter);
@@ -332,8 +330,80 @@ QMenu* DecodeTrace::create_context_menu(QWidget *parent)
        return menu;
 }
 
+void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
+               QPainter &p, int h, const ViewItemPaintParams &pp, int y,
+               size_t base_colour)
+{
+       using namespace pv::data::decode;
+
+       vector<Annotation> a_block;
+       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 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;
+
+               bool a_is_separate = false;
+
+               // Annotation wider than the threshold for a useful label width?
+               if (a_width > 20) {
+                       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);
+                       }
+                       else
+                               draw_annotation_block(a_block, p, h, y, base_colour);
+
+                       a_block.clear();
+               }
+
+               if (a_is_separate) {
+                       draw_annotation(a, p, h, pp, y, base_colour);
+                       // 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);
+       else
+               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 RowItemPaintParams &pp, int y,
+       QPainter &p, int h, const ViewItemPaintParams &pp, int y,
        size_t base_colour) const
 {
        double samples_per_pixel, pixels_offset;
@@ -355,7 +425,45 @@ void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
        if (a.start_sample() == a.end_sample())
                draw_instant(a, p, fill, outline, h, start, y);
        else
-               draw_range(a, p, fill, outline, h, start, end, y);
+               draw_range(a, p, fill, outline, h, start, end, y, pp);
+}
+
+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 double start = annotations.front().start_sample() /
+               samples_per_pixel - pixels_offset;
+       const double end = annotations.back().end_sample() /
+               samples_per_pixel - pixels_offset;
+
+       const double top = y + .5 - h / 2;
+       const double bottom = y + .5 + h / 2;
+
+       const size_t colour = (base_colour + annotations.front().format()) %
+               countof(Colours);
+
+       // 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,
@@ -377,7 +485,7 @@ 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
+       double end, int y, const ViewItemPaintParams &pp) const
 {
        const double top = y + .5 - h / 2;
        const double bottom = y + .5 + h / 2;
@@ -387,8 +495,7 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
        p.setBrush(fill);
 
        // If the two ends are within 1 pixel, draw a vertical line
-       if (start + 1.0 > end)
-       {
+       if (start + 1.0 > end) {
                p.drawLine(QPointF(start, top), QPointF(start, bottom));
                return;
        }
@@ -409,8 +516,15 @@ 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());
+       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;
 
@@ -435,7 +549,7 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 }
 
 void DecodeTrace::draw_error(QPainter &p, const QString &message,
-       const RowItemPaintParams &pp)
+       const ViewItemPaintParams &pp)
 {
        const int y = get_visual_y();
 
@@ -525,7 +639,7 @@ pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
        assert(scale > 0);
 
        const double pixels_offset =
-               (view->offset() - decoder_stack_->start_time()) / scale;
+               ((view->offset() - decoder_stack_->start_time()) / scale).convert_to<double>();
 
        double samplerate = decoder_stack_->samplerate();
 
@@ -556,9 +670,15 @@ int DecodeTrace::get_row_at_point(const QPoint &point)
        if (!row_height_)
                return -1;
 
-       const int row = (point.y() - get_visual_y() + row_height_ / 2) /
-               row_height_;
-       if (row < 0 || row >= (int)visible_rows_.size())
+       const int y = (point.y() - get_visual_y() + row_height_ / 2);
+
+       /* Integer divison of (x-1)/x would yield 0, so we check for this. */
+       if (y < 0)
+               return -1;
+
+       const int row = y / row_height_;
+
+       if (row >= (int)visible_rows_.size())
                return -1;
 
        return row;
@@ -621,7 +741,7 @@ void DecodeTrace::hover_point_changed()
 
        hp.setY(get_visual_y() - (row_height_ / 2) +
                (hover_row * row_height_) -
-               row_height_ - text_size.height());
+               row_height_ - text_size.height() - padding);
 
        QToolTip::showText(view->viewport()->mapToGlobal(hp), ann);
 }
@@ -636,13 +756,17 @@ void DecodeTrace::create_decoder_form(int index,
        const srd_decoder *const decoder = dec->decoder();
        assert(decoder);
 
+       const bool decoder_deletable = index > 0;
+
        pv::widgets::DecoderGroupBox *const group =
                new pv::widgets::DecoderGroupBox(
-                       QString::fromUtf8(decoder->name));
+                       QString::fromUtf8(decoder->name), nullptr, decoder_deletable);
        group->set_decoder_visible(dec->shown());
 
-       delete_mapper_.setMapping(group, index);
-       connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
+       if (decoder_deletable) {
+               delete_mapper_.setMapping(group, index);
+               connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
+       }
 
        show_hide_mapper_.setMapping(group, index);
        connect(group, SIGNAL(show_hide_decoder()),
@@ -652,7 +776,7 @@ void DecodeTrace::create_decoder_form(int index,
        group->add_layout(decoder_form);
 
        // Add the mandatory channels
-       for(l = decoder->channels; l; l = l->next) {
+       for (l = decoder->channels; l; l = l->next) {
                const struct srd_channel *const pdch =
                        (struct srd_channel *)l->data;
                QComboBox *const combo = create_channel_selector(parent, dec, pdch);
@@ -667,7 +791,7 @@ void DecodeTrace::create_decoder_form(int index,
        }
 
        // Add the optional channels
-       for(l = decoder->opt_channels; l; l = l->next) {
+       for (l = decoder->opt_channels; l; l = l->next) {
                const struct srd_channel *const pdch =
                        (struct srd_channel *)l->data;
                QComboBox *const combo = create_channel_selector(parent, dec, pdch);
@@ -682,8 +806,8 @@ void DecodeTrace::create_decoder_form(int index,
        }
 
        // Add the options
-       shared_ptr<prop::binding::DecoderOptions> binding(
-               new prop::binding::DecoderOptions(decoder_stack_, dec));
+       shared_ptr<binding::Decoder> binding(
+               new binding::Decoder(decoder_stack_, dec));
        binding->add_properties_to_form(decoder_form, true);
 
        bindings_.push_back(binding);
@@ -698,29 +822,33 @@ QComboBox* DecodeTrace::create_channel_selector(
 {
        assert(dec);
 
-       shared_lock<shared_mutex> lock(session_.signals_mutex());
-       const vector< shared_ptr<Signal> > &sigs(session_.signals());
+       const auto sigs(session_.signals());
+
+       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; });
 
        assert(decoder_stack_);
        const auto channel_iter = dec->channels().find(pdch);
 
        QComboBox *selector = new QComboBox(parent);
 
-       selector->addItem("-", qVariantFromValue((void*)NULL));
+       selector->addItem("-", qVariantFromValue((void*)nullptr));
 
        if (channel_iter == dec->channels().end())
                selector->setCurrentIndex(0);
 
-       for(size_t i = 0; i < sigs.size(); i++) {
-               const shared_ptr<view::Signal> s(sigs[i]);
+       for (const shared_ptr<view::Signal> &s : sig_list) {
                assert(s);
-
-               if (dynamic_pointer_cast<LogicSignal>(s) && s->enabled())
-               {
+               if (dynamic_pointer_cast<LogicSignal>(s) && s->enabled()) {
                        selector->addItem(s->name(),
                                qVariantFromValue((void*)s.get()));
-                       if ((*channel_iter).second == s)
-                               selector->setCurrentIndex(i + 1);
+
+                       if (channel_iter != dec->channels().end() &&
+                               (*channel_iter).second == s)
+                               selector->setCurrentIndex(
+                                       selector->count() - 1);
                }
        }
 
@@ -733,12 +861,10 @@ void DecodeTrace::commit_decoder_channels(shared_ptr<data::decode::Decoder> &dec
 
        map<const srd_channel*, shared_ptr<LogicSignal> > channel_map;
 
-       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());
 
-       for (const ChannelSelector &s : channel_selectors_)
-       {
-               if(s.decoder_ != dec)
+       for (const ChannelSelector &s : channel_selectors_) {
+               if (s.decoder_ != dec)
                        break;
 
                const LogicSignal *const selection =
@@ -746,7 +872,7 @@ void DecodeTrace::commit_decoder_channels(shared_ptr<data::decode::Decoder> &dec
                                s.combo_->currentIndex()).value<void*>();
 
                for (shared_ptr<Signal> sig : sigs)
-                       if(sig.get() == selection) {
+                       if (sig.get() == selection) {
                                channel_map[s.pdch_] =
                                        dynamic_pointer_cast<LogicSignal>(sig);
                                break;
@@ -768,7 +894,7 @@ void DecodeTrace::commit_channels()
 void DecodeTrace::on_new_decode_data()
 {
        if (owner_)
-               owner_->appearance_changed(false, true);
+               owner_->row_item_appearance_changed(false, true);
 }
 
 void DecodeTrace::delete_pressed()
@@ -815,7 +941,7 @@ void DecodeTrace::on_show_hide_decoder(int index)
 
        // Find the decoder in the stack
        auto iter = stack.cbegin();
-       for(int i = 0; i < index; i++, iter++)
+       for (int i = 0; i < index; i++, iter++)
                assert(iter != stack.end());
 
        shared_ptr<Decoder> dec = *iter;
@@ -828,7 +954,7 @@ void DecodeTrace::on_show_hide_decoder(int index)
        decoder_forms_[index]->set_decoder_visible(show);
 
        if (owner_)
-               owner_->appearance_changed(false, true);
+               owner_->row_item_appearance_changed(false, true);
 }
 
 } // namespace view