summaryrefslogtreecommitdiffstats
path: root/dom/base/FragmentOrElement.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/base/FragmentOrElement.h')
-rw-r--r--dom/base/FragmentOrElement.h400
1 files changed, 400 insertions, 0 deletions
diff --git a/dom/base/FragmentOrElement.h b/dom/base/FragmentOrElement.h
new file mode 100644
index 000000000..3cb5575fe
--- /dev/null
+++ b/dom/base/FragmentOrElement.h
@@ -0,0 +1,400 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* 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/. */
+
+/*
+ * Base class for all element classes as well as nsDocumentFragment. This
+ * provides an implementation of nsIDOMNode, implements nsIContent, provides
+ * utility methods for subclasses, and so forth.
+ */
+
+#ifndef FragmentOrElement_h___
+#define FragmentOrElement_h___
+
+#include "mozilla/Attributes.h"
+#include "mozilla/MemoryReporting.h"
+#include "nsAttrAndChildArray.h" // member
+#include "nsCycleCollectionParticipant.h" // NS_DECL_CYCLE_*
+#include "nsIContent.h" // base class
+#include "nsIWeakReference.h" // base class
+#include "nsNodeUtils.h" // class member nsNodeUtils::CloneNodeImpl
+#include "nsIHTMLCollection.h"
+
+class ContentUnbinder;
+class nsContentList;
+class nsDOMAttributeMap;
+class nsDOMTokenList;
+class nsIControllers;
+class nsICSSDeclaration;
+class nsIDocument;
+class nsDOMStringMap;
+class nsIURI;
+
+namespace mozilla {
+class DeclarationBlock;
+namespace dom {
+class DOMIntersectionObserver;
+class Element;
+} // namespace dom
+} // namespace mozilla
+
+/**
+ * A class that implements nsIWeakReference
+ */
+
+class nsNodeWeakReference final : public nsIWeakReference
+{
+public:
+ explicit nsNodeWeakReference(nsINode* aNode)
+ : mNode(aNode)
+ {
+ }
+
+ // nsISupports
+ NS_DECL_ISUPPORTS
+
+ // nsIWeakReference
+ NS_DECL_NSIWEAKREFERENCE
+ virtual size_t SizeOfOnlyThis(mozilla::MallocSizeOf aMallocSizeOf) const override;
+
+ void NoticeNodeDestruction()
+ {
+ mNode = nullptr;
+ }
+
+private:
+ ~nsNodeWeakReference();
+
+ nsINode* MOZ_NON_OWNING_REF mNode;
+};
+
+/**
+ * Tearoff to use for nodes to implement nsISupportsWeakReference
+ */
+class nsNodeSupportsWeakRefTearoff final : public nsISupportsWeakReference
+{
+public:
+ explicit nsNodeSupportsWeakRefTearoff(nsINode* aNode)
+ : mNode(aNode)
+ {
+ }
+
+ // nsISupports
+ NS_DECL_CYCLE_COLLECTING_ISUPPORTS
+
+ // nsISupportsWeakReference
+ NS_DECL_NSISUPPORTSWEAKREFERENCE
+
+ NS_DECL_CYCLE_COLLECTION_CLASS(nsNodeSupportsWeakRefTearoff)
+
+private:
+ ~nsNodeSupportsWeakRefTearoff() {}
+
+ nsCOMPtr<nsINode> mNode;
+};
+
+/**
+ * A generic base class for DOM elements, implementing many nsIContent,
+ * nsIDOMNode and nsIDOMElement methods.
+ */
+namespace mozilla {
+namespace dom {
+
+class ShadowRoot;
+
+class FragmentOrElement : public nsIContent
+{
+public:
+ explicit FragmentOrElement(already_AddRefed<mozilla::dom::NodeInfo>& aNodeInfo);
+ explicit FragmentOrElement(already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo);
+
+ NS_DECL_CYCLE_COLLECTING_ISUPPORTS
+
+ NS_DECL_SIZEOF_EXCLUDING_THIS
+
+ // nsINode interface methods
+ virtual uint32_t GetChildCount() const override;
+ virtual nsIContent *GetChildAt(uint32_t aIndex) const override;
+ virtual nsIContent * const * GetChildArray(uint32_t* aChildCount) const override;
+ virtual int32_t IndexOf(const nsINode* aPossibleChild) const override;
+ virtual nsresult InsertChildAt(nsIContent* aKid, uint32_t aIndex,
+ bool aNotify) override;
+ virtual void RemoveChildAt(uint32_t aIndex, bool aNotify) override;
+ virtual void GetTextContentInternal(nsAString& aTextContent,
+ mozilla::ErrorResult& aError) override;
+ virtual void SetTextContentInternal(const nsAString& aTextContent,
+ mozilla::ErrorResult& aError) override;
+
+ // nsIContent interface methods
+ virtual already_AddRefed<nsINodeList> GetChildren(uint32_t aFilter) override;
+ virtual const nsTextFragment *GetText() override;
+ virtual uint32_t TextLength() const override;
+ virtual nsresult SetText(const char16_t* aBuffer, uint32_t aLength,
+ bool aNotify) override;
+ // Need to implement this here too to avoid hiding.
+ nsresult SetText(const nsAString& aStr, bool aNotify)
+ {
+ return SetText(aStr.BeginReading(), aStr.Length(), aNotify);
+ }
+ virtual nsresult AppendText(const char16_t* aBuffer, uint32_t aLength,
+ bool aNotify) override;
+ virtual bool TextIsOnlyWhitespace() override;
+ virtual bool HasTextForTranslation() override;
+ virtual void AppendTextTo(nsAString& aResult) override;
+ MOZ_MUST_USE
+ virtual bool AppendTextTo(nsAString& aResult, const mozilla::fallible_t&) override;
+ virtual nsIContent *GetBindingParent() const override;
+ virtual nsXBLBinding *GetXBLBinding() const override;
+ virtual void SetXBLBinding(nsXBLBinding* aBinding,
+ nsBindingManager* aOldBindingManager = nullptr) override;
+ virtual ShadowRoot *GetContainingShadow() const override;
+ virtual nsTArray<nsIContent*> &DestInsertionPoints() override;
+ virtual nsTArray<nsIContent*> *GetExistingDestInsertionPoints() const override;
+ virtual void SetShadowRoot(ShadowRoot* aBinding) override;
+ virtual nsIContent *GetXBLInsertionParent() const override;
+ virtual void SetXBLInsertionParent(nsIContent* aContent) override;
+ virtual bool IsLink(nsIURI** aURI) const override;
+
+ virtual CustomElementData *GetCustomElementData() const override;
+ virtual void SetCustomElementData(CustomElementData* aData) override;
+
+ virtual void DestroyContent() override;
+ virtual void SaveSubtreeState() override;
+
+ NS_IMETHOD WalkContentStyleRules(nsRuleWalker* aRuleWalker) override;
+
+ nsIHTMLCollection* Children();
+ uint32_t ChildElementCount()
+ {
+ return Children()->Length();
+ }
+
+ /**
+ * Sets the IsElementInStyleScope flag on each element in the subtree rooted
+ * at this node, including any elements reachable through shadow trees.
+ *
+ * @param aInStyleScope The flag value to set.
+ */
+ void SetIsElementInStyleScopeFlagOnSubtree(bool aInStyleScope);
+
+public:
+ /**
+ * If there are listeners for DOMNodeInserted event, fires the event on all
+ * aNodes
+ */
+ static void FireNodeInserted(nsIDocument* aDoc,
+ nsINode* aParent,
+ nsTArray<nsCOMPtr<nsIContent> >& aNodes);
+
+ NS_DECL_CYCLE_COLLECTION_SKIPPABLE_SCRIPT_HOLDER_CLASS(FragmentOrElement)
+
+ /**
+ * Fire a DOMNodeRemoved mutation event for all children of this node
+ */
+ void FireNodeRemovedForChildren();
+
+ virtual bool OwnedOnlyByTheDOMTree() override
+ {
+ uint32_t rc = mRefCnt.get();
+ if (GetParent()) {
+ --rc;
+ }
+ rc -= mAttrsAndChildren.ChildCount();
+ return rc == 0;
+ }
+
+ virtual bool IsPurple() override
+ {
+ return mRefCnt.IsPurple();
+ }
+
+ virtual void RemovePurple() override
+ {
+ mRefCnt.RemovePurple();
+ }
+
+ static void ClearContentUnbinder();
+ static bool CanSkip(nsINode* aNode, bool aRemovingAllowed);
+ static bool CanSkipInCC(nsINode* aNode);
+ static bool CanSkipThis(nsINode* aNode);
+ static void RemoveBlackMarkedNode(nsINode* aNode);
+ static void MarkNodeChildren(nsINode* aNode);
+ static void InitCCCallbacks();
+ static void MarkUserData(void* aObject, nsIAtom* aKey, void* aChild,
+ void *aData);
+
+ /**
+ * Is the HTML local name a void element?
+ */
+ static bool IsHTMLVoid(nsIAtom* aLocalName);
+protected:
+ virtual ~FragmentOrElement();
+
+ /**
+ * Copy attributes and state to another element
+ * @param aDest the object to copy to
+ */
+ nsresult CopyInnerTo(FragmentOrElement* aDest);
+
+public:
+ // Because of a bug in MS C++ compiler nsDOMSlots must be declared public,
+ // otherwise nsXULElement::nsXULSlots doesn't compile.
+ /**
+ * There are a set of DOM- and scripting-specific instance variables
+ * that may only be instantiated when a content object is accessed
+ * through the DOM. Rather than burn actual slots in the content
+ * objects for each of these instance variables, we put them off
+ * in a side structure that's only allocated when the content is
+ * accessed through the DOM.
+ */
+ class nsDOMSlots : public nsINode::nsSlots
+ {
+ public:
+ nsDOMSlots();
+ virtual ~nsDOMSlots();
+
+ void Traverse(nsCycleCollectionTraversalCallback &cb, bool aIsXUL);
+ void Unlink(bool aIsXUL);
+
+ size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
+
+ /**
+ * The .style attribute (an interface that forwards to the actual
+ * style rules)
+ * @see nsGenericHTMLElement::GetStyle
+ */
+ nsCOMPtr<nsICSSDeclaration> mStyle;
+
+ /**
+ * The .dataset attribute.
+ * @see nsGenericHTMLElement::GetDataset
+ */
+ nsDOMStringMap* mDataset; // [Weak]
+
+ /**
+ * SMIL Overridde style rules (for SMIL animation of CSS properties)
+ * @see nsIContent::GetSMILOverrideStyle
+ */
+ nsCOMPtr<nsICSSDeclaration> mSMILOverrideStyle;
+
+ /**
+ * Holds any SMIL override style declaration for this element.
+ */
+ RefPtr<mozilla::DeclarationBlock> mSMILOverrideStyleDeclaration;
+
+ /**
+ * An object implementing nsIDOMMozNamedAttrMap for this content (attributes)
+ * @see FragmentOrElement::GetAttributes
+ */
+ RefPtr<nsDOMAttributeMap> mAttributeMap;
+
+ union {
+ /**
+ * The nearest enclosing content node with a binding that created us.
+ * @see FragmentOrElement::GetBindingParent
+ */
+ nsIContent* mBindingParent; // [Weak]
+
+ /**
+ * The controllers of the XUL Element.
+ */
+ nsIControllers* mControllers; // [OWNER]
+ };
+
+ /**
+ * An object implementing the .children property for this element.
+ */
+ RefPtr<nsContentList> mChildrenList;
+
+ /**
+ * An object implementing the .classList property for this element.
+ */
+ RefPtr<nsDOMTokenList> mClassList;
+
+ /**
+ * ShadowRoot bound to the element.
+ */
+ RefPtr<ShadowRoot> mShadowRoot;
+
+ /**
+ * The root ShadowRoot of this element if it is in a shadow tree.
+ */
+ RefPtr<ShadowRoot> mContainingShadow;
+
+ /**
+ * An array of web component insertion points to which this element
+ * is distributed.
+ */
+ nsTArray<nsIContent*> mDestInsertionPoints;
+
+ /**
+ * XBL binding installed on the element.
+ */
+ RefPtr<nsXBLBinding> mXBLBinding;
+
+ /**
+ * XBL binding installed on the lement.
+ */
+ nsCOMPtr<nsIContent> mXBLInsertionParent;
+
+ /**
+ * Web components custom element data.
+ */
+ RefPtr<CustomElementData> mCustomElementData;
+
+ /**
+ * Registered Intersection Observers on the element.
+ */
+ struct IntersectionObserverRegistration {
+ DOMIntersectionObserver* observer;
+ int32_t previousThreshold;
+ };
+
+ nsTArray<IntersectionObserverRegistration> mRegisteredIntersectionObservers;
+ };
+
+protected:
+ void GetMarkup(bool aIncludeSelf, nsAString& aMarkup);
+ void SetInnerHTMLInternal(const nsAString& aInnerHTML, ErrorResult& aError);
+
+ // Override from nsINode
+ virtual nsINode::nsSlots* CreateSlots() override;
+
+ nsDOMSlots *DOMSlots()
+ {
+ return static_cast<nsDOMSlots*>(Slots());
+ }
+
+ nsDOMSlots *GetExistingDOMSlots() const
+ {
+ return static_cast<nsDOMSlots*>(GetExistingSlots());
+ }
+
+ /**
+ * Calls SetIsElementInStyleScopeFlagOnSubtree for each shadow tree attached
+ * to this node, which is assumed to be an Element.
+ *
+ * @param aInStyleScope The IsElementInStyleScope flag value to set.
+ */
+ void SetIsElementInStyleScopeFlagOnShadowTree(bool aInStyleScope);
+
+ friend class ::ContentUnbinder;
+ /**
+ * Array containing all attributes and children for this element
+ */
+ nsAttrAndChildArray mAttrsAndChildren;
+};
+
+} // namespace dom
+} // namespace mozilla
+
+#define NS_ELEMENT_INTERFACE_TABLE_TO_MAP_SEGUE \
+ if (NS_SUCCEEDED(rv)) \
+ return rv; \
+ \
+ rv = FragmentOrElement::QueryInterface(aIID, aInstancePtr); \
+ NS_INTERFACE_TABLE_TO_MAP_SEGUE
+
+#endif /* FragmentOrElement_h___ */