Differential D27166 Diff 78016 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
19	#include <QGuiApplication>	22		#include <QGuiApplication>
20	#include <QClipboard>	23		#include <QClipboard>
21	#include <QDesktopServices>	24		#include <QDesktopServices>
22	#include <QSet>
23	#include <QDebug>	25		#include <QDebug>
24	#include <KLocalizedString>	26		#include <KLocalizedString>
25	#include <KUnitConversion/Converter>
26	#include <KUnitConversion/UnitCategory>
27		27
28	#include <cmath>	28		#include <cmath>
29		29
30	#define CONVERSION_CHAR QLatin1Char( '>' )
31
32	K_EXPORT_PLASMA_RUNNER(converterrunner, ConverterRunner)	30		K_EXPORT_PLASMA_RUNNER(converterrunner, ConverterRunner)
33		31
34	class StringParser	32		ConverterRunner::ConverterRunner(QObject *parent, const QVariantList &args)
35	{	33		: Plasma::AbstractRunner(parent, args)
36	public:
37	enum GetType
38	{	34		{
39	GetString = 1,	35		setObjectName(QStringLiteral("Converter"));
40	GetDigit = 2	36		//can not ignore commands: we have things like m4
41	};	37		setIgnoredTypes(Plasma::RunnerContext::Directory \| Plasma::RunnerContext::File \|
		38		Plasma::RunnerContext::NetworkLocation);
42		39
43	StringParser(const QString &s) : m_index(0), m_s(s) {}	40		const QString description = i18n("Converts the value of :q: when :q: is made up of "
44	~StringParser() {}	41		"\"value unit [>, to, as, in] unit\". You can use the "
		42		"Unit converter applet to find all available units.");
		43		addSyntax(Plasma::RunnerSyntax(QStringLiteral(":q:"), description));
		44		}
45		45
46	QString get(int type)	46		void ConverterRunner::init()
47	{	47		{
48	QChar current;	48		m_separators << QStringLiteral("<");
49	QString result;	49		m_separators << i18nc("list of words that can used as amount of 'unit1' [in\|to\|as] 'unit2'",
		50		"in;to;as").split(QLatin1Char(';'));
50		51
51	passWhiteSpace();	52		const QList<QLocale> allLocales = QLocale::matchingLocales(
52	while (true) {	53		QLocale::AnyLanguage, QLocale::AnyScript, QLocale::AnyCountry);
53	current = next();	54		KUnitConversion::UnitCategory currencyCategory = converter.category(QStringLiteral("Currency"));
54	if (current.isNull()) {	55		const QStringList availableISOCodes = currencyCategory.allUnits();
55	break;	56		hasCurrencyRegex = QRegularExpression(QStringLiteral("\\p{Sc}"));
56	}	57		hasCurrencyRegex.optimize();
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		58
76	bool isNumber(const QChar &ch)	59		// Get all valid and by backend supported currency symbols
77	{	60		for (const auto &currencyLocale: allLocales) {
78	if (ch.isNumber()) {	61		const QString symbol = currencyLocale.currencySymbol(QLocale::CurrencySymbol);
79	return true;	62		const QString isoCode = currencyLocale.currencySymbol(QLocale::CurrencyIsoCode);
		63
		64		if (isoCode.isEmpty() \|\| !symbol.contains(hasCurrencyRegex)) {
		65		continue;
80	}	66		}
81	if (QStringLiteral(".,-+/").contains(ch)) {	67		if (availableISOCodes.contains(isoCode)) {
82	return true;	68		symbolToISOMap.insert(symbol, isoCode);
83	}	69		}
84	return false;
85	}	70		}
86		71
87	QString rest()	72		// Construct match regex, see https://regex101.com/r/EUDzQi/17 for demo
88	{	73		const QString valueGroup = QStringLiteral("(?P<%1>[0-9,./]+)").arg(valueKey);
89	return m_s.mid(m_index).simplified();	74		const QString unitGroups = QStringLiteral("(?P<%1>[a-zA-Z/\"'^0-9\\p{Sc}²³]+)");
			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…
		75		const QString sourceUnitGroup = unitGroups.arg(sourceUnitKey);
		76		const QString targetUnitGroup = unitGroups.arg(targetUnitKey);
		77		const QString separatorsGroup = QStringLiteral("(?: in \| to \| as \| ?> ?)");
		78		matchRegex = QRegularExpression(QStringLiteral("^%1 ?%2(?:%3%4)?$")
		79		.arg(valueGroup, sourceUnitGroup, separatorsGroup, targetUnitGroup));
		80		matchRegex.optimize();
90	}	81		}
91		82
92	void pass(const QStringList &strings)	83		ConverterRunner::~ConverterRunner() = default;
		84
		85		void ConverterRunner::match(Plasma::RunnerContext &context)
93	{	86		{
94	passWhiteSpace();	87		const QString term = context.query();
95	const QString temp = m_s.mid(m_index);	88		if (term.size() < 2 \|\| !context.isValid()) {
		89		return;
		90		}
96		91
97	foreach (const QString& s, strings) {	92		const QRegularExpressionMatch regexMatch = matchRegex.match(context.query());
98	if (temp.startsWith(s)) {	93		if (!regexMatch.hasMatch() \|\| regexMatch.capturedTexts().size() < 2) {
99	m_index += s.length();
100	return;	94		return;
101	}	95		}
		96		const QString inputValueString = regexMatch.captured(valueKey);
		97
		98		// If the units contain a currency symbol convert them to ISO
		99		QString inputUnitString = regexMatch.captured(sourceUnitKey);
		100		if (inputUnitString.contains(hasCurrencyRegex)) {
		101		inputUnitString = symbolToISOMap.value(inputUnitString.toUpper(), inputUnitString);
		102		}
		103		QString outputUnitString;
		104		if (regexMatch.lastCapturedIndex() == 3) {
		105		outputUnitString = regexMatch.captured(targetUnitKey);
		106		if (outputUnitString.contains(hasCurrencyRegex)) {
		107		outputUnitString = symbolToISOMap.value(outputUnitString.toUpper(), outputUnitString);
102	}	108		}
103	}	109		}
104		110
105	private:	111		KUnitConversion::UnitCategory inputCategory = converter.categoryForUnit(inputUnitString);
106	void passWhiteSpace()	112		const KUnitConversion::Unit inputUnit = inputCategory.unit(inputUnitString);
107	{	113		const QList<KUnitConversion::Unit> outputUnits = createResultUnits(outputUnitString, inputCategory);
108	while (next().isSpace()) {	114		const auto numberDataPair = getValidatedNumberValue(inputValueString);
109	++m_index;	115		// Return on invalid user input
110	}	116		if (!numberDataPair.first) {
		117		return;
111	}	118		}
112		119
113	QChar next()	120		const double numberValue = numberDataPair.second;
114	{	121		QList<Plasma::QueryMatch> matches;
			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
115	if (m_index >= m_s.size()) {	122		for (const KUnitConversion::Unit &outputUnit: outputUnits) {
116	return QChar::Null;	123		KUnitConversion::Value outputValue = inputCategory.convert(
		124		KUnitConversion::Value(numberValue, inputUnit), outputUnit);
		125		if (!outputValue.isValid() \|\| inputUnit == outputUnit) {
		126		continue;
117	}	127		}
118	return m_s.at(m_index);	128		if (outputUnit.categoryId() == KUnitConversion::CurrencyCategory) {
		129		outputValue.round(2);
			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
119	}	130		}
120		131
121	int m_index;	132		Plasma::QueryMatch match(this);
122	QString m_s;	133		match.setType(Plasma::QueryMatch::ExactMatch);
123	};	134		match.setIconName(QStringLiteral("edit-copy"));
124		135		match.setText(QStringLiteral("%1 (%2)").arg(outputValue.toString(), outputUnit.symbol()));
125	ConverterRunner::ConverterRunner(QObject* parent, const QVariantList &args)	136		match.setData(outputValue.number());
126	: Plasma::AbstractRunner(parent, args)	137		match.setRelevance(1.0 - std::abs(std::log10(outputValue.number())) / 50.0);
127	{	138		matches.append(match);
128	Q_UNUSED(args)
129	setObjectName(QLatin1String( "Converter" ));
130
131	m_separators << QString( CONVERSION_CHAR );
132	m_separators << i18nc("list of words that can used as amount of 'unit1' [in\|to\|as] 'unit2'",
133	"in;to;as").split(QLatin1Char( ';' ));
134
135	//can not ignore commands: we have things like m4
136	setIgnoredTypes(Plasma::RunnerContext::Directory \| Plasma::RunnerContext::File \|
137	Plasma::RunnerContext::NetworkLocation);
138
139	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 "
141	"Unit converter applet to find all available units.");
142	addSyntax(Plasma::RunnerSyntax(QLatin1String(":q:"), description));
143	}	139		}
144		140
145	ConverterRunner::~ConverterRunner()	141		context.addMatches(matches);
146	{
147	}	142		}
148		143
149	void ConverterRunner::match(Plasma::RunnerContext &context)	144		void ConverterRunner::run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &match)
150	{	145		{
151	const QString term = context.query();	146		Q_UNUSED(context)
152	if (term.size() < 2) {
153	return;
154	}
155		147
156	StringParser cmd(term);	148		QGuiApplication::clipboard()->setText(match.data().toString());
157	QString unit1;
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;
165	}
166	if (unit1.isEmpty()) {
167	unit1 = cmd.get(StringParser::GetString \| StringParser::GetDigit);
168	if (unit1.isEmpty()) {
169	return;
170	}
171	}	149		}
172		150
173	const QString s = cmd.get(StringParser::GetString);	151		QPair<bool, double> ConverterRunner::stringToDouble(const QStringRef &value)
			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.
