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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QBS_SCRIPTENGINE_H
#define QBS_SCRIPTENGINE_H
#include "forward_decls.h"
#include "property.h"
#include <logging/logger.h>
#include <tools/filetime.h>
#include <QDir>
#include <QHash>
#include <QList>
#include <QProcessEnvironment>
#include <QScriptEngine>
#include <QStack>
#include <QString>
#include <vector>
namespace qbs {
namespace Internal {
class Artifact;
class JsImport;
class ScriptImporter;
class ScriptPropertyObserver;
enum class EvalContext { PropertyEvaluation, ProbeExecution, RuleExecution, JsCommand };
class DubiousContext
{
public:
enum Suggestion { NoSuggestion, SuggestMoving };
DubiousContext(EvalContext c, Suggestion s = NoSuggestion) : context(c), suggestion(s) { }
EvalContext context;
Suggestion suggestion;
};
using DubiousContextList = std::vector<DubiousContext>;
class ScriptEngine : public QScriptEngine
{
Q_OBJECT
public:
ScriptEngine(Logger &logger, EvalContext evalContext, QObject *parent = 0);
~ScriptEngine();
Logger &logger() const { return m_logger; }
void import(const FileContextBaseConstPtr &fileCtx, QScriptValue &targetObject);
void import(const JsImport &jsImport, QScriptValue &targetObject);
void clearImportsCache();
void setEvalContext(EvalContext c) { m_evalContext = c; }
EvalContext evalContext() const { return m_evalContext; }
void checkContext(const QString &operation, const DubiousContextList &dubiousContexts);
void addPropertyRequestedInScript(const Property &property) {
m_propertiesRequestedInScript += property;
}
void addPropertyRequestedFromArtifact(const Artifact *artifact, const Property &property);
void clearRequestedProperties() {
m_propertiesRequestedInScript.clear();
m_propertiesRequestedFromArtifact.clear();
}
PropertySet propertiesRequestedInScript() const { return m_propertiesRequestedInScript; }
QHash<QString, PropertySet> propertiesRequestedFromArtifact() const {
return m_propertiesRequestedFromArtifact;
}
void enableProfiling(bool enable);
void setPropertyCacheEnabled(bool enable) { m_propertyCacheEnabled = enable; }
bool isPropertyCacheEnabled() const { return m_propertyCacheEnabled; }
void addToPropertyCache(const QString &moduleName, const QString &propertyName,
const PropertyMapConstPtr &propertyMap, const QVariant &value);
QVariant retrieveFromPropertyCache(const QString &moduleName, const QString &propertyName,
const PropertyMapConstPtr &propertyMap);
void defineProperty(QScriptValue &object, const QString &name, const QScriptValue &descriptor);
void setObservedProperty(QScriptValue &object, const QString &name, const QScriptValue &value,
ScriptPropertyObserver *observer);
void setDeprecatedProperty(QScriptValue &object, const QString &name, const QString &newName,
const QScriptValue &value);
QProcessEnvironment environment() const;
void setEnvironment(const QProcessEnvironment &env);
void addEnvironmentVariable(const QString &name, const QString &value);
QHash<QString, QString> usedEnvironment() const { return m_usedEnvironment; }
void addCanonicalFilePathResult(const QString &filePath, const QString &resultFilePath);
void addFileExistsResult(const QString &filePath, bool exists);
void addDirectoryEntriesResult(const QString &path, QDir::Filters filters,
const QStringList &entries);
void addFileLastModifiedResult(const QString &filePath, const FileTime &fileTime);
QHash<QString, QString> canonicalFilePathResults() const { return m_canonicalFilePathResult; }
QHash<QString, bool> fileExistsResults() const { return m_fileExistsResult; }
QHash<QPair<QString, quint32>, QStringList> directoryEntriesResults() const
{
return m_directoryEntriesResult;
}
QHash<QString, FileTime> fileLastModifiedResults() const { return m_fileLastModifiedResult; }
QSet<QString> imports() const;
static QScriptValueList argumentList(const QStringList &argumentNames,
const QScriptValue &context);
void registerOwnedVariantMap(QVariantMap *vm) { m_ownedVariantMaps.append(vm); }
QStringList uncaughtExceptionBacktraceOrEmpty() const {
return hasUncaughtException() ? uncaughtExceptionBacktrace() : QStringList();
}
bool hasErrorOrException(const QScriptValue &v) const {
return v.isError() || hasUncaughtException();
}
QScriptValue lastErrorValue(const QScriptValue &v) const {
return v.isError() ? v : uncaughtException();
}
QString lastErrorString(const QScriptValue &v) const { return lastErrorValue(v).toString(); }
void cancel();
private:
void abort();
void installQbsBuiltins();
void extendJavaScriptBuiltins();
void installFunction(const QString &name, int length, QScriptValue *functionValue,
FunctionSignature f, QScriptValue *targetObject);
void installQbsFunction(const QString &name, int length, FunctionSignature f);
void installConsoleFunction(const QString &name, FunctionWithArgSignature f);
void installImportFunctions();
void uninstallImportFunctions();
void importFile(const QString &filePath, QScriptValue &targetObject);
static QScriptValue js_loadExtension(QScriptContext *context, QScriptEngine *qtengine);
static QScriptValue js_loadFile(QScriptContext *context, QScriptEngine *qtengine);
class PropertyCacheKey
{
public:
PropertyCacheKey(const QString &moduleName, const QString &propertyName,
const PropertyMapConstPtr &propertyMap);
private:
const QString m_moduleName;
const QString m_propertyName;
const PropertyMapConstPtr m_propertyMap;
friend bool operator==(const PropertyCacheKey &lhs, const PropertyCacheKey &rhs);
friend uint qHash(const ScriptEngine::PropertyCacheKey &k, uint seed);
};
friend bool operator==(const PropertyCacheKey &lhs, const PropertyCacheKey &rhs);
friend uint qHash(const ScriptEngine::PropertyCacheKey &k, uint seed);
ScriptImporter *m_scriptImporter;
QHash<JsImport, QScriptValue> m_jsImportCache;
bool m_propertyCacheEnabled;
QHash<PropertyCacheKey, QVariant> m_propertyCache;
PropertySet m_propertiesRequestedInScript;
QHash<QString, PropertySet> m_propertiesRequestedFromArtifact;
Logger &m_logger;
QScriptValue m_definePropertyFunction;
QScriptValue m_emptyFunction;
QProcessEnvironment m_environment;
QHash<QString, QString> m_usedEnvironment;
QHash<QString, QString> m_canonicalFilePathResult;
QHash<QString, bool> m_fileExistsResult;
QHash<QPair<QString, quint32>, QStringList> m_directoryEntriesResult;
QHash<QString, FileTime> m_fileLastModifiedResult;
QStack<QString> m_currentDirPathStack;
QStack<QStringList> m_extensionSearchPathsStack;
QScriptValue m_loadFileFunction;
QScriptValue m_loadExtensionFunction;
QScriptValue m_qbsObject;
QScriptValue m_consoleObject;
QScriptValue m_cancelationError;
QList<QVariantMap *> m_ownedVariantMaps;
qint64 m_elapsedTimeImporting = -1;
EvalContext m_evalContext;
};
class EvalContextSwitcher
{
public:
EvalContextSwitcher(ScriptEngine *engine, EvalContext newContext)
: m_engine(engine), m_oldContext(engine->evalContext())
{
engine->setEvalContext(newContext);
}
~EvalContextSwitcher() { m_engine->setEvalContext(m_oldContext); }
private:
ScriptEngine * const m_engine;
const EvalContext m_oldContext;
};
} // namespace Internal
} // namespace qbs
#endif // QBS_SCRIPTENGINE_H
|
