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

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2019 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 <QByteArray>
#include <QDebug>
#include <QFileDialog>
#include <QLabel>
#include <QMenu>
#include <QMessageBox>
#include <QToolBar>
#include <QVBoxLayout>

#include <libsigrokdecode/libsigrokdecode.h>

#include "view.hpp"
#include "QHexView.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::shared_ptr;

namespace pv {
namespace views {
namespace decoder_binary {

const char* SaveTypeNames[SaveTypeCount] = {
	"Binary",
	"Hex Dump, plain",
	"Hex Dump, with offset",
	"Hex Dump, canonical"
};


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()),
	format_selector_(new QComboBox()),
	class_selector_(new QComboBox()),
	stacked_widget_(new QStackedWidget()),
	hex_view_(new QHexView()),
	save_button_(new QToolButton()),
	save_action_(new QAction(this)),
	signal_(nullptr)
{
	QVBoxLayout *root_layout = new QVBoxLayout(this);
	root_layout->setContentsMargins(0, 0, 0, 0);

	// 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->addWidget(class_selector_);
	toolbar->addSeparator();
	toolbar->addWidget(new QLabel(tr("Show data as")));
	toolbar->addWidget(format_selector_);
	toolbar->addSeparator();
	toolbar->addWidget(save_button_);

	// Add format types
	format_selector_->addItem(tr("Hexdump"), QVariant(QString("text/hexdump")));

	// Add widget stack
	root_layout->addWidget(stacked_widget_);
	stacked_widget_->addWidget(hex_view_);
	stacked_widget_->setCurrentIndex(0);

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

	// Configure widgets
	decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
	class_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(QVariant::fromValue(i));
	}

	save_button_->setMenu(save_menu);
	save_button_->setDefaultAction(save_action_);
	save_button_->setPopupMode(QToolButton::MenuButtonPopup);

	parent->setSizePolicy(hex_view_->sizePolicy()); // TODO Must be updated when selected widget changes

	// 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 ViewTypeDecoderBinary;
}

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

	decoder_selector_->clear();
	class_selector_->clear();
	format_selector_->setCurrentIndex(0);
	save_button_->setEnabled(false);

	hex_view_->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&)));
	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
	auto stack = signal->decoder_stack();
	if (stack.size() > 1) {
		for (const shared_ptr<Decoder>& dec : stack)
			// Only add the decoder if it has binary output
			if (dec->get_binary_class_count() > 0) {
				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<Decoder>& dec = stack.at(0);
			if (dec->get_binary_class_count() > 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;
	bin_class_id_ = 0;
	binary_data_exists_ = false;

	hex_view_->clear();
}

void View::update_data()
{
	if (!signal_)
		return;

	const DecodeBinaryClass* bin_class =
		signal_->get_binary_data_class(current_segment_, decoder_, bin_class_id_);

	hex_view_->set_data(bin_class);

	if (!binary_data_exists_)
		return;

	if (!save_button_->isEnabled())
		save_button_->setEnabled(true);
}

void View::save_data() const
{
	assert(decoder_);
	assert(signal_);

	if (!signal_)
		return;

	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 (*)"));

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

		vector<uint8_t> data;
		data.resize(selection.second - selection.first + 1);

		signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_,
			bin_class_id_, selection.first, selection.second, &data);

		int64_t bytes_written = file.write((const char*)data.data(), data.size());

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

void View::save_data_as_hex_dump(bool with_offset, bool with_ascii) const
{
	assert(decoder_);
	assert(signal_);

	if (!signal_)
		return;

	GlobalSettings settings;
	const QString dir = settings.value("MainWindow/SaveDirectory").toString();

	const QString file_name = QFileDialog::getSaveFileName(
		parent_, tr("Save Binary Data"), dir, tr("Hex Dumps (*.txt);;All Files (*)"));

	if (file_name.isEmpty())
		return;

	QFile file(file_name);
	if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
		pair<size_t, size_t> selection = hex_view_->get_selection();

		vector<uint8_t> data;
		data.resize(selection.second - selection.first + 1);

		signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_,
			bin_class_id_, selection.first, selection.second, &data);

		QTextStream out_stream(&file);

		uint64_t offset = selection.first;
		uint64_t n = hex_view_->get_bytes_per_line();
		QString s;

		while (offset < selection.second) {
			size_t end = std::min((uint64_t)(selection.second), offset + n);
			offset = hex_view_->create_hex_line(offset, end, &s, with_offset, with_ascii);
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
			out_stream << s << Qt::endl;
#else
			out_stream << s << endl;
#endif
		}

#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
		out_stream << Qt::endl;
#else
		out_stream << endl;
#endif

		if (out_stream.status() != QTextStream::Ok) {
			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;
		}
	}
}

