]> sigrok.org Git - pulseview.git/blame - pv/views/tabular_decoder/model.cpp
Session: Fix issue #67 by improving error handling
[pulseview.git] / pv / views / tabular_decoder / model.cpp
CommitLineData
24d69d27
SA
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
1c521100 20#include <QApplication>
f54e68b0 21#include <QDebug>
24d69d27
SA
22#include <QString>
23
24#include "pv/views/tabular_decoder/view.hpp"
25
d656b010
SA
26#include "view.hpp"
27
85125b0f 28#include "pv/util.hpp"
8e168b23 29#include "pv/globalsettings.hpp"
85125b0f 30
24d69d27
SA
31using std::make_shared;
32
85125b0f
SA
33using pv::util::Timestamp;
34using pv::util::format_time_si;
35using pv::util::format_time_minutes;
36using pv::util::SIPrefix;
37
24d69d27
SA
38namespace pv {
39namespace views {
40namespace tabular_decoder {
41
42AnnotationCollectionModel::AnnotationCollectionModel(QObject* parent) :
f54e68b0
SA
43 QAbstractTableModel(parent),
44 all_annotations_(nullptr),
86d4b8e3 45 dataset_(nullptr),
d656b010 46 signal_(nullptr),
6f43db70 47 first_hidden_column_(0),
f54e68b0 48 prev_segment_(0),
86d4b8e3 49 prev_last_row_(0),
1c521100 50 had_highlight_before_(false),
86d4b8e3 51 hide_hidden_(false)
24d69d27 52{
6f43db70
SA
53 // Note: when adding entries, consider ViewVisibleFilterProxyModel::filterAcceptsRow()
54
55 uint8_t i = 0;
56 header_data_.emplace_back(tr("Sample")); i++; // Column #0
57 header_data_.emplace_back(tr("Time")); i++; // Column #1
58 header_data_.emplace_back(tr("Decoder")); i++; // Column #2
59 header_data_.emplace_back(tr("Ann Row")); i++; // Column #3
60 header_data_.emplace_back(tr("Ann Class")); i++; // Column #4
61 header_data_.emplace_back(tr("Value")); i++; // Column #5
62
63 first_hidden_column_ = i;
64 header_data_.emplace_back("End Sample"); // Column #6, hidden
24d69d27
SA
65}
66
1c521100
SA
67int AnnotationCollectionModel::get_hierarchy_level(const Annotation* ann) const
68{
69 int level = 0;
70
71 const unsigned int ann_stack_level = ann->row_data()->row()->decoder()->get_stack_level();
72 level = (signal_->decoder_stack().size() - 1 - ann_stack_level);
73
74 return level;
75}
76
85125b0f
SA
77QVariant AnnotationCollectionModel::data_from_ann(const Annotation* ann, int index) const
78{
79 switch (index) {
80 case 0: return QVariant((qulonglong)ann->start_sample()); // Column #0, Start Sample
81 case 1: { // Column #1, Start Time
82 Timestamp t = ann->start_sample() / signal_->get_samplerate();
83 QString unit = signal_->get_samplerate() ? tr("s") : tr("sa");
84 QString s;
85 if ((t < 60) || (signal_->get_samplerate() == 0)) // i.e. if unit is sa
86 s = format_time_si(t, SIPrefix::unspecified, 3, unit, false);
87 else
88 s = format_time_minutes(t, 3, false);
89 return QVariant(s);
90 }
91 case 2: return QVariant(ann->row()->decoder()->name()); // Column #2, Decoder
92 case 3: return QVariant(ann->row()->description()); // Column #3, Ann Row
93 case 4: return QVariant(ann->ann_class_description()); // Column #4, Ann Class
94 case 5: return QVariant(ann->longest_annotation()); // Column #5, Value
6f43db70 95 case 6: return QVariant((qulonglong)ann->end_sample()); // Column #6, End Sample
85125b0f
SA
96 default: return QVariant();
97 }
98}
99
24d69d27
SA
100QVariant AnnotationCollectionModel::data(const QModelIndex& index, int role) const
101{
6d46525f 102 if (!signal_ || !index.isValid() || !index.internalPointer())
24d69d27
SA
103 return QVariant();
104
88a25978
SA
105 const Annotation* ann =
106 static_cast<const Annotation*>(index.internalPointer());
f54e68b0 107
85125b0f
SA
108 if ((role == Qt::DisplayRole) || (role == Qt::ToolTipRole))
109 return data_from_ann(ann, index.column());
24d69d27 110
1c521100
SA
111 if (role == Qt::ForegroundRole) {
112 if (index.column() >= get_hierarchy_level(ann)) {
113 // Invert the text color if this cell is highlighted
114 const bool must_highlight = (highlight_sample_num_ > 0) &&
115 ((int64_t)ann->start_sample() <= highlight_sample_num_) &&
116 ((int64_t)ann->end_sample() >= highlight_sample_num_);
117
118 if (must_highlight) {
119 if (GlobalSettings::current_theme_is_dark())
120 return QApplication::palette().brush(QPalette::Window);
121 else
122 return QApplication::palette().brush(QPalette::WindowText);
123 }
124 }
d656b010 125
1c521100
SA
126 return QApplication::palette().brush(QPalette::WindowText);
127 }
d656b010 128
1c521100 129 if (role == Qt::BackgroundRole) {
d656b010 130 // Only use custom cell background color if column index reached the hierarchy level
1c521100
SA
131 if (index.column() >= get_hierarchy_level(ann)) {
132
133 QColor color;
134 const bool must_highlight = (highlight_sample_num_ > 0) &&
135 ((int64_t)ann->start_sample() <= highlight_sample_num_) &&
136 ((int64_t)ann->end_sample() >= highlight_sample_num_);
137
138 if (must_highlight)
139 color = ann->color();
d656b010 140 else
1c521100
SA
141 color = GlobalSettings::current_theme_is_dark() ?
142 ann->dark_color() : ann->bright_color();
143
144 return QBrush(color);
d656b010 145 }
88a25978
SA
146 }
147
24d69d27
SA
148 return QVariant();
149}
150
151Qt::ItemFlags AnnotationCollectionModel::flags(const QModelIndex& index) const
152{
153 if (!index.isValid())
9a35b05d 154 return Qt::NoItemFlags;
24d69d27 155
9a35b05d 156 return Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemNeverHasChildren;
24d69d27
SA
157}
158
6f43db70
SA
159uint8_t AnnotationCollectionModel::first_hidden_column() const
160{
161 return first_hidden_column_;
162}
163
24d69d27
SA
164QVariant AnnotationCollectionModel::headerData(int section, Qt::Orientation orientation,
165 int role) const
166{
6f2f5d25
SA
167 if ((section < 0) || (section >= (int)header_data_.size()))
168 return QVariant();
169
6d46525f 170 if ((orientation == Qt::Horizontal) && (role == Qt::DisplayRole))
6f2f5d25 171 return header_data_[section];
24d69d27
SA
172
173 return QVariant();
174}
175
176QModelIndex AnnotationCollectionModel::index(int row, int column,
177 const QModelIndex& parent_idx) const
178{
f54e68b0 179 (void)parent_idx;
6d46525f 180 assert(column >= 0);
24d69d27 181
593ea025 182 if (!dataset_ || (row < 0))
f54e68b0 183 return QModelIndex();
24d69d27 184
86d4b8e3
SA
185 QModelIndex idx;
186
6f43db70
SA
187 if ((size_t)row < dataset_->size())
188 idx = createIndex(row, column, (void*)dataset_->at(row));
24d69d27 189
86d4b8e3 190 return idx;
24d69d27
SA
191}
192
193QModelIndex AnnotationCollectionModel::parent(const QModelIndex& index) const
194{
f54e68b0 195 (void)index;
24d69d27 196
f54e68b0 197 return QModelIndex();
24d69d27
SA
198}
199
200int AnnotationCollectionModel::rowCount(const QModelIndex& parent_idx) const
201{
f54e68b0 202 (void)parent_idx;
24d69d27 203
86d4b8e3 204 if (!dataset_)
24d69d27
SA
205 return 0;
206
6f43db70 207 return dataset_->size();
24d69d27
SA
208}
209
210int AnnotationCollectionModel::columnCount(const QModelIndex& parent_idx) const
211{
f54e68b0
SA
212 (void)parent_idx;
213
214 return header_data_.size();
24d69d27
SA
215}
216
f54e68b0
SA
217void AnnotationCollectionModel::set_signal_and_segment(data::DecodeSignal* signal, uint32_t current_segment)
218{
49a0a403
SA
219 layoutAboutToBeChanged();
220
88a25978
SA
221 if (!signal) {
222 all_annotations_ = nullptr;
86d4b8e3 223 dataset_ = nullptr;
d656b010 224 signal_ = nullptr;
86d4b8e3 225
88a25978
SA
226 dataChanged(QModelIndex(), QModelIndex());
227 layoutChanged();
228 return;
229 }
230
c2594005
SA
231 if (signal_)
232 for (const shared_ptr<Decoder>& dec : signal_->decoder_stack())
233 disconnect(dec.get(), nullptr, this, SLOT(on_annotation_visibility_changed()));
02078aa1 234
f54e68b0 235 all_annotations_ = signal->get_all_annotations_by_segment(current_segment);
d656b010 236 signal_ = signal;
f54e68b0 237
02078aa1
SA
238 for (const shared_ptr<Decoder>& dec : signal_->decoder_stack())
239 connect(dec.get(), SIGNAL(annotation_visibility_changed()),
240 this, SLOT(on_annotation_visibility_changed()));
241
b36ba611 242 if (hide_hidden_) {
86d4b8e3 243 update_annotations_without_hidden();
b36ba611
SA
244 dataset_ = &all_annotations_without_hidden_;
245 } else
86d4b8e3
SA
246 dataset_ = all_annotations_;
247
248 if (!dataset_ || dataset_->empty()) {
f54e68b0
SA
249 prev_segment_ = current_segment;
250 return;
251 }
252
86d4b8e3 253 const size_t new_row_count = dataset_->size() - 1;
f54e68b0
SA
254
255 // Force the view associated with this model to update when the segment changes
256 if (prev_segment_ != current_segment) {
6f43db70 257 dataChanged(index(0, 0), index(new_row_count, 0));
f54e68b0
SA
258 layoutChanged();
259 } else {
260 // Force the view associated with this model to update when we have more annotations
261 if (prev_last_row_ < new_row_count) {
c84afcfd 262 dataChanged(index(prev_last_row_, 0), index(new_row_count, 0));
f54e68b0
SA
263 layoutChanged();
264 }
265 }
266
267 prev_segment_ = current_segment;
268 prev_last_row_ = new_row_count;
269}
24d69d27 270
86d4b8e3
SA
271void AnnotationCollectionModel::set_hide_hidden(bool hide_hidden)
272{
49a0a403
SA
273 layoutAboutToBeChanged();
274
86d4b8e3
SA
275 hide_hidden_ = hide_hidden;
276
277 if (hide_hidden_) {
278 dataset_ = &all_annotations_without_hidden_;
279 update_annotations_without_hidden();
280 } else {
281 dataset_ = all_annotations_;
282 all_annotations_without_hidden_.clear(); // To conserve memory
283 }
8997f62a 284
8997f62a 285 if (dataset_)
6f43db70 286 dataChanged(index(0, 0), index(dataset_->size() - 1, 0));
8997f62a
SA
287 else
288 dataChanged(QModelIndex(), QModelIndex());
289
290 layoutChanged();
86d4b8e3
SA
291}
292
293void AnnotationCollectionModel::update_annotations_without_hidden()
294{
295 uint64_t count = 0;
296
297 if (!all_annotations_ || all_annotations_->empty()) {
298 all_annotations_without_hidden_.clear();
299 return;
300 }
301
302 for (const Annotation* ann : *all_annotations_) {
303 if (!ann->visible())
304 continue;
305
306 if (all_annotations_without_hidden_.size() < (count + 100))
307 all_annotations_without_hidden_.resize(count + 100);
308
309 all_annotations_without_hidden_[count++] = ann;
310 }
311
312 all_annotations_without_hidden_.resize(count);
86d4b8e3
SA
313}
314
6f43db70 315QModelIndex AnnotationCollectionModel::update_highlighted_rows(QModelIndex first,
1c521100
SA
316 QModelIndex last, int64_t sample_num)
317{
318 bool has_highlight = false;
6f43db70 319 QModelIndex result;
1c521100
SA
320
321 highlight_sample_num_ = sample_num;
322
323 if (!dataset_ || dataset_->empty())
6f43db70 324 return result;
1c521100
SA
325
326 if (sample_num >= 0) {
327 last = last.sibling(last.row() + 1, 0);
328
329 // Check if there are any annotations visible in the table view that
330 // we would need to highlight - only then do we do so
331 QModelIndex index = first;
332 do {
4d0f333a
SA
333 const Annotation* ann = static_cast<const Annotation*>(index.internalPointer());
334 if (!ann) // Can happen if the table is being modified at this exact time
335 return result;
1c521100
SA
336
337 if (((int64_t)ann->start_sample() <= sample_num) &&
338 ((int64_t)ann->end_sample() >= sample_num)) {
6f43db70 339 result = index;
1c521100
SA
340 has_highlight = true;
341 break;
342 }
343
344 index = index.sibling(index.row() + 1, 0);
345 } while (index != last);
346 }
347
49a0a403 348 if (has_highlight || had_highlight_before_)
1c521100
SA
349 dataChanged(first, last);
350
351 had_highlight_before_ = has_highlight;
6f43db70
SA
352
353 return result;
1c521100
SA
354}
355
02078aa1
SA
356void AnnotationCollectionModel::on_annotation_visibility_changed()
357{
358 if (!hide_hidden_)
359 return;
360
49a0a403
SA
361 layoutAboutToBeChanged();
362
02078aa1
SA
363 update_annotations_without_hidden();
364
02078aa1 365 if (dataset_)
6f43db70 366 dataChanged(index(0, 0), index(dataset_->size() - 1, 0));
02078aa1
SA
367 else
368 dataChanged(QModelIndex(), QModelIndex());
369
370 layoutChanged();
371}
372
24d69d27
SA
373} // namespace tabular_decoder
374} // namespace views
375} // namespace pv