1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
/* -*- 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/. */
/*
* Class that represents a prefix/namespace/localName triple; a single
* nodeinfo is shared by all elements in a document that have that
* prefix, namespace, and localName.
*
* nsNodeInfoManagers are internal objects that manage a list of
* NodeInfos, every document object should hold a strong reference to
* a nsNodeInfoManager and every NodeInfo also holds a strong reference
* to their owning manager. When a NodeInfo is no longer used it will
* automatically remove itself from its owner manager, and when all
* NodeInfos have been removed from a nsNodeInfoManager and all external
* references are released the nsNodeInfoManager deletes itself.
*/
#ifndef mozilla_dom_NodeInfo_h___
#define mozilla_dom_NodeInfo_h___
#include "nsCycleCollectionParticipant.h"
#include "mozilla/dom/NameSpaceConstants.h"
#include "nsString.h"
#include "mozilla/Attributes.h"
#include "mozilla/Maybe.h"
#include "nsAtom.h"
#include "nsHashKeys.h"
class nsNodeInfoManager;
namespace mozilla::dom {
class Document;
class NodeInfo final {
public:
NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(NodeInfo)
NS_DECL_CYCLE_COLLECTION_SKIPPABLE_NATIVE_CLASS_WITH_CUSTOM_DELETE(NodeInfo)
/*
* Get the name from this node as a string, this does not include the prefix.
*
* For the HTML element "<body>" this will return "body" and for the XML
* element "<html:body>" this will return "body".
*/
void GetName(nsAString& aName) const;
/*
* Get the name from this node as an atom, this does not include the prefix.
* This function never returns a null atom.
*
* For the HTML element "<body>" this will return the "body" atom and for
* the XML element "<html:body>" this will return the "body" atom.
*/
nsAtom* NameAtom() const { return mInner.mName; }
/*
* Get the qualified name from this node as a string, the qualified name
* includes the prefix, if one exists.
*
* For the HTML element "<body>" this will return "body" and for the XML
* element "<html:body>" this will return "html:body".
*/
const nsString& QualifiedName() const { return mQualifiedName; }
/*
* Returns the node's nodeName as defined in DOM Core
*/
const nsString& NodeName() const { return mNodeName; }
/*
* Returns the node's localName as defined in DOM Core
*/
const nsString& LocalName() const { return mLocalName; }
/*
* Get the prefix from this node as a string.
*
* For the HTML element "<body>" this will return a null string and for
* the XML element "<html:body>" this will return the string "html".
*/
void GetPrefix(nsAString& aPrefix) const;
/*
* Get the prefix from this node as an atom.
*
* For the HTML element "<body>" this will return a null atom and for
* the XML element "<html:body>" this will return the "html" atom.
*/
nsAtom* GetPrefixAtom() const { return mInner.mPrefix; }
/*
* Get the namespace URI for a node, if the node has a namespace URI.
*/
void GetNamespaceURI(nsAString& aNameSpaceURI) const;
/*
* Get the namespace ID for a node if the node has a namespace, if not this
* returns kNameSpaceID_None.
*/
int32_t NamespaceID() const { return mInner.mNamespaceID; }
/*
* Get the nodetype for the node. Returns the values specified in Node
* for Node.nodeType
*/
uint16_t NodeType() const { return mInner.mNodeType; }
/*
* Get the extra name, used by PIs and DocTypes, for the node.
*/
nsAtom* GetExtraName() const { return mInner.mExtraName; }
/**
* Get the owning node info manager. Only to be used inside Gecko, you can't
* really do anything with the pointer outside Gecko anyway.
*/
nsNodeInfoManager* NodeInfoManager() const { return mOwnerManager; }
/*
* Utility functions that can be used to check if a nodeinfo holds a specific
* name, name and prefix, name and prefix and namespace ID, or just
* namespace ID.
*/
inline bool Equals(NodeInfo* aNodeInfo) const;
bool NameAndNamespaceEquals(NodeInfo* aNodeInfo) const;
bool Equals(const nsAtom* aNameAtom) const {
return mInner.mName == aNameAtom;
}
bool Equals(const nsAtom* aNameAtom, const nsAtom* aPrefixAtom) const {
return (mInner.mName == aNameAtom) && (mInner.mPrefix == aPrefixAtom);
}
bool Equals(const nsAtom* aNameAtom, int32_t aNamespaceID) const {
return ((mInner.mName == aNameAtom) &&
(mInner.mNamespaceID == aNamespaceID));
}
bool Equals(const nsAtom* aNameAtom, const nsAtom* aPrefixAtom,
int32_t aNamespaceID) const {
return ((mInner.mName == aNameAtom) && (mInner.mPrefix == aPrefixAtom) &&
(mInner.mNamespaceID == aNamespaceID));
}
bool NamespaceEquals(int32_t aNamespaceID) const {
return mInner.mNamespaceID == aNamespaceID;
}
inline bool Equals(const nsAString& aName) const;
inline bool Equals(const nsAString& aName, const nsAString& aPrefix) const;
inline bool Equals(const nsAString& aName, int32_t aNamespaceID) const;
inline bool Equals(const nsAString& aName, const nsAString& aPrefix,
int32_t aNamespaceID) const;
bool NamespaceEquals(const nsAString& aNamespaceURI) const;
inline bool QualifiedNameEquals(const nsAtom* aNameAtom) const;
bool QualifiedNameEquals(const nsAString& aQualifiedName) const {
return mQualifiedName == aQualifiedName;
}
/*
* Retrieve a pointer to the document that owns this node info.
*/
Document* GetDocument() const { return mDocument; }
private:
NodeInfo() = delete;
NodeInfo(const NodeInfo& aOther) = delete;
// NodeInfo is only constructed by nsNodeInfoManager which is a friend class.
// aName and aOwnerManager may not be null.
NodeInfo(nsAtom* aName, nsAtom* aPrefix, int32_t aNamespaceID,
uint16_t aNodeType, nsAtom* aExtraName,
nsNodeInfoManager* aOwnerManager);
~NodeInfo();
public:
bool CanSkip();
/**
* This method gets called by the cycle collector when it's time to delete
* this object.
*/
void DeleteCycleCollectable();
protected:
/*
* NodeInfoInner is used for two things:
*
* 1. as a member in nsNodeInfo for holding the name, prefix and
* namespace ID
* 2. as the hash key in the hash table in nsNodeInfoManager
*
* NodeInfoInner does not do any kind of reference counting,
* that's up to the user of this class. Since NodeInfoInner is
* typically used as a member of NodeInfo, the hash table doesn't
* need to delete the keys. When the value (NodeInfo) is deleted
* the key is automatically deleted.
*/
class NodeInfoInner {
public:
NodeInfoInner()
: mName(nullptr),
mPrefix(nullptr),
mNamespaceID(kNameSpaceID_Unknown),
mNodeType(0),
mNameString(nullptr),
mExtraName(nullptr),
mHash() {}
NodeInfoInner(nsAtom* aName, nsAtom* aPrefix, int32_t aNamespaceID,
uint16_t aNodeType, nsAtom* aExtraName)
: mName(aName),
mPrefix(aPrefix),
mNamespaceID(aNamespaceID),
mNodeType(aNodeType),
mNameString(nullptr),
mExtraName(aExtraName),
mHash() {}
NodeInfoInner(const nsAString& aTmpName, nsAtom* aPrefix,
int32_t aNamespaceID, uint16_t aNodeType)
: mName(nullptr),
mPrefix(aPrefix),
mNamespaceID(aNamespaceID),
mNodeType(aNodeType),
mNameString(&aTmpName),
mExtraName(nullptr),
mHash() {}
bool operator==(const NodeInfoInner& aOther) const {
if (mPrefix != aOther.mPrefix || mNamespaceID != aOther.mNamespaceID ||
mNodeType != aOther.mNodeType || mExtraName != aOther.mExtraName) {
return false;
}
if (mName) {
if (aOther.mName) {
return mName == aOther.mName;
}
return mName->Equals(*(aOther.mNameString));
}
if (aOther.mName) {
return aOther.mName->Equals(*(mNameString));
}
return mNameString->Equals(*(aOther.mNameString));
}
uint32_t Hash() const {
if (!mHash) {
mHash.emplace(mName ? mName->hash()
: mozilla::HashString(*mNameString));
}
return mHash.value();
}
nsAtom* const MOZ_OWNING_REF mName;
nsAtom* MOZ_OWNING_REF mPrefix;
int32_t mNamespaceID;
uint16_t mNodeType; // As defined by Node.nodeType
const nsAString* const mNameString;
nsAtom* MOZ_OWNING_REF mExtraName; // Only used by PIs and DocTypes
mutable mozilla::Maybe<const uint32_t> mHash;
};
// nsNodeInfoManager needs to pass mInner to the hash table.
friend class ::nsNodeInfoManager;
// This is a non-owning reference, but it's safe since it's set to nullptr
// by nsNodeInfoManager::DropDocumentReference when the document is destroyed.
Document* MOZ_NON_OWNING_REF mDocument; // Cache of mOwnerManager->mDocument
NodeInfoInner mInner;
RefPtr<nsNodeInfoManager> mOwnerManager;
/*
* Members for various functions of mName+mPrefix that we can be
* asked to compute.
*/
// Qualified name
nsString mQualifiedName;
// nodeName for the node.
nsString mNodeName;
// localName for the node. This is either equal to mInner.mName, or a
// void string, depending on mInner.mNodeType.
nsString mLocalName;
};
} // namespace mozilla::dom
#endif /* mozilla_dom_NodeInfo_h___ */
|
