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

	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
c2b80ad9 SA	111	info_box_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
	112	QVBoxLayout* info_box_layout = new QVBoxLayout(info_box_);
	113	info_box_layout->addWidget(info_label_header_);
	114	info_box_layout->addWidget(info_label_body_);
	115	info_box_layout->addWidget(info_label_footer_);
a7961b36	116	info_box_layout->setAlignment(Qt::AlignTop);
0a7cdbf7	117	Qt::TextInteractionFlags flags = Qt::TextSelectableByMouse \| Qt::TextSelectableByKeyboard;
a8ea0620	118	info_label_header_->setWordWrap(true);
0a7cdbf7	119	info_label_header_->setTextInteractionFlags(flags);
c2b80ad9	120	info_label_body_->setWordWrap(true);
0a7cdbf7	121	info_label_body_->setTextInteractionFlags(flags);
c2b80ad9	122	info_label_body_->setText(tr("Select a decoder to see its description here."));
a8ea0620	123	info_label_footer_->setWordWrap(true);
0a7cdbf7	124	info_label_footer_->setTextInteractionFlags(flags);
c2b80ad9	125
b229a1b7 SA	126	connect(filter, SIGNAL(textChanged(const QString&)),
	127	this, SLOT(on_filter_changed(const QString&)));
	128
e10848e8 SA	129	connect(tree_view_, SIGNAL(currentChanged(const QModelIndex&)),
	130	this, SLOT(on_item_changed(const QModelIndex&)));
	131	connect(tree_view_, SIGNAL(activated(const QModelIndex&)),
	132	this, SLOT(on_item_activated(const QModelIndex&)));
97378470 SA	133
	134	connect(this, SIGNAL(new_decoders_selected(vector<const srd_decoder*>)),
	135	&session, SLOT(on_new_decoders_selected(vector<const srd_decoder*>)));
	136	}
	137
	138	bool SubWindow::has_toolbar() const
	139	{
	140	return true;
	141	}
	142
	143	QToolBar* SubWindow::create_toolbar(QWidget *parent) const
	144	{
	145	QToolBar* toolbar = new QToolBar(parent);
	146
	147	return toolbar;
	148	}
	149
8f7c2dce	150	vector<const char> SubWindow::get_decoder_inputs(const srd_decoder d) const
97378470 SA	151	{
	152	vector<const char*> ret_val;
	153
486bcf01 SA	154	for (GSList* li = d->inputs; li; li = li->next)
486bcf01 SA	155	ret_val.push_back((const char*)li->data);
97378470 SA	156
	157	return ret_val;
	158	}
	159
8f7c2dce	160	vector<const srd_decoder> SubWindow::get_decoders_providing(const char output) const
97378470 SA	161	{
	162	vector<const srd_decoder*> ret_val;
	163
486bcf01	164	for (GSList* li = (GSList*)srd_decoder_list(); li; li = li->next) {
97378470 SA	165	const srd_decoder* d = (srd_decoder*)li->data;
	166	assert(d);
	167
	168	if (!d->outputs)
	169	continue;
	170
	171	// TODO For now we ignore that d->outputs is actually a list
	172	if (strncmp((char*)(d->outputs->data), output, strlen(output)) == 0)
	173	ret_val.push_back(d);
	174	}
97378470 SA	175
	176	return ret_val;
	177	}
	178
e10848e8	179	void SubWindow::on_item_changed(const QModelIndex& index)
c2b80ad9 SA	180	{
	181	if (!index.isValid())
	182	return;
	183
	184	QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
	185	QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
	186
	187	if (decoder_name.isEmpty())
	188	return;
	189
644462a7	190	const srd_decoder* d = srd_decoder_get_by_id(decoder_name.toUtf8());
c2b80ad9 SA	191
	192	const QString id = QString::fromUtf8(d->id);
	193	const QString longname = QString::fromUtf8(d->longname);
	194	const QString desc = QString::fromUtf8(d->desc);
	195	const QString doc = QString::fromUtf8(srd_decoder_doc_get(d));
	196
	197	QString tags;
486bcf01 SA	198	for (GSList* li = (GSList*)d->tags; li; li = li->next) {
486bcf01 SA	199	QString s = (li == (GSList*)d->tags) ?
c2b80ad9 SA	200	tr((char*)li->data) :
	201	QString(tr(", %1")).arg(tr((char*)li->data));
	202	tags.append(s);
	203	}
c2b80ad9 SA	204
	205	info_label_header_->setText(QString("<span style='font-size:large;font-weight:bold'>%1 (%2)</span><br>%3")
	206	.arg(longname, id, desc));
	207	info_label_body_->setText(doc);
	208	info_label_footer_->setText(tr("<p align='right'>Tags: %1</p>").arg(tags));
	209	}
	210
