[pulseview.git] / pv / views / tabular_decoder / view.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2020 Soeren Apel <soeren@apelpie.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#include <climits>

#include <QApplication>
#include <QDebug>
#include <QFileDialog>
#include <QFontMetrics>
#include <QHeaderView>
#include <QLabel>
#include <QMenu>
#include <QMessageBox>
#include <QToolBar>
#include <QVBoxLayout>

#include <libsigrokdecode/libsigrokdecode.h>

#include "view.hpp"

#include "pv/globalsettings.hpp"
#include "pv/session.hpp"
#include "pv/util.hpp"
#include "pv/data/decode/decoder.hpp"

using pv::data::DecodeSignal;
using pv::data::SignalBase;
using pv::data::decode::Decoder;
using pv::util::Timestamp;

using std::make_shared;
using std::shared_ptr;

namespace pv {
namespace views {
namespace tabular_decoder {

const char* SaveTypeNames[SaveTypeCount] = {
	"CSV, commas escaped",
	"CSV, fields quoted"
};

QSize QCustomTableView::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 QCustomTableView::sizeHint() const
{
	return minimumSizeHint();
}


View::View(Session &session, bool is_main_view, QMainWindow *parent) :
	ViewBase(session, is_main_view, parent),

	// Note: Place defaults in View::reset_view_state(), not here
	parent_(parent),
	decoder_selector_(new QComboBox()),
	save_button_(new QToolButton()),
	save_action_(new QAction(this)),
	table_view_(new QCustomTableView()),
	model_(new AnnotationCollectionModel()),
	signal_(nullptr)
{
	QVBoxLayout *root_layout = new QVBoxLayout(this);
	root_layout->setContentsMargins(0, 0, 0, 0);
	root_layout->addWidget(table_view_);

	// Create toolbar
	QToolBar* toolbar = new QToolBar();
	toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
	parent->addToolBar(toolbar);

	// Populate toolbar
	toolbar->addWidget(new QLabel(tr("Decoder:")));
	toolbar->addWidget(decoder_selector_);
	toolbar->addSeparator();
	toolbar->addWidget(save_button_);

	connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
		this, SLOT(on_selected_decoder_changed(int)));

	// Configure widgets
	decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);

	// Configure actions
	save_action_->setText(tr("&Save..."));
	save_action_->setIcon(QIcon::fromTheme("document-save-as",
		QIcon(":/icons/document-save-as.png")));
	save_action_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
	connect(save_action_, SIGNAL(triggered(bool)),
		this, SLOT(on_actionSave_triggered()));

	QMenu *save_menu = new QMenu();
	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(qVariantFromValue(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_);
	table_view_->setSelectionBehavior(QAbstractItemView::SelectRows);
	table_view_->setSelectionMode(QAbstractItemView::ContiguousSelection);
	table_view_->setSortingEnabled(true);
	table_view_->sortByColumn(0, Qt::AscendingOrder);

	const int font_height = QFontMetrics(QApplication::font()).height();
	table_view_->verticalHeader()->setDefaultSectionSize((font_height * 5) / 4);

	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&)));

	reset_view_state();
}

ViewType View::get_type() const
{
	return ViewTypeTabularDecoder;
}

void View::reset_view_state()
{
	ViewBase::reset_view_state();

	decoder_selector_->clear();
}

void View::clear_decode_signals()
{
	ViewBase::clear_decode_signals();

	reset_data();
	reset_view_state();
}

void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
{
	ViewBase::add_decode_signal(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 the top-level decoder provided by an already-existing signal
	auto stack = signal->decoder_stack();
	if (!stack.empty()) {
		shared_ptr<Decoder>& dec = stack.at(0);
		decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get()));
	}
}

void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
{
	// Remove all decoders provided by this signal
	for (const shared_ptr<Decoder>& dec : signal->decoder_stack()) {
		int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));

		if (index != -1)
			decoder_selector_->removeItem(index);
	}

	ViewBase::remove_decode_signal(signal);

	if (signal.get() == signal_) {
		reset_data();
		update_data();
		reset_view_state();
	}
}

void View::save_settings(QSettings &settings) const
{
	ViewBase::save_settings(settings);
}

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);
}

