]> sigrok.org Git - pulseview.git/blobdiff - pv/view/decodetrace.cpp
Prefer std::make_shared().
[pulseview.git] / pv / view / decodetrace.cpp
index eb1f7f83d01324d1527e81ffdb890e17a2194dcd..164c7e5a6075fc719a9cc3e9c117e309ecf37ff8 100644 (file)
@@ -14,8 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 extern "C" {
@@ -44,12 +43,12 @@ 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>
 #include <pv/data/logicsegment.hpp>
 #include <pv/data/decode/annotation.hpp>
-#include <pv/view/logicsignal.hpp>
 #include <pv/view/view.hpp>
 #include <pv/view/viewport.hpp>
 #include <pv/widgets/decodergroupbox.hpp>
@@ -67,12 +66,14 @@ using std::map;
 using std::min;
 using std::pair;
 using std::shared_ptr;
+using std::make_shared;
 using std::tie;
 using std::unordered_set;
 using std::vector;
 
 namespace pv {
-namespace view {
+namespace views {
+namespace TraceView {
 
 const QColor DecodeTrace::DecodeColours[4] = {
        QColor(0xEF, 0x29, 0x29),       // Red
@@ -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] = {
@@ -127,21 +129,25 @@ const QColor DecodeTrace::OutlineColours[16] = {
 };
 
 DecodeTrace::DecodeTrace(pv::Session &session,
-       std::shared_ptr<pv::data::DecoderStack> decoder_stack, int index) :
-       Trace(QString::fromUtf8(
-               decoder_stack->stack().front()->decoder()->name)),
+       shared_ptr<data::SignalBase> signalbase, int index) :
+       Trace(signalbase),
        session_(session),
-       decoder_stack_(decoder_stack),
        row_height_(0),
        max_visible_rows_(0),
        delete_mapper_(this),
        show_hide_mapper_(this)
 {
-       assert(decoder_stack_);
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
 
-       set_colour(DecodeColours[index % countof(DecodeColours)]);
+       // 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
 
-       connect(decoder_stack_.get(), SIGNAL(new_decode_data()),
+       base_->set_name(QString::fromUtf8(decoder_stack->stack().front()->decoder()->name));
+       base_->set_colour(DecodeColours[index % countof(DecodeColours)]);
+
+       connect(decoder_stack.get(), SIGNAL(new_decode_data()),
                this, SLOT(on_new_decode_data()));
        connect(&delete_mapper_, SIGNAL(mapped(int)),
                this, SLOT(on_delete_decoder(int)));
@@ -154,16 +160,19 @@ bool DecodeTrace::enabled() const
        return true;
 }
 
-const std::shared_ptr<pv::data::DecoderStack>& DecodeTrace::decoder() const
+std::shared_ptr<data::SignalBase> DecodeTrace::base() const
 {
-       return decoder_stack_;
+       return base_;
 }
 
 pair<int, int> DecodeTrace::v_extents() const
 {
        const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
 
-       return make_pair(-row_height, row_height * max_visible_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)
@@ -176,12 +185,15 @@ void DecodeTrace::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
 {
        using namespace pv::data::decode;
 
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
        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();
+       assert(decoder_stack);
+       const QString err = decoder_stack->error_message();
        if (!err.isEmpty()) {
                draw_unresolved_period(
                        p, annotation_height, pp.left(), pp.right());
@@ -189,18 +201,30 @@ 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(
                pp.left(), pp.right());
 
-       assert(decoder_stack_);
-       const vector<Row> rows(decoder_stack_->get_visible_rows());
+       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());
@@ -208,21 +232,24 @@ void DecodeTrace::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
                base_colour >>= 16;
 
                vector<Annotation> annotations;
-               decoder_stack_->get_annotation_subset(annotations, row,
+               decoder_stack->get_annotation_subset(annotations, row,
                        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());
 }
@@ -271,9 +298,12 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
 {
        using pv::data::decode::Decoder;
 
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
        assert(form);
        assert(parent);
-       assert(decoder_stack_);
+       assert(decoder_stack);
 
        // Add the standard options
        Trace::populate_popup_form(parent, form);
@@ -283,7 +313,7 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
        channel_selectors_.clear();
        decoder_forms_.clear();
 
-       const list< shared_ptr<Decoder> >& stack = decoder_stack_->stack();
+       const list< shared_ptr<Decoder> >& stack = decoder_stack->stack();
 
        if (stack.empty()) {
                QLabel *const l = new QLabel(
@@ -332,7 +362,7 @@ 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;
 
@@ -361,7 +391,7 @@ void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotati
                bool a_is_separate = false;
 
                // Annotation wider than the threshold for a useful label width?
-               if (a_width > 20) {
+               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
@@ -376,7 +406,8 @@ void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotati
                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);
+                               draw_annotation(a_block.front(), p, h, pp, y, base_colour,
+                                       row_title_width);
                        }
                        else
                                draw_annotation_block(a_block, p, h, y, base_colour);
@@ -385,7 +416,7 @@ void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotati
                }
 
                if (a_is_separate) {
-                       draw_annotation(a, p, h, pp, y, base_colour);
+                       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
@@ -397,14 +428,15 @@ void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotati
        }
 
        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, 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) =
@@ -416,16 +448,17 @@ 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, pp);
+               draw_range(a, p, h, start, end, y, pp,
+                       row_title_width);
 }
 
 void DecodeTrace::draw_annotation_block(
@@ -467,7 +500,7 @@ void DecodeTrace::draw_annotation_block(
 }
 
 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();
@@ -475,8 +508,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);
@@ -484,16 +515,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 ViewItemPaintParams &pp) 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));
@@ -519,9 +547,8 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
        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_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);
@@ -577,20 +604,23 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
 
        double samples_per_pixel, pixels_offset;
 
-       assert(decoder_stack_); 
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
+       assert(decoder_stack);
 
        shared_ptr<Logic> data;
-       shared_ptr<LogicSignal> logic_signal;
+       shared_ptr<data::SignalBase> signalbase;
 
-       const list< shared_ptr<Decoder> > &stack = decoder_stack_->stack();
+       const list< shared_ptr<Decoder> > &stack = decoder_stack->stack();
 
        // 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/segment
        for (const shared_ptr<Decoder> &dec : stack)
                if (dec && !dec->channels().empty() &&
-                       ((logic_signal = (*dec->channels().begin()).second)) &&
-                       ((data = logic_signal->logic_data())))
+                       ((signalbase = (*dec->channels().begin()).second)) &&
+                       ((data = signalbase->logic_data())))
                        break;
 
        if (!data || data->logic_segments().empty())
@@ -603,7 +633,7 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
        if (sample_count == 0)
                return;
 
-       const int64_t samples_decoded = decoder_stack_->samples_decoded();
+       const int64_t samples_decoded = decoder_stack->samples_decoded();
        if (sample_count == samples_decoded)
                return;
 
@@ -629,8 +659,11 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
 
 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
 {
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
        assert(owner_);
-       assert(decoder_stack_);
+       assert(decoder_stack);
 
        const View *view = owner_->view();
        assert(view);
@@ -639,9 +672,9 @@ 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).convert_to<double>();
+               ((view->offset() - decoder_stack->start_time()) / scale).convert_to<double>();
 
-       double samplerate = decoder_stack_->samplerate();
+       double samplerate = decoder_stack->samplerate();
 
        // Show sample rate as 1Hz when it is unknown
        if (samplerate == 0.0)
@@ -699,8 +732,11 @@ const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
 
        vector<pv::data::decode::Annotation> annotations;
 
-       assert(decoder_stack_);
-       decoder_stack_->get_annotation_subset(annotations, visible_rows_[row],
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
+       assert(decoder_stack);
+       decoder_stack->get_annotation_subset(annotations, visible_rows_[row],
                sample_range.first, sample_range.second);
 
        return (annotations.empty()) ?
@@ -783,8 +819,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);
@@ -798,16 +834,19 @@ 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);
        }
 
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
        // Add the options
        shared_ptr<binding::Decoder> binding(
-               new binding::Decoder(decoder_stack_, dec));
+               new binding::Decoder(decoder_stack, dec));
        binding->add_properties_to_form(decoder_form, true);
 
        bindings_.push_back(binding);
