-
Notifications
You must be signed in to change notification settings - Fork 512
/
configparams.h
188 lines (156 loc) · 7.65 KB
/
configparams.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
Copyright 2016 - 2020 Benjamin Vedder benjamin@vedder.se
This file is part of VESC Tool.
VESC Tool is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
VESC Tool is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef CONFIGPARAMS_H
#define CONFIGPARAMS_H
#include <QObject>
#include <QHash>
#include <QStringList>
#include <QXmlStreamWriter>
#include <QXmlStreamReader>
#include "configparam.h"
#include "vbytearray.h"
class ConfigParams : public QObject
{
Q_OBJECT
public:
explicit ConfigParams(QObject *parent = nullptr);
Q_INVOKABLE void addParam(const QString &name, ConfigParam param);
Q_INVOKABLE void deleteParam(const QString &name);
Q_INVOKABLE void setUpdateOnly(const QString &name);
Q_INVOKABLE QString getUpdateOnly();
Q_INVOKABLE bool getUpdatesEnabled() const;
Q_INVOKABLE void setUpdatesEnabled(bool updatesEnabled);
Q_INVOKABLE void clearParams();
Q_INVOKABLE void clearAll();
Q_INVOKABLE bool hasParam(const QString &name);
ConfigParam *getParam(const QString &name);
Q_INVOKABLE ConfigParam getParamCopy(const QString &name) const;
Q_INVOKABLE bool isParamDouble(const QString &name);
Q_INVOKABLE bool isParamInt(const QString &name);
Q_INVOKABLE bool isParamEnum(const QString &name);
Q_INVOKABLE bool isParamQString(const QString &name);
Q_INVOKABLE bool isParamBool(const QString &name);
Q_INVOKABLE bool isParamBitfield(const QString &name);
Q_INVOKABLE double getParamDouble(const QString &name);
Q_INVOKABLE int getParamInt(const QString &name);
Q_INVOKABLE int getParamEnum(const QString &name);
Q_INVOKABLE QString getParamQString(const QString &name);
Q_INVOKABLE bool getParamBool(const QString &name);
Q_INVOKABLE QString getLongName(const QString &name);
Q_INVOKABLE QString getDescription(const QString &name);
Q_INVOKABLE double getParamMaxDouble(const QString &name);
Q_INVOKABLE double getParamMinDouble(const QString &name);
Q_INVOKABLE double getParamStepDouble(const QString &name);
Q_INVOKABLE int getParamDecimalsDouble(const QString &name);
Q_INVOKABLE int getParamMaxInt(const QString &name);
Q_INVOKABLE int getParamMinInt(const QString &name);
Q_INVOKABLE int getParamStepInt(const QString &name);
Q_INVOKABLE int getParamMaxLen(const QString &name);
Q_INVOKABLE QStringList getParamEnumNames(const QString &name);
Q_INVOKABLE double getParamEditorScale(const QString &name);
Q_INVOKABLE QString getParamSuffix(const QString &name);
Q_INVOKABLE bool getParamEditAsPercentage(const QString &name);
Q_INVOKABLE bool getParamShowDisplay(const QString &name);
Q_INVOKABLE bool getParamTransmittable(const QString &name);
Q_INVOKABLE QStringList getParamOrder() const;
void setParamOrder(const QStringList &order);
QWidget *getEditor(const QString &name, QWidget *parent = nullptr);
void getParamSerial(VByteArray &vb, const QString &name);
void setParamSerial(VByteArray &vb, const QString &name, QObject *src = nullptr);
QStringList getSerializeOrder() const;
void setSerializeOrder(const QStringList &serializeOrder);
void clearSerializeOrder();
Q_INVOKABLE void serialize(VByteArray &vb);
Q_INVOKABLE bool deSerialize(VByteArray &vb);
void getXML(QXmlStreamWriter &stream, QString configName);
bool setXML(QXmlStreamReader &stream, QString configName);
Q_INVOKABLE bool saveXml(QString fileName, QString configName);
Q_INVOKABLE bool loadXml(QString fileName, QString configName);
QString xmlStatus();
QString saveCompressed(QString configName);
bool loadCompressed(QString data, QString configName);
void getParamsXML(QXmlStreamWriter &stream);
bool setParamsXML(QXmlStreamReader &stream);
bool saveParamsXml(QString fileName);
bool loadParamsXml(QString fileName);
QByteArray getCompressedParamsXml();
bool loadCompressedParamsXml(QByteArray data);
bool saveCDefines(const QString &fileName, bool wrapIfdef = false);
QStringList checkDifference(ConfigParams *config);
quint32 getSignature();
// Parameter grouping
void setGrouping(QList<QPair<QString, QList<QPair<QString, QStringList>>>> grouping);
QList<QPair<QString, QList<QPair<QString, QStringList>>>> getGrouping() const;
Q_INVOKABLE QStringList getParamGroups();
Q_INVOKABLE QStringList getParamSubgroups(QString group);
Q_INVOKABLE QStringList getParamsFromSubgroup(QString group, QString subgroup);
void clearParamGroups();
bool removeParamGroup(QString group);
bool clearParamGroup(QString group);
bool removeParamSubgroup(QString group, QString subgroup);
bool clearParamSubgroup(QString group, QString subgroup);
bool removeParamFromSubgroup(QString group, QString subgroup, QString param);
void addParamGroup(QString groupName);
bool addParamSubgroup(QString group, QString subgroupName);
bool addParamToSubgroup(QString group, QString subgroup, QString param);
bool moveGroupUp(QString group);
bool moveGroupDown(QString group);
bool moveSubgroupUp(QString group, QString subgroup);
bool moveSubgroupDown(QString group, QString subgroup);
bool moveSubgroupParamUp(QString group, QString subgroup, QString param);
bool moveSubgroupParamDown(QString group, QString subgroup, QString param);
bool renameGroup(QString group, QString newName);
bool renameSubgroup(QString group, QString subgroup, QString newName);
bool renameSubgroupParam(QString group, QString subgroup, QString param, QString newName);
// Operators
ConfigParams& operator=(const ConfigParams &other);
int getConfigVersion() const;
bool getStoreConfigVersion() const;
void setStoreConfigVersion(bool storeConfigVersion);
int updateCnt() const;
signals:
void paramChangedDouble(QObject *src, QString name, double newParam);
void paramChangedInt(QObject *src, QString name, int newParam);
void paramChangedEnum(QObject *src, QString name, int newParam);
void paramChangedQString(QObject *src, QString name, QString newParam);
void paramChangedBool(QObject *src, QString name, bool newParam);
void updateRequested();
void updateRequestDefault();
void updated();
void savingXml();
public slots:
void updateParamDouble(QString name, double param, QObject *src = nullptr);
void updateParamInt(QString name, int param, QObject *src = nullptr);
void updateParamEnum(QString name, int param, QObject *src = nullptr);
void updateParamString(QString name, QString param, QObject *src = nullptr);
void updateParamBool(QString name, bool param, QObject *src = nullptr);
void updateParamFromOther(QString name, const ConfigParam &other, QObject *src);
void requestUpdate();
void requestUpdateDefault();
void updateDone();
private:
QHash<QString, ConfigParam> mParams;
QStringList mParamList;
QString mUpdateOnlyName;
bool mUpdatesEnabled;
QStringList mSerializeOrder;
QString mXmlStatus;
QList<QPair<QString, QList<QPair<QString, QStringList>>>> mParamGrouping;
int mConfigVersion;
bool mStoreConfigVersion;
int mUpdateCnt;
bool almostEqual(float A, float B, float eps);
};
#endif // CONFIGPARAMS_H