content/xbl/src/nsXBLProtoImplMethod.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 Communicator client 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  *   David Hyatt <hyatt@netscape.com> (Original Author)
  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 #ifndef nsXBLProtoImplMethod_h__
  40 #define nsXBLProtoImplMethod_h__
  41
  42 #include "nsIAtom.h"
  43 #include "nsString.h"
  44 #include "jsapi.h"
  45 #include "nsIContent.h"
  46 #include "nsString.h"
  47 #include "nsXBLProtoImplMember.h"
  48
  49 struct nsXBLParameter {
  50   nsXBLParameter* mNext;
  51   char* mName;
  52
  53   nsXBLParameter(const nsAString& aName) {
  54     MOZ_COUNT_CTOR(nsXBLParameter);
  55     mName = ToNewCString(aName);
  56     mNext = nsnull;
  57   }
  58
  59   ~nsXBLParameter() {
  60     MOZ_COUNT_DTOR(nsXBLParameter);
  61     nsMemory::Free(mName);
  62     delete mNext;
  63   }
  64 };
  65
  66 struct nsXBLUncompiledMethod {
  67   nsXBLParameter* mParameters;
  68   nsXBLParameter* mLastParameter;
  69   nsXBLTextWithLineNumber mBodyText;
  70
  71   nsXBLUncompiledMethod() :
  72     mParameters(nsnull),
  73     mLastParameter(nsnull),
  74     mBodyText()
  75   {
  76     MOZ_COUNT_CTOR(nsXBLUncompiledMethod);
  77   }
  78
  79   ~nsXBLUncompiledMethod() {
  80     MOZ_COUNT_DTOR(nsXBLUncompiledMethod);
  81     delete mParameters;
  82   }
  83
  84   PRInt32 GetParameterCount() {
  85     PRInt32 result = 0;
  86     for (nsXBLParameter* curr = mParameters; curr; curr=curr->mNext)
  87       result++;
  88     return result;
  89   }
  90
  91   void AppendBodyText(const nsAString& aText) {
  92     mBodyText.AppendText(aText);
  93   }
  94
  95   void AddParameter(const nsAString& aText) {
  96     nsXBLParameter* param = new nsXBLParameter(aText);
  97     if (!param)
  98       return;
  99     if (!mParameters)
 100       mParameters = param;
 101     else
 102       mLastParameter->mNext = param;
 103     mLastParameter = param;
 104   }
 105
 106   void SetLineNumber(PRUint32 aLineNumber) {
 107     mBodyText.SetLineNumber(aLineNumber);
 108   }
 109 };
 110
 111 class nsXBLProtoImplMethod: public nsXBLProtoImplMember
 112 {
 113 public:
 114   nsXBLProtoImplMethod(const PRUnichar* aName);
 115   virtual ~nsXBLProtoImplMethod();
 116
 117   void AppendBodyText(const nsAString& aBody);
 118   void AddParameter(const nsAString& aName);
 119
 120   void SetLineNumber(PRUint32 aLineNumber);
 121
 122   virtual nsresult InstallMember(nsIScriptContext* aContext,
 123                                  nsIContent* aBoundElement,
 124                                  void* aScriptObject,
 125                                  void* aTargetClassObject,
 126                                  const nsCString& aClassStr);
 127   virtual nsresult CompileMember(nsIScriptContext* aContext,
 128                                  const nsCString& aClassStr,
 129                                  void* aClassObject);
 130
 131   virtual void Trace(TraceCallback aCallback, void *aClosure) const;
 132
 133   PRBool IsCompiled() const
 134   {
 135     return !(mUncompiledMethod & BIT_UNCOMPILED);
 136   }
 137   void SetUncompiledMethod(nsXBLUncompiledMethod* aUncompiledMethod)
 138   {
 139     mUncompiledMethod = PRUptrdiff(aUncompiledMethod) | BIT_UNCOMPILED;
 140   }
 141   nsXBLUncompiledMethod* GetUncompiledMethod() const
 142   {
 143     PRUptrdiff unmasked = mUncompiledMethod & ~BIT_UNCOMPILED;
 144     return reinterpret_cast<nsXBLUncompiledMethod*>(unmasked);
 145   }
 146
 147 protected:
 148   enum { BIT_UNCOMPILED = 1 << 0 };
 149
 150   union {
 151     PRUptrdiff mUncompiledMethod; // An object that represents the method before being compiled.
 152     JSObject* mJSMethodObject;    // The JS object for the method (after compilation)
 153   };
 154
 155 #ifdef DEBUG
 156   PRBool mIsCompiled;
 157 #endif
 158 };
 159
 160 class nsXBLProtoImplAnonymousMethod : public nsXBLProtoImplMethod {
 161 public:
 162   nsXBLProtoImplAnonymousMethod() :
 163     nsXBLProtoImplMethod(EmptyString().get())
 164   {}
 165
 166   nsresult Execute(nsIContent* aBoundElement);
 167
 168   // Override InstallMember; these methods never get installed as members on
 169   // binding instantiations (though they may hang out in mMembers on the
 170   // prototype implementation).
 171   virtual nsresult InstallMember(nsIScriptContext* aContext,
 172                                  nsIContent* aBoundElement,
 173                                  void* aScriptObject,
 174                                  void* aTargetClassObject,
 175                                  const nsCString& aClassStr) {
 176     return NS_OK;
 177   }
 178 };
 179
 180 #endif // nsXBLProtoImplMethod_h__