Unreviewed, rolling out r243037.
[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     ShadowRoot* containingShadowRoot() const;
238     ShadowRoot* shadowRoot() const;
239     bool isClosedShadowHidden(const Node&) const;
240
241     HTMLSlotElement* assignedSlot() const;
242     HTMLSlotElement* assignedSlotForBindings() const;
243
244     bool isUndefinedCustomElement() const { return isElementNode() && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
245     bool isCustomElementUpgradeCandidate() const { return getFlag(IsCustomElement) && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
246     bool isDefinedCustomElement() const { return getFlag(IsCustomElement) && !getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
247     bool isFailedCustomElement() const { return isElementNode() && !getFlag(IsCustomElement) && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
248
249     // Returns null, a child of ShadowRoot, or a legacy shadow root.
250     Node* nonBoundaryShadowTreeRootNode();
251
252     // Node's parent or shadow tree host.
253     ContainerNode* parentOrShadowHostNode() const;
254     ContainerNode* parentInComposedTree() const;
255     Element* parentElementInComposedTree() const;
256     Element* parentOrShadowHostElement() const;
257     void setParentNode(ContainerNode*);
258     Node& rootNode() const;
259     Node& traverseToRootNode() const;
260     Node& shadowIncludingRoot() const;
261
262     struct GetRootNodeOptions {
263         bool composed;
264     };
265     Node& getRootNode(const GetRootNodeOptions&) const;
266     
267     void* opaqueRoot() const;
268
269     // Use when it's guaranteed to that shadowHost is null.
270     ContainerNode* parentNodeGuaranteedHostFree() const;
271     // Returns the parent node, but null if the parent node is a ShadowRoot.
272     ContainerNode* nonShadowBoundaryParentNode() const;
273
274     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
275     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
276
277     // Returns the enclosing event parent Element (or self) that, when clicked, would trigger a navigation.
278     Element* enclosingLinkEventParentOrSelf();
279
280     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
281     void setPreviousSibling(Node* previous) { m_previous = previous; }
282     void setNextSibling(Node* next) { m_next = next; }
283
284     virtual bool canContainRangeEndPoint() const { return false; }
285
286     WEBCORE_EXPORT bool isRootEditableElement() const;
287     WEBCORE_EXPORT Element* rootEditableElement() const;
288
289     // Called by the parser when this element's close tag is reached,
290     // signaling that all child tags have been parsed and added.
291     // This is needed for <applet> and <object> elements, which can't lay themselves out
292     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
293     // Also used for script elements and some SVG elements for similar purposes,
294     // but making parsing a special case in this respect should be avoided if possible.
295     virtual void finishParsingChildren() { }
296     virtual void beginParsingChildren() { }
297
298     // For <link> and <style> elements.
299     virtual bool sheetLoaded() { return true; }
300     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
301     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
302
303     bool isUserActionElement() const { return getFlag(IsUserActionElement); }
304     void setUserActionElement(bool flag) { setFlag(flag, IsUserActionElement); }
305
306     bool inRenderedDocument() const;
307     bool needsStyleRecalc() const { return styleValidity() != Style::Validity::Valid; }
308     Style::Validity styleValidity() const;
309     bool styleResolutionShouldRecompositeLayer() const;
310     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
311     bool styleIsAffectedByPreviousSibling() const { return getFlag(StyleIsAffectedByPreviousSibling); }
312     bool isEditingText() const { return getFlag(IsTextFlag) && getFlag(IsEditingTextOrUndefinedCustomElementFlag); }
313
314     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
315     void clearChildNeedsStyleRecalc() { m_nodeFlags &= ~(ChildNeedsStyleRecalcFlag | DirectChildNeedsStyleRecalcFlag); }
316
317     void setHasValidStyle();
318
319     bool isLink() const { return getFlag(IsLinkFlag); }
320     void setIsLink(bool flag) { setFlag(flag, IsLinkFlag); }
321
322     bool hasEventTargetData() const { return getFlag(HasEventTargetDataFlag); }
323     void setHasEventTargetData(bool flag) { setFlag(flag, HasEventTargetDataFlag); }
324
325     enum UserSelectAllTreatment {
326         UserSelectAllDoesNotAffectEditability,
327         UserSelectAllIsAlwaysNonEditable
328     };
329     WEBCORE_EXPORT bool isContentEditable();
330     bool isContentRichlyEditable();
331
332     WEBCORE_EXPORT void inspect();
333
334     bool hasEditableStyle(UserSelectAllTreatment treatment = UserSelectAllIsAlwaysNonEditable) const
335     {
336         return computeEditability(treatment, ShouldUpdateStyle::DoNotUpdate) != Editability::ReadOnly;
337     }
338     // FIXME: Replace every use of this function by helpers in Editing.h
339     bool hasRichlyEditableStyle() const
340     {
341         return computeEditability(UserSelectAllIsAlwaysNonEditable, ShouldUpdateStyle::DoNotUpdate) == Editability::CanEditRichly;
342     }
343
344     enum class Editability { ReadOnly, CanEditPlainText, CanEditRichly };
345     enum class ShouldUpdateStyle { Update, DoNotUpdate };
346     WEBCORE_EXPORT Editability computeEditability(UserSelectAllTreatment, ShouldUpdateStyle) const;
347
348     WEBCORE_EXPORT LayoutRect renderRect(bool* isReplaced);
349     IntRect pixelSnappedRenderRect(bool* isReplaced) { return snappedIntRect(renderRect(isReplaced)); }
350
351     WEBCORE_EXPORT unsigned computeNodeIndex() const;
352
353     // Returns the DOM ownerDocument attribute. This method never returns null, except in the case
354     // of a Document node.
355     WEBCORE_EXPORT Document* ownerDocument() const;
356
357     // Returns the document associated with this node.
358     // A Document node returns itself.
359     Document& document() const
360     {
361         return treeScope().documentScope();
362     }
363
364     TreeScope& treeScope() const
365     {
366         ASSERT(m_treeScope);
367         return *m_treeScope;
368     }
369     void setTreeScopeRecursively(TreeScope&);
370     static ptrdiff_t treeScopeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_treeScope); }
371
372     // Returns true if this node is associated with a document and is in its associated document's
373     // node tree, false otherwise (https://dom.spec.whatwg.org/#connected).
374     bool isConnected() const
375     { 
376         return getFlag(IsConnectedFlag);
377     }
378     bool isInUserAgentShadowTree() const;
379     bool isInShadowTree() const { return getFlag(IsInShadowTreeFlag); }
380     bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(IsConnectedFlag | IsInShadowTreeFlag)); }
381
382     bool isDocumentTypeNode() const { return nodeType() == DOCUMENT_TYPE_NODE; }
383     virtual bool childTypeAllowed(NodeType) const { return false; }
384     unsigned countChildNodes() const;
385     Node* traverseToChildAt(unsigned) const;
386
387     ExceptionOr<void> checkSetPrefix(const AtomicString& prefix);
388
389     WEBCORE_EXPORT bool isDescendantOf(const Node&) const;
390     bool isDescendantOf(const Node* other) const { return other && isDescendantOf(*other); }
391
392     bool isDescendantOrShadowDescendantOf(const Node*) const;
393     WEBCORE_EXPORT bool contains(const Node*) const;
394     bool containsIncludingShadowDOM(const Node*) const;
395     bool containsIncludingHostElements(const Node*) const;
396
397     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
398     // css-transform:capitalize breaking up precomposed characters and ligatures.
399     virtual int maxCharacterOffset() const;
400
401     // Whether or not a selection can be started in this object
402     virtual bool canStartSelection() const;
403
404     virtual bool shouldSelectOnMouseDown() { return false; }
405
406     // Getting points into and out of screen space
407     FloatPoint convertToPage(const FloatPoint&) const;
408     FloatPoint convertFromPage(const FloatPoint&) const;
409
410     // -----------------------------------------------------------------------------
411     // Integration with rendering tree
412
413     // As renderer() includes a branch you should avoid calling it repeatedly in hot code paths.
414     RenderObject* renderer() const { return hasRareData() ? m_data.m_rareData->renderer() : m_data.m_renderer; };
415     void setRenderer(RenderObject* renderer)
416     {
417         if (hasRareData())
418             m_data.m_rareData->setRenderer(renderer);
419         else
420             m_data.m_renderer = renderer;
421     }
422
423     // Use these two methods with caution.
424     WEBCORE_EXPORT RenderBox* renderBox() const;
425     RenderBoxModelObject* renderBoxModelObject() const;
426     
427     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
428     const RenderStyle* renderStyle() const;
429
430     virtual const RenderStyle* computedStyle(PseudoId pseudoElementSpecifier = PseudoId::None);
431
432     enum class InsertedIntoAncestorResult {
433         Done,
434         NeedsPostInsertionCallback,
435     };
436
437     struct InsertionType {
438         bool connectedToDocument { false };
439         bool treeScopeChanged { false };
440     };
441     // 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.
442     // insertedInto **MUST NOT** invoke scripts. Return NeedsPostInsertionCallback and implement didFinishInsertingNode instead to run scripts.
443     virtual InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode& parentOfInsertedTree);
444     virtual void didFinishInsertingNode() { }
445
446     struct RemovalType {
447         bool disconnectedFromDocument { false };
448         bool treeScopeChanged { false };
449     };
450     virtual void removedFromAncestor(RemovalType, ContainerNode& oldParentOfRemovedTree);
451
452 #if ENABLE(TREE_DEBUGGING)
453     virtual void formatForDebugger(char* buffer, unsigned length) const;
454
455     void showNode(const char* prefix = "") const;
456     void showTreeForThis() const;
457     void showNodePathForThis() const;
458     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = nullptr, const char* markedLabel2 = nullptr) const;
459     void showTreeForThisAcrossFrame() const;
460 #endif // ENABLE(TREE_DEBUGGING)
461
462     void invalidateNodeListAndCollectionCachesInAncestors();
463     void invalidateNodeListAndCollectionCachesInAncestorsForAttribute(const QualifiedName& attrName);
464     NodeListsNodeData* nodeLists();
465     void clearNodeLists();
466
467     virtual bool willRespondToMouseMoveEvents();
468     virtual bool willRespondToMouseClickEvents();
469     virtual bool willRespondToMouseWheelEvents();
470
471     WEBCORE_EXPORT unsigned short compareDocumentPosition(Node&);
472
473     EventTargetInterface eventTargetInterface() const override;
474     ScriptExecutionContext* scriptExecutionContext() const final; // Implemented in Document.h
475
476     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) override;
477     bool removeEventListener(const AtomicString& eventType, EventListener&, const ListenerOptions&) override;
478
479     using EventTarget::dispatchEvent;
480     void dispatchEvent(Event&) override;
481
482     void dispatchScopedEvent(Event&);
483
484     virtual void handleLocalEvents(Event&, EventInvokePhase);
485
486     void dispatchSubtreeModifiedEvent();
487     void dispatchDOMActivateEvent(Event& underlyingClickEvent);
488
489 #if ENABLE(TOUCH_EVENTS)
490     virtual bool allowsDoubleTapGesture() const { return true; }
491 #endif
492
493     bool dispatchBeforeLoadEvent(const String& sourceURL);
494
495     WEBCORE_EXPORT void dispatchInputEvent();
496
497     // Perform the default action for an event.
498     virtual void defaultEventHandler(Event&);
499
500     void ref();
501     void deref();
502     bool hasOneRef() const;
503     int refCount() const;
504
505 #ifndef NDEBUG
506     bool m_deletionHasBegun { false };
507     bool m_inRemovedLastRefFunction { false };
508     bool m_adoptionIsRequired { true };
509 #endif
510
511     EventTargetData* eventTargetData() final;
512     EventTargetData* eventTargetDataConcurrently() final;
513     EventTargetData& ensureEventTargetData() final;
514
515     HashMap<Ref<MutationObserver>, MutationRecordDeliveryOptions> registeredMutationObservers(MutationObserver::MutationType, const QualifiedName* attributeName);
516     void registerMutationObserver(MutationObserver&, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
517     void unregisterMutationObserver(MutationObserverRegistration&);
518     void registerTransientMutationObserver(MutationObserverRegistration&);
519     void unregisterTransientMutationObserver(MutationObserverRegistration&);
520     void notifyMutationObserversNodeWillDetach();
521
522     WEBCORE_EXPORT void textRects(Vector<IntRect>&) const;
523
524     unsigned connectedSubframeCount() const;
525     void incrementConnectedSubframeCount(unsigned amount = 1);
526     void decrementConnectedSubframeCount(unsigned amount = 1);
527     void updateAncestorConnectedSubframeCountForRemoval() const;
528     void updateAncestorConnectedSubframeCountForInsertion() const;
529
530 #if ENABLE(JIT)
531     static ptrdiff_t nodeFlagsMemoryOffset() { return OBJECT_OFFSETOF(Node, m_nodeFlags); }
532     static ptrdiff_t rareDataMemoryOffset() { return OBJECT_OFFSETOF(Node, m_data.m_rareData); }
533     static int32_t flagIsText() { return IsTextFlag; }
534     static int32_t flagIsContainer() { return IsContainerFlag; }
535     static int32_t flagIsElement() { return IsElementFlag; }
536     static int32_t flagIsShadowRoot() { return IsShadowRootFlag; }
537     static int32_t flagIsHTML() { return IsHTMLFlag; }
538     static int32_t flagIsLink() { return IsLinkFlag; }
539     static int32_t flagHasFocusWithin() { return HasFocusWithin; }
540     static int32_t flagHasRareData() { return HasRareDataFlag; }
541     static int32_t flagIsParsingChildrenFinished() { return IsParsingChildrenFinishedFlag; }
542     static int32_t flagChildrenAffectedByFirstChildRulesFlag() { return ChildrenAffectedByFirstChildRulesFlag; }
543     static int32_t flagChildrenAffectedByLastChildRulesFlag() { return ChildrenAffectedByLastChildRulesFlag; }
544
545     static int32_t flagAffectsNextSiblingElementStyle() { return AffectsNextSiblingElementStyle; }
546     static int32_t flagStyleIsAffectedByPreviousSibling() { return StyleIsAffectedByPreviousSibling; }
547 #endif // ENABLE(JIT)
548
549 protected:
550     enum NodeFlags {
551         IsTextFlag = 1,
552         IsContainerFlag = 1 << 1,
553         IsElementFlag = 1 << 2,
554         IsHTMLFlag = 1 << 3,
555         IsSVGFlag = 1 << 4,
556         IsMathMLFlag = 1 << 5,
557         IsDocumentNodeFlag = 1 << 6,
558         IsShadowRootFlag = 1 << 7,
559         IsConnectedFlag = 1 << 8,
560         IsInShadowTreeFlag = 1 << 9,
561         HasRareDataFlag = 1 << 10,
562         HasEventTargetDataFlag = 1 << 11,
563
564         // These bits are used by derived classes, pulled up here so they can
565         // be stored in the same memory word as the Node bits above.
566         ChildNeedsStyleRecalcFlag = 1 << 12, // ContainerNode
567         DirectChildNeedsStyleRecalcFlag = 1 << 13,
568
569         IsEditingTextOrUndefinedCustomElementFlag = 1 << 14, // Text and Element
570         IsCustomElement = 1 << 15, // Element
571         HasFocusWithin = 1 << 16,
572         IsLinkFlag = 1 << 17,
573         IsUserActionElement = 1 << 18,
574         IsParsingChildrenFinishedFlag = 1 << 19,
575         HasSyntheticAttrChildNodesFlag = 1 << 20,
576         SelfOrAncestorHasDirAutoFlag = 1 << 21,
577
578         // The following flags are used in style invalidation.
579         StyleValidityShift = 22,
580         StyleValidityMask = 3 << StyleValidityShift,
581         StyleResolutionShouldRecompositeLayerFlag = 1 << 24,
582
583         ChildrenAffectedByFirstChildRulesFlag = 1 << 25,
584         ChildrenAffectedByLastChildRulesFlag = 1 << 26,
585         ChildrenAffectedByHoverRulesFlag = 1 << 27,
586
587         AffectsNextSiblingElementStyle = 1 << 28,
588         StyleIsAffectedByPreviousSibling = 1 << 29,
589         DescendantsAffectedByPreviousSiblingFlag = 1 << 30,
590
591         HasCustomStyleResolveCallbacksFlag = 1 << 31,
592
593         DefaultNodeFlags = IsParsingChildrenFinishedFlag
594     };
595
596     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
597     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
598     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
599     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; }
600
601     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
602     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
603     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
604
605     enum ConstructionType {
606         CreateOther = DefaultNodeFlags,
607         CreateText = DefaultNodeFlags | IsTextFlag,
608         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
609         CreateElement = CreateContainer | IsElementFlag, 
610         CreatePseudoElement =  CreateElement | IsConnectedFlag,
611         CreateShadowRoot = CreateContainer | IsShadowRootFlag | IsInShadowTreeFlag,
612         CreateDocumentFragment = CreateContainer,
613         CreateHTMLElement = CreateElement | IsHTMLFlag,
614         CreateSVGElement = CreateElement | IsSVGFlag | HasCustomStyleResolveCallbacksFlag,
615         CreateMathMLElement = CreateElement | IsMathMLFlag,
616         CreateDocument = CreateContainer | IsDocumentNodeFlag | IsConnectedFlag,
617         CreateEditingText = CreateText | IsEditingTextOrUndefinedCustomElementFlag,
618     };
619     Node(Document&, ConstructionType);
620
621     virtual void addSubresourceAttributeURLs(ListHashSet<URL>&) const { }
622
623     bool hasRareData() const { return getFlag(HasRareDataFlag); }
624
625     NodeRareData* rareData() const;
626     NodeRareData& ensureRareData();
627     void clearRareData();
628
629     void clearEventTargetData();
630
631     void setHasCustomStyleResolveCallbacks() { setFlag(true, HasCustomStyleResolveCallbacksFlag); }
632
633     void setTreeScope(TreeScope& scope) { m_treeScope = &scope; }
634
635     void invalidateStyle(Style::Validity, Style::InvalidationMode = Style::InvalidationMode::Normal);
636     void updateAncestorsForStyleRecalc();
637
638     ExceptionOr<RefPtr<Node>> convertNodesOrStringsIntoNode(Vector<NodeOrString>&&);
639
640 private:
641     virtual PseudoId customPseudoId() const
642     {
643         ASSERT(hasCustomStyleResolveCallbacks());
644         return PseudoId::None;
645     }
646
647     WEBCORE_EXPORT void removedLastRef();
648
649     void refEventTarget() final;
650     void derefEventTarget() final;
651     bool isNode() const final;
652
653     void trackForDebugging();
654     void materializeRareData();
655
656     Vector<std::unique_ptr<MutationObserverRegistration>>* mutationObserverRegistry();
657     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
658
659     void adjustStyleValidity(Style::Validity, Style::InvalidationMode);
660
661     void* opaqueRootSlow() const;
662
663     static void moveShadowTreeToNewDocument(ShadowRoot&, Document& oldDocument, Document& newDocument);
664     static void moveTreeToNewScope(Node&, TreeScope& oldScope, TreeScope& newScope);
665     void moveNodeToNewDocument(Document& oldDocument, Document& newDocument);
666
667     int m_refCount;
668     mutable uint32_t m_nodeFlags;
669
670     ContainerNode* m_parentNode { nullptr };
671     TreeScope* m_treeScope { nullptr };
672     Node* m_previous { nullptr };
673     Node* m_next { nullptr };
674     // When a node has rare data we move the renderer into the rare data.
675     union DataUnion {
676         RenderObject* m_renderer;
677         NodeRareDataBase* m_rareData;
678     } m_data { nullptr };
679 };
680
681 #ifndef NDEBUG
682 inline void adopted(Node* node)
683 {
684     if (!node)
685         return;
686     ASSERT(!node->m_deletionHasBegun);
687     ASSERT(!node->m_inRemovedLastRefFunction);
688     node->m_adoptionIsRequired = false;
689 }
690 #endif
691
692 ALWAYS_INLINE void Node::ref()
693 {
694     ASSERT(isMainThread());
695     ASSERT(!m_deletionHasBegun);
696     ASSERT(!m_inRemovedLastRefFunction);
697     ASSERT(!m_adoptionIsRequired);
698     ++m_refCount;
699 }
700
701 ALWAYS_INLINE void Node::deref()
702 {
703     ASSERT(isMainThread());
704     ASSERT(m_refCount >= 0);
705     ASSERT(!m_deletionHasBegun);
706     ASSERT(!m_inRemovedLastRefFunction);
707     ASSERT(!m_adoptionIsRequired);
708     if (--m_refCount <= 0 && !parentNode()) {
709 #ifndef NDEBUG
710         m_inRemovedLastRefFunction = true;
711 #endif
712         removedLastRef();
713     }
714 }
715
716 ALWAYS_INLINE bool Node::hasOneRef() const
717 {
718     ASSERT(!m_deletionHasBegun);
719     ASSERT(!m_inRemovedLastRefFunction);
720     return m_refCount == 1;
721 }
722
723 ALWAYS_INLINE int Node::refCount() const
724 {
725     return m_refCount;
726 }
727
728 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
729 inline void addSubresourceURL(ListHashSet<URL>& urls, const URL& url)
730 {
731     if (!url.isNull())
732         urls.add(url);
733 }
734
735 inline void Node::setParentNode(ContainerNode* parent)
736 {
737     ASSERT(isMainThread());
738     m_parentNode = parent;
739 }
740
741 inline ContainerNode* Node::parentNode() const
742 {
743     ASSERT(isMainThreadOrGCThread());
744     return m_parentNode;
745 }
746
747 inline void* Node::opaqueRoot() const
748 {
749     // FIXME: Possible race?
750     // https://bugs.webkit.org/show_bug.cgi?id=165713
751     if (isConnected())
752         return &document();
753     return opaqueRootSlow();
754 }
755
756 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
757 {
758     ASSERT(!isShadowRoot());
759     return parentNode();
760 }
761
762 inline Style::Validity Node::styleValidity() const
763 {
764     return static_cast<Style::Validity>((m_nodeFlags & StyleValidityMask) >> StyleValidityShift);
765 }
766
767 inline bool Node::styleResolutionShouldRecompositeLayer() const
768 {
769     return getFlag(StyleResolutionShouldRecompositeLayerFlag);
770 }
771
772 inline void Node::setHasValidStyle()
773 {
774     m_nodeFlags &= ~StyleValidityMask;
775     clearFlag(StyleResolutionShouldRecompositeLayerFlag);
776 }
777
778 inline void Node::setTreeScopeRecursively(TreeScope& newTreeScope)
779 {
780     ASSERT(!isDocumentNode());
781     ASSERT(!m_deletionHasBegun);
782     if (m_treeScope != &newTreeScope)
783         moveTreeToNewScope(*this, *m_treeScope, newTreeScope);
784 }
785
786 } // namespace WebCore
787
788 #if ENABLE(TREE_DEBUGGING)
789 // Outside the WebCore namespace for ease of invocation from the debugger.
790 void showTree(const WebCore::Node*);
791 void showNodePath(const WebCore::Node*);
792 #endif
793
794 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Node)
795     static bool isType(const WebCore::EventTarget& target) { return target.isNode(); }
796 SPECIALIZE_TYPE_TRAITS_END()