summaryrefslogtreecommitdiff
path: root/src/plugins/projectexplorer/jsonwizard/jsonwizard.h
blob: f2baef3070e279c85b33805f792b6c406fea9b76 (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef JSONWIZARD_H
#define JSONWIZARD_H

#include "../projectexplorer_export.h"

#include <coreplugin/generatedfile.h>

#include <utils/wizard.h>

namespace Utils { class AbstractMacroExpander; }

namespace ProjectExplorer {

namespace Internal { class JsonWizardExpander; }

class JsonWizardGenerator;

// Documentation inside.
class PROJECTEXPLORER_EXPORT JsonWizard : public Utils::Wizard
{
    Q_OBJECT

public:
    class GeneratorFile {
    public:
        GeneratorFile() : generator(0) { }
        GeneratorFile(const Core::GeneratedFile &f, JsonWizardGenerator *g) :
            file(f), generator(g)
        { }

        bool isValid() const { return generator; }

        Core::GeneratedFile file;
        JsonWizardGenerator *generator;
    };
    typedef QList<GeneratorFile> GeneratorFiles;
    Q_PROPERTY(GeneratorFiles fileList READ fileList)

    explicit JsonWizard(QWidget *parent = 0);
    ~JsonWizard();

    void addGenerator(JsonWizardGenerator *gen);

    Utils::AbstractMacroExpander *expander() const;

    void resetFileList();
    GeneratorFiles fileList();

    QVariant value(const QString &n) const;
    void setValue(const QString &key, const QVariant &value);

    static bool boolFromVariant(const QVariant &v, Utils::AbstractMacroExpander *expander);

    void removeAttributeFromAllFiles(Core::GeneratedFile::Attribute a);

signals:
    void preGenerateFiles(); // emitted before files are generated.
    void postGenerateFiles(const JsonWizard::GeneratorFiles &files); // emitted after files are generated.
    void prePromptForOverwrite(const JsonWizard::GeneratorFiles &files); // emitted before overwriting checks are done.
    void preFormatFiles(const JsonWizard::GeneratorFiles &files); // emitted before files are formatted.
    void preWriteFiles(const JsonWizard::GeneratorFiles &files); // emitted before files are written to disk.
    void postProcessFiles(const JsonWizard::GeneratorFiles &files); // emitted before files are post-processed.
    void filesReady(const JsonWizard::GeneratorFiles &files); // emitted just after files are in final state on disk.

public slots:
    void accept();

private:
    QList<JsonWizardGenerator *> m_generators;

    GeneratorFiles m_files;
    Internal::JsonWizardExpander *m_expander;
};

} // namespace ProjectExplorer

#endif // JSONWIZARD_H