Debian Codegraph @

src/settings/dsettingsgroup.cpp

raw
1 // SPDX-FileCopyrightText: 2016 - 2022 UnionTech Software Technology Co., Ltd.
2 //
3 // SPDX-License-Identifier: LGPL-3.0-or-later
4
5 #include "dsettingsgroup.h"
6
7 #include <QMap>
8 #include <QJsonObject>
9 #include <QJsonArray>
10
11 DCORE_BEGIN_NAMESPACE
12
13 class DSettingsGroupPrivate
14 {
15 public:
16 DSettingsGroupPrivate(DSettingsGroup *parent) : q_ptr(parent) {}
17
18 QString key;
19 QString name;
20 bool hide = false;
21
22 QMap<QString, OptionPtr> options;
23
24 QPointer<DSettingsGroup> parent;
25 QMap<QString, OptionPtr> childOptions;
26 QList<QString> childOptionKeys;
27
28 QMap<QString, GroupPtr> childGroups;
29 QList<QString> childGroupKeys;
30
31 void parseJson(const QString &prefixKey, const QJsonObject &group);
32
33 DSettingsGroup *q_ptr;
34 Q_DECLARE_PUBLIC(DSettingsGroup)
35 };
36
37 /*!
38 @~english
39 @class Dtk::Core::DSettingsGroup
40 \inmodule dtkcore
41 @brief A group of DSettingsOption and DSettingsGroup.
42 DSettingsGroup can contain a lost option and subgroup.
43 */
44
45
46 DSettingsGroup::DSettingsGroup(QObject *parent) :
47 QObject(parent), dd_ptr(new DSettingsGroupPrivate(this))
48 {
49
50 }
51
52 DSettingsGroup::~DSettingsGroup()
53 {
54
55 }
56
57 /*!
58 @~english
59 @brief Get direct parent group of this group.
60 @return
61 */
62 QPointer<DSettingsGroup> DSettingsGroup::parentGroup() const
63 {
64 Q_D(const DSettingsGroup);
65 return d->parent;
66 }
67
68 /*!
69 @~english
70 @brief Change the direct \a parentGroup of this group.
71 */
72 void DSettingsGroup::setParentGroup(QPointer<DSettingsGroup> parentGroup)
73 {
74 Q_D(DSettingsGroup);
75 d->parent = parentGroup;
76 }
77
78 /*!
79 @~english
80 @brief Return the full key of this group, include all parent.
81 @return eturn the full key of this group, include all parent.
82 */
83 QString DSettingsGroup::key() const
84 {
85 Q_D(const DSettingsGroup);
86 return d->key;
87 }
88
89 /*!
90 @~english
91 @brief Get display name of this group, it may be translated.
92 @return Get display name of this group.
93 */
94 QString DSettingsGroup::name() const
95 {
96 Q_D(const DSettingsGroup);
97 return d->name;
98 }
99
100 /*!
101 @~english
102 @brief Check this group will show on DSettings dialog.
103 @return true indicates that this option group will be displayed。
104 */
105 bool DSettingsGroup::isHidden() const
106 {
107 Q_D(const DSettingsGroup);
108 return d->hide;
109 }
110
111 /*!
112 @~english
113 @brief Get the child group of groupKey
114 \a groupKey is child group key
115
116 @return Returns a pointer to a subgroup.
117 */
118 QPointer<DSettingsGroup> DSettingsGroup::childGroup(const QString &groupKey) const
119 {
120 Q_D(const DSettingsGroup);
121 return d->childGroups.value(groupKey);
122 }
123
124 /*!
125 @~english
126 @brief Get the child option of key
127 \a key is child option key
128
129 @return Returns a pointer to the child option of key.
130 */
131 QPointer<DSettingsOption> DSettingsGroup::option(const QString &key) const
132 {
133 Q_D(const DSettingsGroup);
134 return d->childOptions.value(key);
135 }
136
137 /*!
138 @~english
139 @brief Enum all direct child group of this group
140
141 @return Returns a list of all subgroup Pointers.
142 */
143 QList<QPointer<DSettingsGroup> > DSettingsGroup::childGroups() const
144 {
145 Q_D(const DSettingsGroup);
146 QList<QPointer<DSettingsGroup> > grouplist;
147 for (auto groupKey : d->childGroupKeys) {
148 grouplist << d->childGroups.value(groupKey);
149 }
150 return grouplist;
151 }
152
153 /*!
154 @~english
155 @brief Enum all direct child option with the raw order in json description file.
156 @return Returns a list of all suboption Pointers.
157 */
158 QList<QPointer<DSettingsOption> > DSettingsGroup::childOptions() const
159 {
160 Q_D(const DSettingsGroup);
161 QList<QPointer<DSettingsOption> > optionlist;
162 for (auto optionKey : d->childOptionKeys) {
163 optionlist << d->childOptions.value(optionKey);
164 }
165 return optionlist;
166 }
167
168 /*!
169 @~english
170 @brief Enum all direct child option of this group.
171 @return Returns a list of all option Pointers.
172 */
173 QList<QPointer<DSettingsOption> > DSettingsGroup::options() const
174 {
175 Q_D(const DSettingsGroup);
176 return d->options.values();
177 }
178
179 /*!
180 @~english
181 @brief Convert QJsonObject to DSettingsGroup.
182 \a prefixKey instead parse prefix key from parent.
183 \a group is an QJsonObejct instance.
184 @return Returns a group pointer after parsing json.
185
186 @sa QPointer Dtk::Core::DSettingsOption
187 */
188 QPointer<DSettingsGroup> DSettingsGroup::fromJson(const QString &prefixKey, const QJsonObject &group)
189 {
190 auto groupPtr = QPointer<DSettingsGroup>(new DSettingsGroup);
191 groupPtr->parseJson(prefixKey, group);
192 return groupPtr;
193 }
194
195 /*!
196 @~english
197 @brief Parse QJsonObject to DSettingsGroup.
198 \a prefixKey instead parse prefix key from parent.
199 \a json is an QJsonObejct instance.
200 @sa QPointer<DSettingsOption> Dtk::Core::DSettingsGroup::fromJson(const QString &prefixKey, const QJsonObject &json)
201 */
202 void DSettingsGroup::parseJson(const QString &prefixKey, const QJsonObject &group)
203 {
204 Q_D(DSettingsGroup);
205 d->parseJson(prefixKey, group);
206 }
207
208 void DSettingsGroupPrivate::parseJson(const QString &prefixKey, const QJsonObject &group)
209 {
210 Q_Q(DSettingsGroup);
211 key = group.value("key").toString();
212 Q_ASSERT(!key.isEmpty());
213 key = prefixKey.isEmpty() ? key : prefixKey + "." + key;
214 name = group.value("name").toString();
215 hide = group.value("hide").toBool();
216
217 for (auto optionJson : group.value("options").toArray()) {
218 auto optionObject = optionJson.toObject();
219 auto option = DSettingsOption::fromJson(key, optionObject);
220 option->setParent(q);
221 options.insert(option->key(), option);
222 childOptions.insert(option->key(), option);
223 childOptionKeys << option->key();
224 }
225
226 auto subGroups = group.value("groups").toArray();
227 for (auto subGroup : subGroups) {
228 auto child = DSettingsGroup::fromJson(key, subGroup.toObject());
229 child->setParent(q);
230 child->setParentGroup(q);
231 childGroups.insert(child->key(), child);
232 childGroupKeys << child->key();
233
234 for (auto option : child->options()) {
235 options.insert(option->key(), option);
236 }
237 }
238
239 }
240
241 DCORE_END_NAMESPACE