]> sigrok.org Git - pulseview.git/blobdiff - pv/view/decodetrace.cpp
DecodeTrace: Make tool tips use mapToGlobal() of the view's viewport
[pulseview.git] / pv / view / decodetrace.cpp
index c47a46ab469abd2f7063c02cd1e1a1417984a246..5ee86452d8fe9d6db49048702a39d848bb84ba84 100644 (file)
@@ -24,7 +24,7 @@ extern "C" {
 
 #include <extdef.h>
 
-#include <boost/foreach.hpp>
+#include <boost/functional/hash.hpp>
 
 #include <QAction>
 #include <QApplication>
@@ -33,6 +33,7 @@ extern "C" {
 #include <QLabel>
 #include <QMenu>
 #include <QPushButton>
+#include <QToolTip>
 
 #include "decodetrace.h"
 
@@ -44,15 +45,18 @@ extern "C" {
 #include <pv/data/decode/annotation.h>
 #include <pv/view/logicsignal.h>
 #include <pv/view/view.h>
+#include <pv/view/viewport.h>
 #include <pv/widgets/decodergroupbox.h>
 #include <pv/widgets/decodermenu.h>
 
-using boost::dynamic_pointer_cast;
-using boost::shared_ptr;
+using std::dynamic_pointer_cast;
 using std::list;
+using std::make_pair;
 using std::max;
 using std::map;
 using std::min;
+using std::pair;
+using std::shared_ptr;
 using std::vector;
 
 namespace pv {
@@ -111,11 +115,13 @@ const QColor DecodeTrace::OutlineColours[16] = {
 };
 
 DecodeTrace::DecodeTrace(pv::SigSession &session,
-       boost::shared_ptr<pv::data::DecoderStack> decoder_stack, int index) :
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack, int index) :
        Trace(QString::fromUtf8(
                decoder_stack->stack().front()->decoder()->name)),
        _session(session),
        _decoder_stack(decoder_stack),
+       _text_height(0),
+       _row_height(0),
        _delete_mapper(this),
        _show_hide_mapper(this)
 {
@@ -136,7 +142,7 @@ bool DecodeTrace::enabled() const
        return true;
 }
 
-const boost::shared_ptr<pv::data::DecoderStack>& DecodeTrace::decoder() const
+const std::shared_ptr<pv::data::DecoderStack>& DecodeTrace::decoder() const
 {
        return _decoder_stack;
 }
@@ -157,37 +163,16 @@ void DecodeTrace::paint_mid(QPainter &p, int left, int right)
 {
        using namespace pv::data::decode;
 
-       const double scale = _view->scale();
-       assert(scale > 0);
-
-       double samplerate = _decoder_stack->samplerate();
-
-       _cur_row_headings.clear();
-
-       // Show sample rate as 1Hz when it is unknown
-       if (samplerate == 0.0)
-               samplerate = 1.0;
-
-       const double pixels_offset = (_view->offset() -
-               _decoder_stack->get_start_time()) / scale;
-       const double samples_per_pixel = samplerate * scale;
-
-       const uint64_t start_sample = (uint64_t)max((left + pixels_offset) *
-               samples_per_pixel, 0.0);
-       const uint64_t end_sample = (uint64_t)max((right + pixels_offset) *
-               samples_per_pixel, 0.0);
-
        QFontMetrics m(QApplication::font());
-       const int text_height =  m.boundingRect(QRect(), 0, "Tg").height();
-       const int annotation_height = (text_height * 5) / 4;
-       const int row_height = (text_height * 6) / 4;
+       _text_height = m.boundingRect(QRect(), 0, "Tg").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())
        {
-               draw_unresolved_period(p, annotation_height, left, right,
-                       samples_per_pixel, pixels_offset);
+               draw_unresolved_period(p, annotation_height, left, right);
                draw_error(p, err, left, right);
                return;
        }
@@ -195,10 +180,12 @@ void DecodeTrace::paint_mid(QPainter &p, int left, int right)
        // Iterate through the rows
        assert(_view);
        int y = get_y();
+       pair<uint64_t, uint64_t> sample_range = get_sample_range(left, right);
 
        assert(_decoder_stack);
-
        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];
@@ -211,22 +198,20 @@ void DecodeTrace::paint_mid(QPainter &p, int left, int right)
 
                vector<Annotation> annotations;
                _decoder_stack->get_annotation_subset(annotations, row,
-                       start_sample, end_sample);
+                       sample_range.first, sample_range.second);
                if (!annotations.empty()) {
-                       BOOST_FOREACH(const Annotation &a, annotations)
+                       for (const Annotation &a : annotations)
                                draw_annotation(a, p, get_text_colour(),
-                                       annotation_height, left, right,
-                                       samples_per_pixel, pixels_offset, y,
+                                       annotation_height, left, right, y,
                                        base_colour);
-                       y += row_height;
+                       y += _row_height;
 
-                       _cur_row_headings.push_back(row.title());
+                       _visible_rows.push_back(rows[i]);
                }
        }
 
        // Draw the hatching
