[pulseview.git] / pv / views / decoder_output / 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 <QLabel>
#include <QMenu>
#include <QToolBar>
#include <QVBoxLayout>

#include <libsigrokdecode/libsigrokdecode.h>

#include "view.hpp"
#include "QHexView.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::TimeUnit;
using pv::util::Timestamp;

using std::dynamic_pointer_cast;
using std::numeric_limits;
using std::shared_ptr;

namespace pv {
namespace views {
namespace decoder_output {

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
	decoder_selector_(new QComboBox()),
	format_selector_(new QComboBox()),
	class_selector_(new QComboBox()),
	stacked_widget_(new QStackedWidget()),
	hex_view_(new QHexView()),
	signal_(nullptr),
	merged_data_(new QByteArray())
{
	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_);

	// Add format types
	format_selector_->addItem(tr("Hexdump"), qVariantFromValue(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)));

	hex_view_->setData(merged_data_);

	reset_view_state();
}

View::~View()
{
}

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

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

void View::clear_signals()
{
	ViewBase::clear_signalbases();
	signal_ = nullptr;
}

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

	decoder_selector_->clear();
	format_selector_->setCurrentIndex(0);
	signal_ = nullptr;
}

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) {
			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);
			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_) {
		signal_ = nullptr;
		decoder_ = nullptr;
		bin_class_id_ = 0;
		update_data();
	}
}

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

void View::restore_settings(QSettings &settings)
{
	// Note: It is assumed that this function is only called once,
	// immediately after restoring a previous session.
	(void)settings;
}

void View::update_data()
{
	if (!signal_) {
		merged_data_->clear();
		return;
	}

	if (signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_) == 0) {
		merged_data_->clear();
		return;
	}

	vector<uint8_t> data;
	signal_->get_binary_data_chunks_merged(current_segment_, decoder_, bin_class_id_,
		0, numeric_limits<uint64_t>::max(), &data);

	merged_data_->resize(data.size());
	memcpy(merged_data_->data(), data.data(), data.size());
}

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

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

	// Find the signal that contains the selected decoder
	signal_ = nullptr;

	for (const shared_ptr<data::SignalBase>& sb : signalbases_) {
		shared_ptr<DecodeSignal> ds = dynamic_pointer_cast<DecodeSignal>(sb);

		if (ds)
			for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
				if (decoder_ == dec.get())
					signal_ = ds.get();
	}

	if (signal_)
		connect(signal_, SIGNAL(new_binary_data(unsigned int, unsigned int)),
			this, SLOT(on_new_binary_data(unsigned int, unsigned int)));

	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, unsigned int bin_class_id)
{
	if ((segment_id == current_segment_) && (bin_class_id == bin_class_id_))
		update_data();
}

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

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


} // namespace decoder_output
} // 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>
bdbc561f	24	#include <QLabel>
2bdc5796	25	#include <QMenu>
a24412db	26	#include <QToolBar>
2bdc5796 SA	27	#include <QVBoxLayout>
2bdc5796 SA	28
4b97fe09 SA	29	#include <libsigrokdecode/libsigrokdecode.h>
4b97fe09 SA	30
2bdc5796	31	#include "view.hpp"
560f8377	32	#include "QHexView.hpp"
2bdc5796 SA	33
	34	#include "pv/session.hpp"
	35	#include "pv/util.hpp"
e77de61f	36	#include "pv/data/decode/decoder.hpp"
2bdc5796	37
4b97fe09	38	using pv::data::DecodeSignal;
bdbc561f	39	using pv::data::SignalBase;
e77de61f	40	using pv::data::decode::Decoder;
2bdc5796 SA	41	using pv::util::TimeUnit;
	42	using pv::util::Timestamp;
	43
