DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (e67641c2e4cc)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_XULDocument_h
#define mozilla_dom_XULDocument_h

#include "nsAutoPtr.h"
#include "nsCOMPtr.h"
#include "nsXULPrototypeDocument.h"
#include "nsTArray.h"

#include "mozilla/dom/XMLDocument.h"
#include "mozilla/StyleSheet.h"
#include "nsForwardReference.h"
#include "nsIContent.h"
#include "nsIDOMXULCommandDispatcher.h"
#include "nsCOMArray.h"
#include "nsIURI.h"
#include "nsIStreamListener.h"
#include "nsIStreamLoader.h"
#include "nsICSSLoaderObserver.h"
#include "nsIXULStore.h"

#include "mozilla/Attributes.h"
#include "mozilla/dom/ScriptLoader.h"

#include "js/TracingAPI.h"
#include "js/TypeDecls.h"

class nsIRDFResource;
class nsIRDFService;
class nsPIWindowRoot;
class nsXULPrototypeElement;
#if 0  // XXXbe save me, scc (need NSCAP_FORWARD_DECL(nsXULPrototypeScript))
class nsIObjectInputStream;
class nsIObjectOutputStream;
#else
#include "nsIObjectInputStream.h"
#include "nsIObjectOutputStream.h"
#include "nsXULElement.h"
#endif
#include "nsURIHashKey.h"
#include "nsInterfaceHashtable.h"

/**
 * The XUL document class
 */

// Factory function.
nsresult NS_NewXULDocument(nsIDocument** result);

