decodetrace.hpp

Go to the documentation of this file.

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_PV_VIEWS_TRACE_DECODETRACE_HPP
#define PULSEVIEW_PV_VIEWS_TRACE_DECODETRACE_HPP

#include <config.h>
#include "trace.hpp"

#include <list>
#include <map>
#include <memory>
#include <vector>

#include <QColor>
#include <QComboBox>
#include <QCheckBox>
#include <QElapsedTimer>
#include <QPolygon>
#include <QPushButton>
#include <QSignalMapper>
#include <QTimer>

#include <pv/binding/decoder.hpp>
#include <pv/data/decode/decoder.hpp>
#include <pv/data/decode/annotation.hpp>
#include <pv/data/decode/row.hpp>
#include <pv/data/signalbase.hpp>

#define DECODETRACE_SHOW_RENDER_TIME 0

using std::deque;
using std::list;
using std::map;
using std::mutex;
using std::pair;
using std::shared_ptr;
using std::vector;

using pv::data::SignalBase;
using pv::data::decode::Annotation;
using pv::data::decode::Decoder;
using pv::data::decode::Row;

struct srd_channel;
struct srd_decoder;

namespace pv {

class Session;

namespace data {
struct DecodeChannel;
class DecodeSignal;

namespace decode {
class Decoder;
class Row;
}
}  // namespace data

namespace widgets {
class DecoderGroupBox;
}

namespace views {
namespace trace {

class ContainerWidget;

struct DecodeTraceRow {
    // When adding a field, make sure it's initialized properly in
    // DecodeTrace::update_rows()

    Row* decode_row;
    unsigned int height, expanded_height, title_width, animation_step;
    bool exists, currently_visible, has_hidden_classes;
    bool expand_marker_highlighted, expanding, expanded, collapsing;
    QPolygon expand_marker_shape;
    float anim_height, anim_shape;

    ContainerWidget* container;
    QWidget* header_container;
    QWidget* selector_container;
    QCheckBox* row_visibility_checkbox;
    vector<QCheckBox*> selectors;
};

class ContainerWidget : public QWidget
{
    Q_OBJECT

public:
    ContainerWidget(QWidget *parent = nullptr);

    virtual void resizeEvent(QResizeEvent* event);

Q_SIGNALS:
    void widgetResized(QWidget* sender);
};

class DecodeTrace : public Trace
{
    Q_OBJECT

private:
    static const QColor NoDecodeColor;
    static const QColor ExpandMarkerWarnColor;
    static const QColor ExpandMarkerHiddenColor;
    static const uint8_t ExpansionAreaHeaderAlpha;
    static const uint8_t ExpansionAreaAlpha;

    static const int ArrowSize;
    static const double EndCapWidth;
    static const int RowTitleMargin;
    static const int DrawPadding;

    static const int MaxTraceUpdateRate;
    static const int AnimationDurationInTicks;
    static const int HiddenRowHideDelay;

public:
    DecodeTrace(pv::Session &session, shared_ptr<SignalBase> signalbase,
        int index);

    ~DecodeTrace();

    bool enabled() const;

    shared_ptr<SignalBase> base() const;

    virtual void set_owner(TraceTreeItemOwner *owner);

    pair<int, int> v_extents() const;

    void paint_back(QPainter &p, ViewItemPaintParams &pp);

    void paint_mid(QPainter &p, ViewItemPaintParams &pp);

    void paint_fore(QPainter &p, ViewItemPaintParams &pp);

    void populate_popup_form(QWidget *parent, QFormLayout *form);

    QMenu* create_header_context_menu(QWidget *parent);

    virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);

    virtual void delete_pressed();

    virtual void hover_point_changed(const QPoint &hp);

    virtual void mouse_left_press_event(const QMouseEvent* event);

private:
    void draw_annotations(deque<const Annotation*>& annotations, QPainter &p,
        const ViewItemPaintParams &pp, int y, const DecodeTraceRow& row);

    void draw_annotation(const Annotation* a, QPainter &p,
        const ViewItemPaintParams &pp, int y, const DecodeTraceRow& row) const;

