[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
	parent_(parent),
	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);

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

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

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


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