void View::on_selected_decoder_changed(int index)
{
	if (signal_)
		disconnect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)));

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

	class_selector_->clear();

	if (signal_) {
		// Populate binary class selector
		uint32_t bin_classes = decoder_->get_binary_class_count();
		for (uint32_t i = 0; i < bin_classes; i++) {
			const data::decode::DecodeBinaryClassInfo* class_info = decoder_->get_binary_class(i);
			class_selector_->addItem(class_info->description, QVariant::fromValue(i));
		}

		connect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)),
			this, SLOT(on_new_binary_data(unsigned int, void*, unsigned int)));
	}

	update_data();
}

void View::on_selected_class_changed(int index)
{
	bin_class_id_ = class_selector_->itemData(index).value<uint32_t>();

	binary_data_exists_ = (signal_) ?
		signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_) :
		false;

	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 all decoder entries provided by this signal
	auto stack = signal->decoder_stack();
	if (stack.size() > 1) {
		for (const shared_ptr<Decoder>& dec : stack) {
			QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
			int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));

			if (index != -1)
				decoder_selector_->setItemText(index, title);
		}
	} else
		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_new_binary_data(unsigned int segment_id, void* decoder, unsigned int bin_class_id)
{
	if ((segment_id == current_segment_) && (decoder == decoder_) && (bin_class_id == bin_class_id_))
		if (!delayed_view_updater_.isActive())
			delayed_view_updater_.start();
}

void View::on_decoder_stacked(void* decoder)
{
	// TODO This doesn't change existing entries for the same signal - but it should as the naming scheme may change

	Decoder* d = static_cast<Decoder*>(decoder);

	// Only add the decoder if it has binary output
	if (d->get_binary_class_count() == 0)
		return;

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

	// Add the decoder to the list
	QString title = QString("%1 (%2)").arg(signal->name(), d->name());
	decoder_selector_->addItem(title, 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 = SaveTypeBinary;
	if (action)
		save_type = action->data().toInt();

	switch (save_type)
	{
	case SaveTypeBinary: save_data(); break;
	case SaveTypeHexDumpPlain: save_data_as_hex_dump(false, false); break;
	case SaveTypeHexDumpWithOffset: save_data_as_hex_dump(true, false); break;
	case SaveTypeHexDumpComplete: save_data_as_hex_dump(true, true); break;
	}
}

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 need both
	if ((obj->type() == MetadataObjMainViewRange) &&
		(value_type == MetadataValueEndSample)) {

		int64_t start_sample = obj->value(MetadataValueStartSample).toLongLong();
		int64_t end_sample = obj->value(MetadataValueEndSample).toLongLong();

		hex_view_->set_visible_sample_range(start_sample, end_sample);
	}

	if (obj->type() == MetadataObjMousePos)
		hex_view_->set_highlighted_data_sample(obj->value(MetadataValueStartSample).toLongLong());
}

