REGRESSION (iOS 13): Tests that simulate multiple back-to-back single taps fail or...
[WebKit-https.git] / Tools / TestRunnerShared / UIScriptContext / UIScriptController.h
1 /*
2  * Copyright (C) 2015 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef UIScriptController_h
27 #define UIScriptController_h
28
29 #include "JSWrappable.h"
30 #include <JavaScriptCore/JSRetainPtr.h>
31 #include <wtf/Optional.h>
32 #include <wtf/Ref.h>
33
34 OBJC_CLASS NSUndoManager;
35 OBJC_CLASS NSView;
36 OBJC_CLASS UIView;
37
38 namespace WebCore {
39 class FloatRect;
40 }
41
42 namespace WTR {
43
44 class UIScriptContext;
45
46 enum class DeviceOrientation {
47     Portrait,
48     PortraitUpsideDown,
49     LandscapeLeft,
50     LandscapeRight
51 };
52
53 DeviceOrientation* toDeviceOrientation(JSContextRef, JSValueRef);
54
55 class UIScriptController : public JSWrappable {
56 public:
57     static Ref<UIScriptController> create(UIScriptContext&);
58
59     void uiScriptComplete(JSStringRef result);
60
61     void notImplemented() const { RELEASE_ASSERT_NOT_REACHED(); }
62
63     void contextDestroyed();
64     virtual void checkForOutstandingCallbacks() { /* notImplemented(); */ }
65
66     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
67
68     // Transaction helpers
69     
70     virtual void doAsyncTask(JSValueRef callback) { notImplemented(); }
71     virtual void doAfterPresentationUpdate(JSValueRef callback) { doAsyncTask(callback); }
72     virtual void doAfterNextStablePresentationUpdate(JSValueRef callback) { doAsyncTask(callback); }
73     virtual void ensurePositionInformationIsUpToDateAt(long x, long y, JSValueRef callback) { doAsyncTask(callback); }
74     virtual void doAfterVisibleContentRectUpdate(JSValueRef callback) { doAsyncTask(callback); }
75
76     // Preferences
77
78     virtual void overridePreference(JSStringRef preference, JSStringRef value) { notImplemented(); }
79
80     // Zooming
81
82     virtual void zoomToScale(double scale, JSValueRef callback) { notImplemented(); }
83     virtual void immediateZoomToScale(double scale) { notImplemented(); }
84     virtual void setViewScale(double) { notImplemented(); }
85     virtual double zoomScale() const { notImplemented(); return 1; }
86     virtual double minimumZoomScale() const { notImplemented(); return 1; }
87     virtual double maximumZoomScale() const { notImplemented(); return 1; }
88
89     // Viewports
90
91     virtual void setMinimumEffectiveWidth(double) { notImplemented(); }
92     virtual void setAllowsViewportShrinkToFit(bool) { notImplemented(); }
93
94     virtual Optional<bool> stableStateOverride() const { notImplemented(); return WTF::nullopt; }
95     virtual void setStableStateOverride(Optional<bool>) { notImplemented(); }
96
97     virtual JSObjectRef contentVisibleRect() const { notImplemented(); return nullptr; }
98     
99     virtual void setSafeAreaInsets(double top, double right, double bottom, double left) { notImplemented(); }
100
101     // View Parenting and Visibility
102
103     virtual void becomeFirstResponder() { notImplemented(); }
104     virtual void resignFirstResponder() { notImplemented(); }
105
106     virtual void firstResponderSuppressionForWebView(bool) { notImplemented(); }
107     virtual void makeWindowContentViewFirstResponder() { notImplemented(); }
108     virtual bool isWindowContentViewFirstResponder() const { notImplemented(); return false; }
109
110     virtual void removeViewFromWindow(JSValueRef) { notImplemented(); }
111     virtual void addViewToWindow(JSValueRef) { notImplemented(); }
112
113     // Compositing
114
115     virtual JSObjectRef propertiesOfLayerWithID(uint64_t layerID) const { notImplemented(); return nullptr; }
116
117     // Scrolling
118
119     virtual bool scrollUpdatesDisabled() const { notImplemented(); return false; }
120     virtual void setScrollUpdatesDisabled(bool) { notImplemented(); }
121
122     virtual void scrollToOffset(long x, long y) { notImplemented(); }
123
124     virtual void immediateScrollToOffset(long x, long y) { notImplemented(); }
125     virtual void immediateScrollElementAtContentPointToOffset(long x, long y, long xScrollOffset, long yScrollOffset) { notImplemented(); }
126
127     virtual double contentOffsetX() const { notImplemented(); return 0; }
128     virtual double contentOffsetY() const { notImplemented(); return 0; }
129
130     virtual JSRetainPtr<JSStringRef> scrollingTreeAsText() const { notImplemented(); return nullptr; }
131
132     // Touches
133
134     virtual void touchDownAtPoint(long x, long y, long touchCount, JSValueRef callback) { notImplemented(); }
135     virtual void liftUpAtPoint(long x, long y, long touchCount, JSValueRef callback) { notImplemented(); }
136     virtual void singleTapAtPoint(long x, long y, JSValueRef callback) { notImplemented(); }
137     virtual void singleTapAtPointWithModifiers(long x, long y, JSValueRef modifierArray, JSValueRef callback) { notImplemented(); }
138     virtual void doubleTapAtPoint(long x, long y, float delay, JSValueRef callback) { notImplemented(); }
139     virtual void dragFromPointToPoint(long startX, long startY, long endX, long endY, double durationSeconds, JSValueRef callback) { notImplemented(); }
140     virtual void longPressAtPoint(long x, long y, JSValueRef callback) { notImplemented(); }
141
142     // Keyboard
143
144     virtual void enterText(JSStringRef) { notImplemented(); }
145     virtual void typeCharacterUsingHardwareKeyboard(JSStringRef character, JSValueRef callback) { notImplemented(); }
146
147     virtual void keyDown(JSStringRef character, JSValueRef modifierArray) { notImplemented(); }
148     virtual void toggleCapsLock(JSValueRef callback) { notImplemented(); }
149
150     virtual void rawKeyDown(JSStringRef) { notImplemented(); }
151     virtual void rawKeyUp(JSStringRef) { notImplemented(); }
152
153     virtual void keyboardAccessoryBarNext() { notImplemented(); }
154     virtual void keyboardAccessoryBarPrevious() { notImplemented(); }
155
156     virtual void applyAutocorrection(JSStringRef newString, JSStringRef oldString, JSValueRef callback) { notImplemented(); }
157
158     virtual bool isShowingKeyboard() const { notImplemented(); return false; }
159     virtual bool hasInputSession() const { notImplemented(); return false; }
160
161     virtual void setHardwareKeyboardAttached(bool) { }
162
163     virtual void setKeyboardInputModeIdentifier(JSStringRef) { notImplemented(); }
164
165     virtual void replaceTextAtRange(JSStringRef, int location, int length) { notImplemented(); }
166     virtual void removeAllDynamicDictionaries() { notImplemented(); }
167
168     // Stylus
169
170     virtual void stylusDownAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, JSValueRef callback) { notImplemented(); }
171     virtual void stylusMoveToPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, JSValueRef callback) { notImplemented(); }
172     virtual void stylusUpAtPoint(long x, long y, JSValueRef callback) { notImplemented(); }
173     virtual void stylusTapAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, JSValueRef callback) { notImplemented(); }
174     virtual void stylusTapAtPointWithModifiers(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, JSValueRef modifierArray, JSValueRef callback) { notImplemented(); }
175
176     // Event Stream
177
178     virtual void sendEventStream(JSStringRef eventsJSON, JSValueRef callback) { notImplemented(); }
179     virtual void playBackEventStream(JSStringRef stream, JSValueRef callback) { notImplemented(); }
180
181     // Form Controls
182     
183     virtual void dismissFilePicker(JSValueRef callback) { notImplemented(); }
184     virtual void dismissFormAccessoryView() { notImplemented(); }
185     virtual void selectFormAccessoryPickerRow(long) { notImplemented(); }
186     virtual JSRetainPtr<JSStringRef> textContentType() const { notImplemented(); return nullptr; }
187     virtual JSRetainPtr<JSStringRef> selectFormPopoverTitle() const { notImplemented(); return nullptr; }
188     virtual JSRetainPtr<JSStringRef> formInputLabel() const { notImplemented(); return nullptr; }
189     virtual void setTimePickerValue(long hour, long minute) { notImplemented(); }
190     virtual bool isShowingDataListSuggestions() const { notImplemented(); return false; }
191     virtual JSObjectRef calendarType() const { notImplemented(); return nullptr; }
192     virtual void setDefaultCalendarType(JSStringRef calendarIdentifier) { notImplemented(); }
193     virtual JSObjectRef inputViewBounds() const { notImplemented(); return nullptr; }
194
195     // Share Sheet
196
197     virtual void setShareSheetCompletesImmediatelyWithResolution(bool resolved) { notImplemented(); }
198
199     // Find in Page
200
201     virtual void findString(JSStringRef, unsigned long options, unsigned long maxCount) { notImplemented(); }
202
203     // Accessibility
204
205     virtual void simulateAccessibilitySettingsChangeNotification(JSValueRef callback) { notImplemented(); }
206     virtual void retrieveSpeakSelectionContent(JSValueRef) { notImplemented(); }
207     virtual JSRetainPtr<JSStringRef> accessibilitySpeakSelectionContent() const { notImplemented(); return nullptr; }
208     virtual JSObjectRef contentsOfUserInterfaceItem(JSStringRef) const { notImplemented(); return nullptr; }
209
210     // Swipe
211
212     virtual void beginBackSwipe(JSValueRef callback) { notImplemented(); }
213     virtual void completeBackSwipe(JSValueRef callback) { notImplemented(); }
214
215     // Child View Controllers
216
217     virtual bool isShowingPopover() const { notImplemented(); return false; }
218     virtual bool isPresentingModally() const { notImplemented(); return false; }
219
220     // Context Menus
221
222     virtual bool isDismissingMenu() const { notImplemented(); return false; }
223     virtual bool isShowingMenu() const { notImplemented(); return false; }
224     virtual JSObjectRef rectForMenuAction(JSStringRef action) const { notImplemented(); return nullptr; }
225     virtual JSObjectRef menuRect() const { notImplemented(); return nullptr; }
226
227     // Selection
228
229     virtual JSObjectRef textSelectionRangeRects() const { notImplemented(); return nullptr; }
230     virtual JSObjectRef textSelectionCaretRect() const { notImplemented(); return nullptr; }
231     virtual JSObjectRef selectionStartGrabberViewRect() const { notImplemented(); return nullptr; }
232     virtual JSObjectRef selectionEndGrabberViewRect() const { notImplemented(); return nullptr; }
233     virtual JSObjectRef selectionCaretViewRect() const { notImplemented(); return nullptr; }
234     virtual JSObjectRef selectionRangeViewRects() const { notImplemented(); return nullptr; }
235
236     // Rotation
237
238     virtual void simulateRotation(DeviceOrientation*, JSValueRef) { notImplemented(); }
239     virtual void simulateRotationLikeSafari(DeviceOrientation*, JSValueRef) { notImplemented(); }
240
241     // Editable Images
242
243     virtual void drawSquareInEditableImage() { notImplemented(); }
244     virtual long numberOfStrokesInEditableImage() { notImplemented(); return 0; }
245
246     // Undo/Redo
247
248     virtual JSRetainPtr<JSStringRef> lastUndoLabel() const { notImplemented(); return nullptr; }
249     virtual JSRetainPtr<JSStringRef> firstRedoLabel() const { notImplemented(); return nullptr; }
250
251     // Attachment Elements
252
253     virtual JSObjectRef attachmentInfo(JSStringRef attachmentIdentifier) { notImplemented(); return nullptr; }
254
255     // Callbacks
256     
257     virtual void setDidStartFormControlInteractionCallback(JSValueRef);
258     JSValueRef didStartFormControlInteractionCallback() const;
259
260     virtual void setDidEndFormControlInteractionCallback(JSValueRef);
261     JSValueRef didEndFormControlInteractionCallback() const;
262     
263     virtual void setDidShowForcePressPreviewCallback(JSValueRef);
264     JSValueRef didShowForcePressPreviewCallback() const;
265     
266     virtual void setDidDismissForcePressPreviewCallback(JSValueRef);
267     JSValueRef didDismissForcePressPreviewCallback() const;
268
269     virtual void setWillBeginZoomingCallback(JSValueRef);
270     JSValueRef willBeginZoomingCallback() const;
271
272     virtual void setDidEndZoomingCallback(JSValueRef);
273     JSValueRef didEndZoomingCallback() const;
274
275     virtual void setWillCreateNewPageCallback(JSValueRef);
276     JSValueRef willCreateNewPageCallback() const;
277
278     virtual void setDidShowKeyboardCallback(JSValueRef);
279     JSValueRef didShowKeyboardCallback() const;
280
281     virtual void setDidHideKeyboardCallback(JSValueRef);
282     JSValueRef didHideKeyboardCallback() const;
283
284     virtual void setDidHideMenuCallback(JSValueRef);
285     JSValueRef didHideMenuCallback() const;
286     virtual void setDidShowMenuCallback(JSValueRef);
287     JSValueRef didShowMenuCallback() const;
288
289     virtual void setDidDismissPopoverCallback(JSValueRef);
290     JSValueRef didDismissPopoverCallback() const;
291     virtual void setWillPresentPopoverCallback(JSValueRef);
292     JSValueRef willPresentPopoverCallback() const;
293
294     virtual void setDidEndScrollingCallback(JSValueRef);
295     JSValueRef didEndScrollingCallback() const;
296
297 protected:
298     explicit UIScriptController(UIScriptContext&);
299     
300     UIScriptContext* context() { return m_context; }
301
302     virtual void clearAllCallbacks() { /* notImplemented(); */ }
303
304 #if PLATFORM(COCOA)
305     virtual NSUndoManager *platformUndoManager() const { notImplemented(); return nullptr; }
306 #endif
307
308 #if PLATFORM(IOS_FAMILY)
309     virtual UIView *platformContentView() const { notImplemented(); return nullptr; }
310 #endif
311 #if PLATFORM(MAC)
312     virtual NSView *platformContentView() const { notImplemented(); return nullptr; }
313 #endif
314
315     JSClassRef wrapperClass() final;
316
317     JSObjectRef objectFromRect(const WebCore::FloatRect&) const;
318
319     UIScriptContext* m_context;
320
321 #if PLATFORM(COCOA)
322     bool m_capsLockOn { false };
323 #endif
324 };
325
326 }
327
328 #endif // UIScriptController_h