Differential D26202 Diff 73510 src/kconfig_compiler/KConfigCommonStructs.h

Changeset View

Standalone View

View Options

src/kconfig_compiler/KConfigCommonStructs.h

  • This file was added.
1​/* This file is part of the KDE libraries
2​ Copyright (C) 2020 Tomaz Cananbrava (tcanabrava@kde.org)
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Library General Public
6​ License as published by the Free Software Foundation; either
7​ version 2 of the License, or (at your option) any later version.
8​
9​ This library is distributed in the hope that it will be useful,
10​ but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12​ Library General Public License for more details.
13​
14​ You should have received a copy of the GNU Library General Public License
15​ along with this library; see the file COPYING.LIB. If not, write to
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​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17​ Boston, MA 02110-1301, USA.
18​*/
19​
20​#ifndef KCONFIGCOMMONSTRUCTS_H
21​#define KCONFIGCOMMONSTRUCTS_H
22​
23​#include <QString>
24​#include <QVector>
25​#include <QList>
26​
27​#include "KConfigXTParameters.h"
28​
29​struct Param
30​{
31​ QString name;
32​ QString type;
33​};
34​
35​struct Signal
36​{
37​ QString name;
38​ QString label;
39​ QList<Param> arguments;
40​ bool modify = false;
41​};
42​
43​class CfgEntry
44​{
45​public:
46​ struct Choice {
47​ QString name;
48​ QString context;
49​ QString label;
50​ QString toolTip;
51​ QString whatsThis;
52​ };
53​ class Choices
54​ {
55​ public:
56​ Choices() {}
57​ Choices(const QList<Choice> &d, const QString &n, const QString &p)
58​ : prefix(p), choices(d), mName(n)
59​ {
60​ int i = n.indexOf(QLatin1String("::"));
61​ if (i >= 0) {
62​ mExternalQual = n.left(i + 2);
63​ }
64​ }
65​ QString prefix;
66​ QList<Choice> choices;
67​ const QString &name() const
68​ {
69​ return mName;
70​ }
71​ const QString &externalQualifier() const
72​ {
73​ return mExternalQual;
74​ }
75​ bool external() const
76​ {
77​ return !mExternalQual.isEmpty();
78​ }
79​ private:
80​ QString mName;
81​ QString mExternalQual;
82​ };
83​
84​public:
85​ QString group;
86​ QString type;
87​ QString key;
88​ QString name;
89​ QString labelContext;
90​ QString label;
91​ QString toolTipContext;
92​ QString toolTip;
93​ QString whatsThisContext;
94​ QString whatsThis;
95​ QString code;
96​ QString defaultValue;
97​ QString param;
98​ QString paramName;
99​ QString paramType;
100​ Choices choices;
101​ QList<Signal> signalList;
102​ QStringList paramValues;
103​ QStringList paramDefaultValues;
104​ int paramMax;
105​ bool hidden;
106​ QString min;
107​ QString max;
108​};
109​
110​struct ParseResult {
111​ QString cfgFileName;
112​ bool cfgFileNameArg = false;
113​ QList<Param> parameters;
114​ QList<Signal> signalList;
115​ QStringList includes;
116​ QList<CfgEntry *> entries;
117​ bool hasNonModifySignals = false;
118​};
119​
120​// TODO: Move those methods
121​QString enumName(const QString &n);
122​QString enumName(const QString &n, const CfgEntry::Choices &c);
123​QString param(const QString &t);
124​QString cppType(const QString &t);
125​QString itemType(const QString &type);
126​QString changeSignalName(const QString &n);
127​
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 enumType(const CfgEntry *e, bool globalEnums);
129​
130​QString getDefaultFunction(const QString &n, const QString &className = QString());
131​QString setFunction(const QString &n, const QString &className = QString());
132​QString getFunction(const QString &n, const QString &className = QString());
133​
134​QString itemAccessorBody(const CfgEntry *e, const KConfigXTParameters &cfg);
135​QString signalEnumName(const QString &signalName);
136​
137​bool isUnsigned(const QString &type);
138​
139​// returns the name of an member variable
140​// use itemPath to know the full path
141​// like using d-> in case of dpointer
142​QString varName(const QString &n, const KConfigXTParameters &cfg);
143​
144​QString varPath(const QString &n, const KConfigXTParameters &cfg);
145​
146​// returns the name of an item variable
147​// use itemPath to know the full path
148​// like using d-> in case of dpointer
149​QString itemVar(const CfgEntry *e, const KConfigXTParameters &cfg);
150​
151​QString itemPath(const CfgEntry *e, const KConfigXTParameters &cfg);
152​
153​QString filenameOnly(const QString &path);
154​
155​QString itemDeclaration(const CfgEntry *e, const KConfigXTParameters &cfg);
156​
157​QString translatedString(
158​ const KConfigXTParameters &cfg,
159​ const QString &string,
160​ const QString &context = QString(),
161​ const QString &param = QString(),
162​ const QString &paramValue = QString());
163​
164​// TODO: Sanitize those functions.
165​QString newItem(
166​ const CfgEntry* entry,
167​ const QString &key,
168​ const QString& defaultValue,
169​ const KConfigXTParameters &cfg,
170​ const QString &param = QString());
171​
172​QString userTextsFunctions(
173​ const CfgEntry *e,
ervinUnsubmitted
Done

Space before * not after

ervin: Space before * not after
174​ const KConfigXTParameters &cfg,
175​ QString itemVarStr = QString(),
176​ const QString &i = QString());
177​
178​QString paramString(const QString &s, const CfgEntry *e, int i);
179​QString paramString(const QString &group, const QList<Param> &parameters);
180​
181​QString defaultValue(const QString &t);
182​QString memberGetDefaultBody(const CfgEntry *e);
183​QString literalString(const QString &s);
184​QString enumTypeQualifier(const QString &n, const CfgEntry::Choices &c);
185​
186​void addQuotes(QString &s);
187​void addDebugMethod(QTextStream &out, const KConfigXTParameters &cfg, const QString &n);
188​
189​#endif