namespace mozilla {
namespace dom {

class XULDocument final : public XMLDocument,
                          public nsIStreamLoaderObserver,
                          public nsICSSLoaderObserver,
                          public nsIOffThreadScriptReceiver {
 public:
  XULDocument();

  // nsISupports interface
  NS_DECL_ISUPPORTS_INHERITED
  NS_DECL_NSISTREAMLOADEROBSERVER

  // nsIDocument interface
  virtual void Reset(nsIChannel* aChannel, nsILoadGroup* aLoadGroup) override;
  virtual void ResetToURI(nsIURI* aURI, nsILoadGroup* aLoadGroup,
                          nsIPrincipal* aPrincipal) override;

  virtual nsresult StartDocumentLoad(const char* aCommand, nsIChannel* channel,
                                     nsILoadGroup* aLoadGroup,
                                     nsISupports* aContainer,
                                     nsIStreamListener** aDocListener,
                                     bool aReset = true,
                                     nsIContentSink* aSink = nullptr) override;

  virtual void SetContentType(const nsAString& aContentType) override;

  virtual void EndLoad() override;

  virtual XULDocument* AsXULDocument() override { return this; }

  // nsIMutationObserver interface
  NS_DECL_NSIMUTATIONOBSERVER_CONTENTAPPENDED
  NS_DECL_NSIMUTATIONOBSERVER_CONTENTINSERTED
  NS_DECL_NSIMUTATIONOBSERVER_CONTENTREMOVED
  NS_DECL_NSIMUTATIONOBSERVER_ATTRIBUTECHANGED

  /**
   * Notify the XUL document that a subtree has been added
   */
  nsresult AddSubtreeToDocument(nsIContent* aContent);
  /**
   * Notify the XUL document that a subtree has been removed
   */
  nsresult RemoveSubtreeFromDocument(nsIContent* aContent);
  /**
   * This is invoked whenever the prototype for this document is loaded
   * and should be walked, regardless of whether the XUL cache is
   * disabled, whether the protototype was loaded, whether the
   * prototype was loaded from the cache or created by parsing the
   * actual XUL source, etc.
   *
   * @param aResumeWalk whether this should also call ResumeWalk().
   * Sometimes the caller of OnPrototypeLoadDone resumes the walk itself
   */
  nsresult OnPrototypeLoadDone(bool aResumeWalk);
  /**
   * Callback notifying when a document could not be parsed properly.
   */
  bool OnDocumentParserError();

  // nsINode interface overrides
  virtual nsresult Clone(mozilla::dom::NodeInfo* aNodeInfo, nsINode** aResult,
                         bool aPreallocateChildren) const override;

  // nsIDOMDocument interface
  using nsDocument::CreateElement;
  using nsDocument::CreateElementNS;
  NS_FORWARD_NSIDOMDOCUMENT(XMLDocument::)
  // And explicitly import the things from nsDocument that we just shadowed
  using mozilla::dom::DocumentOrShadowRoot::GetElementById;
  using nsDocument::GetImplementation;
  using nsDocument::GetLastStyleSheetSet;
  using nsDocument::GetTitle;
  using nsDocument::MozSetImageElement;
  using nsDocument::SetTitle;
  using nsIDocument::GetLocation;

  // nsICSSLoaderObserver
  NS_IMETHOD StyleSheetLoaded(mozilla::StyleSheet* aSheet, bool aWasAlternate,
                              nsresult aStatus) override;

  virtual void EndUpdate(nsUpdateType aUpdateType) override;

  virtual bool IsDocumentRightToLeft() override;

  /**
   * Reset the document direction so that it is recomputed.
   */
  void ResetDocumentDirection();

  virtual nsIDocument::DocumentTheme GetDocumentLWTheme() override;
  virtual nsIDocument::DocumentTheme ThreadSafeGetDocumentLWTheme()
      const override;

  void ResetDocumentLWTheme() { mDocLWTheme = Doc_Theme_Uninitialized; }

  NS_IMETHOD OnScriptCompileComplete(JSScript* aScript,
                                     nsresult aStatus) override;

  static bool MatchAttribute(Element* aContent, int32_t aNameSpaceID,
                             nsAtom* aAttrName, void* aData);

  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(XULDocument, XMLDocument)

  void TraceProtos(JSTracer* aTrc);

  // WebIDL API
  already_AddRefed<nsINode> GetPopupNode();
  void SetPopupNode(nsINode* aNode);
  nsINode* GetPopupRangeParent(ErrorResult& aRv);
  int32_t GetPopupRangeOffset(ErrorResult& aRv);
  already_AddRefed<nsINode> GetTooltipNode();
  void SetTooltipNode(nsINode* aNode) { /* do nothing */
  }
  nsIDOMXULCommandDispatcher* GetCommandDispatcher() const {
    return mCommandDispatcher;
  }
  int32_t GetWidth(ErrorResult& aRv);
  int32_t GetHeight(ErrorResult& aRv);
  already_AddRefed<nsINodeList> GetElementsByAttribute(
      const nsAString& aAttribute, const nsAString& aValue);
  already_AddRefed<nsINodeList> GetElementsByAttributeNS(
      const nsAString& aNamespaceURI, const nsAString& aAttribute,
      const nsAString& aValue, ErrorResult& aRv);
  void AddBroadcastListenerFor(Element& aBroadcaster, Element& aListener,
                               const nsAString& aAttr, ErrorResult& aRv);
  void RemoveBroadcastListenerFor(Element& aBroadcaster, Element& aListener,
                                  const nsAString& aAttr);
  void Persist(const nsAString& aId, const nsAString& aAttr, ErrorResult& aRv);
  using nsDocument::GetBoxObjectFor;
  void LoadOverlay(const nsAString& aURL, nsIObserver* aObserver,
                   ErrorResult& aRv);

 protected:
  virtual ~XULDocument();

  // Implementation methods
  friend nsresult(::NS_NewXULDocument(nsIDocument** aResult));

  nsresult Init(void) override;
  nsresult StartLayout(void);

  nsresult GetViewportSize(int32_t* aWidth, int32_t* aHeight);

  nsresult PrepareToLoad(nsISupports* aContainer, const char* aCommand,
                         nsIChannel* aChannel, nsILoadGroup* aLoadGroup,
                         nsIParser** aResult);

  nsresult PrepareToLoadPrototype(nsIURI* aURI, const char* aCommand,
                                  nsIPrincipal* aDocumentPrincipal,
                                  nsIParser** aResult);

  nsresult LoadOverlayInternal(nsIURI* aURI, bool aIsDynamic,
                               bool* aShouldReturn, bool* aFailureFromContent);

  nsresult ApplyPersistentAttributes();
  nsresult ApplyPersistentAttributesInternal();
  nsresult ApplyPersistentAttributesToElements(const nsAString& aID,
                                               nsCOMArray<Element>& aElements);

  nsresult AddElementToDocumentPre(Element* aElement);

  nsresult AddElementToDocumentPost(Element* aElement);

  nsresult ExecuteOnBroadcastHandlerFor(Element* aBroadcaster,
                                        Element* aListener, nsAtom* aAttr);

  nsresult BroadcastAttributeChangeFromOverlay(nsIContent* aNode,
                                               int32_t aNameSpaceID,
                                               nsAtom* aAttribute,
                                               nsAtom* aPrefix,
                                               const nsAString& aValue);

  already_AddRefed<nsPIWindowRoot> GetWindowRoot();

  static void DirectionChanged(const char* aPrefName, void* aData);

  // pseudo constants
  static int32_t gRefCnt;

  static nsIRDFService* gRDFService;
  static nsIRDFResource* kNC_persist;
  static nsIRDFResource* kNC_attribute;
  static nsIRDFResource* kNC_value;

  static LazyLogModule gXULLog;

  nsresult Persist(mozilla::dom::Element* aElement, int32_t aNameSpaceID,
                   nsAtom* aAttribute);
  // Just like Persist but ignores the return value so we can use it
  // as a runnable method.
  void DoPersist(mozilla::dom::Element* aElement, int32_t aNameSpaceID,
                 nsAtom* aAttribute) {
    Persist(aElement, aNameSpaceID, aAttribute);
  }

  virtual JSObject* WrapNode(JSContext* aCx,
                             JS::Handle<JSObject*> aGivenProto) override;

  // IMPORTANT: The ownership implicit in the following member
  // variables has been explicitly checked and set using nsCOMPtr
  // for owning pointers and raw COM interface pointers for weak
  // (ie, non owning) references. If you add any members to this
  // class, please make the ownership explicit (pinkerton, scc).
  // NOTE, THIS IS STILL IN PROGRESS, TALK TO PINK OR SCC BEFORE
  // CHANGING

  XULDocument* mNextSrcLoadWaiter;  // [OWNER] but not COMPtr

  nsCOMPtr<nsIXULStore> mLocalStore;
  bool mApplyingPersistedAttrs;
  bool mIsWritingFastLoad;
  bool mDocumentLoaded;
  /**
   * Since ResumeWalk is interruptible, it's possible that last
   * stylesheet finishes loading while the PD walk is still in
   * progress (waiting for an overlay to finish loading).
   * mStillWalking prevents DoneLoading (and StartLayout) from being
   * called in this situation.
   */
  bool mStillWalking;

  /**
   * These two values control where persistent attributes get applied.
   */
  bool mRestrictPersistence;
  nsTHashtable<nsStringHashKey> mPersistenceIds;

  /**
   * An array of style sheets, that will be added (preserving order) to the
   * document after all of them are loaded (in DoneWalking).
   */
  nsTArray<RefPtr<StyleSheet>> mOverlaySheets;

  nsCOMPtr<nsIDOMXULCommandDispatcher>
      mCommandDispatcher;  // [OWNER] of the focus tracker

  uint32_t mPendingSheets;

  /**
   * document lightweight theme for use with :-moz-lwtheme,
   * :-moz-lwtheme-brighttext and :-moz-lwtheme-darktext
   */
  DocumentTheme mDocLWTheme;

  /**
   * Context stack, which maintains the state of the Builder and allows
   * it to be interrupted.
   */
  class ContextStack {
   protected:
    struct Entry {
      nsXULPrototypeElement* mPrototype;
      nsIContent* mElement;
      int32_t mIndex;
      Entry* mNext;
    };

    Entry* mTop;
    int32_t mDepth;

   public:
    ContextStack();
    ~ContextStack();

    int32_t Depth() { return mDepth; }

    nsresult Push(nsXULPrototypeElement* aPrototype, nsIContent* aElement);
    nsresult Pop();
    nsresult Peek(nsXULPrototypeElement** aPrototype, nsIContent** aElement,
                  int32_t* aIndex);

    nsresult SetTopIndex(int32_t aIndex);
  };

  friend class ContextStack;
  ContextStack mContextStack;

  enum State { eState_Master, eState_Overlay };
  State mState;

  /**
   * An array of overlay nsIURIs that have yet to be resolved. The
   * order of the array is significant: overlays at the _end_ of the
   * array are resolved before overlays earlier in the array (i.e.,
   * it is a stack).
   *
   * In the current implementation the order the overlays are loaded
   * in is as follows: first overlays from xul-overlay PIs, in the
   * same order as in the document, then the overlays from the chrome
   * registry.
   */
  nsTArray<nsCOMPtr<nsIURI>> mUnloadedOverlays;

  /**
   * Load the transcluded script at the specified URI. If the
   * prototype construction must 'block' until the load has
   * completed, aBlock will be set to true.
   */
  nsresult LoadScript(nsXULPrototypeScript* aScriptProto, bool* aBlock);

  /**
   * Execute the precompiled script object scoped by this XUL document's
   * containing window object.
   */
  nsresult ExecuteScript(nsXULPrototypeScript* aScript);

  /**
   * Create a delegate content model element from a prototype.
   * Note that the resulting content node is not bound to any tree
   */
  nsresult CreateElementFromPrototype(nsXULPrototypeElement* aPrototype,
                                      Element** aResult, bool aIsRoot);

  /**
   * Create a hook-up element to which content nodes can be attached for
   * later resolution.
   */
  nsresult CreateOverlayElement(nsXULPrototypeElement* aPrototype,
                                Element** aResult);

  /**
   * Add attributes from the prototype to the element.
   */
  nsresult AddAttributes(nsXULPrototypeElement* aPrototype, Element* aElement);

  /**
   * The prototype-script of the current transcluded script that is being
   * loaded.  For document.write('<script src="nestedwrite.js"><\/script>')
   * to work, these need to be in a stack element type, and we need to hold
   * the top of stack here.
   */
  nsXULPrototypeScript* mCurrentScriptProto;

  /**
   * Whether the current transcluded script is being compiled off thread.
   * The load event is blocked while this is in progress.
   */
  bool mOffThreadCompiling;

  /**
   * If the current transcluded script is being compiled off thread, the
   * source for that script.
   */
  char16_t* mOffThreadCompileStringBuf;
  size_t mOffThreadCompileStringLength;

  /**
   * Add the current prototype's style sheets (currently it's just
   * style overlays from the chrome registry) to the document.
   */
  nsresult AddPrototypeSheets();

 protected:
  /* Declarations related to forward references.
   *
   * Forward references are declarations which are added to the temporary
   * list (mForwardReferences) during the document (or overlay) load and
   * are resolved later, when the document loading is almost complete.
   */

  /**
   * The list of different types of forward references to resolve. After
   * a reference is resolved, it is removed from this array (and
   * automatically deleted)
   */
  nsTArray<nsAutoPtr<nsForwardReference>> mForwardReferences;

  /** Indicates what kind of forward references are still to be processed. */
  nsForwardReference::Phase mResolutionPhase;

  /**
   * Adds aRef to the mForwardReferences array. Takes the ownership of aRef.
   */
  nsresult AddForwardReference(nsForwardReference* aRef);

  /**
   * Resolve all of the document's forward references.
   */
  nsresult ResolveForwardReferences();

  /**
   * Used to resolve broadcaster references
   */
  class BroadcasterHookup : public nsForwardReference {
   protected:
    XULDocument* mDocument;            // [WEAK]
    RefPtr<Element> mObservesElement;  // [OWNER]
    bool mResolved;

   public:
    BroadcasterHookup(XULDocument* aDocument, Element* aObservesElement)
        : mDocument(aDocument),
          mObservesElement(aObservesElement),
          mResolved(false) {}

    virtual ~BroadcasterHookup();

    virtual Phase GetPhase() override { return eHookup; }
    virtual Result Resolve() override;
  };

  friend class BroadcasterHookup;

  /**
   * Used to hook up overlays
   */
  class OverlayForwardReference : public nsForwardReference {
   protected:
    XULDocument* mDocument;      // [WEAK]
    nsCOMPtr<Element> mOverlay;  // [OWNER]
    bool mResolved;

    nsresult Merge(Element* aTargetNode, Element* aOverlayNode, bool aNotify);

   public:
    OverlayForwardReference(XULDocument* aDocument, Element* aOverlay)
        : mDocument(aDocument), mOverlay(aOverlay), mResolved(false) {}

    virtual ~OverlayForwardReference();

    virtual Phase GetPhase() override { return eConstruction; }
    virtual Result Resolve() override;
  };

  friend class OverlayForwardReference;

  // The out params of FindBroadcaster only have values that make sense when
  // the method returns NS_FINDBROADCASTER_FOUND.  In all other cases, the
  // values of the out params should not be relied on (though *aListener and
  // *aBroadcaster do need to be released if non-null, of course).
  nsresult FindBroadcaster(Element* aElement, Element** aListener,
                           nsString& aBroadcasterID, nsString& aAttribute,
                           Element** aBroadcaster);

  nsresult CheckBroadcasterHookup(Element* aElement, bool* aNeedsHookup,
                                  bool* aDidResolve);

  void SynchronizeBroadcastListener(Element* aBroadcaster, Element* aListener,
                                    const nsAString& aAttr);

  // FIXME: This should probably be renamed, there's nothing guaranteeing that
  // aChild is an Element as far as I can tell!
  static nsresult InsertElement(nsINode* aParent, nsIContent* aChild,
                                bool aNotify);

  /**
   * The current prototype that we are walking to construct the
   * content model.
   */
  RefPtr<nsXULPrototypeDocument> mCurrentPrototype;

  /**
   * The master document (outermost, .xul) prototype, from which
   * all subdocuments get their security principals.
   */
  RefPtr<nsXULPrototypeDocument> mMasterPrototype;

  /**
   * Owning references to all of the prototype documents that were
   * used to construct this document.
   */
  nsTArray<RefPtr<nsXULPrototypeDocument>> mPrototypes;

  /**
   * Prepare to walk the current prototype.
   */
  nsresult PrepareToWalk();

  /**
   * Creates a processing instruction based on aProtoPI and inserts
   * it to the DOM.
   */
  nsresult CreateAndInsertPI(const nsXULPrototypePI* aProtoPI, nsINode* aParent,
                             nsINode* aBeforeThis);

  /**
   * Inserts the passed <?xml-stylesheet ?> PI at the specified
   * index. Loads and applies the associated stylesheet
   * asynchronously.
   * The prototype document walk can happen before the stylesheets
   * are loaded, but the final steps in the load process (see
   * DoneWalking()) are not run before all the stylesheets are done
   * loading.
   */
  nsresult InsertXMLStylesheetPI(const nsXULPrototypePI* aProtoPI,
                                 nsINode* aParent, nsINode* aBeforeThis,
                                 nsIContent* aPINode);

  /**
   * Inserts the passed <?xul-overlay ?> PI at the specified index.
   * Schedules the referenced overlay URI for further processing.
   */
  nsresult InsertXULOverlayPI(const nsXULPrototypePI* aProtoPI,
                              nsINode* aParent, nsINode* aBeforeThis,
                              nsIContent* aPINode);

  /**
   * Add overlays from the chrome registry to the set of unprocessed
   * overlays still to do.
   */
  nsresult AddChromeOverlays();

  /**
   * Resume (or initiate) an interrupted (or newly prepared)
   * prototype walk.
   */
  nsresult ResumeWalk();

  /**
   * Called at the end of ResumeWalk() and from StyleSheetLoaded().
   * Expects that both the prototype document walk is complete and
   * all referenced stylesheets finished loading.
   */
  nsresult DoneWalking();

  /**
   * Report that an overlay failed to load
   * @param aURI the URI of the overlay that failed to load
   */
  void ReportMissingOverlay(nsIURI* aURI);

  class CachedChromeStreamListener : public nsIStreamListener {
   protected:
    RefPtr<XULDocument> mDocument;
    bool mProtoLoaded;

    virtual ~CachedChromeStreamListener();

   public:
    CachedChromeStreamListener(XULDocument* aDocument, bool aProtoLoaded);

    NS_DECL_ISUPPORTS
    NS_DECL_NSIREQUESTOBSERVER
    NS_DECL_NSISTREAMLISTENER
  };

  friend class CachedChromeStreamListener;

  class ParserObserver : public nsIRequestObserver {
   protected:
    RefPtr<XULDocument> mDocument;
    RefPtr<nsXULPrototypeDocument> mPrototype;
    virtual ~ParserObserver();

   public:
    ParserObserver(XULDocument* aDocument, nsXULPrototypeDocument* aPrototype);

    NS_DECL_ISUPPORTS
    NS_DECL_NSIREQUESTOBSERVER
  };

  friend class ParserObserver;

  /**
   * A map from a broadcaster element to a list of listener elements.
   */
  PLDHashTable* mBroadcasterMap;

  nsAutoPtr<nsInterfaceHashtable<nsURIHashKey, nsIObserver>>
      mOverlayLoadObservers;
  nsAutoPtr<nsInterfaceHashtable<nsURIHashKey, nsIObserver>>
      mPendingOverlayLoadNotifications;

  bool mInitialLayoutComplete;

  class nsDelayedBroadcastUpdate {
   public:
    nsDelayedBroadcastUpdate(Element* aBroadcaster, Element* aListener,
                             const nsAString& aAttr)
        : mBroadcaster(aBroadcaster),
          mListener(aListener),
          mAttr(aAttr),
          mSetAttr(false),
          mNeedsAttrChange(false) {}

    nsDelayedBroadcastUpdate(Element* aBroadcaster, Element* aListener,
                             nsAtom* aAttrName, const nsAString& aAttr,
                             bool aSetAttr, bool aNeedsAttrChange)
        : mBroadcaster(aBroadcaster),
          mListener(aListener),
          mAttr(aAttr),
          mAttrName(aAttrName),
          mSetAttr(aSetAttr),
          mNeedsAttrChange(aNeedsAttrChange) {}

    nsDelayedBroadcastUpdate(const nsDelayedBroadcastUpdate& aOther)
        : mBroadcaster(aOther.mBroadcaster),
          mListener(aOther.mListener),
          mAttr(aOther.mAttr),
          mAttrName(aOther.mAttrName),
          mSetAttr(aOther.mSetAttr),
          mNeedsAttrChange(aOther.mNeedsAttrChange) {}

    nsCOMPtr<Element> mBroadcaster;
    nsCOMPtr<Element> mListener;
    // Note if mAttrName isn't used, this is the name of the attr, otherwise
    // this is the value of the attribute.
    nsString mAttr;
    RefPtr<nsAtom> mAttrName;
    bool mSetAttr;
    bool mNeedsAttrChange;

    class Comparator {
     public:
      static bool Equals(const nsDelayedBroadcastUpdate& a,
                         const nsDelayedBroadcastUpdate& b) {
        return a.mBroadcaster == b.mBroadcaster && a.mListener == b.mListener &&
               a.mAttrName == b.mAttrName;
      }
    };
  };

  nsTArray<nsDelayedBroadcastUpdate> mDelayedBroadcasters;
  nsTArray<nsDelayedBroadcastUpdate> mDelayedAttrChangeBroadcasts;
  bool mHandlingDelayedAttrChange;
  bool mHandlingDelayedBroadcasters;

  void MaybeBroadcast();

 private:
  // helpers
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_XULDocument_h