dom/base/nsIScriptObjectOwner.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 nsIScriptObjectOwner_h__
  39 #define nsIScriptObjectOwner_h__
  40
  41 #include "nsISupports.h"
  42 #include "nsIScriptContext.h"
  43 #include "nsAString.h"
  44
  45 class nsScriptObjectHolder;
  46
  47 #define NS_ISCRIPTOBJECTOWNER_IID \
  48 { /* 8f6bca7e-ce42-11d1-b724-00600891d8c9 */ \
  49 0x8f6bca7e, 0xce42, 0x11d1, \
  50   {0xb7, 0x24, 0x00, 0x60, 0x08, 0x91, 0xd8, 0xc9} } \
  51
  52 /**
  53  * Creates a link between the script object and its native implementation
  54  *<P>
  55  * Every object that wants to be exposed in a script environment should
  56  * implement this interface. This interface should guarantee that the same
  57  * script object is returned in the context of the same script.
  58  * <P><I>It does have a bit too much java script information now, that
  59  * should be removed in a short time. Ideally this interface will be
  60  * language neutral</I>
  61  */
  62 class nsIScriptObjectOwner : public nsISupports {
  63 public:
  64   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCRIPTOBJECTOWNER_IID)
  65
  66   /**
  67    * Return the script object associated with this object.
  68    * Create a script object if not present.
  69    *
  70    * @param aContext the context the script object has to be created in
  71    * @param aScriptObject on return will contain the script object
  72    *
  73    * @return nsresult NS_OK if the script object is successfully returned
  74    *
  75    **/
  76   NS_IMETHOD GetScriptObject(nsIScriptContext *aContext, void** aScriptObject) = 0;
  77
  78   /**
  79    * Set the script object associated with this object.
  80    * Often used to either reset the object to null or initially
  81    * set it in cases where the object comes before the owner.
  82    *
  83    * @param aScriptObject the script object to set
  84    *
  85    * @return nsresult NS_OK if the script object is successfully set
  86    *
  87    **/
  88   NS_IMETHOD SetScriptObject(void* aScriptObject) = 0;
  89 };
  90
  91 NS_DEFINE_STATIC_IID_ACCESSOR(nsIScriptObjectOwner,
  92                               NS_ISCRIPTOBJECTOWNER_IID)
  93
  94 class nsIAtom;
  95
  96 #define NS_ISCRIPTEVENTHANDLEROWNER_IID \
  97 { /* 2ad54ae0-a839-11d3-ba97-00104ba02d3d */ \
  98 0x2ad54ae0, 0xa839, 0x11d3, \
  99   {0xba, 0x97, 0x00, 0x10, 0x4b, 0xa0, 0x2d, 0x3d} }
 100
 101 /**
 102  * Associate a compiled event handler with its target object, which owns it
 103  * This is an adjunct to nsIScriptObjectOwner that nsIEventListenerManager's
 104  * implementation queries for, in order to avoid recompiling a recurrent or
 105  * prototype-inherited event handler.
 106  */
 107 class nsIScriptEventHandlerOwner : public nsISupports
 108 {
 109 public:
 110   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCRIPTEVENTHANDLEROWNER_IID)
 111
 112   /**
 113    * Compile the specified event handler, and bind it to aTarget using
 114    * aContext.
 115    *
 116    * @param aContext the context to use when creating event handler
 117    * @param aTarget the object to which to bind the event handler
 118    * @param aName the name of the handler
 119    * @param aBody the handler script body
 120    * @param aURL the URL or filename for error messages
 121    * @param aLineNo the starting line number of the script for error messages
 122    * @param aHandler the holder for the compiled, bound handler object
 123    */
 124   virtual nsresult CompileEventHandler(nsIScriptContext* aContext,
 125                                        nsISupports* aTarget,
 126                                        nsIAtom *aName,
 127                                        const nsAString& aBody,
 128                                        const char* aURL,
 129                                        PRUint32 aLineNo,
 130                                        nsScriptObjectHolder &aHandler) = 0;
 131
 132   /**
 133    * Retrieve an already-compiled event handler that can be bound to a
 134    * target object using a script context.
 135    *
 136    * @param aName the name of the event handler to retrieve
 137    * @param aHandler the holder for the compiled event handler.
 138    */
 139   virtual nsresult GetCompiledEventHandler(nsIAtom *aName,
 140                                            nsScriptObjectHolder &aHandler) = 0;
 141 };
 142
 143 NS_DEFINE_STATIC_IID_ACCESSOR(nsIScriptEventHandlerOwner,
 144                               NS_ISCRIPTEVENTHANDLEROWNER_IID)
 145
 146 #endif // nsIScriptObjectOwner_h__