xpcom/glue/nsGenericFactory.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsGenericFactory_h___
  39 #define nsGenericFactory_h___
  40
  41 #include "nsCOMPtr.h"
  42 #include "nsIGenericFactory.h"
  43 #include "nsIClassInfo.h"
  44
  45 /**
  46  * Most factories follow this simple pattern, so why not just use a function
  47  * pointer for most creation operations?
  48  */
  49 class nsGenericFactory : public nsIGenericFactory, public nsIClassInfo {
  50 public:
  51     NS_DEFINE_STATIC_CID_ACCESSOR(NS_GENERICFACTORY_CID)
  52
  53     nsGenericFactory(const nsModuleComponentInfo *info = NULL);
  54
  55     NS_DECL_ISUPPORTS
  56     NS_DECL_NSICLASSINFO
  57
  58     /* nsIGenericFactory methods */
  59     NS_IMETHOD SetComponentInfo(const nsModuleComponentInfo *info);
  60     NS_IMETHOD GetComponentInfo(const nsModuleComponentInfo **infop);
  61
  62     NS_IMETHOD CreateInstance(nsISupports *aOuter, REFNSIID aIID, void **aResult);
  63
  64     NS_IMETHOD LockFactory(PRBool aLock);
  65
  66     static NS_METHOD Create(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr);
  67 private:
  68     ~nsGenericFactory();
  69
  70     const nsModuleComponentInfo *mInfo;
  71 };
  72
  73 ////////////////////////////////////////////////////////////////////////////////
  74
  75 #include "nsIModule.h"
  76 #include "plhash.h"
  77
  78 class nsGenericModule : public nsIModule
  79 {
  80 public:
  81     nsGenericModule(const char* moduleName,
  82                     PRUint32 componentCount,
  83                     const nsModuleComponentInfo* components,
  84                     nsModuleConstructorProc ctor,
  85                     nsModuleDestructorProc dtor);
  86
  87 private:
  88     ~nsGenericModule();
  89
  90 public:
  91     NS_DECL_ISUPPORTS
  92
  93     NS_DECL_NSIMODULE
  94
  95     struct FactoryNode
  96     {
  97         FactoryNode(nsIGenericFactory* fact, FactoryNode* next)
  98         {
  99             mFactory = fact;
 100             mNext    = next;
 101         }
 102         ~FactoryNode(){}
 103
 104         nsCOMPtr<nsIGenericFactory> mFactory;
 105         FactoryNode* mNext;
 106     };
 107
 108
 109
 110
 111 protected:
 112     nsresult Initialize(nsIComponentManager* compMgr);
 113
 114     void Shutdown();
 115     nsresult AddFactoryNode(nsIGenericFactory* fact);
 116
 117     PRBool                       mInitialized;
 118     const char*                  mModuleName;
 119     PRUint32                     mComponentCount;
 120     const nsModuleComponentInfo* mComponents;
 121     FactoryNode*                 mFactoriesNotToBeRegistered;
 122     nsModuleConstructorProc      mCtor;
 123     nsModuleDestructorProc       mDtor;
 124 };
 125
 126 #endif /* nsGenericFactory_h___ */
 127