174		152		{
175	if (!s.isEmpty() && !m_separators.contains(s)) {	153		bool ok;
176	unit1 += QLatin1Char( ' ' ) + s;	154		double numberValue = locale.toDouble(value, &ok);
		155		if (!ok) {
		156		numberValue = value.toDouble(&ok);
			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…
177	}	157		}
178	if (s.isEmpty() \|\| !m_separators.contains(s)) {	158		return {ok, numberValue};
			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…
179	cmd.pass(m_separators);
180	}	159		}
181	unit2 = cmd.rest();
182		160
183	KUnitConversion::Converter converter;	161		QPair<bool, double> ConverterRunner::getValidatedNumberValue(const QString &value)
184	KUnitConversion::UnitCategory category = converter.categoryForUnit(unit1);	162		{
185	bool found = false;	163		const auto fractionParts = value.splitRef(QLatin1Char('/'), QString::SkipEmptyParts);
			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.
186	if (category.id() == KUnitConversion::InvalidCategory) {	164		if (fractionParts.isEmpty() \|\| fractionParts.count() > 2) {
187	foreach (category, converter.categories()) {	165		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	}	166		}
		167
		168		if (fractionParts.count() == 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…
		169		const QPair<bool, double> doubleFirstResults = stringToDouble(fractionParts.first());
			sitterUnsubmitted Done unnecessary ref. sitter: unnecessary ref.
		170		if (!doubleFirstResults.first) {
		171		return {false, 0};
			sitterUnsubmitted Done `s/u/unit` sitter: `s/u/unit`
194	}	172		}
			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…
			sitterUnsubmitted Done `s/v/value` sitter: `s/v/value`
195	if (found) {	173		const QPair<bool, double> doubleSecondResult = stringToDouble(fractionParts.last());
196	break;	174		if (!doubleSecondResult.first \|\| qFuzzyIsNull(doubleSecondResult.second)) {
		175		return {false, 0};
			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 };`
197	}	176		}
			sitterUnsubmitted Done newline missing it seems sitter: newline missing it seems
		177
		178		return {true, doubleFirstResults.second / doubleSecondResult.second};
		179		} else if (fractionParts.count() == 1) {
		180		const QPair<bool, double> doubleResult = stringToDouble(fractionParts.first());
		181		if (!doubleResult.first) {
		182		return {false, 0};
198	}	183		}
199	if (!found) {	184		return {true, doubleResult.second};
200	return;	185		} else {
		186		return {true, 0};
201	}	187		}
202	}	188		}
203		189
		190		QList<KUnitConversion::Unit> ConverterRunner::createResultUnits(const QString &outputUnitString,
			sitterUnsubmitted Done left over debug sitter: left over debug
		191		const KUnitConversion::UnitCategory &category)
		192		{
204	QList<KUnitConversion::Unit> units;	193		QList<KUnitConversion::Unit> units;
205		194		if (!outputUnitString.isEmpty()) {
206	if (!unit2.isEmpty()) {	195		KUnitConversion::Unit outputUnit = category.unit(outputUnitString);
207	KUnitConversion::Unit u = category.unit(unit2);	196		if (!outputUnit.isNull() && outputUnit.isValid()) {
208	if (!u.isNull() && u.isValid()) {	197		units.append(outputUnit);
209	units.append(u);
210	config().writeEntry(category.name(), u.symbol());
211	} else {	198		} else {
212	const QStringList unitStrings = category.allUnits();	199		const QStringList unitStrings = category.allUnits();
213	QList<KUnitConversion::Unit> matchingUnits;	200		for (const QString &unitString: unitStrings) {
214	foreach (const QString& s, unitStrings) {	201		if (unitString.startsWith(outputUnitString, Qt::CaseInsensitive)) {
215	if (s.startsWith(unit2, Qt::CaseInsensitive)) {	202		outputUnit = category.unit(unitString);
216	u = category.unit(s);	203		if (!units.contains(outputUnit)) {
217	if (!matchingUnits.contains(u)) {	204		units << outputUnit;
218	matchingUnits << u;
219	}
220	}	205		}
221	}	206		}
222	units = matchingUnits;
223	if (units.count() == 1) {
224	config().writeEntry(category.name(), units[0].symbol());
225	}	207		}
226	}	208		}
227	} else {	209		} else {
228	units = category.mostCommonUnits();	210		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	211		// suggest converting to the user's local currency
235	if (category.id() == KUnitConversion::CurrencyCategory) {	212		if (category.id() == KUnitConversion::CurrencyCategory) {
236	const QString &currencyIsoCode = QLocale().currencySymbol(QLocale::CurrencyIsoCode);	213		const QString &currencyIsoCode = QLocale().currencySymbol(QLocale::CurrencyIsoCode);
237		214
238	KUnitConversion::Unit localCurrency = category.unit(currencyIsoCode);	215		const KUnitConversion::Unit localCurrency = category.unit(currencyIsoCode);
239	if (localCurrency.isValid() && !units.contains(localCurrency)) {	216		if (localCurrency.isValid() && !units.contains(localCurrency)) {
240	units << localCurrency;	217		units << localCurrency;
241	}	218		}
242	}	219		}
243	}	220		}
244		221
245	QList<Plasma::QueryMatch> matches;	222		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	}	223		}
317		224
318	#include "converterrunner.moc"	225		#include "converterrunner.moc"