xpcom/components/nsStaticComponentLoader.h

   1 /* -*- Mode: C++; tab-width: 8; 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. This file was copied
  16  * from nsStaticComponentLoader.cpp
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2000
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Benjamin Smedberg <benjamin@smedbergs.us>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsStaticModuleLoader_h__
  41 #define nsStaticModuleLoader_h__
  42
  43 #include "nsXPCOM.h"
  44 #include "pldhash.h"
  45 #include "nsTArray.h"
  46
  47 class nsIModule;
  48 struct StaticModuleInfo;
  49 class nsComponentManagerImpl;
  50 struct DeferredModule;
  51
  52 typedef void (*StaticLoaderCallback)(const char               *key,
  53                                      nsIModule*                module,
  54                                      nsTArray<DeferredModule> &deferred);
  55
  56 class nsStaticModuleLoader
  57 {
  58 public:
  59     nsStaticModuleLoader() :
  60         mFirst(nsnull)
  61     { }
  62
  63     ~nsStaticModuleLoader() { }
  64
  65     nsresult Init(nsStaticModuleInfo const *aStaticModules,
  66                   PRUint32 aModuleCount);
  67
  68     void ReleaseModules() {
  69         if (mInfoHash.ops)
  70             PL_DHashTableFinish(&mInfoHash);
  71     }
  72
  73     void EnumerateModules(StaticLoaderCallback      cb,
  74                           nsTArray<DeferredModule> &deferred);
  75     nsresult GetModuleFor(const char *key, nsIModule* *aResult);
  76
  77 private:
  78     PLDHashTable                  mInfoHash;
  79     static PLDHashTableOps        sInfoHashOps;
  80     StaticModuleInfo             *mFirst;
  81 };
  82
  83 #endif