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
|
/****************************************************************************
**
** 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 CUSTOMWIZARDPARAMETERS_H
#define CUSTOMWIZARDPARAMETERS_H
#include <coreplugin/basefilewizardfactory.h>
#include <QStringList>
#include <QMap>
#include <QSharedPointer>
QT_BEGIN_NAMESPACE
class QIODevice;
class QDebug;
class QTemporaryFile;
class QScriptEngine;
QT_END_NAMESPACE
namespace ProjectExplorer {
namespace Internal {
class CustomWizardField {
public:
// Parameters of the widget control are stored as map
typedef QMap<QString, QString> ControlAttributeMap;
CustomWizardField();
void clear();
// Attribute map keys for combo entries
static QString comboEntryValueKey(int i);
static QString comboEntryTextKey(int i);
QString description;
QString name;
ControlAttributeMap controlAttributes;
bool mandatory;
};
class CustomWizardFile {
public:
CustomWizardFile();
QString source;
QString target;
bool openEditor;
bool openProject;
bool binary;
};
// Documentation inside.
class CustomWizardValidationRule {
public:
// Validate a set of rules and return false + message on the first failing one.
static bool validateRules(const QList<CustomWizardValidationRule> &rules,
const QMap<QString, QString> &replacementMap,
QString *errorMessage);
bool validate(QScriptEngine &, const QMap<QString, QString> &replacementMap) const;
QString condition;
QString message;
};
// Documentation inside.
class GeneratorScriptArgument {
public:
enum Flags {
// Omit this arguments if all field placeholders expanded to empty strings.
OmitEmpty = 0x1,
// Do use the actual field value, but write it to a temporary
// text file and inserts its file name (suitable for multiline texts).
WriteFile = 0x2 };
explicit GeneratorScriptArgument(const QString &value = QString());
QString value;
unsigned flags;
};
class CustomWizardParameters
{
public:
enum ParseResult { ParseOk, ParseDisabled, ParseFailed };
CustomWizardParameters();
void clear();
ParseResult parse(QIODevice &device, const QString &configFileFullPath,
QString *errorMessage);
ParseResult parse(const QString &configFileFullPath, QString *errorMessage);
QString id;
QString directory;
QString klass;
QList<CustomWizardFile> files;
QStringList filesGeneratorScript; // Complete binary, such as 'cmd /c myscript.pl'.
QString filesGeneratorScriptWorkingDirectory;
QList<GeneratorScriptArgument> filesGeneratorScriptArguments;
QString fieldPageTitle;
QList<CustomWizardField> fields;
QList<CustomWizardValidationRule> rules;
int firstPageId;
// Wizard Factory data:
Core::IWizardFactory::WizardKind kind;
QIcon icon;
QString description;
QString displayName;
QString category;
QString displayCategory;
Core::FeatureSet requiredFeatures;
Core::IWizardFactory::WizardFlags flags;
};
// Documentation inside.
class CustomWizardContext {
public:
typedef QMap<QString, QString> FieldReplacementMap;
typedef QSharedPointer<QTemporaryFile> TemporaryFilePtr;
typedef QList<TemporaryFilePtr> TemporaryFilePtrList;
void reset();
static bool replaceFields(const FieldReplacementMap &fm, QString *s);
static bool replaceFields(const FieldReplacementMap &fm, QString *s,
TemporaryFilePtrList *files);
static QString processFile(const FieldReplacementMap &fm, QString in);
FieldReplacementMap baseReplacements;
FieldReplacementMap replacements;
QString path;
// Where files should be created, that is, 'path' for simple wizards
// or "path + project" for project wizards.
QString targetPath;
};
extern const char customWizardFileOpenEditorAttributeC[];
extern const char customWizardFileOpenProjectAttributeC[];
} // namespace Internal
} // namespace ProjectExplorer
#endif // CUSTOMWIZARDPARAMETERS_H
|
