pv/views/tabular_decoder/view.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2020 Soeren Apel <soeren@apelpie.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_VIEWS_TABULARDECODER_VIEW_HPP
  21 #define PULSEVIEW_PV_VIEWS_TABULARDECODER_VIEW_HPP
  22
  23 #include <QAction>
  24 #include <QCheckBox>
  25 #include <QComboBox>
  26 #include <QTableView>
  27 #include <QToolButton>
  28
  29 #include "pv/metadata_obj.hpp"
  30 #include "pv/views/viewbase.hpp"
  31 #include "pv/data/decodesignal.hpp"
  32
  33 namespace pv {
  34 class Session;
  35
  36 namespace views {
  37
  38 namespace tabular_decoder {
  39
  40 // When adding an entry here, don't forget to update SaveTypeNames as well
  41 enum SaveType {
  42         SaveTypeCSVEscaped,
  43         SaveTypeCSVQuoted,
  44         SaveTypeCount  // Indicates how many save types there are, must always be last
  45 };
  46
  47 // When adding an entry here, don't forget to update ViewModeNames as well
  48 enum ViewModeType {
  49         ViewModeAll,
  50         ViewModeLatest,
  51         ViewModeVisible,
  52         ViewModeCount // Indicates how many view mode types there are, must always be last
  53 };
  54
  55 extern const char* SaveTypeNames[SaveTypeCount];
  56 extern const char* ViewModeNames[ViewModeCount];
  57
  58
  59 class AnnotationCollectionModel : public QAbstractTableModel
  60 {
  61         Q_OBJECT
  62
  63 public:
  64         AnnotationCollectionModel(QObject* parent = nullptr);
  65
  66         int get_hierarchy_level(const Annotation* ann) const;
  67         QVariant data_from_ann(const Annotation* ann, int index) const;
  68         QVariant data(const QModelIndex& index, int role) const override;
  69         Qt::ItemFlags flags(const QModelIndex& index) const override;
  70
  71         QVariant headerData(int section, Qt::Orientation orientation,
  72                 int role = Qt::DisplayRole) const override;
  73         QModelIndex index(int row, int column,
  74                 const QModelIndex& parent_idx = QModelIndex()) const override;
  75
  76         QModelIndex parent(const QModelIndex& index) const override;
  77
  78         int rowCount(const QModelIndex& parent_idx = QModelIndex()) const override;
  79         int columnCount(const QModelIndex& parent_idx = QModelIndex()) const override;
  80
  81         void set_signal_and_segment(data::DecodeSignal* signal, uint32_t current_segment);
  82         void set_sample_range(uint64_t start_sample, uint64_t end_sample);
  83         void set_hide_hidden(bool hide_hidden);
  84
  85         void update_annotations_without_hidden();
  86         void update_highlighted_rows(QModelIndex first, QModelIndex last,
  87                 int64_t sample_num);
  88
  89 private Q_SLOTS:
  90         void on_annotation_visibility_changed();
  91
  92 private:
  93         vector<QVariant> header_data_;
  94         const deque<const Annotation*>* all_annotations_;
  95         deque<const Annotation*> all_annotations_without_hidden_;
  96         const deque<const Annotation*>* dataset_;
  97         data::DecodeSignal* signal_;
  98         uint32_t prev_segment_;
  99         uint64_t prev_last_row_;
 100         uint64_t start_sample_, end_sample_, start_index_, end_index_;
 101         int64_t highlight_sample_num_;
 102         bool had_highlight_before_;
 103         bool hide_hidden_;
 104 };
 105
 106
 107 class QCustomTableView : public QTableView
 108 {
 109         Q_OBJECT
 110
 111 public:
 112         QSize minimumSizeHint() const;
 113         QSize sizeHint() const;
 114 };
 115
 116
 117 class View : public ViewBase, public MetadataObjObserverInterface
 118 {
 119         Q_OBJECT
 120
 121 public:
 122         explicit View(Session &session, bool is_main_view=false, QMainWindow *parent = nullptr);
 123         ~View();
 124
 125         virtual ViewType get_type() const;
 126
 127         /**
 128          * Resets the view to its default state after construction. It does however
 129          * not reset the signal bases or any other connections with the session.
 130          */
 131         virtual void reset_view_state();
 132
 133         virtual void clear_decode_signals();
 134         virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
 135         virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
 136
 137         virtual void save_settings(QSettings &settings) const;
 138         virtual void restore_settings(QSettings &settings);
 139
 140 private:
 141         void reset_data();
 142         void update_data();
 143
 144         void save_data_as_csv(unsigned int save_type) const;
 145
 146 private Q_SLOTS:
 147         void on_selected_decoder_changed(int index);
 148         void on_hide_hidden_changed(bool checked);
 149         void on_view_mode_changed(int index);
 150
 151         void on_signal_name_changed(const QString &name);
 152         void on_signal_color_changed(const QColor &color);
 153         void on_new_annotations();
 154
 155         void on_decoder_reset();
 156         void on_decoder_stacked(void* decoder);
 157         void on_decoder_removed(void* decoder);
 158
 159         void on_actionSave_triggered(QAction* action = nullptr);
 160
 161         void on_table_item_clicked(const QModelIndex& index);
 162         void on_table_item_double_clicked(const QModelIndex& index);
 163         void on_table_header_requested(const QPoint& pos);
 164         void on_table_header_toggled(bool checked);
 165
 166         virtual void on_metadata_object_changed(MetadataObject* obj,
 167                 MetadataValueType value_type);
 168
 169         virtual void perform_delayed_view_update();
 170
 171 private:
 172         QWidget* parent_;
 173
 174         QComboBox* decoder_selector_;
 175         QCheckBox* hide_hidden_cb_;
 176         QComboBox* view_mode_selector_;
 177
 178         QToolButton* save_button_;
 179         QAction* save_action_;
 180
 181         QCustomTableView* table_view_;
 182
 183         AnnotationCollectionModel* model_;
 184
 185         data::DecodeSignal* signal_;
 186         const data::decode::Decoder* decoder_;
 187 };
 188
 189 } // namespace tabular_decoder
 190 } // namespace views
 191 } // namespace pv
 192
 193 #endif // PULSEVIEW_PV_VIEWS_TABULARDECODER_VIEW_HPP