void View::perform_delayed_view_update()
{
	if (signal_ && !binary_data_exists_)
		if (signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_))
			binary_data_exists_ = true;

	update_data();
}


} // namespace decoder_binary
} // namespace views
} // namespace pv
Commit	Line	Data
2bdc5796 SA	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2019 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
4b97fe09	20	#include <climits>
2bdc5796	21
4b97fe09 SA	22	#include <QByteArray>
4b97fe09 SA	23	#include <QDebug>
13b726cd	24	#include <QFileDialog>
bdbc561f	25	#include <QLabel>
2bdc5796	26	#include <QMenu>
13b726cd	27	#include <QMessageBox>
a24412db	28	#include <QToolBar>
2bdc5796 SA	29	#include <QVBoxLayout>
2bdc5796 SA	30
4b97fe09 SA	31	#include <libsigrokdecode/libsigrokdecode.h>
4b97fe09 SA	32
2bdc5796	33	#include "view.hpp"
560f8377	34	#include "QHexView.hpp"
2bdc5796	35
13b726cd	36	#include "pv/globalsettings.hpp"
2bdc5796 SA	37	#include "pv/session.hpp"
2bdc5796 SA	38	#include "pv/util.hpp"
e77de61f	39	#include "pv/data/decode/decoder.hpp"
2bdc5796	40
4b97fe09	41	using pv::data::DecodeSignal;
bdbc561f	42	using pv::data::SignalBase;
e77de61f	43	using pv::data::decode::Decoder;
2bdc5796 SA	44	using pv::util::Timestamp;
	45
	46	using std::shared_ptr;
	47
	48	namespace pv {
	49	namespace views {
121307b3	50	namespace decoder_binary {
2bdc5796	51
03408f5f SA	52	const char* SaveTypeNames[SaveTypeCount] = {
03408f5f SA	53	"Binary",
d5645564 SA	54	"Hex Dump, plain",
d5645564 SA	55	"Hex Dump, with offset",
7a8a02ca	56	"Hex Dump, canonical"
03408f5f SA	57	};
	58
	59
a24412db	60	View::View(Session &session, bool is_main_view, QMainWindow *parent) :
bdbc561f	61	ViewBase(session, is_main_view, parent),
2bdc5796 SA	62
2bdc5796 SA	63	// Note: Place defaults in View::reset_view_state(), not here
6961eab0	64	parent_(parent),
e77de61f	65	decoder_selector_(new QComboBox()),
560f8377	66	format_selector_(new QComboBox()),
e77de61f	67	class_selector_(new QComboBox()),
560f8377	68	stacked_widget_(new QStackedWidget()),
4b97fe09	69	hex_view_(new QHexView()),
03408f5f SA	70	save_button_(new QToolButton()),
03408f5f SA	71	save_action_(new QAction(this)),
628b45cc	72	signal_(nullptr)
2bdc5796 SA	73	{
	74	QVBoxLayout *root_layout = new QVBoxLayout(this);
	75	root_layout->setContentsMargins(0, 0, 0, 0);
	76
bdbc561f SA	77	// Create toolbar
	78	QToolBar* toolbar = new QToolBar();
	79	toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
	80	parent->addToolBar(toolbar);
a24412db	81
bdbc561f SA	82	// Populate toolbar
bdbc561f SA	83	toolbar->addWidget(new QLabel(tr("Decoder:")));
e77de61f SA	84	toolbar->addWidget(decoder_selector_);
e77de61f SA	85	toolbar->addWidget(class_selector_);
861ab3a4 SA	86	toolbar->addSeparator();
	87	toolbar->addWidget(new QLabel(tr("Show data as")));
	88	toolbar->addWidget(format_selector_);
03408f5f SA	89	toolbar->addSeparator();
03408f5f SA	90	toolbar->addWidget(save_button_);
861ab3a4 SA	91
861ab3a4 SA	92	// Add format types
009fc9ae	93	format_selector_->addItem(tr("Hexdump"), QVariant(QString("text/hexdump")));
a24412db	94
560f8377 SA	95	// Add widget stack
	96	root_layout->addWidget(stacked_widget_);
	97	stacked_widget_->addWidget(hex_view_);
4b97fe09 SA	98	stacked_widget_->setCurrentIndex(0);
4b97fe09 SA	99
e77de61f SA	100	connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
e77de61f SA	101	this, SLOT(on_selected_decoder_changed(int)));
b2b18d3a SA	102	connect(class_selector_, SIGNAL(currentIndexChanged(int)),
b2b18d3a SA	103	this, SLOT(on_selected_class_changed(int)));
4b97fe09	104
a13d836f SA	105	// Configure widgets
	106	decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
	107	class_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
	108
03408f5f SA	109	// Configure actions
	110	save_action_->setText(tr("&Save..."));
	111	save_action_->setIcon(QIcon::fromTheme("document-save-as",
	112	QIcon(":/icons/document-save-as.png")));
	113	save_action_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
	114	connect(save_action_, SIGNAL(triggered(bool)),
	115	this, SLOT(on_actionSave_triggered()));
	116
	117	QMenu *save_menu = new QMenu();
	118	connect(save_menu, SIGNAL(triggered(QAction*)),
	119	this, SLOT(on_actionSave_triggered(QAction*)));
	120
	121	for (int i = 0; i < SaveTypeCount; i++) {
	122	QAction *const action = save_menu->addAction(tr(SaveTypeNames[i]));
009fc9ae	123	action->setData(QVariant::fromValue(i));
03408f5f SA	124	}
	125
	126	save_button_->setMenu(save_menu);
	127	save_button_->setDefaultAction(save_action_);
	128	save_button_->setPopupMode(QToolButton::MenuButtonPopup);
	129
6961eab0 SA	130	parent->setSizePolicy(hex_view_->sizePolicy()); // TODO Must be updated when selected widget changes
6961eab0 SA	131
978dbc9a SA	132	// Set up metadata event handler
	133	session_.metadata_obj_manager()->add_observer(this);
	134
2bdc5796 SA	135	reset_view_state();
	136	}
	137
978dbc9a SA	138	View::~View()
	139	{
	140	session_.metadata_obj_manager()->remove_observer(this);
	141	}
	142
db298158 SA	143	ViewType View::get_type() const
db298158 SA	144	{
121307b3	145	return ViewTypeDecoderBinary;
db298158 SA	146	}
db298158 SA	147
2bdc5796 SA	148	void View::reset_view_state()
	149	{
	150	ViewBase::reset_view_state();
2bdc5796	151
03408f5f SA	152	decoder_selector_->clear();
	153	class_selector_->clear();
	154	format_selector_->setCurrentIndex(0);
	155	save_button_->setEnabled(false);
	156
	157	hex_view_->clear();
2bdc5796 SA	158	}
	159
	160	void View::clear_decode_signals()
	161	{
e77de61f SA	162	ViewBase::clear_decode_signals();
e77de61f SA	163
03408f5f SA	164	reset_data();
03408f5f SA	165	reset_view_state();
2bdc5796 SA	166	}
	167
	168	void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
	169	{
e77de61f SA	170	ViewBase::add_decode_signal(signal);
e77de61f SA	171
2bdc5796	172	connect(signal.get(), SIGNAL(name_changed(const QString&)),
bdbc561f	173	this, SLOT(on_signal_name_changed(const QString&)));
e77de61f SA	174	connect(signal.get(), SIGNAL(decoder_stacked(void*)),
	175	this, SLOT(on_decoder_stacked(void*)));
	176	connect(signal.get(), SIGNAL(decoder_removed(void*)),
	177	this, SLOT(on_decoder_removed(void*)));
	178
	179	// Add all decoders provided by this signal
	180	auto stack = signal->decoder_stack();
	181	if (stack.size() > 1) {
b2b18d3a SA	182	for (const shared_ptr<Decoder>& dec : stack)
	183	// Only add the decoder if it has binary output
	184	if (dec->get_binary_class_count() > 0) {
	185	QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
	186	decoder_selector_->addItem(title, QVariant::fromValue((void*)dec.get()));
	187	}
e77de61f SA	188	} else
	189	if (!stack.empty()) {
	190	shared_ptr<Decoder>& dec = stack.at(0);
b2b18d3a SA	191	if (dec->get_binary_class_count() > 0)
b2b18d3a SA	192	decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get()));
e77de61f	193	}
2bdc5796 SA	194	}
	195
	196	void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
	197	{
e77de61f SA	198	// Remove all decoders provided by this signal
	199	for (const shared_ptr<Decoder>& dec : signal->decoder_stack()) {
	200	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
bdbc561f	201
e77de61f SA	202	if (index != -1)
	203	decoder_selector_->removeItem(index);
	204	}
	205
	206	ViewBase::remove_decode_signal(signal);
4b97fe09 SA	207
4b97fe09 SA	208	if (signal.get() == signal_) {
03408f5f	209	reset_data();
4b97fe09	210	update_data();
03408f5f	211	reset_view_state();
4b97fe09	212	}
2bdc5796 SA	213	}
	214
	215	void View::save_settings(QSettings &settings) const
	216	{
24d69d27	217	ViewBase::save_settings(settings);
2bdc5796 SA	218	}
	219
	220	void View::restore_settings(QSettings &settings)
	221	{
	222	// Note: It is assumed that this function is only called once,
	223	// immediately after restoring a previous session.
24d69d27	224	ViewBase::restore_settings(settings);
2bdc5796 SA	225	}
2bdc5796 SA	226
03408f5f SA	227	void View::reset_data()
	228	{
	229	signal_ = nullptr;
	230	decoder_ = nullptr;
	231	bin_class_id_ = 0;
	232	binary_data_exists_ = false;
	233
	234	hex_view_->clear();
	235	}
	236
