dom/base/nsDOMClassInfo.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 sw=2 et tw=80: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2000
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Johnny Stenback <jst@netscape.com> (original author)
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsDOMClassInfo_h___
  41 #define nsDOMClassInfo_h___
  42
  43 #include "nsIDOMClassInfo.h"
  44 #include "nsIXPCScriptable.h"
  45 #include "jsapi.h"
  46 #include "nsIScriptSecurityManager.h"
  47 #include "nsIScriptContext.h"
  48 #include "nsDOMJSUtils.h" // for GetScriptContextFromJSContext
  49 #include "nsIScriptGlobalObject.h"
  50 #include "nsContentUtils.h"
  51
  52 class nsIDOMWindow;
  53 class nsIDOMNSHTMLOptionCollection;
  54 class nsIPluginInstance;
  55 class nsIForm;
  56 class nsIDOMNodeList;
  57 class nsIDOMDocument;
  58 class nsIHTMLDocument;
  59 class nsGlobalWindow;
  60
  61 struct nsDOMClassInfoData;
  62
  63 typedef nsIClassInfo* (*nsDOMClassInfoConstructorFnc)
  64   (nsDOMClassInfoData* aData);
  65
  66 typedef nsresult (*nsDOMConstructorFunc)(nsISupports** aNewObject);
  67
  68 struct nsDOMClassInfoData
  69 {
  70   const char *mName;
  71   const PRUnichar *mNameUTF16;
  72   union {
  73     nsDOMClassInfoConstructorFnc mConstructorFptr;
  74     nsDOMClassInfoExternalConstructorFnc mExternalConstructorFptr;
  75   } u;
  76
  77   nsIClassInfo *mCachedClassInfo; // low bit is set to 1 if external,
  78                                   // so be sure to mask if necessary!
  79   const nsIID *mProtoChainInterface;
  80   const nsIID **mInterfaces;
  81   PRUint32 mScriptableFlags : 31; // flags must not use more than 31 bits!
  82   PRUint32 mHasClassInterface : 1;
  83   PRUint32 mInterfacesBitmap;
  84   PRBool mChromeOnly;
  85 #ifdef NS_DEBUG
  86   PRUint32 mDebugID;
  87 #endif
  88 };
  89
  90 struct nsExternalDOMClassInfoData : public nsDOMClassInfoData
  91 {
  92   const nsCID *mConstructorCID;
  93 };
  94
  95
  96 typedef PRUptrdiff PtrBits;
  97
  98 // To be used with the nsDOMClassInfoData::mCachedClassInfo pointer.
  99 // The low bit is set when we created a generic helper for an external
 100 // (which holds on to the nsDOMClassInfoData).
 101 #define GET_CLEAN_CI_PTR(_ptr) (nsIClassInfo*)(PtrBits(_ptr) & ~0x1)
 102 #define MARK_EXTERNAL(_ptr) (nsIClassInfo*)(PtrBits(_ptr) | 0x1)
 103 #define IS_EXTERNAL(_ptr) (PtrBits(_ptr) & 0x1)
 104
 105
 106 class nsDOMClassInfo : public nsXPCClassInfo
 107 {
 108 public:
 109   nsDOMClassInfo(nsDOMClassInfoData* aData);
 110   virtual ~nsDOMClassInfo();
 111
 112   NS_DECL_NSIXPCSCRIPTABLE
 113
 114   NS_DECL_ISUPPORTS
 115
 116   NS_DECL_NSICLASSINFO
 117
 118   // Helper method that returns a *non* refcounted pointer to a
 119   // helper. So please note, don't release this pointer, if you do,
 120   // you better make sure you've addreffed before release.
 121   //
 122   // Whaaaaa! I wanted to name this method GetClassInfo, but nooo,
 123   // some of Microsoft devstudio's headers #defines GetClassInfo to
 124   // GetClassInfoA so I can't, those $%#@^! bastards!!! What gives
 125   // them the right to do that?
 126
 127   static nsIClassInfo* GetClassInfoInstance(nsDOMClassInfoData* aData);
 128
 129   static void ShutDown();
 130
 131   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 132   {
 133     return new nsDOMClassInfo(aData);
 134   }
 135
 136   static nsresult WrapNative(JSContext *cx, JSObject *scope,
 137                              nsISupports *native, const nsIID* aIID,
 138                              PRBool aAllowWrapping, jsval *vp,
 139                              // If non-null aHolder will keep the jsval alive
 140                              // while there's a ref to it
 141                              nsIXPConnectJSObjectHolder** aHolder = nsnull)
 142   {
 143     return WrapNative(cx, scope, native, nsnull, aIID, vp, aHolder,
 144                       aAllowWrapping);
 145   }
 146
 147   // Used for cases where PreCreate needs to wrap the native parent, and the
 148   // native parent is likely to have been wrapped already.  |native| must
 149   // implement nsWrapperCache, and nativeWrapperCache must be |native|'s
 150   // nsWrapperCache.
 151   static inline nsresult WrapNativeParent(JSContext *cx, JSObject *scope,
 152                                           nsISupports *native,
 153                                           nsWrapperCache *nativeWrapperCache,
 154                                           JSObject **parentObj);
 155
 156   // Same as the WrapNative above, but use these if aIID is nsISupports' IID.
 157   static nsresult WrapNative(JSContext *cx, JSObject *scope,
 158                              nsISupports *native, PRBool aAllowWrapping,
 159                              jsval *vp,
 160                              // If non-null aHolder will keep the jsval alive
 161                              // while there's a ref to it
 162                              nsIXPConnectJSObjectHolder** aHolder = nsnull)
 163   {
 164     return WrapNative(cx, scope, native, nsnull, nsnull, vp, aHolder,
 165                       aAllowWrapping);
 166   }
 167   static nsresult WrapNative(JSContext *cx, JSObject *scope,
 168                              nsISupports *native, nsWrapperCache *cache,
 169                              PRBool aAllowWrapping, jsval *vp,
 170                              // If non-null aHolder will keep the jsval alive
 171                              // while there's a ref to it
 172                              nsIXPConnectJSObjectHolder** aHolder = nsnull)
 173   {
 174     return WrapNative(cx, scope, native, cache, nsnull, vp, aHolder,
 175                       aAllowWrapping);
 176   }
 177
 178   static nsresult ThrowJSException(JSContext *cx, nsresult aResult);
 179
 180   /*
 181    * The following two functions exist because of the way that Xray wrappers
 182    * work. In order to allow scriptable helpers to define non-IDL defined but
 183    * still "safe" properties for Xray wrappers, we call into the scriptable
 184    * helper with |obj| being the wrapper.
 185    *
 186    * Ideally, that would be the end of the story, however due to complications
 187    * dealing with document.domain, it's possible to end up in a scriptable
 188    * helper with a wrapper, even though we should be treating the lookup as a
 189    * transparent one.
 190    */
 191   static PRBool ObjectIsNativeWrapper(JSContext* cx, JSObject* obj);
 192
 193   static nsISupports *GetNative(nsIXPConnectWrappedNative *wrapper, JSObject *obj);
 194
 195   static nsIXPConnect *XPConnect()
 196   {
 197     return sXPConnect;
 198   }
 199
 200 protected:
 201   friend nsIClassInfo* NS_GetDOMClassInfoInstance(nsDOMClassInfoID aID);
 202
 203   const nsDOMClassInfoData* mData;
 204
 205   virtual void PreserveWrapper(nsISupports *aNative)
 206   {
 207   }
 208
 209   virtual PRUint32 GetInterfacesBitmap()
 210   {
 211     return mData->mInterfacesBitmap;
 212   }
 213
 214   static nsresult Init();
 215   static nsresult RegisterClassName(PRInt32 aDOMClassInfoID);
 216   static nsresult RegisterClassProtos(PRInt32 aDOMClassInfoID);
 217   static nsresult RegisterExternalClasses();
 218   nsresult ResolveConstructor(JSContext *cx, JSObject *obj,
 219                               JSObject **objp);
 220
 221   // Checks if id is a number and returns the number, if aIsNumber is
 222   // non-null it's set to true if the id is a number and false if it's
 223   // not a number. If id is not a number this method returns -1
 224   static PRInt32 GetArrayIndexFromId(JSContext *cx, jsid id,
 225                                      PRBool *aIsNumber = nsnull);
 226
 227   static inline PRBool IsReadonlyReplaceable(jsid id)
 228   {
 229     return (id == sTop_id          ||
 230             id == sParent_id       ||
 231             id == sScrollbars_id   ||
 232             id == sContent_id      ||
 233             id == sMenubar_id      ||
 234             id == sToolbar_id      ||
 235             id == sLocationbar_id  ||
 236             id == sPersonalbar_id  ||
 237             id == sStatusbar_id    ||
 238             id == sControllers_id  ||
 239             id == sScrollX_id      ||
 240             id == sScrollY_id      ||
 241             id == sScrollMaxX_id   ||
 242             id == sScrollMaxY_id   ||
 243             id == sLength_id       ||
 244             id == sFrames_id       ||
 245             id == sSelf_id         ||
 246             id == sURL_id);
 247   }
 248
 249   static inline PRBool IsWritableReplaceable(jsid id)
 250   {
 251     return (id == sInnerHeight_id  ||
 252             id == sInnerWidth_id   ||
 253             id == sOpener_id       ||
 254             id == sOuterHeight_id  ||
 255             id == sOuterWidth_id   ||
 256             id == sScreenX_id      ||
 257             id == sScreenY_id      ||
 258             id == sStatus_id       ||
 259             id == sName_id);
 260   }
 261
 262   inline static nsresult WrapNative(JSContext *cx, JSObject *scope,
 263                                     nsISupports *native, nsWrapperCache *cache,
 264                                     const nsIID* aIID, jsval *vp,
 265                                     nsIXPConnectJSObjectHolder** aHolder,
 266                                     PRBool aAllowWrapping);
 267
 268   static nsIXPConnect *sXPConnect;
 269   static nsIScriptSecurityManager *sSecMan;
 270
 271   // nsIXPCScriptable code
 272   static nsresult DefineStaticJSVals(JSContext *cx);
 273
 274   static PRBool sIsInitialized;
 275   static PRBool sDisableDocumentAllSupport;
 276   static PRBool sDisableGlobalScopePollutionSupport;
 277
 278 public:
 279   static jsid sTop_id;
 280   static jsid sParent_id;
 281   static jsid sScrollbars_id;
 282   static jsid sLocation_id;
 283   static jsid sConstructor_id;
 284   static jsid s_content_id;
 285   static jsid sContent_id;
 286   static jsid sMenubar_id;
 287   static jsid sToolbar_id;
 288   static jsid sLocationbar_id;
 289   static jsid sPersonalbar_id;
 290   static jsid sStatusbar_id;
 291   static jsid sDialogArguments_id;
 292   static jsid sControllers_id;
 293   static jsid sLength_id;
 294   static jsid sInnerHeight_id;
 295   static jsid sInnerWidth_id;
 296   static jsid sOuterHeight_id;
 297   static jsid sOuterWidth_id;
 298   static jsid sScreenX_id;
 299   static jsid sScreenY_id;
 300   static jsid sStatus_id;
 301   static jsid sName_id;
 302   static jsid sOnmousedown_id;
 303   static jsid sOnmouseup_id;
 304   static jsid sOnclick_id;
 305   static jsid sOndblclick_id;
 306   static jsid sOncontextmenu_id;
 307   static jsid sOnmouseover_id;
 308   static jsid sOnmouseout_id;
 309   static jsid sOnkeydown_id;
 310   static jsid sOnkeyup_id;
 311   static jsid sOnkeypress_id;
 312   static jsid sOnmousemove_id;
 313   static jsid sOnfocus_id;
 314   static jsid sOnblur_id;
 315   static jsid sOnsubmit_id;
 316   static jsid sOnreset_id;
 317   static jsid sOnchange_id;
 318   static jsid sOninput_id;
 319   static jsid sOninvalid_id;
 320   static jsid sOnselect_id;
 321   static jsid sOnload_id;
 322   static jsid sOnpopstate_id;
 323   static jsid sOnbeforeunload_id;
 324   static jsid sOnunload_id;
 325   static jsid sOnhashchange_id;
 326   static jsid sOnreadystatechange_id;
 327   static jsid sOnpageshow_id;
 328   static jsid sOnpagehide_id;
 329   static jsid sOnabort_id;
 330   static jsid sOnerror_id;
 331   static jsid sOnpaint_id;
 332   static jsid sOnresize_id;
 333   static jsid sOnscroll_id;
 334   static jsid sOndrag_id;
 335   static jsid sOndragend_id;
 336   static jsid sOndragenter_id;
 337   static jsid sOndragleave_id;
 338   static jsid sOndragover_id;
 339   static jsid sOndragstart_id;
 340   static jsid sOndrop_id;
 341   static jsid sScrollX_id;
 342   static jsid sScrollY_id;
 343   static jsid sScrollMaxX_id;
 344   static jsid sScrollMaxY_id;
 345   static jsid sOpen_id;
 346   static jsid sItem_id;
 347   static jsid sNamedItem_id;
 348   static jsid sEnumerate_id;
 349   static jsid sNavigator_id;
 350   static jsid sDocument_id;
 351   static jsid sFrames_id;
 352   static jsid sSelf_id;
 353   static jsid sOpener_id;
 354   static jsid sAll_id;
 355   static jsid sTags_id;
 356   static jsid sAddEventListener_id;
 357   static jsid sBaseURIObject_id;
 358   static jsid sNodePrincipal_id;
 359   static jsid sDocumentURIObject_id;
 360   static jsid sOncopy_id;
 361   static jsid sOncut_id;
 362   static jsid sOnpaste_id;
 363   static jsid sJava_id;
 364   static jsid sPackages_id;
 365   static jsid sOnloadstart_id;
 366   static jsid sOnprogress_id;
 367   static jsid sOnsuspend_id;
 368   static jsid sOnemptied_id;
 369   static jsid sOnstalled_id;
 370   static jsid sOnplay_id;
 371   static jsid sOnpause_id;
 372   static jsid sOnloadedmetadata_id;
 373   static jsid sOnloadeddata_id;
 374   static jsid sOnwaiting_id;
 375   static jsid sOnplaying_id;
 376   static jsid sOncanplay_id;
 377   static jsid sOncanplaythrough_id;
 378   static jsid sOnseeking_id;
 379   static jsid sOnseeked_id;
 380   static jsid sOntimeupdate_id;
 381   static jsid sOnended_id;
 382   static jsid sOnratechange_id;
 383   static jsid sOndurationchange_id;
 384   static jsid sOnvolumechange_id;
 385   static jsid sOnmessage_id;
 386   static jsid sOnbeforescriptexecute_id;
 387   static jsid sOnafterscriptexecute_id;
 388   static jsid sWrappedJSObject_id;
 389   static jsid sURL_id;
 390   static jsid sKeyPath_id;
 391   static jsid sAutoIncrement_id;
 392   static jsid sUnique_id;
 393
 394 protected:
 395   static JSPropertyOp sXPCNativeWrapperGetPropertyOp;
 396   static JSPropertyOp sXrayWrapperPropertyHolderGetPropertyOp;
 397 };
 398
 399
 400 inline
 401 const nsQueryInterface
 402 do_QueryWrappedNative(nsIXPConnectWrappedNative *wrapper, JSObject *obj)
 403 {
 404   return nsQueryInterface(nsDOMClassInfo::GetNative(wrapper, obj));
 405 }
 406
 407 inline
 408 const nsQueryInterfaceWithError
 409 do_QueryWrappedNative(nsIXPConnectWrappedNative *wrapper, JSObject *obj,
 410                       nsresult *aError)
 411
 412 {
 413   return nsQueryInterfaceWithError(nsDOMClassInfo::GetNative(wrapper, obj),
 414                                    aError);
 415 }
 416
 417 inline
 418 nsQueryInterface
 419 do_QueryWrapper(JSContext *cx, JSObject *obj)
 420 {
 421   nsISupports *native =
 422     nsDOMClassInfo::XPConnect()->GetNativeOfWrapper(cx, obj);
 423   return nsQueryInterface(native);
 424 }
 425
 426 inline
 427 nsQueryInterfaceWithError
 428 do_QueryWrapper(JSContext *cx, JSObject *obj, nsresult* error)
 429 {
 430   nsISupports *native =
 431     nsDOMClassInfo::XPConnect()->GetNativeOfWrapper(cx, obj);
 432   return nsQueryInterfaceWithError(native, error);
 433 }
 434
 435
 436 typedef nsDOMClassInfo nsDOMGenericSH;
 437
 438 // EventProp scriptable helper, this class should be the base class of
 439 // all objects that should support things like
 440 // obj.onclick=function{...}
 441
 442 class nsEventReceiverSH : public nsDOMGenericSH
 443 {
 444 protected:
 445   nsEventReceiverSH(nsDOMClassInfoData* aData) : nsDOMGenericSH(aData)
 446   {
 447   }
 448
 449   virtual ~nsEventReceiverSH()
 450   {
 451   }
 452
 453   static PRBool ReallyIsEventName(jsid id, jschar aFirstChar);
 454
 455   static inline PRBool IsEventName(jsid id)
 456   {
 457     NS_ASSERTION(JSID_IS_STRING(id), "Don't pass non-string jsid's here!");
 458
 459     const jschar *str = ::JS_GetInternedStringChars(JSID_TO_STRING(id));
 460
 461     if (str[0] == 'o' && str[1] == 'n') {
 462       return ReallyIsEventName(id, str[2]);
 463     }
 464
 465     return PR_FALSE;
 466   }
 467
 468   nsresult RegisterCompileHandler(nsIXPConnectWrappedNative *wrapper,
 469                                   JSContext *cx, JSObject *obj, jsid id,
 470                                   PRBool compile, PRBool remove,
 471                                   PRBool *did_define);
 472
 473 public:
 474   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 475                         JSObject *obj, jsid id, PRUint32 flags,
 476                         JSObject **objp, PRBool *_retval);
 477   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 478                          JSObject *obj, jsid id, jsval *vp,
 479                          PRBool *_retval);
 480   NS_IMETHOD AddProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 481                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 482 };
 483
 484 // Simpler than nsEventReceiverSH
 485 // Makes sure that the wrapper is preserved if new properties are added.
 486 class nsEventTargetSH : public nsDOMGenericSH
 487 {
 488 protected:
 489   nsEventTargetSH(nsDOMClassInfoData* aData) : nsDOMGenericSH(aData)
 490   {
 491   }
 492
 493   virtual ~nsEventTargetSH()
 494   {
 495   }
 496 public:
 497   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 498                        JSObject *globalObj, JSObject **parentObj);
 499   NS_IMETHOD AddProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 500                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 501
 502   virtual void PreserveWrapper(nsISupports *aNative);
 503
 504   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 505   {
 506     return new nsEventTargetSH(aData);
 507   }
 508 };
 509
 510 // Window scriptable helper
 511
 512 class nsWindowSH : public nsEventReceiverSH
 513 {
 514 protected:
 515   nsWindowSH(nsDOMClassInfoData *aData) : nsEventReceiverSH(aData)
 516   {
 517   }
 518
 519   virtual ~nsWindowSH()
 520   {
 521   }
 522
 523   static nsresult GlobalResolve(nsGlobalWindow *aWin, JSContext *cx,
 524                                 JSObject *obj, jsid id, PRBool *did_resolve);
 525
 526 public:
 527   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 528                        JSObject *globalObj, JSObject **parentObj);
 529 #ifdef DEBUG
 530   NS_IMETHOD PostCreate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 531                         JSObject *obj)
 532   {
 533     nsCOMPtr<nsIScriptGlobalObject> sgo(do_QueryWrappedNative(wrapper));
 534
 535     NS_ASSERTION(!sgo || sgo->GetGlobalJSObject() == nsnull,
 536                  "Multiple wrappers created for global object!");
 537
 538     return NS_OK;
 539   }
 540   NS_IMETHOD GetScriptableFlags(PRUint32 *aFlags)
 541   {
 542     PRUint32 flags;
 543     nsresult rv = nsEventReceiverSH::GetScriptableFlags(&flags);
 544     if (NS_SUCCEEDED(rv)) {
 545       *aFlags = flags | nsIXPCScriptable::WANT_POSTCREATE;
 546     }
 547
 548     return rv;
 549   }
 550 #endif
 551   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 552                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 553   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 554                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 555   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 556                         JSObject *obj, jsid id, PRUint32 flags,
 557                         JSObject **objp, PRBool *_retval);
 558   NS_IMETHOD Finalize(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 559                       JSObject *obj);
 560   NS_IMETHOD Equality(nsIXPConnectWrappedNative *wrapper, JSContext * cx,
 561                       JSObject * obj, const jsval &val, PRBool *bp);
 562   NS_IMETHOD OuterObject(nsIXPConnectWrappedNative *wrapper, JSContext * cx,
 563                          JSObject * obj, JSObject * *_retval);
 564
 565   static JSBool GlobalScopePolluterNewResolve(JSContext *cx, JSObject *obj,
 566                                               jsid id, uintN flags,
 567                                               JSObject **objp);
 568   static JSBool GlobalScopePolluterGetProperty(JSContext *cx, JSObject *obj,
 569                                                jsid id, jsval *vp);
 570   static JSBool SecurityCheckOnAddDelProp(JSContext *cx, JSObject *obj, jsid id,
 571                                           jsval *vp);
 572   static JSBool SecurityCheckOnSetProp(JSContext *cx, JSObject *obj, jsid id,
 573                                        JSBool strict, jsval *vp);
 574   static void InvalidateGlobalScopePolluter(JSContext *cx, JSObject *obj);
 575   static nsresult InstallGlobalScopePolluter(JSContext *cx, JSObject *obj,
 576                                              nsIHTMLDocument *doc);
 577   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 578   {
 579     return new nsWindowSH(aData);
 580   }
 581 };
 582
 583 // Location scriptable helper
 584
 585 class nsLocationSH : public nsDOMGenericSH
 586 {
 587 protected:
 588   nsLocationSH(nsDOMClassInfoData* aData) : nsDOMGenericSH(aData)
 589   {
 590   }
 591
 592   virtual ~nsLocationSH()
 593   {
 594   }
 595
 596 public:
 597   NS_IMETHOD CheckAccess(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 598                          JSObject *obj, jsid id, PRUint32 mode,
 599                          jsval *vp, PRBool *_retval);
 600
 601   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 602                        JSObject *globalObj, JSObject **parentObj);
 603
 604   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 605   {
 606     return new nsLocationSH(aData);
 607   }
 608 };
 609
 610
 611 // Navigator scriptable helper
 612
 613 class nsNavigatorSH : public nsDOMGenericSH
 614 {
 615 protected:
 616   nsNavigatorSH(nsDOMClassInfoData* aData) : nsDOMGenericSH(aData)
 617   {
 618   }
 619
 620   virtual ~nsNavigatorSH()
 621   {
 622   }
 623
 624 public:
 625   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 626                        JSObject *globalObj, JSObject **parentObj);
 627
 628   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 629   {
 630     return new nsNavigatorSH(aData);
 631   }
 632 };
 633
 634
 635 // DOM Node helper, this class deals with setting the parent for the
 636 // wrappers
 637
 638 class nsNodeSH : public nsEventReceiverSH
 639 {
 640 protected:
 641   nsNodeSH(nsDOMClassInfoData* aData) : nsEventReceiverSH(aData)
 642   {
 643   }
 644
 645   virtual ~nsNodeSH()
 646   {
 647   }
 648
 649   // Helper to check whether a capability is enabled
 650   PRBool IsCapabilityEnabled(const char* aCapability);
 651
 652   inline PRBool IsPrivilegedScript() {
 653     return IsCapabilityEnabled("UniversalXPConnect");
 654   }
 655
 656   // Helper to define a void property with JSPROP_SHARED; this can do all the
 657   // work so it's safe to just return whatever it returns.  |obj| is the object
 658   // we're defining on, |id| is the name of the prop.  This must be a string
 659   // jsval.  |objp| is the out param if we define successfully.
 660   nsresult DefineVoidProp(JSContext* cx, JSObject* obj, jsid id,
 661                           JSObject** objp);
 662
 663 public:
 664   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 665                        JSObject *globalObj, JSObject **parentObj);
 666   NS_IMETHOD AddProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 667                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 668   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 669                         JSObject *obj, jsid id, PRUint32 flags,
 670                         JSObject **objp, PRBool *_retval);
 671   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 672                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 673   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 674                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 675   NS_IMETHOD GetFlags(PRUint32 *aFlags);
 676
 677   virtual void PreserveWrapper(nsISupports *aNative);
 678
 679   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 680   {
 681     return new nsNodeSH(aData);
 682   }
 683 };
 684
 685
 686 // Element helper
 687
 688 class nsElementSH : public nsNodeSH
 689 {
 690 protected:
 691   nsElementSH(nsDOMClassInfoData* aData) : nsNodeSH(aData)
 692   {
 693   }
 694
 695   virtual ~nsElementSH()
 696   {
 697   }
 698
 699 public:
 700   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 701                        JSObject *globalObj, JSObject **parentObj);
 702   NS_IMETHOD PostCreate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 703                         JSObject *obj);
 704   NS_IMETHOD Enumerate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 705                        JSObject *obj, PRBool *_retval);
 706
 707   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 708   {
 709     return new nsElementSH(aData);
 710   }
 711 };
 712
 713
 714 // Generic array scriptable helper
 715
 716 class nsGenericArraySH : public nsDOMClassInfo
 717 {
 718 protected:
 719   nsGenericArraySH(nsDOMClassInfoData* aData) : nsDOMClassInfo(aData)
 720   {
 721   }
 722
 723   virtual ~nsGenericArraySH()
 724   {
 725   }
 726
 727 public:
 728   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 729                         JSObject *obj, jsid id, PRUint32 flags,
 730                         JSObject **objp, PRBool *_retval);
 731   NS_IMETHOD Enumerate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 732                        JSObject *obj, PRBool *_retval);
 733
 734   virtual nsresult GetLength(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 735                              JSObject *obj, PRUint32 *length);
 736
 737   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 738   {
 739     return new nsGenericArraySH(aData);
 740   }
 741 };
 742
 743
 744 // Array scriptable helper
 745
 746 class nsArraySH : public nsGenericArraySH
 747 {
 748 protected:
 749   nsArraySH(nsDOMClassInfoData* aData) : nsGenericArraySH(aData)
 750   {
 751   }
 752
 753   virtual ~nsArraySH()
 754   {
 755   }
 756
 757   // Subclasses need to override this, if the implementation can't fail it's
 758   // allowed to not set *aResult.
 759   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
 760                                  nsWrapperCache **aCache, nsresult *aResult) = 0;
 761
 762 public:
 763   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 764                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 765
 766 private:
 767   // Not implemented, nothing should create an instance of this class.
 768   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData);
 769 };
 770
 771
 772 // NodeList scriptable helper
 773
 774 class nsNodeListSH : public nsArraySH
 775 {
 776 protected:
 777   nsNodeListSH(nsDOMClassInfoData* aData) : nsArraySH(aData)
 778   {
 779   }
 780
 781 public:
 782   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 783                        JSObject *globalObj, JSObject **parentObj);
 784
 785   virtual nsresult GetLength(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 786                              JSObject *obj, PRUint32 *length);
 787   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
 788                                  nsWrapperCache **aCache, nsresult *aResult);
 789
 790   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 791   {
 792     return new nsNodeListSH(aData);
 793   }
 794 };
 795
 796
 797 // NamedArray helper
 798
 799 class nsNamedArraySH : public nsArraySH
 800 {
 801 protected:
 802   nsNamedArraySH(nsDOMClassInfoData* aData) : nsArraySH(aData)
 803   {
 804   }
 805
 806   virtual ~nsNamedArraySH()
 807   {
 808   }
 809
 810   virtual nsISupports* GetNamedItem(nsISupports *aNative,
 811                                     const nsAString& aName,
 812                                     nsWrapperCache **cache,
 813                                     nsresult *aResult) = 0;
 814
 815 public:
 816   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 817                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 818
 819 private:
 820   // Not implemented, nothing should create an instance of this class.
 821   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData);
 822 };
 823
 824
 825 // NamedNodeMap helper
 826
 827 class nsNamedNodeMapSH : public nsNamedArraySH
 828 {
 829 protected:
 830   nsNamedNodeMapSH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
 831   {
 832   }
 833
 834   virtual ~nsNamedNodeMapSH()
 835   {
 836   }
 837
 838   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
 839                                  nsWrapperCache **aCache, nsresult *aResult);
 840
 841   // Override nsNamedArraySH::GetNamedItem()
 842   virtual nsISupports* GetNamedItem(nsISupports *aNative,
 843                                     const nsAString& aName,
 844                                     nsWrapperCache **cache,
 845                                     nsresult *aResult);
 846
 847 public:
 848   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 849   {
 850     return new nsNamedNodeMapSH(aData);
 851   }
 852 };
 853
 854
 855 // HTMLCollection helper
 856
 857 class nsHTMLCollectionSH : public nsNamedArraySH
 858 {
 859 protected:
 860   nsHTMLCollectionSH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
 861   {
 862   }
 863
 864   virtual ~nsHTMLCollectionSH()
 865   {
 866   }
 867
 868   virtual nsresult GetLength(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 869                              JSObject *obj, PRUint32 *length);
 870   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
 871                                  nsWrapperCache **aCache, nsresult *aResult);
 872
 873   // Override nsNamedArraySH::GetNamedItem()
 874   virtual nsISupports* GetNamedItem(nsISupports *aNative,
 875                                     const nsAString& aName,
 876                                     nsWrapperCache **cache,
 877                                     nsresult *aResult);
 878
 879 public:
 880   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 881   {
 882     return new nsHTMLCollectionSH(aData);
 883   }
 884 };
 885
 886
 887 // ContentList helper
 888
 889 class nsContentListSH : public nsNamedArraySH
 890 {
 891 protected:
 892   nsContentListSH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
 893   {
 894   }
 895
 896 public:
 897   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
 898                        JSObject *globalObj, JSObject **parentObj);
 899
 900   virtual nsresult GetLength(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 901                              JSObject *obj, PRUint32 *length);
 902   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
 903                                  nsWrapperCache **aCache, nsresult *aResult);
 904   virtual nsISupports* GetNamedItem(nsISupports *aNative,
 905                                     const nsAString& aName,
 906                                     nsWrapperCache **cache,
 907                                     nsresult *aResult);
 908
 909   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 910   {
 911     return new nsContentListSH(aData);
 912   }
 913 };
 914
 915
 916
 917 // Document helper, for document.location and document.on*
 918
 919 class nsDocumentSH : public nsNodeSH
 920 {
 921 public:
 922   nsDocumentSH(nsDOMClassInfoData* aData) : nsNodeSH(aData)
 923   {
 924   }
 925
 926   virtual ~nsDocumentSH()
 927   {
 928   }
 929
 930 public:
 931   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 932                         JSObject *obj, jsid id, PRUint32 flags,
 933                         JSObject **objp, PRBool *_retval);
 934   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 935                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 936   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 937                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 938   NS_IMETHOD GetFlags(PRUint32* aFlags);
 939   NS_IMETHOD PostCreate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 940                         JSObject *obj);
 941
 942   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 943   {
 944     return new nsDocumentSH(aData);
 945   }
 946 };
 947
 948
 949 // HTMLDocument helper
 950
 951 class nsHTMLDocumentSH : public nsDocumentSH
 952 {
 953 protected:
 954   nsHTMLDocumentSH(nsDOMClassInfoData* aData) : nsDocumentSH(aData)
 955   {
 956   }
 957
 958   virtual ~nsHTMLDocumentSH()
 959   {
 960   }
 961
 962   static JSBool DocumentOpen(JSContext *cx, uintN argc, jsval *vp);
 963   static JSBool GetDocumentAllNodeList(JSContext *cx, JSObject *obj,
 964                                        nsDocument *doc,
 965                                        nsContentList **nodeList);
 966
 967 public:
 968   static JSBool DocumentAllGetProperty(JSContext *cx, JSObject *obj, jsid id,
 969                                        jsval *vp);
 970   static JSBool DocumentAllNewResolve(JSContext *cx, JSObject *obj, jsid id,
 971                                       uintN flags, JSObject **objp);
 972   static void ReleaseDocument(JSContext *cx, JSObject *obj);
 973   static JSBool CallToGetPropMapper(JSContext *cx, uintN argc, jsval *vp);
 974   static JSBool DocumentAllHelperGetProperty(JSContext *cx, JSObject *obj,
 975                                              jsid id, jsval *vp);
 976   static JSBool DocumentAllHelperNewResolve(JSContext *cx, JSObject *obj,
 977                                             jsid id, uintN flags,
 978                                             JSObject **objp);
 979   static JSBool DocumentAllTagsNewResolve(JSContext *cx, JSObject *obj,
 980                                           jsid id, uintN flags,
 981                                           JSObject **objp);
 982
 983   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 984                         JSObject *obj, jsid id, PRUint32 flags,
 985                         JSObject **objp, PRBool *_retval);
 986   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
 987                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
 988
 989   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
 990   {
 991     return new nsHTMLDocumentSH(aData);
 992   }
 993 };
 994
 995
 996 // HTMLBodyElement helper
 997
 998 class nsHTMLBodyElementSH : public nsElementSH
 999 {
1000 protected:
1001   nsHTMLBodyElementSH(nsDOMClassInfoData* aData) : nsElementSH(aData)
1002   {
1003   }
1004
1005   virtual ~nsHTMLBodyElementSH()
1006   {
1007   }
1008
1009 public:
1010   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1011                         JSObject *obj, jsid id, PRUint32 flags,
1012                         JSObject **objp, PRBool *_retval);
1013
1014   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1015                          JSObject *obj, jsid id, jsval *vp,
1016                          PRBool *_retval);
1017
1018   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1019                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1020
1021   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1022   {
1023     return new nsHTMLBodyElementSH(aData);
1024   }
1025 };
1026
1027
1028 // HTMLFormElement helper
1029
1030 class nsHTMLFormElementSH : public nsElementSH
1031 {
1032 protected:
1033   nsHTMLFormElementSH(nsDOMClassInfoData* aData) : nsElementSH(aData)
1034   {
1035   }
1036
1037   virtual ~nsHTMLFormElementSH()
1038   {
1039   }
1040
1041   static nsresult FindNamedItem(nsIForm *aForm, jsid id,
1042                                 nsISupports **aResult, nsWrapperCache **aCache);
1043
1044 public:
1045   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1046                         JSObject *obj, jsid id, PRUint32 flags,
1047                         JSObject **objp, PRBool *_retval);
1048   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1049                          JSObject *obj, jsid id, jsval *vp,
1050                          PRBool *_retval);
1051
1052   NS_IMETHOD NewEnumerate(nsIXPConnectWrappedNative *wrapper,
1053                           JSContext *cx, JSObject *obj,
1054                           PRUint32 enum_op, jsval *statep,
1055                           jsid *idp, PRBool *_retval);
1056
1057   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1058   {
1059     return new nsHTMLFormElementSH(aData);
1060   }
1061 };
1062
1063
1064 // HTMLSelectElement helper
1065
1066 class nsHTMLSelectElementSH : public nsElementSH
1067 {
1068 protected:
1069   nsHTMLSelectElementSH(nsDOMClassInfoData* aData) : nsElementSH(aData)
1070   {
1071   }
1072
1073   virtual ~nsHTMLSelectElementSH()
1074   {
1075   }
1076
1077 public:
1078   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1079                          JSObject *obj, jsid id, jsval *vp,
1080                          PRBool *_retval);
1081   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1082                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1083
1084   static nsresult SetOption(JSContext *cx, jsval *vp, PRUint32 aIndex,
1085                             nsIDOMNSHTMLOptionCollection *aOptCollection);
1086
1087   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1088   {
1089     return new nsHTMLSelectElementSH(aData);
1090   }
1091 };
1092
1093
1094 // HTMLEmbed/Object/AppletElement helper
1095
1096 class nsHTMLPluginObjElementSH : public nsElementSH
1097 {
1098 protected:
1099   nsHTMLPluginObjElementSH(nsDOMClassInfoData* aData)
1100     : nsElementSH(aData)
1101   {
1102   }
1103
1104   virtual ~nsHTMLPluginObjElementSH()
1105   {
1106   }
1107
1108   static nsresult GetPluginInstanceIfSafe(nsIXPConnectWrappedNative *aWrapper,
1109                                           JSObject *obj,
1110                                           nsIPluginInstance **aResult);
1111
1112   static nsresult GetPluginJSObject(JSContext *cx, JSObject *obj,
1113                                     nsIPluginInstance *plugin_inst,
1114                                     JSObject **plugin_obj,
1115                                     JSObject **plugin_proto);
1116
1117 public:
1118   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1119                         JSObject *obj, jsid id, PRUint32 flags,
1120                         JSObject **objp, PRBool *_retval);
1121   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
1122                        JSObject *globalObj, JSObject **parentObj);
1123   NS_IMETHOD PostCreate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1124                         JSObject *obj);
1125   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1126                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1127   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1128                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1129   NS_IMETHOD Call(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1130                   JSObject *obj, PRUint32 argc, jsval *argv, jsval *vp,
1131                   PRBool *_retval);
1132
1133
1134   static nsresult SetupProtoChain(nsIXPConnectWrappedNative *wrapper,
1135                                   JSContext *cx, JSObject *obj);
1136
1137   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1138   {
1139     return new nsHTMLPluginObjElementSH(aData);
1140   }
1141 };
1142
1143
1144 // HTMLOptionsCollection helper
1145
1146 class nsHTMLOptionsCollectionSH : public nsHTMLCollectionSH
1147 {
1148 protected:
1149   nsHTMLOptionsCollectionSH(nsDOMClassInfoData* aData)
1150     : nsHTMLCollectionSH(aData)
1151   {
1152   }
1153
1154   virtual ~nsHTMLOptionsCollectionSH()
1155   {
1156   }
1157
1158 public:
1159   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1160                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1161
1162   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1163   {
1164     return new nsHTMLOptionsCollectionSH(aData);
1165   }
1166 };
1167
1168
1169 // Plugin helper
1170
1171 class nsPluginSH : public nsNamedArraySH
1172 {
1173 protected:
1174   nsPluginSH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
1175   {
1176   }
1177
1178   virtual ~nsPluginSH()
1179   {
1180   }
1181
1182   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1183                                  nsWrapperCache **aCache, nsresult *aResult);
1184
1185   // Override nsNamedArraySH::GetNamedItem()
1186   virtual nsISupports* GetNamedItem(nsISupports *aNative,
1187                                     const nsAString& aName,
1188                                     nsWrapperCache **cache,
1189                                     nsresult *aResult);
1190
1191 public:
1192   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1193   {
1194     return new nsPluginSH(aData);
1195   }
1196 };
1197
1198
1199 // PluginArray helper
1200
1201 class nsPluginArraySH : public nsNamedArraySH
1202 {
1203 protected:
1204   nsPluginArraySH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
1205   {
1206   }
1207
1208   virtual ~nsPluginArraySH()
1209   {
1210   }
1211
1212   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1213                                  nsWrapperCache **aCache, nsresult *aResult);
1214
1215   // Override nsNamedArraySH::GetNamedItem()
1216   virtual nsISupports* GetNamedItem(nsISupports *aNative,
1217                                     const nsAString& aName,
1218                                     nsWrapperCache **cache,
1219                                     nsresult *aResult);
1220
1221 public:
1222   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1223   {
1224     return new nsPluginArraySH(aData);
1225   }
1226 };
1227
1228
1229 // MimeTypeArray helper
1230
1231 class nsMimeTypeArraySH : public nsNamedArraySH
1232 {
1233 protected:
1234   nsMimeTypeArraySH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
1235   {
1236   }
1237
1238   virtual ~nsMimeTypeArraySH()
1239   {
1240   }
1241
1242   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1243                                  nsWrapperCache **aCache, nsresult *aResult);
1244
1245   // Override nsNamedArraySH::GetNamedItem()
1246   virtual nsISupports* GetNamedItem(nsISupports *aNative,
1247                                     const nsAString& aName,
1248                                     nsWrapperCache **cache,
1249                                     nsresult *aResult);
1250
1251 public:
1252   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1253   {
1254     return new nsMimeTypeArraySH(aData);
1255   }
1256 };
1257
1258
1259 // String array helper
1260
1261 class nsStringArraySH : public nsGenericArraySH
1262 {
1263 protected:
1264   nsStringArraySH(nsDOMClassInfoData* aData) : nsGenericArraySH(aData)
1265   {
1266   }
1267
1268   virtual ~nsStringArraySH()
1269   {
1270   }
1271
1272   virtual nsresult GetStringAt(nsISupports *aNative, PRInt32 aIndex,
1273                                nsAString& aResult) = 0;
1274
1275 public:
1276   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1277                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1278 };
1279
1280
1281 // History helper
1282
1283 class nsHistorySH : public nsStringArraySH
1284 {
1285 protected:
1286   nsHistorySH(nsDOMClassInfoData* aData) : nsStringArraySH(aData)
1287   {
1288   }
1289
1290   virtual ~nsHistorySH()
1291   {
1292   }
1293
1294   virtual nsresult GetStringAt(nsISupports *aNative, PRInt32 aIndex,
1295                                nsAString& aResult);
1296
1297 public:
1298   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
1299                        JSObject *globalObj, JSObject **parentObj);
1300   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1301                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1302
1303   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1304   {
1305     return new nsHistorySH(aData);
1306   }
1307 };
1308
1309 // StringList scriptable helper
1310
1311 class nsStringListSH : public nsStringArraySH
1312 {
1313 protected:
1314   nsStringListSH(nsDOMClassInfoData* aData) : nsStringArraySH(aData)
1315   {
1316   }
1317
1318   virtual ~nsStringListSH()
1319   {
1320   }
1321
1322   virtual nsresult GetStringAt(nsISupports *aNative, PRInt32 aIndex,
1323                                nsAString& aResult);
1324
1325 public:
1326   // Inherit GetProperty, Enumerate from nsStringArraySH
1327
1328   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1329   {
1330     return new nsStringListSH(aData);
1331   }
1332 };
1333
1334
1335 // DOMTokenList scriptable helper
1336
1337 class nsDOMTokenListSH : public nsStringArraySH
1338 {
1339 protected:
1340   nsDOMTokenListSH(nsDOMClassInfoData* aData) : nsStringArraySH(aData)
1341   {
1342   }
1343
1344   virtual ~nsDOMTokenListSH()
1345   {
1346   }
1347
1348   virtual nsresult GetStringAt(nsISupports *aNative, PRInt32 aIndex,
1349                                nsAString& aResult);
1350
1351 public:
1352
1353   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1354   {
1355     return new nsDOMTokenListSH(aData);
1356   }
1357 };
1358
1359
1360 // MediaList helper
1361
1362 class nsMediaListSH : public nsStringArraySH
1363 {
1364 protected:
1365   nsMediaListSH(nsDOMClassInfoData* aData) : nsStringArraySH(aData)
1366   {
1367   }
1368
1369   virtual ~nsMediaListSH()
1370   {
1371   }
1372
1373   virtual nsresult GetStringAt(nsISupports *aNative, PRInt32 aIndex,
1374                                nsAString& aResult);
1375
1376 public:
1377   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1378   {
1379     return new nsMediaListSH(aData);
1380   }
1381 };
1382
1383
1384 // StyleSheetList helper
1385
1386 class nsStyleSheetListSH : public nsArraySH
1387 {
1388 protected:
1389   nsStyleSheetListSH(nsDOMClassInfoData* aData) : nsArraySH(aData)
1390   {
1391   }
1392
1393   virtual ~nsStyleSheetListSH()
1394   {
1395   }
1396
1397   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1398                                  nsWrapperCache **aCache, nsresult *aResult);
1399
1400 public:
1401   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1402   {
1403     return new nsStyleSheetListSH(aData);
1404   }
1405 };
1406
1407
1408 // CSSValueList helper
1409
1410 class nsCSSValueListSH : public nsArraySH
1411 {
1412 protected:
1413   nsCSSValueListSH(nsDOMClassInfoData* aData) : nsArraySH(aData)
1414   {
1415   }
1416
1417   virtual ~nsCSSValueListSH()
1418   {
1419   }
1420
1421   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1422                                  nsWrapperCache **aCache, nsresult *aResult);
1423
1424 public:
1425   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1426   {
1427     return new nsCSSValueListSH(aData);
1428   }
1429 };
1430
1431
1432 // CSSStyleDeclaration helper
1433
1434 class nsCSSStyleDeclSH : public nsStringArraySH
1435 {
1436 protected:
1437   nsCSSStyleDeclSH(nsDOMClassInfoData* aData) : nsStringArraySH(aData)
1438   {
1439   }
1440
1441   virtual ~nsCSSStyleDeclSH()
1442   {
1443   }
1444
1445   virtual nsresult GetStringAt(nsISupports *aNative, PRInt32 aIndex,
1446                                nsAString& aResult);
1447
1448 public:
1449   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
1450                        JSObject *globalObj, JSObject **parentObj);
1451
1452   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1453   {
1454     return new nsCSSStyleDeclSH(aData);
1455   }
1456 };
1457
1458
1459 // CSSRuleList helper
1460
1461 class nsCSSRuleListSH : public nsArraySH
1462 {
1463 protected:
1464   nsCSSRuleListSH(nsDOMClassInfoData* aData) : nsArraySH(aData)
1465   {
1466   }
1467
1468   virtual ~nsCSSRuleListSH()
1469   {
1470   }
1471
1472   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1473                                  nsWrapperCache **aCache, nsresult *aResult);
1474
1475 public:
1476   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1477   {
1478     return new nsCSSRuleListSH(aData);
1479   }
1480 };
1481
1482 // ClientRectList helper
1483
1484 class nsClientRectListSH : public nsArraySH
1485 {
1486 protected:
1487   nsClientRectListSH(nsDOMClassInfoData* aData) : nsArraySH(aData)
1488   {
1489   }
1490
1491   virtual ~nsClientRectListSH()
1492   {
1493   }
1494
1495   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1496                                  nsWrapperCache **aCache, nsresult *aResult);
1497
1498 public:
1499   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1500   {
1501     return new nsClientRectListSH(aData);
1502   }
1503 };
1504
1505
1506 // PaintRequestList helper
1507
1508 class nsPaintRequestListSH : public nsArraySH
1509 {
1510 protected:
1511   nsPaintRequestListSH(nsDOMClassInfoData* aData) : nsArraySH(aData)
1512   {
1513   }
1514
1515   virtual ~nsPaintRequestListSH()
1516   {
1517   }
1518
1519   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1520                                  nsWrapperCache **aCache, nsresult *aResult);
1521
1522 public:
1523   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1524   {
1525     return new nsPaintRequestListSH(aData);
1526   }
1527 };
1528
1529
1530 #ifdef MOZ_XUL
1531 // TreeColumns helper
1532
1533 class nsTreeColumnsSH : public nsNamedArraySH
1534 {
1535 protected:
1536   nsTreeColumnsSH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
1537   {
1538   }
1539
1540   virtual ~nsTreeColumnsSH()
1541   {
1542   }
1543
1544   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1545                                  nsWrapperCache **aCache, nsresult *aResult);
1546
1547   // Override nsNamedArraySH::GetNamedItem()
1548   virtual nsISupports* GetNamedItem(nsISupports *aNative,
1549                                     const nsAString& aName,
1550                                     nsWrapperCache **cache,
1551                                     nsresult *aResult);
1552
1553 public:
1554   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1555   {
1556     return new nsTreeColumnsSH(aData);
1557   }
1558 };
1559 #endif
1560
1561 // WebApps Storage helpers
1562
1563 class nsStorageSH : public nsNamedArraySH
1564 {
1565 protected:
1566   nsStorageSH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
1567   {
1568   }
1569
1570   virtual ~nsStorageSH()
1571   {
1572   }
1573
1574   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1575                         JSObject *obj, jsid id, PRUint32 flags,
1576                         JSObject **objp, PRBool *_retval);
1577   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1578                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1579   NS_IMETHOD DelProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1580                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1581   NS_IMETHOD NewEnumerate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1582                           JSObject *obj, PRUint32 enum_op, jsval *statep,
1583                           jsid *idp, PRBool *_retval);
1584
1585   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1586                                  nsWrapperCache **aCache, nsresult *aResult)
1587   {
1588     return nsnull;
1589   }
1590   // Override nsNamedArraySH::GetNamedItem()
1591   virtual nsISupports* GetNamedItem(nsISupports *aNative,
1592                                     const nsAString& aName,
1593                                     nsWrapperCache **cache,
1594                                     nsresult *aResult);
1595
1596 public:
1597   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1598   {
1599     return new nsStorageSH(aData);
1600   }
1601 };
1602
1603
1604 class nsStorage2SH : public nsDOMGenericSH
1605 {
1606 protected:
1607   nsStorage2SH(nsDOMClassInfoData* aData) : nsDOMGenericSH(aData)
1608   {
1609   }
1610
1611   virtual ~nsStorage2SH()
1612   {
1613   }
1614
1615   NS_IMETHOD NewResolve(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1616                         JSObject *obj, jsid id, PRUint32 flags,
1617                         JSObject **objp, PRBool *_retval);
1618   NS_IMETHOD SetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1619                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1620   NS_IMETHOD GetProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1621                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1622   NS_IMETHOD DelProperty(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1623                          JSObject *obj, jsid id, jsval *vp, PRBool *_retval);
1624   NS_IMETHOD NewEnumerate(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1625                           JSObject *obj, PRUint32 enum_op, jsval *statep,
1626                           jsid *idp, PRBool *_retval);
1627
1628 public:
1629   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1630   {
1631     return new nsStorage2SH(aData);
1632   }
1633 };
1634
1635 class nsStorageListSH : public nsNamedArraySH
1636 {
1637 protected:
1638   nsStorageListSH(nsDOMClassInfoData* aData) : nsNamedArraySH(aData)
1639   {
1640   }
1641
1642   virtual ~nsStorageListSH()
1643   {
1644   }
1645
1646   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1647                                  nsWrapperCache **aCache, nsresult *aResult)
1648   {
1649     return nsnull;
1650   }
1651   // Override nsNamedArraySH::GetNamedItem()
1652   virtual nsISupports* GetNamedItem(nsISupports *aNative,
1653                                     const nsAString& aName,
1654                                     nsWrapperCache **cache,
1655                                     nsresult *aResult);
1656
1657 public:
1658   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1659   {
1660     return new nsStorageListSH(aData);
1661   }
1662 };
1663
1664
1665 // Event handler 'this' translator class, this is called by XPConnect
1666 // when a "function interface" (nsIDOMEventListener) is called, this
1667 // class extracts 'this' fomr the first argument to the called
1668 // function (nsIDOMEventListener::HandleEvent(in nsIDOMEvent)), this
1669 // class will pass back nsIDOMEvent::currentTarget to be used as
1670 // 'this'.
1671
1672 class nsEventListenerThisTranslator : public nsIXPCFunctionThisTranslator
1673 {
1674 public:
1675   nsEventListenerThisTranslator()
1676   {
1677   }
1678
1679   virtual ~nsEventListenerThisTranslator()
1680   {
1681   }
1682
1683   // nsISupports
1684   NS_DECL_ISUPPORTS
1685
1686   // nsIXPCFunctionThisTranslator
1687   NS_DECL_NSIXPCFUNCTIONTHISTRANSLATOR
1688 };
1689
1690 class nsDOMConstructorSH : public nsDOMGenericSH
1691 {
1692 protected:
1693   nsDOMConstructorSH(nsDOMClassInfoData* aData) : nsDOMGenericSH(aData)
1694   {
1695   }
1696
1697 public:
1698   NS_IMETHOD PreCreate(nsISupports *nativeObj, JSContext *cx,
1699                        JSObject *globalObj, JSObject **parentObj);
1700   NS_IMETHOD PostCreatePrototype(JSContext * cx, JSObject * proto)
1701   {
1702     return NS_OK;
1703   }
1704   NS_IMETHOD Call(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1705                   JSObject *obj, PRUint32 argc, jsval *argv, jsval *vp,
1706                   PRBool *_retval);
1707
1708   NS_IMETHOD Construct(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1709                        JSObject *obj, PRUint32 argc, jsval *argv,
1710                        jsval *vp, PRBool *_retval);
1711
1712   NS_IMETHOD HasInstance(nsIXPConnectWrappedNative *wrapper, JSContext *cx,
1713                          JSObject *obj, const jsval &val, PRBool *bp,
1714                          PRBool *_retval);
1715
1716   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1717   {
1718     return new nsDOMConstructorSH(aData);
1719   }
1720 };
1721
1722 class nsNonDOMObjectSH : public nsDOMGenericSH
1723 {
1724 protected:
1725   nsNonDOMObjectSH(nsDOMClassInfoData* aData) : nsDOMGenericSH(aData)
1726   {
1727   }
1728
1729   virtual ~nsNonDOMObjectSH()
1730   {
1731   }
1732
1733 public:
1734   NS_IMETHOD GetFlags(PRUint32 *aFlags);
1735
1736   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1737   {
1738     return new nsNonDOMObjectSH(aData);
1739   }
1740 };
1741
1742 // Need this to override GetFlags() on nsNodeSH
1743 class nsAttributeSH : public nsNodeSH
1744 {
1745 protected:
1746   nsAttributeSH(nsDOMClassInfoData* aData) : nsNodeSH(aData)
1747   {
1748   }
1749
1750   virtual ~nsAttributeSH()
1751   {
1752   }
1753
1754 public:
1755   NS_IMETHOD GetFlags(PRUint32 *aFlags);
1756
1757   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1758   {
1759     return new nsAttributeSH(aData);
1760   }
1761 };
1762
1763 class nsOfflineResourceListSH : public nsStringArraySH
1764 {
1765 protected:
1766   nsOfflineResourceListSH(nsDOMClassInfoData* aData) : nsStringArraySH(aData)
1767   {
1768   }
1769
1770   virtual ~nsOfflineResourceListSH()
1771   {
1772   }
1773
1774   virtual nsresult GetStringAt(nsISupports *aNative, PRInt32 aIndex,
1775                                nsAString& aResult);
1776
1777 public:
1778   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1779   {
1780     return new nsOfflineResourceListSH(aData);
1781   }
1782 };
1783
1784 class nsFileListSH : public nsArraySH
1785 {
1786 protected:
1787   nsFileListSH(nsDOMClassInfoData *aData) : nsArraySH(aData)
1788   {
1789   }
1790
1791   virtual ~nsFileListSH()
1792   {
1793   }
1794
1795   virtual nsISupports* GetItemAt(nsISupports *aNative, PRUint32 aIndex,
1796                                  nsWrapperCache **aCache, nsresult *aResult);
1797
1798 public:
1799   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1800   {
1801     return new nsFileListSH(aData);
1802   }
1803 };
1804
1805 class nsWebGLViewportHandlerSH : public nsDOMGenericSH
1806 {
1807 protected:
1808   nsWebGLViewportHandlerSH(nsDOMClassInfoData *aData) : nsDOMGenericSH(aData)
1809   {
1810   }
1811
1812   virtual ~nsWebGLViewportHandlerSH()
1813   {
1814   }
1815
1816 public:
1817   NS_IMETHOD PostCreatePrototype(JSContext * cx, JSObject * proto) {
1818     nsresult rv = nsDOMGenericSH::PostCreatePrototype(cx, proto);
1819     if (NS_SUCCEEDED(rv)) {
1820       if (!::JS_DefineProperty(cx, proto, "VIEWPORT", INT_TO_JSVAL(0x0BA2),
1821                                nsnull, nsnull, JSPROP_ENUMERATE))
1822       {
1823         return NS_ERROR_UNEXPECTED;
1824       }
1825     }
1826     return rv;
1827   }
1828
1829   static nsIClassInfo *doCreate(nsDOMClassInfoData* aData)
1830   {
1831     return new nsWebGLViewportHandlerSH(aData);
1832   }
1833 };
1834
1835 #endif /* nsDOMClassInfo_h___ */