gecko-dev/xpcom/glue/nsComponentManagerUtils.h
Ehsan Akhgari 9297631e0b Bug 1114880 follow-up: Rename MOZ_{STRONG,WEAK}_REF to MOZ_{OWNING,NON_OWNING}_REF
--HG--
extra : rebase_source : 51fff0785d112b5b87be3c6ff723c8986b37effe
2014-12-23 21:17:50 -05:00

276 lines
7.9 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
#ifndef nsComponentManagerUtils_h__
#define nsComponentManagerUtils_h__
#include "nscore.h"
#include "nsCOMPtr.h"
#include "nsIFactory.h"
nsresult CallCreateInstance(const nsCID& aClass, nsISupports* aDelegate,
const nsIID& aIID, void** aResult);
nsresult CallCreateInstance(const char* aContractID, nsISupports* aDelegate,
const nsIID& aIID, void** aResult);
nsresult CallGetClassObject(const nsCID& aClass, const nsIID& aIID,
void** aResult);
nsresult CallGetClassObject(const char* aContractID, const nsIID& aIID,
void** aResult);
class nsCreateInstanceByCID : public nsCOMPtr_helper
{
public:
nsCreateInstanceByCID(const nsCID& aCID, nsISupports* aOuter,
nsresult* aErrorPtr)
: mCID(aCID)
, mOuter(aOuter)
, mErrorPtr(aErrorPtr)
{
}
virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const;
private:
const nsCID& mCID;
nsISupports* MOZ_NON_OWNING_REF mOuter;
nsresult* mErrorPtr;
};
class nsCreateInstanceByContractID : public nsCOMPtr_helper
{
public:
nsCreateInstanceByContractID(const char* aContractID, nsISupports* aOuter,
nsresult* aErrorPtr)
: mContractID(aContractID)
, mOuter(aOuter)
, mErrorPtr(aErrorPtr)
{
}
virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const;
private:
const char* mContractID;
nsISupports* MOZ_NON_OWNING_REF mOuter;
nsresult* mErrorPtr;
};
class nsCreateInstanceFromFactory : public nsCOMPtr_helper
{
public:
nsCreateInstanceFromFactory(nsIFactory* aFactory, nsISupports* aOuter,
nsresult* aErrorPtr)
: mFactory(aFactory)
, mOuter(aOuter)
, mErrorPtr(aErrorPtr)
{
}
virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const;
private:
nsIFactory* MOZ_NON_OWNING_REF mFactory;
nsISupports* MOZ_NON_OWNING_REF mOuter;
nsresult* mErrorPtr;
};
inline const nsCreateInstanceByCID
do_CreateInstance(const nsCID& aCID, nsresult* aError = 0)
{
return nsCreateInstanceByCID(aCID, 0, aError);
}
inline const nsCreateInstanceByCID
do_CreateInstance(const nsCID& aCID, nsISupports* aOuter, nsresult* aError = 0)
{
return nsCreateInstanceByCID(aCID, aOuter, aError);
}
inline const nsCreateInstanceByContractID
do_CreateInstance(const char* aContractID, nsresult* aError = 0)
{
return nsCreateInstanceByContractID(aContractID, 0, aError);
}
inline const nsCreateInstanceByContractID
do_CreateInstance(const char* aContractID, nsISupports* aOuter,
nsresult* aError = 0)
{
return nsCreateInstanceByContractID(aContractID, aOuter, aError);
}
inline const nsCreateInstanceFromFactory
do_CreateInstance(nsIFactory* aFactory, nsresult* aError = 0)
{
return nsCreateInstanceFromFactory(aFactory, 0, aError);
}
inline const nsCreateInstanceFromFactory
do_CreateInstance(nsIFactory* aFactory, nsISupports* aOuter,
nsresult* aError = 0)
{
return nsCreateInstanceFromFactory(aFactory, aOuter, aError);
}
class nsGetClassObjectByCID : public nsCOMPtr_helper
{
public:
nsGetClassObjectByCID(const nsCID& aCID, nsresult* aErrorPtr)
: mCID(aCID)
, mErrorPtr(aErrorPtr)
{
}
virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const;
private:
const nsCID& mCID;
nsresult* mErrorPtr;
};
class nsGetClassObjectByContractID : public nsCOMPtr_helper
{
public:
nsGetClassObjectByContractID(const char* aContractID, nsresult* aErrorPtr)
: mContractID(aContractID)
, mErrorPtr(aErrorPtr)
{
}
virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const;
private:
const char* mContractID;
nsresult* mErrorPtr;
};
/**
* do_GetClassObject can be used to improve performance of callers
* that call |CreateInstance| many times. They can cache the factory
* and call do_CreateInstance or CallCreateInstance with the cached
* factory rather than having the component manager retrieve it every
* time.
*/
inline const nsGetClassObjectByCID
do_GetClassObject(const nsCID& aCID, nsresult* aError = 0)
{
return nsGetClassObjectByCID(aCID, aError);
}
inline const nsGetClassObjectByContractID
do_GetClassObject(const char* aContractID, nsresult* aError = 0)
{
return nsGetClassObjectByContractID(aContractID, aError);
}
// type-safe shortcuts for calling |CreateInstance|
template<class DestinationType>
inline nsresult
CallCreateInstance(const nsCID& aClass,
nsISupports* aDelegate,
DestinationType** aDestination)
{
NS_PRECONDITION(aDestination, "null parameter");
return CallCreateInstance(aClass, aDelegate,
NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
template<class DestinationType>
inline nsresult
CallCreateInstance(const nsCID& aClass, DestinationType** aDestination)
{
NS_PRECONDITION(aDestination, "null parameter");
return CallCreateInstance(aClass, nullptr,
NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
template<class DestinationType>
inline nsresult
CallCreateInstance(const char* aContractID,
nsISupports* aDelegate,
DestinationType** aDestination)
{
NS_PRECONDITION(aContractID, "null parameter");
NS_PRECONDITION(aDestination, "null parameter");
return CallCreateInstance(aContractID,
aDelegate,
NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
template<class DestinationType>
inline nsresult
CallCreateInstance(const char* aContractID, DestinationType** aDestination)
{
NS_PRECONDITION(aContractID, "null parameter");
NS_PRECONDITION(aDestination, "null parameter");
return CallCreateInstance(aContractID, nullptr,
NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
template<class DestinationType>
inline nsresult
CallCreateInstance(nsIFactory* aFactory,
nsISupports* aDelegate,
DestinationType** aDestination)
{
NS_PRECONDITION(aFactory, "null parameter");
NS_PRECONDITION(aDestination, "null parameter");
return aFactory->CreateInstance(aDelegate,
NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
template<class DestinationType>
inline nsresult
CallCreateInstance(nsIFactory* aFactory, DestinationType** aDestination)
{
NS_PRECONDITION(aFactory, "null parameter");
NS_PRECONDITION(aDestination, "null parameter");
return aFactory->CreateInstance(nullptr,
NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
template<class DestinationType>
inline nsresult
CallGetClassObject(const nsCID& aClass, DestinationType** aDestination)
{
NS_PRECONDITION(aDestination, "null parameter");
return CallGetClassObject(aClass, NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
template<class DestinationType>
inline nsresult
CallGetClassObject(const char* aContractID, DestinationType** aDestination)
{
NS_PRECONDITION(aDestination, "null parameter");
return CallGetClassObject(aContractID, NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
#endif /* nsComponentManagerUtils_h__ */