Differential D26202 Diff 74118 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) 2020 Tomaz Cananbrava (tcanabrava@kde.org)
5		Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>
6		Copyright (c) 2003 Waldo Bastian <bastian@kde.org>
7		Copyright (c) 2003 Zack Rusin <zack@kde.org>
8		Copyright (c) 2006 Michaël Larouche <michael.larouche@kdemail.net>
9		Copyright (c) 2008 Allen Winter <winter@kde.org>
10		Copyright (C) 2020 Tomaz Cananbrava (tcanabrava@kde.org)
11
12		This library is free software; you can redistribute it and/or
13		modify it under the terms of the GNU Library General Public
14		License as published by the Free Software Foundation; either
15		version 2 of the License, or (at your option) any later version.
16
17		This library is distributed in the hope that it will be useful,
18		but WITHOUT ANY WARRANTY; without even the implied warranty of
19		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20		Library General Public License for more details.
21
22		You should have received a copy of the GNU Library General Public License
23		along with this library; see the file COPYING.LIB. If not, write to
24		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25		Boston, MA 02110-1301, USA.
26		*/
27
28		#ifndef KCONFIGCODEGENERATORBASE_H
29		#define KCONFIGCODEGENERATORBASE_H
30
31		#include <QString>
32		#include <QTextStream>
33		#include <QFile>
34		#include <QVector>
35
36		#include "KConfigParameters.h"
37		#include "KConfigCommonStructs.h"
38
39		class CfgEntry;
40		struct ParseResult;
41
42		/* This class manages the base of writing a C - Based code */
43		class KConfigCodeGeneratorBase {
44		public:
45		enum ScopeFinalizer {None, Semicolon};
46
47		KConfigCodeGeneratorBase(
48		const QString &inputFileName, // The kcfg file
	ervinUnsubmitted Done Space before & not after (and following lines as well). ervin: Space before & not after (and following lines as well).
49		const QString &baseDir, // where we should store the generated file
50		const QString &fileName, // the name of the generated file
51		const KConfigParameters &parameters, // parameters passed to the generator
52		ParseResult &parseResult // The pre processed configuration entries
53		);
54		virtual ~KConfigCodeGeneratorBase();
55
56		// iterates over the header list adding an #include directive.
57		void addHeaders(const QStringList &header);
	ervinUnsubmitted Done Ditto ervin: Ditto
58
59		// Create all the namespace indentation levels based on the parsed result and parameters */
60		void beginNamespaces();
61
62		// Closes all the namespaces adding lines with single '}'
63		void endNamespaces();
64
65		// Add the correct amount of whitespace in the code.
66		QString whitespace() const;
	ervinUnsubmitted Done This screams to be const ervin: This screams to be const
67
68		// start a block scope `{` and increase indentation level.
69		void endScope(ScopeFinalizer finalizer = None);
70
71		// end a block scope `}` and decrease indentation level.
72		void startScope();
73
74		// start writing to the output file
75		virtual void start();
76
77		// save the result on the disk
78		void save();
79
80		// Code Implementations
81		// Implements the `Get` methods for the CfgEntry
82		// TODO: write to the stream directly without returning a QString.
83		QString memberAccessorBody(const CfgEntry *e, bool globalEnums) const;
84
85		// Implements the `Set` methods for the CfgEntry
86		void memberMutatorBody(const CfgEntry *e);
87
88		// This is the code that creates the logic for the Setter / Mutator.
89		// It just creates the if test, no body. The reason is that just
90		// the if test was more than 20 lines of code and hard to understand
91		// what was happening in a bigger function.
92		void createIfSetLogic(const CfgEntry *e, const QString &varExpression);
93
94		protected:
95		/* advance the number of spaces for the indentation level */
96		void indent();
97
98		/* reduce the number of spaces for the indentation level */
99		void unindent();
100
101		QString inputFile() const { return m_inputFile; }
	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		QString fileName() const { return m_fileName; }
103		QString baseDir() const { return m_baseDir; }
104		QString This() const { return m_this; }
105		QString Const() const { return m_const; }
106		KConfigParameters cfg() const { return m_cfg; }
107
108		// Can't be const.
109		QTextStream& stream() { return m_stream; }
110
111		// HACK: This needs to be accesible because the HeaderGenerator actually modifies
112		// it while running. Considering that this is a the result of the xml Parse, and not
113		// the result of generating code, I consider this to be quite wrong - but moving the
114		// changes away from the header generator only created more problems and I have to
115		// investigate more.
116		ParseResult &parseResult; // the result of the parsed kcfg file
117
118		private:
119		QString m_inputFile; // the base file name, input file is based on this.
120
121		QString m_baseDir; // Where we are going to save the file
122		QString m_fileName; // The file name
123
124		KConfigParameters m_cfg; // The parameters passed via the kcfgc file
125		QTextStream m_stream; // the stream that operates in the file to write data.
126		QFile m_file; // The file handler.
127
128		// Special access to `this->` and `const` thru the code.
129		QString m_this;
130		QString m_const;
131		int m_indentLevel = 0;
132		};
133
134		#endif