gecko-dev/dom/base/nsJSEnvironment.h
Benjamin Smedberg 555ae1b325 Bug 481102 - Reorganize dom/public, dom/public/base, and dom/src/base to dom/base, r+sr=jst
--HG--
rename : dom/src/base/Makefile.in => dom/base/Makefile.in
rename : dom/src/base/crashtests/244933-1.html => dom/base/crashtests/244933-1.html
rename : dom/src/base/crashtests/275912-1.html => dom/base/crashtests/275912-1.html
rename : dom/src/base/crashtests/327571-1.html => dom/base/crashtests/327571-1.html
rename : dom/src/base/crashtests/327695-1.html => dom/base/crashtests/327695-1.html
rename : dom/src/base/crashtests/329481-1.xhtml => dom/base/crashtests/329481-1.xhtml
rename : dom/src/base/crashtests/338674-1.xhtml => dom/base/crashtests/338674-1.xhtml
rename : dom/src/base/crashtests/346381-1.html => dom/base/crashtests/346381-1.html
rename : dom/src/base/crashtests/359432-1.xhtml => dom/base/crashtests/359432-1.xhtml
rename : dom/src/base/crashtests/369413-1.html => dom/base/crashtests/369413-1.html
rename : dom/src/base/crashtests/372554-1.html => dom/base/crashtests/372554-1.html
rename : dom/src/base/crashtests/404869-1.xul => dom/base/crashtests/404869-1.xul
rename : dom/src/base/crashtests/439206-1.html => dom/base/crashtests/439206-1.html
rename : dom/src/base/crashtests/462947.html => dom/base/crashtests/462947.html
rename : dom/src/base/crashtests/473284.xul => dom/base/crashtests/473284.xul
rename : dom/src/base/crashtests/90613-1.html => dom/base/crashtests/90613-1.html
rename : dom/src/base/crashtests/crashtests.list => dom/base/crashtests/crashtests.list
rename : dom/src/base/domerr.msg => dom/base/domerr.msg
rename : dom/src/base/nsBarProps.cpp => dom/base/nsBarProps.cpp
rename : dom/src/base/nsBarProps.h => dom/base/nsBarProps.h
rename : dom/public/nsDOMCID.h => dom/base/nsDOMCID.h
rename : dom/src/base/nsDOMClassInfo.cpp => dom/base/nsDOMClassInfo.cpp
rename : dom/src/base/nsDOMClassInfo.h => dom/base/nsDOMClassInfo.h
rename : dom/public/nsDOMClassInfoID.h => dom/base/nsDOMClassInfoID.h
rename : dom/public/nsDOMError.h => dom/base/nsDOMError.h
rename : dom/src/base/nsDOMException.cpp => dom/base/nsDOMException.cpp
rename : dom/src/base/nsDOMException.h => dom/base/nsDOMException.h
rename : dom/public/nsDOMJSUtils.h => dom/base/nsDOMJSUtils.h
rename : dom/src/base/nsDOMScriptObjectFactory.cpp => dom/base/nsDOMScriptObjectFactory.cpp
rename : dom/src/base/nsDOMScriptObjectFactory.h => dom/base/nsDOMScriptObjectFactory.h
rename : dom/public/nsDOMScriptObjectHolder.h => dom/base/nsDOMScriptObjectHolder.h
rename : dom/public/nsDOMString.h => dom/base/nsDOMString.h
rename : dom/src/base/nsDOMWindowList.cpp => dom/base/nsDOMWindowList.cpp
rename : dom/src/base/nsDOMWindowList.h => dom/base/nsDOMWindowList.h
rename : dom/src/base/nsDOMWindowUtils.cpp => dom/base/nsDOMWindowUtils.cpp
rename : dom/src/base/nsDOMWindowUtils.h => dom/base/nsDOMWindowUtils.h
rename : dom/src/base/nsFocusController.cpp => dom/base/nsFocusController.cpp
rename : dom/src/base/nsFocusController.h => dom/base/nsFocusController.h
rename : dom/src/base/nsGlobalWindow.cpp => dom/base/nsGlobalWindow.cpp
rename : dom/src/base/nsGlobalWindow.h => dom/base/nsGlobalWindow.h
rename : dom/src/base/nsGlobalWindowCommands.cpp => dom/base/nsGlobalWindowCommands.cpp
rename : dom/src/base/nsGlobalWindowCommands.h => dom/base/nsGlobalWindowCommands.h
rename : dom/src/base/nsHistory.cpp => dom/base/nsHistory.cpp
rename : dom/src/base/nsHistory.h => dom/base/nsHistory.h
rename : dom/public/nsIBaseDOMException.h => dom/base/nsIBaseDOMException.h
rename : dom/public/nsIDOMClassInfo.h => dom/base/nsIDOMClassInfo.h
rename : dom/public/nsIDOMScriptObjectFactory.h => dom/base/nsIDOMScriptObjectFactory.h
rename : dom/public/nsIEntropyCollector.idl => dom/base/nsIEntropyCollector.idl
rename : dom/public/base/nsIFocusController.h => dom/base/nsIFocusController.h
rename : dom/public/nsIJSEventListener.h => dom/base/nsIJSEventListener.h
rename : dom/public/nsIJSNativeInitializer.h => dom/base/nsIJSNativeInitializer.h
rename : dom/public/nsIScriptChannel.idl => dom/base/nsIScriptChannel.idl
rename : dom/public/nsIScriptContext.h => dom/base/nsIScriptContext.h
rename : dom/public/nsIScriptExternalNameSet.h => dom/base/nsIScriptExternalNameSet.h
rename : dom/public/nsIScriptGlobalObject.h => dom/base/nsIScriptGlobalObject.h
rename : dom/public/nsIScriptGlobalObjectOwner.h => dom/base/nsIScriptGlobalObjectOwner.h
rename : dom/public/nsIScriptNameSpaceManager.h => dom/base/nsIScriptNameSpaceManager.h
rename : dom/public/nsIScriptObjectOwner.h => dom/base/nsIScriptObjectOwner.h
rename : dom/public/nsIScriptObjectPrincipal.h => dom/base/nsIScriptObjectPrincipal.h
rename : dom/public/nsIScriptRuntime.h => dom/base/nsIScriptRuntime.h
rename : dom/public/nsIScriptTimeoutHandler.h => dom/base/nsIScriptTimeoutHandler.h
rename : dom/src/base/nsJSEnvironment.cpp => dom/base/nsJSEnvironment.cpp
rename : dom/src/base/nsJSEnvironment.h => dom/base/nsJSEnvironment.h
rename : dom/src/base/nsJSTimeoutHandler.cpp => dom/base/nsJSTimeoutHandler.cpp
rename : dom/src/base/nsJSUtils.cpp => dom/base/nsJSUtils.cpp
rename : dom/src/base/nsJSUtils.h => dom/base/nsJSUtils.h
rename : dom/src/base/nsLocation.cpp => dom/base/nsLocation.cpp
rename : dom/src/base/nsMimeTypeArray.cpp => dom/base/nsMimeTypeArray.cpp
rename : dom/src/base/nsMimeTypeArray.h => dom/base/nsMimeTypeArray.h
rename : dom/public/base/nsPIDOMWindow.h => dom/base/nsPIDOMWindow.h
rename : dom/public/base/nsPIWindowRoot.h => dom/base/nsPIWindowRoot.h
rename : dom/src/base/nsPluginArray.cpp => dom/base/nsPluginArray.cpp
rename : dom/src/base/nsPluginArray.h => dom/base/nsPluginArray.h
rename : dom/src/base/nsScreen.cpp => dom/base/nsScreen.cpp
rename : dom/src/base/nsScreen.h => dom/base/nsScreen.h
rename : dom/src/base/nsScriptNameSpaceManager.cpp => dom/base/nsScriptNameSpaceManager.cpp
rename : dom/src/base/nsScriptNameSpaceManager.h => dom/base/nsScriptNameSpaceManager.h
rename : dom/src/base/nsWindowRoot.cpp => dom/base/nsWindowRoot.cpp
rename : dom/src/base/nsWindowRoot.h => dom/base/nsWindowRoot.h
rename : dom/public/nsWrapperCache.h => dom/base/nsWrapperCache.h
2009-03-11 10:10:19 -04:00

