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
191
192
193
194
195
196
197
198
|
/*
* Copyright (C) 2018, 2019 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(WEBDRIVER_ACTIONS_API)
#include <WebCore/FrameIdentifier.h>
#include <WebCore/IntPoint.h>
#include <variant>
#include <wtf/CompletionHandler.h>
#include <wtf/ListHashSet.h>
#include <wtf/RunLoop.h>
#include <wtf/Seconds.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>
namespace Inspector { namespace Protocol { namespace Automation {
enum class ErrorMessage;
enum class KeyboardInteractionType;
enum class MouseButton;
enum class MouseInteraction;
enum class MouseMoveOrigin;
enum class VirtualKey;
} } }
namespace WebKit {
class AutomationCommandError;
using AutomationCompletionHandler = WTF::CompletionHandler<void(std::optional<AutomationCommandError>)>;
class WebPageProxy;
using KeyboardInteraction = Inspector::Protocol::Automation::KeyboardInteractionType;
using VirtualKey = Inspector::Protocol::Automation::VirtualKey;
using VirtualKeyMap = HashMap<VirtualKey, VirtualKey, WTF::IntHash<VirtualKey>, WTF::StrongEnumHashTraits<VirtualKey>>;
#if ENABLE(WEBDRIVER_KEYBOARD_GRAPHEME_CLUSTERS)
// A CharKey must only ever represent a single unicode codepoint or a single grapheme cluster.
using CharKey = String;
#else
using CharKey = UChar32;
#endif
using CharKeySet = ListHashSet<CharKey>;
using MouseButton = Inspector::Protocol::Automation::MouseButton;
using MouseInteraction = Inspector::Protocol::Automation::MouseInteraction;
using MouseMoveOrigin = Inspector::Protocol::Automation::MouseMoveOrigin;
enum class SimulatedInputSourceType {
Null, // Used to induce a minimum duration.
Keyboard,
Mouse,
Touch,
Wheel,
Pen,
};
enum class TouchInteraction {
TouchDown,
MoveTo,
LiftUp,
};
struct SimulatedInputSourceState {
CharKeySet pressedCharKeys;
VirtualKeyMap pressedVirtualKeys;
std::optional<MouseButton> pressedMouseButton;
std::optional<MouseMoveOrigin> origin;
std::optional<String> nodeHandle;
std::optional<WebCore::IntPoint> location;
std::optional<WebCore::IntSize> scrollDelta;
std::optional<Seconds> duration;
static SimulatedInputSourceState emptyStateForSourceType(SimulatedInputSourceType);
};
struct SimulatedInputSource : public RefCounted<SimulatedInputSource> {
public:
SimulatedInputSourceType type;
// The last state associated with this input source.
SimulatedInputSourceState state;
static Ref<SimulatedInputSource> create(SimulatedInputSourceType type)
{
return adoptRef(*new SimulatedInputSource(type));
}
private:
SimulatedInputSource(SimulatedInputSourceType type)
: type(type)
, state(SimulatedInputSourceState::emptyStateForSourceType(type))
{ }
};
struct SimulatedInputKeyFrame {
public:
using StateEntry = std::pair<SimulatedInputSource&, SimulatedInputSourceState>;
explicit SimulatedInputKeyFrame(Vector<StateEntry>&&);
Seconds maximumDuration() const;
static SimulatedInputKeyFrame keyFrameFromStateOfInputSources(const HashMap<String, Ref<SimulatedInputSource>>&);
static SimulatedInputKeyFrame keyFrameToResetInputSources(const HashMap<String, Ref<SimulatedInputSource>>&);
Vector<StateEntry> states;
};
class SimulatedInputDispatcher : public RefCounted<SimulatedInputDispatcher> {
WTF_MAKE_NONCOPYABLE(SimulatedInputDispatcher);
public:
class Client {
public:
virtual ~Client() { }
#if ENABLE(WEBDRIVER_MOUSE_INTERACTIONS)
virtual void simulateMouseInteraction(WebPageProxy&, MouseInteraction, MouseButton, const WebCore::IntPoint& locationInView, const String& pointerType, AutomationCompletionHandler&&) = 0;
#endif
#if ENABLE(WEBDRIVER_TOUCH_INTERACTIONS)
virtual void simulateTouchInteraction(WebPageProxy&, TouchInteraction, const WebCore::IntPoint& locationInView, std::optional<Seconds> duration, AutomationCompletionHandler&&) = 0;
#endif
#if ENABLE(WEBDRIVER_KEYBOARD_INTERACTIONS)
virtual void simulateKeyboardInteraction(WebPageProxy&, KeyboardInteraction, std::variant<VirtualKey, CharKey>&&, AutomationCompletionHandler&&) = 0;
#endif
#if ENABLE(WEBDRIVER_WHEEL_INTERACTIONS)
virtual void simulateWheelInteraction(WebPageProxy&, const WebCore::IntPoint& locationInView, const WebCore::IntSize& delta, AutomationCompletionHandler&&) = 0;
#endif
virtual void viewportInViewCenterPointOfElement(WebPageProxy&, std::optional<WebCore::FrameIdentifier>, const String& nodeHandle, Function<void (std::optional<WebCore::IntPoint>, std::optional<AutomationCommandError>)>&&) = 0;
};
static Ref<SimulatedInputDispatcher> create(WebPageProxy& page, SimulatedInputDispatcher::Client& client)
{
return adoptRef(*new SimulatedInputDispatcher(page, client));
}
~SimulatedInputDispatcher();
void run(std::optional<WebCore::FrameIdentifier>, Vector<SimulatedInputKeyFrame>&& keyFrames, const HashMap<String, Ref<SimulatedInputSource>>& inputSources, AutomationCompletionHandler&&);
void cancel();
bool isActive() const;
private:
SimulatedInputDispatcher(WebPageProxy&, SimulatedInputDispatcher::Client&);
void transitionToNextKeyFrame();
void transitionBetweenKeyFrames(const SimulatedInputKeyFrame&, const SimulatedInputKeyFrame&, AutomationCompletionHandler&&);
void transitionToNextInputSourceState();
void transitionInputSourceToState(SimulatedInputSource&, SimulatedInputSourceState& newState, AutomationCompletionHandler&&);
void finishDispatching(std::optional<AutomationCommandError>);
void keyFrameTransitionDurationTimerFired();
bool isKeyFrameTransitionComplete() const;
void resolveLocation(const WebCore::IntPoint& currentLocation, std::optional<WebCore::IntPoint> location, MouseMoveOrigin, std::optional<String> nodeHandle, Function<void (std::optional<WebCore::IntPoint>, std::optional<AutomationCommandError>)>&&);
WebPageProxy& m_page;
SimulatedInputDispatcher::Client& m_client;
std::optional<WebCore::FrameIdentifier> m_frameID;
AutomationCompletionHandler m_runCompletionHandler;
AutomationCompletionHandler m_keyFrameTransitionCompletionHandler;
RunLoop::Timer m_keyFrameTransitionDurationTimer;
Vector<SimulatedInputKeyFrame> m_keyframes;
// The position within m_keyframes.
unsigned m_keyframeIndex { 0 };
// The position within the input source state vector at m_keyframes[m_keyframeIndex].
// Events that reflect input source state transitions are dispatched serially based on this order.
unsigned m_inputSourceStateIndex { 0 };
};
} // namespace WebKit
#endif // ENABLE(WEBDRIVER_ACTIONS_API)
|
