Differential D26202 Diff 74118 src/kconfig_compiler/KConfigHeaderGenerator.cpp

Changeset View

Standalone View

View Options

src/kconfig_compiler/KConfigHeaderGenerator.cpp

  • This file was added.
1​/* 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>
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​ 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​ 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 "KConfigHeaderGenerator.h"
27​#include "KConfigCommonStructs.h"
28​
29​#include <QTextStream>
30​#include <QDebug>
31​
32​namespace
33​{
34​QTextStream cout(stdout);
35​QTextStream cerr(stderr);
36​}
37​
38​KConfigHeaderGenerator::KConfigHeaderGenerator(
39​ const QString &inputFile,
40​ const QString &baseDir,
ervinUnsubmitted
Done

Ditto

ervin: Ditto
41​ const KConfigParameters &cfg,
42​ ParseResult &result)
43​ : KConfigCodeGeneratorBase(inputFile, baseDir, baseDir + cfg.baseName + QLatin1Char('.') + cfg.headerExtension, cfg, result)
44​{
45​}
46​
47​void KConfigHeaderGenerator::start()
48​{
49​ KConfigCodeGeneratorBase::start();
50​ startHeaderGuards();
51​ createHeaders();
52​
53​ beginNamespaces();
dfaureUnsubmitted
Done

qAsConst()

dfaure: qAsConst()
54​
55​ createForwardDeclarations();
56​
57​ doClassDefinition();
58​
59​ endNamespaces();
60​ endHeaderGuards();
61​}
62​
63​void KConfigHeaderGenerator::doClassDefinition()
64​{
65​ stream() << "class " << cfg().visibility << cfg().className << " : public " << cfg().inherits << endl;
66​ startScope();
67​
68​ // Add Q_OBJECT macro if the config need signals.
69​ if (!parseResult.signalList.isEmpty() || cfg().generateProperties) {
70​ stream() << " Q_OBJECT" << endl;
71​ }
72​ stream() << " public:" << endl;
73​ implementEnums();
74​ createConstructor();
75​ createDestructor();
76​
77​ for (auto *entry : parseResult.entries) {
78​ const QString n = entry->name;
79​ const QString t = entry->type;
80​
81​ const QString returnType = (cfg().useEnumTypes && t == QLatin1String("Enum"))
82​ ? enumType(entry, cfg().globalEnums)
83​ : cppType(t);
84​
85​ createSetters(entry);
86​ createProperties(entry, returnType);
87​ createGetters(entry, returnType);
88​ createDefaultValueMember(entry);
89​ createItemAcessors(entry, returnType);
90​ }
91​
92​ createSignals();
93​ stream() << " protected:" << endl;
94​ createSingleton();
95​
96​ // TODO: Move those to functions too.
97​ if (parseResult.hasNonModifySignals) {
98​ stream() << whitespace() << "bool usrSave() override;" << endl;
99​ }
100​
101​ // Member variables
102​ if (!cfg().memberVariables.isEmpty()
103​ && cfg().memberVariables != QLatin1String("private")
104​ && cfg().memberVariables != QLatin1String("dpointer")) {
105​ stream() << " " << cfg().memberVariables << ":" << endl;
106​ }
107​
108​ // Class Parameters
109​ for (const auto &parameter : parseResult.parameters) {
110​ stream() << whitespace() << "" << cppType(parameter.type) << " mParam" << parameter.name << ";" << endl;
111​ }
112​
113​ createNonDPointerHelpers();
114​ createDPointer();
115​
116​ if (cfg().customAddons) {
117​ stream() << whitespace() << "// Include custom additions" << endl;
118​ stream() << whitespace() << "#include \"" << cfg().baseName << "_addons." << cfg().headerExtension << '"' << endl;
119​ }
120​
121​ endScope(ScopeFinalizer::Semicolon);
122​}
123​
124​void KConfigHeaderGenerator::createHeaders()
125​{
126​ addHeaders(cfg().headerIncludes);
127​ if (cfg().headerIncludes.size()) {
128​ stream() << endl;
129​ }
130​
131​ if (!cfg().singleton && parseResult.parameters.isEmpty()) {
132​ addHeaders({QStringLiteral("qglobal.h")});
133​ }
134​
135​ if (cfg().inherits == QLatin1String("KCoreConfigSkeleton")) {
136​ addHeaders({QStringLiteral("kcoreconfigskeleton.h")});
137​ } else {
138​ addHeaders({QStringLiteral("kconfigskeleton.h")});
139​ }
140​
141​ addHeaders({QStringLiteral("QCoreApplication"), QStringLiteral("QDebug")});
dfaureUnsubmitted
Done

s/spaces/newlines/

dfaure: s/spaces/newlines/
142​ stream() << endl;
143​
144​ addHeaders(parseResult.includes);
145​ if (parseResult.includes.size()) {
146​ stream() << endl;
147​ }
148​}
149​
150​void KConfigHeaderGenerator::startHeaderGuards()
151​{
152​ const bool hasNamespace = !cfg().nameSpace.isEmpty();
153​ const QString namespaceName = QString(QString(cfg().nameSpace).replace(QLatin1String("::"), QLatin1String("_"))).toUpper();
154​ const QString namespaceStr = hasNamespace ? namespaceName + QLatin1Char('_') : QStringLiteral("");
155​ const QString defineName = namespaceStr + cfg().className.toUpper() + QStringLiteral("_H");
156​
157​ stream() << "#ifndef " << defineName << endl;
158​ stream() << "#define " << defineName << endl;
159​ stream() << endl;
160​}
161​
162​void KConfigHeaderGenerator::endHeaderGuards()
163​{
164​ stream() << endl;
165​ stream() << "#endif";
166​ stream() << endl;
167​ // HACK: Original files ended with two last newlines, add them.
168​ stream() << endl;
169​}
170​
171​void KConfigHeaderGenerator::implementChoiceEnums(const CfgEntry *entry, const CfgEntry::Choices &choices)
172​{
173​ const QList<CfgEntry::Choice> chlist = choices.choices;
174​
175​ if (chlist.isEmpty()) {
176​ return;
177​ }
178​
179​ QStringList values;
180​ for (const auto choice : qAsConst(chlist)) {
181​ values.append(choices.prefix + choice.name);
182​ }
183​
184​ if (choices.name().isEmpty()) {
185​ if (cfg().globalEnums) {
186​ stream() << whitespace() << "enum " << enumName(entry->name, entry->choices) << " { " << values.join(QStringLiteral(", ")) << " };" << endl;
187​ } else {
188​ // Create an automatically named enum
189​ stream() << whitespace() << "class " << enumName(entry->name, entry->choices) << endl;
190​ stream() << whitespace() << "{" << endl;
191​ stream() << whitespace() << " public:" << endl;
192​ stream() << whitespace() << " enum type { " << values.join(QStringLiteral(", ")) << ", COUNT };" << endl;
193​ stream() << whitespace() << "};" << endl;
194​ }
195​ } else if (!choices.external()) {
196​ // Create a named enum
197​ stream() << whitespace() << "enum " << enumName(entry->name, entry->choices) << " { " << values.join(QStringLiteral(", ")) << " };" << endl;
198​ }
199​}
200​
201​void KConfigHeaderGenerator::implementValueEnums(const CfgEntry *entry, const QStringList &values)
202​{
203​ if (values.isEmpty()) {
204​ return;
205​ }
206​
207​ if (cfg().globalEnums) {
208​ // ### FIXME!!
209​ // make the following string table an index-based string search!
210​ // ###
211​ stream() << whitespace() << "enum " << enumName(entry->param) << " { " << values.join(QStringLiteral(", ")) << " };" << endl;
212​ stream() << whitespace() << "static const char* const " << enumName(entry->param) << "ToString[];" << endl;
213​ } else {
214​ stream() << whitespace() << "class " << enumName(entry->param) << endl;
215​ stream() << whitespace() << "{" << endl;
dfaureUnsubmitted
Done

nothing here?

dfaure: nothing here?
216​ stream() << whitespace() << " public:" << endl;
217​ stream() << whitespace() << " enum type { " << values.join(QStringLiteral(", ")) << ", COUNT };" << endl;
218​ stream() << whitespace() << " static const char* const enumToString[];" << endl;
219​ stream() << whitespace() << "};" << endl;
220​ }
221​}
222​
223​void KConfigHeaderGenerator::implementEnums()
224​{
225​ if (!parseResult.entries.size()) {
226​ return;
227​ }
228​
229​ for (const auto entry : parseResult.entries) {
230​ const CfgEntry::Choices &choices = entry->choices;
231​ const QStringList values = entry->paramValues;
232​
233​ implementChoiceEnums(entry, choices);
234​ implementValueEnums(entry, values);
235​ }
236​ stream() << endl;
237​}
238​
239​void KConfigHeaderGenerator::createSignals()
240​{
241​ // Signal definition.
242​ const bool hasSignals = !parseResult.signalList.isEmpty();
243​
244​ unsigned val = 1 << parseResult.signalList.size();
245​ if (!val) {
246​ cerr << "Too many signals to create unique bit masks" << endl;
247​ exit(1);
248​ }
249​
250​ if (!hasSignals) {
251​ return;
252​ }
253​
254​ stream() << "\n enum {" << endl;
255​ val = 1;
256​
257​ // HACK: Use C-Style for add a comma in all but the last element,
258​ // just to make the source generated code equal to the old one.
259​ // When we are sure, revert this to a range-based-for and just add
260​ // a last comma, as it's valid c++.
261​ for (int i = 0, end = parseResult.signalList.size(); i < end; i++) {
262​ auto signal = parseResult.signalList.at(i);
263​ stream() << whitespace() << " " << signalEnumName(signal.name) << " = 0x" << hex << val;
264​ if (i != end-1) {
265​ stream() << "," << endl;
266​ }
267​
268​ val <<= 1;
269​ }
270​ stream() << endl;
271​ stream() << whitespace() << "};" << dec << endl << endl;
272​
273​ stream() << " Q_SIGNALS:";
274​ for (const Signal &signal : parseResult.signalList) {
275​ stream() << endl;
276​ if (!signal.label.isEmpty()) {
277​ stream() << whitespace() << "/**" << endl;
278​ stream() << whitespace() << " " << signal.label << endl;
279​ stream() << whitespace() << "*/" << endl;
280​ }
281​ stream() << whitespace() << "void " << signal.name << "(";
282​ QList<Param>::ConstIterator it, itEnd = signal.arguments.constEnd();
283​ for (it = signal.arguments.constBegin(); it != itEnd;) {
284​ Param argument = *it;
285​ QString type = param(argument.type);
286​ if (cfg().useEnumTypes && argument.type == QLatin1String("Enum")) {
287​ for (auto *entry : parseResult.entries) {
288​ if (entry->name == argument.name) {
289​ type = enumType(entry, cfg().globalEnums);
290​ break;
291​ }
292​ }
293​ }
294​ stream() << type << " " << argument.name;
295​ if (++it != itEnd) {
296​ stream() << ", ";
297​ }
298​ }
299​ stream() << ");" << endl;
300​ }
301​ stream() << endl;
302​
303​ stream() << " private:" << endl;
304​ stream() << whitespace() << "void itemChanged(quint64 flags);" << endl;
305​ stream() << endl;
306​}
307​
308​void KConfigHeaderGenerator::createDPointer()
309​{
310​ if (!cfg().dpointer) {
311​ return;
312​ }
313​
314​ // use a private class for both member variables and items
315​ stream() << " private:" << endl;
316​ for (const auto &entry : parseResult.entries) {
317​ if (cfg().allDefaultGetters || cfg().defaultGetters.contains(entry->name)) {
318​ stream() << whitespace() << "";
319​ if (cfg().staticAccessors) {
320​ stream() << "static ";
321​ }
322​ stream() << cppType(entry->type) << " " << getDefaultFunction(entry->name) << "_helper(";
323​ if (!entry->param.isEmpty()) {
324​ stream() << " " << cppType(entry->paramType) << " i ";
325​ }
326​ stream() << ")" << Const() << ";" << endl;
327​ }
328​ }
329​ stream() << whitespace() << "" << cfg().className << "Private *d;" << endl;
330​}
331​
332​void KConfigHeaderGenerator::createConstructor()
333​{
334​ if (cfg().singleton) {
335​ stream() << whitespace() << "static " << cfg().className << " *self();" << endl;
336​ if (parseResult.cfgFileNameArg) {
337​ stream() << whitespace() << "static void instance(const QString& cfgfilename);" << endl;
338​ stream() << whitespace() << "static void instance(KSharedConfig::Ptr config);" << endl;
339​ }
340​ return;
341​ }
342​
343​ stream() << whitespace() << "" << cfg().className << "(";
344​ if (parseResult.cfgFileNameArg) {
345​ if (cfg().forceStringFilename)
346​ stream() << " const QString &cfgfilename" << (parseResult.parameters.isEmpty() ? " = QString()" : ", ");
347​ else
348​ stream() << " KSharedConfig::Ptr config" << (parseResult.parameters.isEmpty() ? " = KSharedConfig::openConfig()" : ", ");
349​ }
350​
351​ bool first = true;
352​ for (const auto parameter : parseResult.parameters) {
353​ if (first) {
354​ first = false;
355​ } else {
356​ stream() << ",";
357​ }
358​
359​ stream() << " " << param(parameter.type) << " " << parameter.name;
360​ }
361​
362​ if (cfg().parentInConstructor) {
363​ if (parseResult.cfgFileNameArg || !parseResult.parameters.isEmpty()) {
364​ stream() << ",";
365​ }
366​ stream() << " QObject *parent = nullptr";
367​ }
368​ stream() << " );" << endl;
369​}
370​
371​void KConfigHeaderGenerator::createDestructor()
372​{
373​ stream() << whitespace() << "~" << cfg().className << "();" << endl << endl;
374​}
375​
376​void KConfigHeaderGenerator::createForwardDeclarations()
377​{
378​ // Private class declaration
379​ if (cfg().dpointer) {
380​ stream() << "class " << cfg().className << "Private;" << endl << endl;
381​ }
382​}
383​
ervinUnsubmitted
Done

