Files
Mozilla/mozilla/dom/public/nsIDOMScriptObjectFactory.h
mhammond%skippinet.com.au dea949c488 Update the IID for this interface we changed.
git-svn-id: svn://10.0.0.236/branches/DOM_AGNOSTIC_BRANCH@179887 18797224-902f-48f8-a5cc-f745e15eee43
2005-09-09 02:32:39 +00:00

112 lines
5.1 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla 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/MPL/
*
* 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 of 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 MPL, 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 MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef nsIDOMScriptObjectFactory_h__
#define nsIDOMScriptObjectFactory_h__
#include "nsISupports.h"
#include "nsIDOMClassInfo.h"
#include "nsString.h"
#define NS_IDOM_SCRIPT_OBJECT_FACTORY_IID \
{ /* {38EC7717-6CBE-44a8-B2BB-53F2BA998B31} */ \
0x38ec7717, 0x6cbe, 0x44a8, \
{ 0xb2, 0xbb, 0x53, 0xf2, 0xba, 0x99, 0x8b, 0x31 } }
class nsIScriptContext;
class nsIScriptGlobalObject;
class nsILanguageRuntime;
class nsIDOMEventListener;
class nsIDOMScriptObjectFactory : public nsISupports {
public:
NS_DEFINE_STATIC_IID_ACCESSOR(NS_IDOM_SCRIPT_OBJECT_FACTORY_IID)
// Get a script language given its "name" (ie, the mime-type)
// See below - we should consider having the JS code still register
// as a component (using the simple name 'javascript', for example).
// We would still keep the mime-type matching for JS external, but it would
// then allow this module to work correctly with JS, and remove the JS
// dependency from this interface.
// NOTE: Only works for "pluggable" languages - does *not* work for
// javascript - the mime-type handling for JS remains external to this for
// perf reasons. If you want javascript, use GetLanguageByID.
NS_IMETHOD GetLanguageRuntime(const nsAString &aLanguageName,
nsILanguageRuntime **aLanguage) = 0;
// Get a script language given its nsIProgrammingLanguage ID. Note that for
// languages other than javascript, if the language has not previosly been
// loaded by name, the factory will instantiate *all* registered
// nsILanguageRuntime components to match the ID (we have no way of mapping
// language IDs directly to contract IDs.)
NS_IMETHOD GetLanguageRuntimeByID(PRUint32 aLanguageID,
nsILanguageRuntime **aLanguage) = 0;
// Get the ID for a language given its name - but like GetScriptLanguage,
// *not* for javascript.
NS_IMETHOD GetIDForLanguage(const nsAString &aLanguageName,
PRUint32 *aLanguageID) = 0;
NS_IMETHOD NewScriptGlobalObject(PRBool aIsChrome,
nsIScriptGlobalObject **aGlobal) = 0;
NS_IMETHOD_(nsISupports *)GetClassInfoInstance(nsDOMClassInfoID aID) = 0;
NS_IMETHOD_(nsISupports *)GetExternalClassInfoInstance(const nsAString& aName) = 0;
// Register the info for an external class. aName must be static
// data, it will not be deleted by the DOM code. aProtoChainInterface
// must be registered in the JAVASCRIPT_DOM_INTERFACE category, or
// prototypes for this class won't work (except if the interface
// name starts with nsIDOM).
NS_IMETHOD RegisterDOMClassInfo(const char *aName,
nsDOMClassInfoExternalConstructorFnc aConstructorFptr,
const nsIID *aProtoChainInterface,
const nsIID **aInterfaces,
PRUint32 aScriptableFlags,
PRBool aHasClassInterface,
const nsCID *aConstructorCID) = 0;
};
/* helper functions */
nsresult NS_GetLanguageRuntime(const nsAString &aLanguageName,
nsILanguageRuntime **aLanguage);
nsresult NS_GetLanguageRuntimeByID(PRUint32 aLanguageID,
nsILanguageRuntime **aLanguage);
#endif /* nsIDOMScriptObjectFactory_h__ */