Differential D27166 Diff 75359 runners/converter/converterrunner.cpp

Changeset View

Standalone View

runners/converter/converterrunner.cpp

1	/*	1		/*
2	* Copyright (C) 2007,2008 Petri Damstén <damu@iki.fi>	2		* Copyright (C) 2007,2008 Petri Damstén <damu@iki.fi>
		3		* Copyright (C) 2020 Alexander Lohnau <alexander.lohnau@gmx.de>
3	*	4		*
4	* This program is free software; you can redistribute it and/or	5		* This program is free software; you can redistribute it and/or
5	* modify it under the terms of the GNU General Public License as	6		* modify it under the terms of the GNU General Public License as
6	* published by the Free Software Foundation; either version 2 of	7		* published by the Free Software Foundation; either version 2 of
7	* the License, or (at your option) any later version.	8		* the License, or (at your option) any later version.
8	*	9		*
9	* This program is distributed in the hope that it will be useful,	10		* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of	11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12	* GNU General Public License for more details.	13		* GNU General Public License for more details.
13	*	14		*
14	* You should have received a copy of the GNU General Public License	15		* You should have received a copy of the GNU General Public License
15	* along with this program. If not, see <http://www.gnu.org/licenses/>.	16		* along with this program. If not, see <http://www.gnu.org/licenses/>.
16	*/	17		*/
17		18
		19
			sitterUnsubmitted Done Please move this after the includes. If any header in the future decides to want to use the name as well we're in for an awkward debugging session. sitter: Please move this after the includes. If any header in the future decides to want to use the…
18	#include "converterrunner.h"	20		#include "converterrunner.h"
		21
		22		// Qt
19	#include <QGuiApplication>	23		#include <QGuiApplication>
20	#include <QClipboard>	24		#include <QClipboard>
21	#include <QDesktopServices>	25		#include <QDesktopServices>
22	#include <QSet>	26		#include <QSet>
23	#include <QDebug>	27		#include <QDebug>
		28		// KF
24	#include <KLocalizedString>	29		#include <KLocalizedString>
25	#include <KUnitConversion/Converter>
26	#include <KUnitConversion/UnitCategory>
27		30
28	#include <cmath>	31		#include <cmath>
29		32
30	#define CONVERSION_CHAR QLatin1Char( '>' )	33		K_EXPORT_PLASMA_RUNNER(converterrunner, ConverterRunner
31
32	K_EXPORT_PLASMA_RUNNER(converterrunner, ConverterRunner)
33
34	class StringParser
35	{
36	public:
37	enum GetType
38	{
39	GetString = 1,
40	GetDigit = 2
41	};
42
43	StringParser(const QString &s) : m_index(0), m_s(s) {}
44	~StringParser() {}
45
46	QString get(int type)
47	{
48	QChar current;
49	QString result;
50
51	passWhiteSpace();
52	while (true) {
53	current = next();
54	if (current.isNull()) {
55	break;
56	}
57	if (current.isSpace()) {
58	break;
59	}
60	bool number = isNumber(current);
61	if (type == GetDigit && !number) {
62	break;
63	}
64	if (type == GetString && number) {
65	break;
66	}
67	if(current == QLatin1Char( CONVERSION_CHAR )) {
68	break;
69	}
70	++m_index;
71	result += current;
72	}
73	return result;
74	}
75
76	bool isNumber(const QChar &ch)
77	{
78	if (ch.isNumber()) {
79	return true;
80	}
81	if (QStringLiteral(".,-+/").contains(ch)) {
82	return true;
83	}
84	return false;
85	}
86
87	QString rest()
88	{
89	return m_s.mid(m_index).simplified();
90	}
91
92	void pass(const QStringList &strings)
93	{
94	passWhiteSpace();
95	const QString temp = m_s.mid(m_index);
96
97	foreach (const QString& s, strings) {
98	if (temp.startsWith(s)) {
99	m_index += s.length();
100	return;
101	}
102	}
103	}
104
105	private:
106	void passWhiteSpace()
107	{
108	while (next().isSpace()) {
109	++m_index;
110	}
111	}
112		34
113	QChar next()	35		)
114	{
115	if (m_index >= m_s.size()) {
116	return QChar::Null;
117	}
118	return m_s.at(m_index);
119	}
120
121	int m_index;
122	QString m_s;
123	};
124		36
			broulikUnsubmitted Done There's also units with µ, Ω, . (fl.oz.), not taking into account how those might be localized, so using a very specific regexp looks somewhat brittle to me. Can't really think of a better way, though... broulik: There's also units with µ, Ω, . (fl.oz.), not taking into account how those might be localized…
			alexAuthorUnsubmitted Done Well the only idea I have is to allow everything as a unit and let the conversion backend decide if it is valid. alex: Well the only idea I have is to allow everything as a unit and let the conversion backend…
