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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "../projectexplorer_export.h"
#include <projectexplorer/projectnodes.h>
#include <coreplugin/generatedfile.h>
#include <coreplugin/jsexpander.h>
#include <utils/wizard.h>
#include <utils/macroexpander.h>
#include <QDebug>
#include <QVariant>
namespace ProjectExplorer {
class JsonWizard;
class JsonWizardGenerator;
namespace Internal {
class JsonWizardJsExtension : public QObject
{
Q_OBJECT
public:
JsonWizardJsExtension(JsonWizard *wizard);
Q_INVOKABLE QVariant value(const QString &name) const;
private:
JsonWizard *m_wizard;
};
} // namespace Internal
// Documentation inside.
class PROJECTEXPLORER_EXPORT JsonWizard : public Utils::Wizard
{
Q_OBJECT
public:
class GeneratorFile {
public:
GeneratorFile() = default;
GeneratorFile(const Core::GeneratedFile &f, JsonWizardGenerator *g) :
file(f), generator(g)
{ }
bool isValid() const { return generator; }
Core::GeneratedFile file;
JsonWizardGenerator *generator = nullptr;
};
using GeneratorFiles = QList<GeneratorFile>;
Q_PROPERTY(GeneratorFiles generateFileList READ generateFileList)
explicit JsonWizard(QWidget *parent = nullptr);
~JsonWizard() override;
void addGenerator(JsonWizardGenerator *gen);
Utils::MacroExpander *expander();
GeneratorFiles generateFileList();
void commitToFileList(const GeneratorFiles &list);
QString stringValue(const QString &n) const;
QVariant value(const QString &n) const;
void setValue(const QString &key, const QVariant &value);
class OptionDefinition {
public:
QString key() const { return m_key; }
QString value(Utils::MacroExpander &expander) const;
bool condition(Utils::MacroExpander &expander) const;
private:
QString m_key;
QString m_value;
QVariant m_condition;
QVariant m_evaluate;
friend QDebug &operator<<(QDebug &debug, const OptionDefinition &option);
friend class JsonWizard;
};
static QList<OptionDefinition> parseOptions(const QVariant &v, QString *errorMessage);
static bool boolFromVariant(const QVariant &v, Utils::MacroExpander *expander);
static QString stringListToArrayString(const QStringList &list,
const Utils::MacroExpander *expander);
void removeAttributeFromAllFiles(Core::GeneratedFile::Attribute a);
QHash<QString, QVariant> variables() const override;
signals:
void preGenerateFiles(); // emitted before files are generated (can happen several times!)
void postGenerateFiles(const JsonWizard::GeneratorFiles &files); // emitted after commitToFileList was called.
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.
void filesPolished(const JsonWizard::GeneratorFiles &files); // emitted just after additional files (e.g. settings) not directly related to the project were created.
void allDone(const JsonWizard::GeneratorFiles &files); // emitted just after the wizard is done with the files. They are ready to be opened.
public slots:
void accept() override;
void reject() override;
private:
void handleNewPages(int pageId);
void handleError(const QString &message);
QString stringify(const QVariant &v) const override;
QString evaluate(const QVariant &v) const override ;
void openFiles(const GeneratorFiles &files);
void openProjectForNode(ProjectExplorer::Node *node);
QList<JsonWizardGenerator *> m_generators;
GeneratorFiles m_files;
Utils::MacroExpander m_expander;
Core::JsExpander m_jsExpander;
};
inline QDebug &operator<<(QDebug &debug, const JsonWizard::GeneratorFile &file)
{
debug << "GeneratorFile{file: " << file.file << "}";
return debug;
}
inline QDebug &operator<<(QDebug &debug, const JsonWizard::OptionDefinition &option)
{
debug << "Option{"
<< "key:" << option.m_key
<< "; value:" << option.m_value
<< "; evaluate:" << option.m_evaluate
<< "; condition:" << option.m_condition
<< "}";
return debug;
}
} // namespace ProjectExplorer
|
