Differential D26202 Diff 72338 src/kconfig_compiler/KConfigCommonStructs.h

Changeset View

Standalone View

View Options

src/kconfig_compiler/KConfigCommonStructs.h

  • This file was added.
1​#ifndef KCONFIGCOMMONSTRUCTS_H
2​#define KCONFIGCOMMONSTRUCTS_H
3​
4​#include <QString>
5​#include <QVector>
6​#include <QList>
7​
8​#include "KConfigXTParameters.h"
9​struct SignalArguments {
10​ QString type;
11​ QString variableName;
12​};
13​
14​// TODO: Remove Signal Arguments for `Param`
15​struct Param
dfaureUnsubmitted
Done

done already?

dfaure: done already?
tcanabravaAuthorUnsubmitted
Done

No, there's a struct SignalArguments and a struct Param that are basically the same thing. A name and a Type. Still in the TODO.

tcanabrava: No, there's a struct SignalArguments and a struct Param that are basically the same thing. A…
dfaureUnsubmitted
Done

Oh. I thought it meant "remove SignalArguments members from Param".

Can you at least clarify the comment by saying "TODO merge Param and SignalArguments" or (in front of SignalArguments) "TODO use Param instead"?

dfaure: Oh. I thought it meant "remove SignalArguments members from Param". Can you at least clarify…
16​{
17​ QString name;
18​ QString type;
19​};
20​
21​struct Signal
22​{
23​ QString name;
24​ QString label;
25​ QList<SignalArguments> arguments;
26​ bool modify = false;
27​};
28​
29​class CfgEntry
30​{
31​public:
32​ struct Choice {
33​ QString name;
34​ QString context;
35​ QString label;
36​ QString toolTip;
37​ QString whatsThis;
38​ };
39​ class Choices
40​ {
41​ public:
42​ Choices() {}
43​ Choices(const QList<Choice> &d, const QString &n, const QString &p)
44​ : prefix(p), choices(d), mName(n)
45​ {
46​ int i = n.indexOf(QLatin1String("::"));
47​ if (i >= 0) {
48​ mExternalQual = n.left(i + 2);
49​ }
50​ }
51​ QString prefix;
52​ QList<Choice> choices;
53​ const QString &name() const
54​ {
55​ return mName;
56​ }
57​ const QString &externalQualifier() const
58​ {
59​ return mExternalQual;
60​ }
61​ bool external() const
62​ {
63​ return !mExternalQual.isEmpty();
64​ }
65​ private:
66​ QString mName;
67​ QString mExternalQual;
68​ };
69​
70​public:
71​ QString group;
72​ QString type;
73​ QString key;
74​ QString name;
75​ QString labelContext;
76​ QString label;
77​ QString toolTipContext;
78​ QString toolTip;
79​ QString whatsThisContext;
80​ QString whatsThis;
81​ QString code;
82​ QString defaultValue;
83​ QString param;
84​ QString paramName;
85​ QString paramType;
86​ Choices choices;
87​ QList<Signal> signalList;
88​ QStringList paramValues;
89​ QStringList paramDefaultValues;
90​ int paramMax;
91​ bool hidden;
92​ QString min;
93​ QString max;
94​};
95​
96​struct ParseResult {
97​ QString cfgFileName;
98​ bool cfgFileNameArg = false;
99​ QList<Param> parameters;
100​ QList<Signal> signalList;
101​ QStringList includes;
102​ QList<CfgEntry *> entries;
103​ bool hasNonModifySignals;
104​};
105​
106​// TODO: Move those methods
107​QString enumName(const QString &n);
108​QString enumName(const QString &n, const CfgEntry::Choices &c);
109​QString param(const QString &t);
110​QString cppType(const QString &t);
111​QString itemType(const QString &type);
112​QString changeSignalName(const QString &n);
113​
114​QString enumType(const CfgEntry *e, bool globalEnums);
115​
116​QString getDefaultFunction(const QString &n, const QString &className = QString());
117​QString setFunction(const QString &n, const QString &className = QString());
118​QString getFunction(const QString &n, const QString &className = QString());
119​
120​QString memberAccessorBody(CfgEntry *e, bool globalEnums, const KConfigXTParameters &cfg);
121​QString itemAccessorBody(CfgEntry *e, const KConfigXTParameters &cfg);
122​QString memberMutatorBody(CfgEntry *e, const KConfigXTParameters &cfg);
123​QString signalEnumName(const QString &signalName);
124​
125​// returns the name of an member variable
126​// use itemPath to know the full path
127​// like using d-> in case of dpointer
ervinUnsubmitted
Done

Hell yes, that's will be a nice second step.

ervin: Hell yes, that's will be a nice second step.
128​QString varName(const QString &n, const KConfigXTParameters &cfg);
129​
130​QString varPath(const QString &n, const KConfigXTParameters &cfg);
131​
132​// returns the name of an item variable
133​// use itemPath to know the full path
134​// like using d-> in case of dpointer
135​QString itemVar(const CfgEntry *e, const KConfigXTParameters &cfg);
136​
137​QString itemPath(const CfgEntry *e, const KConfigXTParameters &cfg);
138​
139​QString filenameOnly(const QString &path);
140​
141​QString itemDeclaration(const CfgEntry *e, const KConfigXTParameters &cfg);
142​
143​QString translatedString(
144​ const KConfigXTParameters &cfg,
145​ const QString &string,
146​ const QString &context = QString(),
147​ const QString &param = QString(),
148​ const QString &paramValue = QString());
149​
150​// TODO: Sanitize those functions.
151​QString newItem(
152​ const CfgEntry* entry,
153​ const QString &key,
154​ const QString& defaultValue,
155​ const KConfigXTParameters &cfg,
156​ const QString &param = QString());
157​
158​QString userTextsFunctions(
159​ CfgEntry *e,
160​ const KConfigXTParameters &cfg,
161​ QString itemVarStr = QString(),
162​ const QString &i = QString());
163​
164​QString paramString(const QString &s, const CfgEntry *e, int i);
165​QString paramString(const QString &group, const QList<Param> &parameters);
166​
167​QString defaultValue(const QString &t);
168​QString memberGetDefaultBody(CfgEntry *e);
169​QString literalString(const QString &s);
170​void addQuotes(QString &s);
171​
172​#endif
ervinUnsubmitted
Done

Space before * not after

ervin: Space before * not after