2001-09-25 22:43:09 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
2012-05-21 11:12:37 +00:00
|
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
1998-04-13 20:24:54 +00:00
|
|
|
|
|
|
|
#ifndef nsIScriptContext_h__
|
|
|
|
#define nsIScriptContext_h__
|
|
|
|
|
|
|
|
#include "nscore.h"
|
2013-09-25 07:27:54 +00:00
|
|
|
#include "nsStringGlue.h"
|
1998-04-13 20:24:54 +00:00
|
|
|
#include "nsISupports.h"
|
2003-06-24 21:43:01 +00:00
|
|
|
#include "nsCOMPtr.h"
|
2006-06-13 03:07:47 +00:00
|
|
|
#include "nsIProgrammingLanguage.h"
|
2011-09-18 09:22:17 +00:00
|
|
|
#include "jspubtd.h"
|
2013-01-27 20:35:12 +00:00
|
|
|
#include "js/GCAPI.h"
|
1998-04-13 20:24:54 +00:00
|
|
|
|
1998-06-23 18:43:06 +00:00
|
|
|
class nsIScriptGlobalObject;
|
1998-11-21 00:12:33 +00:00
|
|
|
class nsIScriptSecurityManager;
|
1999-09-15 20:58:41 +00:00
|
|
|
class nsIPrincipal;
|
2001-07-16 02:40:48 +00:00
|
|
|
class nsIAtom;
|
2006-06-13 03:07:47 +00:00
|
|
|
class nsIArray;
|
|
|
|
class nsIVariant;
|
|
|
|
class nsIObjectInputStream;
|
|
|
|
class nsIObjectOutputStream;
|
2010-05-18 12:28:37 +00:00
|
|
|
class nsIScriptObjectPrincipal;
|
2012-03-11 08:49:15 +00:00
|
|
|
class nsIDOMWindow;
|
2012-05-16 17:42:10 +00:00
|
|
|
class nsIURI;
|
1998-04-13 20:24:54 +00:00
|
|
|
|
|
|
|
#define NS_ISCRIPTCONTEXT_IID \
|
2013-09-04 21:06:57 +00:00
|
|
|
{ 0xf3859ce7, 0x7551, 0x4760, \
|
|
|
|
{ 0x84, 0x29, 0x64, 0x4f, 0x26, 0x1e, 0xdb, 0x91 } }
|
2008-02-16 05:13:16 +00:00
|
|
|
|
|
|
|
/* This MUST match JSVERSION_DEFAULT. This version stuff if we don't
|
|
|
|
know what language we have is a little silly... */
|
|
|
|
#define SCRIPTVERSION_DEFAULT JSVERSION_DEFAULT
|
1998-04-13 20:24:54 +00:00
|
|
|
|
2013-08-15 21:14:43 +00:00
|
|
|
class nsIOffThreadScriptReceiver;
|
|
|
|
|
1998-04-15 18:55:21 +00:00
|
|
|
/**
|
|
|
|
* It is used by the application to initialize a runtime and run scripts.
|
|
|
|
* A script runtime would implement this interface.
|
|
|
|
*/
|
2013-05-06 23:53:10 +00:00
|
|
|
class nsIScriptContext : public nsISupports
|
2004-02-09 22:48:53 +00:00
|
|
|
{
|
1998-04-13 20:24:54 +00:00
|
|
|
public:
|
2005-11-11 14:36:26 +00:00
|
|
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCRIPTCONTEXT_IID)
|
1999-02-04 18:29:36 +00:00
|
|
|
|
2013-01-17 02:50:26 +00:00
|
|
|
/**
|
|
|
|
* Compile and execute a script.
|
|
|
|
*
|
|
|
|
* @param aScript a string representing the script to be executed
|
|
|
|
* @param aScopeObject a script object for the scope to execute in.
|
|
|
|
* @param aOptions an options object. You probably want to at least set
|
|
|
|
* filename and line number. The principal is computed
|
|
|
|
* internally, though 'originPrincipals' may be passed.
|
|
|
|
* @param aCoerceToString if the return value is not JSVAL_VOID, convert it
|
|
|
|
* to a string before returning.
|
2013-01-29 13:44:00 +00:00
|
|
|
* @param aRetValue the result of executing the script. Pass null if you
|
|
|
|
* don't care about the result. Note that asking for a
|
|
|
|
* result will deoptimize your script somewhat in many cases.
|
2013-09-11 23:42:09 +00:00
|
|
|
* @param aOffThreadToken if specified, the result of compiling the script
|
|
|
|
* on another thread.
|
2013-01-29 13:44:00 +00:00
|
|
|
*/
|
2013-01-17 02:50:26 +00:00
|
|
|
virtual nsresult EvaluateString(const nsAString& aScript,
|
2013-05-10 18:22:21 +00:00
|
|
|
JS::Handle<JSObject*> aScopeObject,
|
2013-01-17 02:50:26 +00:00
|
|
|
JS::CompileOptions& aOptions,
|
|
|
|
bool aCoerceToString,
|
2013-09-11 23:42:09 +00:00
|
|
|
JS::Value* aRetValue,
|
|
|
|
void **aOffThreadToken = nullptr) = 0;
|
2000-03-29 01:18:21 +00:00
|
|
|
|
1999-12-03 03:40:30 +00:00
|
|
|
/**
|
2011-08-24 19:49:25 +00:00
|
|
|
* Bind an already-compiled event handler function to the given
|
|
|
|
* target. Scripting languages with static scoping must re-bind the
|
|
|
|
* scope chain for aHandler to begin (after the activation scope for
|
|
|
|
* aHandler itself, typically) with aTarget's scope.
|
1999-12-03 03:40:30 +00:00
|
|
|
*
|
2011-08-24 19:49:25 +00:00
|
|
|
* The result of the bind operation is a new handler object, with
|
|
|
|
* principals now set and scope set as above. This is returned in
|
|
|
|
* aBoundHandler. When this function is called, aBoundHandler is
|
|
|
|
* expected to not be holding an object.
|
2006-06-13 03:07:47 +00:00
|
|
|
*
|
1999-12-07 22:14:17 +00:00
|
|
|
* @param aTarget an object telling the scope in which to bind the compiled
|
2006-06-13 03:07:47 +00:00
|
|
|
* event handler function. The context will presumably associate
|
|
|
|
* this nsISupports with a native script object.
|
2011-08-24 19:49:25 +00:00
|
|
|
* @param aScope the scope in which the script object for aTarget should be
|
|
|
|
* looked for.
|
|
|
|
* @param aHandler the function object to bind, created by an earlier call to
|
1999-12-03 03:40:30 +00:00
|
|
|
* CompileEventHandler
|
2011-08-24 19:49:25 +00:00
|
|
|
* @param aBoundHandler [out] the result of the bind operation.
|
|
|
|
* @return NS_OK if the function was successfully bound
|
2006-06-13 03:07:47 +00:00
|
|
|
*/
|
2011-08-24 19:49:25 +00:00
|
|
|
virtual nsresult BindCompiledEventHandler(nsISupports* aTarget,
|
2013-05-12 05:17:42 +00:00
|
|
|
JS::Handle<JSObject*> aScope,
|
|
|
|
JS::Handle<JSObject*> aHandler,
|
2013-03-20 20:09:09 +00:00
|
|
|
JS::MutableHandle<JSObject*> aBoundHandler) = 0;
|
2006-06-13 03:07:47 +00:00
|
|
|
|
1998-04-15 18:55:21 +00:00
|
|
|
/**
|
|
|
|
* Return the global object.
|
|
|
|
*
|
|
|
|
**/
|
2004-02-09 22:48:53 +00:00
|
|
|
virtual nsIScriptGlobalObject *GetGlobalObject() = 0;
|
1998-04-15 18:55:21 +00:00
|
|
|
|
|
|
|
/**
|
1998-06-23 18:43:06 +00:00
|
|
|
* Return the native script context
|
1998-04-15 18:55:21 +00:00
|
|
|
*
|
|
|
|
**/
|
2011-09-18 09:22:17 +00:00
|
|
|
virtual JSContext* GetNativeContext() = 0;
|
1998-04-15 18:55:21 +00:00
|
|
|
|
2006-06-13 03:07:47 +00:00
|
|
|
/**
|
2010-07-15 22:16:29 +00:00
|
|
|
* Initialize the context generally. Does not create a global object.
|
1998-04-15 18:55:21 +00:00
|
|
|
**/
|
2010-07-15 22:16:29 +00:00
|
|
|
virtual nsresult InitContext() = 0;
|
|
|
|
|
1998-12-30 02:46:36 +00:00
|
|
|
/**
|
|
|
|
* Check to see if context is as yet intialized. Used to prevent
|
|
|
|
* reentrancy issues during the initialization process.
|
|
|
|
*
|
2011-10-17 14:59:28 +00:00
|
|
|
* @return true if initialized, false if not
|
1998-12-30 02:46:36 +00:00
|
|
|
*
|
|
|
|
*/
|
2011-09-29 06:19:26 +00:00
|
|
|
virtual bool IsContextInitialized() = 0;
|
1998-12-30 02:46:36 +00:00
|
|
|
|
1998-10-26 23:22:21 +00:00
|
|
|
/**
|
|
|
|
* For garbage collected systems, do a synchronous collection pass.
|
|
|
|
* May be a no-op on other systems
|
|
|
|
*
|
|
|
|
* @return NS_OK if the method is successful
|
|
|
|
*/
|
2013-01-27 20:35:12 +00:00
|
|
|
virtual void GC(JS::gcreason::Reason aReason) = 0;
|
1999-03-12 22:24:30 +00:00
|
|
|
|
2000-03-28 00:15:56 +00:00
|
|
|
/**
|
|
|
|
* Called to disable/enable script execution in this context.
|
|
|
|
*/
|
2011-09-29 06:19:26 +00:00
|
|
|
virtual bool GetScriptsEnabled() = 0;
|
|
|
|
virtual void SetScriptsEnabled(bool aEnabled, bool aFireTimeouts) = 0;
|
2001-05-15 22:26:19 +00:00
|
|
|
|
2006-06-13 03:07:47 +00:00
|
|
|
// SetProperty is suspect and jst believes should not be needed. Currenly
|
|
|
|
// used only for "arguments".
|
2013-05-12 05:17:42 +00:00
|
|
|
virtual nsresult SetProperty(JS::Handle<JSObject*> aTarget,
|
|
|
|
const char* aPropName, nsISupports* aVal) = 0;
|
2013-01-15 11:46:35 +00:00
|
|
|
/**
|
|
|
|
* Called to set/get information if the script context is
|
|
|
|
* currently processing a script tag
|
|
|
|
*/
|
|
|
|
virtual bool GetProcessingScriptTag() = 0;
|
|
|
|
virtual void SetProcessingScriptTag(bool aResult) = 0;
|
2001-10-19 04:13:37 +00:00
|
|
|
|
2005-07-30 20:57:07 +00:00
|
|
|
/**
|
2005-08-12 04:11:00 +00:00
|
|
|
* Initialize DOM classes on aGlobalObj, always call
|
|
|
|
* WillInitializeContext() before calling InitContext(), and always
|
|
|
|
* call DidInitializeContext() when a context is fully
|
|
|
|
* (successfully) initialized.
|
2005-07-30 20:57:07 +00:00
|
|
|
*/
|
2013-05-12 05:17:42 +00:00
|
|
|
virtual nsresult InitClasses(JS::Handle<JSObject*> aGlobalObj) = 0;
|
2006-06-13 03:07:47 +00:00
|
|
|
|
2005-07-30 20:57:07 +00:00
|
|
|
/**
|
|
|
|
* Tell the context we're about to be reinitialize it.
|
|
|
|
*/
|
|
|
|
virtual void WillInitializeContext() = 0;
|
|
|
|
|
|
|
|
/**
|
2005-08-17 18:17:39 +00:00
|
|
|
* Tell the context we're done reinitializing it.
|
2005-07-30 20:57:07 +00:00
|
|
|
*/
|
|
|
|
virtual void DidInitializeContext() = 0;
|
2013-09-04 21:06:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Access the Window Proxy. The setter should only be called by nsGlobalWindow.
|
|
|
|
*/
|
|
|
|
virtual void SetWindowProxy(JS::Handle<JSObject*> aWindowProxy) = 0;
|
|
|
|
virtual JSObject* GetWindowProxy() = 0;
|
|
|
|
virtual JSObject* GetWindowProxyPreserveColor() = 0;
|
1998-04-13 20:24:54 +00:00
|
|
|
};
|
|
|
|
|
2005-11-11 14:36:26 +00:00
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(nsIScriptContext, NS_ISCRIPTCONTEXT_IID)
|
|
|
|
|
2013-08-15 21:14:43 +00:00
|
|
|
#define NS_IOFFTHREADSCRIPTRECEIVER_IID \
|
|
|
|
{0x3a980010, 0x878d, 0x46a9, \
|
|
|
|
{0x93, 0xad, 0xbc, 0xfd, 0xd3, 0x8e, 0xa0, 0xc2}}
|
|
|
|
|
|
|
|
class nsIOffThreadScriptReceiver : public nsISupports
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_IOFFTHREADSCRIPTRECEIVER_IID)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Notify this object that a previous CompileScript call specifying this as
|
|
|
|
* aOffThreadReceiver has completed. The script being passed in must be
|
|
|
|
* rooted before any call which could trigger GC.
|
|
|
|
*/
|
|
|
|
NS_IMETHOD OnScriptCompileComplete(JSScript* aScript, nsresult aStatus) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(nsIOffThreadScriptReceiver, NS_IOFFTHREADSCRIPTRECEIVER_IID)
|
|
|
|
|
1998-04-13 20:24:54 +00:00
|
|
|
#endif // nsIScriptContext_h__
|
|
|
|
|