4b97fe09 SA	237	void View::update_data()
4b97fe09 SA	238	{
03408f5f	239	if (!signal_)
4b97fe09	240	return;
4b97fe09	241
628b45cc SA	242	const DecodeBinaryClass* bin_class =
628b45cc SA	243	signal_->get_binary_data_class(current_segment_, decoder_, bin_class_id_);
b2b18d3a	244
d5645564	245	hex_view_->set_data(bin_class);
13b726cd	246
ff9f0baf SA	247	if (!binary_data_exists_)
	248	return;
	249
13b726cd SA	250	if (!save_button_->isEnabled())
	251	save_button_->setEnabled(true);
	252	}
	253
	254	void View::save_data() const
	255	{
	256	assert(decoder_);
	257	assert(signal_);
	258
	259	if (!signal_)
	260	return;
	261
	262	GlobalSettings settings;
	263	const QString dir = settings.value("MainWindow/SaveDirectory").toString();
	264
	265	const QString file_name = QFileDialog::getSaveFileName(
	266	parent_, tr("Save Binary Data"), dir, tr("Binary Data Files (.bin);;All Files ()"));
	267
	268	if (file_name.isEmpty())
	269	return;
	270
	271	QFile file(file_name);
	272	if (file.open(QIODevice::WriteOnly \| QIODevice::Truncate)) {
	273	pair<size_t, size_t> selection = hex_view_->get_selection();
	274
	275	vector<uint8_t> data;
e094bcb2 SA	276	data.resize(selection.second - selection.first + 1);
e094bcb2 SA	277
13b726cd SA	278	signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_,
	279	bin_class_id_, selection.first, selection.second, &data);
	280
	281	int64_t bytes_written = file.write((const char*)data.data(), data.size());
	282
	283	if ((bytes_written == -1) \|\| ((uint64_t)bytes_written != data.size())) {
	284	QMessageBox msg(parent_);
	285	msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
	286	msg.setStandardButtons(QMessageBox::Ok);
	287	msg.setIcon(QMessageBox::Warning);
	288	msg.exec();
	289	return;
	290	}
	291	}
	292	}
	293