void View::reset_data()
{
	signal_ = nullptr;
	decoder_ = nullptr;
}

void View::update_data()
{
	model_->set_signal_and_segment(signal_, current_segment_);
}

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;

	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 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)) {
		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);

				if (table_view_->horizontalHeader()->isSectionHidden(column))
					continue;

				const QModelIndex idx = model_->index(row, column, QModelIndex());
				QString s = 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();

			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(color_changed(QColor)));
		disconnect(signal_, SIGNAL(new_annotations()));
		disconnect(signal_, SIGNAL(decode_reset()));
	}

	reset_data();

	decoder_ = (Decoder*)decoder_selector_->itemData(index).value<void*>();

	// Find the signal that contains the selected decoder
	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
		for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
			if (decoder_ == dec.get())
				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_signal_name_changed(const QString &name)
{
	(void)name;

	SignalBase* sb = qobject_cast<SignalBase*>(QObject::sender());
	assert(sb);

	DecodeSignal* signal = dynamic_cast<DecodeSignal*>(sb);
	assert(signal);

	// Update the top-level decoder provided by this signal
	auto stack = signal->decoder_stack();
	if (!stack.empty()) {
		shared_ptr<Decoder>& dec = stack.at(0);
		int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));

		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();
}

void View::on_decoder_reset()
{
	// 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*>(decoder);

	// Find the signal that contains the selected decoder
	DecodeSignal* signal = nullptr;

	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
		for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
			if (d == dec.get())
				signal = ds.get();

	assert(signal);

	const shared_ptr<Decoder>& 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)
{
	Decoder* d = static_cast<Decoder*>(decoder);

	// Remove the decoder from the list
	int index = decoder_selector_->findData(QVariant::fromValue((void*)d));

	if (index != -1)
		decoder_selector_->removeItem(index);
}

void View::on_actionSave_triggered(QAction* 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);
	}

	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::perform_delayed_view_update()
{
	update_data();
}


} // namespace tabular_decoder
} // namespace views
} // namespace pv
Commit	Line	Data
24d69d27 SA	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 <climits>
	21
f54e68b0	22	#include <QApplication>
24d69d27 SA	23	#include <QDebug>
24d69d27 SA	24	#include <QFileDialog>
f54e68b0 SA	25	#include <QFontMetrics>
f54e68b0 SA	26	#include <QHeaderView>
24d69d27 SA	27	#include <QLabel>
	28	#include <QMenu>
	29	#include <QMessageBox>
	30	#include <QToolBar>
	31	#include <QVBoxLayout>
	32
	33	#include <libsigrokdecode/libsigrokdecode.h>
	34
	35	#include "view.hpp"
	36
	37	#include "pv/globalsettings.hpp"
9a35b05d	38	#include "pv/session.hpp"
24d69d27 SA	39	#include "pv/util.hpp"
	40	#include "pv/data/decode/decoder.hpp"
	41
	42	using pv::data::DecodeSignal;
	43	using pv::data::SignalBase;
	44	using pv::data::decode::Decoder;
	45	using pv::util::Timestamp;
	46
