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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
/*
Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "config.h"
#include "qscriptengine.h"
#include "qscriptengine_p.h"
#include "qscriptprogram_p.h"
#include "qscriptsyntaxcheckresult_p.h"
#include "qscriptvalue_p.h"
/*!
Constructs a QScriptEngine object.
The globalObject() is initialized to have properties as described in ECMA-262, Section 15.1.
*/
QScriptEngine::QScriptEngine()
: d_ptr(new QScriptEnginePrivate(this))
{
}
/*!
Destroys this QScriptEngine.
*/
QScriptEngine::~QScriptEngine()
{
}
/*!
Checks the syntax of the given \a program. Returns a
QScriptSyntaxCheckResult object that contains the result of the check.
*/
QScriptSyntaxCheckResult QScriptEngine::checkSyntax(const QString &program)
{
// FIXME This is not optimal.
// The JSC C API needs a context to perform a syntax check, it means that a QScriptEnginePrivate
// had to be created. This function is static so we have to create QScriptEnginePrivate for each
// call. We can't remove the "static" for compatibility reason, at least up to Qt5.
// QScriptSyntaxCheckResultPrivate takes ownership of newly created engine. The engine will be
// kept as long as it is needed for lazy evaluation of properties of
// the QScriptSyntaxCheckResultPrivate.
QScriptEnginePrivate* engine = new QScriptEnginePrivate(/* q_ptr */ 0);
return QScriptSyntaxCheckResultPrivate::get(engine->checkSyntax(program));
}
/*!
Evaluates \a program, using \a lineNumber as the base line number,
and returns the result of the evaluation.
The script code will be evaluated in the current context.
The evaluation of \a program can cause an exception in the
engine; in this case the return value will be the exception
that was thrown (typically an \c{Error} object). You can call
hasUncaughtException() to determine if an exception occurred in
the last call to evaluate().
\a lineNumber is used to specify a starting line number for \a
program; line number information reported by the engine that pertain
to this evaluation (e.g. uncaughtExceptionLineNumber()) will be
based on this argument. For example, if \a program consists of two
lines of code, and the statement on the second line causes a script
exception, uncaughtExceptionLineNumber() would return the given \a
lineNumber plus one. When no starting line number is specified, line
numbers will be 1-based.
\a fileName is used for error reporting. For example in error objects
the file name is accessible through the "fileName" property if it's
provided with this function.
*/
QScriptValue QScriptEngine::evaluate(const QString& program, const QString& fileName, int lineNumber)
{
return QScriptValuePrivate::get(d_ptr->evaluate(program, fileName, lineNumber));
}
QScriptValue QScriptEngine::evaluate(const QScriptProgram& program)
{
return QScriptValuePrivate::get(d_ptr->evaluate(QScriptProgramPrivate::get(program)));
}
/*!
Returns true if the last script evaluation resulted in an uncaught
exception; otherwise returns false.
The exception state is cleared when evaluate() is called.
\sa uncaughtException(), uncaughtExceptionLineNumber(),
uncaughtExceptionBacktrace()
*/
bool QScriptEngine::hasUncaughtException() const
{
return d_ptr->hasUncaughtException();
}
/*!
Returns the current uncaught exception, or an invalid QScriptValue
if there is no uncaught exception.
The exception value is typically an \c{Error} object; in that case,
you can call toString() on the return value to obtain an error
message.
\sa hasUncaughtException(), uncaughtExceptionLineNumber(),
uncaughtExceptionBacktrace()
*/
QScriptValue QScriptEngine::uncaughtException() const
{
return QScriptValuePrivate::get(d_ptr->uncaughtException());
}
/*!
Clears any uncaught exceptions in this engine.
\sa hasUncaughtException()
*/
void QScriptEngine::clearExceptions()
{
d_ptr->clearExceptions();
}
/*!
Returns the line number where the last uncaught exception occurred.
Line numbers are 1-based, unless a different base was specified as
the second argument to evaluate().
\sa hasUncaughtException(), uncaughtExceptionBacktrace()
*/
int QScriptEngine::uncaughtExceptionLineNumber() const
{
return d_ptr->uncaughtExceptionLineNumber();
}
/*!
Returns a human-readable backtrace of the last uncaught exception.
Each line is of the form \c{<function-name>(<arguments>)@<file-name>:<line-number>}.
\sa uncaughtException()
*/
QStringList QScriptEngine::uncaughtExceptionBacktrace() const
{
return d_ptr->uncaughtExceptionBacktrace();
}
/*!
Runs the garbage collector.
The garbage collector will attempt to reclaim memory by locating and disposing of objects that are
no longer reachable in the script environment.
Normally you don't need to call this function; the garbage collector will automatically be invoked
when the QScriptEngine decides that it's wise to do so (i.e. when a certain number of new objects
have been created). However, you can call this function to explicitly request that garbage
collection should be performed as soon as possible.
\sa reportAdditionalMemoryCost()
*/
void QScriptEngine::collectGarbage()
{
d_ptr->collectGarbage();
}
/*!
Reports an additional memory cost of the given \a size, measured in
bytes, to the garbage collector.
This function can be called to indicate that a JavaScript object has
memory associated with it that isn't managed by Qt Script itself.
Reporting the additional cost makes it more likely that the garbage
collector will be triggered.
Note that if the additional memory is shared with objects outside
the scripting environment, the cost should not be reported, since
collecting the JavaScript object would not cause the memory to be
freed anyway.
Negative \a size values are ignored, i.e. this function can't be
used to report that the additional memory has been deallocated.
\sa collectGarbage()
*/
void QScriptEngine::reportAdditionalMemoryCost(int cost)
{
d_ptr->reportAdditionalMemoryCost(cost);
}
/*!
Returns a handle that represents the given string, \a str.
QScriptString can be used to quickly look up properties, and
compare property names, of script objects.
\sa QScriptValue::property()
*/
QScriptString QScriptEngine::toStringHandle(const QString& str)
{
return QScriptStringPrivate::get(d_ptr->toStringHandle(str));
}
/*!
Converts the given \a value to an object, if such a conversion is
possible; otherwise returns an invalid QScriptValue. The conversion
is performed according to the following table:
\table
\header \o Input Type \o Result
\row \o Undefined \o An invalid QScriptValue.
\row \o Null \o An invalid QScriptValue.
\row \o Boolean \o A new Boolean object whose internal value is set to the value of the boolean.
\row \o Number \o A new Number object whose internal value is set to the value of the number.
\row \o String \o A new String object whose internal value is set to the value of the string.
\row \o Object \o The result is the object itself (no conversion).
\endtable
\sa newObject()
*/
QScriptValue QScriptEngine::toObject(const QScriptValue& value)
{
return QScriptValuePrivate::get(QScriptValuePrivate::get(value)->toObject(d_ptr.data()));
}
/*!
Returns a QScriptValue of the primitive type Null.
\sa undefinedValue()
*/
QScriptValue QScriptEngine::nullValue()
{
return QScriptValue(this, QScriptValue::NullValue);
}
/*!
Returns a QScriptValue of the primitive type Undefined.
\sa nullValue()
*/
QScriptValue QScriptEngine::undefinedValue()
{
return QScriptValue(this, QScriptValue::UndefinedValue);
}
/*!
Creates a QtScript object of class Object.
The prototype of the created object will be the Object
prototype object.
\sa newArray(), QScriptValue::setProperty()
*/
QScriptValue QScriptEngine::newObject()
{
return QScriptValuePrivate::get(d_ptr->newObject());
}
/*!
Creates a QtScript object of class Array with the given \a length.
\sa newObject()
*/
QScriptValue QScriptEngine::newArray(uint length)
{
return QScriptValuePrivate::get(d_ptr->newArray(length));
}
/*!
Returns this engine's Global Object.
By default, the Global Object contains the built-in objects that are
part of \l{ECMA-262}, such as Math, Date and String. Additionally,
you can set properties of the Global Object to make your own
extensions available to all script code. Non-local variables in
script code will be created as properties of the Global Object, as
well as local variables in global code.
*/
QScriptValue QScriptEngine::globalObject() const
{
return QScriptValuePrivate::get(d_ptr->globalObject());
}
|