d5645564	294	void View::save_data_as_hex_dump(bool with_offset, bool with_ascii) const
13b726cd	295	{
d5645564 SA	296	assert(decoder_);
	297	assert(signal_);
	298
	299	if (!signal_)
	300	return;
	301
	302	GlobalSettings settings;
	303	const QString dir = settings.value("MainWindow/SaveDirectory").toString();
	304
	305	const QString file_name = QFileDialog::getSaveFileName(
	306	parent_, tr("Save Binary Data"), dir, tr("Hex Dumps (.txt);;All Files ()"));
	307
	308	if (file_name.isEmpty())
	309	return;
	310
	311	QFile file(file_name);
	312	if (file.open(QIODevice::WriteOnly \| QIODevice::Truncate \| QIODevice::Text)) {
	313	pair<size_t, size_t> selection = hex_view_->get_selection();
	314
	315	vector<uint8_t> data;
e094bcb2 SA	316	data.resize(selection.second - selection.first + 1);
e094bcb2 SA	317
d5645564 SA	318	signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_,
	319	bin_class_id_, selection.first, selection.second, &data);
	320
	321	QTextStream out_stream(&file);
	322
	323	uint64_t offset = selection.first;
44b2b6b7	324	uint64_t n = hex_view_->get_bytes_per_line();
d5645564	325	QString s;
13b726cd	326
d5645564	327	while (offset < selection.second) {
44b2b6b7	328	size_t end = std::min((uint64_t)(selection.second), offset + n);
d5645564	329	offset = hex_view_->create_hex_line(offset, end, &s, with_offset, with_ascii);
ffad6cd6 SA	330	#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
	331	out_stream << s << Qt::endl;
	332	#else
d5645564	333	out_stream << s << endl;
ffad6cd6	334	#endif
d5645564 SA	335	}
d5645564 SA	336
ffad6cd6 SA	337	#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
	338	out_stream << Qt::endl;
	339	#else
d5645564	340	out_stream << endl;
ffad6cd6	341	#endif
d5645564 SA	342
	343	if (out_stream.status() != QTextStream::Ok) {
	344	QMessageBox msg(parent_);
	345	msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
	346	msg.setStandardButtons(QMessageBox::Ok);
	347	msg.setIcon(QMessageBox::Warning);
	348	msg.exec();
	349	return;
	350	}
	351	}
