dde-application-manager/src/desktopentry.h
ComixHe 06ee5e5899 refact: DesktopFile's method and structure
Signed-off-by: ComixHe <heyuming@deepin.org>
2023-08-22 11:42:13 +08:00

138 lines
4.4 KiB
C++

// SPDX-FileCopyrightText: 2023 UnionTech Software Technology Co., Ltd.
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#ifndef DESKTOPENTRY_H
#define DESKTOPENTRY_H
#include <QString>
#include <QMap>
#include <QDebug>
#include <QLocale>
#include <QTextStream>
#include <optional>
#include <QFile>
constexpr static auto defaultKeyStr = "default";
enum class DesktopErrorCode {
NoError,
NotFound,
MismatchedFile,
InvalidLocation,
OpenFailed,
GroupHeaderInvalid,
EntryKeyInvalid
};
struct DesktopFileGuard;
struct DesktopFile
{
friend struct DesktopFileGuard;
DesktopFile(const DesktopFile &) = delete;
DesktopFile(DesktopFile &&) = default;
DesktopFile &operator=(const DesktopFile &) = delete;
DesktopFile &operator=(DesktopFile &&) = default;
~DesktopFile() = default;
[[nodiscard]] QString sourcePath() const noexcept;
// WARNING: This raw pointer's ownership belong to DesktopFile, DO NOT MODIFY!
[[nodiscard]] QFile *sourceFile() const noexcept { return &sourceFileRef(); };
[[nodiscard]] QFile &sourceFileRef() const noexcept { return *m_fileSource; };
[[nodiscard]] const QString &desktopId() const noexcept { return m_desktopId; }
[[nodiscard]] bool modified(std::size_t time) const noexcept;
static std::optional<DesktopFile> searchDesktopFileById(const QString &appId, DesktopErrorCode &err) noexcept;
static std::optional<DesktopFile> searchDesktopFileByPath(const QString &desktopFilePath, DesktopErrorCode &err) noexcept;
static std::optional<DesktopFile> createTemporaryDesktopFile(std::unique_ptr<QFile> temporaryFile) noexcept;
private:
DesktopFile(std::unique_ptr<QFile> source, QString fileId, std::size_t mtime)
: m_mtime(mtime)
, m_fileSource(std::move(source))
, m_desktopId(std::move(fileId))
{
}
std::size_t m_mtime;
std::unique_ptr<QFile> m_fileSource{nullptr};
QString m_desktopId{""};
};
struct DesktopFileGuard
{
DesktopFileGuard(const DesktopFileGuard &) = delete;
DesktopFileGuard(DesktopFileGuard &&other) noexcept
: fileRef(other.fileRef)
{
}
DesktopFileGuard &operator=(const DesktopFileGuard &) = delete;
DesktopFileGuard &operator=(DesktopFileGuard &&) = delete;
explicit DesktopFileGuard(DesktopFile &file)
: fileRef(file)
{
}
bool try_open() { return fileRef.m_fileSource->open(QFile::ExistingOnly | QFile::ReadOnly | QFile::Text); }
~DesktopFileGuard()
{
if (fileRef.m_fileSource->isOpen()) {
fileRef.m_fileSource->close();
}
}
private:
DesktopFile &fileRef;
};
class DesktopEntry
{
public:
class Value final : private QMap<QString, QString>
{
public:
using QMap<QString, QString>::QMap;
using QMap<QString, QString>::find;
using QMap<QString, QString>::insert;
using QMap<QString, QString>::cbegin;
using QMap<QString, QString>::cend;
using QMap<QString, QString>::begin;
using QMap<QString, QString>::end;
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:
[[nodiscard]] static QString unescape(const QString &str) noexcept;
};
DesktopEntry() = default;
DesktopEntry(const DesktopEntry &) = default;
DesktopEntry(DesktopEntry &&) = default;
DesktopEntry &operator=(const DesktopEntry &) = default;
DesktopEntry &operator=(DesktopEntry &&) = default;
~DesktopEntry() = default;
[[nodiscard]] DesktopErrorCode parse(DesktopFile &file) noexcept;
[[nodiscard]] DesktopErrorCode parse(QTextStream &stream) noexcept;
[[nodiscard]] std::optional<QMap<QString, Value>> group(const QString &key) const noexcept;
[[nodiscard]] std::optional<Value> value(const QString &key, const QString &valueKey) const noexcept;
private:
QMap<QString, QMap<QString, Value>> m_entryMap;
auto parserGroupHeader(const QString &str) noexcept;
static DesktopErrorCode parseEntry(const QString &str, decltype(m_entryMap)::iterator &currentGroup) noexcept;
};
QDebug operator<<(QDebug debug, const DesktopEntry::Value &v);
QDebug operator<<(QDebug debug, const DesktopErrorCode &v);
#endif