dom/base/nsScriptNameSpaceManager.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Communicator client code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1998
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK *****
  38  *
  39  *
  40  * This Original Code has been modified by IBM Corporation.
  41  * Modifications made by IBM described herein are
  42  * Copyright (c) International Business Machines
  43  * Corporation, 2000
  44  *
  45  * Modifications to Mozilla code or documentation
  46  * identified per MPL Section 3.3
  47  *
  48  * Date         Modified by     Description of modification
  49  * 03/27/2000   IBM Corp.       Added PR_CALLBACK for Optlink
  50  *                               use in OS2
  51  */
  52
  53 #ifndef nsScriptNameSpaceManager_h__
  54 #define nsScriptNameSpaceManager_h__
  55
  56 #include "nsIScriptNameSpaceManager.h"
  57 #include "nsString.h"
  58 #include "nsID.h"
  59 #include "pldhash.h"
  60 #include "nsDOMClassInfo.h"
  61 #include "nsIObserver.h"
  62 #include "nsWeakReference.h"
  63
  64
  65 struct nsGlobalNameStruct
  66 {
  67   struct ConstructorAlias
  68   {
  69     nsCID mCID;
  70     nsString mProtoName;
  71     nsGlobalNameStruct* mProto;
  72   };
  73
  74   enum nametype {
  75     eTypeNotInitialized,
  76     eTypeInterface,
  77     eTypeProperty,
  78     eTypeExternalConstructor,
  79     eTypeStaticNameSet,
  80     eTypeDynamicNameSet,
  81     eTypeClassConstructor,
  82     eTypeClassProto,
  83     eTypeExternalClassInfoCreator,
  84     eTypeExternalClassInfo,
  85     eTypeExternalConstructorAlias
  86   } mType;
  87
  88   PRBool mChromeOnly;
  89
  90   union {
  91     PRInt32 mDOMClassInfoID; // eTypeClassConstructor
  92     nsIID mIID; // eTypeInterface, eTypeClassProto
  93     nsExternalDOMClassInfoData* mData; // eTypeExternalClassInfo
  94     ConstructorAlias* mAlias; // eTypeExternalConstructorAlias
  95     nsCID mCID; // All other types...
  96   };
  97
  98 private:
  99
 100   // copy constructor
 101 };
 102
 103
 104 class nsIScriptContext;
 105 class nsICategoryManager;
 106 class GlobalNameMapEntry;
 107
 108
 109 class nsScriptNameSpaceManager : public nsIObserver,
 110                                  public nsSupportsWeakReference
 111 {
 112 public:
 113   NS_DECL_ISUPPORTS
 114   NS_DECL_NSIOBSERVER
 115
 116   nsScriptNameSpaceManager();
 117   virtual ~nsScriptNameSpaceManager();
 118
 119   nsresult Init();
 120   nsresult InitForContext(nsIScriptContext *aContext);
 121
 122   // Returns a nsGlobalNameStruct for aName, or null if one is not
 123   // found. The returned nsGlobalNameStruct is only guaranteed to be
 124   // valid until the next call to any of the methods in this class.
 125   // It also returns a pointer to the string buffer of the classname
 126   // in the nsGlobalNameStruct.
 127   nsresult LookupName(const nsAString& aName,
 128                       const nsGlobalNameStruct **aNameStruct,
 129                       const PRUnichar **aClassName = nsnull);
 130
 131   nsresult RegisterClassName(const char *aClassName,
 132                              PRInt32 aDOMClassInfoID,
 133                              PRBool aPrivileged,
 134                              const PRUnichar **aResult);
 135
 136   nsresult RegisterClassProto(const char *aClassName,
 137                               const nsIID *aConstructorProtoIID,
 138                               PRBool *aFoundOld);
 139
 140   nsresult RegisterExternalInterfaces(PRBool aAsProto);
 141
 142   nsresult RegisterExternalClassName(const char *aClassName,
 143                                      nsCID& aCID);
 144
 145   // Register the info for an external class. aName must be static
 146   // data, it will not be deleted by the DOM code.
 147   nsresult RegisterDOMCIData(const char *aName,
 148                              nsDOMClassInfoExternalConstructorFnc aConstructorFptr,
 149                              const nsIID *aProtoChainInterface,
 150                              const nsIID **aInterfaces,
 151                              PRUint32 aScriptableFlags,
 152                              PRBool aHasClassInterface,
 153                              const nsCID *aConstructorCID);
 154
 155   nsGlobalNameStruct* GetConstructorProto(const nsGlobalNameStruct* aStruct);
 156
 157 protected:
 158   // Adds a new entry to the hash and returns the nsGlobalNameStruct
 159   // that aKey will be mapped to. If mType in the returned
 160   // nsGlobalNameStruct is != eTypeNotInitialized, an entry for aKey
 161   // already existed.
 162   nsGlobalNameStruct *AddToHash(const char *aKey,
 163                                 const PRUnichar **aClassName = nsnull);
 164
 165   nsresult FillHash(nsICategoryManager *aCategoryManager,
 166                     const char *aCategory);
 167   nsresult FillHashWithDOMInterfaces();
 168   nsresult RegisterInterface(const char* aIfName,
 169                              const nsIID *aIfIID,
 170                              PRBool* aFoundOld);
 171
 172   /**
 173    * Add a new category entry into the hash table.
 174    *
 175    * @aCategoryManager Instance of the category manager service.
 176    * @aCategory        Category where the entry comes from.
 177    * @aEntry           The entry that should be added.
 178    */
 179   nsresult AddCategoryEntryToHash(nsICategoryManager* aCategoryManager,
 180                                   const char* aCategory,
 181                                   nsISupports* aEntry);
 182
 183   // Inline PLDHashTable, init with PL_DHashTableInit() and delete
 184   // with PL_DHashTableFinish().
 185   PLDHashTable mGlobalNames;
 186
 187   PRPackedBool mIsInitialized;
 188 };
 189
 190 #endif /* nsScriptNameSpaceManager_h__ */