2 * This file is part of the PulseView project.
4 * Copyright (C) 2020 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
23 #include "pv/views/tabular_decoder/view.hpp"
27 #include "pv/util.hpp"
28 #include "pv/globalsettings.hpp"
30 using std::make_shared;
32 using pv::util::Timestamp;
33 using pv::util::format_time_si;
34 using pv::util::format_time_minutes;
35 using pv::util::SIPrefix;
39 namespace tabular_decoder {
41 AnnotationCollectionModel::AnnotationCollectionModel(QObject* parent) :
42 QAbstractTableModel(parent),
43 all_annotations_(nullptr),
52 // TBD Maybe use empty columns as indentation levels to indicate stacked decoders
53 header_data_.emplace_back(tr("Sample")); // Column #0
54 header_data_.emplace_back(tr("Time")); // Column #1
55 header_data_.emplace_back(tr("Decoder")); // Column #2
56 header_data_.emplace_back(tr("Ann Row")); // Column #3
57 header_data_.emplace_back(tr("Ann Class")); // Column #4
58 header_data_.emplace_back(tr("Value")); // Column #5
61 QVariant AnnotationCollectionModel::data_from_ann(const Annotation* ann, int index) const
64 case 0: return QVariant((qulonglong)ann->start_sample()); // Column #0, Start Sample
65 case 1: { // Column #1, Start Time
66 Timestamp t = ann->start_sample() / signal_->get_samplerate();
67 QString unit = signal_->get_samplerate() ? tr("s") : tr("sa");
69 if ((t < 60) || (signal_->get_samplerate() == 0)) // i.e. if unit is sa
70 s = format_time_si(t, SIPrefix::unspecified, 3, unit, false);
72 s = format_time_minutes(t, 3, false);
75 case 2: return QVariant(ann->row()->decoder()->name()); // Column #2, Decoder
76 case 3: return QVariant(ann->row()->description()); // Column #3, Ann Row
77 case 4: return QVariant(ann->ann_class_description()); // Column #4, Ann Class
78 case 5: return QVariant(ann->longest_annotation()); // Column #5, Value
79 default: return QVariant();
83 QVariant AnnotationCollectionModel::data(const QModelIndex& index, int role) const
85 if (!signal_ || !index.isValid() || !index.internalPointer())
88 const Annotation* ann =
89 static_cast<const Annotation*>(index.internalPointer());
91 if ((role == Qt::DisplayRole) || (role == Qt::ToolTipRole))
92 return data_from_ann(ann, index.column());
94 if (role == Qt::BackgroundRole) {
97 const unsigned int ann_stack_level = ann->row_data()->row()->decoder()->get_stack_level();
98 level = (signal_->decoder_stack().size() - 1 - ann_stack_level);
100 // Only use custom cell background color if column index reached the hierarchy level
101 if (index.column() >= level) {
102 if (GlobalSettings::current_theme_is_dark())
103 return QBrush(ann->dark_color());
105 return QBrush(ann->bright_color());
112 Qt::ItemFlags AnnotationCollectionModel::flags(const QModelIndex& index) const
114 if (!index.isValid())
115 return Qt::NoItemFlags;
117 return Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemNeverHasChildren;
120 QVariant AnnotationCollectionModel::headerData(int section, Qt::Orientation orientation,
123 if ((orientation == Qt::Horizontal) && (role == Qt::DisplayRole))
124 return header_data_.at(section);
129 QModelIndex AnnotationCollectionModel::index(int row, int column,
130 const QModelIndex& parent_idx) const
135 if (!dataset_ || (row < 0))
136 return QModelIndex();
140 if (start_index_ == end_index_) {
141 if ((size_t)row < dataset_->size())
142 idx = createIndex(row, column, (void*)dataset_->at(row));
144 if ((size_t)row < (end_index_ - start_index_))
145 idx = createIndex(row, column, (void*)dataset_->at(start_index_ + row));
151 QModelIndex AnnotationCollectionModel::parent(const QModelIndex& index) const
155 return QModelIndex();
158 int AnnotationCollectionModel::rowCount(const QModelIndex& parent_idx) const
165 if (start_index_ == end_index_)
166 return dataset_->size();
168 return (end_index_ - start_index_);
171 int AnnotationCollectionModel::columnCount(const QModelIndex& parent_idx) const
175 return header_data_.size();
178 void AnnotationCollectionModel::set_signal_and_segment(data::DecodeSignal* signal, uint32_t current_segment)
181 all_annotations_ = nullptr;
185 dataChanged(QModelIndex(), QModelIndex());
190 disconnect(this, SLOT(on_annotation_visibility_changed()));
192 all_annotations_ = signal->get_all_annotations_by_segment(current_segment);
195 for (const shared_ptr<Decoder>& dec : signal_->decoder_stack())
196 connect(dec.get(), SIGNAL(annotation_visibility_changed()),
197 this, SLOT(on_annotation_visibility_changed()));
200 update_annotations_without_hidden();
202 dataset_ = all_annotations_;
204 if (!dataset_ || dataset_->empty()) {
205 prev_segment_ = current_segment;
209 // Re-apply the requested sample range
210 set_sample_range(start_sample_, end_sample_);
212 const size_t new_row_count = dataset_->size() - 1;
214 // Force the view associated with this model to update when the segment changes
215 if (prev_segment_ != current_segment) {
216 dataChanged(QModelIndex(), QModelIndex());
219 // Force the view associated with this model to update when we have more annotations
220 if (prev_last_row_ < new_row_count) {
221 dataChanged(index(prev_last_row_, 0), index(new_row_count, 0));
226 prev_segment_ = current_segment;
227 prev_last_row_ = new_row_count;
230 void AnnotationCollectionModel::set_sample_range(uint64_t start_sample, uint64_t end_sample)
232 // Check if there's even anything to reset
233 if ((start_sample == end_sample) && (start_index_ == end_index_))
236 if (!dataset_ || dataset_->empty() || (end_sample == 0)) {
242 dataChanged(QModelIndex(), QModelIndex());
247 start_sample_ = start_sample;
248 end_sample_ = end_sample;
250 // Determine first and last indices into the annotation list
252 bool ann_outside_range;
256 if (i == (int64_t)dataset_->size()) {
260 dataChanged(QModelIndex(), QModelIndex());
264 const Annotation* ann = (*dataset_)[i];
266 ((ann->start_sample() < start_sample) && (ann->end_sample() < start_sample));
267 } while (ann_outside_range);
270 // Ideally, we would be able to set end_index_ to the last annotation that
271 // is within range. However, as annotations in the list are sorted by
272 // start sample and hierarchy level, we may encounter this scenario:
273 // [long annotation that spans across view]
274 // [short annotations that aren't seen]
275 // [short annotations that are seen]
276 // ..in which our output would only show the first long annotations.
277 // For this reason, we simply show everything after the first visible
278 // annotation for now.
280 end_index_ = dataset_->size();
282 dataChanged(index(0, 0), index((end_index_ - start_index_), 0));
286 void AnnotationCollectionModel::set_hide_hidden(bool hide_hidden)
288 hide_hidden_ = hide_hidden;
291 dataset_ = &all_annotations_without_hidden_;
292 update_annotations_without_hidden();
294 dataset_ = all_annotations_;
295 all_annotations_without_hidden_.clear(); // To conserve memory
298 // Re-apply the requested sample range
299 set_sample_range(start_sample_, end_sample_);
302 dataChanged(index(0, 0), index(dataset_->size(), 0));
304 dataChanged(QModelIndex(), QModelIndex());
309 void AnnotationCollectionModel::update_annotations_without_hidden()
313 if (!all_annotations_ || all_annotations_->empty()) {
314 all_annotations_without_hidden_.clear();
318 for (const Annotation* ann : *all_annotations_) {
322 if (all_annotations_without_hidden_.size() < (count + 100))
323 all_annotations_without_hidden_.resize(count + 100);
325 all_annotations_without_hidden_[count++] = ann;
328 all_annotations_without_hidden_.resize(count);
331 void AnnotationCollectionModel::on_annotation_visibility_changed()
336 update_annotations_without_hidden();
338 // Re-apply the requested sample range
339 set_sample_range(start_sample_, end_sample_);
342 dataChanged(index(0, 0), index(dataset_->size(), 0));
344 dataChanged(QModelIndex(), QModelIndex());
349 } // namespace tabular_decoder