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
|
/****************************************************************************
**
** 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 "jsonwizard.h"
#include <coreplugin/iwizardfactory.h>
#include <utils/fileutils.h>
#include <QMap>
#include <QVariant>
QT_BEGIN_NAMESPACE
class QDir;
QT_END_NAMESPACE
namespace ProjectExplorer {
class JsonWizardFactory;
class JsonWizardPageFactory;
class JsonWizardGeneratorFactory;
class ProjectExplorerPlugin;
class ProjectExplorerPluginPrivate;
// Documentation inside.
class PROJECTEXPLORER_EXPORT JsonWizardFactory : public Core::IWizardFactory
{
Q_OBJECT
public:
// Add search paths for wizard.json files. All subdirs are going to be checked.
static void addWizardPath(const Utils::FilePath &path);
// actual interface of the wizard factory:
class Generator {
public:
bool isValid() const { return typeId.isValid(); }
Core::Id typeId;
QVariant data;
};
class Page {
public:
bool isValid() const { return typeId.isValid(); }
QString title;
QString subTitle;
QString shortTitle;
int index = -1; // page index in the wizard
Core::Id typeId;
QVariant enabled;
QVariant data;
};
static void registerPageFactory(JsonWizardPageFactory *factory);
static void registerGeneratorFactory(JsonWizardGeneratorFactory *factory);
static QList<QVariant> objectOrList(const QVariant &data, QString *errorMessage);
static QString localizedString(const QVariant &value);
bool isAvailable(Core::Id platformId) const override;
private:
Utils::Wizard *runWizardImpl(const QString &path, QWidget *parent, Core::Id platform,
const QVariantMap &variables) override;
// Create all wizards. As other plugins might register factories for derived
// classes. Called when the new file dialog is shown for the first time.
static QList<IWizardFactory *> createWizardFactories();
static JsonWizardFactory *createWizardFactory(const QVariantMap &data, const QDir &baseDir,
QString *errorMessage);
static Utils::FilePaths &searchPaths();
static void setVerbose(int level);
static int verbose();
static void destroyAllFactories();
bool initialize(const QVariantMap &data, const QDir &baseDir, QString *errorMessage);
QVariant m_enabledExpression;
QString m_wizardDir;
QList<Generator> m_generators;
QList<Page> m_pages;
QList<JsonWizard::OptionDefinition> m_options;
QSet<Core::Id> m_preferredFeatures;
static int m_verbose;
friend class ProjectExplorerPlugin;
friend class ProjectExplorerPluginPrivate;
};
namespace Internal {
class JsonWizardFactoryJsExtension : public QObject
{
Q_OBJECT
public:
JsonWizardFactoryJsExtension(Core::Id platformId,
const QSet<Core::Id> &availableFeatures,
const QSet<Core::Id> &pluginFeatures);
Q_INVOKABLE QVariant value(const QString &name) const;
private:
Core::Id m_platformId;
QSet<Core::Id> m_availableFeatures;
QSet<Core::Id> m_pluginFeatures;
};
} // namespace Internal
} // namespace ProjectExplorer
|
