Differential D26202 Diff 72338 src/kconfig_compiler/KConfigCodeGenerator.h

Changeset View

Standalone View

src/kconfig_compiler/KConfigCodeGenerator.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		#ifndef KCONFIGCODEGENERATOR_H
22		#define KCONFIGCODEGENERATOR_H
23
24		#include <QString>
25		#include <QTextStream>
26		#include <QFile>
27		#include <QVector>
28
29		#include "KConfigXTParameters.h"
30
31		class CfgEntry;
32		struct ParseResult;
33
34		/* This class manages the base of writting a C - Based code */
35		class KConfigCodeGenerator {
	dfaureUnsubmitted Done writing takes a single 't' dfaure: writing takes a single 't'
36		public:
	dfaureUnsubmitted Done Maybe call it KConfigCodeGeneratorBase ? It wasn't obvious to me initially that it was "just" a base class. dfaure: Maybe call it KConfigCodeGeneratorBase ? It wasn't obvious to me initially that it was "just"…
37		KConfigCodeGenerator(
38		const QString& inputFileName, // The kcfg file
	dfaureUnsubmitted Done Semicolon takes a single 'l' dfaure: Semicolon takes a single 'l'
39		const QString& baseDir, // where we should store the generated file
40		const QString& fileName, // the name of the generated file
41		const KConfigXTParameters &parameters, // parameters passed to the generator
42		ParseResult &parseResult // The pre processed configuration entries
43		);
44		virtual ~KConfigCodeGenerator();
45
46		void addHeaders(const QStringList& header);
47
48		void beginNamespaces();
49		void endNamespaces();
50
51		void indent();
52		void unindent();
53
54		// Add the correct amount of whitespace in the code.
55		QString whitespace();
56
57		// start a block scope `{` and increase indentation level.
58		void endScope();
59
60		// end a block scope `}` and decrease indentation level.
61		void startScope();
62
63		virtual void start();
64
65		protected:
66		QString inputFile;
67		QString baseDir;
68		QString fileName;
69		const KConfigXTParameters &cfg;
70		ParseResult &parseResult;
71		QTextStream stream;
72		QFile file;
73
74		// Special access to `this->` and `const` thru the code.
75		QString This;
76		QString Const;
77
78		public:
79		int indentLevel = 0;
80		};
81
82		#endif
83		No newline at end of file
	dfaureUnsubmitted Done urgh, a public variable dfaure: urgh, a public variable
	tcanabravaAuthorUnsubmitted Not Done that was a honest mistake :) tcanabrava: that was a honest mistake :)