-       draw_unresolved_period(p, annotation_height, left, right,
-               samples_per_pixel, pixels_offset);
+       draw_unresolved_period(p, annotation_height, left, right);
 }
 
 void DecodeTrace::paint_fore(QPainter &p, int left, int right)
@@ -235,13 +220,11 @@ void DecodeTrace::paint_fore(QPainter &p, int left, int right)
 
        (void)right;
 
-       QFontMetrics m(QApplication::font());
-       const int text_height =  m.boundingRect(QRect(), 0, "Tg").height();
-       const int row_height = (text_height * 6) / 4;
+       assert(_row_height);
 
-       for (size_t i = 0; i < _cur_row_headings.size(); i++)
+       for (size_t i = 0; i < _visible_rows.size(); i++)
        {
-               const int y = i * row_height + get_y();
+               const int y = i * _row_height + get_y();
 
                p.setPen(QPen(Qt::NoPen));
                p.setBrush(QApplication::palette().brush(QPalette::WindowText));
@@ -256,9 +239,9 @@ void DecodeTrace::paint_fore(QPainter &p, int left, int right)
                        p.drawPolygon(points, countof(points));
                }
 
-               const QRect r(left + ArrowSize * 2, y - row_height / 2,
-                       right - left, row_height);
-               const QString h(_cur_row_headings[i]);
+               const QRect r(left + ArrowSize * 2, y - _row_height / 2,
+                       right - left, _row_height);
+               const QString h(_visible_rows[i].title());
                const int f = Qt::AlignLeft | Qt::AlignVCenter |
                        Qt::TextDontClip;
 
@@ -288,7 +271,7 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
 
        // Add the decoder options
        _bindings.clear();
-       _probe_selectors.clear();
+       _channel_selectors.clear();
        _decoder_forms.clear();
 
        const list< shared_ptr<Decoder> >& stack = _decoder_stack->stack();
@@ -302,15 +285,14 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
        }
        else
        {
-               list< shared_ptr<Decoder> >::const_iterator iter =
-                       stack.begin();
+               auto iter = stack.cbegin();
                for (int i = 0; i < (int)stack.size(); i++, iter++) {
                        shared_ptr<Decoder> dec(*iter);
                        create_decoder_form(i, dec, parent, form);
                }
 
                form->addRow(new QLabel(
-                       tr("<i>* Required Probes</i>"), parent));
+                       tr("<i>* Required channels</i>"), parent));
        }
 
        // Add stacking button
@@ -343,10 +325,12 @@ QMenu* DecodeTrace::create_context_menu(QWidget *parent)
 }
 
 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
