feat: add desktopentry class
Log:
This commit is contained in:
heyuming
Comix
parent
fdf01923db
commit
6f598ab52b
264
src/desktopentry.cpp
Normal file
264
src/desktopentry.cpp
Normal file
@ -0,0 +1,264 @@
|
||||
// SPDX-FileCopyrightText: 2023 UnionTech Software Technology Co., Ltd.
|
||||
//
|
||||
// SPDX-License-Identifier: LGPL-3.0-or-later
|
||||
|
||||
#include "desktopentry.h"
|
||||
#include <QFileInfo>
|
||||
#include <QDir>
|
||||
#include <algorithm>
|
||||
#include <QRegularExpression>
|
||||
#include <QDirIterator>
|
||||
#include <QStringView>
|
||||
#include <QVariant>
|
||||
#include <iostream>
|
||||
|
||||
auto DesktopEntry::parserGroupHeader(const QString &str) noexcept
|
||||
{
|
||||
auto groupHeader = str.sliced(1, str.size() - 2);
|
||||
if (auto it = m_entryMap.find(groupHeader); it == m_entryMap.cend()) {
|
||||
return m_entryMap.insert(groupHeader, {});
|
||||
} else {
|
||||
return it;
|
||||
}
|
||||
}
|
||||
|
||||
ParseError DesktopEntry::parseEntry(const QString &str, decltype(m_entryMap)::iterator& currentGroup) noexcept
|
||||
{
|
||||
if (str.startsWith("#"))
|
||||
return ParseError::NoError;
|
||||
auto splitCharIndex = str.indexOf(']');
|
||||
if(splitCharIndex != -1){
|
||||
for (; splitCharIndex < str.size(); ++splitCharIndex) {
|
||||
if (str.at(splitCharIndex) == '=')
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
splitCharIndex = str.indexOf('=');
|
||||
}
|
||||
auto keyStr = str.first(splitCharIndex).trimmed();
|
||||
auto valueStr = str.sliced(splitCharIndex + 1).trimmed();
|
||||
QString key, valueKey{defaultKeyStr};
|
||||
|
||||
constexpr auto MainKey = R"re((?<MainKey>[0-9a-zA-Z-]+))re";// main key. eg.(Name, X-CUSTOM-KEY).
|
||||
constexpr auto Language = R"re((?:[a-z]+))re";// language of locale postfix. eg.(en, zh)
|
||||
constexpr auto Country = R"re((?:_[A-Z]+))re";// country of locale postfix. eg.(US, CN)
|
||||
constexpr auto Encoding = R"re((?:\.[0-9A-Z-]+))re";// encoding of locale postfix. eg.(UFT-8)
|
||||
constexpr auto Modifier = R"re((?:@[a-z=;]+))re";// modifier of locale postfix. eg(euro;collation=traditional)
|
||||
const static auto validKey =
|
||||
QString("^%1(?:\\[(?<LOCALE>%2%3?%4?%5?)\\])?$").arg(MainKey).arg(Language).arg(Country).arg(Encoding).arg(Modifier);
|
||||
// example: https://regex101.com/r/hylOay/1
|
||||
QRegularExpression re{validKey};
|
||||
re.optimize();
|
||||
auto matcher = re.match(keyStr);
|
||||
if (!matcher.hasMatch()) {
|
||||
qWarning() << "invalid key: " << keyStr;
|
||||
return ParseError::EntryKeyInvalid;
|
||||
}
|
||||
|
||||
key = matcher.captured("MainKey");
|
||||
|
||||
if (auto locale = matcher.captured("LOCALE"); !locale.isEmpty()) {
|
||||
valueKey = locale ;
|
||||
}
|
||||
qDebug() << valueKey << valueStr;
|
||||
if (auto cur = currentGroup->find(key); cur == currentGroup->end()) {
|
||||
currentGroup->insert(keyStr, {{valueKey, valueStr}});
|
||||
return ParseError::NoError;
|
||||
} else {
|
||||
if (auto v = cur->find(valueKey); v == cur->end()) {
|
||||
cur->insert(valueKey, valueStr);
|
||||
return ParseError::NoError;
|
||||
} else {
|
||||
qWarning() << "duplicated postfix and this line will be aborted, maybe format is invalid.\n"
|
||||
<< "exist: " << v.key() << "[" << v.value() << "]"
|
||||
<< "current: " << str;
|
||||
}
|
||||
}
|
||||
return ParseError::NoError;
|
||||
}
|
||||
|
||||
std::optional<DesktopFile> DesktopFile::searchDesktopFile(const QString &desktopFile, ParseError &err) noexcept
|
||||
{
|
||||
if (auto tmp = desktopFile.split("."); tmp.last() != "desktop") {
|
||||
qWarning() << "file isn't a desktop file";
|
||||
err = ParseError::MismatchedFile;
|
||||
return std::nullopt;
|
||||
}
|
||||
QString path,id;
|
||||
QFileInfo Fileinfo{desktopFile};
|
||||
if (Fileinfo.isAbsolute() and Fileinfo.exists()) {
|
||||
path = desktopFile;
|
||||
} else {
|
||||
auto XDGDataDirs = qgetenv("XDG_DATA_DIRS").split(':');
|
||||
qDebug() << "Current Application Dirs:" << XDGDataDirs;
|
||||
for (const auto &d : XDGDataDirs) {
|
||||
auto dirPath = QDir::cleanPath(d);
|
||||
QDirIterator it{dirPath,{desktopFile},QDir::AllEntries | QDir::NoSymLinks | QDir::NoDotAndDotDot, QDirIterator::Subdirectories};
|
||||
if (it.hasNext()){
|
||||
path = it.next();
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (path.isEmpty()) {
|
||||
qWarning() << "desktop file not found.";
|
||||
err = ParseError::NotFound;
|
||||
return std::nullopt;
|
||||
}
|
||||
|
||||
auto components = path.split(QDir::separator()).toList();
|
||||
auto it = std::find(components.cbegin(), components.cend(), "applications");
|
||||
if (it == components.cend()) {
|
||||
qWarning() << "fatal error: file location invalid";
|
||||
err = ParseError::InvalidLocation;
|
||||
return std::nullopt;
|
||||
}
|
||||
QString FileId;
|
||||
++it;
|
||||
while (it != components.cend())
|
||||
FileId += (*(it++) + "-");
|
||||
id = FileId.chopped(1);
|
||||
|
||||
err = ParseError::NoError;
|
||||
return DesktopFile{path,id};
|
||||
}
|
||||
|
||||
ParseError DesktopEntry::parse(QTextStream& stream) noexcept
|
||||
{
|
||||
if (stream.atEnd())
|
||||
return ParseError::OpenFailed;
|
||||
|
||||
stream.setEncoding(QStringConverter::Utf8);
|
||||
decltype(m_entryMap)::iterator currentGroup;
|
||||
|
||||
ParseError err{ParseError::NoError};
|
||||
while (!stream.atEnd()) {
|
||||
auto line = stream.readLine().trimmed();
|
||||
|
||||
if (line.startsWith("[")) {
|
||||
if (!line.endsWith("]"))
|
||||
return ParseError::GroupHeaderInvalid;
|
||||
currentGroup = parserGroupHeader(line);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (auto e = parseEntry(line, currentGroup); e != ParseError::NoError) {
|
||||
err = e;
|
||||
qWarning() << "an error occurred,this line will be skipped:"<< line;
|
||||
}
|
||||
}
|
||||
return err;
|
||||
}
|
||||
|
||||
QMap<QString, DesktopEntry::Value> DesktopEntry::group(const QString &key) const noexcept
|
||||
{
|
||||
if (auto group = m_entryMap.find(key); group != m_entryMap.cend())
|
||||
return *group;
|
||||
return {};
|
||||
}
|
||||
|
||||
QString DesktopEntry::Value::unescape(const QString &str) const noexcept
|
||||
{
|
||||
QString unescapedStr;
|
||||
for (qsizetype i = 0; i < str.size(); ++i) {
|
||||
auto c = str.at(i);
|
||||
if (c != '\\') {
|
||||
unescapedStr.append(c);
|
||||
continue;
|
||||
}
|
||||
|
||||
switch (str.at(i + 1).toLatin1()) {
|
||||
default:
|
||||
unescapedStr.append(c);
|
||||
break;
|
||||
case 'n':
|
||||
unescapedStr.append('\n');
|
||||
++i;
|
||||
break;
|
||||
case 't':
|
||||
unescapedStr.append('\t');
|
||||
++i;
|
||||
break;
|
||||
case 'r':
|
||||
unescapedStr.append('\r');
|
||||
++i;
|
||||
break;
|
||||
case '\\':
|
||||
unescapedStr.append('\\');
|
||||
++i;
|
||||
break;
|
||||
case ';':
|
||||
unescapedStr.append(';');
|
||||
++i;
|
||||
break;
|
||||
case 's':
|
||||
unescapedStr.append(' ');
|
||||
++i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return unescapedStr;
|
||||
}
|
||||
|
||||
QString DesktopEntry::Value::toString(bool &ok) const noexcept
|
||||
{
|
||||
ok = false;
|
||||
auto str = this->find(defaultKeyStr);
|
||||
if (str == this->end())
|
||||
return {};
|
||||
auto unescapedStr = unescape(*str);
|
||||
constexpr auto controlChars = "\\p{Cc}";
|
||||
constexpr auto asciiChars = "[^\x00-\x7f]";
|
||||
if (unescapedStr.contains(QRegularExpression{controlChars}) and
|
||||
unescapedStr.contains(QRegularExpression{asciiChars}))
|
||||
return {};
|
||||
|
||||
ok = true;
|
||||
return unescapedStr;
|
||||
}
|
||||
|
||||
QString DesktopEntry::Value::toLocaleString(const QLocale &locale, bool& ok) const noexcept
|
||||
{
|
||||
ok = false;
|
||||
for (auto it = this->constKeyValueBegin(); it != this->constKeyValueEnd(); ++it) {
|
||||
auto [a, b] = *it;
|
||||
if (QLocale{a}.name() == locale.name()) {
|
||||
ok = true;
|
||||
return unescape(b);
|
||||
}
|
||||
}
|
||||
return toString(ok);
|
||||
}
|
||||
|
||||
QString DesktopEntry::Value::toIconString(bool &ok) const noexcept
|
||||
{
|
||||
return toString(ok);
|
||||
}
|
||||
|
||||
bool DesktopEntry::Value::toBoolean(bool &ok) const noexcept
|
||||
{
|
||||
ok = true;
|
||||
const auto& str = (*this)[defaultKeyStr];
|
||||
if (str.compare("true"))
|
||||
return true;
|
||||
if (str.compare("false"))
|
||||
return false;
|
||||
ok = false;
|
||||
return false;
|
||||
}
|
||||
|
||||
float DesktopEntry::Value::toNumeric(bool &ok) const noexcept
|
||||
{
|
||||
const auto& str = (*this)[defaultKeyStr];
|
||||
QVariant v{str};
|
||||
return v.toFloat(&ok);
|
||||
}
|
||||
|
||||
QDebug operator<<(QDebug debug, const DesktopEntry::Value &v)
|
||||
{
|
||||
QDebugStateSaver saver{debug};
|
||||
debug << static_cast<const QMap<QString,QString>&>(v);
|
||||
return debug;
|
||||
}
|
||||
66
src/include/desktopentry.h
Normal file
66
src/include/desktopentry.h
Normal file
@ -0,0 +1,66 @@
|
||||
// SPDX-FileCopyrightText: 2023 UnionTech Software Technology Co., Ltd.
|
||||
//
|
||||
// SPDX-License-Identifier: LGPL-3.0-or-later
|
||||
|
||||
#include <QString>
|
||||
#include <QMap>
|
||||
#include <QDebug>
|
||||
#include <QLocale>
|
||||
#include <QTextStream>
|
||||
#include <optional>
|
||||
|
||||
constexpr static auto defaultKeyStr = "default";
|
||||
|
||||
enum class ParseError {
|
||||
NoError,
|
||||
NotFound,
|
||||
FilePathEmpty,
|
||||
MismatchedFile,
|
||||
InvalidLocation,
|
||||
OpenFailed,
|
||||
GroupHeaderInvalid,
|
||||
EntryKeyInvalid
|
||||
};
|
||||
|
||||
class DesktopEntry
|
||||
{
|
||||
public:
|
||||
class Value : public QMap<QString, QString>
|
||||
{
|
||||
public:
|
||||
using QMap<QString, QString>::QMap;
|
||||
QString toString(bool &ok) const noexcept;
|
||||
bool toBoolean(bool &ok) const noexcept;
|
||||
QString toIconString(bool &ok) const noexcept;
|
||||
float toNumeric(bool &ok) const noexcept;
|
||||
QString toLocaleString(const QLocale &locale, bool &ok) const noexcept;
|
||||
friend QDebug operator<<(QDebug debug, const DesktopEntry::Value &v);
|
||||
|
||||
private:
|
||||
QString unescape(const QString& str) const noexcept;
|
||||
};
|
||||
|
||||
DesktopEntry() = default;
|
||||
~DesktopEntry() = default;
|
||||
ParseError parse(QTextStream& stream) noexcept;
|
||||
QMap<QString, Value> group(const QString &key) const noexcept;
|
||||
|
||||
private:
|
||||
QMap<QString, QMap<QString, Value>> m_entryMap;
|
||||
|
||||
auto parserGroupHeader(const QString &str) noexcept;
|
||||
ParseError parseEntry(const QString &str, decltype(m_entryMap)::iterator ¤tGroup) noexcept;
|
||||
};
|
||||
|
||||
struct DesktopFile
|
||||
{
|
||||
const QString filePath;
|
||||
const QString desktopId;
|
||||
|
||||
static std::optional<DesktopFile> searchDesktopFile(const QString &desktopFilePath, ParseError& err) noexcept;
|
||||
|
||||
private:
|
||||
DesktopFile() = default;
|
||||
};
|
||||
|
||||
QDebug operator<<(QDebug debug, const DesktopEntry::Value& v);
|
||||
Loading…
Reference in New Issue
Block a user