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
|
/****************************************************************************
**
** 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/id.h>
#include <QList>
#include <QObject>
namespace Utils { class MacroExpander; }
namespace ProjectExplorer {
class JsonWizardGenerator
{
public:
virtual ~JsonWizardGenerator() = default;
virtual Core::GeneratedFiles fileList(Utils::MacroExpander *expander,
const QString &baseDir, const QString &projectDir,
QString *errorMessage) = 0;
virtual bool formatFile(const JsonWizard *wizard, Core::GeneratedFile *file, QString *errorMessage);
virtual bool writeFile(const JsonWizard *wizard, Core::GeneratedFile *file, QString *errorMessage);
virtual bool postWrite(const JsonWizard *wizard, Core::GeneratedFile *file, QString *errorMessage);
virtual bool polish(const JsonWizard *wizard, Core::GeneratedFile *file, QString *errorMessage);
virtual bool allDone(const JsonWizard *wizard, Core::GeneratedFile *file, QString *errorMessage);
virtual bool canKeepExistingFiles() const { return true; }
enum OverwriteResult { OverwriteOk, OverwriteError, OverwriteCanceled };
static OverwriteResult promptForOverwrite(JsonWizard::GeneratorFiles *files, QString *errorMessage);
static bool formatFiles(const JsonWizard *wizard, QList<JsonWizard::GeneratorFile> *files, QString *errorMessage);
static bool writeFiles(const JsonWizard *wizard, JsonWizard::GeneratorFiles *files, QString *errorMessage);
static bool postWrite(const JsonWizard *wizard, JsonWizard::GeneratorFiles *files, QString *errorMessage);
static bool polish(const JsonWizard *wizard, JsonWizard::GeneratorFiles *files, QString *errorMessage);
static bool allDone(const JsonWizard *wizard, JsonWizard::GeneratorFiles *files, QString *errorMessage);
};
class JsonWizardGeneratorFactory : public QObject
{
Q_OBJECT
public:
bool canCreate(Core::Id typeId) const { return m_typeIds.contains(typeId); }
QList<Core::Id> supportedIds() const { return m_typeIds; }
virtual JsonWizardGenerator *create(Core::Id typeId, const QVariant &data,
const QString &path, Core::Id platform,
const QVariantMap &variables) = 0;
// Basic syntax check for the data taken from the wizard.json file:
virtual bool validateData(Core::Id typeId, const QVariant &data, QString *errorMessage) = 0;
protected:
// This will add "PE.Wizard.Generator." in front of the suffixes and set those as supported typeIds
void setTypeIdsSuffixes(const QStringList &suffixes);
void setTypeIdsSuffix(const QString &suffix);
private:
QList<Core::Id> m_typeIds;
};
namespace Internal {
class FileGeneratorFactory : public JsonWizardGeneratorFactory
{
Q_OBJECT
public:
FileGeneratorFactory();
JsonWizardGenerator *create(Core::Id typeId, const QVariant &data,
const QString &path, Core::Id platform,
const QVariantMap &variables) override;
bool validateData(Core::Id typeId, const QVariant &data, QString *errorMessage) override;
};
class ScannerGeneratorFactory : public JsonWizardGeneratorFactory
{
Q_OBJECT
public:
ScannerGeneratorFactory();
JsonWizardGenerator *create(Core::Id typeId, const QVariant &data,
const QString &path, Core::Id platform,
const QVariantMap &variables) override;
bool validateData(Core::Id typeId, const QVariant &data, QString *errorMessage) override;
};
} // namespace Internal
} // namespace ProjectExplorer
|
