Differential D26202 Diff 74121 src/kconfig_compiler/KConfigCodeGeneratorBase.cpp

Changeset View

Standalone View

View Options

src/kconfig_compiler/KConfigCodeGeneratorBase.cpp

  • This file was added.
1​/* m_this file is part of the KDE libraries
2​ Copyright (C) 2020 Tomaz Cananbrava (tcanabrava@kde.org)
3​ Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>
dfaureUnsubmitted
Done

Is this really entirely new code?

Please propagate the copyright of the file you copied this from.

I can agree that .h files are brand new, but not .cpp files

dfaure: Is this really entirely new code? Please propagate the copyright of the file you copied this…
4​ Copyright (c) 2003 Waldo Bastian <bastian@kde.org>
5​ Copyright (c) 2003 Zack Rusin <zack@kde.org>
6​ Copyright (c) 2006 Michaël Larouche <michael.larouche@kdemail.net>
7​ Copyright (c) 2008 Allen Winter <winter@kde.org>
8​ Copyright (C) 2020 Tomaz Cananbrava (tcanabrava@kde.org)
9​
10​ m_this library is free software; you can redistribute it and/or
11​ modify it under the terms of the GNU Library General Public
12​ License as published by the Free Software Foundation; either
13​ version 2 of the License, or (at your option) any later version.
14​
15​ m_this library is distributed in the hope that it will be useful,
16​ but WITHOUT ANY WARRANTY; without even the implied warranty of
17​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18​ Library General Public License for more details.
19​
20​ You should have received a copy of the GNU Library General Public License
21​ along with this library; see the file COPYING.LIB. If not, write to
22​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23​ Boston, MA 02110-1301, USA.
24​*/
25​
26​#include "KConfigCodeGeneratorBase.h"
27​#include "KConfigParameters.h"
28​#include "KConfigCommonStructs.h"
29​
30​#include <QTextStream>
31​#include <QLatin1Char>
32​#include <QFileInfo>
33​
34​#include <ostream>
35​#include <QDebug>
36​
37​using std::endl;
38​
39​namespace
40​{
41​QTextStream cout(stdout);
42​QTextStream cerr(stderr);
43​}
44​
45​KConfigCodeGeneratorBase::KConfigCodeGeneratorBase(
46​ const QString &inputFile,
47​ const QString &baseDir,
ervinUnsubmitted
Done

Space before & not after

ervin: Space before & not after
48​ const QString &fileName,
49​ const KConfigParameters &parameters,
50​ ParseResult &parseResult)
51​ : m_inputFile(inputFile), m_baseDir(baseDir), m_fileName(fileName), m_cfg(parameters), parseResult(parseResult)
52​{
53​ m_file.setFileName(m_fileName);
54​ if (!m_file.open(QIODevice::WriteOnly)) {
55​ cerr << "Can not open '" << m_fileName << "for writing." << endl;
56​ exit(1);
57​ }
58​ m_stream.setDevice(&m_file);
59​ m_stream.setCodec("utf-8");
60​
61​ if (m_cfg.staticAccessors) {
62​ m_this = QStringLiteral("self()->");
63​ } else {
64​ m_const = QStringLiteral(" const");
65​ }
66​}
67​
68​KConfigCodeGeneratorBase::~KConfigCodeGeneratorBase()
69​{
70​ save();
71​}
72​
73​void KConfigCodeGeneratorBase::save()
74​{
75​ m_file.close();
76​}
77​
78​//TODO: Remove this weird logic and adapt the testcases
79​void KConfigCodeGeneratorBase::indent()
80​{
81​ if (m_indentLevel >= 4) {
ervinUnsubmitted
Done

This is an odd indentation logic, is it to stay close to the original? (which I'd actually support, just trying to understand where that's coming from).

ervin: This is an odd indentation logic, is it to stay close to the original? (which I'd actually…
tcanabravaAuthorUnsubmitted
Not Done

it's to stay close to the original. originally all the indentation was done manually, but first 4 spaces and later 2 spaces. This code is bogus and I would like to get rid of it spporting only one indentation style. I'm adding a TODO: for that here.

tcanabrava: it's to stay close to the original. originally all the indentation was done manually, but first…
82​ m_indentLevel += 2;
83​ } else {
84​ m_indentLevel += 4;
85​ }
86​}
87​
88​void KConfigCodeGeneratorBase::unindent()
89​{
90​ if (m_indentLevel > 4) {
91​ m_indentLevel -= 2;
92​ } else {
93​ m_indentLevel -= 4;
94​ }
95​}
96​
97​QString KConfigCodeGeneratorBase::whitespace() const
98​{
99​ QString spaces;
100​ for (int i = 0; i < m_indentLevel; i++) {
101​ spaces.append(QLatin1Char(' '));
102​ }
103​ return spaces;
104​}
105​
106​void KConfigCodeGeneratorBase::startScope()
107​{
108​ m_stream << whitespace() << QLatin1Char('{');
109​ m_stream << endl;
110​ indent();
111​}
112​
113​void KConfigCodeGeneratorBase::endScope(ScopeFinalizer finalizer)
114​{
115​ unindent();
116​ m_stream << whitespace() << QLatin1Char('}');
117​ if (finalizer == ScopeFinalizer::Semicolon) {
118​ m_stream << ';';
119​ }
120​ m_stream << endl;
121​}
122​
123​void KConfigCodeGeneratorBase::start()
124​{
125​ const QString m_fileName = QFileInfo(m_inputFile).fileName();
126​ m_stream << "// This file is generated by kconfig_compiler_kf5 from " << m_fileName << ".kcfg" << "." << endl;
127​ m_stream << "// All changes you do to this file will be lost." << endl;
128​}
129​
130​void KConfigCodeGeneratorBase::addHeaders(const QStringList &headerList)
ervinUnsubmitted
Done

Space before & not after

ervin: Space before & not after
131​{
132​ for (auto include : qAsConst(headerList)) {
133​ if (include.startsWith(QLatin1Char('"'))) {
134​ m_stream << "#include " << include << endl;
135​ } else {
136​ m_stream << "#include <" << include << ">" << endl;
137​ }
138​ }
139​}
140​
141​// adds as many 'namespace foo {' lines to p_out as
142​// there are namespaces in p_ns
143​void KConfigCodeGeneratorBase::beginNamespaces()
144​{
145​ if (!m_cfg.nameSpace.isEmpty()) {
146​ for (const QString &ns : m_cfg.nameSpace.split(QStringLiteral("::"))) {
147​ m_stream << "namespace " << ns << " {" << endl;
148​ }
149​ m_stream << endl;
150​ }
151​}
152​
153​// adds as many '}' lines to p_out as
154​// there are namespaces in p_ns
155​void KConfigCodeGeneratorBase::endNamespaces()
156​{
157​ if (!m_cfg.nameSpace.isEmpty()) {
158​ m_stream << endl;
159​ const int namespaceCount = m_cfg.nameSpace.count(QStringLiteral("::")) + 1;
160​ for (int i = 0; i < namespaceCount; ++i) {
161​ m_stream << "}" << endl;
162​ }
163​ }
164​}
165​
166​// returns the member accesor implementation
167​// which should go in the h file if inline
168​// or the cpp file if not inline
169​QString KConfigCodeGeneratorBase::memberAccessorBody(const CfgEntry *e, bool globalEnums) const
170​{
171​ QString result;
172​ QTextStream out(&result, QIODevice::WriteOnly);
173​ QString n = e->name;
174​ QString t = e->type;
175​ bool useEnumType = m_cfg.useEnumTypes && t == QLatin1String("Enum");
176​
177​ out << "return ";
178​ if (useEnumType) {
179​ out << "static_cast<" << enumType(e, globalEnums) << ">(";
180​ }
181​ out << m_this << varPath(n, m_cfg);
182​ if (!e->param.isEmpty()) {
183​ out << "[i]";
184​ }
185​ if (useEnumType) {
186​ out << ")";
187​ }
188​ out << ";" << endl;
189​
190​ return result;
191​}
192​
193​void KConfigCodeGeneratorBase::createIfSetLogic(const CfgEntry *e, const QString &varExpression)
194​{
195​ const QString n = e->name;
196​ const QString t = e->type;
197​ const bool hasBody = !e->signalList.empty() || m_cfg.generateProperties;
198​
199​ m_stream << whitespace() << "if (";
200​ if (hasBody) {
201​ m_stream << "v != " << varExpression << " && ";
202​ }
203​ m_stream << "!" << m_this << "isImmutable( QStringLiteral( \"";
204​ if (!e->param.isEmpty()) {
205​ QString paramName = e->paramName;
206​
207​ m_stream << paramName.replace(QStringLiteral("$(") + e->param + QStringLiteral(")"), QLatin1String("%1")) << "\" ).arg( ";
208​ if (e->paramType == QLatin1String("Enum")) {
209​ m_stream << "QLatin1String( ";
210​
211​ if (m_cfg.globalEnums) {
212​ m_stream << enumName(e->param) << "ToString[i]";
213​ } else {
214​ m_stream << enumName(e->param) << "::enumToString[i]";
215​ }
216​
217​ m_stream << " )";
218​ } else {
219​ m_stream << "i";
220​ }
221​ m_stream << " )";
222​ } else {
223​ m_stream << n << "\" )";
224​ }
225​ m_stream << " ))";
226​}
227​
228​void KConfigCodeGeneratorBase::memberMutatorBody(const CfgEntry *e)
229​{
230​ QString n = e->name;
231​ QString t = e->type;
232​
233​ // HACK: Don't open '{' manually, use startScope / endScope to automatically handle whitespace indentation.
234​ if (!e->min.isEmpty()) {
235​ if (e->min != QLatin1String("0") || !isUnsigned(t)) { // skip writing "if uint<0" (#187579)
236​ m_stream << whitespace() << "if (v < " << e->min << ")" << endl;
237​ m_stream << whitespace() << "{" << endl;
238​ m_stream << whitespace(); addDebugMethod(m_stream, m_cfg, n);
239​ m_stream << ": value \" << v << \" is less than the minimum value of " << e->min << "\";" << endl;
240​ m_stream << whitespace() << " v = " << e->min << ";" << endl;
241​ m_stream << whitespace() << "}" << endl;
242​ }
243​ }
244​
245​ if (!e->max.isEmpty()) {
246​ m_stream << endl;
247​ m_stream << whitespace() << "if (v > " << e->max << ")" << endl;
248​ m_stream << whitespace() << "{" << endl;
249​ m_stream << whitespace(); addDebugMethod(m_stream, m_cfg, n);
250​ m_stream << ": value \" << v << \" is greater than the maximum value of " << e->max << "\";" << endl;
251​ m_stream << whitespace() << " v = " << e->max << ";" << endl;
252​ m_stream << whitespace() << "}" << endl << endl;
253​ }
254​
255​ const QString varExpression = m_this + varPath(n, m_cfg) + (e->param.isEmpty() ? QString() : QStringLiteral("[i]"));
256​
257​ // TODO: Remove this `hasBody` logic, always use an '{' for the if.
258​ const bool hasBody = !e->signalList.empty() || m_cfg.generateProperties;
259​
260​ // m_this call creates an `if (someTest ...) that's just to long to throw over the code.
261​ createIfSetLogic(e, varExpression);
262​ m_stream << (hasBody ? " {" : "") << endl;
263​ m_stream << whitespace() << " " << varExpression << " = v;" << endl;
264​
265​ const auto listSignal = e->signalList;
266​ for (const Signal &signal : qAsConst(listSignal)) {
267​ if (signal.modify) {
268​ m_stream << whitespace() << " Q_EMIT " << m_this << signal.name << "();" << endl;
269​ } else {
270​ m_stream << whitespace() << " " << m_this << varPath(QStringLiteral("settingsChanged"), m_cfg)
271​ << " |= " << signalEnumName(signal.name) << ";" << endl;
272​ }
273​ }
274​ if (hasBody) {
275​ m_stream << whitespace() << "}" << endl;
276​ }
277​}