2015-05-03 19:32:37 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
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/. */
|
2008-11-13 16:54:52 +00:00
|
|
|
|
|
|
|
#ifndef nsWrapperCache_h___
|
|
|
|
#define nsWrapperCache_h___
|
|
|
|
|
|
|
|
#include "nsCycleCollectionParticipant.h"
|
2013-01-29 17:51:55 +00:00
|
|
|
#include "mozilla/Assertions.h"
|
2013-08-22 05:26:56 +00:00
|
|
|
#include "js/Id.h" // must come before js/RootingAPI.h
|
2013-08-17 22:50:18 +00:00
|
|
|
#include "js/Value.h" // must come before js/RootingAPI.h
|
|
|
|
#include "js/RootingAPI.h"
|
2014-04-11 22:19:05 +00:00
|
|
|
#include "js/TracingAPI.h"
|
2008-11-13 16:54:52 +00:00
|
|
|
|
2014-10-07 09:44:48 +00:00
|
|
|
namespace mozilla {
|
|
|
|
namespace dom {
|
|
|
|
class TabChildGlobal;
|
2015-02-20 01:13:02 +00:00
|
|
|
class ProcessGlobal;
|
2014-10-07 09:44:48 +00:00
|
|
|
} // namespace dom
|
|
|
|
} // namespace mozilla
|
|
|
|
class SandboxPrivate;
|
|
|
|
class nsInProcessTabChildGlobal;
|
|
|
|
class nsWindowRoot;
|
2009-05-12 20:20:42 +00:00
|
|
|
|
2008-11-13 16:54:52 +00:00
|
|
|
#define NS_WRAPPERCACHE_IID \
|
2011-05-23 15:39:52 +00:00
|
|
|
{ 0x6f3179a1, 0x36f7, 0x4a5c, \
|
|
|
|
{ 0x8c, 0xf1, 0xad, 0xc8, 0x7c, 0xde, 0x3e, 0x87 } }
|
2008-11-13 16:54:52 +00:00
|
|
|
|
|
|
|
/**
|
2011-10-05 10:22:26 +00:00
|
|
|
* Class to store the wrapper for an object. This can only be used with objects
|
|
|
|
* that only have one non-security wrapper at a time (for an XPCWrappedNative
|
|
|
|
* this is usually ensured by setting an explicit parent in the PreCreate hook
|
|
|
|
* for the class).
|
|
|
|
*
|
|
|
|
* An instance of nsWrapperCache can be gotten from an object that implements
|
|
|
|
* a wrapper cache by calling QueryInterface on it. Note that this breaks XPCOM
|
2008-11-13 16:54:52 +00:00
|
|
|
* rules a bit (this object doesn't derive from nsISupports).
|
2011-10-05 10:22:26 +00:00
|
|
|
*
|
|
|
|
* The cache can store objects other than wrappers. We allow wrappers to use a
|
|
|
|
* separate JSObject to store their state (mostly expandos). If the wrapper is
|
|
|
|
* collected and we want to preserve this state we actually store the state
|
|
|
|
* object in the cache.
|
|
|
|
*
|
2012-03-14 14:22:10 +00:00
|
|
|
* The cache can store 2 types of objects:
|
2011-10-05 10:22:26 +00:00
|
|
|
*
|
2014-10-07 09:44:48 +00:00
|
|
|
* If WRAPPER_IS_NOT_DOM_BINDING is set (IsDOMBinding() returns false):
|
|
|
|
* - the JSObject of an XPCWrappedNative wrapper
|
2011-10-05 10:22:26 +00:00
|
|
|
*
|
2014-10-07 09:44:48 +00:00
|
|
|
* If WRAPPER_IS_NOT_DOM_BINDING is not set (IsDOMBinding() returns true):
|
2012-03-31 04:42:20 +00:00
|
|
|
* - a DOM binding object (regular JS object or proxy)
|
2011-10-05 10:22:26 +00:00
|
|
|
*
|
2012-03-14 14:22:10 +00:00
|
|
|
* The finalizer for the wrapper clears the cache.
|
2011-10-05 10:22:26 +00:00
|
|
|
*
|
2014-09-17 14:35:11 +00:00
|
|
|
* A compacting GC can move the wrapper object. Pointers to moved objects are
|
|
|
|
* usually found and updated by tracing the heap, however non-preserved wrappers
|
|
|
|
* are weak references and are not traced, so another approach is
|
|
|
|
* necessary. Instead a class hook (objectMovedOp) is provided that is called
|
|
|
|
* when an object is moved and is responsible for ensuring pointers are
|
|
|
|
* updated. It does this by calling UpdateWrapper() on the wrapper
|
|
|
|
* cache. SetWrapper() asserts that the hook is implemented for any wrapper set.
|
|
|
|
*
|
2011-10-05 10:22:26 +00:00
|
|
|
* A number of the methods are implemented in nsWrapperCacheInlines.h because we
|
|
|
|
* have to include some JS headers that don't play nicely with the rest of the
|
|
|
|
* codebase. Include nsWrapperCacheInlines.h if you need to call those methods.
|
2008-11-13 16:54:52 +00:00
|
|
|
*/
|
2015-07-09 19:32:04 +00:00
|
|
|
|
2008-11-13 16:54:52 +00:00
|
|
|
class nsWrapperCache
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_WRAPPERCACHE_IID)
|
|
|
|
|
2013-06-08 08:53:21 +00:00
|
|
|
nsWrapperCache() : mWrapper(nullptr), mFlags(0)
|
2008-11-13 16:54:52 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
~nsWrapperCache()
|
|
|
|
{
|
2013-01-15 19:04:24 +00:00
|
|
|
MOZ_ASSERT(!PreservingWrapper(),
|
|
|
|
"Destroying cache with a preserved wrapper!");
|
2008-11-13 16:54:52 +00:00
|
|
|
}
|
|
|
|
|
2011-02-16 20:47:08 +00:00
|
|
|
/**
|
2011-10-05 10:22:26 +00:00
|
|
|
* Get the cached wrapper.
|
|
|
|
*
|
2011-02-16 20:47:08 +00:00
|
|
|
* This getter clears the gray bit before handing out the JSObject which means
|
|
|
|
* that the object is guaranteed to be kept alive past the next CC.
|
|
|
|
*/
|
2011-05-26 19:58:35 +00:00
|
|
|
JSObject* GetWrapper() const;
|
2011-02-16 20:47:08 +00:00
|
|
|
|
|
|
|
/**
|
2011-10-05 10:22:26 +00:00
|
|
|
* Get the cached wrapper.
|
|
|
|
*
|
2011-02-16 20:47:08 +00:00
|
|
|
* This getter does not change the color of the JSObject meaning that the
|
|
|
|
* object returned is not guaranteed to be kept alive past the next CC.
|
|
|
|
*
|
|
|
|
* This should only be called if you are certain that the return value won't
|
|
|
|
* be passed into a JS API function and that it won't be stored without being
|
|
|
|
* rooted (or otherwise signaling the stored value to the CC).
|
|
|
|
*/
|
2012-03-14 14:22:10 +00:00
|
|
|
JSObject* GetWrapperPreserveColor() const
|
|
|
|
{
|
2013-06-08 08:53:21 +00:00
|
|
|
return GetWrapperJSObject();
|
2012-03-14 14:22:10 +00:00
|
|
|
}
|
2008-11-13 16:54:52 +00:00
|
|
|
|
2015-07-09 19:32:04 +00:00
|
|
|
#ifdef DEBUG
|
|
|
|
private:
|
|
|
|
static bool HasJSObjectMovedOp(JSObject* aWrapper);
|
|
|
|
|
|
|
|
public:
|
|
|
|
#endif
|
|
|
|
|
2012-03-14 14:22:10 +00:00
|
|
|
void SetWrapper(JSObject* aWrapper)
|
|
|
|
{
|
2013-01-15 19:04:24 +00:00
|
|
|
MOZ_ASSERT(!PreservingWrapper(), "Clearing a preserved wrapper!");
|
|
|
|
MOZ_ASSERT(aWrapper, "Use ClearWrapper!");
|
2015-07-09 19:32:04 +00:00
|
|
|
MOZ_ASSERT(HasJSObjectMovedOp(aWrapper),
|
2014-09-17 14:35:11 +00:00
|
|
|
"Object has not provided the hook to update the wrapper if it is moved");
|
2008-11-13 16:54:52 +00:00
|
|
|
|
2013-06-08 08:53:21 +00:00
|
|
|
SetWrapperJSObject(aWrapper);
|
2012-03-14 14:22:10 +00:00
|
|
|
}
|
2011-05-26 19:58:35 +00:00
|
|
|
|
2011-10-05 10:22:26 +00:00
|
|
|
/**
|
2012-03-14 14:22:10 +00:00
|
|
|
* Clear the wrapper. This should be called from the finalizer for the
|
|
|
|
* wrapper.
|
2011-10-05 10:22:26 +00:00
|
|
|
*/
|
2012-03-14 14:22:10 +00:00
|
|
|
void ClearWrapper()
|
|
|
|
{
|
2013-01-15 19:04:24 +00:00
|
|
|
MOZ_ASSERT(!PreservingWrapper(), "Clearing a preserved wrapper!");
|
2011-10-05 10:22:26 +00:00
|
|
|
|
2013-06-08 08:53:21 +00:00
|
|
|
SetWrapperJSObject(nullptr);
|
2012-03-14 14:22:10 +00:00
|
|
|
}
|
2008-11-13 16:54:52 +00:00
|
|
|
|
2014-09-17 14:35:11 +00:00
|
|
|
/**
|
|
|
|
* Update the wrapper if the object it contains is moved.
|
|
|
|
*
|
|
|
|
* This method must be called from the objectMovedOp class extension hook for
|
|
|
|
* any wrapper cached object.
|
|
|
|
*/
|
|
|
|
void UpdateWrapper(JSObject* aNewObject, const JSObject* aOldObject)
|
|
|
|
{
|
2014-10-03 09:04:19 +00:00
|
|
|
if (mWrapper) {
|
|
|
|
MOZ_ASSERT(mWrapper == aOldObject);
|
|
|
|
mWrapper = aNewObject;
|
|
|
|
}
|
2014-09-17 14:35:11 +00:00
|
|
|
}
|
|
|
|
|
2011-09-29 06:19:26 +00:00
|
|
|
bool PreservingWrapper()
|
2008-11-13 16:54:52 +00:00
|
|
|
{
|
2013-06-08 08:53:21 +00:00
|
|
|
return HasWrapperFlag(WRAPPER_BIT_PRESERVED);
|
2010-09-17 21:54:40 +00:00
|
|
|
}
|
|
|
|
|
2012-03-16 15:44:09 +00:00
|
|
|
bool IsDOMBinding() const
|
2010-09-17 21:54:40 +00:00
|
|
|
{
|
2014-10-07 09:44:48 +00:00
|
|
|
return !HasWrapperFlag(WRAPPER_IS_NOT_DOM_BINDING);
|
2008-11-13 16:54:52 +00:00
|
|
|
}
|
|
|
|
|
2011-05-23 15:39:52 +00:00
|
|
|
/**
|
2011-06-29 17:17:37 +00:00
|
|
|
* Wrap the object corresponding to this wrapper cache. If non-null is
|
2013-03-11 23:03:47 +00:00
|
|
|
* returned, the object has already been stored in the wrapper cache.
|
2011-05-23 15:39:52 +00:00
|
|
|
*/
|
Bug 1117172 part 3. Change the wrappercached WrapObject methods to allow passing in aGivenProto. r=peterv
The only manual changes here are to BindingUtils.h, BindingUtils.cpp,
Codegen.py, Element.cpp, IDBFileRequest.cpp, IDBObjectStore.cpp,
dom/workers/Navigator.cpp, WorkerPrivate.cpp, DeviceStorageRequestChild.cpp,
Notification.cpp, nsGlobalWindow.cpp, MessagePort.cpp, nsJSEnvironment.cpp,
Sandbox.cpp, XPCConvert.cpp, ExportHelpers.cpp, and DataStoreService.cpp. The
rest of this diff was generated by running the following commands:
find . -name "*.h" -o -name "*.cpp" | xargs perl -pi -e 'BEGIN { $/ = undef } s/(WrapObjectInternal\(JSContext *\* *(?:aCx|cx|aContext|aCtx|js))\)/\1, JS::Handle<JSObject*> aGivenProto)/g'
find . -name "*.h" -o -name "*.cpp" | xargs perl -pi -e 'BEGIN { $/ = undef } s/(WrapObjectInternal\((?:aCx|cx|aContext|aCtx|js))\)/\1, aGivenProto)/g'
find . -name "*.h" -o -name "*.cpp" | xargs perl -pi -e 'BEGIN { $/ = undef } s/(WrapNode\(JSContext *\* *(?:aCx|cx|aContext|aCtx|js))\)/\1, JS::Handle<JSObject*> aGivenProto)/g'
find . -name "*.h" -o -name "*.cpp" | xargs perl -pi -e 'BEGIN { $/ = undef } s/(WrapNode\((?:aCx|cx|aContext|aCtx|js))\)/\1, aGivenProto)/g'
find . -name "*.h" -o -name "*.cpp" | xargs perl -pi -e 'BEGIN { $/ = undef } s/(WrapObject\(JSContext *\* *(?:aCx|cx|aContext|aCtx|js))\)/\1, JS::Handle<JSObject*> aGivenProto)/g'
find . -name "*.h" -o -name "*.cpp" | xargs perl -pi -e 'BEGIN { $/ = undef } s/(Binding(?:_workers)?::Wrap\((?:aCx|cx|aContext|aCtx|js), [^,)]+)\)/\1, aGivenProto)/g'
2015-03-19 14:13:33 +00:00
|
|
|
virtual JSObject* WrapObject(JSContext* cx, JS::Handle<JSObject*> aGivenProto) = 0;
|
2011-05-23 15:39:52 +00:00
|
|
|
|
2011-12-29 21:21:33 +00:00
|
|
|
/**
|
|
|
|
* Returns true if the object has a non-gray wrapper.
|
|
|
|
*/
|
|
|
|
bool IsBlack();
|
|
|
|
|
2012-09-28 22:29:37 +00:00
|
|
|
/**
|
|
|
|
* Returns true if the object has a black wrapper,
|
|
|
|
* and all the GC things it is keeping alive are black too.
|
|
|
|
*/
|
|
|
|
bool IsBlackAndDoesNotNeedTracing(nsISupports* aThis);
|
|
|
|
|
2013-11-24 19:35:34 +00:00
|
|
|
bool HasNothingToTrace(nsISupports* aThis);
|
|
|
|
|
2012-03-14 14:22:10 +00:00
|
|
|
// Only meant to be called by code that preserves a wrapper.
|
2011-09-29 06:19:26 +00:00
|
|
|
void SetPreservingWrapper(bool aPreserve)
|
2011-02-16 20:47:08 +00:00
|
|
|
{
|
|
|
|
if(aPreserve) {
|
2013-06-08 08:53:21 +00:00
|
|
|
SetWrapperFlags(WRAPPER_BIT_PRESERVED);
|
2011-02-16 20:47:08 +00:00
|
|
|
}
|
|
|
|
else {
|
2013-06-08 08:53:21 +00:00
|
|
|
UnsetWrapperFlags(WRAPPER_BIT_PRESERVED);
|
2011-02-16 20:47:08 +00:00
|
|
|
}
|
|
|
|
}
|
2012-03-14 14:22:10 +00:00
|
|
|
|
2013-05-27 11:50:49 +00:00
|
|
|
void TraceWrapper(const TraceCallbacks& aCallbacks, void* aClosure)
|
|
|
|
{
|
2013-06-08 08:53:21 +00:00
|
|
|
if (PreservingWrapper() && mWrapper) {
|
2013-06-18 10:00:38 +00:00
|
|
|
aCallbacks.Trace(&mWrapper, "Preserved wrapper", aClosure);
|
2013-05-27 11:50:49 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-09-17 14:35:11 +00:00
|
|
|
/*
|
2013-06-08 08:53:21 +00:00
|
|
|
* The following methods for getting and manipulating flags allow the unused
|
|
|
|
* bits of mFlags to be used by derived classes.
|
|
|
|
*/
|
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
typedef uint32_t FlagsType;
|
|
|
|
|
|
|
|
FlagsType GetFlags() const
|
2013-06-08 08:53:21 +00:00
|
|
|
{
|
|
|
|
return mFlags & ~kWrapperFlagsMask;
|
|
|
|
}
|
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
bool HasFlag(FlagsType aFlag) const
|
2013-06-08 08:53:21 +00:00
|
|
|
{
|
|
|
|
MOZ_ASSERT((aFlag & kWrapperFlagsMask) == 0, "Bad flag mask");
|
|
|
|
return !!(mFlags & aFlag);
|
|
|
|
}
|
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
void SetFlags(FlagsType aFlagsToSet)
|
2013-06-08 08:53:21 +00:00
|
|
|
{
|
|
|
|
MOZ_ASSERT((aFlagsToSet & kWrapperFlagsMask) == 0, "Bad flag mask");
|
|
|
|
mFlags |= aFlagsToSet;
|
|
|
|
}
|
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
void UnsetFlags(FlagsType aFlagsToUnset)
|
2013-06-08 08:53:21 +00:00
|
|
|
{
|
|
|
|
MOZ_ASSERT((aFlagsToUnset & kWrapperFlagsMask) == 0, "Bad flag mask");
|
|
|
|
mFlags &= ~aFlagsToUnset;
|
|
|
|
}
|
|
|
|
|
2013-06-23 07:15:42 +00:00
|
|
|
void PreserveWrapper(nsISupports* aScriptObjectHolder)
|
|
|
|
{
|
|
|
|
if (PreservingWrapper()) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
nsISupports* ccISupports;
|
|
|
|
aScriptObjectHolder->QueryInterface(NS_GET_IID(nsCycleCollectionISupports),
|
|
|
|
reinterpret_cast<void**>(&ccISupports));
|
|
|
|
MOZ_ASSERT(ccISupports);
|
|
|
|
|
|
|
|
nsXPCOMCycleCollectionParticipant* participant;
|
|
|
|
CallQueryInterface(ccISupports, &participant);
|
|
|
|
PreserveWrapper(ccISupports, participant);
|
|
|
|
}
|
|
|
|
|
|
|
|
void PreserveWrapper(void* aScriptObjectHolder, nsScriptObjectTracer* aTracer)
|
|
|
|
{
|
|
|
|
if (PreservingWrapper()) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
HoldJSObjects(aScriptObjectHolder, aTracer);
|
|
|
|
SetPreservingWrapper(true);
|
2013-06-23 07:15:10 +00:00
|
|
|
#ifdef DEBUG
|
2013-06-23 07:15:42 +00:00
|
|
|
// Make sure the cycle collector will be able to traverse to the wrapper.
|
|
|
|
CheckCCWrapperTraversal(aScriptObjectHolder, aTracer);
|
|
|
|
#endif
|
|
|
|
}
|
2013-06-23 07:15:10 +00:00
|
|
|
|
2013-08-02 07:04:01 +00:00
|
|
|
void ReleaseWrapper(void* aScriptObjectHolder);
|
|
|
|
|
2013-11-09 10:20:22 +00:00
|
|
|
protected:
|
|
|
|
void TraceWrapper(JSTracer* aTrc, const char* name)
|
|
|
|
{
|
|
|
|
if (mWrapper) {
|
2015-12-30 19:31:16 +00:00
|
|
|
js::UnsafeTraceManuallyBarrieredEdge(aTrc, &mWrapper, name);
|
2013-11-09 10:20:22 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void PoisonWrapper()
|
|
|
|
{
|
|
|
|
if (mWrapper) {
|
2016-11-04 17:32:36 +00:00
|
|
|
// Set the pointer to a value that will cause a crash if it is
|
|
|
|
// dereferenced.
|
2015-12-31 13:21:49 +00:00
|
|
|
mWrapper = reinterpret_cast<JSObject*>(1);
|
2013-11-09 10:20:22 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-03-14 14:22:10 +00:00
|
|
|
private:
|
2014-10-07 09:44:48 +00:00
|
|
|
friend class mozilla::dom::TabChildGlobal;
|
2015-02-20 01:13:02 +00:00
|
|
|
friend class mozilla::dom::ProcessGlobal;
|
2014-10-07 09:44:48 +00:00
|
|
|
friend class SandboxPrivate;
|
|
|
|
friend class nsInProcessTabChildGlobal;
|
|
|
|
friend class nsWindowRoot;
|
|
|
|
void SetIsNotDOMBinding()
|
|
|
|
{
|
|
|
|
MOZ_ASSERT(!mWrapper && !(GetWrapperFlags() & ~WRAPPER_IS_NOT_DOM_BINDING),
|
|
|
|
"This flag should be set before creating any wrappers.");
|
|
|
|
SetWrapperFlags(WRAPPER_IS_NOT_DOM_BINDING);
|
|
|
|
}
|
|
|
|
|
2013-06-08 08:53:21 +00:00
|
|
|
JSObject *GetWrapperJSObject() const
|
2011-05-26 19:58:35 +00:00
|
|
|
{
|
2013-06-08 08:53:21 +00:00
|
|
|
return mWrapper;
|
2011-05-26 19:58:35 +00:00
|
|
|
}
|
2013-06-08 08:53:21 +00:00
|
|
|
|
2015-12-31 13:21:49 +00:00
|
|
|
void SetWrapperJSObject(JSObject* aWrapper);
|
2013-06-08 08:53:21 +00:00
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
FlagsType GetWrapperFlags() const
|
2013-06-08 08:53:21 +00:00
|
|
|
{
|
|
|
|
return mFlags & kWrapperFlagsMask;
|
|
|
|
}
|
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
bool HasWrapperFlag(FlagsType aFlag) const
|
2011-05-26 19:58:35 +00:00
|
|
|
{
|
2013-06-08 08:53:21 +00:00
|
|
|
MOZ_ASSERT((aFlag & ~kWrapperFlagsMask) == 0, "Bad wrapper flag bits");
|
|
|
|
return !!(mFlags & aFlag);
|
2011-05-26 19:58:35 +00:00
|
|
|
}
|
2011-02-16 20:47:08 +00:00
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
void SetWrapperFlags(FlagsType aFlagsToSet)
|
2013-06-08 08:53:21 +00:00
|
|
|
{
|
|
|
|
MOZ_ASSERT((aFlagsToSet & ~kWrapperFlagsMask) == 0, "Bad wrapper flag bits");
|
|
|
|
mFlags |= aFlagsToSet;
|
|
|
|
}
|
|
|
|
|
2014-06-19 00:07:26 +00:00
|
|
|
void UnsetWrapperFlags(FlagsType aFlagsToUnset)
|
2013-06-08 08:53:21 +00:00
|
|
|
{
|
|
|
|
MOZ_ASSERT((aFlagsToUnset & ~kWrapperFlagsMask) == 0, "Bad wrapper flag bits");
|
|
|
|
mFlags &= ~aFlagsToUnset;
|
|
|
|
}
|
2013-03-28 20:37:22 +00:00
|
|
|
|
2015-12-31 13:21:49 +00:00
|
|
|
void HoldJSObjects(void* aScriptObjectHolder,
|
|
|
|
nsScriptObjectTracer* aTracer);
|
2013-06-23 07:15:42 +00:00
|
|
|
|
|
|
|
#ifdef DEBUG
|
2015-07-29 10:28:45 +00:00
|
|
|
public:
|
2013-06-23 07:15:42 +00:00
|
|
|
void CheckCCWrapperTraversal(void* aScriptObjectHolder,
|
|
|
|
nsScriptObjectTracer* aTracer);
|
2015-07-29 10:28:45 +00:00
|
|
|
private:
|
2013-06-23 07:15:42 +00:00
|
|
|
#endif // DEBUG
|
|
|
|
|
2011-10-05 10:22:26 +00:00
|
|
|
/**
|
|
|
|
* If this bit is set then we're preserving the wrapper, which in effect ties
|
|
|
|
* the lifetime of the JS object stored in the cache to the lifetime of the
|
|
|
|
* native object. We rely on the cycle collector to break the cycle that this
|
|
|
|
* causes between the native object and the JS object, so it is important that
|
|
|
|
* any native object that supports preserving of its wrapper
|
|
|
|
* traces/traverses/unlinks the cached JS object (see
|
|
|
|
* NS_IMPL_CYCLE_COLLECTION_TRACE_PRESERVED_WRAPPER,
|
|
|
|
* NS_IMPL_CYCLE_COLLECTION_TRAVERSE_SCRIPT_OBJECTS and
|
|
|
|
* NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER).
|
|
|
|
*/
|
2008-11-13 16:54:52 +00:00
|
|
|
enum { WRAPPER_BIT_PRESERVED = 1 << 0 };
|
2011-10-05 10:22:26 +00:00
|
|
|
|
|
|
|
/**
|
2014-10-07 09:44:48 +00:00
|
|
|
* If this bit is set then the wrapper for the native object is not a DOM
|
|
|
|
* binding.
|
2011-10-05 10:22:26 +00:00
|
|
|
*/
|
2014-10-07 09:44:48 +00:00
|
|
|
enum { WRAPPER_IS_NOT_DOM_BINDING = 1 << 1 };
|
2011-10-05 10:22:26 +00:00
|
|
|
|
2014-10-07 09:44:48 +00:00
|
|
|
enum { kWrapperFlagsMask = (WRAPPER_BIT_PRESERVED | WRAPPER_IS_NOT_DOM_BINDING) };
|
2008-11-13 16:54:52 +00:00
|
|
|
|
2015-12-31 13:21:49 +00:00
|
|
|
JSObject* mWrapper;
|
|
|
|
FlagsType mFlags;
|
2008-11-13 16:54:52 +00:00
|
|
|
};
|
|
|
|
|
2014-03-19 16:35:45 +00:00
|
|
|
enum { WRAPPER_CACHE_FLAGS_BITS_USED = 2 };
|
2013-06-08 08:53:21 +00:00
|
|
|
|
2008-11-13 16:54:52 +00:00
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(nsWrapperCache, NS_WRAPPERCACHE_IID)
|
|
|
|
|
2014-08-25 23:21:35 +00:00
|
|
|
#define NS_WRAPPERCACHE_INTERFACE_TABLE_ENTRY \
|
2008-11-13 16:54:52 +00:00
|
|
|
if ( aIID.Equals(NS_GET_IID(nsWrapperCache)) ) { \
|
|
|
|
*aInstancePtr = static_cast<nsWrapperCache*>(this); \
|
|
|
|
return NS_OK; \
|
|
|
|
}
|
|
|
|
|
2014-08-25 23:21:35 +00:00
|
|
|
#define NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY \
|
|
|
|
NS_WRAPPERCACHE_INTERFACE_TABLE_ENTRY \
|
|
|
|
else
|
|
|
|
|
2012-05-14 15:24:03 +00:00
|
|
|
|
|
|
|
// Cycle collector macros for wrapper caches.
|
|
|
|
|
|
|
|
#define NS_IMPL_CYCLE_COLLECTION_TRACE_PRESERVED_WRAPPER \
|
2013-05-27 11:50:49 +00:00
|
|
|
tmp->TraceWrapper(aCallbacks, aClosure);
|
2012-05-14 15:24:03 +00:00
|
|
|
|
|
|
|
#define NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER \
|
2013-08-02 07:04:01 +00:00
|
|
|
tmp->ReleaseWrapper(p);
|
2012-09-26 18:12:15 +00:00
|
|
|
|
2012-05-14 15:24:03 +00:00
|
|
|
#define NS_IMPL_CYCLE_COLLECTION_TRACE_WRAPPERCACHE(_class) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN(_class) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRACE_PRESERVED_WRAPPER \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRACE_END
|
|
|
|
|
|
|
|
#define NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE_0(_class) \
|
2013-08-02 01:29:05 +00:00
|
|
|
NS_IMPL_CYCLE_COLLECTION_CLASS(_class) \
|
2012-05-14 15:24:03 +00:00
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(_class) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_END \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(_class) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_SCRIPT_OBJECTS \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRACE_WRAPPERCACHE(_class)
|
|
|
|
|
2014-04-29 08:56:00 +00:00
|
|
|
#define NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(_class, ...) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_CLASS(_class) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(_class) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK(__VA_ARGS__) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_END \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(_class) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(__VA_ARGS__) \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_SCRIPT_OBJECTS \
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END \
|
2012-05-14 15:24:03 +00:00
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRACE_WRAPPERCACHE(_class)
|
|
|
|
|
2008-11-13 16:54:52 +00:00
|
|
|
#endif /* nsWrapperCache_h___ */
|