]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/decodetrace.cpp
DecodeTrace: Implement annotation export for cursor range
[pulseview.git] / pv / views / trace / decodetrace.cpp
index 9eeea1c29ec20beaa7139eb8ea1d9b835754b109..be7ac04a5847b6591bd808799317ed47ad4600ea 100644 (file)
@@ -21,6 +21,7 @@ extern "C" {
 #include <libsigrokdecode/libsigrokdecode.h>
 }
 
+#include <limits>
 #include <mutex>
 #include <tuple>
 
@@ -31,10 +32,13 @@ extern "C" {
 #include <QAction>
 #include <QApplication>
 #include <QComboBox>
+#include <QFileDialog>
 #include <QFormLayout>
 #include <QLabel>
 #include <QMenu>
+#include <QMessageBox>
 #include <QPushButton>
+#include <QTextStream>
 #include <QToolTip>
 
 #include "decodetrace.hpp"
@@ -56,6 +60,7 @@ using std::abs;
 using std::make_pair;
 using std::max;
 using std::min;
+using std::numeric_limits;
 using std::out_of_range;
 using std::pair;
 using std::shared_ptr;
@@ -321,6 +326,78 @@ QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
        return menu;
 }
 
+QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
+{
+       try {
+               selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
+       } catch (out_of_range&) {
+               selected_row_ = nullptr;
+       }
+
+       // Default sample range is "from here"
+       const pair<uint64_t, uint64_t> sample_range =
+               get_sample_range(click_pos.x(), click_pos.x() + 1);
+       selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
+
+       QMenu *const menu = new QMenu(parent);
+
+       QAction *const export_all_rows =
+                       new QAction(tr("Export all annotations"), this);
+       export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
+               QIcon(":/icons/document-save-as.png")));
+       connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
+       menu->addAction(export_all_rows);
+
+       QAction *const export_row =
+                       new QAction(tr("Export all annotations for this row"), this);
+       export_row->setIcon(QIcon::fromTheme("document-save-as",
+               QIcon(":/icons/document-save-as.png")));
+       connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
+       menu->addAction(export_row);
+
+       menu->addSeparator();
+
+       QAction *const export_all_rows_from_here =
+               new QAction(tr("Export all annotations, starting here"), this);
+       export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
+               QIcon(":/icons/document-save-as.png")));
+       connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
+       menu->addAction(export_all_rows_from_here);
+
+       QAction *const export_row_from_here =
+               new QAction(tr("Export annotations for this row, starting here"), this);
+       export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
+               QIcon(":/icons/document-save-as.png")));
+       connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
+       menu->addAction(export_row_from_here);
+
+       menu->addSeparator();
+
+       QAction *const export_all_rows_with_cursor =
+               new QAction(tr("Export all annotations within cursor range"), this);
+       export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
+               QIcon(":/icons/document-save-as.png")));
+       connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
+       menu->addAction(export_all_rows_with_cursor);
+
+       QAction *const export_row_with_cursor =
+               new QAction(tr("Export annotations for this row within cursor range"), this);
+       export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
+               QIcon(":/icons/document-save-as.png")));
+       connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
+       menu->addAction(export_row_with_cursor);
+
+       const View *view = owner_->view();
+       assert(view);
+
+       if (!view->cursors()->enabled()) {
+               export_all_rows_with_cursor->setEnabled(false);
+               export_row_with_cursor->setEnabled(false);
+       }
+
+       return menu;
+}
+
 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
                QPainter &p, int h, const ViewItemPaintParams &pp, int y,
                QColor row_color, int row_title_width)
@@ -699,7 +776,7 @@ const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
        if (row < 0)
                return QString();
 
-       vector<pv::data::decode::Annotation> annotations;
+       vector<Annotation> annotations;
 
        decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
                current_segment_, sample_range.first, sample_range.second);
@@ -877,6 +954,62 @@ QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
        return selector;
 }
 
