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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
#include "MockDragServiceController.h"
#include "mozilla/dom/CanonicalBrowsingContext.h"
#include "mozilla/dom/Document.h"
#include "mozilla/dom/DragEvent.h"
#include "mozilla/MouseEvents.h"
#include "mozilla/SpinEventLoopUntil.h"
#include "nsIFrame.h"
#include "nsPresContext.h"
#include "nsBaseDragService.h"
namespace mozilla::test {
NS_IMPL_ISUPPORTS(MockDragServiceController, nsIMockDragServiceController)
class MockDragSession : public nsBaseDragSession {
protected:
MOZ_CAN_RUN_SCRIPT nsresult
InvokeDragSessionImpl(nsIWidget* aWidget, nsIArray* aTransferableArray,
const mozilla::Maybe<mozilla::CSSIntRegion>& aRegion,
uint32_t aActionType) override {
// In Windows' nsDragService, InvokeDragSessionImpl would establish a
// nested (native) event loop that runs as long as the drag is happening.
// See DoDragDrop in MSDN.
// We cannot do anything like that here since it would block mochitest
// from scripting behavior with MockDragServiceController::SendDragEvent.
// mDragAction is not yet handled properly in the MockDragService.
// This should be updated with each drag event. Instead, we always MOVE.
//
// We still need to end the drag session on the source widget.
// In normal (non-mock) Gecko operation, this happens regardless
// of whether the drop/cancel happened over one of our widgets.
// For instance, Windows does this in StartInvokingDragSession, after
// DoDragDrop returns, gtk does this on eDragTaskSourceEnd and cocoa
// does this in -[NSDraggingSource draggingSession: endedAt: operation:].
//
// Here, we know the source and target are Gecko windows (the test
// framework does not support dragging to/from other apps). We could
// end the source drag session on drop and cancel, but sometimes we
// will want a dragleave to end the session (representing a drag cancel
// from Gecko) and other we times don't (like when dragging from one Gecko
// widget to another). Therefore, we instead rely on the test to tell
// us when to end the source session by calling
// MockDragServiceController::EndSourceDragSession().
// Note that, like in non-mocked DND, we do this regardless of whether
// the source and target were the same widget -- in that case,
// EndDragSession is just called twice.
mDragAction = nsIDragService::DRAGDROP_ACTION_MOVE;
return NS_OK;
}
};
class MockDragService : public nsBaseDragService {
public:
MockDragService() { SetNeverAllowSessionIsSynthesizedForTests(true); }
NS_IMETHOD GetIsMockService(bool* aRet) override {
*aRet = true;
return NS_OK;
}
uint32_t mLastModifierKeyState = 0;
protected:
already_AddRefed<nsIDragSession> CreateDragSession() override {
RefPtr<nsIDragSession> session = new MockDragSession();
return session.forget();
}
};
static void SetDragEndPointFromScreenPoint(
nsIDragSession* aSession, nsPresContext* aPc,
const LayoutDeviceIntPoint& aScreenPt) {
// aScreenPt is screen-relative, and we want to be
// top-level-widget-relative.
auto* widget = aPc->GetRootWidget();
auto pt = aScreenPt - widget->WidgetToScreenOffset();
pt += widget->WidgetToTopLevelWidgetOffset();
aSession->SetDragEndPoint(pt.x, pt.y);
}
static bool IsMouseEvent(nsIMockDragServiceController::EventType aEventType) {
using EventType = nsIMockDragServiceController::EventType;
switch (aEventType) {
case EventType::eMouseDown:
case EventType::eMouseMove:
case EventType::eMouseUp:
return true;
default:
return false;
}
}
static EventMessage MockEventTypeToEventMessage(
nsIMockDragServiceController::EventType aEventType) {
using EventType = nsIMockDragServiceController::EventType;
switch (aEventType) {
case EventType::eDragEnter:
return EventMessage::eDragEnter;
case EventType::eDragOver:
return EventMessage::eDragOver;
case EventType::eDragExit:
return EventMessage::eDragExit;
case EventType::eDrop:
return EventMessage::eDrop;
case EventType::eMouseDown:
return EventMessage::eMouseDown;
case EventType::eMouseMove:
return EventMessage::eMouseMove;
case EventType::eMouseUp:
return EventMessage::eMouseUp;
default:
MOZ_ASSERT(false, "Invalid event type");
return EventMessage::eVoidEvent;
}
}
MockDragServiceController::MockDragServiceController()
: mDragService(new MockDragService()) {}
MockDragServiceController::~MockDragServiceController() = default;
NS_IMETHODIMP
MockDragServiceController::GetMockDragService(nsIDragService** aService) {
RefPtr<nsIDragService> ds = mDragService;
ds.forget(aService);
return NS_OK;
}
NS_IMETHODIMP
MockDragServiceController::SendEvent(
dom::BrowsingContext* aBC,
nsIMockDragServiceController::EventType aEventType, int32_t aScreenX,
int32_t aScreenY, uint32_t aKeyModifiers = 0) {
auto* embedder = aBC->Top()->GetEmbedderElement();
NS_ENSURE_TRUE(embedder, NS_ERROR_UNEXPECTED);
auto* frame = embedder->GetPrimaryFrame();
NS_ENSURE_TRUE(frame, NS_ERROR_UNEXPECTED);
auto* presCxt = frame->PresContext();
MOZ_ASSERT(presCxt);
RefPtr<nsIWidget> widget = nsContentUtils::WidgetForContent(embedder);
NS_ENSURE_TRUE(widget, NS_ERROR_UNEXPECTED);
EventMessage eventType = MockEventTypeToEventMessage(aEventType);
UniquePtr<WidgetInputEvent> widgetEvent;
if (IsMouseEvent(aEventType)) {
widgetEvent = MakeUnique<WidgetMouseEvent>(true, eventType, widget,
WidgetMouseEvent::Reason::eReal);
} else {
widgetEvent = MakeUnique<WidgetDragEvent>(true, eventType, widget);
}
widgetEvent->mWidget = widget;
widgetEvent->mFlags.mIsSynthesizedForTests = true;
auto clientPosInScreenCoords = widget->GetClientBounds().TopLeft();
widgetEvent->mRefPoint =
LayoutDeviceIntPoint(aScreenX, aScreenY) - clientPosInScreenCoords;
RefPtr<MockDragService> ds = mDragService;
if (aEventType == EventType::eDragEnter) {
// We expect StartDragSession to return an "error" when a drag session
// already exists, which it will since we are testing dragging from
// inside Gecko, so we don't check the return value.
ds->StartDragSession(widget);
}
nsCOMPtr<nsIDragSession> currentDragSession = ds->GetCurrentSession(widget);
nsresult rv;
switch (aEventType) {
case EventType::eMouseDown:
case EventType::eMouseMove:
case EventType::eMouseUp:
widget->DispatchInputEvent(widgetEvent.get());
break;
case EventType::eDragEnter:
NS_ENSURE_TRUE(currentDragSession, NS_ERROR_UNEXPECTED);
currentDragSession->SetDragAction(nsIDragService::DRAGDROP_ACTION_MOVE);
widget->DispatchInputEvent(widgetEvent.get());
break;
case EventType::eDragExit: {
NS_ENSURE_TRUE(currentDragSession, NS_ERROR_UNEXPECTED);
currentDragSession->SetDragAction(nsIDragService::DRAGDROP_ACTION_MOVE);
widget->DispatchInputEvent(widgetEvent.get());
SetDragEndPointFromScreenPoint(currentDragSession, presCxt,
LayoutDeviceIntPoint(aScreenX, aScreenY));
nsCOMPtr<nsINode> sourceNode;
rv = currentDragSession->GetSourceNode(getter_AddRefs(sourceNode));
NS_ENSURE_SUCCESS(rv, rv);
if (!sourceNode) {
rv = currentDragSession->EndDragSession(false /* doneDrag */,
aKeyModifiers);
NS_ENSURE_SUCCESS(rv, rv);
}
} break;
case EventType::eDragOver:
NS_ENSURE_TRUE(currentDragSession, NS_ERROR_UNEXPECTED);
rv = currentDragSession->FireDragEventAtSource(EventMessage::eDrag,
aKeyModifiers);
NS_ENSURE_SUCCESS(rv, rv);
currentDragSession->SetDragAction(nsIDragService::DRAGDROP_ACTION_MOVE);
widget->DispatchInputEvent(widgetEvent.get());
break;
case EventType::eDrop: {
NS_ENSURE_TRUE(currentDragSession, NS_ERROR_UNEXPECTED);
currentDragSession->SetDragAction(nsIDragService::DRAGDROP_ACTION_MOVE);
widget->DispatchInputEvent(widgetEvent.get());
SetDragEndPointFromScreenPoint(currentDragSession, presCxt,
LayoutDeviceIntPoint(aScreenX, aScreenY));
rv = currentDragSession->EndDragSession(true /* doneDrag */,
aKeyModifiers);
NS_ENSURE_SUCCESS(rv, rv);
} break;
default:
MOZ_ASSERT_UNREACHABLE("Impossible event type?");
return NS_ERROR_FAILURE;
}
return NS_OK;
}
NS_IMETHODIMP
MockDragServiceController::CancelDrag(uint32_t aKeyModifiers = 0) {
RefPtr<MockDragService> ds = mDragService;
nsCOMPtr<nsIDragSession> currentDragSession;
ds->GetCurrentSession(nullptr, getter_AddRefs(currentDragSession));
MOZ_ASSERT(currentDragSession);
return currentDragSession->EndDragSession(false /* doneDrag */,
aKeyModifiers);
}
} // namespace mozilla::test
|
