[pulseview.git] / pv / subwindows / decoder_selector / subwindow.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2018 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 <algorithm>

#include <QDebug>
#include <QInputDialog>
#include <QLabel>
#include <QLineEdit>
#include <QPushButton>
#include <QVBoxLayout>

#include "pv/session.hpp"
#include "pv/subwindows/decoder_selector/subwindow.hpp"

using std::reverse;
using std::shared_ptr;

namespace pv {
namespace subwindows {
namespace decoder_selector {


bool QCustomSortFilterProxyModel::filterAcceptsRow(int source_row,
	const QModelIndex& source_parent) const
{
	// Search model recursively

	if (QSortFilterProxyModel::filterAcceptsRow(source_row, source_parent))
		return true;

	const QModelIndex index = sourceModel()->index(source_row, 0, source_parent);

	for (int i = 0; i < sourceModel()->rowCount(index); i++)
		if (filterAcceptsRow(i, index))
			return true;

	return false;
}


void QCustomTreeView::currentChanged(const QModelIndex& current,
	const QModelIndex& previous)
{
	QTreeView::currentChanged(current, previous);
	currentChanged(current);
}


SubWindow::SubWindow(Session& session, QWidget* parent) :
	SubWindowBase(session, parent),
	splitter_(new QSplitter()),
	tree_view_(new QCustomTreeView()),
	info_box_(new QWidget()),
	info_label_header_(new QLabel()),
	info_label_body_(new QLabel()),
	info_label_footer_(new QLabel()),
	model_(new DecoderCollectionModel()),
	sort_filter_model_(new QCustomSortFilterProxyModel())
{
	QVBoxLayout* root_layout = new QVBoxLayout(this);
	root_layout->setContentsMargins(0, 0, 0, 0);
	root_layout->addWidget(splitter_);

	QWidget* upper_container = new QWidget();
	QVBoxLayout* upper_layout = new QVBoxLayout(upper_container);
	upper_layout->setContentsMargins(0, 5, 0, 0);
	QLineEdit* filter = new QLineEdit();
	upper_layout->addWidget(filter);
	upper_layout->addWidget(tree_view_);

	splitter_->setOrientation(Qt::Vertical);
	splitter_->addWidget(upper_container);
	splitter_->addWidget(info_box_);

	const QIcon filter_icon(QIcon::fromTheme("search",
		QIcon(":/icons/search.svg")));
	filter->setClearButtonEnabled(true);
	filter->addAction(filter_icon, QLineEdit::LeadingPosition);

	sort_filter_model_->setSourceModel(model_);
	sort_filter_model_->setFilterCaseSensitivity(Qt::CaseInsensitive);

	tree_view_->setModel(sort_filter_model_);
	tree_view_->setRootIsDecorated(true);
	tree_view_->setSortingEnabled(true);
	tree_view_->sortByColumn(0, Qt::AscendingOrder);

	// Hide the columns that hold the detailed item information
	tree_view_->hideColumn(2);  // ID

	// Ensure that all decoder tag names are fully visible by default
	tree_view_->resizeColumnToContents(0);

	tree_view_->setIndentation(10);

	info_box_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
	QVBoxLayout* info_box_layout = new QVBoxLayout(info_box_);
	info_box_layout->addWidget(info_label_header_);
	info_box_layout->addWidget(info_label_body_);
	info_box_layout->addWidget(info_label_footer_);
	info_box_layout->setAlignment(Qt::AlignTop);
	Qt::TextInteractionFlags flags = Qt::TextSelectableByMouse | Qt::TextSelectableByKeyboard;
	info_label_header_->setWordWrap(true);
	info_label_header_->setTextInteractionFlags(flags);
	info_label_body_->setWordWrap(true);
	info_label_body_->setTextInteractionFlags(flags);
	info_label_body_->setText(tr("Select a decoder to see its description here."));
	info_label_footer_->setWordWrap(true);
	info_label_footer_->setTextInteractionFlags(flags);

	connect(filter, SIGNAL(textChanged(const QString&)),
		this, SLOT(on_filter_changed(const QString&)));

	connect(tree_view_, SIGNAL(currentChanged(const QModelIndex&)),
		this, SLOT(on_item_changed(const QModelIndex&)));
	connect(tree_view_, SIGNAL(activated(const QModelIndex&)),
		this, SLOT(on_item_activated(const QModelIndex&)));

	connect(this, SIGNAL(new_decoders_selected(vector<const srd_decoder*>)),
		&session, SLOT(on_new_decoders_selected(vector<const srd_decoder*>)));
}

bool SubWindow::has_toolbar() const
{
	return true;
}

QToolBar* SubWindow::create_toolbar(QWidget *parent) const
{
	QToolBar* toolbar = new QToolBar(parent);

	return toolbar;
}

vector<const char*> SubWindow::get_decoder_inputs(const srd_decoder* d) const
{
	vector<const char*> ret_val;

	for (GSList* li = d->inputs; li; li = li->next)
		ret_val.push_back((const char*)li->data);

	return ret_val;
}

vector<const srd_decoder*> SubWindow::get_decoders_providing(const char* output) const
{
	vector<const srd_decoder*> ret_val;

	for (GSList* li = (GSList*)srd_decoder_list(); li; li = li->next) {
		const srd_decoder* d = (srd_decoder*)li->data;
		assert(d);

		if (!d->outputs)
			continue;

		// TODO For now we ignore that d->outputs is actually a list
		if (strncmp((char*)(d->outputs->data), output, strlen(output)) == 0)
			ret_val.push_back(d);
	}

	return ret_val;
}

void SubWindow::on_item_changed(const QModelIndex& index)
{
	if (!index.isValid())
		return;

	QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
	QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();

	if (decoder_name.isEmpty())
		return;

	const srd_decoder* d = srd_decoder_get_by_id(decoder_name.toUtf8());

	const QString id = QString::fromUtf8(d->id);
	const QString longname = QString::fromUtf8(d->longname);
	const QString desc = QString::fromUtf8(d->desc);
	const QString doc = QString::fromUtf8(srd_decoder_doc_get(d));

	QString tags;
	for (GSList* li = (GSList*)d->tags; li; li = li->next) {
		QString s = (li == (GSList*)d->tags) ?
			tr((char*)li->data) :
			QString(tr(", %1")).arg(tr((char*)li->data));
		tags.append(s);
	}

	info_label_header_->setText(QString("<span style='font-size:large;font-weight:bold'>%1 (%2)</span><br>%3")
		.arg(longname, id, desc));
	info_label_body_->setText(doc);
	info_label_footer_->setText(tr("<p align='right'>Tags: %1</p>").arg(tags));
}

void SubWindow::on_item_activated(const QModelIndex& index)
{
	if (!index.isValid())
		return;

	QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
	QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();

	const srd_decoder* chosen_decoder = srd_decoder_get_by_id(decoder_name.toUtf8());
	if (chosen_decoder == nullptr)
		return;

	vector<const srd_decoder*> decoders;
	decoders.push_back(chosen_decoder);

	// If the decoder only depends on logic inputs, we add it and are done
	vector<const char*> inputs = get_decoder_inputs(decoders.front());
	if (inputs.size() == 0) {
		qWarning() << "Protocol decoder" << decoder_name << "cannot have 0 inputs!";
		return;
	}

	if (strncmp(inputs.at(0), "logic", 5) == 0) {
		new_decoders_selected(decoders);
		return;
	}

	// Check if we can automatically fulfill the stacking requirements
	while (strncmp(inputs.at(0), "logic", 5) != 0) {
		vector<const srd_decoder*> prov_decoders = get_decoders_providing(inputs.at(0));

		if (prov_decoders.size() == 0) {
			// Emit warning and add the stack that we could gather so far
			qWarning() << "Protocol decoder" << QString::fromUtf8(decoders.back()->id) \
				<< "has input that no other decoder provides:" << QString::fromUtf8(inputs.at(0));
			break;
		}

		if (prov_decoders.size() == 1) {
			decoders.push_back(prov_decoders.front());
		} else {
			// Let user decide which one to use
			QString caption = QString(tr("Protocol decoder <b>%1</b> requires input type <b>%2</b> " \
				"which several decoders provide.<br>Choose which one to use:<br>"))
					.arg(QString::fromUtf8(decoders.back()->id), QString::fromUtf8(inputs.at(0)));

			QStringList items;
			for (const srd_decoder* d : prov_decoders)
				items << QString::fromUtf8(d->id) + " (" + QString::fromUtf8(d->longname) + ")";
			bool ok_clicked;
			QString item = QInputDialog::getItem(this, tr("Choose Decoder"),
				tr(caption.toUtf8()), items, 0, false, &ok_clicked);

			if ((!ok_clicked) || (item.isEmpty()))
				return;

			QString d = item.section(' ', 0, 0);
			decoders.push_back(srd_decoder_get_by_id(d.toUtf8()));
		}

		inputs = get_decoder_inputs(decoders.back());
	}

	// Reverse decoder list and add the stack
	reverse(decoders.begin(), decoders.end());
	new_decoders_selected(decoders);
}

void SubWindow::on_filter_changed(const QString& text)
{
	sort_filter_model_->setFilterFixedString(text);
}

} // namespace decoder_selector
} // namespace subwindows
} // namespace pv
Commit	Line	Data
97378470 SA	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2018 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 <algorithm>
	21
	22	#include <QDebug>
	23	#include <QInputDialog>
	24	#include <QLabel>