e77de61f	44	using std::dynamic_pointer_cast;
4b97fe09	45	using std::numeric_limits;
2bdc5796 SA	46	using std::shared_ptr;
	47
	48	namespace pv {
	49	namespace views {
	50	namespace decoder_output {
	51
a24412db	52	View::View(Session &session, bool is_main_view, QMainWindow *parent) :
bdbc561f	53	ViewBase(session, is_main_view, parent),
2bdc5796 SA	54
2bdc5796 SA	55	// Note: Place defaults in View::reset_view_state(), not here
e77de61f	56	decoder_selector_(new QComboBox()),
560f8377	57	format_selector_(new QComboBox()),
e77de61f	58	class_selector_(new QComboBox()),
560f8377	59	stacked_widget_(new QStackedWidget()),
4b97fe09 SA	60	hex_view_(new QHexView()),
	61	signal_(nullptr),
	62	merged_data_(new QByteArray())
2bdc5796 SA	63	{
	64	QVBoxLayout *root_layout = new QVBoxLayout(this);
	65	root_layout->setContentsMargins(0, 0, 0, 0);
	66
bdbc561f SA	67	// Create toolbar
	68	QToolBar* toolbar = new QToolBar();
	69	toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
	70	parent->addToolBar(toolbar);
a24412db	71
bdbc561f SA	72	// Populate toolbar
bdbc561f SA	73	toolbar->addWidget(new QLabel(tr("Decoder:")));
e77de61f SA	74	toolbar->addWidget(decoder_selector_);
e77de61f SA	75	toolbar->addWidget(class_selector_);
861ab3a4 SA	76	toolbar->addSeparator();
	77	toolbar->addWidget(new QLabel(tr("Show data as")));
	78	toolbar->addWidget(format_selector_);
	79
	80	// Add format types
	81	format_selector_->addItem(tr("Hexdump"), qVariantFromValue(QString("text/hexdump")));
a24412db	82
560f8377 SA	83	// Add widget stack
	84	root_layout->addWidget(stacked_widget_);
	85	stacked_widget_->addWidget(hex_view_);
4b97fe09 SA	86	stacked_widget_->setCurrentIndex(0);
4b97fe09 SA	87
e77de61f SA	88	connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
e77de61f SA	89	this, SLOT(on_selected_decoder_changed(int)));
4b97fe09 SA	90
4b97fe09 SA	91	hex_view_->setData(merged_data_);
560f8377	92
2bdc5796 SA	93	reset_view_state();
	94	}
	95
	96	View::~View()
	97	{
	98	}
	99
db298158 SA	100	ViewType View::get_type() const
	101	{
	102	return ViewTypeDecoderOutput;
	103	}
	104
2bdc5796 SA	105	void View::reset_view_state()
	106	{
	107	ViewBase::reset_view_state();
	108	}
	109
	110	void View::clear_signals()
	111	{
	112	ViewBase::clear_signalbases();
4b97fe09	113	signal_ = nullptr;
2bdc5796 SA	114	}
	115
	116	void View::clear_decode_signals()
	117	{
e77de61f SA	118	ViewBase::clear_decode_signals();
	119
	120	decoder_selector_->clear();
861ab3a4	121	format_selector_->setCurrentIndex(0);
4b97fe09	122	signal_ = nullptr;
2bdc5796 SA	123	}
	124
	125	void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
	126	{
e77de61f SA	127	ViewBase::add_decode_signal(signal);
e77de61f SA	128
2bdc5796	129	connect(signal.get(), SIGNAL(name_changed(const QString&)),
bdbc561f	130	this, SLOT(on_signal_name_changed(const QString&)));
e77de61f SA	131	connect(signal.get(), SIGNAL(decoder_stacked(void*)),
	132	this, SLOT(on_decoder_stacked(void*)));
	133	connect(signal.get(), SIGNAL(decoder_removed(void*)),
	134	this, SLOT(on_decoder_removed(void*)));
	135
	136	// Add all decoders provided by this signal
	137	auto stack = signal->decoder_stack();
	138	if (stack.size() > 1) {
	139	for (const shared_ptr<Decoder>& dec : stack) {
	140	QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
	141	decoder_selector_->addItem(title, QVariant::fromValue((void*)dec.get()));
	142	}
	143	} else
	144	if (!stack.empty()) {
	145	shared_ptr<Decoder>& dec = stack.at(0);
	146	decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get()));
	147	}
2bdc5796 SA	148	}
	149
	150	void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
	151	{
e77de61f SA	152	// Remove all decoders provided by this signal
	153	for (const shared_ptr<Decoder>& dec : signal->decoder_stack()) {
	154	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
bdbc561f	155
e77de61f SA	156	if (index != -1)
	157	decoder_selector_->removeItem(index);
	158	}
	159
	160	ViewBase::remove_decode_signal(signal);
4b97fe09 SA	161
	162	if (signal.get() == signal_) {
	163	signal_ = nullptr;
e77de61f SA	164	decoder_ = nullptr;
e77de61f SA	165	bin_class_id_ = 0;
4b97fe09 SA	166	update_data();
4b97fe09 SA	167	}
2bdc5796 SA	168	}
	169
	170	void View::save_settings(QSettings &settings) const
	171	{
	172	(void)settings;
	173	}
	174
	175	void View::restore_settings(QSettings &settings)
	176	{
	177	// Note: It is assumed that this function is only called once,
	178	// immediately after restoring a previous session.
	179	(void)settings;
	180	}
	181
