[Cocoa] Fold common UIScriptController functionality on macOS and iOS into UIScriptCo...
[WebKit-https.git] / Tools / WebKitTestRunner / mac / UIScriptControllerMac.mm
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 #import "config.h"
27 #import "UIScriptController.h"
28
29 #import "EventSerializerMac.h"
30 #import "PlatformWebView.h"
31 #import "SharedEventStreamsMac.h"
32 #import "TestController.h"
33 #import "PlatformWebView.h"
34 #import "StringFunctions.h"
35 #import "TestController.h"
36 #import "TestRunnerWKWebView.h"
37 #import "UIScriptContext.h"
38 #import <JavaScriptCore/JSContext.h>
39 #import <JavaScriptCore/JSStringRefCF.h>
40 #import <JavaScriptCore/JSValue.h>
41 #import <JavaScriptCore/JavaScriptCore.h>
42 #import <JavaScriptCore/OpaqueJSString.h>
43 #import <WebKit/WKWebViewPrivate.h>
44
45 namespace WTR {
46
47 NSString *nsString(JSStringRef string)
48 {
49     return CFBridgingRelease(JSStringCopyCFString(kCFAllocatorDefault, string));
50 }
51
52 void UIScriptController::doAfterPresentationUpdate(JSValueRef callback)
53 {
54     return doAsyncTask(callback);
55 }
56
57 void UIScriptController::doAfterNextStablePresentationUpdate(JSValueRef callback)
58 {
59     doAsyncTask(callback);
60 }
61
62 void UIScriptController::doAfterVisibleContentRectUpdate(JSValueRef callback)
63 {
64     doAsyncTask(callback);
65 }
66
67 void UIScriptController::replaceTextAtRange(JSStringRef text, int location, int length)
68 {
69 #if WK_API_ENABLED
70     auto* webView = TestController::singleton().mainWebView()->platformView();
71     [webView _insertText:nsString(text) replacementRange:NSMakeRange(location == -1 ? NSNotFound : location, length)];
72 #else
73     UNUSED_PARAM(text);
74     UNUSED_PARAM(location);
75     UNUSED_PARAM(length);
76 #endif
77 }
78
79 void UIScriptController::zoomToScale(double scale, JSValueRef callback)
80 {
81 #if WK_API_ENABLED
82     unsigned callbackID = m_context->prepareForAsyncTask(callback, CallbackTypeNonPersistent);
83
84     auto* webView = TestController::singleton().mainWebView()->platformView();
85     [webView _setPageScale:scale withOrigin:CGPointZero];
86
87     [webView _doAfterNextPresentationUpdate: ^ {
88         if (!m_context)
89             return;
90         m_context->asyncTaskComplete(callbackID);
91     }];
92 #else
93     UNUSED_PARAM(scale);
94     UNUSED_PARAM(callback);
95 #endif
96 }
97
98 void UIScriptController::simulateAccessibilitySettingsChangeNotification(JSValueRef callback)
99 {
100 #if WK_API_ENABLED
101     unsigned callbackID = m_context->prepareForAsyncTask(callback, CallbackTypeNonPersistent);
102
103     auto* webView = TestController::singleton().mainWebView()->platformView();
104     NSNotificationCenter *center = [[NSWorkspace sharedWorkspace] notificationCenter];
105     [center postNotificationName:NSWorkspaceAccessibilityDisplayOptionsDidChangeNotification object:webView];
106
107     [webView _doAfterNextPresentationUpdate: ^{
108         if (!m_context)
109             return;
110         m_context->asyncTaskComplete(callbackID);
111     }];
112 #else
113     UNUSED_PARAM(callback);
114 #endif
115 }
116
117 void UIScriptController::simulateRotation(DeviceOrientation*, JSValueRef)
118 {
119 }
120
121 void UIScriptController::simulateRotationLikeSafari(DeviceOrientation*, JSValueRef)
122 {
123 }
124
125 bool UIScriptController::isShowingDataListSuggestions() const
126 {
127 #if WK_API_ENABLED
128     TestRunnerWKWebView *webView = TestController::singleton().mainWebView()->platformView();
129     for (NSWindow *childWindow in webView.window.childWindows) {
130         if ([childWindow isKindOfClass:NSClassFromString(@"WKDataListSuggestionWindow")])
131             return true;
132     }
133 #endif
134     return false;
135 }
136
137 static void playBackEvents(UIScriptContext *context, NSString *eventStream, JSValueRef callback)
138 {
139     NSError *error = nil;
140     NSArray *eventDicts = [NSJSONSerialization JSONObjectWithData:[eventStream dataUsingEncoding:NSUTF8StringEncoding] options:0 error:&error];
141
142     if (error) {
143         NSLog(@"ERROR: %@", error);
144         return;
145     }
146
147     unsigned callbackID = context->prepareForAsyncTask(callback, CallbackTypeNonPersistent);
148
149     NSWindow *window = [TestController::singleton().mainWebView()->platformView() window];
150
151     [EventStreamPlayer playStream:eventDicts window:window completionHandler:^ {
152         context->asyncTaskComplete(callbackID);
153     }];
154 }
155
156 void UIScriptController::beginBackSwipe(JSValueRef callback)
157 {
158     playBackEvents(m_context, beginSwipeBackEventStream(), callback);
159 }
160
161 void UIScriptController::completeBackSwipe(JSValueRef callback)
162 {
163     playBackEvents(m_context, completeSwipeBackEventStream(), callback);
164 }
165
166 void UIScriptController::platformPlayBackEventStream(JSStringRef eventStream, JSValueRef callback)
167 {
168     RetainPtr<CFStringRef> stream = adoptCF(JSStringCopyCFString(kCFAllocatorDefault, eventStream));
169     playBackEvents(m_context, (__bridge NSString *)stream.get(), callback);
170 }
171
172 void UIScriptController::firstResponderSuppressionForWebView(bool shouldSuppress)
173 {
174 #if WK_API_ENABLED
175     auto* webView = TestController::singleton().mainWebView()->platformView();
176     [webView _setShouldSuppressFirstResponderChanges:shouldSuppress];
177 #else
178     UNUSED_PARAM(shouldSuppress);
179 #endif
180 }
181
182 void UIScriptController::makeWindowContentViewFirstResponder()
183 {
184     NSWindow *window = [TestController::singleton().mainWebView()->platformView() window];
185     [window makeFirstResponder:[window contentView]];
186 }
187
188 bool UIScriptController::isWindowContentViewFirstResponder() const
189 {
190     NSWindow *window = [TestController::singleton().mainWebView()->platformView() window];
191     return [window firstResponder] == [window contentView];
192 }
193
194 } // namespace WTR