]> sigrok.org Git - pulseview.git/blobdiff - pv/views/tabular_decoder/view.cpp
TabularDecView: Some fixes and refactorings
[pulseview.git] / pv / views / tabular_decoder / view.cpp
index 1f79be033bf1432ca472f63b0cbe19d1ceb67bc8..3c916f4d340689ef2230978387c6dae0ca8ddb29 100644 (file)
@@ -35,6 +35,7 @@
 #include "view.hpp"
 
 #include "pv/globalsettings.hpp"
+#include "pv/session.hpp"
 #include "pv/util.hpp"
 #include "pv/data/decode/decoder.hpp"
 
@@ -44,13 +45,82 @@ using pv::data::decode::Decoder;
 using pv::util::Timestamp;
 
 using std::make_shared;
+using std::max;
 using std::shared_ptr;
 
 namespace pv {
 namespace views {
 namespace tabular_decoder {
 
-QSize QCustomTableView::minimumSizeHint() const
+const char* SaveTypeNames[SaveTypeCount] = {
+       "CSV, commas escaped",
+       "CSV, fields quoted"
+};
+
+const char* ViewModeNames[ViewModeCount] = {
+       "Show all",
+       "Show all and focus on newest",
+       "Show visible in main view"
+};
+
+
+CustomFilterProxyModel::CustomFilterProxyModel(QObject* parent) :
+       QSortFilterProxyModel(parent),
+       range_filtering_enabled_(false)
+{
+}
+
+bool CustomFilterProxyModel::filterAcceptsRow(int sourceRow,
+       const QModelIndex &sourceParent) const
+{
+       (void)sourceParent;
+       assert(sourceModel() != nullptr);
+
+       bool result = true;
+
+       if (range_filtering_enabled_) {
+               const QModelIndex ann_start_sample_idx = sourceModel()->index(sourceRow, 0);
+               const uint64_t ann_start_sample =
+                       sourceModel()->data(ann_start_sample_idx, Qt::DisplayRole).toULongLong();
+
+               const QModelIndex ann_end_sample_idx = sourceModel()->index(sourceRow, 6);
+               const uint64_t ann_end_sample =
+                       sourceModel()->data(ann_end_sample_idx, Qt::DisplayRole).toULongLong();
+
+               // We consider all annotations as visible that either
+               // a) begin to the left of the range and end within the range or
+               // b) begin and end within the range or
+               // c) begin within the range and end to the right of the range
+               // ...which is equivalent to the negation of "begins and ends outside the range"
+
+               const bool left_of_range = (ann_end_sample < range_start_sample_);
+               const bool right_of_range = (ann_start_sample > range_end_sample_);
+               const bool entirely_outside_of_range = left_of_range || right_of_range;
+
+               result = !entirely_outside_of_range;
+       }
+
+       return result;
+}
+
+void CustomFilterProxyModel::set_sample_range(uint64_t start_sample,
+       uint64_t end_sample)
+{
+       range_start_sample_ = start_sample;
+       range_end_sample_ = end_sample;
+
+       invalidateFilter();
+}
+
+void CustomFilterProxyModel::enable_range_filtering(bool value)
+{
+       range_filtering_enabled_ = value;
+
+       invalidateFilter();
+}
+
+
+QSize CustomTableView::minimumSizeHint() const
 {
        QSize size(QTableView::sizeHint());
 
@@ -64,7 +134,7 @@ QSize QCustomTableView::minimumSizeHint() const
        return size;
 }
 
-QSize QCustomTableView::sizeHint() const
+QSize CustomTableView::sizeHint() const
 {
        return minimumSizeHint();
 }
@@ -76,12 +146,14 @@ View::View(Session &session, bool is_main_view, QMainWindow *parent) :
        // Note: Place defaults in View::reset_view_state(), not here
        parent_(parent),
        decoder_selector_(new QComboBox()),
+       hide_hidden_cb_(new QCheckBox()),
+       view_mode_selector_(new QComboBox()),
        save_button_(new QToolButton()),
        save_action_(new QAction(this)),
-       table_view_(new QCustomTableView()),
-       model_(new AnnotationCollectionModel()),
-       signal_(nullptr),
-       updating_data_(false)
+       table_view_(new CustomTableView()),
+       model_(new AnnotationCollectionModel(this)),
+       filter_proxy_model_(new CustomFilterProxyModel(this)),
+       signal_(nullptr)
 {
        QVBoxLayout *root_layout = new QVBoxLayout(this);
        root_layout->setContentsMargins(0, 0, 0, 0);
@@ -97,13 +169,27 @@ View::View(Session &session, bool is_main_view, QMainWindow *parent) :
        toolbar->addWidget(decoder_selector_);
        toolbar->addSeparator();
        toolbar->addWidget(save_button_);
+       toolbar->addSeparator();
+       toolbar->addWidget(view_mode_selector_);
+       toolbar->addSeparator();
+       toolbar->addWidget(hide_hidden_cb_);
 
        connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
                this, SLOT(on_selected_decoder_changed(int)));
+       connect(view_mode_selector_, SIGNAL(currentIndexChanged(int)),
+               this, SLOT(on_view_mode_changed(int)));
+       connect(hide_hidden_cb_, SIGNAL(toggled(bool)),
+               this, SLOT(on_hide_hidden_changed(bool)));
 
        // Configure widgets
        decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
 
+       for (int i = 0; i < ViewModeCount; i++)
+               view_mode_selector_->addItem(ViewModeNames[i], QVariant::fromValue(i));
+
+       hide_hidden_cb_->setText(tr("Hide Hidden Rows/Classes"));
+       hide_hidden_cb_->setChecked(true);
+
        // Configure actions
        save_action_->setText(tr("&Save..."));
        save_action_->setIcon(QIcon::fromTheme("document-save-as",
@@ -116,28 +202,57 @@ View::View(Session &session, bool is_main_view, QMainWindow *parent) :
        connect(save_menu, SIGNAL(triggered(QAction*)),
                this, SLOT(on_actionSave_triggered(QAction*)));
 
+       for (int i = 0; i < SaveTypeCount; i++) {
+               QAction *const action = save_menu->addAction(tr(SaveTypeNames[i]));
+               action->setData(QVariant::fromValue(i));
+       }
+
        save_button_->setMenu(save_menu);
        save_button_->setDefaultAction(save_action_);
        save_button_->setPopupMode(QToolButton::MenuButtonPopup);
 
-       // Set up the table view
-       table_view_->setModel(model_);
+       // Set up the models and the table view
+       filter_proxy_model_->setSourceModel(model_);
+       table_view_->setModel(filter_proxy_model_);
+
+       table_view_->setSelectionBehavior(QAbstractItemView::SelectRows);
+       table_view_->setSelectionMode(QAbstractItemView::ContiguousSelection);
        table_view_->setSortingEnabled(true);
        table_view_->sortByColumn(0, Qt::AscendingOrder);
 
+       for (uint8_t i = model_->first_hidden_column(); i < model_->columnCount(); i++)
+               table_view_->setColumnHidden(i, true);
+
        const int font_height = QFontMetrics(QApplication::font()).height();
        table_view_->verticalHeader()->setDefaultSectionSize((font_height * 5) / 4);
+       table_view_->verticalHeader()->setVisible(false);
 
        table_view_->horizontalHeader()->setStretchLastSection(true);
        table_view_->horizontalHeader()->setCascadingSectionResizes(true);
        table_view_->horizontalHeader()->setSectionsMovable(true);
+       table_view_->horizontalHeader()->setContextMenuPolicy(Qt::CustomContextMenu);
 
        table_view_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
        parent->setSizePolicy(table_view_->sizePolicy());
 
+       connect(table_view_, SIGNAL(clicked(const QModelIndex&)),
+               this, SLOT(on_table_item_clicked(const QModelIndex&)));
+       connect(table_view_, SIGNAL(doubleClicked(const QModelIndex&)),
+               this, SLOT(on_table_item_double_clicked(const QModelIndex&)));
+       connect(table_view_->horizontalHeader(), SIGNAL(customContextMenuRequested(const QPoint&)),
+               this, SLOT(on_table_header_requested(const QPoint&)));
+
+       // Set up metadata event handler
+       session_.metadata_obj_manager()->add_observer(this);
+
        reset_view_state();
 }
 
+View::~View()
+{
+       session_.metadata_obj_manager()->remove_observer(this);
+}
+
 ViewType View::get_type() const
 {
        return ViewTypeTabularDecoder;
@@ -203,13 +318,20 @@ void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
 void View::save_settings(QSettings &settings) const
 {
        ViewBase::save_settings(settings);
+
+       settings.setValue("view_mode", view_mode_selector_->currentIndex());
+       settings.setValue("hide_hidden", hide_hidden_cb_->isChecked());
 }
 
 void View::restore_settings(QSettings &settings)
 {
-       // Note: It is assumed that this function is only called once,
-       // immediately after restoring a previous session.
        ViewBase::restore_settings(settings);
+
+       if (settings.contains("view_mode"))
+               view_mode_selector_->setCurrentIndex(settings.value("view_mode").toInt());
+
+       if (settings.contains("hide_hidden"))
+               hide_hidden_cb_->setChecked(settings.value("hide_hidden").toBool());
 }
 
 void View::reset_data()
@@ -220,67 +342,103 @@ void View::reset_data()
 
 void View::update_data()
 {
-       if (!signal_)
-               return;
-
-       if (updating_data_) {
-               if (!delayed_view_updater_.isActive())
-                       delayed_view_updater_.start();
-               return;
-       }
-
-       updating_data_ = true;
-
-       table_view_->setRootIndex(model_->index(1, 0, QModelIndex()));
        model_->set_signal_and_segment(signal_, current_segment_);
-
-       updating_data_ = false;
 }
 
-void View::save_data() const
+void View::save_data_as_csv(unsigned int save_type) const
 {
+       // Note: We try to follow RFC 4180 (https://tools.ietf.org/html/rfc4180)
+
        assert(decoder_);
        assert(signal_);
 
        if (!signal_)
                return;
 
-/*     GlobalSettings settings;
+       const bool save_all = !table_view_->selectionModel()->hasSelection();
+
+       GlobalSettings settings;
        const QString dir = settings.value("MainWindow/SaveDirectory").toString();
 
        const QString file_name = QFileDialog::getSaveFileName(
-               parent_, tr("Save Binary Data"), dir, tr("Binary Data Files (*.bin);;All Files (*)"));
+               parent_, tr("Save Annotations as CSV"), dir, tr("CSV Files (*.csv);;Text Files (*.txt);;All Files (*)"));
 
        if (file_name.isEmpty())
                return;
 
        QFile file(file_name);
        if (file.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
-               pair<size_t, size_t> selection = hex_view_->get_selection();
+               QTextStream out_stream(&file);
+
+               if (save_all)
+                       table_view_->selectAll();
+
+               // Write out header columns in visual order, not logical order
+               for (int i = 0; i < table_view_->horizontalHeader()->count(); i++) {
+                       int column = table_view_->horizontalHeader()->logicalIndex(i);
+
+                       if (table_view_->horizontalHeader()->isSectionHidden(column))
+                               continue;
+
+                       const QString title = filter_proxy_model_->headerData(column, Qt::Horizontal, Qt::DisplayRole).toString();
+
+                       if (save_type == SaveTypeCSVEscaped)
+                               out_stream << title;
+                       else
+                               out_stream << '"' << title << '"';
+
+                       if (i < (table_view_->horizontalHeader()->count() - 1))
+                               out_stream << ",";
+               }
+               out_stream << '\r' << '\n';
+
 
-               vector<uint8_t> data;
-               data.resize(selection.second - selection.first + 1);
+               QModelIndexList selected_rows = table_view_->selectionModel()->selectedRows();
 
-               signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_,
-                       bin_class_id_, selection.first, selection.second, &data);
+               for (int i = 0; i < selected_rows.size(); i++) {
+                       const int row = selected_rows.at(i).row();
 
-               int64_t bytes_written = file.write((const char*)data.data(), data.size());
+                       // Write out columns in visual order, not logical order
+                       for (int c = 0; c < table_view_->horizontalHeader()->count(); c++) {
+                               const int column = table_view_->horizontalHeader()->logicalIndex(c);
+
+                               if (table_view_->horizontalHeader()->isSectionHidden(column))
+                                       continue;
+
+                               const QModelIndex idx = filter_proxy_model_->index(row, column);
+                               QString s = filter_proxy_model_->data(idx, Qt::DisplayRole).toString();
+
+                               if (save_type == SaveTypeCSVEscaped)
+                                       out_stream << s.replace(",", "\\,");
+                               else
+                                       out_stream << '"' << s.replace("\"", "\"\"") << '"';
+
+                               if (c < (table_view_->horizontalHeader()->count() - 1))
+                                       out_stream << ",";
+                       }
+
+                       out_stream << '\r' << '\n';
+               }
+
+               if (out_stream.status() == QTextStream::Ok) {
+                       if (save_all)
+                               table_view_->clearSelection();
 
-               if ((bytes_written == -1) || ((uint64_t)bytes_written != data.size())) {
-                       QMessageBox msg(parent_);
-                       msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
-                       msg.setStandardButtons(QMessageBox::Ok);
-                       msg.setIcon(QMessageBox::Warning);
-                       msg.exec();
                        return;
                }
-       } */
+       }
+
+       QMessageBox msg(parent_);
+       msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
+       msg.setStandardButtons(QMessageBox::Ok);
+       msg.setIcon(QMessageBox::Warning);
+       msg.exec();
 }
 
 void View::on_selected_decoder_changed(int index)
 {
        if (signal_) {
-               disconnect(signal_, SIGNAL(signal_color_changed()));
+               disconnect(signal_, SIGNAL(color_changed(QColor)));
                disconnect(signal_, SIGNAL(new_annotations()));
                disconnect(signal_, SIGNAL(decode_reset()));
        }
@@ -304,6 +462,41 @@ void View::on_selected_decoder_changed(int index)
        update_data();
 }
 
+void View::on_hide_hidden_changed(bool checked)
+{
+       model_->set_hide_hidden(checked);
+
+       // Force repaint, otherwise the new selection isn't shown for some reason
+       table_view_->viewport()->update();
+}
+
+void View::on_view_mode_changed(int index)
+{
+       if (index == ViewModeAll)
+               filter_proxy_model_->enable_range_filtering(false);
+
+       if (index == ViewModeVisible) {
+               MetadataObject *md_obj =
+                       session_.metadata_obj_manager()->find_object_by_type(MetadataObjMainViewRange);
+               assert(md_obj);
+
+               int64_t start_sample = md_obj->value(MetadataValueStartSample).toLongLong();
+               int64_t end_sample = md_obj->value(MetadataValueEndSample).toLongLong();
+
+               filter_proxy_model_->enable_range_filtering(true);
+               filter_proxy_model_->set_sample_range(max((int64_t)0, start_sample),
+                       max((int64_t)0, end_sample));
+       }
+
+       if (index == ViewModeLatest) {
+               filter_proxy_model_->enable_range_filtering(false);
+
+               table_view_->scrollTo(
+                       filter_proxy_model_->mapFromSource(model_->index(model_->rowCount() - 1, 0)),
+                       QAbstractItemView::PositionAtBottom);
+       }
+}
+
 void View::on_signal_name_changed(const QString &name)
 {
        (void)name;
@@ -334,8 +527,14 @@ void View::on_signal_color_changed(const QColor &color)
 
 void View::on_new_annotations()
 {
-       if (!delayed_view_updater_.isActive())
-               delayed_view_updater_.start();
+       if (view_mode_selector_->currentIndex() == ViewModeLatest) {
+               update_data();
+               table_view_->scrollTo(model_->index(model_->rowCount() - 1, 0),
+                       QAbstractItemView::PositionAtBottom);
+       } else {
+               if (!delayed_view_updater_.isActive())
+                       delayed_view_updater_.start();
+       }
 }
 
 void View::on_decoder_reset()
@@ -364,8 +563,7 @@ void View::on_decoder_stacked(void* decoder)
 
        if (index == -1) {
                // Add the decoder to the list
-               QString title = QString("%1 (%2)").arg(signal->name(), d->name());
-               decoder_selector_->addItem(title, QVariant::fromValue((void*)d));
+               decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)d));
        }
 }
 
@@ -382,9 +580,98 @@ void View::on_decoder_removed(void* decoder)
 
 void View::on_actionSave_triggered(QAction* action)
 {
-       (void)action;
+       int save_type = SaveTypeCSVQuoted;
+
+       if (action)
+               save_type = action->data().toInt();
+
+       save_data_as_csv(save_type);
+}
+
+void View::on_table_item_clicked(const QModelIndex& index)
+{
+       (void)index;
+
+       // Force repaint, otherwise the new selection isn't shown for some reason
+       table_view_->viewport()->update();
+}
+
+void View::on_table_item_double_clicked(const QModelIndex& index)
+{
+       const Annotation* ann = static_cast<const Annotation*>(index.internalPointer());
+
+       shared_ptr<views::ViewBase> main_view = session_.main_view();
+
+       main_view->focus_on_range(ann->start_sample(), ann->end_sample());
+}
+
+void View::on_table_header_requested(const QPoint& pos)
+{
+       QMenu* menu = new QMenu(this);
+
+       for (int i = 0; i < table_view_->horizontalHeader()->count(); i++) {
+               int column = table_view_->horizontalHeader()->logicalIndex(i);
+
+               const QString title = model_->headerData(column, Qt::Horizontal, Qt::DisplayRole).toString();
+               QAction* action = new QAction(title, this);
+
+               action->setCheckable(true);
+               action->setChecked(!table_view_->horizontalHeader()->isSectionHidden(column));
+               action->setData(column);
+
+               connect(action, SIGNAL(toggled(bool)), this, SLOT(on_table_header_toggled(bool)));
+
+               menu->addAction(action);
+       }
 
-       save_data();
+       menu->popup(table_view_->horizontalHeader()->viewport()->mapToGlobal(pos));
+}
+
+void View::on_table_header_toggled(bool checked)
+{
+       QAction* action = qobject_cast<QAction*>(QObject::sender());
+       assert(action);
+
+       const int column = action->data().toInt();
+
+       table_view_->horizontalHeader()->setSectionHidden(column, !checked);
+}
+
+void View::on_metadata_object_changed(MetadataObject* obj,
+       MetadataValueType value_type)
+{
+       // Check if we need to update the model's data range. We only work on the
+       // end sample value because the start sample value is updated first and
+       // we don't want to update the model twice
+
+       if ((view_mode_selector_->currentIndex() == ViewModeVisible) &&
+               (obj->type() == MetadataObjMainViewRange) &&
+               (value_type == MetadataValueEndSample)) {
+
+               int64_t start_sample = obj->value(MetadataValueStartSample).toLongLong();
+               int64_t end_sample = obj->value(MetadataValueEndSample).toLongLong();
+
+               filter_proxy_model_->set_sample_range(max((int64_t)0, start_sample),
+                       max((int64_t)0, end_sample));
+       }
+
+       if (obj->type() == MetadataObjMousePos) {
+               QModelIndex first_visible_idx =
+                       filter_proxy_model_->mapToSource(filter_proxy_model_->index(0, 0));
+               QModelIndex last_visible_idx =
+                       filter_proxy_model_->mapToSource(filter_proxy_model_->index(filter_proxy_model_->rowCount() - 1, 0));
+
+               if (first_visible_idx.isValid()) {
+                       const QModelIndex first_highlighted_idx =
+                               model_->update_highlighted_rows(first_visible_idx, last_visible_idx,
+                                       obj->value(MetadataValueStartSample).toLongLong());
+
+                       if (view_mode_selector_->currentIndex() == ViewModeVisible) {
+                               const QModelIndex idx = filter_proxy_model_->mapFromSource(first_highlighted_idx);
+                               table_view_->scrollTo(idx, QAbstractItemView::EnsureVisible);
+                       }
+               }
+       }
 }
 
 void View::perform_delayed_view_update()