4b97fe09 SA	352	}
4b97fe09 SA	353
e77de61f	354	void View::on_selected_decoder_changed(int index)
4b97fe09 SA	355	{
4b97fe09 SA	356	if (signal_)
b2b18d3a	357	disconnect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)));
4b97fe09	358
03408f5f SA	359	reset_data();
03408f5f SA	360
e77de61f SA	361	decoder_ = (Decoder)decoder_selector_->itemData(index).value<void>();
	362
	363	// Find the signal that contains the selected decoder
b2b18d3a SA	364	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
	365	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	366	if (decoder_ == dec.get())
	367	signal_ = ds.get();
e77de61f	368
b2b18d3a SA	369	class_selector_->clear();
	370
	371	if (signal_) {
	372	// Populate binary class selector
ac9494ef SA	373	uint32_t bin_classes = decoder_->get_binary_class_count();
ac9494ef SA	374	for (uint32_t i = 0; i < bin_classes; i++) {
b2b18d3a	375	const data::decode::DecodeBinaryClassInfo* class_info = decoder_->get_binary_class(i);
cbf428c2	376	class_selector_->addItem(class_info->description, QVariant::fromValue(i));
b2b18d3a SA	377	}
	378
	379	connect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)),
	380	this, SLOT(on_new_binary_data(unsigned int, void*, unsigned int)));
e77de61f	381	}
4b97fe09	382
b2b18d3a SA	383	update_data();
	384	}
	385
	386	void View::on_selected_class_changed(int index)
	387	{
ac9494ef	388	bin_class_id_ = class_selector_->itemData(index).value<uint32_t>();
e77de61f	389
f95b1d81 SA	390	binary_data_exists_ = (signal_) ?
	391	signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_) :
	392	false;