f54e68b0	47	using std::make_shared;
24d69d27 SA	48	using std::shared_ptr;
	49
	50	namespace pv {
	51	namespace views {
	52	namespace tabular_decoder {
	53
be0f5903 SA	54	const char* SaveTypeNames[SaveTypeCount] = {
	55	"CSV, commas escaped",
	56	"CSV, fields quoted"
	57	};
	58
f54e68b0 SA	59	QSize QCustomTableView::minimumSizeHint() const
	60	{
	61	QSize size(QTableView::sizeHint());
	62
	63	int width = 0;
	64	for (int i = 0; i < horizontalHeader()->count(); i++)
	65	if (!horizontalHeader()->isSectionHidden(i))
88a25978	66	width += horizontalHeader()->sectionSize(i);
f54e68b0 SA	67
	68	size.setWidth(width + (horizontalHeader()->count() * 1));
	69
	70	return size;
	71	}
	72
	73	QSize QCustomTableView::sizeHint() const
	74	{
	75	return minimumSizeHint();
	76	}
	77
24d69d27 SA	78
	79	View::View(Session &session, bool is_main_view, QMainWindow *parent) :
	80	ViewBase(session, is_main_view, parent),
	81
	82	// Note: Place defaults in View::reset_view_state(), not here
	83	parent_(parent),
	84	decoder_selector_(new QComboBox()),
	85	save_button_(new QToolButton()),
	86	save_action_(new QAction(this)),
f54e68b0	87	table_view_(new QCustomTableView()),
24d69d27	88	model_(new AnnotationCollectionModel()),
6d46525f	89	signal_(nullptr)
24d69d27 SA	90	{
	91	QVBoxLayout *root_layout = new QVBoxLayout(this);
	92	root_layout->setContentsMargins(0, 0, 0, 0);
	93	root_layout->addWidget(table_view_);
	94
	95	// Create toolbar
	96	QToolBar* toolbar = new QToolBar();
	97	toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
	98	parent->addToolBar(toolbar);
	99
	100	// Populate toolbar
	101	toolbar->addWidget(new QLabel(tr("Decoder:")));
	102	toolbar->addWidget(decoder_selector_);
	103	toolbar->addSeparator();
	104	toolbar->addWidget(save_button_);
	105
	106	connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
	107	this, SLOT(on_selected_decoder_changed(int)));
	108
	109	// Configure widgets
	110	decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
	111
	112	// Configure actions
	113	save_action_->setText(tr("&Save..."));
	114	save_action_->setIcon(QIcon::fromTheme("document-save-as",
	115	QIcon(":/icons/document-save-as.png")));
	116	save_action_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
	117	connect(save_action_, SIGNAL(triggered(bool)),
	118	this, SLOT(on_actionSave_triggered()));
	119
	120	QMenu *save_menu = new QMenu();
	121	connect(save_menu, SIGNAL(triggered(QAction*)),
	122	this, SLOT(on_actionSave_triggered(QAction*)));
	123
be0f5903 SA	124	for (int i = 0; i < SaveTypeCount; i++) {
	125	QAction *const action = save_menu->addAction(tr(SaveTypeNames[i]));
	126	action->setData(qVariantFromValue(i));
	127	}
	128
24d69d27 SA	129	save_button_->setMenu(save_menu);
	130	save_button_->setDefaultAction(save_action_);
	131	save_button_->setPopupMode(QToolButton::MenuButtonPopup);
	132
	133	// Set up the table view
	134	table_view_->setModel(model_);
9a35b05d	135	table_view_->setSelectionBehavior(QAbstractItemView::SelectRows);
be0f5903	136	table_view_->setSelectionMode(QAbstractItemView::ContiguousSelection);
24d69d27 SA	137	table_view_->setSortingEnabled(true);
	138	table_view_->sortByColumn(0, Qt::AscendingOrder);
	139
f54e68b0 SA	140	const int font_height = QFontMetrics(QApplication::font()).height();
	141	table_view_->verticalHeader()->setDefaultSectionSize((font_height * 5) / 4);
	142
88a25978 SA	143	table_view_->horizontalHeader()->setStretchLastSection(true);
	144	table_view_->horizontalHeader()->setCascadingSectionResizes(true);
	145	table_view_->horizontalHeader()->setSectionsMovable(true);
9a35b05d	146	table_view_->horizontalHeader()->setContextMenuPolicy(Qt::CustomContextMenu);
f54e68b0 SA	147
	148	table_view_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
	149	parent->setSizePolicy(table_view_->sizePolicy());
	150
9a35b05d SA	151	connect(table_view_, SIGNAL(clicked(const QModelIndex&)),
	152	this, SLOT(on_table_item_clicked(const QModelIndex&)));
	153	connect(table_view_, SIGNAL(doubleClicked(const QModelIndex&)),
	154	this, SLOT(on_table_item_double_clicked(const QModelIndex&)));
	155	connect(table_view_->horizontalHeader(), SIGNAL(customContextMenuRequested(const QPoint&)),
	156	this, SLOT(on_table_header_requested(const QPoint&)));
	157
24d69d27 SA	158	reset_view_state();
	159	}
	160
	161	ViewType View::get_type() const
	162	{
	163	return ViewTypeTabularDecoder;
	164	}
	165
	166	void View::reset_view_state()
	167	{
	168	ViewBase::reset_view_state();
	169
	170	decoder_selector_->clear();
	171	}
	172
	173	void View::clear_decode_signals()
	174	{
	175	ViewBase::clear_decode_signals();
	176
	177	reset_data();
	178	reset_view_state();
	179	}
	180
	181	void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
	182	{
	183	ViewBase::add_decode_signal(signal);
	184
	185	connect(signal.get(), SIGNAL(name_changed(const QString&)),
	186	this, SLOT(on_signal_name_changed(const QString&)));
88a25978 SA	187
	188	// Note: At time of initial creation, decode signals have no decoders so we
	189	// need to watch for decoder stacking events
	190
24d69d27 SA	191	connect(signal.get(), SIGNAL(decoder_stacked(void*)),
	192	this, SLOT(on_decoder_stacked(void*)));
	193	connect(signal.get(), SIGNAL(decoder_removed(void*)),
	194	this, SLOT(on_decoder_removed(void*)));
	195
88a25978	196	// Add the top-level decoder provided by an already-existing signal
24d69d27	197	auto stack = signal->decoder_stack();
f54e68b0 SA	198	if (!stack.empty()) {
	199	shared_ptr<Decoder>& dec = stack.at(0);
	200	decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get()));
	201	}
24d69d27 SA	202	}
	203
	204	void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
	205	{
	206	// Remove all decoders provided by this signal
	207	for (const shared_ptr<Decoder>& dec : signal->decoder_stack()) {
	208	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	209
	210	if (index != -1)
	211	decoder_selector_->removeItem(index);
	212	}
	213
	214	ViewBase::remove_decode_signal(signal);
	215
	216	if (signal.get() == signal_) {
	217	reset_data();
	218	update_data();
	219	reset_view_state();
	220	}
	221	}
	222
	223	void View::save_settings(QSettings &settings) const
	224	{
	225	ViewBase::save_settings(settings);
	226	}
	227
	228	void View::restore_settings(QSettings &settings)
	229	{
	230	// Note: It is assumed that this function is only called once,
	231	// immediately after restoring a previous session.
	232	ViewBase::restore_settings(settings);
	233	}
	234
	235	void View::reset_data()
	236	{
	237	signal_ = nullptr;
	238	decoder_ = nullptr;
	239	}
	240
	241	void View::update_data()
	242	{
f54e68b0	243	model_->set_signal_and_segment(signal_, current_segment_);
24d69d27 SA	244	}
24d69d27 SA	245
be0f5903	246	void View::save_data_as_csv(unsigned int save_type) const
24d69d27	247	{
be0f5903 SA	248	// Note: We try to follow RFC 4180 (https://tools.ietf.org/html/rfc4180)
be0f5903 SA	249
24d69d27 SA	250	assert(decoder_);
	251	assert(signal_);
	252
	253	if (!signal_)
	254	return;
	255
be0f5903 SA	256	const bool save_all = !table_view_->selectionModel()->hasSelection();
	257
	258	GlobalSettings settings;
24d69d27 SA	259	const QString dir = settings.value("MainWindow/SaveDirectory").toString();
	260
	261	const QString file_name = QFileDialog::getSaveFileName(
be0f5903	262	parent_, tr("Save Annotations as CSV"), dir, tr("CSV Files (.csv);;Text Files (.txt);;All Files (*)"));
24d69d27 SA	263
	264	if (file_name.isEmpty())
	265	return;
	266
	267	QFile file(file_name);
	268	if (file.open(QIODevice::WriteOnly \| QIODevice::Truncate)) {
be0f5903 SA	269	QTextStream out_stream(&file);
	270
	271	if (save_all)
	272	table_view_->selectAll();
	273
	274	// Write out header columns in visual order, not logical order
	275	for (int i = 0; i < table_view_->horizontalHeader()->count(); i++) {
	276	int column = table_view_->horizontalHeader()->logicalIndex(i);
	277
	278	if (table_view_->horizontalHeader()->isSectionHidden(column))
	279	continue;
	280
	281	const QString title = model_->headerData(column, Qt::Horizontal, Qt::DisplayRole).toString();
	282
	283	if (save_type == SaveTypeCSVEscaped)
	284	out_stream << title;
	285	else
	286	out_stream << '"' << title << '"';
	287
	288	if (i < (table_view_->horizontalHeader()->count() - 1))
	289	out_stream << ",";
	290	}
	291	out_stream << '\r' << '\n';
24d69d27	292
24d69d27	293
be0f5903	294	QModelIndexList selected_rows = table_view_->selectionModel()->selectedRows();
24d69d27	295
be0f5903 SA	296	for (int i = 0; i < selected_rows.size(); i++) {
	297	const int row = selected_rows.at(i).row();
	298
	299	// Write out columns in visual order, not logical order
	300	for (int c = 0; c < table_view_->horizontalHeader()->count(); c++) {
	301	const int column = table_view_->horizontalHeader()->logicalIndex(c);
	302
	303	if (table_view_->horizontalHeader()->isSectionHidden(column))
	304	continue;
	305
	306	const QModelIndex idx = model_->index(row, column, QModelIndex());
	307	QString s = model_->data(idx, Qt::DisplayRole).toString();
	308
	309	if (save_type == SaveTypeCSVEscaped)
	310	out_stream << s.replace(",", "\\,");
	311	else
	312	out_stream << '"' << s.replace("\"", "\"\"") << '"';
	313
	314	if (c < (table_view_->horizontalHeader()->count() - 1))
	315	out_stream << ",";
	316	}
	317
	318	out_stream << '\r' << '\n';
	319	}
	320
	321	if (out_stream.status() == QTextStream::Ok) {
	322	if (save_all)
	323	table_view_->clearSelection();
24d69d27	324
24d69d27 SA	325	return;
24d69d27 SA	326	}
be0f5903 SA	327	}
	328
	329	QMessageBox msg(parent_);
	330	msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
	331	msg.setStandardButtons(QMessageBox::Ok);
	332	msg.setIcon(QMessageBox::Warning);
	333	msg.exec();
24d69d27 SA	334	}
	335
	336	void View::on_selected_decoder_changed(int index)
	337	{
02c87df7	338	if (signal_) {
85125b0f	339	disconnect(signal_, SIGNAL(color_changed(QColor)));
24d69d27	340	disconnect(signal_, SIGNAL(new_annotations()));
02c87df7 SA	341	disconnect(signal_, SIGNAL(decode_reset()));
02c87df7 SA	342	}
24d69d27 SA	343
	344	reset_data();
	345
	346	decoder_ = (Decoder)decoder_selector_->itemData(index).value<void>();
	347
	348	// Find the signal that contains the selected decoder
	349	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
	350	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	351	if (decoder_ == dec.get())
	352	signal_ = ds.get();
	353
02c87df7	354	if (signal_) {
88a25978	355	connect(signal_, SIGNAL(color_changed(QColor)), this, SLOT(on_signal_color_changed(QColor)));
24d69d27	356	connect(signal_, SIGNAL(new_annotations()), this, SLOT(on_new_annotations()));
02c87df7 SA	357	connect(signal_, SIGNAL(decode_reset()), this, SLOT(on_decoder_reset()));
02c87df7 SA	358	}
24d69d27 SA	359
	360	update_data();
	361	}
	362
	363	void View::on_signal_name_changed(const QString &name)
	364	{
	365	(void)name;
	366
	367	SignalBase* sb = qobject_cast<SignalBase*>(QObject::sender());
	368	assert(sb);
	369
	370	DecodeSignal* signal = dynamic_cast<DecodeSignal*>(sb);
	371	assert(signal);
	372
f54e68b0	373	// Update the top-level decoder provided by this signal
24d69d27	374	auto stack = signal->decoder_stack();
f54e68b0 SA	375	if (!stack.empty()) {
	376	shared_ptr<Decoder>& dec = stack.at(0);
	377	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
24d69d27	378
f54e68b0 SA	379	if (index != -1)
	380	decoder_selector_->setItemText(index, signal->name());
	381	}
24d69d27 SA	382	}
24d69d27 SA	383
88a25978 SA	384	void View::on_signal_color_changed(const QColor &color)
	385	{
	386	(void)color;
	387
	388	table_view_->update();
	389	}
	390
