Differential D26202 Diff 73345 src/kconfig_compiler/KCFGXmlParser.h

Changeset View

Standalone View

View Options

src/kconfig_compiler/KCFGXmlParser.h

  • This file was added.
1​/* This file is part of the KDE libraries
2​ Copyright (C) 2020 Tomaz Cananbrava (tcanabrava@kde.org)
dfaureUnsubmitted
Done

missing license header

(repeats)

dfaure: missing license header (repeats)
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Library General Public
6​ License as published by the Free Software Foundation; either
7​ version 2 of the License, or (at your option) any later version.
8​
9​ This library is distributed in the hope that it will be useful,
10​ but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12​ Library General Public License for more details.
13​
14​ You should have received a copy of the GNU Library General Public License
15​ along with this library; see the file COPYING.LIB. If not, write to
16​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
dfaureUnsubmitted
Done

... const;

dfaure: ... const;
17​ Boston, MA 02110-1301, USA.
dfaureUnsubmitted
Done

... const;

dfaure: ... const;
18​*/
19​
20​#ifndef KCFGXMLPARSER_H
21​#define KCFGXMLPARSER_H
22​
23​#include <QDomDocument>
24​#include <QString>
25​#include <QRegularExpression>
26​
27​#include "KConfigCommonStructs.h"
28​#include "KConfigXTParameters.h"
29​
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​/* This parses the contents of a Xml file into a ParseResult Structure,
31​ * It also fails hard:
32​ * If start() succeeds, you can use the result,
33​ * if start() fails, the program aborts with an error message so there's
34​ * no possibility of generating incorrect code information.
35​ */
dfaureUnsubmitted
Done

how, why, when?

dfaure: how, why, when?
36​class KCFGXmlParser {
37​public:
38​ KCFGXmlParser(const KConfigXTParameters &cfg, const QString& inputFileName);
39​
40​ // Start the parser and reads the contents of the inputFileName into the ParseResult Structure
41​ void start();
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​ // Get the result of the parse
44​ ParseResult getParseResult() const;
ervinUnsubmitted
Done

Please have the space before & and not after.

ervin: Please have the space before & and not after.
45​
46​private:
47​ // creates a `somethignChanged` signal for every property
dfaureUnsubmitted
Done

typo ("something")

dfaure: typo ("something")
48​ void createChangedSignal(CfgEntry &readEntry);
49​
50​ void validateNameAndKey(CfgEntry &readEntry, const QDomElement &element);
51​
52​ // TODO: Use std::optional and CfgEntry (without heap allocation) for this function
53​ // *or* fail hard if the parse fails.
54​ CfgEntry *parseEntry(const QString &group, const QDomElement &element);
55​
56​ // Steps
57​ void readIncludeTag(const QDomElement &element);
58​ void readGroupTag(const QDomElement &element);
59​ void readKcfgfileTag(const QDomElement &element);
60​ void readSignalTag(const QDomElement &element);
61​
62​ // Those are the Entries in the Xml, that represent a parameter within the <group> </group> tag.
63​ void readParameterFromEntry(CfgEntry &entry, const QDomElement &element);
64​ bool hasDefaultCode(CfgEntry &entry, const QDomElement &element);
65​ void readChoicesFromEntry(CfgEntry &entry, const QDomElement &element);
66​ void readGroupElements(CfgEntry &entry, const QDomElement &element);
67​ void readParamDefaultValues(CfgEntry &entry, const QDomElement &element);
68​
69​private:
70​ ParseResult mParseResult;
71​ KConfigXTParameters cfg;
72​ QString mInputFileName;
73​ QStringList mAllNames;
74​ QRegularExpression mValidNameRegexp;
75​};
76​
77​#endif
dfaureUnsubmitted
Done

should be fixed

dfaure: should be fixed