src/third_party/WebKit/Source/core/events/EventPath.h

   1 /*
   2  * Copyright (C) 2013 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Neither the name of Google Inc. nor the names of its
  11  * contributors may be used to endorse or promote products derived from
  12  * this software without specific prior written permission.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef EventPath_h
  28 #define EventPath_h
  29
  30 #include "core/events/NodeEventContext.h"
  31 #include "core/events/TreeScopeEventContext.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/HashMap.h"
  34 #include "wtf/Vector.h"
  35
  36 namespace WebCore {
  37
  38 class Event;
  39 class EventTarget;
  40 class Node;
  41 class TouchEvent;
  42 class TouchList;
  43 class TreeScope;
  44
  45 enum EventDispatchBehavior {
  46     RetargetEvent,
  47     StayInsideShadowDOM
  48 };
  49
  50 class EventPath : public NoBaseWillBeGarbageCollectedFinalized<EventPath> {
  51 public:
  52     explicit EventPath(Event*);
  53     explicit EventPath(Node*);
  54     void resetWith(Node*);
  55
  56     NodeEventContext& operator[](size_t index) { return m_nodeEventContexts[index]; }
  57     const NodeEventContext& operator[](size_t index) const { return m_nodeEventContexts[index]; }
  58     const NodeEventContext& last() const { return m_nodeEventContexts[size() - 1]; }
  59
  60     bool isEmpty() const { return m_nodeEventContexts.isEmpty(); }
  61     size_t size() const { return m_nodeEventContexts.size(); }
  62
  63     void adjustForRelatedTarget(Node*, EventTarget* relatedTarget);
  64     void adjustForTouchEvent(Node*, TouchEvent&);
  65
  66     static EventTarget* eventTargetRespectingTargetRules(Node*);
  67
  68     void trace(Visitor*);
  69
  70 private:
  71     EventPath();
  72
  73     NodeEventContext& at(size_t index) { return m_nodeEventContexts[index]; }
  74
  75     void addNodeEventContext(Node*);
  76
  77     void calculatePath();
  78     void calculateAdjustedTargets();
  79     void calculateTreeScopePrePostOrderNumbers();
  80
  81     void shrink(size_t newSize) { m_nodeEventContexts.shrink(newSize); }
  82     void shrinkIfNeeded(const Node* target, const EventTarget* relatedTarget);
  83
  84     void adjustTouchList(const Node*, const TouchList*, WillBeHeapVector<RawPtrWillBeMember<TouchList> > adjustedTouchList, const WillBeHeapVector<RawPtrWillBeMember<TreeScope> >& treeScopes);
  85
  86     typedef WillBeHeapHashMap<RawPtrWillBeMember<TreeScope>, RefPtrWillBeMember<TreeScopeEventContext> > TreeScopeEventContextMap;
  87     TreeScopeEventContext* ensureTreeScopeEventContext(Node* currentTarget, TreeScope*, TreeScopeEventContextMap&);
  88
  89     typedef WillBeHeapHashMap<RawPtrWillBeMember<TreeScope>, RawPtrWillBeMember<EventTarget> > RelatedTargetMap;
  90
  91     static void buildRelatedNodeMap(const Node*, RelatedTargetMap&);
  92     static EventTarget* findRelatedNode(TreeScope*, RelatedTargetMap&);
  93
  94 #ifndef NDEBUG
  95     static void checkReachability(TreeScope&, TouchList&);
  96 #endif
  97
  98     WillBeHeapVector<NodeEventContext, 64> m_nodeEventContexts;
  99     RawPtrWillBeMember<Node> m_node;
 100     RawPtrWillBeMember<Event> m_event;
 101     WillBeHeapVector<RefPtrWillBeMember<TreeScopeEventContext> > m_treeScopeEventContexts;
 102 };
 103
 104 } // namespace
 105
 106 #endif