dom/base/ShadowRoot.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_shadowroot_h__
   8 #define mozilla_dom_shadowroot_h__
   9
  10 #include "mozilla/DOMEventTargetHelper.h"
  11 #include "mozilla/dom/DocumentBinding.h"
  12 #include "mozilla/dom/DocumentFragment.h"
  13 #include "mozilla/dom/DocumentOrShadowRoot.h"
  14 #include "mozilla/dom/NameSpaceConstants.h"
  15 #include "mozilla/dom/ShadowRootBinding.h"
  16 #include "mozilla/ServoBindings.h"
  17 #include "nsCOMPtr.h"
  18 #include "nsCycleCollectionParticipant.h"
  19 #include "nsIRadioGroupContainer.h"
  20 #include "nsStubMutationObserver.h"
  21 #include "nsTHashtable.h"
  22
  23 class nsAtom;
  24 class nsIContent;
  25
  26 namespace mozilla {
  27
  28 class EventChainPreVisitor;
  29 class ServoStyleRuleMap;
  30
  31 enum class StyleRuleChangeKind : uint32_t;
  32
  33 namespace css {
  34 class Rule;
  35 }
  36
  37 namespace dom {
  38
  39 class CSSImportRule;
  40 class Element;
  41 class HTMLInputElement;
  42
  43 class ShadowRoot final : public DocumentFragment,
  44                          public DocumentOrShadowRoot,
  45                          public nsIRadioGroupContainer {
  46   friend class DocumentOrShadowRoot;
  47
  48  public:
  49   NS_IMPL_FROMNODE_HELPER(ShadowRoot, IsShadowRoot());
  50
  51   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ShadowRoot, DocumentFragment)
  52   NS_DECL_ISUPPORTS_INHERITED
  53
  54   ShadowRoot(Element* aElement, ShadowRootMode aMode,
  55              Element::DelegatesFocus aDelegatesFocus,
  56              SlotAssignmentMode aSlotAssignment,
  57              already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo);
  58
  59   void AddSizeOfExcludingThis(nsWindowSizes&, size_t* aNodeSize) const final;
  60
  61   // Try to reassign an element or text to a slot.
  62   void MaybeReassignContent(nsIContent& aElementOrText);
  63   // Called when an element is inserted as a direct child of our host. Tries to
  64   // slot the child in one of our slots.
  65   void MaybeSlotHostChild(nsIContent&);
  66   // Called when a direct child of our host is removed. Tries to un-slot the
  67   // child from the currently-assigned slot, if any.
  68   void MaybeUnslotHostChild(nsIContent&);
  69
  70   // Shadow DOM v1
  71   Element* Host() const {
  72     MOZ_ASSERT(GetHost(),
  73                "ShadowRoot always has a host, how did we create "
  74                "this ShadowRoot?");
  75     return GetHost();
  76   }
  77
  78   ShadowRootMode Mode() const { return mMode; }
  79   bool DelegatesFocus() const {
  80     return mDelegatesFocus == Element::DelegatesFocus::Yes;
  81   }
  82   SlotAssignmentMode SlotAssignment() const { return mSlotAssignment; }
  83   bool IsClosed() const { return mMode == ShadowRootMode::Closed; }
  84
  85   void RemoveSheetFromStyles(StyleSheet&);
  86   void RuleAdded(StyleSheet&, css::Rule&);
  87   void RuleRemoved(StyleSheet&, css::Rule&);
  88   void RuleChanged(StyleSheet&, css::Rule*, StyleRuleChangeKind);
  89   void ImportRuleLoaded(CSSImportRule&, StyleSheet&);
  90   void SheetCloned(StyleSheet&);
  91   void StyleSheetApplicableStateChanged(StyleSheet&);
  92
  93   /**
  94    * Clones internal state, for example stylesheets, of aOther to 'this'.
  95    */
  96   void CloneInternalDataFrom(ShadowRoot* aOther);
  97   void InsertSheetAt(size_t aIndex, StyleSheet&);
  98
  99   // Calls UnbindFromTree for each of our kids, and also flags us as no longer
 100   // being connected.
 101   void Unbind();
 102
 103   // Only intended for UA widgets / special shadow roots, or for handling
 104   // failure cases when adopting (see BlastSubtreeToPieces).
 105   //
 106   // Forgets our shadow host and unbinds all our kids.
 107   void Unattach();
 108
 109   // Calls BindToTree on each of our kids, and also maybe flags us as being
 110   // connected.
 111   nsresult Bind();
 112
 113   /**
 114    * Explicitly invalidates the style and layout of the flattened-tree subtree
 115    * rooted at the element.
 116    *
 117    * You need to use this whenever the flat tree is going to be shuffled in a
 118    * way that layout doesn't understand via the usual ContentInserted /
 119    * ContentAppended / ContentRemoved notifications. For example, if removing an
 120    * element will cause a change in the flat tree such that other element will
 121    * start showing up (like fallback content), this method needs to be called on
 122    * an ancestor of that element.
 123    *
 124    * It is important that this runs _before_ actually shuffling the flat tree
 125    * around, so that layout knows the actual tree that it needs to invalidate.
 126    */
 127   void InvalidateStyleAndLayoutOnSubtree(Element*);
 128
 129  private:
 130   void InsertSheetIntoAuthorData(size_t aIndex, StyleSheet&,
 131                                  const nsTArray<RefPtr<StyleSheet>>&);
 132
 133   void AppendStyleSheet(StyleSheet& aSheet) {
 134     InsertSheetAt(SheetCount(), aSheet);
 135   }
 136
 137   /**
 138    * Represents the insertion point in a slot for a given node.
 139    */
 140   struct SlotInsertionPoint {
 141     HTMLSlotElement* mSlot = nullptr;
 142     Maybe<uint32_t> mIndex;
 143
 144     SlotInsertionPoint() = default;
 145     SlotInsertionPoint(HTMLSlotElement* aSlot, const Maybe<uint32_t>& aIndex)
 146         : mSlot(aSlot), mIndex(aIndex) {}
 147   };
 148
 149   /**
 150    * Return the assignment corresponding to the content node at this particular
 151    * point in time.
 152    *
 153    * It's the caller's responsibility to actually call InsertAssignedNode /
 154    * AppendAssignedNode in the slot as needed.
 155    */
 156   SlotInsertionPoint SlotInsertionPointFor(nsIContent&);
 157
 158   /**
 159    * Returns the effective slot name for a given slottable. In most cases, this
 160    * is just the value of the slot attribute, if any, or the empty string, but
 161    * this also deals with the <details> shadow tree specially.
 162    */
 163   void GetSlotNameFor(const nsIContent&, nsAString&) const;
 164
 165   /**
 166    * Re-assign the current main summary if it has changed.
 167    *
 168    * Must be called only if mIsDetailsShadowTree is true.
 169    */
 170   enum class SummaryChangeReason { Deletion, Insertion };
 171   void MaybeReassignMainSummary(SummaryChangeReason);
 172
 173  public:
 174   void AddSlot(HTMLSlotElement* aSlot);
 175   void RemoveSlot(HTMLSlotElement* aSlot);
 176   bool HasSlots() const { return !mSlotMap.IsEmpty(); };
 177   HTMLSlotElement* GetDefaultSlot() const {
 178     SlotArray* list = mSlotMap.Get(u""_ns);
 179     return list ? (*list)->ElementAt(0) : nullptr;
 180   }
 181
 182   void PartAdded(const Element&);
 183   void PartRemoved(const Element&);
 184
 185   IMPL_EVENT_HANDLER(slotchange);
 186
 187   const nsTArray<const Element*>& Parts() const { return mParts; }
 188
 189   const RawServoAuthorStyles* GetServoStyles() const {
 190     return mServoStyles.get();
 191   }
 192
 193   RawServoAuthorStyles* GetServoStyles() { return mServoStyles.get(); }
 194
 195   mozilla::ServoStyleRuleMap& ServoStyleRuleMap();
 196
 197   JSObject* WrapNode(JSContext*, JS::Handle<JSObject*> aGivenProto) final;
 198
 199   void NodeInfoChanged(Document* aOldDoc) override;
 200
 201   void AddToIdTable(Element* aElement, nsAtom* aId);
 202   void RemoveFromIdTable(Element* aElement, nsAtom* aId);
 203
 204   // WebIDL methods.
 205   using mozilla::dom::DocumentOrShadowRoot::GetElementById;
 206
 207   Element* GetActiveElement();
 208
 209   /**
 210    * These methods allow UA Widget to insert DOM elements into the Shadow ROM
 211    * without putting their DOM reflectors to content scope first.
 212    * The inserted DOM will have their reflectors in the UA Widget scope.
 213    */
 214   nsINode* ImportNodeAndAppendChildAt(nsINode& aParentNode, nsINode& aNode,
 215                                       bool aDeep, mozilla::ErrorResult& rv);
 216
 217   nsINode* CreateElementAndAppendChildAt(nsINode& aParentNode,
 218                                          const nsAString& aTagName,
 219                                          mozilla::ErrorResult& rv);
 220
 221   bool IsUAWidget() const { return mIsUAWidget; }
 222
 223   void SetIsUAWidget() {
 224     MOZ_ASSERT(!HasChildren());
 225     SetFlags(NODE_HAS_BEEN_IN_UA_WIDGET);
 226     mIsUAWidget = true;
 227   }
 228
 229   bool IsAvailableToElementInternals() const {
 230     return mIsAvailableToElementInternals;
 231   }
 232
 233   void SetAvailableToElementInternals() {
 234     mIsAvailableToElementInternals = true;
 235   }
 236
 237   void GetEventTargetParent(EventChainPreVisitor& aVisitor) override;
 238
 239   // nsIRadioGroupContainer
 240   NS_IMETHOD WalkRadioGroup(const nsAString& aName,
 241                             nsIRadioVisitor* aVisitor) override {
 242     return DocumentOrShadowRoot::WalkRadioGroup(aName, aVisitor);
 243   }
 244   virtual void SetCurrentRadioButton(const nsAString& aName,
 245                                      HTMLInputElement* aRadio) override {
 246     DocumentOrShadowRoot::SetCurrentRadioButton(aName, aRadio);
 247   }
 248   virtual HTMLInputElement* GetCurrentRadioButton(
 249       const nsAString& aName) override {
 250     return DocumentOrShadowRoot::GetCurrentRadioButton(aName);
 251   }
 252   NS_IMETHOD
 253   GetNextRadioButton(const nsAString& aName, const bool aPrevious,
 254                      HTMLInputElement* aFocusedRadio,
 255                      HTMLInputElement** aRadioOut) override {
 256     return DocumentOrShadowRoot::GetNextRadioButton(aName, aPrevious,
 257                                                     aFocusedRadio, aRadioOut);
 258   }
 259   virtual void AddToRadioGroup(const nsAString& aName,
 260                                HTMLInputElement* aRadio) override {
 261     DocumentOrShadowRoot::AddToRadioGroup(aName, aRadio);
 262   }
 263   virtual void RemoveFromRadioGroup(const nsAString& aName,
 264                                     HTMLInputElement* aRadio) override {
 265     DocumentOrShadowRoot::RemoveFromRadioGroup(aName, aRadio);
 266   }
 267   virtual uint32_t GetRequiredRadioCount(
 268       const nsAString& aName) const override {
 269     return DocumentOrShadowRoot::GetRequiredRadioCount(aName);
 270   }
 271   virtual void RadioRequiredWillChange(const nsAString& aName,
 272                                        bool aRequiredAdded) override {
 273     DocumentOrShadowRoot::RadioRequiredWillChange(aName, aRequiredAdded);
 274   }
 275   virtual bool GetValueMissingState(const nsAString& aName) const override {
 276     return DocumentOrShadowRoot::GetValueMissingState(aName);
 277   }
 278   virtual void SetValueMissingState(const nsAString& aName,
 279                                     bool aValue) override {
 280     return DocumentOrShadowRoot::SetValueMissingState(aName, aValue);
 281   }
 282
 283  protected:
 284   // FIXME(emilio): This will need to become more fine-grained.
 285   void ApplicableRulesChanged();
 286
 287   virtual ~ShadowRoot();
 288
 289   const ShadowRootMode mMode;
 290
 291   Element::DelegatesFocus mDelegatesFocus;
 292
 293   const SlotAssignmentMode mSlotAssignment;
 294
 295   // The computed data from the style sheets.
 296   UniquePtr<RawServoAuthorStyles> mServoStyles;
 297   UniquePtr<mozilla::ServoStyleRuleMap> mStyleRuleMap;
 298
 299   using SlotArray = TreeOrderedArray<HTMLSlotElement>;
 300   // Map from name of slot to an array of all slots in the shadow DOM with with
 301   // the given name. The slots are stored as a weak pointer because the elements
 302   // are in the shadow tree and should be kept alive by its parent.
 303   nsClassHashtable<nsStringHashKey, SlotArray> mSlotMap;
 304
 305   // Unordered array of all elements that have a part attribute in this shadow
 306   // tree.
 307   nsTArray<const Element*> mParts;
 308
 309   bool mIsUAWidget : 1;
 310
 311   // Whether this is the <details> internal shadow tree.
 312   bool mIsDetailsShadowTree : 1;
 313
 314   // https://dom.spec.whatwg.org/#shadowroot-available-to-element-internals
 315   bool mIsAvailableToElementInternals : 1;
 316
 317   nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;
 318 };
 319
 320 }  // namespace dom
 321 }  // namespace mozilla
 322
 323 #endif  // mozilla_dom_shadowroot_h__