Differential D26202 Diff 72338 src/kconfig_compiler/KCFGXmlParser.h

Changeset View

Standalone View

src/kconfig_compiler/KCFGXmlParser.h

This file was added.

1		#ifndef KCFGXMLPARSER_H
2		#define KCFGXMLPARSER_H
	dfaureUnsubmitted Done missing license header (repeats) dfaure: missing license header (repeats)
3
4		#include <QDomDocument>
5		#include <QString>
6
7		#include "KConfigCommonStructs.h"
8		#include "KConfigXTParameters.h"
9
10		class KCFGXmlParser {
11		public:
12		KCFGXmlParser();
13
14		void setInputFileName(const QString inputFileName);
15		void setConfigurationParameters(KConfigXTParameters cfg);
16		void start();
	dfaureUnsubmitted Done ... const; dfaure: ... const;
17		QString errorString();
	dfaureUnsubmitted Done ... const; dfaure: ... const;
18		ParseResult getParseResult();
19
20		//
21		void createChangedSignal();
22		void validateNameAndKey(CfgEntry &entry);
23		// Steps
24		void readIncludeTag();
25		void readGroupTag();
26		void readKcfgfileTag();
27		void readSignalTag();
28
29		// Those are the Entries in the Xml, that represent a parameter within the <group> </group> tag.
	dfaureUnsubmitted Done (to pick on one random method as an example) : this is only used internally by the class, it should be made private. Please do this for all methods that are not used from outside the class. It will make it much clearer what's the actual API of the class. dfaure: (to pick on one random method as an example) : this is only used internally by the class, it…
30		void readParameterFromEntry(CfgEntry &entry, QDomElement &element);
31		bool hasDefaultCode(CfgEntry &entry, QDomElement &element);
32		void readChoicesFromEntry(CfgEntry &entry, QDomElement &element);
33		void readGroupElements(CfgEntry &entry, QDomElement &element);
34		void readParamDefaultValues(CfgEntry &entry, QDomElement &element);
35
	dfaureUnsubmitted Done how, why, when? dfaure: how, why, when?
36		// TODO: Fix this function later.
37		CfgEntry *parseEntry(const QString &group, const QDomElement &element, const KConfigXTParameters &cfg);
38
39		private:
40		ParseResult mParseResult;
41		QString mErrorString;
42		};
	ervinUnsubmitted Done Please put the opening curly brace on its own line. As far as the class name goes I'd propose KCfgXmlParser or KConfigXmlParser to make sure we have a consistent capitalization. ervin: Please put the opening curly brace on its own line. As far as the class name goes I'd propose…
43
44		#endif
	ervinUnsubmitted Done Please have the space before & and not after. ervin: Please have the space before & and not after.
45		No newline at end of file
	dfaureUnsubmitted Done should be fixed dfaure: should be fixed
	dfaureUnsubmitted Done typo ("something") dfaure: typo ("something")