24d69d27 SA	391	void View::on_new_annotations()
	392	{
	393	if (!delayed_view_updater_.isActive())
	394	delayed_view_updater_.start();
	395	}
	396
02c87df7 SA	397	void View::on_decoder_reset()
	398	{
	399	// Invalidate the model's data connection immediately - otherwise we
	400	// will use a stale pointer in model_->index() when called from the table view
	401	model_->set_signal_and_segment(signal_, current_segment_);
	402	}
	403
24d69d27 SA	404	void View::on_decoder_stacked(void* decoder)
24d69d27 SA	405	{
24d69d27 SA	406	Decoder* d = static_cast<Decoder*>(decoder);
	407
	408	// Find the signal that contains the selected decoder
	409	DecodeSignal* signal = nullptr;
	410
	411	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
	412	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	413	if (d == dec.get())
	414	signal = ds.get();
	415
	416	assert(signal);
	417
88a25978 SA	418	const shared_ptr<Decoder>& dec = signal->decoder_stack().at(0);
	419	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	420
	421	if (index == -1) {
	422	// Add the decoder to the list
85125b0f	423	decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)d));
88a25978	424	}
24d69d27 SA	425	}
	426
	427	void View::on_decoder_removed(void* decoder)
	428	{
	429	Decoder* d = static_cast<Decoder*>(decoder);
	430
	431	// Remove the decoder from the list
	432	int index = decoder_selector_->findData(QVariant::fromValue((void*)d));
	433
	434	if (index != -1)
	435	decoder_selector_->removeItem(index);
	436	}
	437
	438	void View::on_actionSave_triggered(QAction* action)
	439	{
be0f5903 SA	440	int save_type = SaveTypeCSVQuoted;
	441
	442	if (action)
	443	save_type = action->data().toInt();
24d69d27	444
be0f5903	445	save_data_as_csv(save_type);
24d69d27 SA	446	}
24d69d27 SA	447
9a35b05d SA	448	void View::on_table_item_clicked(const QModelIndex& index)
	449	{
	450	(void)index;
	451
	452	// Force repaint, otherwise the new selection isn't shown for some reason
	453	table_view_->viewport()->update();
	454	}
	455
	456	void View::on_table_item_double_clicked(const QModelIndex& index)
	457	{
	458	const Annotation* ann = static_cast<const Annotation*>(index.internalPointer());
	459
	460	shared_ptr<views::ViewBase> main_view = session_.main_view();
	461
	462	main_view->focus_on_range(ann->start_sample(), ann->end_sample());
	463	}
	464
	465	void View::on_table_header_requested(const QPoint& pos)
	466	{
	467	QMenu* menu = new QMenu(this);
	468
	469	for (int i = 0; i < table_view_->horizontalHeader()->count(); i++) {
	470	int column = table_view_->horizontalHeader()->logicalIndex(i);
	471
	472	const QString title = model_->headerData(column, Qt::Horizontal, Qt::DisplayRole).toString();
	473	QAction* action = new QAction(title, this);
	474
	475	action->setCheckable(true);
	476	action->setChecked(!table_view_->horizontalHeader()->isSectionHidden(column));
	477	action->setData(column);
	478
	479	connect(action, SIGNAL(toggled(bool)), this, SLOT(on_table_header_toggled(bool)));
	480
	481	menu->addAction(action);
	482	}
	483
	484	menu->popup(table_view_->horizontalHeader()->viewport()->mapToGlobal(pos));
	485	}
	486
	487	void View::on_table_header_toggled(bool checked)
	488	{
	489	QAction* action = qobject_cast<QAction*>(QObject::sender());
	490	assert(action);
	491
	492	const int column = action->data().toInt();
	493
	494	table_view_->horizontalHeader()->setSectionHidden(column, !checked);
	495	}
	496
24d69d27 SA	497	void View::perform_delayed_view_update()
	498	{
	499	update_data();
	500	}
	501
	502
	503	} // namespace tabular_decoder
	504	} // namespace views
	505	} // namespace pv