aboutsummaryrefslogtreecommitdiff
path: root/src/kconfig_compiler/KConfigSourceGenerator.h
blob: 1e1ffc97940e0a9873453d68f348bb6bcd2736d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
    This file is part of KDE.

    Copyright (C) 2020 Tomaz Cananbrava (tcanabrava@kde.org)
    Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>
    Copyright (c) 2003 Waldo Bastian <bastian@kde.org>
    Copyright (c) 2003 Zack Rusin <zack@kde.org>
    Copyright (c) 2006 Michaƫl Larouche <michael.larouche@kdemail.net>
    Copyright (c) 2008 Allen Winter <winter@kde.org>
    Copyright (C) 2020 Tomaz Cananbrava (tcanabrava@kde.org)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KCONFIGSOURCEGENERATOR_H
#define KCONFIGSOURCEGENERATOR_H

#include "KConfigCodeGeneratorBase.h"
#include "KConfigCommonStructs.h"

#include <QString>
#include <QList>

class KConfigParameters;
class CfgEntry;
class QTextStream;
struct ParseResult;

class KConfigSourceGenerator : public KConfigCodeGeneratorBase {
public:
    KConfigSourceGenerator(
        const QString &inputFile,
        const QString &baseDir,
        const KConfigParameters &parameters,
        ParseResult &parseResult);

    void start() override;

private:
    // Those are fairly self contained functions.
    void createHeaders();
    void createPrivateDPointerImplementation();
    void createSingletonImplementation();
    void createPreamble();
    void createDestructor();
    void createConstructorParameterList();
    void createParentConstructorCall();
    void createInitializerList();
    void createDefaultValueGetterSetter();
    void createNonModifyingSignalsHelper();
    void createSignalFlagsHandler();
    void includeMoc();

    // Constructor related methods
    // the `do` methods have related helper functions that are only related
    // to it. So we can break the function into many smaller ones and create
    // logic inside of the `do` function.
    void doConstructor();
    void createEnums(const CfgEntry *entry);
    void createNormalEntry(const CfgEntry *entry, const QString &key);
    void createIndexedEntry(const CfgEntry *entry, const QString &key);
    void handleCurrentGroupChange(const CfgEntry *entry);

    void doGetterSetterDPointerMode();
    void createGetterDPointerMode(const CfgEntry *entry);
    void createImmutableGetterDPointerMode(const CfgEntry *entry);
    void createSetterDPointerMode(const CfgEntry *entry);
    void createItemGetterDPointerMode(const CfgEntry *entry);

private:
    QString mCurrentGroup;
};

#endif