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

	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();
	class_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)
			// 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_) {
		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_) {
		hex_view_->clear();
		return;
	}

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

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

	hex_view_->setData(bin_class);
}

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

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

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

	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
		uint8_t bin_classes = decoder_->get_binary_class_count();
		for (uint8_t i = 0; i < bin_classes; i++) {
			const data::decode::DecodeBinaryClassInfo* class_info = decoder_->get_binary_class(i);
			class_selector_->addItem(class_info->name, 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<uint8_t>();

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

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


} // 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	60	hex_view_(new QHexView()),
628b45cc	61	signal_(nullptr)
2bdc5796 SA	62	{
	63	QVBoxLayout *root_layout = new QVBoxLayout(this);
	64	root_layout->setContentsMargins(0, 0, 0, 0);
	65
bdbc561f SA	66	// Create toolbar
	67	QToolBar* toolbar = new QToolBar();
	68	toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
	69	parent->addToolBar(toolbar);
a24412db	70
bdbc561f SA	71	// Populate toolbar
bdbc561f SA	72	toolbar->addWidget(new QLabel(tr("Decoder:")));
e77de61f SA	73	toolbar->addWidget(decoder_selector_);
e77de61f SA	74	toolbar->addWidget(class_selector_);
861ab3a4 SA	75	toolbar->addSeparator();
	76	toolbar->addWidget(new QLabel(tr("Show data as")));
	77	toolbar->addWidget(format_selector_);
	78
	79	// Add format types
	80	format_selector_->addItem(tr("Hexdump"), qVariantFromValue(QString("text/hexdump")));
a24412db	81
560f8377 SA	82	// Add widget stack
	83	root_layout->addWidget(stacked_widget_);
	84	stacked_widget_->addWidget(hex_view_);
4b97fe09 SA	85	stacked_widget_->setCurrentIndex(0);
4b97fe09 SA	86
e77de61f SA	87	connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
e77de61f SA	88	this, SLOT(on_selected_decoder_changed(int)));
b2b18d3a SA	89	connect(class_selector_, SIGNAL(currentIndexChanged(int)),
b2b18d3a SA	90	this, SLOT(on_selected_class_changed(int)));
4b97fe09	91
a13d836f SA	92	// Configure widgets
	93	decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
	94	class_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
	95
2bdc5796 SA	96	reset_view_state();
	97	}
	98
	99	View::~View()
	100	{
	101	}
	102
db298158 SA	103	ViewType View::get_type() const
	104	{
	105	return ViewTypeDecoderOutput;
	106	}
	107
2bdc5796 SA	108	void View::reset_view_state()
	109	{
	110	ViewBase::reset_view_state();
	111	}
	112
	113	void View::clear_signals()
	114	{
	115	ViewBase::clear_signalbases();
4b97fe09	116	signal_ = nullptr;
2bdc5796 SA	117	}
	118
	119	void View::clear_decode_signals()
	120	{
e77de61f SA	121	ViewBase::clear_decode_signals();
	122
	123	decoder_selector_->clear();
b2b18d3a	124	class_selector_->clear();
861ab3a4	125	format_selector_->setCurrentIndex(0);
4b97fe09	126	signal_ = nullptr;
2bdc5796 SA	127	}
	128
	129	void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
	130	{
e77de61f SA	131	ViewBase::add_decode_signal(signal);
e77de61f SA	132
2bdc5796	133	connect(signal.get(), SIGNAL(name_changed(const QString&)),
bdbc561f	134	this, SLOT(on_signal_name_changed(const QString&)));
e77de61f SA	135	connect(signal.get(), SIGNAL(decoder_stacked(void*)),
	136	this, SLOT(on_decoder_stacked(void*)));
	137	connect(signal.get(), SIGNAL(decoder_removed(void*)),
	138	this, SLOT(on_decoder_removed(void*)));
	139
	140	// Add all decoders provided by this signal
	141	auto stack = signal->decoder_stack();
	142	if (stack.size() > 1) {
b2b18d3a SA	143	for (const shared_ptr<Decoder>& dec : stack)
	144	// Only add the decoder if it has binary output
	145	if (dec->get_binary_class_count() > 0) {
	146	QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
	147	decoder_selector_->addItem(title, QVariant::fromValue((void*)dec.get()));
	148	}
e77de61f SA	149	} else
	150	if (!stack.empty()) {
	151	shared_ptr<Decoder>& dec = stack.at(0);
b2b18d3a SA	152	if (dec->get_binary_class_count() > 0)
b2b18d3a SA	153	decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get()));
e77de61f	154	}
2bdc5796 SA	155	}
	156
	157	void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
	158	{
e77de61f SA	159	// Remove all decoders provided by this signal
	160	for (const shared_ptr<Decoder>& dec : signal->decoder_stack()) {
	161	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
bdbc561f	162
e77de61f SA	163	if (index != -1)
	164	decoder_selector_->removeItem(index);
	165	}
	166
	167	ViewBase::remove_decode_signal(signal);
4b97fe09 SA	168
	169	if (signal.get() == signal_) {
	170	signal_ = nullptr;
e77de61f SA	171	decoder_ = nullptr;
e77de61f SA	172	bin_class_id_ = 0;
4b97fe09 SA	173	update_data();
4b97fe09 SA	174	}
2bdc5796 SA	175	}
	176
	177	void View::save_settings(QSettings &settings) const
	178	{
	179	(void)settings;
	180	}
	181
	182	void View::restore_settings(QSettings &settings)
	183	{
	184	// Note: It is assumed that this function is only called once,
	185	// immediately after restoring a previous session.
	186	(void)settings;
	187	}
	188
