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