Differential D26202 Diff 73510 src/kconfig_compiler/KConfigCodeGeneratorBase.h

Changeset View

Standalone View

src/kconfig_compiler/KConfigCodeGeneratorBase.h

This file was added.

1		/*
2		This file is part of KDE.
3
4		Copyright (c) 2019 Tomaz Canabrava <tcanabrava@kde.org>
5
6		This library is free software; you can redistribute it and/or
7		modify it under the terms of the GNU Library General Public
8		License as published by the Free Software Foundation; either
9		version 2 of the License, or (at your option) any later version.
10
11		This library is distributed in the hope that it will be useful,
12		but WITHOUT ANY WARRANTY; without even the implied warranty of
13		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14		Library General Public License for more details.
15
16		You should have received a copy of the GNU Library General Public License
17		along with this library; see the file COPYING.LIB. If not, write to
18		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19		Boston, MA 02110-1301, USA.
20		*/
21
22		#ifndef KCONFIGCODEGENERATORBASE_H
23		#define KCONFIGCODEGENERATORBASE_H
24
25		#include <QString>
26		#include <QTextStream>
27		#include <QFile>
28		#include <QVector>
29
30		#include "KConfigXTParameters.h"
31
32		class CfgEntry;
33		struct ParseResult;
34
35		/* This class manages the base of writing a C - Based code */
36		class KConfigCodeGeneratorBase {
37		public:
38		enum ScopeFinalizer {None, Semicolon};
39
40		KConfigCodeGeneratorBase(
41		const QString& inputFileName, // The kcfg file
42		const QString& baseDir, // where we should store the generated file
43		const QString& fileName, // the name of the generated file
44		const KConfigXTParameters &parameters, // parameters passed to the generator
45		ParseResult &parseResult // The pre processed configuration entries
46		);
47		virtual ~KConfigCodeGeneratorBase();
48
	ervinUnsubmitted Done Space before & not after (and following lines as well). ervin: Space before & not after (and following lines as well).
49		// iterates over the header list adding an #include directive.
50		void addHeaders(const QStringList& header);
51
52		// Create all the namespace indentation levels based on the parsed result and parameters */
53		void beginNamespaces();
54
55		// Closes all the namespaces adding lines with single '}'
56		void endNamespaces();
57
	ervinUnsubmitted Done Ditto ervin: Ditto
58		// Add the correct amount of whitespace in the code.
59		QString whitespace();
60
61		// start a block scope `{` and increase indentation level.
62		void endScope(ScopeFinalizer finalizer = None);
63
64		// end a block scope `}` and decrease indentation level.
65		void startScope();
66
	ervinUnsubmitted Done This screams to be const ervin: This screams to be const
67		// start writing to the output file
68		virtual void start();
69
70		// save the result on the disk
71		void save();
72
73		// Code Implementations
74		// Implements the `Get` methods for the CfgEntry
75		// TODO: write to the stream directly without returning a QString.
76		QString memberAccessorBody(const CfgEntry *e, bool globalEnums) const;
77
78		// Implements the `Set` methods for the CfgEntry
79		void memberMutatorBody(const CfgEntry *e);
80
81		// This is the code that creates the logic for the Setter / Mutator.
82		// It just creates the if test, no body. The reason is that just
83		// the if test was more than 20 lines of code and hard to understand
84		// what was happening in a bigger function.
85		void createIfSetLogic(const CfgEntry *e, const QString &varExpression);
86
87		protected:
88		/* advance the number of spaces for the indentation level */
89		void indent();
90
91		/* reduce the number of spaces for the indentation level */
92		void unindent();
93
94		QString inputFile; // the base file name, input file is based on this.
95
96		QString baseDir; // Where we are going to save the file
97		QString fileName; // The file name
98
99		const KConfigXTParameters &cfg; // The parameters passed via the kcfgc file
100		ParseResult &parseResult; // the result of the parsed kcfg file
101		QTextStream stream; // the stream that operates in the file to write data.
	ervinUnsubmitted Done I'd tend to put those private and provide only protected const getters. Just to make sure we don't temper with them by mistake, those instances are in control of the base class after all. Also I wonder if it wouldn't be the right opportunity to give those members a "m_" prefix? It's the more common style in KF I think. ervin: I'd tend to put those private and provide only protected const getters. Just to make sure we…
102		QFile file; // The file handler.
103
104		// Special access to `this->` and `const` thru the code.
105		QString This;
106		QString Const;
107
108		private:
109		int indentLevel = 0;
110		};
111
112		#endif