+void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
+{
+       using namespace pv::data::decode;
+
+       GlobalSettings settings;
+       const QString dir = settings.value("MainWindow/SaveDirectory").toString();
+
+       const QString file_name = QFileDialog::getSaveFileName(
+               owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
+
+       if (file_name.isEmpty())
+               return;
+
+       QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
+       const QString quote = format.contains("%q") ? "\"" : "";
+       format = format.remove("%q");
+
+       QFile file(file_name);
+       if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
+               QTextStream out_stream(&file);
+
+               for (Annotation &ann : *annotations) {
+                       const QString sample_range = QString("%1-%2") \
+                               .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
+
+                       const QString class_name = quote + ann.row()->class_name() + quote;
+
+                       QString all_ann_text;
+                       for (const QString &s : ann.annotations())
+                               all_ann_text = all_ann_text + quote + s + quote + ",";
+                       all_ann_text.chop(1);
+
+                       const QString first_ann_text = quote + ann.annotations().front() + quote;
+
+                       QString out_text = format;
+                       out_text = out_text.replace("%s", sample_range);
+                       out_text = out_text.replace("%d",
+                               quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
+                       out_text = out_text.replace("%c", class_name);
+                       out_text = out_text.replace("%1", first_ann_text);
+                       out_text = out_text.replace("%a", all_ann_text);
+                       out_stream << out_text << '\n';
+               }
+
+               if (out_stream.status() == QTextStream::Ok)
+                       return;
+       }
+
+       QMessageBox msg(owner_->view());
+       msg.setText(tr("Error"));
+       msg.setInformativeText(tr("File %1 could not be written to.").arg(file_name));
+       msg.setStandardButtons(QMessageBox::Ok);
+       msg.setIcon(QMessageBox::Warning);
+       msg.exec();
+}
+
 void DecodeTrace::on_new_annotations()
 {
        if (!delayed_trace_updater_.isActive())
@@ -983,6 +1116,104 @@ void DecodeTrace::on_show_hide_decoder(int index)
                owner_->row_item_appearance_changed(false, true);
 }
 
+void DecodeTrace::on_export_row()
+{
+       selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
+       on_export_row_from_here();
+}
+
+void DecodeTrace::on_export_all_rows()
+{
+       selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
+       on_export_all_rows_from_here();
+}
+
+void DecodeTrace::on_export_row_with_cursor()
+{
+       const View *view = owner_->view();
+       assert(view);
+
+       if (!view->cursors()->enabled())
+               return;
+
+       const double samplerate = session_.get_samplerate();
+
+       const pv::util::Timestamp& start_time = view->cursors()->first()->time();
+       const pv::util::Timestamp& end_time = view->cursors()->second()->time();
+
+       const uint64_t start_sample = (uint64_t)max(
+               (double)0, start_time.convert_to<double>() * samplerate);
+       const uint64_t end_sample = (uint64_t)max(
+               (double)0, end_time.convert_to<double>() * samplerate);
+
+       // Are both cursors negative and thus were clamped to 0?
+       if ((start_sample == 0) && (end_sample == 0))
+               return;
+
+       selected_sample_range_ = make_pair(start_sample, end_sample);
+       on_export_row_from_here();
+}
+
+void DecodeTrace::on_export_all_rows_with_cursor()
+{
+       const View *view = owner_->view();
+       assert(view);
+
+       if (!view->cursors()->enabled())
+               return;
+
+       const double samplerate = session_.get_samplerate();
+
+       const pv::util::Timestamp& start_time = view->cursors()->first()->time();
+       const pv::util::Timestamp& end_time = view->cursors()->second()->time();
+
+       const uint64_t start_sample = (uint64_t)max(
+               (double)0, start_time.convert_to<double>() * samplerate);
+       const uint64_t end_sample = (uint64_t)max(
+               (double)0, end_time.convert_to<double>() * samplerate);
+
+       // Are both cursors negative and thus were clamped to 0?
+       if ((start_sample == 0) && (end_sample == 0))
+               return;
+
+       selected_sample_range_ = make_pair(start_sample, end_sample);
+       on_export_all_rows_from_here();
+}
+
+void DecodeTrace::on_export_row_from_here()
+{
+       using namespace pv::data::decode;
+
+       if (!selected_row_)
+               return;
+
+       vector<Annotation> *annotations = new vector<Annotation>();
+
+       decode_signal_->get_annotation_subset(*annotations, *selected_row_,
+               current_segment_, selected_sample_range_.first, selected_sample_range_.second);
+
+       if (annotations->empty())
+               return;
+
+       export_annotations(annotations);
+       delete annotations;
+}
+
+void DecodeTrace::on_export_all_rows_from_here()
+{
+       using namespace pv::data::decode;
+
+       vector<Annotation> *annotations = new vector<Annotation>();
+
+       decode_signal_->get_annotation_subset(*annotations, current_segment_,
+                       selected_sample_range_.first, selected_sample_range_.second);
+
+       if (!annotations->empty())
+               export_annotations(annotations);
+
+       delete annotations;
+}
+
 } // namespace trace
 } // namespace views
 } // namespace pv