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 "nsIDocument.h"
30 #include "nsGkAtoms.h"
31 #include "nsCCUncollectableMarker.h"
32 #include "nsNameSpaceManager.h"
33 
34 using namespace mozilla;
35 using mozilla::dom::NodeInfo;
36 
~NodeInfo()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 
NodeInfo(nsAtom * aName,nsAtom * aPrefix,int32_t aNamespaceID,uint16_t aNodeType,nsAtom * aExtraName,nsNodeInfoManager * aOwnerManager)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) +
66                      NS_LITERAL_STRING(":") +
67                      nsDependentAtomString(mInner.mName);
68   } else {
69     mInner.mName->ToString(mQualifiedName);
70   }
71 
72   MOZ_ASSERT_IF(aNodeType != nsINode::ELEMENT_NODE &&
73                     aNodeType != nsINode::ATTRIBUTE_NODE &&
74                     aNodeType != UINT16_MAX,
75                 aNamespaceID == kNameSpaceID_None && !aPrefix);
76 
77   switch (aNodeType) {
78     case nsINode::ELEMENT_NODE:
79     case nsINode::ATTRIBUTE_NODE:
80       // Correct the case for HTML
81       if (aNodeType == nsINode::ELEMENT_NODE &&
82           aNamespaceID == kNameSpaceID_XHTML && GetDocument() &&
83           GetDocument()->IsHTMLDocument()) {
84         nsContentUtils::ASCIIToUpper(mQualifiedName, mNodeName);
85       } else {
86         mNodeName = mQualifiedName;
87       }
88       mInner.mName->ToString(mLocalName);
89       break;
90     case nsINode::TEXT_NODE:
91     case nsINode::CDATA_SECTION_NODE:
92     case nsINode::COMMENT_NODE:
93     case nsINode::DOCUMENT_NODE:
94     case nsINode::DOCUMENT_FRAGMENT_NODE:
95       mInner.mName->ToString(mNodeName);
96       SetDOMStringToNull(mLocalName);
97       break;
98     case nsINode::PROCESSING_INSTRUCTION_NODE:
99     case nsINode::DOCUMENT_TYPE_NODE:
100       mInner.mExtraName->ToString(mNodeName);
101       SetDOMStringToNull(mLocalName);
102       break;
103     default:
104       MOZ_ASSERT(aNodeType == UINT16_MAX, "Unknown node type");
105   }
106 }
107 
108 // nsISupports
109 
110 NS_IMPL_CYCLE_COLLECTION_CLASS(NodeInfo)
111 
112 NS_IMPL_CYCLE_COLLECTION_UNLINK_0(NodeInfo)
113 
114 static const char* kNodeInfoNSURIs[] = {
115     " ([none])", " (xmlns)", " (xml)",    " (xhtml)", " (XLink)",
116     " (XSLT)",   " (XBL)",   " (MathML)", " (RDF)",   " (XUL)"};
117 
118 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INTERNAL(NodeInfo)
119   if (MOZ_UNLIKELY(cb.WantDebugInfo())) {
120     char name[72];
121     uint32_t nsid = tmp->NamespaceID();
122     nsAtomCString localName(tmp->NameAtom());
123     if (nsid < ArrayLength(kNodeInfoNSURIs)) {
124       SprintfLiteral(name, "NodeInfo%s %s", kNodeInfoNSURIs[nsid],
125                      localName.get());
126     } else {
127       SprintfLiteral(name, "NodeInfo %s", localName.get());
128     }
129 
130     cb.DescribeRefCountedNode(tmp->mRefCnt.get(), name);
131   } else {
132     NS_IMPL_CYCLE_COLLECTION_DESCRIBE(NodeInfo, tmp->mRefCnt.get())
133   }
134 
135   NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mOwnerManager)
136 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
137 
138 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_BEGIN(NodeInfo)
139   return nsCCUncollectableMarker::sGeneration && tmp->CanSkip();
140 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_END
141 
142 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_IN_CC_BEGIN(NodeInfo)
143   return nsCCUncollectableMarker::sGeneration && tmp->CanSkip();
144 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_IN_CC_END
145 
146 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_THIS_BEGIN(NodeInfo)
147   return nsCCUncollectableMarker::sGeneration && tmp->CanSkip();
148 NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_THIS_END
149 
NS_IMPL_CYCLE_COLLECTION_ROOT_NATIVE(NodeInfo,AddRef)150 NS_IMPL_CYCLE_COLLECTION_ROOT_NATIVE(NodeInfo, AddRef)
151 NS_IMPL_CYCLE_COLLECTION_UNROOT_NATIVE(NodeInfo, Release)
152 
153 void NodeInfo::GetName(nsAString& aName) const {
154   mInner.mName->ToString(aName);
155 }
156 
GetPrefix(nsAString & aPrefix) const157 void NodeInfo::GetPrefix(nsAString& aPrefix) const {
158   if (mInner.mPrefix) {
159     mInner.mPrefix->ToString(aPrefix);
160   } else {
161     SetDOMStringToNull(aPrefix);
162   }
163 }
164 
GetNamespaceURI(nsAString & aNameSpaceURI) const165 void NodeInfo::GetNamespaceURI(nsAString& aNameSpaceURI) const {
166   if (mInner.mNamespaceID > 0) {
167     nsresult rv = nsContentUtils::NameSpaceManager()->GetNameSpaceURI(
168         mInner.mNamespaceID, aNameSpaceURI);
169     // How can we possibly end up with a bogus namespace ID here?
170     if (NS_FAILED(rv)) {
171       MOZ_CRASH();
172     }
173   } else {
174     SetDOMStringToNull(aNameSpaceURI);
175   }
176 }
177 
NamespaceEquals(const nsAString & aNamespaceURI) const178 bool NodeInfo::NamespaceEquals(const nsAString& aNamespaceURI) const {
179   int32_t nsid = nsContentUtils::NameSpaceManager()->GetNameSpaceID(
180       aNamespaceURI, nsContentUtils::IsChromeDoc(mOwnerManager->GetDocument()));
181 
182   return mozilla::dom::NodeInfo::NamespaceEquals(nsid);
183 }
184 
DeleteCycleCollectable()185 void NodeInfo::DeleteCycleCollectable() {
186   RefPtr<nsNodeInfoManager> kungFuDeathGrip = mOwnerManager;
187   mozilla::Unused
188       << kungFuDeathGrip;  // Just keeping value alive for longer than this
189   delete this;
190 }
191 
CanSkip()192 bool NodeInfo::CanSkip() {
193   return mDocument && nsCCUncollectableMarker::InGeneration(
194                           mDocument->GetMarkedCCGeneration());
195 }
196