125	ConverterRunner::ConverterRunner(QObject* parent, const QVariantList &args)	37		ConverterRunner::ConverterRunner(QObject *parent, const QVariantList &args)
			broulikUnsubmitted Done When there's just one decimal, it doesn't add a zero broulik: When there's just one decimal, it doesn't add a zero
126	: Plasma::AbstractRunner(parent, args)	38		: Plasma::AbstractRunner(parent, args)
127	{	39		{
128	Q_UNUSED(args)	40		Q_UNUSED(args)
129	setObjectName(QLatin1String( "Converter" ));	41		setObjectName(QStringLiteral("Converter"));
130		42
131	m_separators << QString( CONVERSION_CHAR );	43		m_separators << QString(QLatin1Char('<'));
132	m_separators << i18nc("list of words that can used as amount of 'unit1' [in\|to\|as] 'unit2'",	44		m_separators << i18nc("list of words that can used as amount of 'unit1' [in\|to\|as] 'unit2'",
133	"in;to;as").split(QLatin1Char( ';' ));	45		"in;to;as").split(QLatin1Char(';'));
			broulikUnsubmitted Done I thought `KUnitConversion` was doing that when requesting a pretty string broulik: I thought `KUnitConversion` was doing that when requesting a pretty string
134		46
135	//can not ignore commands: we have things like m4	47		//can not ignore commands: we have things like m4
136	setIgnoredTypes(Plasma::RunnerContext::Directory \| Plasma::RunnerContext::File \|	48		setIgnoredTypes(Plasma::RunnerContext::Directory \| Plasma::RunnerContext::File \|
137	Plasma::RunnerContext::NetworkLocation);	49		Plasma::RunnerContext::NetworkLocation);
138		50
139	QString description = i18n("Converts the value of :q: when :q: is made up of "	51		const QString description = i18n("Converts the value of :q: when :q: is made up of "
140	"\"value unit [>, to, as, in] unit\". You can use the "	52		"\"value unit [>, to, as, in] unit\". You can use the "
141	"Unit converter applet to find all available units.");	53		"Unit converter applet to find all available units.");
142	addSyntax(Plasma::RunnerSyntax(QLatin1String(":q:"), description));	54		addSyntax(Plasma::RunnerSyntax(QStringLiteral(":q:"), description));
		55		// Construct match regex, see https://regex101.com/r/EUDzQi/11 for demo
		56		const QString valueGroup = QStringLiteral("([0-9,./]+)");
		57		const QString unitGroup = QStringLiteral("([a-zA-Z/\"'^0-9$£¥€]+)");
			sitterUnsubmitted Done I am sure we can do better than hardcoding currency symbols. Perhaps iterate QLocales and get the currencySymbol for each? (needs checking that performance doesn't degrade) sitter: I am sure we can do better than hardcoding currency symbols. Perhaps iterate QLocales and get…
		58		const QString separatorsGroup = QStringLiteral("(?: in \| to \| as \| ?> ?)");
		59		matchRegex = QRegularExpression(QStringLiteral("^%1 ?%2(?:%3%2)?$").arg(valueGroup, unitGroup, separatorsGroup));
			sitterUnsubmitted Done I'd really prefer named capture groups. Popping data out of the captures by index is fairly terrible to read and also easier to mess up in the future. sitter: I'd really prefer named capture groups. Popping data out of the captures by index is fairly…
143	}	60		}
144		61
145	ConverterRunner::~ConverterRunner()	62		ConverterRunner::~ConverterRunner()
			sitterUnsubmitted Done Seeing as this now doesn't do anything you can `= default` it. sitter: Seeing as this now doesn't do anything you can `= default` it.
146	{	63		{
147	}	64		}
148		65
149	void ConverterRunner::match(Plasma::RunnerContext &context)	66		void ConverterRunner::match(Plasma::RunnerContext &context)
150	{	67		{
151	const QString term = context.query();	68		const QString term = context.query();
152	if (term.size() < 2) {	69		if (term.size() < 2 \|\| !context.isValid()) {
			sitterUnsubmitted Done Is there a particular reason you hold it as a reference? (also applies to a bunch of QStrings and QLists below). We generally do not hold Qt types as references unless there is a reason to I think. sitter: Is there a particular reason you hold it as a reference? (also applies to a bunch of QStrings…
			sitterUnsubmitted Done unnecessary ref. sitter: unnecessary ref.
153	return;	70		return;
154	}	71		}
155		72
156	StringParser cmd(term);	73		const QRegularExpressionMatch regexMatch = matchRegex.match(context.query());
157	QString unit1;	74		if (!regexMatch.hasMatch() \|\| regexMatch.capturedTexts().size() < 2) {
			sitterUnsubmitted Done Please use more descriptive names than u1, such as unit1. In fact, isn't unit1 "inputUnit" and unit2 "outputUnit"? If so I'd name them thusly. sitter: Please use more descriptive names than u1, such as unit1. In fact, isn't unit1 "inputUnit" and…
158	QString value;
159	QString unit2;
160
161	unit1 = cmd.get(StringParser::GetString);
162	value = cmd.get(StringParser::GetDigit);
163	if (value.isEmpty()) {
164	return;	75		return;
			sitterUnsubmitted Done unnecessary ref. sitter: unnecessary ref.
165	}	76		}
166	if (unit1.isEmpty()) {	77		const QString inputValueString = regexMatch.captured(1);
			sitterUnsubmitted Done unit1 and unit2 should probably be unitString1 and unitString2 so the actual units can be unit1 and unit2. same for value I suppose. sitter: unit1 and unit2 should probably be unitString1 and unitString2 so the actual units can be unit1…
167	unit1 = cmd.get(StringParser::GetString \| StringParser::GetDigit);	78		const QString inputUnitString = regexMatch.captured(2);
168	if (unit1.isEmpty()) {	79		const QString outputUnitString = regexMatch.lastCapturedIndex() == 3 ? regexMatch.captured(3) : QString();
		80
		81		KUnitConversion::UnitCategory inputCategory = converter.categoryForUnit(inputUnitString);
		82		const KUnitConversion::Unit inputUnit = inputCategory.unit(inputUnitString);
		83		const QList<KUnitConversion::Unit> outputUnits = createResultUnits(outputUnitString, inputCategory);
		84		const auto numberDataPair = getValidatedNumberValue(inputValueString);
		85		// Return on invalid user input
		86		if (!numberDataPair.first) {
169	return;	87		return;
170	}	88		}
		89
		90		const double numberValue = numberDataPair.second;
		91		QList<Plasma::QueryMatch> matches;
			sitterUnsubmitted Done left over debug sitter: left over debug
		92		for (const KUnitConversion::Unit &outputUnit: outputUnits) {
			sitterUnsubmitted Done `s/u/unit` sitter: `s/u/unit`
		93		const KUnitConversion::Value &outputValue = inputCategory.convert(
			sitterUnsubmitted Done `s/v/value` sitter: `s/v/value`
		94		KUnitConversion::Value(numberValue, inputUnit), outputUnit);
		95		if (!outputValue.isValid() \|\| inputUnit == outputUnit) {
		96		continue;
171	}	97		}
172		98
173	const QString s = cmd.get(StringParser::GetString);	99		Plasma::QueryMatch match(this);
		100		match.setType(Plasma::QueryMatch::ExactMatch);
		101		match.setIconName(QStringLiteral("edit-copy"));
		102		match.setText(QStringLiteral("%1 (%2)").arg(outputValue.toString(), outputUnit.symbol()));
		103		match.setData(outputValue.number());
		104		match.setRelevance(1.0 - std::abs(std::log10(outputValue.number())) / 50.0);
		105		matches.append(match);
		106		}
		107
		108		context.addMatches(matches);
		109		}
		110
		111		void ConverterRunner::run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &match)
		112		{
		113		Q_UNUSED(context)
174		114
175	if (!s.isEmpty() && !m_separators.contains(s)) {	115		QGuiApplication::clipboard()->setText(match.data().toString());
176	unit1 += QLatin1Char( ' ' ) + s;	116		}
		117
		118		QPair<bool, double> ConverterRunner::stringToDouble(const QStringRef &value)
		119		{
		120		bool ok;
		121		double numberValue = locale.toDouble(value, &ok);
		122		if (!ok) {
			sitterUnsubmitted Done newline missing it seems sitter: newline missing it seems
		123		numberValue = value.toDouble(&ok);
177	}	124		}
178	if (s.isEmpty() \|\| !m_separators.contains(s)) {	125		return {ok, numberValue};
179	cmd.pass(m_separators);
180	}	126		}
181	unit2 = cmd.rest();
182		127
183	KUnitConversion::Converter converter;	128		QPair<bool, double> ConverterRunner::getValidatedNumberValue(const QString &value)
			sitterUnsubmitted Done in all return statements you can use list initialization `return { ok, output };` sitter: in all return statements you can use list initialization `return { ok, output };`
184	KUnitConversion::UnitCategory category = converter.categoryForUnit(unit1);	129		{
185	bool found = false;	130		const auto fractionParts = value.splitRef(QLatin1Char('/'), QString::SkipEmptyParts);
186	if (category.id() == KUnitConversion::InvalidCategory) {	131		if (fractionParts.isEmpty() \|\| fractionParts.count() > 2) {
187	foreach (category, converter.categories()) {	132		return {false, 0};
188	foreach (const QString& s, category.allUnits()) {
189	if (s.compare(unit1, Qt::CaseInsensitive) == 0) {
190	unit1 = s;
191	found = true;
192	break;
193	}	133		}
		134
		135		if (fractionParts.count() == 2) {
		136		const QPair<bool, double> doubleFirstResults = stringToDouble(fractionParts.first());
		137		if (!doubleFirstResults.first) {
		138		return {false, 0};
194	}	139		}
195	if (found) {	140		const QPair<bool, double> doubleSecondResult = stringToDouble(fractionParts.last());
196	break;	141		if (!doubleSecondResult.first \|\| qFuzzyIsNull(doubleSecondResult.second)) {
		142		return {false, 0};
197	}	143		}
		144
		145		return {true, doubleFirstResults.second / doubleSecondResult.second};
		146		} else if (fractionParts.count() == 1) {
		147		const QPair<bool, double> doubleResult = stringToDouble(fractionParts.first());
		148		if (!doubleResult.first) {
		149		return {false, 0};
198	}	150		}
199	if (!found) {	151		return {true, doubleResult.second};
200	return;	152		} else {
		153		return {true, 0};
201	}	154		}
202	}	155		}
203		156
		157		QList<KUnitConversion::Unit> ConverterRunner::createResultUnits(const QString &outputUnitString,
		158		const KUnitConversion::UnitCategory &category)
		159		{
204	QList<KUnitConversion::Unit> units;	160		QList<KUnitConversion::Unit> units;
205		161		if (!outputUnitString.isEmpty()) {
206	if (!unit2.isEmpty()) {	162		KUnitConversion::Unit outputUnit = category.unit(outputUnitString);
207	KUnitConversion::Unit u = category.unit(unit2);	163		if (!outputUnit.isNull() && outputUnit.isValid()) {
208	if (!u.isNull() && u.isValid()) {	164		units.append(outputUnit);
209	units.append(u);
210	config().writeEntry(category.name(), u.symbol());
211	} else {	165		} else {
212	const QStringList unitStrings = category.allUnits();	166		const QStringList unitStrings = category.allUnits();
213	QList<KUnitConversion::Unit> matchingUnits;	167		for (const QString &unitString: unitStrings) {
214	foreach (const QString& s, unitStrings) {	168		if (unitString.startsWith(outputUnitString, Qt::CaseInsensitive)) {
215	if (s.startsWith(unit2, Qt::CaseInsensitive)) {	169		outputUnit = category.unit(unitString);
216	u = category.unit(s);	170		if (!units.contains(outputUnit)) {
217	if (!matchingUnits.contains(u)) {	171		units << outputUnit;
218	matchingUnits << u;
219	}	172		}
220	}	173		}
221	}	174		}
222	units = matchingUnits;
223	if (units.count() == 1) {
224	config().writeEntry(category.name(), units[0].symbol());
225	}
226	}	175		}
227	} else {	176		} else {
228	units = category.mostCommonUnits();	177		units = category.mostCommonUnits();
229	KUnitConversion::Unit u = category.unit(config().readEntry(category.name()));
230	if (!u.isNull() && units.indexOf(u) < 0) {
231	units << u;
232	}
233
234	// suggest converting to the user's local currency	178		// suggest converting to the user's local currency
235	if (category.id() == KUnitConversion::CurrencyCategory) {	179		if (category.id() == KUnitConversion::CurrencyCategory) {
236	const QString &currencyIsoCode = QLocale().currencySymbol(QLocale::CurrencyIsoCode);	180		const QString &currencyIsoCode = QLocale().currencySymbol(QLocale::CurrencyIsoCode);
237		181
238	KUnitConversion::Unit localCurrency = category.unit(currencyIsoCode);	182		const KUnitConversion::Unit localCurrency = category.unit(currencyIsoCode);
239	if (localCurrency.isValid() && !units.contains(localCurrency)) {	183		if (localCurrency.isValid() && !units.contains(localCurrency)) {
240	units << localCurrency;	184		units << localCurrency;
241	}	185		}
242	}	186		}
243	}	187		}
244		188
245	QList<Plasma::QueryMatch> matches;	189		return units;
246
247	QLocale locale;
248	auto stringToDouble = [&locale](const QStringRef &value, bool *ok) {
249	double numberValue = locale.toDouble(value, ok);
250	if (!(*ok)) {
251	numberValue = value.toDouble(ok);
252	}
253	return numberValue;
254	};
255
256	KUnitConversion::Unit u1 = category.unit(unit1);
257	foreach (const KUnitConversion::Unit& u, units) {
258	if (u1 == u) {
259	continue;
260	}
261
262	double numberValue = 0.0;
263
264	const auto fractionParts = value.splitRef(QLatin1Char('/'), QString::SkipEmptyParts);
265	if (fractionParts.isEmpty() \|\| fractionParts.count() > 2) {
266	continue;
267	}
268
269	if (fractionParts.count() == 2) {
270	bool ok;
271	const double numerator = stringToDouble(fractionParts.first(), &ok);
272	if (!ok) {
273	continue;
274	}
275	const double denominator = stringToDouble(fractionParts.last(), &ok);
276	if (!ok \|\| qFuzzyIsNull(denominator)) {
277	continue;
278	}
279
280	numberValue = numerator / denominator;
281	} else if (fractionParts.count() == 1) {
282	bool ok;
283	numberValue = stringToDouble(fractionParts.first(), &ok);
284	if (!ok) {
285	continue;
286	}
287	}
288
289	KUnitConversion::Value v = category.convert(KUnitConversion::Value(numberValue, u1), u);
290
291	if (!v.isValid()) {
292	continue;
293	}
294
295	Plasma::QueryMatch match(this);
296	match.setType(Plasma::QueryMatch::InformationalMatch);
297	match.setIconName(QStringLiteral("edit-copy"));
298	match.setText(QStringLiteral("%1 (%2)").arg(v.toString(), u.symbol()));
299	match.setData(v.number());
300	match.setRelevance(1.0 - std::abs(std::log10(v.number())) / 50.0);
301	matches.append(match);
302	}
303
304	context.addMatches(matches);
305	}
306
307	void ConverterRunner::run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &match)
308	{
309	Q_UNUSED(context)
310	const QString data = match.data().toString();
311	if (data.startsWith(QLatin1String("http://"))) {
312	QDesktopServices::openUrl(QUrl(data));
313	} else {
314	QGuiApplication::clipboard()->setText(data);
315	}
316	}	190		}
317		191
318	#include "converterrunner.moc"	192		#include "converterrunner.moc"