03408f5f	393
e77de61f	394	update_data();
4b97fe09 SA	395	}
4b97fe09 SA	396
bdbc561f	397	void View::on_signal_name_changed(const QString &name)
2bdc5796	398	{
e77de61f SA	399	(void)name;
	400
	401	SignalBase* sb = qobject_cast<SignalBase*>(QObject::sender());
bdbc561f SA	402	assert(sb);
bdbc561f SA	403
e77de61f SA	404	DecodeSignal* signal = dynamic_cast<DecodeSignal*>(sb);
	405	assert(signal);
	406
	407	// Update all decoder entries provided by this signal
	408	auto stack = signal->decoder_stack();
	409	if (stack.size() > 1) {
	410	for (const shared_ptr<Decoder>& dec : stack) {
	411	QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
	412	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	413
	414	if (index != -1)
	415	decoder_selector_->setItemText(index, title);
	416	}
	417	} else
	418	if (!stack.empty()) {
	419	shared_ptr<Decoder>& dec = stack.at(0);
	420	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	421
	422	if (index != -1)
	423	decoder_selector_->setItemText(index, signal->name());
	424	}
2bdc5796 SA	425	}
2bdc5796 SA	426
b2b18d3a	427	void View::on_new_binary_data(unsigned int segment_id, void* decoder, unsigned int bin_class_id)
4b97fe09	428	{
b2b18d3a	429	if ((segment_id == current_segment_) && (decoder == decoder_) && (bin_class_id == bin_class_id_))
516d2128 SA	430	if (!delayed_view_updater_.isActive())
516d2128 SA	431	delayed_view_updater_.start();
4b97fe09 SA	432	}
4b97fe09 SA	433
e77de61f SA	434	void View::on_decoder_stacked(void* decoder)
	435	{
	436	// TODO This doesn't change existing entries for the same signal - but it should as the naming scheme may change
	437
	438	Decoder* d = static_cast<Decoder*>(decoder);
	439
b2b18d3a SA	440	// Only add the decoder if it has binary output
	441	if (d->get_binary_class_count() == 0)
	442	return;
	443
e77de61f SA	444	// Find the signal that contains the selected decoder
	445	DecodeSignal* signal = nullptr;
	446
	447	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
	448	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	449	if (d == dec.get())
	450	signal = ds.get();
	451
	452	assert(signal);
	453
	454	// Add the decoder to the list
	455	QString title = QString("%1 (%2)").arg(signal->name(), d->name());
	456	decoder_selector_->addItem(title, QVariant::fromValue((void*)d));
	457	}
	458
	459	void View::on_decoder_removed(void* decoder)
	460	{
	461	Decoder* d = static_cast<Decoder*>(decoder);
	462
	463	// Remove the decoder from the list
	464	int index = decoder_selector_->findData(QVariant::fromValue((void*)d));
	465
	466	if (index != -1)
	467	decoder_selector_->removeItem(index);
	468	}
	469
03408f5f SA	470	void View::on_actionSave_triggered(QAction* action)
03408f5f SA	471	{
13b726cd SA	472	int save_type = SaveTypeBinary;
	473	if (action)
	474	save_type = action->data().toInt();
	475
d5645564 SA	476	switch (save_type)
	477	{
	478	case SaveTypeBinary: save_data(); break;
	479	case SaveTypeHexDumpPlain: save_data_as_hex_dump(false, false); break;
	480	case SaveTypeHexDumpWithOffset: save_data_as_hex_dump(true, false); break;
	481	case SaveTypeHexDumpComplete: save_data_as_hex_dump(true, true); break;
	482	}
03408f5f SA	483	}
03408f5f SA	484
978dbc9a SA	485	void View::on_metadata_object_changed(MetadataObject* obj,
	486	MetadataValueType value_type)
	487	{
	488	// Check if we need to update the model's data range. We only work on the
	489	// end sample value because the start sample value is updated first and
	490	// we need both
	491	if ((obj->type() == MetadataObjMainViewRange) &&
	492	(value_type == MetadataValueEndSample)) {
	493
	494	int64_t start_sample = obj->value(MetadataValueStartSample).toLongLong();
	495	int64_t end_sample = obj->value(MetadataValueEndSample).toLongLong();
	496
	497	hex_view_->set_visible_sample_range(start_sample, end_sample);
	498	}
	499
	500	if (obj->type() == MetadataObjMousePos)
	501	hex_view_->set_highlighted_data_sample(obj->value(MetadataValueStartSample).toLongLong());
	502	}
	503
516d2128 SA	504	void View::perform_delayed_view_update()
516d2128 SA	505	{
ee4ba097	506	if (signal_ && !binary_data_exists_)
13b726cd	507	if (signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_))
03408f5f SA	508	binary_data_exists_ = true;
03408f5f SA	509
516d2128 SA	510	update_data();
	511	}
	512
e77de61f	513
121307b3	514	} // namespace decoder_binary
2bdc5796 SA	515	} // namespace views
2bdc5796 SA	516	} // namespace pv