X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=pv%2Fviews%2Ftabular_decoder%2Fview.cpp;h=1ed6f95b18b1a0daedf3903291febfab099f8ed2;hb=8845be3c9c7d5aca02fb2efc4038f4735a5242d6;hp=8c5859e3bcb17f7f425a0b7ec66787722fd93c1b;hpb=24d69d27584c7adec70bc0d6db764a3db04fce3c;p=pulseview.git diff --git a/pv/views/tabular_decoder/view.cpp b/pv/views/tabular_decoder/view.cpp index 8c5859e3..1ed6f95b 100644 --- a/pv/views/tabular_decoder/view.cpp +++ b/pv/views/tabular_decoder/view.cpp @@ -19,8 +19,11 @@ #include +#include #include #include +#include +#include #include #include #include @@ -32,6 +35,7 @@ #include "view.hpp" #include "pv/globalsettings.hpp" +#include "pv/session.hpp" #include "pv/util.hpp" #include "pv/data/decode/decoder.hpp" @@ -40,12 +44,87 @@ using pv::data::SignalBase; 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 { +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) +{ +} + +bool CustomFilterProxyModel::filterAcceptsRow(int sourceRow, + const QModelIndex &sourceParent) const +{ + (void)sourceParent; + assert(sourceModel() != nullptr); + + 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; + + return !entirely_outside_of_range; +} + +void CustomFilterProxyModel::set_sample_range(uint64_t start_sample, + uint64_t end_sample) +{ + range_start_sample_ = start_sample; + range_end_sample_ = end_sample; + + invalidateFilter(); +} + + +QSize CustomTableView::minimumSizeHint() const +{ + QSize size(QTableView::sizeHint()); + + int width = 0; + for (int i = 0; i < horizontalHeader()->count(); i++) + if (!horizontalHeader()->isSectionHidden(i)) + width += horizontalHeader()->sectionSize(i); + + size.setWidth(width + (horizontalHeader()->count() * 1)); + + return size; +} + +QSize CustomTableView::sizeHint() const +{ + return minimumSizeHint(); +} + View::View(Session &session, bool is_main_view, QMainWindow *parent) : ViewBase(session, is_main_view, parent), @@ -53,10 +132,13 @@ 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 QTableView()), - model_(new AnnotationCollectionModel()), + table_view_(new CustomTableView()), + model_(new AnnotationCollectionModel(this)), + filter_proxy_model_(new CustomFilterProxyModel(this)), signal_(nullptr) { QVBoxLayout *root_layout = new QVBoxLayout(this); @@ -73,13 +155,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", @@ -92,18 +188,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; @@ -130,23 +265,21 @@ void View::add_decode_signal(shared_ptr signal) connect(signal.get(), SIGNAL(name_changed(const QString&)), this, SLOT(on_signal_name_changed(const QString&))); + + // Note: At time of initial creation, decode signals have no decoders so we + // need to watch for decoder stacking events + connect(signal.get(), SIGNAL(decoder_stacked(void*)), this, SLOT(on_decoder_stacked(void*))); connect(signal.get(), SIGNAL(decoder_removed(void*)), this, SLOT(on_decoder_removed(void*))); - // Add all decoders provided by this signal + // Add the top-level decoder provided by an already-existing signal auto stack = signal->decoder_stack(); - if (stack.size() > 1) { - for (const shared_ptr& dec : stack) { - QString title = QString("%1 (%2)").arg(signal->name(), dec->name()); - decoder_selector_->addItem(title, QVariant::fromValue((void*)dec.get())); - } - } else - if (!stack.empty()) { - shared_ptr& dec = stack.at(0); - decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get())); - } + if (!stack.empty()) { + shared_ptr& dec = stack.at(0); + decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get())); + } } void View::remove_decode_signal(shared_ptr signal) @@ -171,13 +304,20 @@ void View::remove_decode_signal(shared_ptr 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() @@ -188,56 +328,106 @@ void View::reset_data() void View::update_data() { - if (!signal_) - return; - - // TBD + model_->set_signal_and_segment(signal_, current_segment_); } -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 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 = 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'; + + + QModelIndexList selected_rows = table_view_->selectionModel()->selectedRows(); + + for (int i = 0; i < selected_rows.size(); i++) { + const int row = selected_rows.at(i).row(); + + // 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); - vector data; - data.resize(selection.second - selection.first + 1); + if (table_view_->horizontalHeader()->isSectionHidden(column)) + continue; - signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_, - bin_class_id_, selection.first, selection.second, &data); + const QModelIndex idx = model_->index(row, column); + QString s = model_->data(idx, Qt::DisplayRole).toString(); - int64_t bytes_written = file.write((const char*)data.data(), data.size()); + 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_) + if (signal_) { + disconnect(signal_, SIGNAL(color_changed(QColor))); disconnect(signal_, SIGNAL(new_annotations())); + disconnect(signal_, SIGNAL(decode_reset())); + } reset_data(); @@ -250,12 +440,48 @@ void View::on_selected_decoder_changed(int index) signal_ = ds.get(); if (signal_) { + connect(signal_, SIGNAL(color_changed(QColor)), this, SLOT(on_signal_color_changed(QColor))); connect(signal_, SIGNAL(new_annotations()), this, SLOT(on_new_annotations())); + connect(signal_, SIGNAL(decode_reset()), this, SLOT(on_decoder_reset())); } 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 == 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_->set_sample_range(max((int64_t)0, start_sample), + max((int64_t)0, end_sample)); + + // Force repaint, otherwise the new selection may not show immediately +// table_view_->viewport()->update(); + } else { + // Use the data model directly + table_view_->setModel(model_); + } + + if (index == ViewModeLatest) + 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; @@ -266,36 +492,45 @@ void View::on_signal_name_changed(const QString &name) DecodeSignal* signal = dynamic_cast(sb); assert(signal); - // Update all decoder entries provided by this signal + // Update the top-level decoder provided by this signal auto stack = signal->decoder_stack(); - if (stack.size() > 1) { - for (const shared_ptr& dec : stack) { - QString title = QString("%1 (%2)").arg(signal->name(), dec->name()); - int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get())); + if (!stack.empty()) { + shared_ptr& dec = stack.at(0); + int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get())); - if (index != -1) - decoder_selector_->setItemText(index, title); - } - } else - if (!stack.empty()) { - shared_ptr& dec = stack.at(0); - int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get())); + if (index != -1) + decoder_selector_->setItemText(index, signal->name()); + } +} - if (index != -1) - decoder_selector_->setItemText(index, signal->name()); - } +void View::on_signal_color_changed(const QColor &color) +{ + (void)color; + + table_view_->update(); } 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_stacked(void* decoder) +void View::on_decoder_reset() { - // TODO This doesn't change existing entries for the same signal - but it should as the naming scheme may change + // Invalidate the model's data connection immediately - otherwise we + // will use a stale pointer in model_->index() when called from the table view + model_->set_signal_and_segment(signal_, current_segment_); +} +void View::on_decoder_stacked(void* decoder) +{ Decoder* d = static_cast(decoder); // Find the signal that contains the selected decoder @@ -308,9 +543,13 @@ void View::on_decoder_stacked(void* decoder) assert(signal); - // Add the decoder to the list - QString title = QString("%1 (%2)").arg(signal->name(), d->name()); - decoder_selector_->addItem(title, QVariant::fromValue((void*)d)); + const shared_ptr& dec = signal->decoder_stack().at(0); + int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get())); + + if (index == -1) { + // Add the decoder to the list + decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)d)); + } } void View::on_decoder_removed(void* decoder) @@ -326,9 +565,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(index.internalPointer()); + + shared_ptr 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); + } + + menu->popup(table_view_->horizontalHeader()->viewport()->mapToGlobal(pos)); +} + +void View::on_table_header_toggled(bool checked) +{ + QAction* action = qobject_cast(QObject::sender()); + assert(action); + + const int column = action->data().toInt(); + + table_view_->horizontalHeader()->setSectionHidden(column, !checked); +} - save_data(); +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()