1998-10-19 17:48:55 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
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-10-19 17:48:55 +00:00
|
|
|
|
|
|
|
|
#ifndef nsAgg_h___
|
|
|
|
|
#define nsAgg_h___
|
|
|
|
|
|
|
|
|
|
#include "nsISupports.h"
|
2007-04-10 22:05:41 +00:00
|
|
|
#include "nsCycleCollectionParticipant.h"
|
1998-10-19 17:48:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
2007-04-10 22:05:41 +00:00
|
|
|
// Put NS_DECL_AGGREGATED or NS_DECL_CYCLE_COLLECTING_AGGREGATED in your class's
|
|
|
|
|
// declaration.
|
1998-10-19 17:48:55 +00:00
|
|
|
#define NS_DECL_AGGREGATED \
|
|
|
|
|
NS_DECL_ISUPPORTS \
|
2007-04-10 22:05:41 +00:00
|
|
|
NS_DECL_AGGREGATED_HELPER
|
|
|
|
|
|
|
|
|
|
#define NS_DECL_CYCLE_COLLECTING_AGGREGATED \
|
|
|
|
|
NS_DECL_CYCLE_COLLECTING_ISUPPORTS \
|
|
|
|
|
NS_DECL_AGGREGATED_HELPER
|
|
|
|
|
|
|
|
|
|
#define NS_DECL_AGGREGATED_HELPER \
|
2000-01-10 23:14:32 +00:00
|
|
|
public: \
|
1998-10-19 17:48:55 +00:00
|
|
|
\
|
2005-09-28 13:13:27 +00:00
|
|
|
/** \
|
|
|
|
|
* Returns the nsISupports pointer of the inner object (aka the \
|
|
|
|
|
* aggregatee). This pointer is really only useful to the outer object \
|
|
|
|
|
* (aka the aggregator), which can use it to hold on to the inner \
|
|
|
|
|
* object. Anything else wants the nsISupports pointer of the outer \
|
|
|
|
|
* object (gotten by QI'ing inner or outer to nsISupports). This method \
|
|
|
|
|
* returns a non-addrefed pointer. \
|
|
|
|
|
* @return the nsISupports pointer of the inner object \
|
|
|
|
|
*/ \
|
|
|
|
|
nsISupports* InnerObject(void) { return &fAggregated; } \
|
|
|
|
|
\
|
2007-04-10 22:05:41 +00:00
|
|
|
/** \
|
2011-10-17 14:59:28 +00:00
|
|
|
* Returns true if this object is part of an aggregated object. \
|
2007-04-10 22:05:41 +00:00
|
|
|
*/ \
|
2011-09-29 06:19:26 +00:00
|
|
|
bool IsPartOfAggregated(void) { return fOuter != InnerObject(); } \
|
2007-04-10 22:05:41 +00:00
|
|
|
\
|
2005-09-28 13:13:27 +00:00
|
|
|
private: \
|
|
|
|
|
\
|
1998-10-19 17:48:55 +00:00
|
|
|
/* You must implement this operation instead of the nsISupports */ \
|
2005-09-28 13:13:27 +00:00
|
|
|
/* methods. */ \
|
|
|
|
|
nsresult \
|
1998-10-19 17:48:55 +00:00
|
|
|
AggregatedQueryInterface(const nsIID& aIID, void** aInstancePtr); \
|
|
|
|
|
\
|
|
|
|
|
class Internal : public nsISupports { \
|
|
|
|
|
public: \
|
|
|
|
|
\
|
|
|
|
|
Internal() {} \
|
|
|
|
|
\
|
2005-09-28 13:13:27 +00:00
|
|
|
NS_IMETHOD QueryInterface(const nsIID& aIID, void** aInstancePtr); \
|
1998-10-19 17:48:55 +00:00
|
|
|
NS_IMETHOD_(nsrefcnt) AddRef(void); \
|
|
|
|
|
NS_IMETHOD_(nsrefcnt) Release(void); \
|
|
|
|
|
\
|
2008-01-09 21:14:02 +00:00
|
|
|
NS_DECL_OWNINGTHREAD \
|
1998-10-19 17:48:55 +00:00
|
|
|
}; \
|
|
|
|
|
\
|
|
|
|
|
friend class Internal; \
|
|
|
|
|
\
|
|
|
|
|
nsISupports* fOuter; \
|
|
|
|
|
Internal fAggregated; \
|
|
|
|
|
\
|
|
|
|
|
public: \
|
|
|
|
|
|
2007-04-10 22:05:41 +00:00
|
|
|
#define NS_DECL_AGGREGATED_CYCLE_COLLECTION_CLASS(_class) \
|
|
|
|
|
class NS_CYCLE_COLLECTION_INNERCLASS \
|
2007-05-24 14:10:02 +00:00
|
|
|
: public nsXPCOMCycleCollectionParticipant \
|
2007-04-10 22:05:41 +00:00
|
|
|
{ \
|
|
|
|
|
public: \
|
2007-05-24 14:10:02 +00:00
|
|
|
NS_IMETHOD Unlink(void *p); \
|
|
|
|
|
NS_IMETHOD Traverse(void *p, \
|
2007-04-10 22:05:41 +00:00
|
|
|
nsCycleCollectionTraversalCallback &cb); \
|
2012-03-26 16:57:29 +00:00
|
|
|
NS_IMETHOD_(void) UnmarkIfPurple(nsISupports *p) \
|
2007-04-10 22:05:41 +00:00
|
|
|
{ \
|
2012-03-26 16:57:29 +00:00
|
|
|
Downcast(p)->UnmarkIfPurple(); \
|
2007-04-10 22:05:41 +00:00
|
|
|
} \
|
|
|
|
|
static _class* Downcast(nsISupports* s) \
|
|
|
|
|
{ \
|
|
|
|
|
return (_class*)((char*)(s) - offsetof(_class, fAggregated)); \
|
|
|
|
|
} \
|
|
|
|
|
static nsISupports* Upcast(_class *p) \
|
|
|
|
|
{ \
|
|
|
|
|
return p->InnerObject(); \
|
|
|
|
|
} \
|
2007-10-29 13:45:07 +00:00
|
|
|
}; \
|
|
|
|
|
NS_CYCLE_COLLECTION_PARTICIPANT_INSTANCE
|
1998-10-19 17:48:55 +00:00
|
|
|
|
|
|
|
|
// Put this in your class's constructor:
|
|
|
|
|
#define NS_INIT_AGGREGATED(outer) \
|
1999-01-26 09:46:33 +00:00
|
|
|
PR_BEGIN_MACRO \
|
1999-08-19 05:36:30 +00:00
|
|
|
fOuter = outer ? outer : &fAggregated; \
|
1999-01-26 09:46:33 +00:00
|
|
|
PR_END_MACRO
|
1998-10-19 17:48:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
// Put this in your class's implementation file:
|
|
|
|
|
#define NS_IMPL_AGGREGATED(_class) \
|
|
|
|
|
\
|
2007-04-10 22:05:41 +00:00
|
|
|
NS_IMPL_AGGREGATED_HELPER(_class) \
|
1998-10-19 17:48:55 +00:00
|
|
|
\
|
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) \
|
|
|
|
|
_class::Internal::AddRef(void) \
|
|
|
|
|
{ \
|
|
|
|
|
_class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
|
1999-10-07 21:50:20 +00:00
|
|
|
NS_PRECONDITION(PRInt32(agg->mRefCnt) >= 0, "illegal refcnt"); \
|
2008-01-09 21:14:02 +00:00
|
|
|
NS_ASSERT_OWNINGTHREAD(_class); \
|
1999-10-07 21:50:20 +00:00
|
|
|
++agg->mRefCnt; \
|
1999-10-08 20:41:19 +00:00
|
|
|
NS_LOG_ADDREF(this, agg->mRefCnt, #_class, sizeof(*this)); \
|
1999-10-07 21:50:20 +00:00
|
|
|
return agg->mRefCnt; \
|
1998-10-19 17:48:55 +00:00
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) \
|
|
|
|
|
_class::Internal::Release(void) \
|
|
|
|
|
{ \
|
|
|
|
|
_class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
|
1999-10-07 21:50:20 +00:00
|
|
|
NS_PRECONDITION(0 != agg->mRefCnt, "dup release"); \
|
2008-01-09 21:14:02 +00:00
|
|
|
NS_ASSERT_OWNINGTHREAD(_class); \
|
1999-10-07 21:50:20 +00:00
|
|
|
--agg->mRefCnt; \
|
|
|
|
|
NS_LOG_RELEASE(this, agg->mRefCnt, #_class); \
|
|
|
|
|
if (agg->mRefCnt == 0) { \
|
1999-10-12 02:10:08 +00:00
|
|
|
agg->mRefCnt = 1; /* stabilize */ \
|
2010-07-05 09:42:18 +00:00
|
|
|
delete agg; \
|
1998-10-19 17:48:55 +00:00
|
|
|
return 0; \
|
|
|
|
|
} \
|
|
|
|
|
return agg->mRefCnt; \
|
|
|
|
|
} \
|
|
|
|
|
|
2007-04-10 22:05:41 +00:00
|
|
|
#define NS_IMPL_CYCLE_COLLECTING_AGGREGATED(_class) \
|
|
|
|
|
\
|
|
|
|
|
NS_IMPL_AGGREGATED_HELPER(_class) \
|
|
|
|
|
\
|
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) \
|
|
|
|
|
_class::Internal::AddRef(void) \
|
|
|
|
|
{ \
|
|
|
|
|
_class* agg = NS_CYCLE_COLLECTION_CLASSNAME(_class)::Downcast(this); \
|
|
|
|
|
NS_PRECONDITION(PRInt32(agg->mRefCnt) >= 0, "illegal refcnt"); \
|
|
|
|
|
NS_CheckThreadSafe(agg->_mOwningThread.GetThread(), \
|
|
|
|
|
#_class " not thread-safe"); \
|
|
|
|
|
nsrefcnt count = agg->mRefCnt.incr(this); \
|
|
|
|
|
NS_LOG_ADDREF(this, count, #_class, sizeof(*agg)); \
|
|
|
|
|
return count; \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) \
|
|
|
|
|
_class::Internal::Release(void) \
|
|
|
|
|
{ \
|
|
|
|
|
_class* agg = NS_CYCLE_COLLECTION_CLASSNAME(_class)::Downcast(this); \
|
|
|
|
|
NS_PRECONDITION(0 != agg->mRefCnt, "dup release"); \
|
|
|
|
|
NS_CheckThreadSafe(agg->_mOwningThread.GetThread(), \
|
|
|
|
|
#_class " not thread-safe"); \
|
|
|
|
|
nsrefcnt count = agg->mRefCnt.decr(this); \
|
|
|
|
|
NS_LOG_RELEASE(this, count, #_class); \
|
|
|
|
|
if (count == 0) { \
|
|
|
|
|
agg->mRefCnt.stabilizeForDeletion(this); \
|
2010-07-05 09:42:18 +00:00
|
|
|
delete agg; \
|
2007-04-10 22:05:41 +00:00
|
|
|
return 0; \
|
|
|
|
|
} \
|
|
|
|
|
return count; \
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#define NS_IMPL_AGGREGATED_HELPER(_class) \
|
|
|
|
|
NS_IMETHODIMP \
|
|
|
|
|
_class::QueryInterface(const nsIID& aIID, void** aInstancePtr) \
|
|
|
|
|
{ \
|
|
|
|
|
return fOuter->QueryInterface(aIID, aInstancePtr); \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) \
|
|
|
|
|
_class::AddRef(void) \
|
|
|
|
|
{ \
|
|
|
|
|
return fOuter->AddRef(); \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) \
|
|
|
|
|
_class::Release(void) \
|
|
|
|
|
{ \
|
|
|
|
|
return fOuter->Release(); \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
NS_IMETHODIMP \
|
|
|
|
|
_class::Internal::QueryInterface(const nsIID& aIID, void** aInstancePtr) \
|
|
|
|
|
{ \
|
|
|
|
|
_class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
|
|
|
|
|
return agg->AggregatedQueryInterface(aIID, aInstancePtr); \
|
|
|
|
|
} \
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* To make aggregated objects participate in cycle collection we need to enable
|
|
|
|
|
* the outer object (aggregator) to traverse/unlink the objects held by the
|
|
|
|
|
* inner object (the aggregatee). We can't just make the inner object QI'able to
|
|
|
|
|
* NS_CYCLECOLLECTIONPARTICIPANT_IID, we don't want to return the inner object's
|
|
|
|
|
* nsCycleCollectionParticipant for the outer object (which will happen if the
|
|
|
|
|
* outer object doesn't participate in cycle collection itself).
|
|
|
|
|
* NS_AGGREGATED_CYCLECOLLECTIONPARTICIPANT_IID enables the outer object to get
|
|
|
|
|
* the inner objects nsCycleCollectionParticipant.
|
|
|
|
|
*
|
|
|
|
|
* There are three cases:
|
|
|
|
|
* - No aggregation
|
|
|
|
|
* QI'ing to NS_CYCLECOLLECTIONPARTICIPANT_IID will return the inner
|
|
|
|
|
* object's nsCycleCollectionParticipant.
|
|
|
|
|
*
|
|
|
|
|
* - Aggregation and outer object does not participate in cycle collection
|
|
|
|
|
* QI'ing to NS_CYCLECOLLECTIONPARTICIPANT_IID will not return anything.
|
|
|
|
|
*
|
|
|
|
|
* - Aggregation and outer object does participate in cycle collection
|
|
|
|
|
* QI'ing to NS_CYCLECOLLECTIONPARTICIPANT_IID will return the outer
|
|
|
|
|
* object's nsCycleCollectionParticipant. The outer object's
|
|
|
|
|
* nsCycleCollectionParticipant can then QI the inner object to
|
|
|
|
|
* NS_AGGREGATED_CYCLECOLLECTIONPARTICIPANT_IID to get the inner object's
|
|
|
|
|
* nsCycleCollectionParticipant, which it can use to traverse/unlink the
|
|
|
|
|
* objects reachable from the inner object.
|
|
|
|
|
*/
|
|
|
|
|
#define NS_AGGREGATED_CYCLECOLLECTIONPARTICIPANT_IID \
|
|
|
|
|
{ \
|
|
|
|
|
0x32889b7e, \
|
|
|
|
|
0xe4fe, \
|
|
|
|
|
0x43f4, \
|
|
|
|
|
{ 0x85, 0x31, 0xb5, 0x28, 0x23, 0xa2, 0xe9, 0xfc } \
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Just holds the IID so NS_GET_IID works.
|
|
|
|
|
*/
|
|
|
|
|
class nsAggregatedCycleCollectionParticipant
|
|
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_AGGREGATED_CYCLECOLLECTIONPARTICIPANT_IID)
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(nsAggregatedCycleCollectionParticipant,
|
|
|
|
|
NS_AGGREGATED_CYCLECOLLECTIONPARTICIPANT_IID)
|
|
|
|
|
|
2000-01-10 23:14:32 +00:00
|
|
|
// for use with QI macros in nsISupportsUtils.h:
|
|
|
|
|
|
2002-10-03 19:41:42 +00:00
|
|
|
#define NS_INTERFACE_MAP_BEGIN_AGGREGATED(_class) \
|
|
|
|
|
NS_IMPL_AGGREGATED_QUERY_HEAD(_class)
|
|
|
|
|
|
2007-04-10 22:05:41 +00:00
|
|
|
#define NS_INTERFACE_MAP_ENTRY_CYCLE_COLLECTION_AGGREGATED(_class) \
|
|
|
|
|
NS_IMPL_QUERY_CYCLE_COLLECTION(_class)
|
|
|
|
|
|
|
|
|
|
#define NS_INTERFACE_MAP_ENTRIES_CYCLE_COLLECTION_AGGREGATED(_class) \
|
|
|
|
|
NS_INTERFACE_MAP_ENTRY_CYCLE_COLLECTION_AGGREGATED(_class) \
|
|
|
|
|
NS_INTERFACE_MAP_ENTRY_CYCLE_COLLECTION_ISUPPORTS(_class)
|
|
|
|
|
|
2001-07-31 19:05:34 +00:00
|
|
|
#define NS_IMPL_AGGREGATED_QUERY_HEAD(_class) \
|
2005-09-28 13:13:27 +00:00
|
|
|
nsresult \
|
2001-07-31 19:05:34 +00:00
|
|
|
_class::AggregatedQueryInterface(REFNSIID aIID, void** aInstancePtr) \
|
|
|
|
|
{ \
|
|
|
|
|
NS_ASSERTION(aInstancePtr, \
|
|
|
|
|
"AggregatedQueryInterface requires a non-NULL result ptr!"); \
|
|
|
|
|
if ( !aInstancePtr ) \
|
|
|
|
|
return NS_ERROR_NULL_POINTER; \
|
2005-09-28 13:13:27 +00:00
|
|
|
nsISupports* foundInterface; \
|
|
|
|
|
if ( aIID.Equals(NS_GET_IID(nsISupports)) ) \
|
|
|
|
|
foundInterface = InnerObject(); \
|
|
|
|
|
else
|
|
|
|
|
|
2007-04-10 22:05:41 +00:00
|
|
|
#define NS_IMPL_AGGREGATED_QUERY_CYCLE_COLLECTION(_class) \
|
|
|
|
|
if (aIID.Equals(IsPartOfAggregated() ? \
|
|
|
|
|
NS_GET_IID(nsCycleCollectionParticipant) : \
|
|
|
|
|
NS_GET_IID(nsAggregatedCycleCollectionParticipant))) \
|
|
|
|
|
foundInterface = & NS_CYCLE_COLLECTION_NAME(_class); \
|
|
|
|
|
else
|
|
|
|
|
|
|
|
|
|
#define NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_AGGREGATED(_class) \
|
|
|
|
|
NS_IMETHODIMP \
|
|
|
|
|
NS_CYCLE_COLLECTION_CLASSNAME(_class)::Traverse \
|
2007-05-24 14:10:02 +00:00
|
|
|
(void *p, \
|
2007-04-10 22:05:41 +00:00
|
|
|
nsCycleCollectionTraversalCallback &cb) \
|
|
|
|
|
{ \
|
2007-07-11 08:46:44 +00:00
|
|
|
nsISupports *s = static_cast<nsISupports*>(p); \
|
2007-05-24 14:10:02 +00:00
|
|
|
NS_ASSERTION(CheckForRightISupports(s), \
|
2007-04-10 22:05:41 +00:00
|
|
|
"not the nsISupports pointer we expect"); \
|
2007-07-11 08:46:44 +00:00
|
|
|
_class *tmp = static_cast<_class*>(Downcast(s)); \
|
2007-04-10 22:05:41 +00:00
|
|
|
if (!tmp->IsPartOfAggregated()) \
|
2009-05-07 18:19:36 +00:00
|
|
|
NS_IMPL_CYCLE_COLLECTION_DESCRIBE(_class, tmp->mRefCnt.get())
|
2007-04-10 22:05:41 +00:00
|
|
|
|
2005-09-28 13:13:27 +00:00
|
|
|
#define NS_GENERIC_AGGREGATED_CONSTRUCTOR(_InstanceClass) \
|
2010-06-10 18:11:11 +00:00
|
|
|
static nsresult \
|
2005-09-28 13:13:27 +00:00
|
|
|
_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
|
|
|
|
|
void **aResult) \
|
|
|
|
|
{ \
|
|
|
|
|
*aResult = nsnull; \
|
|
|
|
|
\
|
|
|
|
|
NS_ENSURE_PROPER_AGGREGATION(aOuter, aIID); \
|
|
|
|
|
\
|
|
|
|
|
_InstanceClass* inst = new _InstanceClass(aOuter); \
|
|
|
|
|
if (!inst) { \
|
|
|
|
|
return NS_ERROR_OUT_OF_MEMORY; \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
nsISupports* inner = inst->InnerObject(); \
|
|
|
|
|
nsresult rv = inner->QueryInterface(aIID, aResult); \
|
|
|
|
|
if (NS_FAILED(rv)) { \
|
|
|
|
|
delete inst; \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
return rv; \
|
|
|
|
|
} \
|
|
|
|
|
|
|
|
|
|
#define NS_GENERIC_AGGREGATED_CONSTRUCTOR_INIT(_InstanceClass, _InitMethod) \
|
2010-06-10 18:11:11 +00:00
|
|
|
static nsresult \
|
2005-09-28 13:13:27 +00:00
|
|
|
_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
|
|
|
|
|
void **aResult) \
|
|
|
|
|
{ \
|
|
|
|
|
*aResult = nsnull; \
|
|
|
|
|
\
|
|
|
|
|
NS_ENSURE_PROPER_AGGREGATION(aOuter, aIID); \
|
|
|
|
|
\
|
|
|
|
|
_InstanceClass* inst = new _InstanceClass(aOuter); \
|
|
|
|
|
if (!inst) { \
|
|
|
|
|
return NS_ERROR_OUT_OF_MEMORY; \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
nsISupports* inner = inst->InnerObject(); \
|
|
|
|
|
NS_ADDREF(inner); \
|
|
|
|
|
nsresult rv = inst->_InitMethod(); \
|
|
|
|
|
if (NS_SUCCEEDED(rv)) { \
|
|
|
|
|
rv = inner->QueryInterface(aIID, aResult); \
|
|
|
|
|
} \
|
|
|
|
|
NS_RELEASE(inner); \
|
|
|
|
|
\
|
|
|
|
|
return rv; \
|
|
|
|
|
} \
|
2000-01-10 23:14:32 +00:00
|
|
|
|
1998-10-19 17:48:55 +00:00
|
|
|
#endif /* nsAgg_h___ */
|
