TabularDecView: Some fixes and refactorings
[pulseview.git] / 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_TABULAR_DECODER_VIEW_HPP
21 #define PULSEVIEW_PV_VIEWS_TABULAR_DECODER_VIEW_HPP
22
23 #include <QAction>
24 #include <QCheckBox>
25 #include <QComboBox>
26 #include <QSortFilterProxyModel>
27 #include <QTableView>
28 #include <QToolButton>
29
30 #include "pv/metadata_obj.hpp"
31 #include "pv/views/viewbase.hpp"
32 #include "pv/data/decodesignal.hpp"
33
34 namespace pv {
35 class Session;
36
37 namespace views {
38
39 namespace tabular_decoder {
40
41 // When adding an entry here, don't forget to update SaveTypeNames as well
42 enum SaveType {
43         SaveTypeCSVEscaped,
44         SaveTypeCSVQuoted,
45         SaveTypeCount  // Indicates how many save types there are, must always be last
46 };
47
48 // When adding an entry here, don't forget to update ViewModeNames as well
49 enum ViewModeType {
50         ViewModeAll,
51         ViewModeLatest,
52         ViewModeVisible,
53         ViewModeCount // Indicates how many view mode types there are, must always be last
54 };
55
56 extern const char* SaveTypeNames[SaveTypeCount];
57 extern const char* ViewModeNames[ViewModeCount];
58
59
60 class AnnotationCollectionModel : public QAbstractTableModel
61 {
62         Q_OBJECT
63
64 public:
65         AnnotationCollectionModel(QObject* parent = nullptr);
66
67         int get_hierarchy_level(const Annotation* ann) const;
68         QVariant data_from_ann(const Annotation* ann, int index) const;
69         QVariant data(const QModelIndex& index, int role) const override;
70         Qt::ItemFlags flags(const QModelIndex& index) const override;
71
72         uint8_t first_hidden_column() const;
73         QVariant headerData(int section, Qt::Orientation orientation,
74                 int role = Qt::DisplayRole) const override;
75         QModelIndex index(int row, int column,
76                 const QModelIndex& parent_idx = QModelIndex()) const override;
77
78         QModelIndex parent(const QModelIndex& index) const override;
79
80         int rowCount(const QModelIndex& parent_idx = QModelIndex()) const override;
81         int columnCount(const QModelIndex& parent_idx = QModelIndex()) const override;
82
83         void set_signal_and_segment(data::DecodeSignal* signal, uint32_t current_segment);
84         void set_hide_hidden(bool hide_hidden);
85
86         void update_annotations_without_hidden();
87         QModelIndex update_highlighted_rows(QModelIndex first, QModelIndex last,
88                 int64_t sample_num);
89
90 private Q_SLOTS:
91         void on_annotation_visibility_changed();
92
93 private:
94         vector<QVariant> header_data_;
95         const deque<const Annotation*>* all_annotations_;
96         deque<const Annotation*> all_annotations_without_hidden_;
97         const deque<const Annotation*>* dataset_;
98         data::DecodeSignal* signal_;
99         uint8_t first_hidden_column_;
100         uint32_t prev_segment_;
101         uint64_t prev_last_row_;
102         int64_t highlight_sample_num_;
103         bool had_highlight_before_;
104         bool hide_hidden_;
105 };
106
107
108 class CustomFilterProxyModel : public QSortFilterProxyModel
109 {
110         Q_OBJECT
111
112 public:
113         CustomFilterProxyModel(QObject* parent = 0);
114
115         void set_sample_range(uint64_t start_sample, uint64_t end_sample);
116
117         void enable_range_filtering(bool value);
118
119 protected:
120         bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
121
122 private:
123         uint64_t range_start_sample_, range_end_sample_;
124         bool range_filtering_enabled_;
125 };
126
127
128 class CustomTableView : public QTableView
129 {
130         Q_OBJECT
131
132 public:
133         QSize minimumSizeHint() const;
134         QSize sizeHint() const;
135 };
136
137
138 class View : public ViewBase, public MetadataObjObserverInterface
139 {
140         Q_OBJECT
141
142 public:
143         explicit View(Session &session, bool is_main_view=false, QMainWindow *parent = nullptr);
144         ~View();
145
146         virtual ViewType get_type() const;
147
148         /**
149          * Resets the view to its default state after construction. It does however
150          * not reset the signal bases or any other connections with the session.
151          */
152         virtual void reset_view_state();
153
154         virtual void clear_decode_signals();
155         virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
156         virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
157
158         virtual void save_settings(QSettings &settings) const;
159         virtual void restore_settings(QSettings &settings);
160
161 private:
162         void reset_data();
163         void update_data();
164
165         void save_data_as_csv(unsigned int save_type) const;
166
167 private Q_SLOTS:
168         void on_selected_decoder_changed(int index);
169         void on_hide_hidden_changed(bool checked);
170         void on_view_mode_changed(int index);
171
172         void on_signal_name_changed(const QString &name);
173         void on_signal_color_changed(const QColor &color);
174         void on_new_annotations();
175
176         void on_decoder_reset();
177         void on_decoder_stacked(void* decoder);
178         void on_decoder_removed(void* decoder);
179
180         void on_actionSave_triggered(QAction* action = nullptr);
181
182         void on_table_item_clicked(const QModelIndex& index);
183         void on_table_item_double_clicked(const QModelIndex& index);
184         void on_table_header_requested(const QPoint& pos);
185         void on_table_header_toggled(bool checked);
186
187         virtual void on_metadata_object_changed(MetadataObject* obj,
188                 MetadataValueType value_type);
189
190         virtual void perform_delayed_view_update();
191
192 private:
193         QWidget* parent_;
194
195         QComboBox* decoder_selector_;
196         QCheckBox* hide_hidden_cb_;
197         QComboBox* view_mode_selector_;
198
199         QToolButton* save_button_;
200         QAction* save_action_;
201
202         CustomTableView* table_view_;
203         AnnotationCollectionModel* model_;
204         CustomFilterProxyModel* filter_proxy_model_;
205
206         data::DecodeSignal* signal_;
207         const data::decode::Decoder* decoder_;
208 };
209
210 } // namespace tabular_decoder
211 } // namespace views
212 } // namespace pv
213
214 #endif // PULSEVIEW_PV_VIEWS_TABULAR_DECODER_VIEW_HPP