JavaScriptCore/qt/api/qscriptengine.cpp - WebKit - Git at Google

 /*
     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)));
 }

 /*!
     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());
 }
	/*
	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)));
	}

	/*!
	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());
	}