Reduce uses of PassRefPtr in WebCore/dom - 6
[WebKit-https.git] / Source / WebCore / dom / EventContext.h
1 /*
2  * Copyright (C) 2010 Google Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  *
25  */
26
27 #ifndef EventContext_h
28 #define EventContext_h
29
30 #include "EventTarget.h"
31 #include "Node.h"
32 #include "TreeScope.h"
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36
37 class Event;
38 #if ENABLE(TOUCH_EVENTS)
39 class TouchList;
40 #endif
41
42 class EventContext {
43     WTF_MAKE_FAST_ALLOCATED;
44 public:
45     // FIXME: Use ContainerNode instead of Node.
46     EventContext(Node*, EventTarget* currentTarget, EventTarget*);
47     virtual ~EventContext();
48
49     Node* node() const { return m_node.get(); }
50     EventTarget* currentTarget() const { return m_currentTarget.get(); }
51     EventTarget* target() const { return m_target.get(); }
52     bool currentTargetSameAsTarget() const { return m_currentTarget.get() == m_target.get(); }
53     virtual void handleLocalEvents(Event&) const;
54     virtual bool isMouseOrFocusEventContext() const;
55     virtual bool isTouchEventContext() const;
56
57 protected:
58 #if !ASSERT_DISABLED
59     bool isUnreachableNode(EventTarget*);
60     bool isReachable(Node*) const;
61 #endif
62     RefPtr<Node> m_node;
63     RefPtr<EventTarget> m_currentTarget;
64     RefPtr<EventTarget> m_target;
65 };
66
67 class MouseOrFocusEventContext final : public EventContext {
68 public:
69     MouseOrFocusEventContext(Node*, EventTarget* currentTarget, EventTarget*);
70     virtual ~MouseOrFocusEventContext();
71     EventTarget* relatedTarget() const { return m_relatedTarget.get(); }
72     void setRelatedTarget(PassRefPtr<EventTarget>);
73     void handleLocalEvents(Event&) const override;
74     bool isMouseOrFocusEventContext() const override;
75
76 private:
77     RefPtr<EventTarget> m_relatedTarget;
78 };
79
80
81 #if ENABLE(TOUCH_EVENTS)
82 class TouchEventContext final : public EventContext {
83 public:
84     TouchEventContext(Node*, EventTarget* currentTarget, EventTarget*);
85     virtual ~TouchEventContext();
86
87     void handleLocalEvents(Event&) const override;
88     bool isTouchEventContext() const override;
89
90     enum TouchListType { Touches, TargetTouches, ChangedTouches, NotTouchList };
91     TouchList* touchList(TouchListType type)
92     {
93         switch (type) {
94         case Touches:
95             return m_touches.get();
96         case TargetTouches:
97             return m_targetTouches.get();
98         case ChangedTouches:
99             return m_changedTouches.get();
100         case NotTouchList:
101             break;
102         }
103         ASSERT_NOT_REACHED();
104         return nullptr;
105     }
106
107     TouchList* touches() { return m_touches.get(); }
108     TouchList* targetTouches() { return m_targetTouches.get(); }
109     TouchList* changedTouches() { return m_changedTouches.get(); }
110
111 private:
112     RefPtr<TouchList> m_touches;
113     RefPtr<TouchList> m_targetTouches;
114     RefPtr<TouchList> m_changedTouches;
115 #if !ASSERT_DISABLED
116     void checkReachability(TouchList*) const;
117 #endif
118 };
119
120 inline TouchEventContext& toTouchEventContext(EventContext& eventContext)
121 {
122     ASSERT_WITH_SECURITY_IMPLICATION(eventContext.isTouchEventContext());
123     return static_cast<TouchEventContext&>(eventContext);
124 }
125
126 inline TouchEventContext* toTouchEventContext(EventContext* eventContext)
127 {
128     ASSERT_WITH_SECURITY_IMPLICATION(!eventContext || eventContext->isTouchEventContext());
129     return static_cast<TouchEventContext*>(eventContext);
130 }
131 #endif // ENABLE(TOUCH_EVENTS) && !PLATFORM(IOS)
132
133 #if !ASSERT_DISABLED
134 inline bool EventContext::isUnreachableNode(EventTarget* target)
135 {
136     // FIXME: Checks also for SVG elements.
137     return target && target->toNode() && !target->toNode()->isSVGElement() && !isReachable(target->toNode());
138 }
139
140 inline bool EventContext::isReachable(Node* target) const
141 {
142     ASSERT(target);
143     TreeScope& targetScope = target->treeScope();
144     for (TreeScope* scope = &m_node->treeScope(); scope; scope = scope->parentTreeScope()) {
145         if (scope == &targetScope)
146             return true;
147     }
148     return false;
149 }
150 #endif
151
152 inline void MouseOrFocusEventContext::setRelatedTarget(PassRefPtr<EventTarget> relatedTarget)
153 {
154     ASSERT(!isUnreachableNode(relatedTarget.get()));
155     m_relatedTarget = relatedTarget;
156 }
157
158 }
159
160 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::MouseOrFocusEventContext)
161 static bool isType(const WebCore::EventContext& context) { return context.isMouseOrFocusEventContext(); }
162 SPECIALIZE_TYPE_TRAITS_END()
163
164 #if ENABLE(TOUCH_EVENTS)
165 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::TouchEventContext)
166 static bool isType(const WebCore::EventContext& context) { return context.isTouchEventContext(); }
167 SPECIALIZE_TYPE_TRAITS_END()
168 #endif
169
170 #endif // EventContext_h