Differential D26202 Diff 73608 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 KConfigXTParameters &cfg,
42​ ParseResult &parseResult)
43​ : KConfigCodeGeneratorBase(inputFile, baseDir, baseDir + cfg.baseName + QLatin1Char('.') + cfg.headerExtension, cfg, parseResult)
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 : qAsConst(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() && cfg.memberVariables != QLatin1String("private") && cfg.memberVariables != QLatin1String("dpointer")) {
103​ stream << " " << cfg.memberVariables << ":" << endl;
104​ }
105​
106​ // Class Parameters
107​ for (const auto &parameter : qAsConst(parseResult.parameters)) {
108​ stream << whitespace() << "" << cppType(parameter.type) << " mParam" << parameter.name << ";" << endl;
109​ }
110​
111​ createNonDPointerHelpers();
112​ createDPointer();
113​
114​ if (cfg.customAddons) {
115​ stream << whitespace() << "// Include custom additions" << endl;
116​ stream << whitespace() << "#include \"" << cfg.baseName << "_addons." << cfg.headerExtension << '"' << endl;
117​ }
118​
119​ endScope(ScopeFinalizer::Semicolon);
120​}
121​
122​void KConfigHeaderGenerator::createHeaders()
123​{
124​ addHeaders(cfg.headerIncludes);
125​ if (cfg.headerIncludes.size()) {
126​ stream << endl;
127​ }
128​
129​ if (!cfg.singleton && parseResult.parameters.isEmpty()) {
130​ addHeaders({QStringLiteral("qglobal.h")});
131​ }
132​
133​ if (cfg.inherits == QLatin1String("KCoreConfigSkeleton")) {
134​ addHeaders({QStringLiteral("kcoreconfigskeleton.h")});
135​ } else {
136​ addHeaders({QStringLiteral("kconfigskeleton.h")});
137​ }
138​
139​ addHeaders({QStringLiteral("QCoreApplication"), QStringLiteral("QDebug")});
140​ stream << endl;
141​
dfaureUnsubmitted
Done

s/spaces/newlines/

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

nothing here?

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

Ditto

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

Ditto

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

Ditto

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