4b97fe09 SA	182	void View::update_data()
	183	{
	184	if (!signal_) {
	185	merged_data_->clear();
	186	return;
	187	}
	188
e77de61f	189	if (signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_) == 0) {
4b97fe09 SA	190	merged_data_->clear();
	191	return;
	192	}
	193
	194	vector<uint8_t> data;
e77de61f SA	195	signal_->get_binary_data_chunks_merged(current_segment_, decoder_, bin_class_id_,
e77de61f SA	196	0, numeric_limits<uint64_t>::max(), &data);
4b97fe09 SA	197
	198	merged_data_->resize(data.size());
	199	memcpy(merged_data_->data(), data.data(), data.size());
	200	}
	201
e77de61f	202	void View::on_selected_decoder_changed(int index)
4b97fe09 SA	203	{
4b97fe09 SA	204	if (signal_)
e77de61f	205	disconnect(signal_, SIGNAL(new_binary_data(unsigned int, unsigned int)));
4b97fe09	206
e77de61f SA	207	decoder_ = (Decoder)decoder_selector_->itemData(index).value<void>();
	208
	209	// Find the signal that contains the selected decoder
	210	signal_ = nullptr;
	211
	212	for (const shared_ptr<data::SignalBase>& sb : signalbases_) {
	213	shared_ptr<DecodeSignal> ds = dynamic_pointer_cast<DecodeSignal>(sb);
	214
	215	if (ds)
	216	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	217	if (decoder_ == dec.get())
	218	signal_ = ds.get();
	219	}
4b97fe09 SA	220
4b97fe09 SA	221	if (signal_)
e77de61f SA	222	connect(signal_, SIGNAL(new_binary_data(unsigned int, unsigned int)),
	223	this, SLOT(on_new_binary_data(unsigned int, unsigned int)));
	224
	225	update_data();
4b97fe09 SA	226	}
4b97fe09 SA	227
bdbc561f	228	void View::on_signal_name_changed(const QString &name)
2bdc5796	229	{
e77de61f SA	230	(void)name;
	231
	232	SignalBase* sb = qobject_cast<SignalBase*>(QObject::sender());
bdbc561f SA	233	assert(sb);
bdbc561f SA	234
e77de61f SA	235	DecodeSignal* signal = dynamic_cast<DecodeSignal*>(sb);
	236	assert(signal);
	237
	238	// Update all decoder entries provided by this signal
	239	auto stack = signal->decoder_stack();
	240	if (stack.size() > 1) {
	241	for (const shared_ptr<Decoder>& dec : stack) {
	242	QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
	243	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	244
	245	if (index != -1)
	246	decoder_selector_->setItemText(index, title);
	247	}
	248	} else
	249	if (!stack.empty()) {
	250	shared_ptr<Decoder>& dec = stack.at(0);
	251	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	252
	253	if (index != -1)
	254	decoder_selector_->setItemText(index, signal->name());
	255	}
2bdc5796 SA	256	}
2bdc5796 SA	257
e77de61f	258	void View::on_new_binary_data(unsigned int segment_id, unsigned int bin_class_id)
4b97fe09	259	{
e77de61f	260	if ((segment_id == current_segment_) && (bin_class_id == bin_class_id_))
4b97fe09 SA	261	update_data();
	262	}
	263
e77de61f SA	264	void View::on_decoder_stacked(void* decoder)
	265	{
	266	// TODO This doesn't change existing entries for the same signal - but it should as the naming scheme may change
	267
	268	Decoder* d = static_cast<Decoder*>(decoder);
	269
	270	// Find the signal that contains the selected decoder
	271	DecodeSignal* signal = nullptr;
	272
	273	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
	274	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	275	if (d == dec.get())
	276	signal = ds.get();
	277
	278	assert(signal);
	279
	280	// Add the decoder to the list
	281	QString title = QString("%1 (%2)").arg(signal->name(), d->name());
	282	decoder_selector_->addItem(title, QVariant::fromValue((void*)d));
	283	}
	284
	285	void View::on_decoder_removed(void* decoder)
	286	{
	287	Decoder* d = static_cast<Decoder*>(decoder);
	288
	289	// Remove the decoder from the list
	290	int index = decoder_selector_->findData(QVariant::fromValue((void*)d));
	291
	292	if (index != -1)
	293	decoder_selector_->removeItem(index);
	294	}
	295
	296
2bdc5796 SA	297	} // namespace decoder_output
	298	} // namespace views
	299	} // namespace pv