dom/base/nsIDOMScriptObjectFactory.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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 nsIDOMScriptObjectFactory_h__
  39 #define nsIDOMScriptObjectFactory_h__
  40
  41 #include "nsISupports.h"
  42 #include "nsIDOMClassInfo.h"
  43 #include "nsStringGlue.h"
  44
  45 #define NS_IDOM_SCRIPT_OBJECT_FACTORY_IID   \
  46 { 0x8c0eb687, 0xa859, 0x4a62, \
  47  { 0x99, 0x82, 0xea, 0xbf, 0x9e, 0xf5, 0x59, 0x5f } }
  48
  49 class nsIScriptContext;
  50 class nsIScriptGlobalObject;
  51 class nsIScriptRuntime;
  52 class nsIDOMEventListener;
  53
  54 typedef nsXPCClassInfo* (*nsDOMClassInfoExternalConstructorFnc)
  55   (const char* aName);
  56
  57 class nsIDOMScriptObjectFactory : public nsISupports {
  58 public:
  59   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDOM_SCRIPT_OBJECT_FACTORY_IID)
  60
  61   // Get a script language given its "name" (ie, the mime-type)
  62   // Note that to fetch javascript from this function, you must currently
  63   // use the name "application/javascript" (but also note that all existing
  64   // callers of this function optimize the detection of JS, so do not
  65   // ask this function for JS)
  66   NS_IMETHOD GetScriptRuntime(const nsAString &aLanguageName,
  67                               nsIScriptRuntime **aLanguage) = 0;
  68
  69   // Get a script language given its nsIProgrammingLanguage ID.
  70   NS_IMETHOD GetScriptRuntimeByID(PRUint32 aScriptTypeID,
  71                                   nsIScriptRuntime **aLanguage) = 0;
  72
  73   // Get the ID for a language given its name - but like GetScriptRuntime,
  74   // only "application/javascript" is currently supported for JS.
  75   NS_IMETHOD GetIDForScriptType(const nsAString &aLanguageName,
  76                                 PRUint32 *aScriptTypeID) = 0;
  77
  78   NS_IMETHOD NewScriptGlobalObject(PRBool aIsChrome,
  79                                    PRBool aIsModalContentWindow,
  80                                    nsIScriptGlobalObject **aGlobal) = 0;
  81
  82   NS_IMETHOD_(nsISupports *) GetClassInfoInstance(nsDOMClassInfoID aID) = 0;
  83   NS_IMETHOD_(nsISupports *) GetExternalClassInfoInstance(const nsAString& aName) = 0;
  84
  85   // Register the info for an external class. aName must be static
  86   // data, it will not be deleted by the DOM code. aProtoChainInterface
  87   // must be registered in the JAVASCRIPT_DOM_INTERFACE category, or
  88   // prototypes for this class won't work (except if the interface
  89   // name starts with nsIDOM).
  90   NS_IMETHOD RegisterDOMClassInfo(const char *aName,
  91                                   nsDOMClassInfoExternalConstructorFnc aConstructorFptr,
  92                                   const nsIID *aProtoChainInterface,
  93                                   const nsIID **aInterfaces,
  94                                   PRUint32 aScriptableFlags,
  95                                   PRBool aHasClassInterface,
  96                                   const nsCID *aConstructorCID) = 0;
  97 };
  98
  99 NS_DEFINE_STATIC_IID_ACCESSOR(nsIDOMScriptObjectFactory,
 100                               NS_IDOM_SCRIPT_OBJECT_FACTORY_IID)
 101
 102 #endif /* nsIDOMScriptObjectFactory_h__ */