Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / dom / Node.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
6  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #pragma once
26
27 #include "EventTarget.h"
28 #include "ExceptionOr.h"
29 #include "LayoutRect.h"
30 #include "MutationObserver.h"
31 #include "RenderStyleConstants.h"
32 #include "StyleValidity.h"
33 #include "TreeScope.h"
34 #include <wtf/Forward.h>
35 #include <wtf/IsoMalloc.h>
36 #include <wtf/ListHashSet.h>
37 #include <wtf/MainThread.h>
38 #include <wtf/URLHash.h>
39
40 // This needs to be here because Document.h also depends on it.
41 #define DUMP_NODE_STATISTICS 0
42
43 namespace WebCore {
44
45 class ContainerNode;
46 class Document;
47 class Element;
48 class FloatPoint;
49 class HTMLQualifiedName;
50 class HTMLSlotElement;
51 class MathMLQualifiedName;
52 class NamedNodeMap;
53 class NodeList;
54 class NodeListsNodeData;
55 class NodeRareData;
56 class QualifiedName;
57 class RenderBox;
58 class RenderBoxModelObject;
59 class RenderObject;
60 class RenderStyle;
61 class SVGQualifiedName;
62 class ShadowRoot;
63 class TouchEvent;
64
65 using NodeOrString = Variant<RefPtr<Node>, String>;
66
67 class NodeRareDataBase {
68 public:
69     RenderObject* renderer() const { return m_renderer; }
70     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
71
72 protected:
73     NodeRareDataBase(RenderObject* renderer)
74         : m_renderer(renderer)
75     { }
76
77 private:
78     RenderObject* m_renderer;
79 };
80
81 class Node : public EventTarget {
82     WTF_MAKE_ISO_ALLOCATED(Node);
83
84     friend class Document;
85     friend class TreeScope;
86 public:
87     enum NodeType {
88         ELEMENT_NODE = 1,
89         ATTRIBUTE_NODE = 2,
90         TEXT_NODE = 3,
91         CDATA_SECTION_NODE = 4,
92         PROCESSING_INSTRUCTION_NODE = 7,
93         COMMENT_NODE = 8,
94         DOCUMENT_NODE = 9,
95         DOCUMENT_TYPE_NODE = 10,
96         DOCUMENT_FRAGMENT_NODE = 11,
97     };
98     enum DeprecatedNodeType {
99         ENTITY_REFERENCE_NODE = 5,
100         ENTITY_NODE = 6,
101         NOTATION_NODE = 12,
102     };
103     enum DocumentPosition {
104         DOCUMENT_POSITION_EQUIVALENT = 0x00,
105         DOCUMENT_POSITION_DISCONNECTED = 0x01,
106         DOCUMENT_POSITION_PRECEDING = 0x02,
107         DOCUMENT_POSITION_FOLLOWING = 0x04,
108         DOCUMENT_POSITION_CONTAINS = 0x08,
109         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
110         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
111     };
112
113     WEBCORE_EXPORT static void startIgnoringLeaks();
114     WEBCORE_EXPORT static void stopIgnoringLeaks();
115
116     static void dumpStatistics();
117
118     virtual ~Node();
119     void willBeDeletedFrom(Document&);
120
121     // DOM methods & attributes for Node
122
123     bool hasTagName(const HTMLQualifiedName&) const;
124     bool hasTagName(const MathMLQualifiedName&) const;
125     bool hasTagName(const SVGQualifiedName&) const;
126     virtual String nodeName() const = 0;
127     virtual String nodeValue() const;
128     virtual ExceptionOr<void> setNodeValue(const String&);
129     virtual NodeType nodeType() const = 0;
130     virtual size_t approximateMemoryCost() const { return sizeof(*this); }
131     ContainerNode* parentNode() const;
132     static ptrdiff_t parentNodeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_parentNode); }
133     Element* parentElement() const;
134     Node* previousSibling() const { return m_previous; }
135     static ptrdiff_t previousSiblingMemoryOffset() { return OBJECT_OFFSETOF(Node, m_previous); }
136     Node* nextSibling() const { return m_next; }
137     static ptrdiff_t nextSiblingMemoryOffset() { return OBJECT_OFFSETOF(Node, m_next); }
138     WEBCORE_EXPORT RefPtr<NodeList> childNodes();
139     Node* firstChild() const;
140     Node* lastChild() const;
141     bool hasAttributes() const;
142     NamedNodeMap* attributes() const;
143     Node* pseudoAwareNextSibling() const;
144     Node* pseudoAwarePreviousSibling() const;
145     Node* pseudoAwareFirstChild() const;
146     Node* pseudoAwareLastChild() const;
147
148     WEBCORE_EXPORT const URL& baseURI() const;
149     
150     void getSubresourceURLs(ListHashSet<URL>&) const;
151
152     WEBCORE_EXPORT ExceptionOr<void> insertBefore(Node& newChild, Node* refChild);
153     WEBCORE_EXPORT ExceptionOr<void> replaceChild(Node& newChild, Node& oldChild);
154     WEBCORE_EXPORT ExceptionOr<void> removeChild(Node& child);
155     WEBCORE_EXPORT ExceptionOr<void> appendChild(Node& newChild);
156
157     bool hasChildNodes() const { return firstChild(); }
158
159     enum class CloningOperation {
160         OnlySelf,
161         SelfWithTemplateContent,
162         Everything,
163     };
164     virtual Ref<Node> cloneNodeInternal(Document&, CloningOperation) = 0;
165     Ref<Node> cloneNode(bool deep) { return cloneNodeInternal(document(), deep ? CloningOperation::Everything : CloningOperation::OnlySelf); }
166     WEBCORE_EXPORT ExceptionOr<Ref<Node>> cloneNodeForBindings(bool deep);
167
168     virtual const AtomicString& localName() const;
169     virtual const AtomicString& namespaceURI() const;
170     virtual const AtomicString& prefix() const;
171     virtual ExceptionOr<void> setPrefix(const AtomicString&);
172     WEBCORE_EXPORT void normalize();
173
174     bool isSameNode(Node* other) const { return this == other; }
175     WEBCORE_EXPORT bool isEqualNode(Node*) const;
176     WEBCORE_EXPORT bool isDefaultNamespace(const AtomicString& namespaceURI) const;
177     WEBCORE_EXPORT const AtomicString& lookupPrefix(const AtomicString& namespaceURI) const;
178     WEBCORE_EXPORT const AtomicString& lookupNamespaceURI(const AtomicString& prefix) const;
179
180     WEBCORE_EXPORT String textContent(bool convertBRsToNewlines = false) const;
181     WEBCORE_EXPORT ExceptionOr<void> setTextContent(const String&);
182     
183     Node* lastDescendant() const;
184     Node* firstDescendant() const;
185
186     // From the NonDocumentTypeChildNode - https://dom.spec.whatwg.org/#nondocumenttypechildnode
187     WEBCORE_EXPORT Element* previousElementSibling() const;
188     WEBCORE_EXPORT Element* nextElementSibling() const;
189
190     // From the ChildNode - https://dom.spec.whatwg.org/#childnode
191     ExceptionOr<void> before(Vector<NodeOrString>&&);
192     ExceptionOr<void> after(Vector<NodeOrString>&&);
193     ExceptionOr<void> replaceWith(Vector<NodeOrString>&&);
194     WEBCORE_EXPORT ExceptionOr<void> remove();
195
196     // Other methods (not part of DOM)
197
198     bool isElementNode() const { return getFlag(IsElementFlag); }
199     bool isContainerNode() const { return getFlag(IsContainerFlag); }
200     bool isTextNode() const { return getFlag(IsTextFlag); }
201     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
202     bool isSVGElement() const { return getFlag(IsSVGFlag); }
203     bool isMathMLElement() const { return getFlag(IsMathMLFlag); }
204
205     bool isPseudoElement() const { return pseudoId() != PseudoId::None; }
206     bool isBeforePseudoElement() const { return pseudoId() == PseudoId::Before; }
207     bool isAfterPseudoElement() const { return pseudoId() == PseudoId::After; }
208     PseudoId pseudoId() const { return (isElementNode() && hasCustomStyleResolveCallbacks()) ? customPseudoId() : PseudoId::None; }
209
210     virtual bool isMediaControlElement() const { return false; }
211     virtual bool isMediaControls() const { return false; }
212 #if ENABLE(VIDEO_TRACK)
213     virtual bool isWebVTTElement() const { return false; }
214 #endif
215     bool isStyledElement() const { return getFlag(IsHTMLFlag) || getFlag(IsSVGFlag) || getFlag(IsMathMLFlag); }
216     virtual bool isAttributeNode() const { return false; }
217     virtual bool isCharacterDataNode() const { return false; }
218     virtual bool isFrameOwnerElement() const { return false; }
219     virtual bool isPluginElement() const { return false; }
220 #if ENABLE(SERVICE_CONTROLS)
221     virtual bool isImageControlsRootElement() const { return false; }
222     virtual bool isImageControlsButtonElement() const { return false; }
223 #endif
224
225     bool isDocumentNode() const { return getFlag(IsDocumentNodeFlag); }
226     bool isTreeScope() const { return getFlag(IsDocumentNodeFlag) || getFlag(IsShadowRootFlag); }
227     bool isDocumentFragment() const { return getFlag(IsContainerFlag) && !(getFlag(IsElementFlag) || getFlag(IsDocumentNodeFlag)); }
228     bool isShadowRoot() const { return getFlag(IsShadowRootFlag); }
229
230     bool hasCustomStyleResolveCallbacks() const { return getFlag(HasCustomStyleResolveCallbacksFlag); }
231
232     bool hasSyntheticAttrChildNodes() const { return getFlag(HasSyntheticAttrChildNodesFlag); }
233     void setHasSyntheticAttrChildNodes(bool flag) { setFlag(flag, HasSyntheticAttrChildNodesFlag); }
234
235     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns null.
236     WEBCORE_EXPORT Element* shadowHost() const;
237     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns this.
238     // Deprecated. Should use shadowHost() and check the return value.
239     WEBCORE_EXPORT Node* deprecatedShadowAncestorNode() const;
240     ShadowRoot* containingShadowRoot() const;
241     ShadowRoot* shadowRoot() const;
242     bool isClosedShadowHidden(const Node&) const;
243
244     HTMLSlotElement* assignedSlot() const;
245     HTMLSlotElement* assignedSlotForBindings() const;
246
247     bool isUndefinedCustomElement() const { return isElementNode() && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
248     bool isCustomElementUpgradeCandidate() const { return getFlag(IsCustomElement) && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
249     bool isDefinedCustomElement() const { return getFlag(IsCustomElement) && !getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
250     bool isFailedCustomElement() const { return isElementNode() && !getFlag(IsCustomElement) && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
251
252     // Returns null, a child of ShadowRoot, or a legacy shadow root.
253     Node* nonBoundaryShadowTreeRootNode();
254
255     // Node's parent or shadow tree host.
256     ContainerNode* parentOrShadowHostNode() const;
257     ContainerNode* parentInComposedTree() const;
258     Element* parentElementInComposedTree() const;
259     Element* parentOrShadowHostElement() const;
260     void setParentNode(ContainerNode*);
261     Node& rootNode() const;
262     Node& traverseToRootNode() const;
263     Node& shadowIncludingRoot() const;
264
265     struct GetRootNodeOptions {
266         bool composed;
267     };
268     Node& getRootNode(const GetRootNodeOptions&) const;
269     
270     void* opaqueRoot() const;
271
272     // Use when it's guaranteed to that shadowHost is null.
273     ContainerNode* parentNodeGuaranteedHostFree() const;
274     // Returns the parent node, but null if the parent node is a ShadowRoot.
275     ContainerNode* nonShadowBoundaryParentNode() const;
276
277     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
278     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
279
280     // Returns the enclosing event parent Element (or self) that, when clicked, would trigger a navigation.
281     Element* enclosingLinkEventParentOrSelf();
282
283     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
284     void setPreviousSibling(Node* previous) { m_previous = previous; }
285     void setNextSibling(Node* next) { m_next = next; }
286
287     virtual bool canContainRangeEndPoint() const { return false; }
288
289     bool isRootEditableElement() const;
290     WEBCORE_EXPORT Element* rootEditableElement() const;
291
292     // Called by the parser when this element's close tag is reached,
293     // signaling that all child tags have been parsed and added.
294     // This is needed for <applet> and <object> elements, which can't lay themselves out
295     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
296     // Also used for script elements and some SVG elements for similar purposes,
297     // but making parsing a special case in this respect should be avoided if possible.
298     virtual void finishParsingChildren() { }
299     virtual void beginParsingChildren() { }
300
301     // For <link> and <style> elements.
302     virtual bool sheetLoaded() { return true; }
303     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
304     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
305
306     bool isUserActionElement() const { return getFlag(IsUserActionElement); }
307     void setUserActionElement(bool flag) { setFlag(flag, IsUserActionElement); }
308
309     bool inRenderedDocument() const;
310     bool needsStyleRecalc() const { return styleValidity() != Style::Validity::Valid; }
311     Style::Validity styleValidity() const;
312     bool styleResolutionShouldRecompositeLayer() const;
313     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
314     bool styleIsAffectedByPreviousSibling() const { return getFlag(StyleIsAffectedByPreviousSibling); }
315     bool isEditingText() const { return getFlag(IsTextFlag) && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
316
317     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
318     void clearChildNeedsStyleRecalc() { m_nodeFlags &= ~(ChildNeedsStyleRecalcFlag | DirectChildNeedsStyleRecalcFlag); }
319
320     void setHasValidStyle();
321
322     bool isLink() const { return getFlag(IsLinkFlag); }
323     void setIsLink(bool flag) { setFlag(flag, IsLinkFlag); }
324
325     bool hasEventTargetData() const { return getFlag(HasEventTargetDataFlag); }
326     void setHasEventTargetData(bool flag) { setFlag(flag, HasEventTargetDataFlag); }
327
328     enum UserSelectAllTreatment {
329         UserSelectAllDoesNotAffectEditability,
330         UserSelectAllIsAlwaysNonEditable
331     };
332     WEBCORE_EXPORT bool isContentEditable();
333     bool isContentRichlyEditable();
334
335     WEBCORE_EXPORT void inspect();
336
337     bool hasEditableStyle(UserSelectAllTreatment treatment = UserSelectAllIsAlwaysNonEditable) const
338     {
339         return computeEditability(treatment, ShouldUpdateStyle::DoNotUpdate) != Editability::ReadOnly;
340     }
341     // FIXME: Replace every use of this function by helpers in Editing.h
342     bool hasRichlyEditableStyle() const
343     {
344         return computeEditability(UserSelectAllIsAlwaysNonEditable, ShouldUpdateStyle::DoNotUpdate) == Editability::CanEditRichly;
345     }
346
347     enum class Editability { ReadOnly, CanEditPlainText, CanEditRichly };
348     enum class ShouldUpdateStyle { Update, DoNotUpdate };
349     WEBCORE_EXPORT Editability computeEditability(UserSelectAllTreatment, ShouldUpdateStyle) const;
350
351     WEBCORE_EXPORT LayoutRect renderRect(bool* isReplaced);
352     IntRect pixelSnappedRenderRect(bool* isReplaced) { return snappedIntRect(renderRect(isReplaced)); }
353
354     WEBCORE_EXPORT unsigned computeNodeIndex() const;
355
356     // Returns the DOM ownerDocument attribute. This method never returns null, except in the case
357     // of a Document node.
358     WEBCORE_EXPORT Document* ownerDocument() const;
359
360     // Returns the document associated with this node.
361     // A Document node returns itself.
362     Document& document() const
363     {
364         return treeScope().documentScope();
365     }
366
367     TreeScope& treeScope() const
368     {
369         ASSERT(m_treeScope);
370         return *m_treeScope;
371     }
372     void setTreeScopeRecursively(TreeScope&);
373     static ptrdiff_t treeScopeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_treeScope); }
374
375     // Returns true if this node is associated with a document and is in its associated document's
376     // node tree, false otherwise (https://dom.spec.whatwg.org/#connected).
377     bool isConnected() const
378     { 
379         return getFlag(IsConnectedFlag);
380     }
381     bool isInUserAgentShadowTree() const;
382     bool isInShadowTree() const { return getFlag(IsInShadowTreeFlag); }
383     bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(IsConnectedFlag | IsInShadowTreeFlag)); }
384
385     bool isDocumentTypeNode() const { return nodeType() == DOCUMENT_TYPE_NODE; }
386     virtual bool childTypeAllowed(NodeType) const { return false; }
387     unsigned countChildNodes() const;
388     Node* traverseToChildAt(unsigned) const;
389
390     ExceptionOr<void> checkSetPrefix(const AtomicString& prefix);
391
392     WEBCORE_EXPORT bool isDescendantOf(const Node&) const;
393     bool isDescendantOf(const Node* other) const { return other && isDescendantOf(*other); }
394
395     bool isDescendantOrShadowDescendantOf(const Node*) const;
396     WEBCORE_EXPORT bool contains(const Node*) const;
397     bool containsIncludingShadowDOM(const Node*) const;
398     bool containsIncludingHostElements(const Node*) const;
399
400     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
401     // css-transform:capitalize breaking up precomposed characters and ligatures.
402     virtual int maxCharacterOffset() const;
403
404     // Whether or not a selection can be started in this object
405     virtual bool canStartSelection() const;
406
407     virtual bool shouldSelectOnMouseDown() { return false; }
408
409     // Getting points into and out of screen space
410     FloatPoint convertToPage(const FloatPoint&) const;
411     FloatPoint convertFromPage(const FloatPoint&) const;
412
413     // -----------------------------------------------------------------------------
414     // Integration with rendering tree
415
416     // As renderer() includes a branch you should avoid calling it repeatedly in hot code paths.
417     RenderObject* renderer() const { return hasRareData() ? m_data.m_rareData->renderer() : m_data.m_renderer; };
418     void setRenderer(RenderObject* renderer)
419     {
420         if (hasRareData())
421             m_data.m_rareData->setRenderer(renderer);
422         else
423             m_data.m_renderer = renderer;
424     }
425
426     // Use these two methods with caution.
427     WEBCORE_EXPORT RenderBox* renderBox() const;
428     RenderBoxModelObject* renderBoxModelObject() const;
429     
430     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
431     const RenderStyle* renderStyle() const;
432
433     virtual const RenderStyle* computedStyle(PseudoId pseudoElementSpecifier = PseudoId::None);
434
435     enum class InsertedIntoAncestorResult {
436         Done,
437         NeedsPostInsertionCallback,
438     };
439
440     struct InsertionType {
441         bool connectedToDocument { false };
442         bool treeScopeChanged { false };
443     };
444     // Called *after* this node or its ancestor is inserted into a new parent (may or may not be a part of document) by scripts or parser.
445     // insertedInto **MUST NOT** invoke scripts. Return NeedsPostInsertionCallback and implement didFinishInsertingNode instead to run scripts.
446     virtual InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode& parentOfInsertedTree);
447     virtual void didFinishInsertingNode() { }
448
449     struct RemovalType {
450         bool disconnectedFromDocument { false };
451         bool treeScopeChanged { false };
452     };
453     virtual void removedFromAncestor(RemovalType, ContainerNode& oldParentOfRemovedTree);
454
455 #if ENABLE(TREE_DEBUGGING)
456     virtual void formatForDebugger(char* buffer, unsigned length) const;
457
458     void showNode(const char* prefix = "") const;
459     void showTreeForThis() const;
460     void showNodePathForThis() const;
461     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = nullptr, const char* markedLabel2 = nullptr) const;
462     void showTreeForThisAcrossFrame() const;
463 #endif // ENABLE(TREE_DEBUGGING)
464
465     void invalidateNodeListAndCollectionCachesInAncestors();
466     void invalidateNodeListAndCollectionCachesInAncestorsForAttribute(const QualifiedName& attrName);
467     NodeListsNodeData* nodeLists();
468     void clearNodeLists();
469
470     virtual bool willRespondToMouseMoveEvents();
471     virtual bool willRespondToMouseClickEvents();
472     virtual bool willRespondToMouseWheelEvents();
473
474     WEBCORE_EXPORT unsigned short compareDocumentPosition(Node&);
475
476     EventTargetInterface eventTargetInterface() const override;
477     ScriptExecutionContext* scriptExecutionContext() const final; // Implemented in Document.h
478
479     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) override;
480     bool removeEventListener(const AtomicString& eventType, EventListener&, const ListenerOptions&) override;
481
482     using EventTarget::dispatchEvent;
483     void dispatchEvent(Event&) override;
484
485     void dispatchScopedEvent(Event&);
486
487     virtual void handleLocalEvents(Event&, EventInvokePhase);
488
489     void dispatchSubtreeModifiedEvent();
490     void dispatchDOMActivateEvent(Event& underlyingClickEvent);
491
492 #if ENABLE(TOUCH_EVENTS)
493     virtual bool allowsDoubleTapGesture() const { return true; }
494 #endif
495
496     bool dispatchBeforeLoadEvent(const String& sourceURL);
497
498     WEBCORE_EXPORT void dispatchInputEvent();
499
500     // Perform the default action for an event.
501     virtual void defaultEventHandler(Event&);
502
503     void ref();
504     void deref();
505     bool hasOneRef() const;
506     int refCount() const;
507
508 #ifndef NDEBUG
509     bool m_deletionHasBegun { false };
510     bool m_inRemovedLastRefFunction { false };
511     bool m_adoptionIsRequired { true };
512 #endif
513
514     EventTargetData* eventTargetData() final;
515     EventTargetData* eventTargetDataConcurrently() final;
516     EventTargetData& ensureEventTargetData() final;
517
518     HashMap<Ref<MutationObserver>, MutationRecordDeliveryOptions> registeredMutationObservers(MutationObserver::MutationType, const QualifiedName* attributeName);
519     void registerMutationObserver(MutationObserver&, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
520     void unregisterMutationObserver(MutationObserverRegistration&);
521     void registerTransientMutationObserver(MutationObserverRegistration&);
522     void unregisterTransientMutationObserver(MutationObserverRegistration&);
523     void notifyMutationObserversNodeWillDetach();
524
525     WEBCORE_EXPORT void textRects(Vector<IntRect>&) const;
526
527     unsigned connectedSubframeCount() const;
528     void incrementConnectedSubframeCount(unsigned amount = 1);
529     void decrementConnectedSubframeCount(unsigned amount = 1);
530     void updateAncestorConnectedSubframeCountForRemoval() const;
531     void updateAncestorConnectedSubframeCountForInsertion() const;
532
533 #if ENABLE(JIT)
534     static ptrdiff_t nodeFlagsMemoryOffset() { return OBJECT_OFFSETOF(Node, m_nodeFlags); }
535     static ptrdiff_t rareDataMemoryOffset() { return OBJECT_OFFSETOF(Node, m_data.m_rareData); }
536     static int32_t flagIsText() { return IsTextFlag; }
537     static int32_t flagIsContainer() { return IsContainerFlag; }
538     static int32_t flagIsElement() { return IsElementFlag; }
539     static int32_t flagIsShadowRoot() { return IsShadowRootFlag; }
540     static int32_t flagIsHTML() { return IsHTMLFlag; }
541     static int32_t flagIsLink() { return IsLinkFlag; }
542     static int32_t flagHasFocusWithin() { return HasFocusWithin; }
543     static int32_t flagHasRareData() { return HasRareDataFlag; }
544     static int32_t flagIsParsingChildrenFinished() { return IsParsingChildrenFinishedFlag; }
545     static int32_t flagChildrenAffectedByFirstChildRulesFlag() { return ChildrenAffectedByFirstChildRulesFlag; }
546     static int32_t flagChildrenAffectedByLastChildRulesFlag() { return ChildrenAffectedByLastChildRulesFlag; }
547
548     static int32_t flagAffectsNextSiblingElementStyle() { return AffectsNextSiblingElementStyle; }
549     static int32_t flagStyleIsAffectedByPreviousSibling() { return StyleIsAffectedByPreviousSibling; }
550 #endif // ENABLE(JIT)
551
552 protected:
553     enum NodeFlags {
554         IsTextFlag = 1,
555         IsContainerFlag = 1 << 1,
556         IsElementFlag = 1 << 2,
557         IsHTMLFlag = 1 << 3,
558         IsSVGFlag = 1 << 4,
559         IsMathMLFlag = 1 << 5,
560         IsDocumentNodeFlag = 1 << 6,
561         IsShadowRootFlag = 1 << 7,
562         IsConnectedFlag = 1 << 8,
563         IsInShadowTreeFlag = 1 << 9,
564         HasRareDataFlag = 1 << 10,
565         HasEventTargetDataFlag = 1 << 11,
566
567         // These bits are used by derived classes, pulled up here so they can
568         // be stored in the same memory word as the Node bits above.
569         ChildNeedsStyleRecalcFlag = 1 << 12, // ContainerNode
570         DirectChildNeedsStyleRecalcFlag = 1 << 13,
571
572         IsEditingTextOrUndefinedCustomElementFlag = 1 << 14, // Text and Element
573         IsCustomElement = 1 << 15, // Element
574         HasFocusWithin = 1 << 16,
575         IsLinkFlag = 1 << 17,
576         IsUserActionElement = 1 << 18,
577         IsParsingChildrenFinishedFlag = 1 << 19,
578         HasSyntheticAttrChildNodesFlag = 1 << 20,
579         SelfOrAncestorHasDirAutoFlag = 1 << 21,
580
581         // The following flags are used in style invalidation.
582         StyleValidityShift = 22,
583         StyleValidityMask = 3 << StyleValidityShift,
584         StyleResolutionShouldRecompositeLayerFlag = 1 << 24,
585
586         ChildrenAffectedByFirstChildRulesFlag = 1 << 25,
587         ChildrenAffectedByLastChildRulesFlag = 1 << 26,
588         ChildrenAffectedByHoverRulesFlag = 1 << 27,
589
590         AffectsNextSiblingElementStyle = 1 << 28,
591         StyleIsAffectedByPreviousSibling = 1 << 29,
592         DescendantsAffectedByPreviousSiblingFlag = 1 << 30,
593
594         HasCustomStyleResolveCallbacksFlag = 1 << 31,
595
596         DefaultNodeFlags = IsParsingChildrenFinishedFlag
597     };
598
599     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
600     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
601     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
602     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; }
603
604     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
605     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
606     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
607
608     enum ConstructionType {
609         CreateOther = DefaultNodeFlags,
610         CreateText = DefaultNodeFlags | IsTextFlag,
611         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
612         CreateElement = CreateContainer | IsElementFlag, 
613         CreatePseudoElement =  CreateElement | IsConnectedFlag,
614         CreateShadowRoot = CreateContainer | IsShadowRootFlag | IsInShadowTreeFlag,
615         CreateDocumentFragment = CreateContainer,
616         CreateHTMLElement = CreateElement | IsHTMLFlag,
617         CreateSVGElement = CreateElement | IsSVGFlag | HasCustomStyleResolveCallbacksFlag,
618         CreateMathMLElement = CreateElement | IsMathMLFlag,
619         CreateDocument = CreateContainer | IsDocumentNodeFlag | IsConnectedFlag,
620         CreateEditingText = CreateText | IsEditingTextOrUndefinedCustomElementFlag,
621     };
622     Node(Document&, ConstructionType);
623
624     virtual void addSubresourceAttributeURLs(ListHashSet<URL>&) const { }
625
626     bool hasRareData() const { return getFlag(HasRareDataFlag); }
627
628     NodeRareData* rareData() const;
629     NodeRareData& ensureRareData();
630     void clearRareData();
631
632     void clearEventTargetData();
633
634     void setHasCustomStyleResolveCallbacks() { setFlag(true, HasCustomStyleResolveCallbacksFlag); }
635
636     void setTreeScope(TreeScope& scope) { m_treeScope = &scope; }
637
638     void invalidateStyle(Style::Validity, Style::InvalidationMode = Style::InvalidationMode::Normal);
639     void updateAncestorsForStyleRecalc();
640
641     ExceptionOr<RefPtr<Node>> convertNodesOrStringsIntoNode(Vector<NodeOrString>&&);
642
643 private:
644     virtual PseudoId customPseudoId() const
645     {
646         ASSERT(hasCustomStyleResolveCallbacks());
647         return PseudoId::None;
648     }
649
650     WEBCORE_EXPORT void removedLastRef();
651
652     void refEventTarget() final;
653     void derefEventTarget() final;
654     bool isNode() const final;
655
656     void trackForDebugging();
657     void materializeRareData();
658
659     Vector<std::unique_ptr<MutationObserverRegistration>>* mutationObserverRegistry();
660     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
661
662     void adjustStyleValidity(Style::Validity, Style::InvalidationMode);
663
664     void* opaqueRootSlow() const;
665
666     static void moveShadowTreeToNewDocument(ShadowRoot&, Document& oldDocument, Document& newDocument);
667     static void moveTreeToNewScope(Node&, TreeScope& oldScope, TreeScope& newScope);
668     void moveNodeToNewDocument(Document& oldDocument, Document& newDocument);
669
670     int m_refCount;
671     mutable uint32_t m_nodeFlags;
672
673     ContainerNode* m_parentNode { nullptr };
674     TreeScope* m_treeScope { nullptr };
675     Node* m_previous { nullptr };
676     Node* m_next { nullptr };
677     // When a node has rare data we move the renderer into the rare data.
678     union DataUnion {
679         RenderObject* m_renderer;
680         NodeRareDataBase* m_rareData;
681     } m_data { nullptr };
682 };
683
684 #ifndef NDEBUG
685 inline void adopted(Node* node)
686 {
687     if (!node)
688         return;
689     ASSERT(!node->m_deletionHasBegun);
690     ASSERT(!node->m_inRemovedLastRefFunction);
691     node->m_adoptionIsRequired = false;
692 }
693 #endif
694
695 ALWAYS_INLINE void Node::ref()
696 {
697     ASSERT(isMainThread());
698     ASSERT(!m_deletionHasBegun);
699     ASSERT(!m_inRemovedLastRefFunction);
700     ASSERT(!m_adoptionIsRequired);
701     ++m_refCount;
702 }
703
704 ALWAYS_INLINE void Node::deref()
705 {
706     ASSERT(isMainThread());
707     ASSERT(m_refCount >= 0);
708     ASSERT(!m_deletionHasBegun);
709     ASSERT(!m_inRemovedLastRefFunction);
710     ASSERT(!m_adoptionIsRequired);
711     if (--m_refCount <= 0 && !parentNode()) {
712 #ifndef NDEBUG
713         m_inRemovedLastRefFunction = true;
714 #endif
715         removedLastRef();
716     }
717 }
718
719 ALWAYS_INLINE bool Node::hasOneRef() const
720 {
721     ASSERT(!m_deletionHasBegun);
722     ASSERT(!m_inRemovedLastRefFunction);
723     return m_refCount == 1;
724 }
725
726 ALWAYS_INLINE int Node::refCount() const
727 {
728     return m_refCount;
729 }
730
731 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
732 inline void addSubresourceURL(ListHashSet<URL>& urls, const URL& url)
733 {
734     if (!url.isNull())
735         urls.add(url);
736 }
737
738 inline void Node::setParentNode(ContainerNode* parent)
739 {
740     ASSERT(isMainThread());
741     m_parentNode = parent;
742 }
743
744 inline ContainerNode* Node::parentNode() const
745 {
746     ASSERT(isMainThreadOrGCThread());
747     return m_parentNode;
748 }
749
750 inline void* Node::opaqueRoot() const
751 {
752     // FIXME: Possible race?
753     // https://bugs.webkit.org/show_bug.cgi?id=165713
754     if (isConnected())
755         return &document();
756     return opaqueRootSlow();
757 }
758
759 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
760 {
761     ASSERT(!isShadowRoot());
762     return parentNode();
763 }
764
765 inline Style::Validity Node::styleValidity() const
766 {
767     return static_cast<Style::Validity>((m_nodeFlags & StyleValidityMask) >> StyleValidityShift);
768 }
769
770 inline bool Node::styleResolutionShouldRecompositeLayer() const
771 {
772     return getFlag(StyleResolutionShouldRecompositeLayerFlag);
773 }
774
775 inline void Node::setHasValidStyle()
776 {
777     m_nodeFlags &= ~StyleValidityMask;
778     clearFlag(StyleResolutionShouldRecompositeLayerFlag);
779 }
780
781 inline void Node::setTreeScopeRecursively(TreeScope& newTreeScope)
782 {
783     ASSERT(!isDocumentNode());
784     ASSERT(!m_deletionHasBegun);
785     if (m_treeScope != &newTreeScope)
786         moveTreeToNewScope(*this, *m_treeScope, newTreeScope);
787 }
788
789 } // namespace WebCore
790
791 #if ENABLE(TREE_DEBUGGING)
792 // Outside the WebCore namespace for ease of invocation from the debugger.
793 void showTree(const WebCore::Node*);
794 void showNodePath(const WebCore::Node*);
795 #endif
796
797 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Node)
798     static bool isType(const WebCore::EventTarget& target) { return target.isNode(); }
799 SPECIALIZE_TYPE_TRAITS_END()