b229a1b7	25	#include <QLineEdit>
97378470 SA	26	#include <QPushButton>
	27	#include <QVBoxLayout>
	28
	29	#include "pv/session.hpp"
	30	#include "pv/subwindows/decoder_selector/subwindow.hpp"
	31
	32	using std::reverse;
	33	using std::shared_ptr;
	34
	35	namespace pv {
	36	namespace subwindows {
	37	namespace decoder_selector {
	38
	39
b229a1b7 SA	40	bool QCustomSortFilterProxyModel::filterAcceptsRow(int source_row,
	41	const QModelIndex& source_parent) const
	42	{
	43	// Search model recursively
	44
	45	if (QSortFilterProxyModel::filterAcceptsRow(source_row, source_parent))
	46	return true;
	47
	48	const QModelIndex index = sourceModel()->index(source_row, 0, source_parent);
	49
	50	for (int i = 0; i < sourceModel()->rowCount(index); i++)
	51	if (filterAcceptsRow(i, index))
	52	return true;
	53
	54	return false;
	55	}
	56
	57
e10848e8 SA	58	void QCustomTreeView::currentChanged(const QModelIndex& current,
	59	const QModelIndex& previous)
	60	{
	61	QTreeView::currentChanged(current, previous);
	62	currentChanged(current);
	63	}
	64
	65
97378470 SA	66	SubWindow::SubWindow(Session& session, QWidget* parent) :
	67	SubWindowBase(session, parent),
	68	splitter_(new QSplitter()),
e10848e8	69	tree_view_(new QCustomTreeView()),
c2b80ad9 SA	70	info_box_(new QWidget()),
	71	info_label_header_(new QLabel()),
	72	info_label_body_(new QLabel()),
	73	info_label_footer_(new QLabel()),
a6fab024	74	model_(new DecoderCollectionModel()),
b229a1b7	75	sort_filter_model_(new QCustomSortFilterProxyModel())
97378470 SA	76	{
	77	QVBoxLayout* root_layout = new QVBoxLayout(this);
	78	root_layout->setContentsMargins(0, 0, 0, 0);
	79	root_layout->addWidget(splitter_);
	80
b229a1b7 SA	81	QWidget* upper_container = new QWidget();
	82	QVBoxLayout* upper_layout = new QVBoxLayout(upper_container);
	83	upper_layout->setContentsMargins(0, 5, 0, 0);
	84	QLineEdit* filter = new QLineEdit();
	85	upper_layout->addWidget(filter);
	86	upper_layout->addWidget(tree_view_);
	87
c2b80ad9	88	splitter_->setOrientation(Qt::Vertical);
b229a1b7	89	splitter_->addWidget(upper_container);
c2b80ad9	90	splitter_->addWidget(info_box_);
97378470	91
b229a1b7 SA	92	const QIcon filter_icon(QIcon::fromTheme("search",
	93	QIcon(":/icons/search.svg")));
	94	filter->setClearButtonEnabled(true);
	95	filter->addAction(filter_icon, QLineEdit::LeadingPosition);
	96
a6fab024	97	sort_filter_model_->setSourceModel(model_);
b229a1b7	98	sort_filter_model_->setFilterCaseSensitivity(Qt::CaseInsensitive);
a6fab024 SA	99
a6fab024 SA	100	tree_view_->setModel(sort_filter_model_);
97378470	101	tree_view_->setRootIsDecorated(true);
a6fab024 SA	102	tree_view_->setSortingEnabled(true);
a6fab024 SA	103	tree_view_->sortByColumn(0, Qt::AscendingOrder);
97378470 SA	104
	105	// Hide the columns that hold the detailed item information
	106	tree_view_->hideColumn(2); // ID
	107
b54aeaea UH	108	// Ensure that all decoder tag names are fully visible by default
	109	tree_view_->resizeColumnToContents(0);
	110
5da32ad6 UH	111	tree_view_->setIndentation(10);
5da32ad6 UH	112
c2b80ad9 SA	113	info_box_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
	114	QVBoxLayout* info_box_layout = new QVBoxLayout(info_box_);
	115	info_box_layout->addWidget(info_label_header_);
	116	info_box_layout->addWidget(info_label_body_);
	117	info_box_layout->addWidget(info_label_footer_);
a7961b36	118	info_box_layout->setAlignment(Qt::AlignTop);
0a7cdbf7	119	Qt::TextInteractionFlags flags = Qt::TextSelectableByMouse \| Qt::TextSelectableByKeyboard;
a8ea0620	120	info_label_header_->setWordWrap(true);
0a7cdbf7	121	info_label_header_->setTextInteractionFlags(flags);
c2b80ad9	122	info_label_body_->setWordWrap(true);
0a7cdbf7	123	info_label_body_->setTextInteractionFlags(flags);
c2b80ad9	124	info_label_body_->setText(tr("Select a decoder to see its description here."));
a8ea0620	125	info_label_footer_->setWordWrap(true);
0a7cdbf7	126	info_label_footer_->setTextInteractionFlags(flags);
c2b80ad9	127
b229a1b7 SA	128	connect(filter, SIGNAL(textChanged(const QString&)),
	129	this, SLOT(on_filter_changed(const QString&)));
	130
e10848e8 SA	131	connect(tree_view_, SIGNAL(currentChanged(const QModelIndex&)),
	132	this, SLOT(on_item_changed(const QModelIndex&)));
	133	connect(tree_view_, SIGNAL(activated(const QModelIndex&)),
	134	this, SLOT(on_item_activated(const QModelIndex&)));
97378470 SA	135
	136	connect(this, SIGNAL(new_decoders_selected(vector<const srd_decoder*>)),
	137	&session, SLOT(on_new_decoders_selected(vector<const srd_decoder*>)));
	138	}
	139
	140	bool SubWindow::has_toolbar() const
	141	{
	142	return true;
	143	}
	144
	145	QToolBar* SubWindow::create_toolbar(QWidget *parent) const
	146	{
	147	QToolBar* toolbar = new QToolBar(parent);
	148
	149	return toolbar;
	150	}
	151
8f7c2dce	152	vector<const char> SubWindow::get_decoder_inputs(const srd_decoder d) const
97378470 SA	153	{
	154	vector<const char*> ret_val;
	155
486bcf01 SA	156	for (GSList* li = d->inputs; li; li = li->next)
486bcf01 SA	157	ret_val.push_back((const char*)li->data);
97378470 SA	158
	159	return ret_val;
	160	}
	161
8f7c2dce	162	vector<const srd_decoder> SubWindow::get_decoders_providing(const char output) const
97378470 SA	163	{
	164	vector<const srd_decoder*> ret_val;
	165
486bcf01	166	for (GSList* li = (GSList*)srd_decoder_list(); li; li = li->next) {
97378470 SA	167	const srd_decoder* d = (srd_decoder*)li->data;
	168	assert(d);
	169
	170	if (!d->outputs)
	171	continue;
	172
	173	// TODO For now we ignore that d->outputs is actually a list
	174	if (strncmp((char*)(d->outputs->data), output, strlen(output)) == 0)
	175	ret_val.push_back(d);
	176	}
97378470 SA	177
	178	return ret_val;
	179	}
	180
e10848e8	181	void SubWindow::on_item_changed(const QModelIndex& index)
c2b80ad9 SA	182	{
	183	if (!index.isValid())
	184	return;
	185
	186	QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
	187	QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
	188
	189	if (decoder_name.isEmpty())
	190	return;
	191
644462a7	192	const srd_decoder* d = srd_decoder_get_by_id(decoder_name.toUtf8());
c2b80ad9 SA	193
	194	const QString id = QString::fromUtf8(d->id);
	195	const QString longname = QString::fromUtf8(d->longname);
	196	const QString desc = QString::fromUtf8(d->desc);
	197	const QString doc = QString::fromUtf8(srd_decoder_doc_get(d));
	198
	199	QString tags;
486bcf01 SA	200	for (GSList* li = (GSList*)d->tags; li; li = li->next) {
486bcf01 SA	201	QString s = (li == (GSList*)d->tags) ?
c2b80ad9 SA	202	tr((char*)li->data) :
	203	QString(tr(", %1")).arg(tr((char*)li->data));
	204	tags.append(s);
	205	}
c2b80ad9 SA	206
	207	info_label_header_->setText(QString("<span style='font-size:large;font-weight:bold'>%1 (%2)</span><br>%3")
	208	.arg(longname, id, desc));
	209	info_label_body_->setText(doc);
	210	info_label_footer_->setText(tr("<p align='right'>Tags: %1</p>").arg(tags));
	211	}
	212
e10848e8	213	void SubWindow::on_item_activated(const QModelIndex& index)
97378470 SA	214	{
	215	if (!index.isValid())
	216	return;
	217
	218	QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
	219	QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
	220
644462a7	221	const srd_decoder* chosen_decoder = srd_decoder_get_by_id(decoder_name.toUtf8());
97378470 SA	222	if (chosen_decoder == nullptr)
	223	return;
	224
	225	vector<const srd_decoder*> decoders;
	226	decoders.push_back(chosen_decoder);
	227
	228	// If the decoder only depends on logic inputs, we add it and are done
8f7c2dce	229	vector<const char*> inputs = get_decoder_inputs(decoders.front());
97378470 SA	230	if (inputs.size() == 0) {
	231	qWarning() << "Protocol decoder" << decoder_name << "cannot have 0 inputs!";
	232	return;
	233	}
	234
	235	if (strncmp(inputs.at(0), "logic", 5) == 0) {
	236	new_decoders_selected(decoders);
	237	return;
	238	}
	239
	240	// Check if we can automatically fulfill the stacking requirements
	241	while (strncmp(inputs.at(0), "logic", 5) != 0) {
8f7c2dce	242	vector<const srd_decoder*> prov_decoders = get_decoders_providing(inputs.at(0));
97378470 SA	243
	244	if (prov_decoders.size() == 0) {
	245	// Emit warning and add the stack that we could gather so far
	246	qWarning() << "Protocol decoder" << QString::fromUtf8(decoders.back()->id) \
	247	<< "has input that no other decoder provides:" << QString::fromUtf8(inputs.at(0));
	248	break;
	249	}
	250
	251	if (prov_decoders.size() == 1) {
	252	decoders.push_back(prov_decoders.front());
	253	} else {
	254	// Let user decide which one to use
	255	QString caption = QString(tr("Protocol decoder <b>%1</b> requires input type <b>%2</b> " \
	256	"which several decoders provide.<br>Choose which one to use:<br>"))
	257	.arg(QString::fromUtf8(decoders.back()->id), QString::fromUtf8(inputs.at(0)));
	258
	259	QStringList items;
	260	for (const srd_decoder* d : prov_decoders)
	261	items << QString::fromUtf8(d->id) + " (" + QString::fromUtf8(d->longname) + ")";
	262	bool ok_clicked;
	263	QString item = QInputDialog::getItem(this, tr("Choose Decoder"),
	264	tr(caption.toUtf8()), items, 0, false, &ok_clicked);
	265
	266	if ((!ok_clicked) \|\| (item.isEmpty()))
	267	return;
	268
	269	QString d = item.section(' ', 0, 0);
644462a7	270	decoders.push_back(srd_decoder_get_by_id(d.toUtf8()));
97378470 SA	271	}
97378470 SA	272
8f7c2dce	273	inputs = get_decoder_inputs(decoders.back());
97378470 SA	274	}
	275
	276	// Reverse decoder list and add the stack
	277	reverse(decoders.begin(), decoders.end());
	278	new_decoders_selected(decoders);
	279	}
	280
b229a1b7 SA	281	void SubWindow::on_filter_changed(const QString& text)
	282	{
	283	sort_filter_model_->setFilterFixedString(text);
	284	}
	285
97378470 SA	286	} // namespace decoder_selector
	287	} // namespace subwindows
	288	} // namespace pv