ASSERTION FAILED: !node || node->isShadowRoot() in WebCore::EventRetargeter::eventTar...
[WebKit-https.git] / Source / WebCore / dom / EventRetargeter.h
1 /*
2  * Copyright (C) 2013 Google Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #ifndef EventRetargeter_h
21 #define EventRetargeter_h
22
23 #include "ContainerNode.h"
24 #include "EventContext.h"
25 #include "PseudoElement.h"
26 #include "ShadowRoot.h"
27 #include <wtf/HashMap.h>
28 #include <wtf/PassRefPtr.h>
29 #include <wtf/RefPtr.h>
30
31 #if ENABLE(SVG)
32 #include "SVGElementInstance.h"
33 #include "SVGNames.h"
34 #include "SVGUseElement.h"
35 #endif
36
37 namespace WebCore {
38
39 class EventTarget;
40 class FocusEvent;
41 class MouseEvent;
42 class Node;
43 #if ENABLE(TOUCH_EVENTS)
44 class TouchEvent;
45 #endif
46 class TreeScope;
47
48 enum EventDispatchBehavior {
49     RetargetEvent,
50     StayInsideShadowDOM
51 };
52
53 class EventRetargeter {
54 public:
55     static void calculateEventPath(Node*, Event*, EventPath&);
56     static void adjustForMouseEvent(Node*, const MouseEvent&, EventPath&);
57     static void adjustForFocusEvent(Node*, const FocusEvent&, EventPath&);
58 #if ENABLE(TOUCH_EVENTS)
59     typedef Vector<RefPtr<TouchList> > EventPathTouchLists;
60     static void adjustForTouchEvent(Node*, const TouchEvent&, EventPath&);
61 #endif
62     static EventTarget* eventTargetRespectingTargetRules(Node* referenceNode);
63
64 private:
65     typedef Vector<RefPtr<Node> > AdjustedNodes;
66     typedef HashMap<TreeScope*, Node*> RelatedNodeMap;
67     enum EventWithRelatedTargetDispatchBehavior {
68         StopAtBoundaryIfNeeded,
69         DoesNotStopAtBoundary
70     };
71     static void adjustForRelatedTarget(const Node*, EventTarget* relatedTarget, EventPath&);
72     static void calculateAdjustedNodes(const Node*, const Node* relatedNode, EventWithRelatedTargetDispatchBehavior, EventPath&, AdjustedNodes&);
73     static void buildRelatedNodeMap(const Node*, RelatedNodeMap&);
74     static Node* findRelatedNode(TreeScope*, RelatedNodeMap&);
75 #if ENABLE(TOUCH_EVENTS)
76     static void adjustTouchList(const Node*, const TouchList*, const EventPath&, EventPathTouchLists&);
77 #endif
78 };
79
80 inline EventTarget* EventRetargeter::eventTargetRespectingTargetRules(Node* referenceNode)
81 {
82     ASSERT(referenceNode);
83
84     if (referenceNode->isPseudoElement())
85         return toPseudoElement(referenceNode)->hostElement();
86
87 #if ENABLE(SVG)
88     if (!referenceNode->isSVGElement() || !referenceNode->isInShadowTree())
89         return referenceNode;
90
91     // Spec: The event handling for the non-exposed tree works as if the referenced element had been textually included
92     // as a deeply cloned child of the 'use' element, except that events are dispatched to the SVGElementInstance objects
93     Node* rootNode = referenceNode->treeScope()->rootNode();
94     Element* shadowHostElement = rootNode->isShadowRoot() ? toShadowRoot(rootNode)->hostElement() : 0;
95     // At this time, SVG nodes are not supported in non-<use> shadow trees.
96     if (!shadowHostElement || !shadowHostElement->hasTagName(SVGNames::useTag))
97         return referenceNode;
98     SVGUseElement* useElement = toSVGUseElement(shadowHostElement);
99     if (SVGElementInstance* instance = useElement->instanceForShadowTreeElement(referenceNode))
100         return instance;
101 #endif
102
103     return referenceNode;
104 }
105
106 }
107
108 #endif // EventRetargeter_h