360 lines
14 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef nsJSEnvironment_h___
#define nsJSEnvironment_h___
#include "nsIScriptContext.h"
#include "nsIScriptRuntime.h"
#include "nsCOMPtr.h"
#include "jsapi.h"
#include "nsIObserver.h"
#include "nsIXPCScriptNotify.h"
#include "prtime.h"
#include "nsCycleCollectionParticipant.h"
#include "nsScriptNameSpaceManager.h"
class nsIXPConnectJSObjectHolder;
class nsJSContext : public nsIScriptContext,
public nsIXPCScriptNotify
{
public:
nsJSContext(JSRuntime *aRuntime);
virtual ~nsJSContext();
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsJSContext, nsIScriptContext)
virtual PRUint32 GetScriptTypeID()
{ return nsIProgrammingLanguage::JAVASCRIPT; }
virtual nsresult EvaluateString(const nsAString& aScript,
void *aScopeObject,
nsIPrincipal *principal,
const char *aURL,
PRUint32 aLineNo,
PRUint32 aVersion,
nsAString *aRetValue,
PRBool* aIsUndefined);
virtual nsresult EvaluateStringWithValue(const nsAString& aScript,
void *aScopeObject,
nsIPrincipal *aPrincipal,
const char *aURL,
PRUint32 aLineNo,
PRUint32 aVersion,
void* aRetValue,
PRBool* aIsUndefined);
virtual nsresult CompileScript(const PRUnichar* aText,
PRInt32 aTextLength,
void *aScopeObject,
nsIPrincipal *principal,
const char *aURL,
PRUint32 aLineNo,
PRUint32 aVersion,
nsScriptObjectHolder &aScriptObject);
virtual nsresult ExecuteScript(void* aScriptObject,
void *aScopeObject,
nsAString* aRetValue,
PRBool* aIsUndefined);
virtual nsresult CompileEventHandler(nsIAtom *aName,
PRUint32 aArgCount,
const char** aArgNames,
const nsAString& aBody,
const char *aURL, PRUint32 aLineNo,
PRUint32 aVersion,
nsScriptObjectHolder &aHandler);
virtual nsresult CallEventHandler(nsISupports* aTarget, void *aScope,
void* aHandler,
nsIArray *argv, nsIVariant **rv);
virtual nsresult BindCompiledEventHandler(nsISupports *aTarget,
void *aScope,
nsIAtom *aName,
void *aHandler);
virtual nsresult GetBoundEventHandler(nsISupports* aTarget, void *aScope,
nsIAtom* aName,
nsScriptObjectHolder &aHandler);
virtual nsresult CompileFunction(void* aTarget,
const nsACString& aName,
PRUint32 aArgCount,
const char** aArgArray,
const nsAString& aBody,
const char* aURL,
PRUint32 aLineNo,
PRUint32 aVersion,
PRBool aShared,
void** aFunctionObject);
virtual void SetDefaultLanguageVersion(PRUint32 aVersion);
virtual nsIScriptGlobalObject *GetGlobalObject();
virtual void *GetNativeContext();
virtual void *GetNativeGlobal();
virtual nsresult CreateNativeGlobalForInner(
nsIScriptGlobalObject *aGlobal,
PRBool aIsChrome,
void **aNativeGlobal,
nsISupports **aHolder);
virtual nsresult ConnectToInner(nsIScriptGlobalObject *aNewInner,
void *aOuterGlobal);
virtual nsresult InitContext(nsIScriptGlobalObject *aGlobalObject);
virtual PRBool IsContextInitialized();
virtual void FinalizeContext();
virtual void GC();
virtual void ScriptEvaluated(PRBool aTerminated);
virtual nsresult SetTerminationFunction(nsScriptTerminationFunc aFunc,
nsISupports* aRef);
virtual PRBool GetScriptsEnabled();
virtual void SetScriptsEnabled(PRBool aEnabled, PRBool aFireTimeouts);
virtual nsresult SetProperty(void *aTarget, const char *aPropName, nsISupports *aVal);
virtual PRBool GetProcessingScriptTag();
virtual void SetProcessingScriptTag(PRBool aResult);
virtual void SetGCOnDestruction(PRBool aGCOnDestruction);
virtual nsresult InitClasses(void *aGlobalObj);
virtual void ClearScope(void* aGlobalObj, PRBool bClearPolluters);
virtual void WillInitializeContext();
virtual void DidInitializeContext();
virtual void DidSetDocument(nsISupports *aDocdoc, void *aGlobal) {;}
virtual nsresult Serialize(nsIObjectOutputStream* aStream, void *aScriptObject);
virtual nsresult Deserialize(nsIObjectInputStream* aStream,
nsScriptObjectHolder &aResult);
virtual nsresult DropScriptObject(void *object);
virtual nsresult HoldScriptObject(void *object);
NS_DECL_NSIXPCSCRIPTNOTIFY
static void LoadStart();
static void LoadEnd();
// CC does always call cycle collector and it also updates the counters
// that MaybeCC uses.
static void CC();
// MaybeCC calls cycle collector if certain conditions are fulfilled.
// The conditions are:
// - The timer related to page load (sGCTimer) must not be active.
// - At least NS_MIN_CC_INTERVAL milliseconds must have elapsed since the
// previous cycle collector call.
// - Certain number of MaybeCC calls have occurred.
// The number of needed MaybeCC calls depends on the aHigherProbability
// parameter. If the parameter is true, probability for calling cycle
// collector rises increasingly. If the parameter is all the time false,
// at least NS_MAX_DELAYED_CCOLLECT MaybeCC calls are needed.
// If the previous call to cycle collector did collect something,
// MaybeCC works effectively as if aHigherProbability was true.
// @return PR_TRUE if cycle collector was called.
static PRBool MaybeCC(PRBool aHigherProbability);
// Calls CC() if user is currently inactive, otherwise MaybeCC(PR_TRUE)
static void CCIfUserInactive();
static void FireGCTimer(PRBool aLoadInProgress);
protected:
nsresult InitializeExternalClasses();
// aHolder should be holding our global object
nsresult FindXPCNativeWrapperClass(nsIXPConnectJSObjectHolder *aHolder);
// Helper to convert xpcom datatypes to jsvals.
JS_FORCES_STACK nsresult ConvertSupportsTojsvals(nsISupports *aArgs,
void *aScope,
PRUint32 *aArgc,
void **aArgv,
void **aMarkp);
nsresult AddSupportsPrimitiveTojsvals(nsISupports *aArg, jsval *aArgv);
// given an nsISupports object (presumably an event target or some other
// DOM object), get (or create) the JSObject wrapping it.
nsresult JSObjectFromInterface(nsISupports *aSup, void *aScript,
JSObject **aRet);
// Report the pending exception on our mContext, if any
// If aSetAsideFrameChain is true, set aside the frame chain on mContext
// before reporting. True should be passed if the frame chain isn't really
// related to our exception.
void ReportPendingException(PRBool aSetAsideFrameChain);
private:
void Unlink();
JSContext *mContext;
PRUint32 mNumEvaluations;
protected:
struct TerminationFuncHolder;
friend struct TerminationFuncHolder;
struct TerminationFuncClosure
{
TerminationFuncClosure(nsScriptTerminationFunc aFunc,
nsISupports* aArg,
TerminationFuncClosure* aNext) :
mTerminationFunc(aFunc),
mTerminationFuncArg(aArg),
mNext(aNext)
{
}
~TerminationFuncClosure()
{
delete mNext;
}
nsScriptTerminationFunc mTerminationFunc;
nsCOMPtr<nsISupports> mTerminationFuncArg;
TerminationFuncClosure* mNext;
};
struct TerminationFuncHolder
{
TerminationFuncHolder(nsJSContext* aContext)
: mContext(aContext),
mTerminations(aContext->mTerminations)
{
aContext->mTerminations = nsnull;
}
~TerminationFuncHolder()
{
// Have to be careful here. mContext might have picked up new
// termination funcs while the script was evaluating. Prepend whatever
// we have to the current termination funcs on the context (since our
// termination funcs were posted first).
if (mTerminations) {
TerminationFuncClosure* cur = mTerminations;
while (cur->mNext) {
cur = cur->mNext;
}
cur->mNext = mContext->mTerminations;
mContext->mTerminations = mTerminations;
}
}
nsJSContext* mContext;
TerminationFuncClosure* mTerminations;
};
TerminationFuncClosure* mTerminations;
private:
PRPackedBool mIsInitialized;
PRPackedBool mScriptsEnabled;
PRPackedBool mGCOnDestruction;
PRPackedBool mProcessingScriptTag;
PRUint32 mDefaultJSOptions;
PRTime mOperationCallbackTime;
// mGlobalWrapperRef is used only to hold a strong reference to the
// global object wrapper while the nsJSContext is alive. This cuts
// down on the number of rooting and unrooting calls XPConnect has
// to make when the global object is touched in JS.
nsCOMPtr<nsISupports> mGlobalWrapperRef;
static int JSOptionChangedCallback(const char *pref, void *data);
static JSBool DOMOperationCallback(JSContext *cx);
};
class nsIJSRuntimeService;
class nsJSRuntime : public nsIScriptRuntime
{
public:
// let people who can see us use our runtime for convenience.
static JSRuntime *sRuntime;
public:
// nsISupports
NS_DECL_ISUPPORTS
virtual PRUint32 GetScriptTypeID() {
return nsIProgrammingLanguage::JAVASCRIPT;
}
virtual nsresult CreateContext(nsIScriptContext **ret);
virtual nsresult ParseVersion(const nsString &aVersionStr, PRUint32 *flags);
virtual nsresult DropScriptObject(void *object);
virtual nsresult HoldScriptObject(void *object);
static void Startup();
static void Shutdown();
// Setup all the statics etc - safe to call multiple times after Startup()
static nsresult Init();
// Get the NameSpaceManager, creating if necessary
static nsScriptNameSpaceManager* GetNameSpaceManager();
};
// An interface for fast and native conversion to/from nsIArray. If an object
// supports this interface, JS can reach directly in for the argv, and avoid
// nsISupports conversion. If this interface is not supported, the object will
// be queried for nsIArray, and everything converted via xpcom objects.
#define NS_IJSARGARRAY_IID \
{ /*{E96FB2AE-CB4F-44a0-81F8-D91C80AFE9A3} */ \
0xe96fb2ae, 0xcb4f, 0x44a0, \
{ 0x81, 0xf8, 0xd9, 0x1c, 0x80, 0xaf, 0xe9, 0xa3 } }
class nsIJSArgArray: public nsISupports
{
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_IJSARGARRAY_IID)
// Bug 312003 describes why this must be "void **", but after calling argv
// may be cast to jsval* and the args found at:
// ((jsval*)argv)[0], ..., ((jsval*)argv)[argc - 1]
virtual nsresult GetArgs(PRUint32 *argc, void **argv) = 0;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsIJSArgArray, NS_IJSARGARRAY_IID)
/* factory functions */
nsresult NS_CreateJSRuntime(nsIScriptRuntime **aRuntime);
/* prototypes */
void NS_ScriptErrorReporter(JSContext *cx, const char *message, JSErrorReport *report);
#endif /* nsJSEnvironment_h___ */