Debian Codegraph @

include/global/dconfigfile.h

raw
1 // SPDX-FileCopyrightText: 2021 - 2023 UnionTech Software Technology Co., Ltd.
2 //
3 // SPDX-License-Identifier: LGPL-3.0-or-later
4
5 #ifndef DCONFIGFILE_H
6 #define DCONFIGFILE_H
7
8 #include <dtkcore_global.h>
9 #include <DObject>
10 #include <QStringList>
11 #include <QFlags>
12 #include <QVariant>
13 #include <QLocale>
14 #include <QJsonDocument>
15 #include <QDebug>
16
17 QT_BEGIN_NAMESPACE
18 class QIODevice;
19 QT_END_NAMESPACE
20
21 DCORE_BEGIN_NAMESPACE
22
23 class DConfigMeta;
24 class DConfigCache;
25 class DConfigFilePrivate;
26 class LIBDTKCORESHARED_EXPORT DConfigFile : public DObject{
27 D_DECLARE_PRIVATE(DConfigFile)
28 public:
29 enum Flag {
30 NoOverride = 1 << 0,
31 Global = 1 << 1,
32 UserPublic = 1 << 2
33 };
34 Q_DECLARE_FLAGS(Flags, Flag)
35
36 enum Permissions {
37 ReadOnly,
38 ReadWrite
39 };
40
41 enum Visibility {
42 Private,
43 Public
44 };
45
46 struct Version {
47 quint16 major;
48 quint16 minor;
49 };
50
51 static constexpr Version supportedVersion();
52
53 explicit DConfigFile(const QString &appId, const QString &name,
54 const QString &subpath = QString());
55 explicit DConfigFile(const DConfigFile &other);
56
57 bool load(const QString &localPrefix = QString());
58 bool load(QIODevice *meta, const QList<QIODevice*> &overrides);
59
60 bool save(const QString &localPrefix = QString(), QJsonDocument::JsonFormat format = QJsonDocument::Indented,
61 bool sync = false) const;
62
63 bool isValid() const;
64 QVariant value(const QString &key, DConfigCache *userCache = nullptr) const;
65 QVariant cacheValue(DConfigCache *userCache, const QString &key) const;
66 bool setValue(const QString &key, const QVariant &value, const QString &callerAppid,
67 DConfigCache *userCache = nullptr);
68
69 DConfigCache *createUserCache(const uint uid);
70 DConfigCache *globalCache() const;
71
72 DConfigMeta *meta();
73
74 protected:
75 friend QDebug operator<<(QDebug, const DConfigFile &);
76 };
77
78 class LIBDTKCORESHARED_EXPORT DConfigMeta {
79 public:
80 virtual ~DConfigMeta();
81 virtual DConfigFile::Version version() const = 0;
82 virtual void setVersion(quint16 major, quint16 minor) = 0;
83
84 virtual bool load(const QString &localPrefix = QString()) = 0;
85
86 virtual bool load(QIODevice *meta, const QList<QIODevice*> &overrides) = 0;
87
88 virtual QStringList keyList() const = 0;
89 virtual DConfigFile::Flags flags(const QString &key) const = 0;
90 virtual DConfigFile::Permissions permissions(const QString &key) const = 0;
91 virtual DConfigFile::Visibility visibility(const QString &key) const = 0;
92 virtual int serial(const QString &key) const = 0;
93
94 virtual QString displayName(const QString &key, const QLocale &locale) = 0;
95 virtual QString description(const QString &key, const QLocale &locale) = 0;
96
97 virtual QString metaPath(const QString &localPrefix = QString(), bool *useAppId = nullptr) const = 0;
98 virtual QStringList allOverrideDirs(const bool useAppId, const QString &prefix = QString()) const = 0;
99
100 virtual QVariant value(const QString &key) const = 0;
101 static QStringList genericMetaDirs(const QString &localPrefix = QString());
102 static QStringList applicationMetaDirs(const QString &localPrefix, const QString &appId);
103 };
104
105 class LIBDTKCORESHARED_EXPORT DConfigCache {
106 public:
107 virtual ~DConfigCache();
108
109 virtual bool load(const QString &localPrefix = QString()) = 0;
110 virtual bool save(const QString &localPrefix = QString(),
111 QJsonDocument::JsonFormat format = QJsonDocument::Indented, bool sync = false) = 0;
112 virtual bool isGlobal() const = 0;
113
114 virtual void remove(const QString &key) = 0;
115 virtual QStringList keyList() const = 0;
116 virtual bool setValue(const QString &key, const QVariant &value, const int serial,
117 const uint uid, const QString &callerAppid) = 0;
118 virtual QVariant value(const QString &key) const = 0;
119 virtual int serial(const QString &key) const = 0;
120 virtual uint uid() const = 0;
121
122 virtual void setCachePathPrefix(const QString &prefix) = 0;
123 };
124
125 #ifndef QT_NO_DEBUG_STREAM
126 Q_CORE_EXPORT QDebug operator<<(QDebug, const DConfigFile &);
127 #endif
128
129 Q_DECLARE_OPERATORS_FOR_FLAGS(DConfigFile::Flags)
130
131 DCORE_END_NAMESPACE
132
133 #endif // DCONFIGFILE_H