@@ -822,14 +861,15 @@ QComboBox* DecodeTrace::create_channel_selector(
 {
        assert(dec);
 
-       const auto sigs(session_.signals());
+       const auto sigs(session_.signalbases());
 
-       vector< shared_ptr<Signal> > sig_list(sigs.begin(), sigs.end());
+       vector< shared_ptr<data::SignalBase> > 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; });
+               [](const shared_ptr<data::SignalBase> &a,
+               const shared_ptr<data::SignalBase> &b) {
+                       return strnatcasecmp(a->name().toStdString(),
+                               b->name().toStdString()) < 0; });
 
-       assert(decoder_stack_);
        const auto channel_iter = dec->channels().find(pdch);
 
        QComboBox *selector = new QComboBox(parent);
@@ -839,14 +879,14 @@ QComboBox* DecodeTrace::create_channel_selector(
        if (channel_iter == dec->channels().end())
                selector->setCurrentIndex(0);
 
-       for (const shared_ptr<view::Signal> &s : sig_list) {
-               assert(s);
-               if (dynamic_pointer_cast<LogicSignal>(s) && s->enabled()) {
-                       selector->addItem(s->name(),
-                               qVariantFromValue((void*)s.get()));
+       for (const shared_ptr<data::SignalBase> &b : sig_list) {
+               assert(b);
+               if (b->type() == sigrok::ChannelType::LOGIC && b->enabled()) {
+                       selector->addItem(b->name(),
+                               qVariantFromValue((void*)b.get()));
 
                        if (channel_iter != dec->channels().end() &&
-                               (*channel_iter).second == s)
+                               (*channel_iter).second == b)
                                selector->setCurrentIndex(
                                        selector->count() - 1);
                }
@@ -859,22 +899,22 @@ void DecodeTrace::commit_decoder_channels(shared_ptr<data::decode::Decoder> &dec
 {
        assert(dec);
 
-       map<const srd_channel*, shared_ptr<LogicSignal> > channel_map;
+       map<const srd_channel*, shared_ptr<data::SignalBase> > channel_map;
 
-       const unordered_set< shared_ptr<Signal> > sigs(session_.signals());
+       const unordered_set< shared_ptr<data::SignalBase> >
+               sigs(session_.signalbases());
 
        for (const ChannelSelector &s : channel_selectors_) {
                if (s.decoder_ != dec)
                        break;
 
-               const LogicSignal *const selection =
-                       (LogicSignal*)s.combo_->itemData(
+               const data::SignalBase *const selection =
+                       (data::SignalBase*)s.combo_->itemData(
                                s.combo_->currentIndex()).value<void*>();
 
-               for (shared_ptr<Signal> sig : sigs)
+               for (shared_ptr<data::SignalBase> sig : sigs)
                        if (sig.get() == selection) {
-                               channel_map[s.pdch_] =
-                                       dynamic_pointer_cast<LogicSignal>(sig);
+                               channel_map[s.pdch_] = sig;
                                break;
                        }
        }
@@ -884,11 +924,14 @@ void DecodeTrace::commit_decoder_channels(shared_ptr<data::decode::Decoder> &dec
 
 void DecodeTrace::commit_channels()
 {
-       assert(decoder_stack_);
-       for (shared_ptr<data::decode::Decoder> dec : decoder_stack_->stack())
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
+       assert(decoder_stack);
+       for (shared_ptr<data::decode::Decoder> dec : decoder_stack->stack())
                commit_decoder_channels(dec);
 
-       decoder_stack_->begin_decode();
+       decoder_stack->begin_decode();
 }
 
 void DecodeTrace::on_new_decode_data()
@@ -904,7 +947,7 @@ void DecodeTrace::delete_pressed()
 
 void DecodeTrace::on_delete()
 {
-       session_.remove_decode_signal(this);
+       session_.remove_decode_signal(base_);
 }
 
 void DecodeTrace::on_channel_selected(int)
@@ -914,30 +957,38 @@ void DecodeTrace::on_channel_selected(int)
 
 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
 {
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
        assert(decoder);
-       assert(decoder_stack_);
-       decoder_stack_->push(shared_ptr<data::decode::Decoder>(
-               new data::decode::Decoder(decoder)));
-       decoder_stack_->begin_decode();
+       assert(decoder_stack);
+       decoder_stack->push(make_shared<data::decode::Decoder>(decoder));
+       decoder_stack->begin_decode();
 
        create_popup_form();
 }
 
 void DecodeTrace::on_delete_decoder(int index)
 {
-       decoder_stack_->remove(index);
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
+       decoder_stack->remove(index);
 
        // Update the popup
        create_popup_form();    
 
-       decoder_stack_->begin_decode();
+       decoder_stack->begin_decode();
 }
 
 void DecodeTrace::on_show_hide_decoder(int index)
 {
        using pv::data::decode::Decoder;
 
-       const list< shared_ptr<Decoder> > stack(decoder_stack_->stack());
+       std::shared_ptr<pv::data::DecoderStack> decoder_stack =
+               base_->decoder_stack();
+
+       const list< shared_ptr<Decoder> > stack(decoder_stack->stack());
 
        // Find the decoder in the stack
        auto iter = stack.cbegin();
@@ -957,5 +1008,6 @@ void DecodeTrace::on_show_hide_decoder(int index)
                owner_->row_item_appearance_changed(false, true);
 }
 
-} // namespace view
+} // namespace TraceView
+} // namespace views
 } // namespace pv