    void draw_annotation_block(qreal start, qreal end, uint32_t ann_class,
        bool use_ann_format, QPainter &p, int y, const DecodeTraceRow& row) const;

    void draw_instant(const Annotation* a, QPainter &p, qreal x, int y) const;

    void draw_range(const Annotation* a, QPainter &p, qreal start, qreal end,
        int y, const ViewItemPaintParams &pp, int row_title_width) const;

    void draw_error(QPainter &p, const QString &message, const ViewItemPaintParams &pp);

    void draw_unresolved_period(QPainter &p, int left, int right) const;

    pair<double, double> get_pixels_offset_samples_per_pixel() const;

    pair<uint64_t, uint64_t> get_view_sample_range(int x_start, int x_end) const;

    unsigned int get_row_y(const DecodeTraceRow* row) const;

    DecodeTraceRow* get_row_at_point(const QPoint &point);

    const QString get_annotation_at_point(const QPoint &point);

    void update_stack_button();

    void create_decoder_form(int index, shared_ptr<Decoder> &dec,
        QWidget *parent, QFormLayout *form);

    QComboBox* create_channel_selector(QWidget *parent,
        const data::decode::DecodeChannel *ch);
    QComboBox* create_channel_selector_init_state(QWidget *parent,
        const data::decode::DecodeChannel *ch);

    void export_annotations(deque<const Annotation*>& annotations) const;

    void initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id);
    void update_rows();

    void set_row_expanded(DecodeTraceRow* r);

    void set_row_collapsed(DecodeTraceRow* r);

    void update_expanded_rows();

private Q_SLOTS:
    void on_setting_changed(const QString &key, const QVariant &value);

    void on_color_changed(const QColor &color);

    void on_new_annotations();
    void on_delayed_trace_update();
    void on_decode_reset();
    void on_decode_finished();
    void on_pause_decode();

    void on_delete();

    void on_channel_selected(int);

    void on_channels_updated();

    void on_init_state_changed(int);

    void on_stack_decoder(srd_decoder *decoder);

    void on_delete_decoder(int index);

    void on_show_hide_decoder(int index);
    void on_show_hide_row(int row_id);
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
    void on_show_hide_class(QObject* sender);
#else
    void on_show_hide_class(QWidget* sender);
#endif
    void on_show_all_classes();
    void on_hide_all_classes();
    void on_row_container_resized(QWidget* sender);

    void on_copy_annotation_to_clipboard();

    void on_export_row();
    void on_export_all_rows();
    void on_export_row_with_cursor();
    void on_export_all_rows_with_cursor();
    void on_export_row_from_here();
    void on_export_all_rows_from_here();

    void on_animation_timer();
    void on_hide_hidden_rows();

private:
    pv::Session &session_;
    shared_ptr<data::DecodeSignal> decode_signal_;

    deque<DecodeTraceRow> rows_;
    mutable mutex row_modification_mutex_;

    map<QComboBox*, uint16_t> channel_id_map_;  // channel selector -> decode channel ID
    map<QComboBox*, uint16_t> init_state_map_;  // init state selector -> decode channel ID
    list< shared_ptr<pv::binding::Decoder> > bindings_;

    const Row* selected_row_;
    pair<uint64_t, uint64_t> selected_sample_range_;

    vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
    QPushButton* stack_button_;

    unsigned int default_row_height_, annotation_height_;
    unsigned int visible_rows_;

    int min_useful_label_width_;
    bool always_show_all_rows_, show_hidden_rows_;

    QSignalMapper delete_mapper_, show_hide_mapper_;
    QSignalMapper row_show_hide_mapper_, class_show_hide_mapper_;

    QTimer delayed_trace_updater_, animation_timer_, delayed_hidden_row_hider_;

    QPolygon default_marker_shape_;

#if DECODETRACE_SHOW_RENDER_TIME
    QElapsedTimer render_time_;
#endif
};

} // namespace trace
} // namespace views
} // namespace pv

#endif // PULSEVIEW_PV_VIEWS_TRACE_DECODETRACE_HPP