pv/views/tabular_decoder/model.cpp

   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 #include <QApplication>
  21 #include <QDebug>
  22 #include <QString>
  23
  24 #include "pv/views/tabular_decoder/view.hpp"
  25
  26 #include "view.hpp"
  27
  28 #include "pv/util.hpp"
  29 #include "pv/globalsettings.hpp"
  30
  31 using std::make_shared;
  32
  33 using pv::util::Timestamp;
  34 using pv::util::format_time_si;
  35 using pv::util::format_time_minutes;
  36 using pv::util::SIPrefix;
  37
  38 namespace pv {
  39 namespace views {
  40 namespace tabular_decoder {
  41
  42 AnnotationCollectionModel::AnnotationCollectionModel(QObject* parent) :
  43         QAbstractTableModel(parent),
  44         all_annotations_(nullptr),
  45         dataset_(nullptr),
  46         signal_(nullptr),
  47         first_hidden_column_(0),
  48         prev_segment_(0),
  49         prev_last_row_(0),
  50         had_highlight_before_(false),
  51         hide_hidden_(false)
  52 {
  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
  65 }
  66
  67 int 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
  77 QVariant 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
  95         case 6: return QVariant((qulonglong)ann->end_sample());    // Column #6, End Sample
  96         default: return QVariant();
  97         }
  98 }
  99
 100 QVariant AnnotationCollectionModel::data(const QModelIndex& index, int role) const
 101 {
 102         if (!signal_ || !index.isValid() || !index.internalPointer())
 103                 return QVariant();
 104
 105         const Annotation* ann =
 106                 static_cast<const Annotation*>(index.internalPointer());
 107
 108         if ((role == Qt::DisplayRole) || (role == Qt::ToolTipRole))
 109                 return data_from_ann(ann, index.column());
 110
 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                 }
 125
 126                 return QApplication::palette().brush(QPalette::WindowText);
 127         }
 128
 129         if (role == Qt::BackgroundRole) {
 130                 // Only use custom cell background color if column index reached the hierarchy level
 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();
 140                         else
 141                                 color = GlobalSettings::current_theme_is_dark() ?
 142                                         ann->dark_color() : ann->bright_color();
 143
 144                         return QBrush(color);
 145                 }
 146         }
 147
 148         return QVariant();
 149 }
 150
 151 Qt::ItemFlags AnnotationCollectionModel::flags(const QModelIndex& index) const
 152 {
 153         if (!index.isValid())
 154                 return Qt::NoItemFlags;
 155
 156         return Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemNeverHasChildren;
 157 }
 158
 159 uint8_t AnnotationCollectionModel::first_hidden_column() const
 160 {
 161         return first_hidden_column_;
 162 }
 163
 164 QVariant AnnotationCollectionModel::headerData(int section, Qt::Orientation orientation,
 165         int role) const
 166 {
 167         if ((section < 0) || (section >= (int)header_data_.size()))
 168                 return QVariant();
 169
 170         if ((orientation == Qt::Horizontal) && (role == Qt::DisplayRole))
 171                 return header_data_[section];
 172
 173         return QVariant();
 174 }
 175
 176 QModelIndex AnnotationCollectionModel::index(int row, int column,
 177         const QModelIndex& parent_idx) const
 178 {
 179         (void)parent_idx;
 180         assert(column >= 0);
 181
 182         if (!dataset_ || (row < 0))
 183                 return QModelIndex();
 184
 185         QModelIndex idx;
 186
 187         if ((size_t)row < dataset_->size())
 188                 idx = createIndex(row, column, (void*)dataset_->at(row));
 189
 190         return idx;
 191 }
 192
 193 QModelIndex AnnotationCollectionModel::parent(const QModelIndex& index) const
 194 {
 195         (void)index;
 196
 197         return QModelIndex();
 198 }
 199
 200 int AnnotationCollectionModel::rowCount(const QModelIndex& parent_idx) const
 201 {
 202         (void)parent_idx;
 203
 204         if (!dataset_)
 205                 return 0;
 206
 207         return dataset_->size();
 208 }
 209
 210 int AnnotationCollectionModel::columnCount(const QModelIndex& parent_idx) const
 211 {
 212         (void)parent_idx;
 213
 214         return header_data_.size();
 215 }
 216
 217 void AnnotationCollectionModel::set_signal_and_segment(data::DecodeSignal* signal, uint32_t current_segment)
 218 {
 219         layoutAboutToBeChanged();
 220
 221         if (!signal) {
 222                 all_annotations_ = nullptr;
 223                 dataset_ = nullptr;
 224                 signal_ = nullptr;
 225
 226                 dataChanged(QModelIndex(), QModelIndex());
 227                 layoutChanged();
 228                 return;
 229         }
 230
 231         disconnect(this, SLOT(on_annotation_visibility_changed()));
 232
 233         all_annotations_ = signal->get_all_annotations_by_segment(current_segment);
 234         signal_ = signal;
 235
 236         for (const shared_ptr<Decoder>& dec : signal_->decoder_stack())
 237                 connect(dec.get(), SIGNAL(annotation_visibility_changed()),
 238                         this, SLOT(on_annotation_visibility_changed()));
 239
 240         if (hide_hidden_) {
 241                 update_annotations_without_hidden();
 242                 dataset_ = &all_annotations_without_hidden_;
 243         } else
 244                 dataset_ = all_annotations_;
 245
 246         if (!dataset_ || dataset_->empty()) {
 247                 prev_segment_ = current_segment;
 248                 return;
 249         }
 250
 251         const size_t new_row_count = dataset_->size() - 1;
 252
 253         // Force the view associated with this model to update when the segment changes
 254         if (prev_segment_ != current_segment) {
 255                 dataChanged(index(0, 0), index(new_row_count, 0));
 256                 layoutChanged();
 257         } else {
 258                 // Force the view associated with this model to update when we have more annotations
 259                 if (prev_last_row_ < new_row_count) {
 260                         dataChanged(index(prev_last_row_, 0), index(new_row_count, 0));
 261                         layoutChanged();
 262                 }
 263         }
 264
 265         prev_segment_ = current_segment;
 266         prev_last_row_ = new_row_count;
 267 }
 268
 269 void AnnotationCollectionModel::set_hide_hidden(bool hide_hidden)
 270 {
 271         layoutAboutToBeChanged();
 272
 273         hide_hidden_ = hide_hidden;
 274
 275         if (hide_hidden_) {
 276                 dataset_ = &all_annotations_without_hidden_;
 277                 update_annotations_without_hidden();
 278         } else {
 279                 dataset_ = all_annotations_;
 280                 all_annotations_without_hidden_.clear();  // To conserve memory
 281         }
 282
 283         if (dataset_)
 284                 dataChanged(index(0, 0), index(dataset_->size() - 1, 0));
 285         else
 286                 dataChanged(QModelIndex(), QModelIndex());
 287
 288         layoutChanged();
 289 }
 290
 291 void AnnotationCollectionModel::update_annotations_without_hidden()
 292 {
 293         uint64_t count = 0;
 294
 295         if (!all_annotations_ || all_annotations_->empty()) {
 296                 all_annotations_without_hidden_.clear();
 297                 return;
 298         }
 299
 300         for (const Annotation* ann : *all_annotations_) {
 301                 if (!ann->visible())
 302                         continue;
 303
 304                 if (all_annotations_without_hidden_.size() < (count + 100))
 305                         all_annotations_without_hidden_.resize(count + 100);
 306
 307                 all_annotations_without_hidden_[count++] = ann;
 308         }
 309
 310         all_annotations_without_hidden_.resize(count);
 311 }
 312
 313 QModelIndex AnnotationCollectionModel::update_highlighted_rows(QModelIndex first,
 314         QModelIndex last, int64_t sample_num)
 315 {
 316         bool has_highlight = false;
 317         QModelIndex result;
 318
 319         highlight_sample_num_ = sample_num;
 320
 321         if (!dataset_ || dataset_->empty())
 322                 return result;
 323
 324         if (sample_num >= 0) {
 325                 last = last.sibling(last.row() + 1, 0);
 326
 327                 // Check if there are any annotations visible in the table view that
 328                 // we would need to highlight - only then do we do so
 329                 QModelIndex index = first;
 330                 do {
 331                         const Annotation* ann = static_cast<const Annotation*>(index.internalPointer());
 332                         if (!ann)  // Can happen if the table is being modified at this exact time
 333                                 return result;
 334
 335                         if (((int64_t)ann->start_sample() <= sample_num) &&
 336                                 ((int64_t)ann->end_sample() >= sample_num)) {
 337                                 result = index;
 338                                 has_highlight = true;
 339                                 break;
 340                         }
 341
 342                         index = index.sibling(index.row() + 1, 0);
 343                 } while (index != last);
 344         }
 345
 346         if (has_highlight || had_highlight_before_)
 347                 dataChanged(first, last);
 348
 349         had_highlight_before_ = has_highlight;
 350
 351         return result;
 352 }
 353
 354 void AnnotationCollectionModel::on_annotation_visibility_changed()
 355 {
 356         if (!hide_hidden_)
 357                 return;
 358
 359         layoutAboutToBeChanged();
 360
 361         update_annotations_without_hidden();
 362
 363         if (dataset_)
 364                 dataChanged(index(0, 0), index(dataset_->size() - 1, 0));
 365         else
 366                 dataChanged(QModelIndex(), QModelIndex());
 367
 368         layoutChanged();
 369 }
 370
 371 } // namespace tabular_decoder
 372 } // namespace views
 373 } // namespace pv