Limit user-agent interactions based on the touch-action property on iOS
[WebKit-https.git] / Source / WebCore / platform / EventTrackingRegions.h
1 /*
2  * Copyright (C) 2016 Apple 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 #pragma once
27
28 #include "Region.h"
29 #include <wtf/HashMap.h>
30 #include <wtf/text/StringHash.h>
31 #include <wtf/text/WTFString.h>
32
33 #if ENABLE(POINTER_EVENTS)
34 #include "CSSPrimitiveValueMappings.h"
35 #include "ScrollingCoordinatorTypes.h"
36 #include "TouchAction.h"
37 #endif
38
39 namespace WebCore {
40
41 enum class TrackingType : uint8_t {
42     NotTracking = 0,
43     Asynchronous = 1,
44     Synchronous = 2
45 };
46
47 #if ENABLE(POINTER_EVENTS)
48 typedef uint64_t ScrollingNodeID;
49 struct TouchActionData {
50     OptionSet<TouchAction> touchActions { TouchAction::Auto };
51     ScrollingNodeID scrollingNodeID { 0 };
52     Region region;
53 };
54
55 bool operator==(const TouchActionData&, const TouchActionData&);
56 inline bool operator!=(const TouchActionData& a, const TouchActionData& b) { return !(a == b); }
57 #endif
58
59 struct EventTrackingRegions {
60     // Region for which events can be dispatched without blocking scrolling.
61     Region asynchronousDispatchRegion;
62
63     // Regions for which events must be sent before performing the default behavior.
64     // The key is the Event Name with an active handler.
65     HashMap<String, Region> eventSpecificSynchronousDispatchRegions;
66
67 #if ENABLE(POINTER_EVENTS)
68     Vector<TouchActionData> touchActionData;
69 #endif
70
71     bool isEmpty() const;
72
73     void translate(IntSize);
74     void uniteSynchronousRegion(const String& eventName, const Region&);
75     void unite(const EventTrackingRegions&);
76
77     TrackingType trackingTypeForPoint(const String& eventName, const IntPoint&);
78 };
79
80 bool operator==(const EventTrackingRegions&, const EventTrackingRegions&);
81 inline bool operator!=(const EventTrackingRegions& a, const EventTrackingRegions& b) { return !(a == b); }
82
83 } // namespace WebCore