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/>.
22 #include <QApplication>
24 #include <QFileDialog>
25 #include <QFontMetrics>
26 #include <QHeaderView>
29 #include <QMessageBox>
31 #include <QVBoxLayout>
33 #include <libsigrokdecode/libsigrokdecode.h>
37 #include "pv/globalsettings.hpp"
38 #include "pv/session.hpp"
39 #include "pv/util.hpp"
40 #include "pv/data/decode/decoder.hpp"
42 using pv::data::DecodeSignal;
43 using pv::data::SignalBase;
44 using pv::data::decode::Decoder;
45 using pv::util::Timestamp;
47 using std::make_shared;
49 using std::shared_ptr;
53 namespace tabular_decoder {
55 const char* SaveTypeNames[SaveTypeCount] = {
56 "CSV, commas escaped",
60 const char* ViewModeNames[ViewModeCount] = {
62 "Show all and focus on newest",
63 "Show visible in main view"
67 CustomFilterProxyModel::CustomFilterProxyModel(QObject* parent) :
68 QSortFilterProxyModel(parent),
69 range_filtering_enabled_(false)
73 bool CustomFilterProxyModel::filterAcceptsRow(int sourceRow,
74 const QModelIndex &sourceParent) const
77 assert(sourceModel() != nullptr);
81 if (range_filtering_enabled_) {
82 const QModelIndex ann_start_sample_idx = sourceModel()->index(sourceRow, 0);
83 const uint64_t ann_start_sample =
84 sourceModel()->data(ann_start_sample_idx, Qt::DisplayRole).toULongLong();
86 const QModelIndex ann_end_sample_idx = sourceModel()->index(sourceRow, 6);
87 const uint64_t ann_end_sample =
88 sourceModel()->data(ann_end_sample_idx, Qt::DisplayRole).toULongLong();
90 // We consider all annotations as visible that either
91 // a) begin to the left of the range and end within the range or
92 // b) begin and end within the range or
93 // c) begin within the range and end to the right of the range
94 // ...which is equivalent to the negation of "begins and ends outside the range"
96 const bool left_of_range = (ann_end_sample < range_start_sample_);
97 const bool right_of_range = (ann_start_sample > range_end_sample_);
98 const bool entirely_outside_of_range = left_of_range || right_of_range;
100 result = !entirely_outside_of_range;
106 void CustomFilterProxyModel::set_sample_range(uint64_t start_sample,
109 range_start_sample_ = start_sample;
110 range_end_sample_ = end_sample;
115 void CustomFilterProxyModel::enable_range_filtering(bool value)
117 range_filtering_enabled_ = value;
123 QSize CustomTableView::minimumSizeHint() const
125 QSize size(QTableView::sizeHint());
128 for (int i = 0; i < horizontalHeader()->count(); i++)
129 if (!horizontalHeader()->isSectionHidden(i))
130 width += horizontalHeader()->sectionSize(i);
132 size.setWidth(width + (horizontalHeader()->count() * 1));
137 QSize CustomTableView::sizeHint() const
139 return minimumSizeHint();
142 void CustomTableView::keyPressEvent(QKeyEvent *event)
144 if ((event->key() == Qt::Key_Return) || (event->key() == Qt::Key_Enter))
145 activatedByKey(currentIndex());
147 QTableView::keyPressEvent(event);
151 View::View(Session &session, bool is_main_view, QMainWindow *parent) :
152 ViewBase(session, is_main_view, parent),
154 // Note: Place defaults in View::reset_view_state(), not here
156 decoder_selector_(new QComboBox()),
157 hide_hidden_cb_(new QCheckBox()),
158 view_mode_selector_(new QComboBox()),
159 save_button_(new QToolButton()),
160 save_action_(new QAction(this)),
161 table_view_(new CustomTableView()),
162 model_(new AnnotationCollectionModel(this)),
163 filter_proxy_model_(new CustomFilterProxyModel(this)),
166 QVBoxLayout *root_layout = new QVBoxLayout(this);
167 root_layout->setContentsMargins(0, 0, 0, 0);
168 root_layout->addWidget(table_view_);
171 QToolBar* toolbar = new QToolBar();
172 toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
173 parent->addToolBar(toolbar);
176 toolbar->addWidget(new QLabel(tr("Decoder:")));
177 toolbar->addWidget(decoder_selector_);
178 toolbar->addSeparator();
179 toolbar->addWidget(save_button_);
180 toolbar->addSeparator();
181 toolbar->addWidget(view_mode_selector_);
182 toolbar->addSeparator();
183 toolbar->addWidget(hide_hidden_cb_);
185 connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
186 this, SLOT(on_selected_decoder_changed(int)));
187 connect(view_mode_selector_, SIGNAL(currentIndexChanged(int)),
188 this, SLOT(on_view_mode_changed(int)));
189 connect(hide_hidden_cb_, SIGNAL(toggled(bool)),
190 this, SLOT(on_hide_hidden_changed(bool)));
193 decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
195 for (int i = 0; i < ViewModeCount; i++)
196 view_mode_selector_->addItem(ViewModeNames[i], QVariant::fromValue(i));
198 hide_hidden_cb_->setText(tr("Hide Hidden Rows/Classes"));
199 hide_hidden_cb_->setChecked(true);
202 save_action_->setText(tr("&Save..."));
203 save_action_->setIcon(QIcon::fromTheme("document-save-as",
204 QIcon(":/icons/document-save-as.png")));
205 #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
206 save_action_->setShortcut(QKeySequence(Qt::CTRL | Qt::Key_S));
208 save_action_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
210 connect(save_action_, SIGNAL(triggered(bool)),
211 this, SLOT(on_actionSave_triggered()));
213 QMenu *save_menu = new QMenu();
214 connect(save_menu, SIGNAL(triggered(QAction*)),
215 this, SLOT(on_actionSave_triggered(QAction*)));
217 for (int i = 0; i < SaveTypeCount; i++) {
218 QAction *const action = save_menu->addAction(tr(SaveTypeNames[i]));
219 action->setData(QVariant::fromValue(i));
222 save_button_->setMenu(save_menu);
223 save_button_->setDefaultAction(save_action_);
224 save_button_->setPopupMode(QToolButton::MenuButtonPopup);
226 // Set up the models and the table view
227 filter_proxy_model_->setSourceModel(model_);
228 table_view_->setModel(filter_proxy_model_);
230 table_view_->setSelectionBehavior(QAbstractItemView::SelectRows);
231 table_view_->setSelectionMode(QAbstractItemView::ContiguousSelection);
232 table_view_->setSortingEnabled(true);
233 table_view_->sortByColumn(0, Qt::AscendingOrder);
235 for (uint8_t i = model_->first_hidden_column(); i < model_->columnCount(); i++)
236 table_view_->setColumnHidden(i, true);
238 const int font_height = QFontMetrics(QApplication::font()).height();
239 table_view_->verticalHeader()->setDefaultSectionSize((font_height * 5) / 4);
240 table_view_->verticalHeader()->setVisible(false);
242 table_view_->horizontalHeader()->setStretchLastSection(true);
243 table_view_->horizontalHeader()->setCascadingSectionResizes(true);
244 table_view_->horizontalHeader()->setSectionsMovable(true);
245 table_view_->horizontalHeader()->setContextMenuPolicy(Qt::CustomContextMenu);
247 table_view_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
248 parent->setSizePolicy(table_view_->sizePolicy());
250 connect(table_view_, SIGNAL(clicked(const QModelIndex&)),
251 this, SLOT(on_table_item_clicked(const QModelIndex&)));
252 connect(table_view_, SIGNAL(doubleClicked(const QModelIndex&)),
253 this, SLOT(on_table_item_double_clicked(const QModelIndex&)));
254 connect(table_view_, SIGNAL(activatedByKey(const QModelIndex&)),
255 this, SLOT(on_table_item_double_clicked(const QModelIndex&)));
256 connect(table_view_->horizontalHeader(), SIGNAL(customContextMenuRequested(const QPoint&)),
257 this, SLOT(on_table_header_requested(const QPoint&)));
259 // Set up metadata event handler
260 session_.metadata_obj_manager()->add_observer(this);
267 session_.metadata_obj_manager()->remove_observer(this);
270 ViewType View::get_type() const
272 return ViewTypeTabularDecoder;
275 void View::reset_view_state()
277 ViewBase::reset_view_state();
279 decoder_selector_->clear();
282 void View::clear_decode_signals()
284 ViewBase::clear_decode_signals();
290 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
292 ViewBase::add_decode_signal(signal);
294 connect(signal.get(), SIGNAL(name_changed(const QString&)),
295 this, SLOT(on_signal_name_changed(const QString&)));
297 // Note: At time of initial creation, decode signals have no decoders so we
298 // need to watch for decoder stacking events
300 connect(signal.get(), SIGNAL(decoder_stacked(void*)),
301 this, SLOT(on_decoder_stacked(void*)));
302 connect(signal.get(), SIGNAL(decoder_removed(void*)),
303 this, SLOT(on_decoder_removed(void*)));
305 // Add the top-level decoder provided by an already-existing signal
306 auto stack = signal->decoder_stack();
307 if (!stack.empty()) {
308 shared_ptr<Decoder>& dec = stack.at(0);
309 decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get()));
313 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
315 // Remove all decoders provided by this signal
316 for (const shared_ptr<Decoder>& dec : signal->decoder_stack()) {
317 int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
320 decoder_selector_->removeItem(index);
323 ViewBase::remove_decode_signal(signal);
325 if (signal.get() == signal_) {
332 void View::save_settings(QSettings &settings) const
334 ViewBase::save_settings(settings);
336 settings.setValue("view_mode", view_mode_selector_->currentIndex());
337 settings.setValue("hide_hidden", hide_hidden_cb_->isChecked());
340 void View::restore_settings(QSettings &settings)
342 ViewBase::restore_settings(settings);
344 if (settings.contains("view_mode"))
345 view_mode_selector_->setCurrentIndex(settings.value("view_mode").toInt());
347 if (settings.contains("hide_hidden"))
348 hide_hidden_cb_->setChecked(settings.value("hide_hidden").toBool());
351 void View::reset_data()
357 void View::update_data()
359 model_->set_signal_and_segment(signal_, current_segment_);
362 void View::save_data_as_csv(unsigned int save_type) const
364 // Note: We try to follow RFC 4180 (https://tools.ietf.org/html/rfc4180)
372 const bool save_all = !table_view_->selectionModel()->hasSelection();
374 GlobalSettings settings;
375 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
377 const QString file_name = QFileDialog::getSaveFileName(
378 parent_, tr("Save Annotations as CSV"), dir, tr("CSV Files (*.csv);;Text Files (*.txt);;All Files (*)"));
380 if (file_name.isEmpty())
383 QFile file(file_name);
384 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
385 QTextStream out_stream(&file);
388 table_view_->selectAll();
390 // Write out header columns in visual order, not logical order
391 for (int i = 0; i < table_view_->horizontalHeader()->count(); i++) {
392 int column = table_view_->horizontalHeader()->logicalIndex(i);
394 if (table_view_->horizontalHeader()->isSectionHidden(column))
397 const QString title = filter_proxy_model_->headerData(column, Qt::Horizontal, Qt::DisplayRole).toString();
399 if (save_type == SaveTypeCSVEscaped)
402 out_stream << '"' << title << '"';
404 if (i < (table_view_->horizontalHeader()->count() - 1))
407 out_stream << '\r' << '\n';
410 QModelIndexList selected_rows = table_view_->selectionModel()->selectedRows();
412 for (int i = 0; i < selected_rows.size(); i++) {
413 const int row = selected_rows.at(i).row();
415 // Write out columns in visual order, not logical order
416 for (int c = 0; c < table_view_->horizontalHeader()->count(); c++) {
417 const int column = table_view_->horizontalHeader()->logicalIndex(c);
419 if (table_view_->horizontalHeader()->isSectionHidden(column))
422 const QModelIndex idx = filter_proxy_model_->index(row, column);
423 QString s = filter_proxy_model_->data(idx, Qt::DisplayRole).toString();
425 if (save_type == SaveTypeCSVEscaped)
426 out_stream << s.replace(",", "\\,");
428 out_stream << '"' << s.replace("\"", "\"\"") << '"';
430 if (c < (table_view_->horizontalHeader()->count() - 1))
434 out_stream << '\r' << '\n';
437 if (out_stream.status() == QTextStream::Ok) {
439 table_view_->clearSelection();
445 QMessageBox msg(parent_);
446 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
447 msg.setStandardButtons(QMessageBox::Ok);
448 msg.setIcon(QMessageBox::Warning);
452 void View::on_selected_decoder_changed(int index)
455 disconnect(signal_, SIGNAL(color_changed(QColor)));
456 disconnect(signal_, SIGNAL(new_annotations()));
457 disconnect(signal_, SIGNAL(decode_reset()));
462 decoder_ = (Decoder*)decoder_selector_->itemData(index).value<void*>();
464 // Find the signal that contains the selected decoder
465 for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
466 for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
467 if (decoder_ == dec.get())
471 connect(signal_, SIGNAL(color_changed(QColor)), this, SLOT(on_signal_color_changed(QColor)));
472 connect(signal_, SIGNAL(new_annotations()), this, SLOT(on_new_annotations()));
473 connect(signal_, SIGNAL(decode_reset()), this, SLOT(on_decoder_reset()));
478 // Force repaint, otherwise the new selection isn't shown for some reason
479 table_view_->viewport()->update();
482 void View::on_hide_hidden_changed(bool checked)
484 model_->set_hide_hidden(checked);
486 // Force repaint, otherwise the new selection isn't shown for some reason
487 table_view_->viewport()->update();
490 void View::on_view_mode_changed(int index)
492 if (index == ViewModeAll)
493 filter_proxy_model_->enable_range_filtering(false);
495 if (index == ViewModeVisible) {
496 MetadataObject *md_obj =
497 session_.metadata_obj_manager()->find_object_by_type(MetadataObjMainViewRange);
500 int64_t start_sample = md_obj->value(MetadataValueStartSample).toLongLong();
501 int64_t end_sample = md_obj->value(MetadataValueEndSample).toLongLong();
503 filter_proxy_model_->enable_range_filtering(true);
504 filter_proxy_model_->set_sample_range(max((int64_t)0, start_sample),
505 max((int64_t)0, end_sample));
508 if (index == ViewModeLatest) {
509 filter_proxy_model_->enable_range_filtering(false);
511 table_view_->scrollTo(
512 filter_proxy_model_->mapFromSource(model_->index(model_->rowCount() - 1, 0)),
513 QAbstractItemView::PositionAtBottom);
517 void View::on_signal_name_changed(const QString &name)
521 SignalBase* sb = qobject_cast<SignalBase*>(QObject::sender());
524 DecodeSignal* signal = dynamic_cast<DecodeSignal*>(sb);
527 // Update the top-level decoder provided by this signal
528 auto stack = signal->decoder_stack();
529 if (!stack.empty()) {
530 shared_ptr<Decoder>& dec = stack.at(0);
531 int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
534 decoder_selector_->setItemText(index, signal->name());
538 void View::on_signal_color_changed(const QColor &color)
542 // Force immediate repaint, otherwise it's updated after the header popup is closed
543 table_view_->viewport()->update();
546 void View::on_new_annotations()
548 if (view_mode_selector_->currentIndex() == ViewModeLatest) {
550 table_view_->scrollTo(
551 filter_proxy_model_->index(filter_proxy_model_->rowCount() - 1, 0),
552 QAbstractItemView::PositionAtBottom);
554 if (!delayed_view_updater_.isActive())
555 delayed_view_updater_.start();
559 void View::on_decoder_reset()
561 // Invalidate the model's data connection immediately - otherwise we
562 // will use a stale pointer in model_->index() when called from the table view
563 model_->set_signal_and_segment(signal_, current_segment_);
566 void View::on_decoder_stacked(void* decoder)
568 Decoder* d = static_cast<Decoder*>(decoder);
570 // Find the signal that contains the selected decoder
571 DecodeSignal* signal = nullptr;
573 for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
574 for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
580 const shared_ptr<Decoder>& dec = signal->decoder_stack().at(0);
581 int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
584 // Add the decoder to the list
585 decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)d));
589 void View::on_decoder_removed(void* decoder)
591 Decoder* d = static_cast<Decoder*>(decoder);
593 // Remove the decoder from the list
594 int index = decoder_selector_->findData(QVariant::fromValue((void*)d));
597 decoder_selector_->removeItem(index);
600 void View::on_actionSave_triggered(QAction* action)
602 int save_type = SaveTypeCSVQuoted;
605 save_type = action->data().toInt();
607 save_data_as_csv(save_type);
610 void View::on_table_item_clicked(const QModelIndex& index)
614 // Force repaint, otherwise the new selection isn't shown for some reason
615 table_view_->viewport()->update();
618 void View::on_table_item_double_clicked(const QModelIndex& index)
620 const QModelIndex src_idx = filter_proxy_model_->mapToSource(index);
622 const Annotation* ann = static_cast<const Annotation*>(src_idx.internalPointer());
625 shared_ptr<views::ViewBase> main_view = session_.main_view();
627 main_view->focus_on_range(ann->start_sample(), ann->end_sample());
630 void View::on_table_header_requested(const QPoint& pos)
632 QMenu* menu = new QMenu(this);
634 for (int i = 0; i < table_view_->horizontalHeader()->count(); i++) {
635 int column = table_view_->horizontalHeader()->logicalIndex(i);
637 const QString title =
638 filter_proxy_model_->headerData(column, Qt::Horizontal, Qt::DisplayRole).toString();
639 QAction* action = new QAction(title, this);
641 action->setCheckable(true);
642 action->setChecked(!table_view_->horizontalHeader()->isSectionHidden(column));
643 action->setData(column);
645 connect(action, SIGNAL(toggled(bool)), this, SLOT(on_table_header_toggled(bool)));
647 menu->addAction(action);
650 menu->popup(table_view_->horizontalHeader()->viewport()->mapToGlobal(pos));
653 void View::on_table_header_toggled(bool checked)
655 QAction* action = qobject_cast<QAction*>(QObject::sender());
658 const int column = action->data().toInt();
660 table_view_->horizontalHeader()->setSectionHidden(column, !checked);
663 void View::on_metadata_object_changed(MetadataObject* obj,
664 MetadataValueType value_type)
666 // Check if we need to update the model's data range. We only work on the
667 // end sample value because the start sample value is updated first and
668 // we don't want to update the model twice
669 if ((view_mode_selector_->currentIndex() == ViewModeVisible) &&
670 (obj->type() == MetadataObjMainViewRange) &&
671 (value_type == MetadataValueEndSample)) {
673 int64_t start_sample = obj->value(MetadataValueStartSample).toLongLong();
674 int64_t end_sample = obj->value(MetadataValueEndSample).toLongLong();
676 filter_proxy_model_->set_sample_range(max((int64_t)0, start_sample),
677 max((int64_t)0, end_sample));
680 if (obj->type() == MetadataObjMousePos) {
681 QModelIndex first_visible_idx =
682 filter_proxy_model_->mapToSource(filter_proxy_model_->index(0, 0));
683 QModelIndex last_visible_idx =
684 filter_proxy_model_->mapToSource(filter_proxy_model_->index(filter_proxy_model_->rowCount() - 1, 0));
686 if (first_visible_idx.isValid()) {
687 const QModelIndex first_highlighted_idx =
688 model_->update_highlighted_rows(first_visible_idx, last_visible_idx,
689 obj->value(MetadataValueStartSample).toLongLong());
691 if (view_mode_selector_->currentIndex() == ViewModeVisible) {
692 const QModelIndex idx = filter_proxy_model_->mapFromSource(first_highlighted_idx);
693 table_view_->scrollTo(idx, QAbstractItemView::EnsureVisible);
696 // Force repaint, otherwise the table doesn't immediately update for some reason
697 table_view_->viewport()->update();
702 void View::perform_delayed_view_update()
708 } // namespace tabular_decoder