Ditto

ervin: Ditto
384​void KConfigHeaderGenerator::createProperties(const CfgEntry *entry, const QString& returnType)
385​{
386​ if (!cfg().generateProperties) {
387​ return;
388​ }
389​ stream() << whitespace() << "Q_PROPERTY(" << returnType << ' ' << getFunction(entry->name);
390​ stream() << " READ " << getFunction(entry->name);
391​
392​ if (cfg().allMutators || cfg().mutators.contains(entry->name)) {
393​ const QString signal = changeSignalName(entry->name);
394​ stream() << " WRITE " << setFunction(entry->name);
395​ stream() << " NOTIFY " << signal;
396​
397​ //If we have the modified signal, we'll also need
398​ //the changed signal as well
399​ Signal s;
400​ s.name = signal;
401​ s.modify = true;
402​ parseResult.signalList.append(s);
403​ } else {
404​ stream() << " CONSTANT";
405​ }
406​ stream() << ")" << endl;
407​}
408​
409​void KConfigHeaderGenerator::createSetters(const CfgEntry *entry)
410​{
411​ // Manipulator
412​ if (!cfg().allMutators && !cfg().mutators.contains(entry->name)) {
413​ return;
414​ }
415​
416​ stream() << whitespace() << "/**" << endl;
417​ stream() << whitespace() << " Set " << entry->label << endl;
418​ stream() << whitespace() << "*/" << endl;
419​
420​ if (cfg().staticAccessors) {
421​ stream() << whitespace() << "static" << endl;
422​ }
423​
424​ stream() << whitespace() << "void " << setFunction(entry->name) << "( ";
425​ if (!entry->param.isEmpty()) {
426​ stream() <<cppType(entry->paramType) << " i, ";
427​ }
428​
429​ stream() << (cfg().useEnumTypes && entry->type == QLatin1String("Enum")
430​ ? enumType(entry, cfg().globalEnums)
431​ : param(entry->type));
432​
433​ stream() << " v )";
434​
435​ // function body inline only if not using dpointer
436​ // for BC mode
437​ if (!cfg().dpointer) {
438​ stream() << endl;
439​ startScope();
440​ memberMutatorBody(entry);
441​ endScope();
442​ stream() << endl;
443​ } else {
444​ stream() << ";" << endl << endl;
445​ }
446​}
447​
ervinUnsubmitted
Done

