dom/base/NodeInfo.cpp

   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 /*
   8  * Class that represents a prefix/namespace/localName triple; a single
   9  * nodeinfo is shared by all elements in a document that have that
  10  * prefix, namespace, and localName.
  11  */
  12
  13 #include "mozilla/dom/NodeInfo.h"
  14 #include "mozilla/dom/NodeInfoInlines.h"
  15
  16 #include "mozilla/ArrayUtils.h"
  17 #include "mozilla/Likely.h"
  18
  19 #include "nsNodeInfoManager.h"
  20 #include "nsCOMPtr.h"
  21 #include "nsString.h"
  22 #include "nsAtom.h"
  23 #include "nsDOMString.h"
  24 #include "nsCRT.h"
  25 #include "nsINode.h"
  26 #include "nsContentUtils.h"
  27 #include "nsReadableUtils.h"
  28 #include "mozilla/Sprintf.h"
  29 #include "mozilla/dom/Document.h"
  30 #include "nsGkAtoms.h"
  31 #include "nsCCUncollectableMarker.h"
  32 #include "nsNameSpaceManager.h"
  33
  34 using namespace mozilla;
  35 using mozilla::dom::NodeInfo;
  36
  37 NodeInfo::~NodeInfo() {
  38   mOwnerManager->RemoveNodeInfo(this);
  39
  40   // We can't use NS_IF_RELEASE because mName is const.
  41   if (mInner.mName) {
  42     mInner.mName->Release();
  43   }
  44   NS_IF_RELEASE(mInner.mPrefix);
  45   NS_IF_RELEASE(mInner.mExtraName);
  46 }
  47
  48 NodeInfo::NodeInfo(nsAtom* aName, nsAtom* aPrefix, int32_t aNamespaceID,
  49                    uint16_t aNodeType, nsAtom* aExtraName,
  50                    nsNodeInfoManager* aOwnerManager)
  51     : mDocument(aOwnerManager->GetDocument()),
  52       mInner(aName, aPrefix, aNamespaceID, aNodeType, aExtraName),
  53       mOwnerManager(aOwnerManager) {
  54   CheckValidNodeInfo(aNodeType, aName, aNamespaceID, aExtraName);
  55
  56   NS_IF_ADDREF(mInner.mName);
  57   NS_IF_ADDREF(mInner.mPrefix);
  58   NS_IF_ADDREF(mInner.mExtraName);
  59
  60   // Now compute our cached members.
  61
  62   // Qualified name.  If we have no prefix, use ToString on
  63   // mInner.mName so that we get to share its buffer.
  64   if (aPrefix) {
  65     mQualifiedName = nsDependentAtomString(mInner.mPrefix) + u":"_ns +
  66                      nsDependentAtomString(mInner.mName);
  67   } else {
  68     mInner.mName->ToString(mQualifiedName);
  69   }
  70
  71   MOZ_ASSERT_IF(aNodeType != nsINode::ELEMENT_NODE &&
  72                     aNodeType != nsINode::ATTRIBUTE_NODE &&
  73                     aNodeType != UINT16_MAX,
  74                 aNamespaceID == kNameSpaceID_None && !aPrefix);
  75
  76   switch (aNodeType) {
  77     case nsINode::ELEMENT_NODE:
  78     case nsINode::ATTRIBUTE_NODE:
  79       // Correct the case for HTML
  80       if (aNodeType == nsINode::ELEMENT_NODE &&
  81           aNamespaceID == kNameSpaceID_XHTML && GetDocument() &&
  82           GetDocument()->IsHTMLDocument()) {
  83         nsContentUtils::ASCIIToUpper(mQualifiedName, mNodeName);
  84       } else {
  85         mNodeName = mQualifiedName;
  86       }
  87       mInner.mName->ToString(mLocalName);
  88       break;
  89     case nsINode::TEXT_NODE:
  90     case nsINode::CDATA_SECTION_NODE:
  91     case nsINode::COMMENT_NODE:
  92     case nsINode::DOCUMENT_NODE:
  93     case nsINode::DOCUMENT_FRAGMENT_NODE:
  94       mInner.mName->ToString(mNodeName);
  95       SetDOMStringToNull(mLocalName);
  96       break;
  97     case nsINode::PROCESSING_INSTRUCTION_NODE:
  98     case nsINode::DOCUMENT_TYPE_NODE:
  99       mInner.mExtraName->ToString(mNodeName);
 100       SetDOMStringToNull(mLocalName);
 101       break;
 102     default:
 103       MOZ_ASSERT(aNodeType == UINT16_MAX, "Unknown node type");
 104   }
 105 }
 106
 107 // nsISupports
 108
 109 NS_IMPL_CYCLE_COLLECTION_CLASS(NodeInfo)
 110
 111 NS_IMPL_CYCLE_COLLECTION_UNLINK_0(NodeInfo)
 112
 113 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INTERNAL(NodeInfo)
 114   if (MOZ_UNLIKELY(cb.WantDebugInfo())) {
 115     char name[72];
 116     uint32_t nsid = tmp->NamespaceID();
 117     nsAtomCString localName(tmp->NameAtom());
 118     const char* nsuri = nsNameSpaceManager::GetNameSpaceDisplayName(nsid);
 119     SprintfLiteral(name, "NodeInfo %s %s", nsuri, localName.get());
 120
 121     cb.DescribeRefCountedNode(tmp->mRefCnt.get(), name);
 122   } else {
 123     NS_IMPL_CYCLE_COLLECTION_DESCRIBE(NodeInfo, tmp->mRefCnt.get())
 124   }
 125
 126   NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mOwnerManager)
 127 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
 128
 129 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_BEGIN(NodeInfo)
 130   return nsCCUncollectableMarker::sGeneration && tmp->CanSkip();
 131 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_END
 132
 133 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_IN_CC_BEGIN(NodeInfo)
 134   return nsCCUncollectableMarker::sGeneration && tmp->CanSkip();
 135 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_IN_CC_END
 136
 137 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_THIS_BEGIN(NodeInfo)
 138   return nsCCUncollectableMarker::sGeneration && tmp->CanSkip();
 139 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_THIS_END
 140
 141 void NodeInfo::GetName(nsAString& aName) const {
 142   mInner.mName->ToString(aName);
 143 }
 144
 145 void NodeInfo::GetPrefix(nsAString& aPrefix) const {
 146   if (mInner.mPrefix) {
 147     mInner.mPrefix->ToString(aPrefix);
 148   } else {
 149     SetDOMStringToNull(aPrefix);
 150   }
 151 }
 152
 153 void NodeInfo::GetNamespaceURI(nsAString& aNameSpaceURI) const {
 154   if (mInner.mNamespaceID > 0) {
 155     nsresult rv = nsNameSpaceManager::GetInstance()->GetNameSpaceURI(
 156         mInner.mNamespaceID, aNameSpaceURI);
 157     // How can we possibly end up with a bogus namespace ID here?
 158     if (NS_FAILED(rv)) {
 159       MOZ_CRASH();
 160     }
 161   } else {
 162     SetDOMStringToNull(aNameSpaceURI);
 163   }
 164 }
 165
 166 bool NodeInfo::NamespaceEquals(const nsAString& aNamespaceURI) const {
 167   int32_t nsid = nsNameSpaceManager::GetInstance()->GetNameSpaceID(
 168       aNamespaceURI, nsContentUtils::IsChromeDoc(mOwnerManager->GetDocument()));
 169
 170   return mozilla::dom::NodeInfo::NamespaceEquals(nsid);
 171 }
 172
 173 void NodeInfo::DeleteCycleCollectable() {
 174   RefPtr<nsNodeInfoManager> kungFuDeathGrip = mOwnerManager;
 175   mozilla::Unused
 176       << kungFuDeathGrip;  // Just keeping value alive for longer than this
 177   delete this;
 178 }
 179
 180 bool NodeInfo::CanSkip() {
 181   return mDocument && nsCCUncollectableMarker::InGeneration(
 182                           mDocument->GetMarkedCCGeneration());
 183 }