Differential D26202 Diff 72338 src/kconfig_compiler/KConfigHeaderGenerator.cpp

Changeset View

Standalone View

View Options

src/kconfig_compiler/KConfigHeaderGenerator.cpp

  • This file was added.
1​#include "KConfigHeaderGenerator.h"
2​#include "KConfigCommonStructs.h"
3​
4​#include <QTextStream>
5​
6​namespace
7​{
8​QTextStream cout(stdout);
9​QTextStream cerr(stderr);
10​}
11​
12​KConfigHeaderGenerator::KConfigHeaderGenerator(
13​ const QString& inputFile,
14​ const QString& baseDir,
15​ const KConfigXTParameters &cfg,
16​ ParseResult &parseResult)
17​ : KConfigCodeGenerator(inputFile, baseDir, cfg.baseName + QLatin1Char('.') + cfg.headerExtension, cfg, parseResult)
18​{
19​}
20​
21​void KConfigHeaderGenerator::start()
22​{
23​ KConfigCodeGenerator::start();
24​ startHeaderGuards();
25​ createHeaders();
26​ beginNamespaces();
27​
28​ createForwardDeclarations();
29​
30​ doClassDefinition();
31​
32​ endNamespaces();
33​ endHeaderGuards();
34​}
35​
36​void KConfigHeaderGenerator::doClassDefinition()
37​{
38​ stream << "class " << cfg.visibility << cfg.className << " : public " << cfg.inherits << endl;
39​ startScope();
40​
ervinUnsubmitted
Done

Ditto

ervin: Ditto
41​ // Add Q_OBJECT macro if the config need signals.
42​ if (!parseResult.signalList.isEmpty() || cfg.generateProperties) {
43​ stream << " Q_OBJECT" << endl;
44​ }
45​ stream << " public:" << endl;
46​
47​ createConstructor();
48​ createDestructor();
49​
50​ for (auto *entry : parseResult.entries) {
51​ const QString n = entry->name;
52​ const QString t = entry->type;
53​
dfaureUnsubmitted
Done

qAsConst()

dfaure: qAsConst()
54​ const QString returnType = (cfg.useEnumTypes && t == QLatin1String("Enum"))
55​ ? enumType(entry, cfg.globalEnums)
56​ : cppType(t);
57​
58​ createSetters(entry);
59​ createProperties(entry, returnType);
60​ createGetters(entry, returnType);
61​ createItemAcessors(entry, returnType);
62​ createSignals(entry);
63​ }
64​
65​ stream << " protected:" << endl;
66​ createSingleton();
67​
68​ // TODO: Move those to functions too.
69​ if (mHasNonModifySignals) {
70​ stream << " bool usrSave() override;" << endl;
71​ }
72​
73​ // Member variables
74​ if (!cfg.memberVariables.isEmpty() && cfg.memberVariables != QLatin1String("private") && cfg.memberVariables != QLatin1String("dpointer")) {
75​ stream << " " << cfg.memberVariables << ":" << endl;
76​ }
77​
78​ // Class Parameters
79​ for (const auto &parameter : qAsConst(parseResult.parameters)) {
80​ stream << " " << cppType(parameter.type) << " mParam" << parameter.name << ";" << endl;
81​ }
82​
83​ createNonDPointerHelpers();
84​ createDPointer();
85​
86​ if (cfg.customAddons) {
87​ stream << " // Include custom additions" << endl;
88​ stream << " #include \"" << filenameOnly(cfg.baseName) << "_addons." << cfg.headerExtension << '"' << endl;
89​ }
90​
91​ endScope();
92​}
93​
94​void KConfigHeaderGenerator::createHeaders()
95​{
96​ addHeaders(cfg.headerIncludes);
97​
98​ if (!cfg.singleton && parseResult.parameters.isEmpty()) {
99​ addHeaders({QStringLiteral("qglobal.h")});
100​ }
101​
102​ if (cfg.inherits == QLatin1String("KCoreConfigSkeleton")) {
103​ addHeaders({QStringLiteral("kcoreconfigskeleton.h")});
104​ } else {
105​ addHeaders({QStringLiteral("kconfigskeleton.h")});
106​ }
107​
108​ addHeaders({QStringLiteral("QCoreApplication"), QStringLiteral("QDebug")});
109​ addHeaders(parseResult.includes);
110​}
111​
112​void KConfigHeaderGenerator::startHeaderGuards()
113​{
114​ const bool hasNamespace = cfg.nameSpace.isEmpty();
115​ const QString namespaceName = QString(QString(cfg.nameSpace).replace(QLatin1String("::"), QLatin1String("_"))).toUpper();
116​ const QString namespaceStr = hasNamespace ? namespaceName + QLatin1Char('_') : QStringLiteral("");
117​ const QString defineName = namespaceStr + cfg.className.toUpper() + QStringLiteral("_H");
118​
119​ stream << "#ifndef " << defineName << endl;
120​ stream << "#define " << defineName << endl;
121​ stream << endl;
122​}
123​
124​void KConfigHeaderGenerator::endHeaderGuards()
125​{
126​ stream << "#ifndef ";
127​ stream << endl;
128​}
129​
130​void KConfigHeaderGenerator::implementChoiceEnums(CfgEntry *entry, const CfgEntry::Choices &choices)
131​{
132​ const QList<CfgEntry::Choice> chlist = choices.choices;
133​
134​ if (chlist.isEmpty()) {
135​ return;
136​ }
137​
138​ QStringList values;
139​ for (const auto choice : chlist) {
140​ values.append(choices.prefix + choice.name);
141​ }
dfaureUnsubmitted
Done

s/spaces/newlines/

dfaure: s/spaces/newlines/
142​
143​ if (choices.name().isEmpty()) {
144​ if (cfg.globalEnums) {
145​ stream << " enum " << enumName(entry->name, entry->choices) << " { " << values.join(QStringLiteral(", ")) << " };" << endl;
146​ } else {
147​ // Create an automatically named enum
148​ stream << " class " << enumName(entry->name, entry->choices) << endl;
149​ stream << " {" << endl;
150​ stream << " public:" << endl;
151​ stream << " enum type { " << values.join(QStringLiteral(", ")) << ", COUNT };" << endl;
152​ stream << " };" << endl;
153​ }
154​ } else if (!choices.external()) {
155​ // Create a named enum
156​ stream << " enum " << enumName(entry->name, entry->choices) << " { " << values.join(QStringLiteral(", ")) << " };" << endl;
157​ }
158​}
159​
160​void KConfigHeaderGenerator::implementValueEnums(CfgEntry *entry, const QStringList &values)
161​{
162​ if (values.isEmpty()) {
163​ return;
164​ }
165​
166​ if (cfg.globalEnums) {
167​ // ### FIXME!!
168​ // make the following string table an index-based string search!
169​ // ###
170​ stream << " enum " << enumName(entry->param) << " { " << values.join(QStringLiteral(", ")) << " };" << endl;
171​ stream << " static const char* const " << enumName(entry->param) << "ToString[];" << endl;
172​ } else {
173​ stream << " class " << enumName(entry->param) << endl;
174​ stream << " {" << endl;
175​ stream << " public:" << endl;
176​ stream << " enum type { " << values.join(QStringLiteral(", ")) << ", COUNT };" << endl;
177​ stream << " static const char* const enumToString[];" << endl;
178​ stream << " };" << endl;
179​ }
180​}
181​
182​void KConfigHeaderGenerator::implementEnums()
183​{
184​ for (const auto entry : qAsConst(parseResult.entries)) {
185​ const CfgEntry::Choices &choices = entry->choices;
186​ const QStringList values = entry->paramValues;
187​
188​ implementChoiceEnums(entry, choices);
189​ implementValueEnums(entry, values);
190​ }
191​ stream << endl;
192​}
193​
194​void KConfigHeaderGenerator::createSlots()
195​{
196​
197​}
198​
199​void KConfigHeaderGenerator::createSignals(CfgEntry *entry)
200​{
201​ // Signal definition.
202​ const bool hasSignals = !parseResult.signalList.isEmpty();
203​
204​ unsigned val = 1 << parseResult.signalList.size();
205​ if (!val) {
206​ cerr << "Too many signals to create unique bit masks" << endl;
207​ exit(1);
208​ }
209​
210​ if (!hasSignals) {
211​ return;
212​ }
213​
214​ stream << "\n enum {" << endl;
215​ val = 1;
dfaureUnsubmitted
Done

nothing here?

dfaure: nothing here?
216​ for (const auto &signal : qAsConst(parseResult.signalList)) {
217​ parseResult.hasNonModifySignals |= !signal.modify;
218​ stream << " " << signalEnumName(signal.name) << " = 0x" << hex << val << "," << endl;
219​ val <<= 1;
220​ }
221​ stream << " };" << dec << endl << endl;
222​
223​ stream << " Q_SIGNALS:";
224​ for (const Signal &signal : qAsConst(parseResult.signalList)) {
225​ stream << endl;
226​ if (!signal.label.isEmpty()) {
227​ stream << " /**" << endl;
228​ stream << " " << signal.label << endl;
229​ stream << " */" << endl;
230​ }
231​ stream << " void " << signal.name << "(";
232​ QList<SignalArguments>::ConstIterator it, itEnd = signal.arguments.constEnd();
233​ for (it = signal.arguments.constBegin(); it != itEnd;) {
234​ SignalArguments argument = *it;
235​ QString type = param(argument.type);
236​ if (cfg.useEnumTypes && argument.type == QLatin1String("Enum")) {
237​ for (auto *entry : parseResult.entries) {
238​ if (entry->name == argument.variableName) {
239​ type = enumType(entry, cfg.globalEnums);
240​ break;
241​ }
242​ }
243​ }
244​ stream << type << " " << argument.variableName;
245​ if (++it != itEnd) {
246​ stream << ", ";
247​ }
248​ }
249​ stream << ");" << endl;
250​ }
251​ stream << endl;
252​
253​ stream << " private:" << endl;
254​ stream << " void itemChanged(quint64 flags);" << endl;
255​ stream << endl;
256​}
257​
258​void KConfigHeaderGenerator::createDPointer()
259​{
260​ // use a private class for both member variables and items
261​ stream << " private:" << endl;
262​ for (const auto &entry : qAsConst(parseResult.entries)) {
263​ if (cfg.allDefaultGetters || cfg.defaultGetters.contains(entry->name)) {
264​ stream << " ";
265​ if (cfg.staticAccessors) {
266​ stream << "static ";
267​ }
268​ stream << cppType(entry->type) << " " << getDefaultFunction(entry->name) << "_helper(";
269​ if (!entry->param.isEmpty()) {
270​ stream << " " << cppType(entry->paramType) << " i ";
271​ }
272​ stream << ")" << Const << ";" << endl;
273​ }
274​ }
275​ stream << " " << cfg.className << "Private *d;" << endl;
276​}
277​
278​void KConfigHeaderGenerator::createConstructor()
279​{
280​ if (cfg.singleton) {
281​ stream << " static " << cfg.className << " *self();" << endl;
282​ if (parseResult.cfgFileNameArg) {
283​ stream << " static void instance(const QString& cfgfilename);" << endl;
284​ stream << " static void instance(KSharedConfig::Ptr config);" << endl;
285​ }
286​ return;
287​ }
288​
289​ stream << " " << cfg.className << "(";
290​ if (parseResult.cfgFileNameArg) {
291​ if (cfg.forceStringFilename)
292​ stream << " const QString &cfgfilename" << (parseResult.parameters.isEmpty() ? " = QString()" : ", ");
293​ else
294​ stream << " KSharedConfig::Ptr config" << (parseResult.parameters.isEmpty() ? " = KSharedConfig::openConfig()" : ", ");
295​ }
296​
297​ bool first = true;
298​ for (const auto parameter : parseResult.parameters) {
299​ if (first) {
300​ first = false;
301​ } else {
302​ stream << ",";
303​ }
304​
305​ stream << " " << param(parameter.type) << " " << parameter.name;
306​ }
307​
308​ if (cfg.parentInConstructor) {
309​ if (parseResult.cfgFileNameArg || !parseResult.parameters.isEmpty()) {
310​ stream << ",";
311​ }
312​ stream << " QObject *parent = nullptr";
313​ }
314​ stream << " );" << endl;
315​}
316​
317​void KConfigHeaderGenerator::createDestructor()
318​{
319​ stream << " ~" << cfg.className << "();" << endl << endl;
320​}
321​
322​void KConfigHeaderGenerator::createForwardDeclarations()
323​{
324​ // Private class declaration
325​ if (cfg.dpointer) {
326​ stream << "class " << cfg.className << "Private;" << endl << endl;
327​ }
328​}
329​
330​void KConfigHeaderGenerator::createProperties(CfgEntry *entry, const QString& returnType)
331​{
332​ if (!cfg.generateProperties) {
333​ return;
334​ }
335​ stream << " Q_PROPERTY(" << returnType << ' ' << getFunction(entry->name);
336​ stream << " READ " << getFunction(entry->name);
337​
338​ if (cfg.allMutators || cfg.mutators.contains(entry->name)) {
339​ const QString signal = changeSignalName(entry->name);
340​ stream << " WRITE " << setFunction(entry->name);
341​ stream << " NOTIFY " << signal;
342​
343​ //If we have the modified signal, we'll also need
344​ //the changed signal as well
345​ Signal s;
346​ s.name = signal;
347​ s.modify = true;
348​ parseResult.signalList.append(s);
349​ } else {
350​ stream << " CONSTANT";
351​ }
352​ stream << ")" << endl;
353​}
354​
355​void KConfigHeaderGenerator::createSetters(CfgEntry *entry)
356​{
357​ // Manipulator
358​ if (!cfg.allMutators && !cfg.mutators.contains(entry->name)) {
359​ return;
360​ }
361​
362​ stream << " /**" << endl;
363​ stream << " Set " << entry->label << endl;
364​ stream << " */" << endl;
365​
366​ if (cfg.staticAccessors) {
367​ stream <<" static" << endl;
368​ }
369​
370​ stream <<" void " << setFunction(entry->name) << "( ";
371​ if (!entry->param.isEmpty()) {
372​ stream <<cppType(entry->paramType) << " i, ";
373​ }
374​
375​ stream << (cfg.useEnumTypes && entry->type == QLatin1String("Enum")
376​ ? enumType(entry, cfg.globalEnums)
377​ : param(entry->type));
378​
379​ stream <<" v )";
380​
381​ // function body inline only if not using dpointer
382​ // for BC mode
383​ if (!cfg.dpointer) {
ervinUnsubmitted
Done

Ditto

ervin: Ditto
384​ stream <<endl;
385​ startScope();
386​ stream << whitespace() << memberMutatorBody(entry, cfg);
387​ endScope();
388​ } else {
389​ stream <<";" << endl;
390​ }
391​
392​ stream <<endl;
393​}
394​
395​void KConfigHeaderGenerator::createGetters(CfgEntry *entry, const QString& returnType)
396​{
397​ // Accessor
398​ stream << " /**" << endl;
399​ stream << " Get " << entry->label << endl;
400​ stream << " */" << endl;
401​ if (cfg.staticAccessors) {
402​ stream << " static" << endl;
403​ }
404​ stream << " ";
405​ stream << returnType;
406​ stream << " " << getFunction(entry->name) << "(";
407​ if (!entry->param.isEmpty()) {
408​ stream << " " << cppType(entry->paramType) << " i ";
409​ }
410​ stream << ")" << Const;
411​
412​ // function body inline only if not using dpointer
413​ // for BC mode
414​ if (!cfg.dpointer) {
415​ startScope();
416​ stream << whitespace() << memberAccessorBody(entry, cfg.globalEnums, cfg);
417​ endScope();
418​ } else {
419​ stream <<";" << endl;
420​ }
421​}
422​
423​void KConfigHeaderGenerator::createItemAcessors(CfgEntry *entry, const QString& returnType)
424​{
425​ // Item accessor
426​ if (!cfg.itemAccessors) {
427​ return;
428​ }
429​ stream << endl;
430​ stream << " /**" << endl;
431​ stream << " Get Item object corresponding to " << entry->name << "()"
432​ << endl;
433​ stream <<" */" << endl;
434​ stream <<" Item" << itemType(entry->type) << " *"
435​ << getFunction(entry->name) << "Item(";
436​ if (!entry->param.isEmpty()) {
437​ stream <<" " << cppType(entry->paramType) << " i ";
438​ }
439​ stream <<")";
440​ if (!cfg.dpointer) {
441​ startScope();
442​ stream << whitespace() << itemAccessorBody(entry, cfg);
443​ endScope();
444​ } else {
445​ stream <<";" << endl;
446​ }
447​
ervinUnsubmitted
Done

Ditto

ervin: Ditto
448​ stream <<endl;
449​}
450​
451​void KConfigHeaderGenerator::createDefaultValueMember(CfgEntry *entry)
452​{
453​ // Default value Accessor
454​ if (! ((cfg.allDefaultGetters || cfg.defaultGetters.contains(entry->name)) && !entry->defaultValue.isEmpty())) {
455​ return;
456​ }
457​ stream << endl;
458​ stream <<" /**" << endl;
459​ stream <<" Get " << entry->label << " default value" << endl;
460​ stream <<" */" << endl;
461​ if (cfg.staticAccessors) {
462​ stream <<" static" << endl;
463​ }
464​ stream <<" ";
465​ if (cfg.useEnumTypes && entry->type == QLatin1String("Enum")) {
466​ stream <<enumType(entry, cfg.globalEnums);
467​ } else {
468​ stream <<cppType(entry->type);
469​ }
470​ stream <<" " << getDefaultFunction(entry->name) << "(";
471​ if (!entry->param.isEmpty()) {
472​ stream <<" " << cppType(entry->paramType) << " i ";
473​ }
474​ stream <<")" << Const << endl;
475​ stream <<" {" << endl;
476​ stream <<" return ";
477​ if (cfg.useEnumTypes && entry->type == QLatin1String("Enum")) {
ervinUnsubmitted
Done

Ditto

ervin: Ditto
478​ stream <<"static_cast<" << enumType(entry, cfg.globalEnums) << ">(";
479​ }
480​ stream << getDefaultFunction(entry->name) << "_helper(";
481​ if (!entry->param.isEmpty()) {
482​ stream <<" i ";
483​ }
484​ stream <<")";
485​ if (cfg.useEnumTypes && entry->type == QLatin1String("Enum")) {
486​ stream <<")";
487​ }
488​ stream << ";" << endl;
489​ stream << " }" << endl;
490​}
491​
492​void KConfigHeaderGenerator::createSingleton()
493​{
494​ // Private constructor for singleton
495​ if (!cfg.singleton) {
496​ return;
497​ }
498​
499​ stream << " " << cfg.className << "(";
500​ if (parseResult.cfgFileNameArg) {
501​ stream << "KSharedConfig::Ptr config";
502​ }
503​ if (cfg.parentInConstructor) {
504​ if (parseResult.cfgFileNameArg) {
505​ stream << ", ";
506​ }
507​ stream << "QObject *parent = nullptr";
508​ }
509​ stream << ");" << endl;
510​ stream << " friend class " << cfg.className << "Helper;" << endl << endl;
511​}
512​
513​void KConfigHeaderGenerator::createNonDPointerHelpers()
514​{
515​ if (cfg.memberVariables == QLatin1String("dpointer")) {
516​ return;
517​ }
518​
519​ QString group;
520​ for (auto *entry : qAsConst(parseResult.entries)) {
521​ if (entry->group != group) {
522​ group = entry->group;
523​ stream << endl;
524​ stream << " // " << group << endl;
525​ }
526​ stream << " " << cppType(entry->type) << " " << varName(entry->name, cfg);
527​ if (!entry->param.isEmpty()) {
528​ stream << QStringLiteral("[%1]").arg(entry->paramMax + 1);
529​ }
530​ stream << ";" << endl;
531​
532​ if (cfg.allDefaultGetters || cfg.defaultGetters.contains(entry->name)) {
533​ stream << " ";
534​ if (cfg.staticAccessors) {
535​ stream << "static ";
536​ }
537​ stream << cppType(entry->type) << " " << getDefaultFunction(entry->name) << "_helper(";
538​ if (!entry->param.isEmpty()) {
539​ stream << " " << cppType(entry->paramType) << " i ";
540​ }
541​ stream << ")" << Const << ";" << endl;
542​ }
543​ }
544​
545​ stream << endl << " private:" << endl;
546​ if (cfg.itemAccessors) {
547​ for (auto *entry : qAsConst(parseResult.entries)) {
548​ stream << " Item" << itemType(entry->type) << " *" << itemVar(entry, cfg);
549​ if (!entry->param.isEmpty()) {
550​ stream << QStringLiteral("[%1]").arg(entry->paramMax + 1);
551​ }
552​ stream << ";" << endl;
553​ }
554​ }
555​
556​ if (parseResult.hasNonModifySignals) {
557​ stream << " uint " << varName(QStringLiteral("settingsChanged"), cfg) << ";" << endl;
558​ }
559​}