Ditto

ervin: Ditto
448​void KConfigHeaderGenerator::createGetters(const CfgEntry *entry, const QString &returnType)
449​{
450​ // Accessor
451​ stream() << whitespace() << "/**" << endl;
452​ stream() << whitespace() << " Get " << entry->label << endl;
453​ stream() << whitespace() << "*/" << endl;
454​ if (cfg().staticAccessors) {
455​ stream() << whitespace() << "static" << endl;
456​ }
457​ stream() << whitespace() << "";
458​ stream() << returnType;
459​ stream() << " " << getFunction(entry->name) << "(";
460​ if (!entry->param.isEmpty()) {
461​ stream() << " " << cppType(entry->paramType) << " i ";
462​ }
463​ stream() << ")" << Const();
464​
465​ // function body inline only if not using dpointer
466​ // for BC mode
467​ if (!cfg().dpointer) {
468​ stream() << endl;
469​ startScope();
470​ stream() << whitespace() << memberAccessorBody(entry, cfg().globalEnums);
471​ endScope();
472​ stream() << endl;
473​ } else {
474​ stream() << ";" << endl << endl;
475​ }
476​}
477​
ervinUnsubmitted
Done

Ditto

ervin: Ditto
478​void KConfigHeaderGenerator::createItemAcessors(const CfgEntry *entry, const QString &returnType)
479​{
480​ // Item accessor
481​ if (!cfg().itemAccessors) {
482​ return;
483​ }
484​ stream() << whitespace() << "/**" << endl;
485​ stream() << whitespace() << " Get Item object corresponding to " << entry->name << "()"
486​ << endl;
487​ stream() << whitespace() << "*/" << endl;
488​ stream() << whitespace() << "Item" << itemType(entry->type) << " *"
489​ << getFunction(entry->name) << "Item(";
490​ if (!entry->param.isEmpty()) {
491​ stream() << " " << cppType(entry->paramType) << " i ";
492​ }
493​ stream() << ")";
494​ if (!cfg().dpointer) {
495​ stream() << endl;
496​ startScope();
497​ stream() << whitespace() << itemAccessorBody(entry, cfg());
498​ endScope();
499​ } else {
500​ stream() << ";" << endl;
501​ }
502​
503​ stream() <<endl;
504​}
505​
506​void KConfigHeaderGenerator::createDefaultValueMember(const CfgEntry *entry)
507​{
508​ // Default value Accessor
509​ if (! ((cfg().allDefaultGetters || cfg().defaultGetters.contains(entry->name)) && !entry->defaultValue.isEmpty())) {
510​ return;
511​ }
512​ stream() << whitespace() << "/**" << endl;
513​ stream() << whitespace() << " Get " << entry->label << " default value" << endl;
514​ stream() << whitespace() << "*/" << endl;
515​ if (cfg().staticAccessors) {
516​ stream() << whitespace() << "static" << endl;
517​ }
518​ stream() << whitespace() << "";
519​ if (cfg().useEnumTypes && entry->type == QLatin1String("Enum")) {
520​ stream() << enumType(entry, cfg().globalEnums);
521​ } else {
522​ stream() << cppType(entry->type);
523​ }
524​ stream() << " " << getDefaultFunction(entry->name) << "(";
525​ if (!entry->param.isEmpty()) {
526​ stream() << " " << cppType(entry->paramType) << " i ";
527​ }
528​ stream() << ")" << Const() << endl;
529​ stream() << whitespace() << "{" << endl;
530​ stream() << whitespace() << " return ";
531​ if (cfg().useEnumTypes && entry->type == QLatin1String("Enum")) {
532​ stream() << "static_cast<" << enumType(entry, cfg().globalEnums) << ">(";
533​ }
534​ stream() << getDefaultFunction(entry->name) << "_helper(";
535​ if (!entry->param.isEmpty()) {
536​ stream() << " i ";
537​ }
538​ stream() << ")";
539​ if (cfg().useEnumTypes && entry->type == QLatin1String("Enum")) {
540​ stream() << ")";
541​ }
542​ stream() << ";" << endl;
543​ stream() << whitespace() << "}" << endl;
544​ stream() << endl;
545​}
546​
547​void KConfigHeaderGenerator::createSingleton()
548​{
549​ // Private constructor for singleton
550​ if (!cfg().singleton) {
551​ return;
552​ }
553​
554​ stream() << whitespace() << "" << cfg().className << "(";
555​ if (parseResult.cfgFileNameArg) {
556​ stream() << "KSharedConfig::Ptr config";
557​ }
558​ if (cfg().parentInConstructor) {
559​ if (parseResult.cfgFileNameArg) {
560​ stream() << ", ";
561​ }
562​ stream() << "QObject *parent = nullptr";
563​ }
564​ stream() << ");" << endl;
565​ stream() << whitespace() << "friend class " << cfg().className << "Helper;" << endl << endl;
566​}
567​
568​void KConfigHeaderGenerator::createNonDPointerHelpers()
569​{
570​ if (cfg().memberVariables == QLatin1String("dpointer")) {
571​ return;
572​ }
573​
574​ QString group;
575​ for (auto *entry : parseResult.entries) {
576​ if (entry->group != group) {
577​ group = entry->group;
578​ stream() << endl;
579​ stream() << whitespace() << "// " << group << endl;
580​ }
581​ stream() << whitespace() << "" << cppType(entry->type) << " " << varName(entry->name, cfg());
582​ if (!entry->param.isEmpty()) {
583​ stream() << QStringLiteral("[%1]").arg(entry->paramMax + 1);
584​ }
585​ stream() << ";" << endl;
586​
587​ if (cfg().allDefaultGetters || cfg().defaultGetters.contains(entry->name)) {
588​ stream() << whitespace() << "";
589​ if (cfg().staticAccessors) {
590​ stream() << "static ";
591​ }
592​ stream() << cppType(entry->type) << " " << getDefaultFunction(entry->name) << "_helper(";
593​ if (!entry->param.isEmpty()) {
594​ stream() << " " << cppType(entry->paramType) << " i ";
595​ }
596​ stream() << ")" << Const() << ";" << endl;
597​ }
598​ }
599​
600​ stream() << endl << " private:" << endl;
601​ if (cfg().itemAccessors) {
602​ for (auto *entry : parseResult.entries) {
603​ stream() << whitespace() << "Item" << itemType(entry->type) << " *" << itemVar(entry, cfg());
604​ if (!entry->param.isEmpty()) {
605​ stream() << QStringLiteral("[%1]").arg(entry->paramMax + 1);
606​ }
607​ stream() << ";" << endl;
608​ }
609​ }
610​
611​ if (parseResult.hasNonModifySignals) {
612​ stream() << whitespace() << "uint " << varName(QStringLiteral("settingsChanged"), cfg()) << ";" << endl;
613​ }
614​}