/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: NPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Netscape 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/NPL/ * * 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 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 NPL, 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 NPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifndef nsIGenericFactory_h___ #define nsIGenericFactory_h___ #include "nsIFactory.h" // {3bc97f01-ccdf-11d2-bab8-b548654461fc} #define NS_GENERICFACTORY_CID \ { 0x3bc97f01, 0xccdf, 0x11d2, \ { 0xba, 0xb8, 0xb5, 0x48, 0x65, 0x44, 0x61, 0xfc } } // {3bc97f00-ccdf-11d2-bab8-b548654461fc} #define NS_IGENERICFACTORY_IID \ { 0x3bc97f00, 0xccdf, 0x11d2, \ { 0xba, 0xb8, 0xb5, 0x48, 0x65, 0x44, 0x61, 0xfc } } #define NS_GENERICFACTORY_CONTRACTID "@mozilla.org/generic-factory;1" #define NS_GENERICFACTORY_CLASSNAME "Generic Factory" struct nsModuleComponentInfo; // forward declaration /** * Provides a Generic nsIFactory implementation that can be used by * DLLs with very simple factory needs. */ class nsIGenericFactory : public nsIFactory { public: NS_DEFINE_STATIC_IID_ACCESSOR(NS_IGENERICFACTORY_IID) NS_IMETHOD SetComponentInfo(nsModuleComponentInfo *info) = 0; NS_IMETHOD GetComponentInfo(nsModuleComponentInfo **infop) = 0; }; extern NS_COM nsresult NS_NewGenericFactory(nsIGenericFactory **result, nsModuleComponentInfo *info); //////////////////////////////////////////////////////////////////////////////// // Generic Modules // // (See xpcom/sample/nsSampleModule.cpp to see how to use this.) #include "nsIModule.h" typedef NS_CALLBACK(NSConstructorProcPtr)(nsISupports *aOuter, REFNSIID aIID, void **aResult); typedef NS_CALLBACK(NSRegisterSelfProcPtr)(nsIComponentManager *aCompMgr, nsIFile *aPath, const char *aRegistryLocation, const char *aComponentType, const nsModuleComponentInfo *aInfo); typedef NS_CALLBACK(NSUnregisterSelfProcPtr)(nsIComponentManager *aCompMgr, nsIFile *aPath, const char *aRegistryLocation, const nsModuleComponentInfo *aInfo); typedef NS_CALLBACK(NSFactoryDestructorProcPtr)(void); typedef NS_CALLBACK(NSGetInterfacesProcPtr)(PRUint32 *countp, nsIID* **array); typedef NS_CALLBACK(NSGetLanguageHelperProcPtr)(PRUint32 language, nsISupports **helper); /** * Use this type to define a list of module component info to pass to * NS_NewGenericModule. E.g.: * static nsModuleComponentInfo components[] = { ... }; * See xpcom/sample/nsSampleModule.cpp for more info. */ struct nsModuleComponentInfo { const char* mDescription; nsCID mCID; const char* mContractID; NSConstructorProcPtr mConstructor; NSRegisterSelfProcPtr mRegisterSelfProc; NSUnregisterSelfProcPtr mUnregisterSelfProc; NSFactoryDestructorProcPtr mFactoryDestructor; NSGetInterfacesProcPtr mGetInterfacesProc; NSGetLanguageHelperProcPtr mGetLanguageHelperProc; nsIClassInfo ** mClassInfoGlobal; PRUint32 mFlags; }; typedef nsresult (PR_CALLBACK *nsModuleConstructorProc) (nsIModule *self); typedef void (PR_CALLBACK *nsModuleDestructorProc) (nsIModule *self); /** * Use this structure to define meta-information about the module * itself, including the name, its components, and an optional * module-level initialization or shutdown routine. */ struct nsModuleInfo { PRUint32 mVersion; const char* mModuleName; nsModuleComponentInfo* mComponents; PRUint32 mCount; nsModuleConstructorProc mCtor; nsModuleDestructorProc mDtor; }; /** * Rev this if you change the nsModuleInfo, and are worried about * binary compatibility. (Ostensibly fix NS_NewGenericModule2() to deal * with older rev's at the same time.) */ #define NS_MODULEINFO_VERSION 0x00010000UL // 1.0 /** * Create a new generic module. Use the NS_IMPL_NSGETMODULE macro, or * one of its relatives, rather than using this directly. */ extern NS_COM nsresult NS_NewGenericModule2(nsModuleInfo *info, nsIModule* *result); /** * Obsolete. Use NS_NewGenericModule2() instead. */ extern NS_COM nsresult NS_NewGenericModule(const char* moduleName, PRUint32 componentCount, nsModuleComponentInfo* components, nsModuleDestructorProc dtor, nsIModule* *result); #if defined(XPCOM_TRANSLATE_NSGM_ENTRY_POINT) # define NSMODULEINFO(_name) _name##_gModuleInfo # define NSGETMODULE_ENTRY_POINT(_info) #else # define NSMODULEINFO(_name) gModuleInfo # define NSGETMODULE_ENTRY_POINT(_info) \ extern "C" NS_EXPORT nsresult \ NSGetModule(nsIComponentManager *servMgr, \ nsIFile* location, \ nsIModule** result) \ { \ return NS_NewGenericModule2(&(_info), result); \ } #endif #define NS_IMPL_NSGETMODULE(_name, _components) \ NS_IMPL_NSGETMODULE_WITH_CTOR_DTOR(_name, _components, nsnull, nsnull) #define NS_IMPL_NSGETMODULE_WITH_CTOR(_name, _components, _ctor) \ NS_IMPL_NSGETMODULE_WITH_CTOR_DTOR(_name, _components, _ctor, nsnull) #define NS_IMPL_NSGETMODULE_WITH_DTOR(_name, _components, _dtor) \ NS_IMPL_NSGETMODULE_WITH_CTOR_DTOR(_name, _components, nsnull, _dtor) #define NS_IMPL_NSGETMODULE_WITH_CTOR_DTOR(_name, _components, _ctor, _dtor) \ nsModuleInfo NSMODULEINFO(_name) = { \ NS_MODULEINFO_VERSION, \ (#_name), \ (_components), \ (sizeof(_components) / sizeof(_components[0])), \ (_ctor), \ (_dtor) \ }; \ NSGETMODULE_ENTRY_POINT(NSMODULEINFO(_name)) //////////////////////////////////////////////////////////////////////////////// #define NS_GENERIC_FACTORY_CONSTRUCTOR(_InstanceClass) \ static NS_IMETHODIMP \ _InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \ void **aResult) \ { \ nsresult rv; \ \ _InstanceClass * inst; \ \ *aResult = NULL; \ if (NULL != aOuter) { \ rv = NS_ERROR_NO_AGGREGATION; \ return rv; \ } \ \ NS_NEWXPCOM(inst, _InstanceClass); \ if (NULL == inst) { \ rv = NS_ERROR_OUT_OF_MEMORY; \ return rv; \ } \ NS_ADDREF(inst); \ rv = inst->QueryInterface(aIID, aResult); \ NS_RELEASE(inst); \ \ return rv; \ } \ #define NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(_InstanceClass, _InitMethod) \ static NS_IMETHODIMP \ _InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \ void **aResult) \ { \ nsresult rv; \ \ _InstanceClass * inst; \ \ *aResult = NULL; \ if (NULL != aOuter) { \ rv = NS_ERROR_NO_AGGREGATION; \ return rv; \ } \ \ NS_NEWXPCOM(inst, _InstanceClass); \ if (NULL == inst) { \ rv = NS_ERROR_OUT_OF_MEMORY; \ return rv; \ } \ NS_ADDREF(inst); \ rv = inst->_InitMethod(); \ if(NS_SUCCEEDED(rv)) { \ rv = inst->QueryInterface(aIID, aResult); \ } \ NS_RELEASE(inst); \ \ return rv; \ } \ // 'Constructor' that uses an existing getter function that gets a singleton. // NOTE: assumes that getter does an AddRef - so additional AddRef is not done. #define NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR(_InstanceClass, _GetterProc) \ static NS_IMETHODIMP \ _InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \ void **aResult) \ { \ nsresult rv; \ \ _InstanceClass * inst; \ \ *aResult = NULL; \ if (NULL != aOuter) { \ rv = NS_ERROR_NO_AGGREGATION; \ return rv; \ } \ \ inst = _GetterProc(); \ if (NULL == inst) { \ rv = NS_ERROR_OUT_OF_MEMORY; \ return rv; \ } \ /* NS_ADDREF(inst); */ \ rv = inst->QueryInterface(aIID, aResult); \ NS_RELEASE(inst); \ \ return rv; \ } \ #endif /* nsIGenericFactory_h___ */