-       QPainter &p, QColor text_color, int h, int left, int right,
-       double samples_per_pixel, double pixels_offset, int y,
+       QPainter &p, QColor text_color, int h, int left, int right, int y,
        size_t base_colour) const
 {
+       const double samples_per_pixel = get_samples_per_pixel();
+       const double pixels_offset = get_pixels_offset();
+
        const double start = a.start_sample() / samples_per_pixel -
                pixels_offset;
        const double end = a.end_sample() / samples_per_pixel -
@@ -372,7 +356,7 @@ void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &
 {
        const QString text = a.annotations().empty() ?
                QString() : a.annotations().back();
-       const double w = min(p.boundingRect(QRectF(), 0, text).width(),
+       const double w = min((double)p.boundingRect(QRectF(), 0, text).width(),
                0.0) + h;
        const QRectF rect(x - w / 2, y - h / 2, w, h);
 
@@ -420,13 +404,16 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 
        QRectF rect(start + cap_width, y - h / 2,
                end - start - cap_width * 2, h);
+       if (rect.width() <= 4)
+               return;
+
        p.setPen(text_color);
 
        // Try to find an annotation that will fit
        QString best_annotation;
        int best_width = 0;
 
-       BOOST_FOREACH(const QString &a, annotations) {
+       for (const QString &a : annotations) {
                const int w = p.boundingRect(QRectF(), 0, a).width();
                if (w <= rect.width() && w > best_width)
                        best_annotation = a, best_width = w;
@@ -462,7 +449,7 @@ void DecodeTrace::draw_error(QPainter &p, const QString &message,
 }
 
 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
-       int right, double samples_per_pixel, double pixels_offset) 
+       int right) const
 {
        using namespace pv::data;
        using pv::data::decode::Decoder;
@@ -474,12 +461,12 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
 
        const list< shared_ptr<Decoder> > &stack = _decoder_stack->stack();
 
-       // We get the logic data of the first probe in the list.
+       // We get the logic data of the first channel in the list.
        // This works because we are currently assuming all
        // LogicSignals have the same data/snapshot
-       BOOST_FOREACH (const shared_ptr<Decoder> &dec, stack)
-               if (dec && !dec->probes().empty() &&
-                       ((logic_signal = (*dec->probes().begin()).second)) &&
+       for (const shared_ptr<Decoder> &dec : stack)
+               if (dec && !dec->channels().empty() &&
+                       ((logic_signal = (*dec->channels().begin()).second)) &&
                        ((data = logic_signal->logic_data())))
                        break;
 
@@ -498,6 +485,10 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
                return;
 
        const int y = get_y();
+
+       const double samples_per_pixel = get_samples_per_pixel();
+       const double pixels_offset = get_pixels_offset();
+
        const double start = max(samples_decoded /
                samples_per_pixel - pixels_offset, left - 1.0);
        const double end = min(sample_count / samples_per_pixel -
@@ -513,11 +504,154 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
        p.drawRect(no_decode_rect);
 }
 
+double DecodeTrace::get_pixels_offset() const
+{
+       assert(_view);
+       assert(_decoder_stack);
+
+       const double scale = _view->scale();
+       assert(scale > 0);
+
+       return (_view->offset() - _decoder_stack->get_start_time()) / scale;
+}
+
+double DecodeTrace::get_samples_per_pixel() const
+{
+       assert(_view);
+       assert(_decoder_stack);
+
+       const double scale = _view->scale();
+       assert(scale > 0);
+
+       double samplerate = _decoder_stack->samplerate();
+
+       // Show sample rate as 1Hz when it is unknown
+       if (samplerate == 0.0)
+               samplerate = 1.0;
+
+       return samplerate * scale;
+}
+
+pair<uint64_t, uint64_t> DecodeTrace::get_sample_range(int x_start, int x_end) const
+{
+       assert(_view);
+       assert(_decoder_stack);
+
+       const double samples_per_pixel = get_samples_per_pixel();
+       const double pixels_offset = get_pixels_offset();
+
+       uint64_t start, end;
+
+       start = (uint64_t)max((x_start + pixels_offset) * samples_per_pixel, 0.0);
+       end = (uint64_t)max((x_end + pixels_offset) * samples_per_pixel, 0.0);
+
+       return make_pair(start, end);
+}
+
+bool DecodeTrace::hover_point_is_over_trace()
+{
+       assert(_view);
+       assert(_row_height);
+
+       // Note: if _row_height is valid then _cur_row_headings is valid, too,
+       // as both are set in paint_mid().
+
+       // Note: hp.x will be 0 if the cursor is above the header area,
+       // so we set trace.left to 1 to exclude this.
+
+       QRect trace(1, get_y() - (_row_height/2),
+               _view->width(), _row_height * _visible_rows.size());
+
+       // Note: We don't need to check for _row_height being 0 here but
+       // we do it anyway to be more robust.
+
+       return _row_height && enabled() && trace.contains(_view->hover_point());
+}
+
+int DecodeTrace::get_row_at_hover_point()
+{
+       assert(_view);
+       assert(_row_height);
+       assert(_decoder_stack);
+
+       QPoint hp = _view->hover_point();
+       int hover_row = (hp.y() - get_y() + (_row_height/2)) / _row_height;
+
+       return min(hover_row, (int)_visible_rows.size() - 1);
+}
+
+const QString DecodeTrace::get_annotation_at_hover_point()
+{
+       using namespace pv::data::decode;
+
+       assert(_view);
+       QPoint hp = _view->hover_point();
+
+       pair<uint64_t, uint64_t> sample_range = get_sample_range(hp.x(), hp.x() + 1);
+
+       const int hover_row = get_row_at_hover_point();
+
+       vector<pv::data::decode::Annotation> annotations;
+
+       assert(_decoder_stack);
+       _decoder_stack->get_annotation_subset(annotations, _visible_rows[hover_row],
+               sample_range.first, sample_range.second);
+
+       return (annotations.empty()) ?
+               QString() : annotations[0].annotations().front();
+}
+
+void DecodeTrace::show_hover_annotation()
+{
+       QString ann = get_annotation_at_hover_point();
+
+       assert(_view);
+       assert(_row_height);
+
+       if (!ann.isEmpty()) {
+               const int hover_row = get_row_at_hover_point();
+
+               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 hp = _view->hover_point();
+
+               hp.setX(hp.x() - (text_size.width() / 2) - padding);
+
+               hp.setY(get_y() - (_row_height / 2) + (hover_row * _row_height)
+                       - _row_height - text_size.height());
+
+               QToolTip::showText(_view->viewport()->mapToGlobal(hp), ann);
+       } else
+               hide_hover_annotation();
+}
+
+void DecodeTrace::hide_hover_annotation()
+{
+       QToolTip::hideText();
+}
+
+void DecodeTrace::hover_point_changed()
+{
+       if (hover_point_is_over_trace())
+               show_hover_annotation();
+       else
+               hide_hover_annotation();
+}
+
 void DecodeTrace::create_decoder_form(int index,
        shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
        QFormLayout *form)
 {
-       const GSList *probe;
+       const GSList *l;
 
        assert(dec);
        const srd_decoder *const decoder = dec->decoder();
@@ -538,34 +672,34 @@ void DecodeTrace::create_decoder_form(int index,
        QFormLayout *const decoder_form = new QFormLayout;
        group->add_layout(decoder_form);
 
-       // Add the mandatory probes
-       for(probe = decoder->probes; probe; probe = probe->next) {
-               const struct srd_probe *const p =
-                       (struct srd_probe *)probe->data;
-               QComboBox *const combo = create_probe_selector(parent, dec, p);
+       // Add the mandatory channels
+       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);
                connect(combo, SIGNAL(currentIndexChanged(int)),
-                       this, SLOT(on_probe_selected(int)));
+                       this, SLOT(on_channel_selected(int)));
                decoder_form->addRow(tr("<b>%1</b> (%2) *")
-                       .arg(QString::fromUtf8(p->name))
-                       .arg(QString::fromUtf8(p->desc)), combo);
+                       .arg(QString::fromUtf8(pdch->name))
+                       .arg(QString::fromUtf8(pdch->desc)), combo);
 
-               const ProbeSelector s = {combo, dec, p};
-               _probe_selectors.push_back(s);
+               const ChannelSelector s = {combo, dec, pdch};
+               _channel_selectors.push_back(s);
        }
 
-       // Add the optional probes
-       for(probe = decoder->opt_probes; probe; probe = probe->next) {
-               const struct srd_probe *const p =
-                       (struct srd_probe *)probe->data;
-               QComboBox *const combo = create_probe_selector(parent, dec, p);
+       // Add the optional channels
+       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);
                connect(combo, SIGNAL(currentIndexChanged(int)),
-                       this, SLOT(on_probe_selected(int)));
+                       this, SLOT(on_channel_selected(int)));
                decoder_form->addRow(tr("<b>%1</b> (%2)")
-                       .arg(QString::fromUtf8(p->name))
-                       .arg(QString::fromUtf8(p->desc)), combo);
+                       .arg(QString::fromUtf8(pdch->name))
+                       .arg(QString::fromUtf8(pdch->desc)), combo);
 
-               const ProbeSelector s = {combo, dec, p};
-               _probe_selectors.push_back(s);
+               const ChannelSelector s = {combo, dec, pdch};
+               _channel_selectors.push_back(s);
        }
 
        // Add the options
@@ -579,24 +713,22 @@ void DecodeTrace::create_decoder_form(int index,
        _decoder_forms.push_back(group);
 }
 
-QComboBox* DecodeTrace::create_probe_selector(
+QComboBox* DecodeTrace::create_channel_selector(
        QWidget *parent, const shared_ptr<data::decode::Decoder> &dec,
-       const srd_probe *const probe)
+       const srd_channel *const pdch)
 {
        assert(dec);
 
        const vector< shared_ptr<Signal> > sigs = _session.get_signals();
 
        assert(_decoder_stack);
-       const map<const srd_probe*,
-               shared_ptr<LogicSignal> >::const_iterator probe_iter =
-               dec->probes().find(probe);
+       const auto channel_iter = dec->channels().find(pdch);
 
        QComboBox *selector = new QComboBox(parent);
 
        selector->addItem("-", qVariantFromValue((void*)NULL));
 
-       if (probe_iter == dec->probes().end())
+       if (channel_iter == dec->channels().end())
                selector->setCurrentIndex(0);
 
        for(size_t i = 0; i < sigs.size(); i++) {
@@ -607,7 +739,7 @@ QComboBox* DecodeTrace::create_probe_selector(
                {
                        selector->addItem(s->get_name(),
                                qVariantFromValue((void*)s.get()));
-                       if ((*probe_iter).second == s)
+                       if ((*channel_iter).second == s)
                                selector->setCurrentIndex(i + 1);
                }
        }
@@ -615,14 +747,14 @@ QComboBox* DecodeTrace::create_probe_selector(
        return selector;
 }
 
-void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
+void DecodeTrace::commit_decoder_channels(shared_ptr<data::decode::Decoder> &dec)
 {
        assert(dec);
 
-       map<const srd_probe*, shared_ptr<LogicSignal> > probe_map;
+       map<const srd_channel*, shared_ptr<LogicSignal> > channel_map;
        const vector< shared_ptr<Signal> > sigs = _session.get_signals();
 
-       BOOST_FOREACH(const ProbeSelector &s, _probe_selectors)
+       for (const ChannelSelector &s : _channel_selectors)
        {
                if(s._decoder != dec)
                        break;
@@ -631,23 +763,22 @@ void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
                        (LogicSignal*)s._combo->itemData(
                                s._combo->currentIndex()).value<void*>();
 
-               BOOST_FOREACH(shared_ptr<Signal> sig, sigs)
+               for (shared_ptr<Signal> sig : sigs)
                        if(sig.get() == selection) {
-                               probe_map[s._probe] =
+                               channel_map[s._pdch] =
                                        dynamic_pointer_cast<LogicSignal>(sig);
                                break;
                        }
        }
 
-       dec->set_probes(probe_map);
+       dec->set_channels(channel_map);
 }
 
-void DecodeTrace::commit_probes()
+void DecodeTrace::commit_channels()
 {
        assert(_decoder_stack);
-       BOOST_FOREACH(shared_ptr<data::decode::Decoder> dec,
-               _decoder_stack->stack())
-               commit_decoder_probes(dec);
+       for (shared_ptr<data::decode::Decoder> dec : _decoder_stack->stack())
+               commit_decoder_channels(dec);
 
        _decoder_stack->begin_decode();
 }
@@ -668,9 +799,9 @@ void DecodeTrace::on_delete()
        _session.remove_decode_signal(this);
 }
 
-void DecodeTrace::on_probe_selected(int)
+void DecodeTrace::on_channel_selected(int)
 {
-       commit_probes();
+       commit_channels();
 }
 
 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
@@ -701,7 +832,7 @@ void DecodeTrace::on_show_hide_decoder(int index)
        const list< shared_ptr<Decoder> > stack(_decoder_stack->stack());
 
        // Find the decoder in the stack
-       list< shared_ptr<Decoder> >::const_iterator iter = stack.begin();
+       auto iter = stack.cbegin();
        for(int i = 0; i < index; i++, iter++)
                assert(iter != stack.end());