4b97fe09 SA	189	void View::update_data()
	190	{
	191	if (!signal_) {
628b45cc	192	hex_view_->clear();
4b97fe09 SA	193	return;
	194	}
	195
e77de61f	196	if (signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_) == 0) {
628b45cc	197	hex_view_->clear();
4b97fe09 SA	198	return;
	199	}
	200
628b45cc SA	201	const DecodeBinaryClass* bin_class =
628b45cc SA	202	signal_->get_binary_data_class(current_segment_, decoder_, bin_class_id_);
b2b18d3a	203
628b45cc	204	hex_view_->setData(bin_class);
4b97fe09 SA	205	}
4b97fe09 SA	206
e77de61f	207	void View::on_selected_decoder_changed(int index)
4b97fe09 SA	208	{
4b97fe09 SA	209	if (signal_)
b2b18d3a	210	disconnect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)));
4b97fe09	211
e77de61f SA	212	decoder_ = (Decoder)decoder_selector_->itemData(index).value<void>();
	213
	214	// Find the signal that contains the selected decoder
	215	signal_ = nullptr;
	216
b2b18d3a SA	217	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
	218	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	219	if (decoder_ == dec.get())
	220	signal_ = ds.get();
e77de61f	221
b2b18d3a SA	222	class_selector_->clear();
	223
	224	if (signal_) {
	225	// Populate binary class selector
	226	uint8_t bin_classes = decoder_->get_binary_class_count();
	227	for (uint8_t i = 0; i < bin_classes; i++) {
	228	const data::decode::DecodeBinaryClassInfo* class_info = decoder_->get_binary_class(i);
	229	class_selector_->addItem(class_info->name, QVariant::fromValue(i));
	230	}
	231
	232	connect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)),
	233	this, SLOT(on_new_binary_data(unsigned int, void*, unsigned int)));
e77de61f	234	}
4b97fe09	235
b2b18d3a SA	236	update_data();
	237	}
	238
	239	void View::on_selected_class_changed(int index)
	240	{
	241	bin_class_id_ = class_selector_->itemData(index).value<uint8_t>();
e77de61f SA	242
e77de61f SA	243	update_data();
4b97fe09 SA	244	}
4b97fe09 SA	245
bdbc561f	246	void View::on_signal_name_changed(const QString &name)
2bdc5796	247	{
e77de61f SA	248	(void)name;
	249
	250	SignalBase* sb = qobject_cast<SignalBase*>(QObject::sender());
bdbc561f SA	251	assert(sb);
bdbc561f SA	252
e77de61f SA	253	DecodeSignal* signal = dynamic_cast<DecodeSignal*>(sb);
	254	assert(signal);
	255
	256	// Update all decoder entries provided by this signal
	257	auto stack = signal->decoder_stack();
	258	if (stack.size() > 1) {
	259	for (const shared_ptr<Decoder>& dec : stack) {
	260	QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
	261	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	262
	263	if (index != -1)
	264	decoder_selector_->setItemText(index, title);
	265	}
	266	} else
	267	if (!stack.empty()) {
	268	shared_ptr<Decoder>& dec = stack.at(0);
	269	int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
	270
	271	if (index != -1)
	272	decoder_selector_->setItemText(index, signal->name());
	273	}
2bdc5796 SA	274	}
2bdc5796 SA	275
b2b18d3a	276	void View::on_new_binary_data(unsigned int segment_id, void* decoder, unsigned int bin_class_id)
4b97fe09	277	{
b2b18d3a	278	if ((segment_id == current_segment_) && (decoder == decoder_) && (bin_class_id == bin_class_id_))
4b97fe09 SA	279	update_data();
	280	}
	281
e77de61f SA	282	void View::on_decoder_stacked(void* decoder)
	283	{
	284	// TODO This doesn't change existing entries for the same signal - but it should as the naming scheme may change
	285
	286	Decoder* d = static_cast<Decoder*>(decoder);
	287
b2b18d3a SA	288	// Only add the decoder if it has binary output
	289	if (d->get_binary_class_count() == 0)
	290	return;
	291
e77de61f SA	292	// Find the signal that contains the selected decoder
	293	DecodeSignal* signal = nullptr;
	294
	295	for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
	296	for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
	297	if (d == dec.get())
	298	signal = ds.get();
	299
	300	assert(signal);
	301
	302	// Add the decoder to the list
	303	QString title = QString("%1 (%2)").arg(signal->name(), d->name());
	304	decoder_selector_->addItem(title, QVariant::fromValue((void*)d));
	305	}
	306
	307	void View::on_decoder_removed(void* decoder)
	308	{
	309	Decoder* d = static_cast<Decoder*>(decoder);
	310
	311	// Remove the decoder from the list
	312	int index = decoder_selector_->findData(QVariant::fromValue((void*)d));
	313
	314	if (index != -1)
	315	decoder_selector_->removeItem(index);
	316	}
	317
	318
2bdc5796 SA	319	} // namespace decoder_output
	320	} // namespace views
	321	} // namespace pv