dom/xbl/XBLChildrenElement.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 sw=2 et tw=79: */
   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 nsXBLChildrenElement_h___
   8 #define nsXBLChildrenElement_h___
   9
  10 #include "nsIDOMElement.h"
  11 #include "nsINodeList.h"
  12 #include "nsBindingManager.h"
  13 #include "mozilla/dom/nsXMLElement.h"
  14
  15 class nsAnonymousContentList;
  16
  17 namespace mozilla {
  18 namespace dom {
  19
  20 class ExplicitChildIterator;
  21
  22 class XBLChildrenElement : public nsXMLElement
  23 {
  24 public:
  25   explicit XBLChildrenElement(already_AddRefed<mozilla::dom::NodeInfo>& aNodeInfo)
  26     : nsXMLElement(aNodeInfo)
  27   {
  28   }
  29   explicit XBLChildrenElement(already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo)
  30     : nsXMLElement(aNodeInfo)
  31   {
  32   }
  33
  34   // nsISupports
  35   NS_DECL_ISUPPORTS_INHERITED
  36
  37   // nsINode interface methods
  38   virtual nsresult Clone(mozilla::dom::NodeInfo* aNodeInfo, nsINode** aResult) const MOZ_OVERRIDE;
  39
  40   virtual nsIDOMNode* AsDOMNode() MOZ_OVERRIDE { return this; }
  41
  42   // nsIContent interface methods
  43   virtual nsresult UnsetAttr(int32_t aNameSpaceID, nsIAtom* aAttribute,
  44                              bool aNotify) MOZ_OVERRIDE;
  45   virtual bool ParseAttribute(int32_t aNamespaceID,
  46                               nsIAtom* aAttribute,
  47                               const nsAString& aValue,
  48                               nsAttrValue& aResult) MOZ_OVERRIDE;
  49
  50   void AppendInsertedChild(nsIContent* aChild)
  51   {
  52     mInsertedChildren.AppendElement(aChild);
  53     aChild->SetXBLInsertionParent(GetParent());
  54
  55     // Appending an inserted child causes the inserted
  56     // children to be projected instead of default content.
  57     MaybeRemoveDefaultContent();
  58   }
  59
  60   void InsertInsertedChildAt(nsIContent* aChild, uint32_t aIndex)
  61   {
  62     mInsertedChildren.InsertElementAt(aIndex, aChild);
  63     aChild->SetXBLInsertionParent(GetParent());
  64
  65     // Inserting an inserted child causes the inserted
  66     // children to be projected instead of default content.
  67     MaybeRemoveDefaultContent();
  68   }
  69
  70   void RemoveInsertedChild(nsIContent* aChild)
  71   {
  72     // Can't use this assertion as we cheat for dynamic insertions and
  73     // only insert in the innermost insertion point.
  74     //NS_ASSERTION(mInsertedChildren.Contains(aChild),
  75     //             "Removing child that's not there");
  76     mInsertedChildren.RemoveElement(aChild);
  77
  78     // After removing the inserted child, default content
  79     // may be projected into this insertion point.
  80     MaybeSetupDefaultContent();
  81   }
  82
  83   void ClearInsertedChildren()
  84   {
  85     for (uint32_t c = 0; c < mInsertedChildren.Length(); ++c) {
  86       mInsertedChildren[c]->SetXBLInsertionParent(nullptr);
  87     }
  88     mInsertedChildren.Clear();
  89
  90     // After clearing inserted children, default content
  91     // will be projected into this insertion point.
  92     MaybeSetupDefaultContent();
  93   }
  94
  95   void MaybeSetupDefaultContent()
  96   {
  97     if (!HasInsertedChildren()) {
  98       for (nsIContent* child = static_cast<nsINode*>(this)->GetFirstChild();
  99            child;
 100            child = child->GetNextSibling()) {
 101         child->SetXBLInsertionParent(GetParent());
 102       }
 103     }
 104   }
 105
 106   void MaybeRemoveDefaultContent()
 107   {
 108     if (!HasInsertedChildren()) {
 109       for (nsIContent* child = static_cast<nsINode*>(this)->GetFirstChild();
 110            child;
 111            child = child->GetNextSibling()) {
 112         child->SetXBLInsertionParent(nullptr);
 113       }
 114     }
 115   }
 116
 117   uint32_t InsertedChildrenLength()
 118   {
 119     return mInsertedChildren.Length();
 120   }
 121
 122   bool HasInsertedChildren()
 123   {
 124     return !mInsertedChildren.IsEmpty();
 125   }
 126
 127   int32_t IndexOfInsertedChild(nsIContent* aChild)
 128   {
 129     return mInsertedChildren.IndexOf(aChild);
 130   }
 131
 132   bool Includes(nsIContent* aChild)
 133   {
 134     NS_ASSERTION(!mIncludes.IsEmpty(),
 135                  "Shouldn't check for includes on default insertion point");
 136     return mIncludes.Contains(aChild->Tag());
 137   }
 138
 139   bool IsDefaultInsertion()
 140   {
 141     return mIncludes.IsEmpty();
 142   }
 143
 144   nsIContent* InsertedChild(uint32_t aIndex)
 145   {
 146     return mInsertedChildren[aIndex];
 147   }
 148
 149 protected:
 150   ~XBLChildrenElement();
 151
 152 private:
 153   nsTArray<nsIContent*> mInsertedChildren; // WEAK
 154   nsTArray<nsCOMPtr<nsIAtom> > mIncludes;
 155 };
 156
 157 } // namespace dom
 158 } // namespace mozilla
 159
 160 class nsAnonymousContentList : public nsINodeList
 161 {
 162 public:
 163   explicit nsAnonymousContentList(nsIContent* aParent)
 164     : mParent(aParent)
 165   {
 166     MOZ_COUNT_CTOR(nsAnonymousContentList);
 167   }
 168
 169   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
 170   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(nsAnonymousContentList)
 171   // nsIDOMNodeList interface
 172   NS_DECL_NSIDOMNODELIST
 173
 174   // nsINodeList interface
 175   virtual int32_t IndexOf(nsIContent* aContent) MOZ_OVERRIDE;
 176   virtual nsINode* GetParentObject() MOZ_OVERRIDE { return mParent; }
 177   virtual nsIContent* Item(uint32_t aIndex) MOZ_OVERRIDE;
 178
 179   virtual JSObject* WrapObject(JSContext *cx) MOZ_OVERRIDE;
 180
 181   bool IsListFor(nsIContent* aContent) {
 182     return mParent == aContent;
 183   }
 184
 185 private:
 186   virtual ~nsAnonymousContentList()
 187   {
 188     MOZ_COUNT_DTOR(nsAnonymousContentList);
 189   }
 190
 191   nsCOMPtr<nsIContent> mParent;
 192 };
 193
 194 #endif // nsXBLChildrenElement_h___