1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_layers_APZEventState_h
#define mozilla_layers_APZEventState_h
#include <stdint.h>
#include "Units.h"
#include "mozilla/EventForwards.h"
#include "mozilla/layers/GeckoContentControllerTypes.h" // for APZStateChange
#include "mozilla/layers/ScrollableLayerGuid.h" // for ScrollableLayerGuid
#include "mozilla/layers/TouchCounter.h" // for TouchCounter
#include "mozilla/RefPtr.h"
#include "mozilla/StaticPrefs_ui.h"
#include "nsCOMPtr.h"
#include "nsISupportsImpl.h" // for NS_INLINE_DECL_REFCOUNTING
#include "nsITimer.h"
#include "nsIWeakReferenceUtils.h" // for nsWeakPtr
#include <functional>
#include <unordered_map>
template <class>
class nsCOMPtr;
class nsIContent;
class nsIWidget;
namespace mozilla {
class PresShell;
enum class PreventDefaultResult : uint8_t;
namespace layers {
class ActiveElementManager;
typedef std::function<void(uint64_t /* input block id */,
bool /* prevent default */)>
ContentReceivedInputBlockCallback;
struct SingleTapTargetInfo {
nsWeakPtr mWidget;
LayoutDevicePoint mPoint;
Modifiers mModifiers;
int32_t mClickCount;
RefPtr<nsIContent> mTouchRollup;
explicit SingleTapTargetInfo(nsWeakPtr aWidget, LayoutDevicePoint aPoint,
Modifiers aModifiers, int32_t aClickCount,
RefPtr<nsIContent> aTouchRollup)
: mWidget(std::move(aWidget)),
mPoint(aPoint),
mModifiers(aModifiers),
mClickCount(aClickCount),
mTouchRollup(std::move(aTouchRollup)) {}
SingleTapTargetInfo(SingleTapTargetInfo&&) = default;
SingleTapTargetInfo& operator=(SingleTapTargetInfo&&) = default;
};
class DelayedFireSingleTapEvent final : public nsITimerCallback,
public nsINamed {
private:
explicit DelayedFireSingleTapEvent(Maybe<SingleTapTargetInfo>&& aTargetInfo,
const nsCOMPtr<nsITimer>& aTimer)
: mTargetInfo(std::move(aTargetInfo))
// Hold the reference count until we are called back.
,
mTimer(aTimer) {}
public:
NS_DECL_ISUPPORTS
static RefPtr<DelayedFireSingleTapEvent> Create(
Maybe<SingleTapTargetInfo>&& aTargetInfo);
NS_IMETHOD Notify(nsITimer*) override;
NS_IMETHOD GetName(nsACString& aName) override;
void PopulateTargetInfo(SingleTapTargetInfo&& aTargetInfo);
void FireSingleTapEvent();
void ClearTimer() { mTimer = nullptr; }
private:
~DelayedFireSingleTapEvent() = default;
Maybe<SingleTapTargetInfo> mTargetInfo;
nsCOMPtr<nsITimer> mTimer;
};
/**
* A content-side component that keeps track of state for handling APZ
* gestures and sending APZ notifications.
*/
class APZEventState final {
typedef GeckoContentController_APZStateChange APZStateChange;
typedef ScrollableLayerGuid::ViewID ViewID;
public:
APZEventState(nsIWidget* aWidget,
ContentReceivedInputBlockCallback&& aCallback);
NS_INLINE_DECL_REFCOUNTING(APZEventState);
void ProcessSingleTap(const CSSPoint& aPoint,
const CSSToLayoutDeviceScale& aScale,
Modifiers aModifiers, int32_t aClickCount,
uint64_t aInputBlockId);
MOZ_CAN_RUN_SCRIPT
void ProcessLongTap(PresShell* aPresShell, const CSSPoint& aPoint,
const CSSToLayoutDeviceScale& aScale,
Modifiers aModifiers, uint64_t aInputBlockId);
MOZ_CAN_RUN_SCRIPT
void ProcessLongTapUp(PresShell* aPresShell, const CSSPoint& aPoint,
const CSSToLayoutDeviceScale& aScale,
Modifiers aModifiers);
void ProcessTouchEvent(const WidgetTouchEvent& aEvent,
const ScrollableLayerGuid& aGuid,
uint64_t aInputBlockId, nsEventStatus aApzResponse,
nsEventStatus aContentResponse,
nsTArray<TouchBehaviorFlags>&& aAllowedTouchBehaviors);
void ProcessWheelEvent(const WidgetWheelEvent& aEvent,
uint64_t aInputBlockId);
void ProcessMouseEvent(const WidgetMouseEvent& aEvent,
uint64_t aInputBlockId);
void ProcessAPZStateChange(ViewID aViewId, APZStateChange aChange, int aArg,
Maybe<uint64_t> aInputBlockId);
private:
~APZEventState();
bool SendPendingTouchPreventedResponse(bool aPreventDefault);
MOZ_CAN_RUN_SCRIPT
PreventDefaultResult FireContextmenuEvents(
PresShell* aPresShell, const CSSPoint& aPoint,
const CSSToLayoutDeviceScale& aScale, Modifiers aModifiers,
const nsCOMPtr<nsIWidget>& aWidget);
already_AddRefed<nsIWidget> GetWidget() const;
already_AddRefed<nsIContent> GetTouchRollup() const;
bool MainThreadAgreesEventsAreConsumableByAPZ() const;
private:
nsWeakPtr mWidget;
RefPtr<ActiveElementManager> mActiveElementManager;
ContentReceivedInputBlockCallback mContentReceivedInputBlockCallback;
TouchCounter mTouchCounter;
bool mPendingTouchPreventedResponse;
ScrollableLayerGuid mPendingTouchPreventedGuid;
uint64_t mPendingTouchPreventedBlockId;
bool mEndTouchIsClick;
bool mFirstTouchCancelled;
bool mTouchEndCancelled;
// Store pending single tap event dispatch tasks keyed on the
// tap gesture's input block id. In the case where multiple taps
// occur in quick succession, we may receive a later tap while the
// dispatch for an earlier tap is still pending.
std::unordered_map<uint64_t, RefPtr<DelayedFireSingleTapEvent>>
mSingleTapsPendingTargetInfo;
int32_t mLastTouchIdentifier;
nsTArray<TouchBehaviorFlags> mTouchBlockAllowedBehaviors;
// Because touch-triggered mouse events (e.g. mouse events from a tap
// gesture) happen asynchronously from the touch events themselves, we
// need to stash and replicate some of the state from the touch events
// to the mouse events. One piece of state is the rollup content, which
// is the content for which a popup window was recently closed. If we
// don't replicate this state properly during the mouse events, the
// synthetic click might reopen a popup window that was just closed by
// the touch event, which is undesirable. See also documentation in
// nsAutoRollup.h
// Note that in cases where we get multiple touch blocks interleaved with
// their single-tap event notifications, mTouchRollup may hold an incorrect
// value. This is kind of an edge case, and falls in the same category of
// problems as bug 1227241. I intend that fixing that bug will also take
// care of this potential problem.
nsWeakPtr mTouchRollup;
};
} // namespace layers
} // namespace mozilla
#endif /* mozilla_layers_APZEventState_h */
|