зеркало из https://github.com/mozilla/pjs.git
173 строки
6.6 KiB
C++
173 строки
6.6 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=2 sw=2 et tw=80: */
|
|
/* ***** 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 nsIScriptGlobalObject_h__
|
|
#define nsIScriptGlobalObject_h__
|
|
|
|
#include "nsISupports.h"
|
|
#include "nsEvent.h"
|
|
#include "nsIProgrammingLanguage.h"
|
|
|
|
class nsIScriptContext;
|
|
class nsIDOMDocument;
|
|
class nsIDOMEvent;
|
|
class nsIScriptGlobalObjectOwner;
|
|
class nsIArray;
|
|
class nsScriptErrorEvent;
|
|
class nsIScriptGlobalObject;
|
|
struct JSObject; // until we finally remove GetGlobalJSObject...
|
|
|
|
// Some helpers for working with integer "script type IDs", and specifically
|
|
// for working with arrays of such objects. For example, it is common for
|
|
// implementations supporting multiple script languages to keep each
|
|
// language's nsIScriptContext in an array indexed by the language ID.
|
|
|
|
// Implementation note: We always ignore nsIProgrammingLanguage::UNKNOWN and
|
|
// nsIProgrammingLanguage::CPLUSPLUS - this gives javascript slot 0. An
|
|
// attempted micro-optimization tried to avoid us going all the way to
|
|
// nsIProgrammingLanguage::MAX; however:
|
|
// * Someone is reportedly working on a PHP impl - that has value 9
|
|
// * nsGenericElement therefore allows 4 bits for the value.
|
|
// So there is no good reason for us to be more restrictive again...
|
|
|
|
#define NS_STID_FIRST nsIProgrammingLanguage::JAVASCRIPT
|
|
// like nsGenericElement, only 4 bits worth is valid...
|
|
#define NS_STID_LAST (nsIProgrammingLanguage::MAX > 0x000FU ? \
|
|
0x000FU : nsIProgrammingLanguage::MAX)
|
|
|
|
// Use to declare the array size
|
|
#define NS_STID_ARRAY_UBOUND (NS_STID_LAST-NS_STID_FIRST+1)
|
|
|
|
// Is a language ID valid?
|
|
#define NS_STID_VALID(langID) (langID >= NS_STID_FIRST && langID <= NS_STID_LAST)
|
|
|
|
// Return an index for a given ID.
|
|
#define NS_STID_INDEX(langID) (langID-NS_STID_FIRST)
|
|
|
|
// Create a 'for' loop iterating over all possible language IDs (*not* indexes)
|
|
#define NS_STID_FOR_ID(varName) \
|
|
for (varName=NS_STID_FIRST;varName<=NS_STID_LAST;varName++)
|
|
|
|
// Create a 'for' loop iterating over all indexes (when you don't need to know
|
|
// what language it is)
|
|
#define NS_STID_FOR_INDEX(varName) \
|
|
for (varName=0;varName<=NS_STID_INDEX(NS_STID_LAST);varName++)
|
|
|
|
// A helper function for nsIScriptGlobalObject implementations to use
|
|
// when handling a script error. Generally called by the global when a context
|
|
// notifies it of an error via nsIScriptGlobalObject::HandleScriptError.
|
|
// Returns true if HandleDOMEvent was actually called, in which case
|
|
// aStatus will be filled in with the status.
|
|
bool
|
|
NS_HandleScriptError(nsIScriptGlobalObject *aScriptGlobal,
|
|
nsScriptErrorEvent *aErrorEvent,
|
|
nsEventStatus *aStatus);
|
|
|
|
|
|
#define NS_ISCRIPTGLOBALOBJECT_IID \
|
|
{ 0x8f19a761, 0x0717, 0x4b3f, \
|
|
{ 0x80, 0xc5, 0xed, 0x7e, 0x9c, 0xbc, 0x40, 0xb1 } }
|
|
|
|
/**
|
|
* The global object which keeps a script context for each supported script
|
|
* language. This often used to store per-window global state.
|
|
*/
|
|
|
|
class nsIScriptGlobalObject : public nsISupports
|
|
{
|
|
public:
|
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCRIPTGLOBALOBJECT_IID)
|
|
|
|
/**
|
|
* Ensure that the script global object is initialized for working with the
|
|
* specified script language ID. This will set up the nsIScriptContext
|
|
* and 'script global' for that language, allowing these to be fetched
|
|
* and manipulated.
|
|
* @return NS_OK if successful; error conditions include that the language
|
|
* has not been registered, as well as 'normal' errors, such as
|
|
* out-of-memory
|
|
*/
|
|
virtual nsresult EnsureScriptEnvironment() = 0;
|
|
/**
|
|
* Get a script context (WITHOUT added reference) for the specified language.
|
|
*/
|
|
virtual nsIScriptContext *GetScriptContext() = 0;
|
|
|
|
virtual JSObject* GetGlobalJSObject() = 0;
|
|
|
|
virtual nsIScriptContext *GetContext() {
|
|
return GetScriptContext();
|
|
}
|
|
|
|
/**
|
|
* Set a new language context for this global. The native global for the
|
|
* context is created by the context's GetNativeGlobal() method.
|
|
*/
|
|
|
|
virtual nsresult SetScriptContext(nsIScriptContext *aContext) = 0;
|
|
|
|
/**
|
|
* Called when the global script for a language is finalized, typically as
|
|
* part of its GC process. By the time this call is made, the
|
|
* nsIScriptContext for the language has probably already been removed.
|
|
* After this call, the passed object is dead - which should generally be the
|
|
* same object the global is using for a global for that language.
|
|
*/
|
|
virtual void OnFinalize(JSObject* aObject) = 0;
|
|
|
|
/**
|
|
* Called to enable/disable scripts.
|
|
*/
|
|
virtual void SetScriptsEnabled(bool aEnabled, bool aFireTimeouts) = 0;
|
|
|
|
/**
|
|
* Handle a script error. Generally called by a script context.
|
|
*/
|
|
virtual nsresult HandleScriptError(nsScriptErrorEvent *aErrorEvent,
|
|
nsEventStatus *aEventStatus) {
|
|
return NS_HandleScriptError(this, aErrorEvent, aEventStatus);
|
|
}
|
|
|
|
virtual bool IsBlackForCC() { return false; }
|
|
};
|
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(nsIScriptGlobalObject,
|
|
NS_ISCRIPTGLOBALOBJECT_IID)
|
|
|
|
#endif
|