e10848e8	211	void SubWindow::on_item_activated(const QModelIndex& index)
97378470 SA	212	{
	213	if (!index.isValid())
	214	return;
	215
	216	QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
	217	QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
	218
644462a7	219	const srd_decoder* chosen_decoder = srd_decoder_get_by_id(decoder_name.toUtf8());
97378470 SA	220	if (chosen_decoder == nullptr)
	221	return;
	222
	223	vector<const srd_decoder*> decoders;
	224	decoders.push_back(chosen_decoder);
	225
	226	// If the decoder only depends on logic inputs, we add it and are done
8f7c2dce	227	vector<const char*> inputs = get_decoder_inputs(decoders.front());
97378470 SA	228	if (inputs.size() == 0) {
	229	qWarning() << "Protocol decoder" << decoder_name << "cannot have 0 inputs!";
	230	return;
	231	}
	232
	233	if (strncmp(inputs.at(0), "logic", 5) == 0) {
	234	new_decoders_selected(decoders);
	235	return;
	236	}
	237
	238	// Check if we can automatically fulfill the stacking requirements
	239	while (strncmp(inputs.at(0), "logic", 5) != 0) {
8f7c2dce	240	vector<const srd_decoder*> prov_decoders = get_decoders_providing(inputs.at(0));
97378470 SA	241
	242	if (prov_decoders.size() == 0) {
	243	// Emit warning and add the stack that we could gather so far
	244	qWarning() << "Protocol decoder" << QString::fromUtf8(decoders.back()->id) \
	245	<< "has input that no other decoder provides:" << QString::fromUtf8(inputs.at(0));
	246	break;
	247	}
	248
	249	if (prov_decoders.size() == 1) {
	250	decoders.push_back(prov_decoders.front());
	251	} else {
	252	// Let user decide which one to use
	253	QString caption = QString(tr("Protocol decoder <b>%1</b> requires input type <b>%2</b> " \
	254	"which several decoders provide.<br>Choose which one to use:<br>"))
	255	.arg(QString::fromUtf8(decoders.back()->id), QString::fromUtf8(inputs.at(0)));
	256
	257	QStringList items;
	258	for (const srd_decoder* d : prov_decoders)
	259	items << QString::fromUtf8(d->id) + " (" + QString::fromUtf8(d->longname) + ")";
	260	bool ok_clicked;
	261	QString item = QInputDialog::getItem(this, tr("Choose Decoder"),
	262	tr(caption.toUtf8()), items, 0, false, &ok_clicked);
	263
	264	if ((!ok_clicked) \|\| (item.isEmpty()))
	265	return;
	266
	267	QString d = item.section(' ', 0, 0);
644462a7	268	decoders.push_back(srd_decoder_get_by_id(d.toUtf8()));
97378470 SA	269	}
97378470 SA	270
8f7c2dce	271	inputs = get_decoder_inputs(decoders.back());
97378470 SA	272	}
	273
	274	// Reverse decoder list and add the stack
	275	reverse(decoders.begin(), decoders.end());
	276	new_decoders_selected(decoders);
	277	}
	278
b229a1b7 SA	279	void SubWindow::on_filter_changed(const QString& text)
	280	{
	281	sort_filter_model_->setFilterFixedString(text);
	282	}
	283
97378470 SA	284	} // namespace decoder_selector
	285	} // namespace subwindows
	286	} // namespace pv