Changeset 285741 in webkit

Timestamp:

Nov 12, 2021, 2:14:26 PM (5 years ago)

Author:

Peng Liu

Message:

Promote WKPreferences._fullScreenEnabled to API
​https://bugs.webkit.org/show_bug.cgi?id=230784
<rdar://83255308>

Reviewed by Jer Noble.

Source/WebKit:

• UIProcess/API/Cocoa/WKPreferences.h:
• UIProcess/API/Cocoa/WKPreferences.mm:

(-[WKPreferences isElementFullscreenEnabled]):
(-[WKPreferences setElementFullscreenEnabled:]):

• UIProcess/API/Cocoa/WKWebView.h:
• UIProcess/API/Cocoa/WKWebView.mm:

(-[WKWebView fullscreenState]):

• UIProcess/Cocoa/FullscreenClient.h:
• UIProcess/Cocoa/FullscreenClient.mm:

(WebKit::FullscreenClient::willEnterFullscreen):
(WebKit::FullscreenClient::didEnterFullscreen):
(WebKit::FullscreenClient::willExitFullscreen):
(WebKit::FullscreenClient::didExitFullscreen):

• UIProcess/Cocoa/WebViewImpl.mm:

(WebKit::WebViewImpl::WebViewImpl):

• UIProcess/WebFullScreenManagerProxy.cpp:

(WebKit::WebFullScreenManagerProxy::willEnterFullScreen):
(WebKit::WebFullScreenManagerProxy::didEnterFullScreen):
(WebKit::WebFullScreenManagerProxy::willExitFullScreen):
(WebKit::WebFullScreenManagerProxy::didExitFullScreen):

• UIProcess/WebFullScreenManagerProxy.h:

(WebKit::WebFullScreenManagerProxy::fullscreenState const):

Tools:

• MiniBrowser/mac/AppDelegate.m:

(-[BrowserAppDelegate defaultConfiguration]):

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKPreferences.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKPreferences.mm (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebView.h (modified) (2 diffs)
• Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm (modified) (6 diffs)
• Source/WebKit/UIProcess/Cocoa/FullscreenClient.h (modified) (1 diff)
• Source/WebKit/UIProcess/Cocoa/FullscreenClient.mm (modified) (4 diffs)
• Source/WebKit/UIProcess/Cocoa/WebViewImpl.mm (modified) (1 diff)
• Source/WebKit/UIProcess/WebFullScreenManagerProxy.cpp (modified) (4 diffs)
• Source/WebKit/UIProcess/WebFullScreenManagerProxy.h (modified) (2 diffs)
• Tools/ChangeLog (modified) (1 diff)
• Tools/MiniBrowser/mac/AppDelegate.m (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-11-12  Peng Liu  <peng.liu6@apple.com>
+
+        Promote WKPreferences._fullScreenEnabled to API
+        https://bugs.webkit.org/show_bug.cgi?id=230784
+        <rdar://83255308>
+
+        Reviewed by Jer Noble.
+
+        * UIProcess/API/Cocoa/WKPreferences.h:
+        * UIProcess/API/Cocoa/WKPreferences.mm:
+        (-[WKPreferences isElementFullscreenEnabled]):
+        (-[WKPreferences setElementFullscreenEnabled:]):
+        * UIProcess/API/Cocoa/WKWebView.h:
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView fullscreenState]):
+        * UIProcess/Cocoa/FullscreenClient.h:
+        * UIProcess/Cocoa/FullscreenClient.mm:
+        (WebKit::FullscreenClient::willEnterFullscreen):
+        (WebKit::FullscreenClient::didEnterFullscreen):
+        (WebKit::FullscreenClient::willExitFullscreen):
+        (WebKit::FullscreenClient::didExitFullscreen):
+        * UIProcess/Cocoa/WebViewImpl.mm:
+        (WebKit::WebViewImpl::WebViewImpl):
+        * UIProcess/WebFullScreenManagerProxy.cpp:
+        (WebKit::WebFullScreenManagerProxy::willEnterFullScreen):
+        (WebKit::WebFullScreenManagerProxy::didEnterFullScreen):
+        (WebKit::WebFullScreenManagerProxy::willExitFullScreen):
+        (WebKit::WebFullScreenManagerProxy::didExitFullScreen):
+        * UIProcess/WebFullScreenManagerProxy.h:
+        (WebKit::WebFullScreenManagerProxy::fullscreenState const):
+
 2021-11-12  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKPreferences.h

@@ -71 +71 @@
 @property (nonatomic, getter=isSiteSpecificQuirksModeEnabled) BOOL siteSpecificQuirksModeEnabled WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
 
+/*! @abstract A Boolean value indicating whether Fullscreen API is enabled.
+ @discussion The default value is NO. We can set it to YES to enable support for the fullscreen API.
+ */
+@property (nonatomic, getter=isElementFullscreenEnabled) BOOL elementFullscreenEnabled WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
+
 @end
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKPreferences.mm

@@ -164 +164 @@
 }
 
+- (BOOL)isElementFullscreenEnabled
+{
+    return _preferences->fullScreenEnabled();
+}
+
+- (void)setElementFullscreenEnabled:(BOOL)elementFullscreenEnabled
+{
+    _preferences->setFullScreenEnabled(elementFullscreenEnabled);
+}
+
 #pragma mark OS X-specific methods
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebView.h

@@ -75 +75 @@
 } WK_API_AVAILABLE(macos(12.0), ios(15.0));
 
+typedef NS_ENUM(NSInteger, WKFullscreenState) {
+    WKFullscreenStateNotInFullscreen,
+    WKFullscreenStateEnteringFullscreen,
+    WKFullscreenStateInFullscreen,
+    WKFullscreenStateExitingFullscreen,
+} NS_SWIFT_NAME(WKWebView.FullscreenState) WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
+
 /*! @abstract A copy of the configuration with which the web view was
  initialized. */
@@ -605 +612 @@
 #endif
 
+/*! @abstract A WKWebView's fullscreen state.
+ @discussion @link WKWebView @link is key-value observing (KVO) compliant for this property. When an element
+ in the WKWebView enters fullscreen, WebKit will replace the WKWebView in the application view hierarchy with
+ a "placeholder" view, and move the WKWebView into a fullscreen window. When the element exits fullscreen later,
+ the WKWebView will be moved back into the application view hierarchy. An application may need to adjust/restore
+ its native UI components when the fullscreen state changes. The application should observe the fullscreenState
+ property of WKWebView in order to receive notifications regarding the fullscreen state change.
+ */
+@property (nonatomic, readonly) WKFullscreenState fullscreenState WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
+
 @end
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm

@@ -71 +71 @@
 #import "WKNSData.h"
 #import "WKNSURLExtras.h"
-#import <WebKit/WKNavigationDelegate.h>
+#import "WKNavigationDelegate.h"
 #import "WKNavigationInternal.h"
 #import "WKPDFConfiguration.h"
@@ -79 +79 @@
 #import "WKSharedAPICast.h"
 #import "WKSnapshotConfiguration.h"
-#import <WebKit/WKUIDelegate.h>
-#import <WebKit/WKUIDelegatePrivate.h>
+#import "WKUIDelegate.h"
+#import "WKUIDelegatePrivate.h"
 #import "WKUserContentControllerInternal.h"
 #import "WKWebViewConfigurationInternal.h"
@@ -1792 +1792 @@
 }
 
+- (WKFullscreenState)fullscreenState
+{
+#if ENABLE(FULLSCREEN_API)
+    auto* fullscreenManager = _page->fullScreenManager();
+    if (!fullscreenManager)
+        return WKFullscreenStateNotInFullscreen;
+
+    WKFullscreenState state = WKFullscreenStateNotInFullscreen;
+    switch (fullscreenManager->fullscreenState()) {
+    case WebKit::WebFullScreenManagerProxy::FullscreenState::EnteringFullscreen:
+        state = WKFullscreenStateEnteringFullscreen;
+        break;
+    case WebKit::WebFullScreenManagerProxy::FullscreenState::InFullscreen:
+        state = WKFullscreenStateInFullscreen;
+        break;
+    case WebKit::WebFullScreenManagerProxy::FullscreenState::ExitingFullscreen:
+        state = WKFullscreenStateExitingFullscreen;
+        break;
+    default:
+        state = WKFullscreenStateNotInFullscreen;
+        break;
+    }
+
+    return state;
+#else
+    return WKFullscreenStateNotInFullscreen;
+#endif
+}
+
 @end
 
@@ -3566 +3595 @@
 }
 
+// FIXME: Remove this after Safari adopts the new API
 - (void)_setFullscreenDelegate:(id<_WKFullscreenDelegate>)delegate
 {
@@ -3574 +3604 @@
 }
 
+// FIXME: Remove this after Safari adopts the new API
 - (id<_WKFullscreenDelegate>)_fullscreenDelegate
 {
@@ -3583 +3614 @@
 }
 
+// FIXME: Remove this after Safari adopts the new API
 - (BOOL)_isInFullscreen
 {

trunk/Source/WebKit/UIProcess/Cocoa/FullscreenClient.h

@@ -32 +32 @@
 #import <wtf/WeakObjCPtr.h>
 
-#if PLATFORM(MAC)
-@class NSView;
-using WKFullscreenClientView = NSView;
-#else
 @class WKWebView;
 using WKFullscreenClientView = WKWebView;
-#endif
 
 @protocol _WKFullscreenDelegate;

trunk/Source/WebKit/UIProcess/Cocoa/FullscreenClient.mm

@@ -60 +60 @@
 void FullscreenClient::willEnterFullscreen(WebPageProxy*)
 {
+    [m_webView willChangeValueForKey:@"fullscreenState"];
+    [m_webView didChangeValueForKey:@"fullscreenState"];
 #if PLATFORM(MAC)
     if (m_delegateMethods.webViewWillEnterFullscreen)
-        [m_delegate.get() _webViewWillEnterFullscreen:m_webView];
+        [m_delegate.get() _webViewWillEnterFullscreen:static_cast<NSView *>(m_webView)];
 #else
     if (m_delegateMethods.webViewWillEnterElementFullscreen)
@@ -71 +73 @@
 void FullscreenClient::didEnterFullscreen(WebPageProxy*)
 {
+    [m_webView willChangeValueForKey:@"fullscreenState"];
+    [m_webView didChangeValueForKey:@"fullscreenState"];
 #if PLATFORM(MAC)
     if (m_delegateMethods.webViewDidEnterFullscreen)
-        [m_delegate.get() _webViewDidEnterFullscreen:m_webView];
+        [m_delegate.get() _webViewDidEnterFullscreen:static_cast<NSView *>(m_webView)];
 #else
     if (m_delegateMethods.webViewDidEnterElementFullscreen)
@@ -82 +86 @@
 void FullscreenClient::willExitFullscreen(WebPageProxy*)
 {
+    [m_webView willChangeValueForKey:@"fullscreenState"];
+    [m_webView didChangeValueForKey:@"fullscreenState"];
 #if PLATFORM(MAC)
     if (m_delegateMethods.webViewWillExitFullscreen)
-        [m_delegate.get() _webViewWillExitFullscreen:m_webView];
+        [m_delegate.get() _webViewWillExitFullscreen:static_cast<NSView *>(m_webView)];
 #else
     if (m_delegateMethods.webViewWillExitElementFullscreen)
@@ -93 +99 @@
 void FullscreenClient::didExitFullscreen(WebPageProxy*)
 {
+    [m_webView willChangeValueForKey:@"fullscreenState"];
+    [m_webView didChangeValueForKey:@"fullscreenState"];
 #if PLATFORM(MAC)
     if (m_delegateMethods.webViewDidExitFullscreen)
-        [m_delegate.get() _webViewDidExitFullscreen:m_webView];
+        [m_delegate.get() _webViewDidExitFullscreen:static_cast<NSView *>(m_webView)];
 #else
     if (m_delegateMethods.webViewDidExitElementFullscreen)

trunk/Source/WebKit/UIProcess/Cocoa/WebViewImpl.mm

@@ -1538 +1538 @@
 
 #if ENABLE(FULLSCREEN_API)
-    m_page->setFullscreenClient(makeUnique<WebKit::FullscreenClient>(view));
+    m_page->setFullscreenClient(makeUnique<WebKit::FullscreenClient>(outerWebView));
 #endif
 

trunk/Source/WebKit/UIProcess/WebFullScreenManagerProxy.cpp

@@ -57 +57 @@
 void WebFullScreenManagerProxy::willEnterFullScreen()
 {
+    m_fullscreenState = FullscreenState::EnteringFullscreen;
     m_page.fullscreenClient().willEnterFullscreen(&m_page);
     m_page.send(Messages::WebFullScreenManager::WillEnterFullScreen());
@@ -63 +64 @@
 void WebFullScreenManagerProxy::didEnterFullScreen()
 {
+    m_fullscreenState = FullscreenState::InFullscreen;
     m_page.fullscreenClient().didEnterFullscreen(&m_page);
     m_page.send(Messages::WebFullScreenManager::DidEnterFullScreen());
@@ -74 +76 @@
 void WebFullScreenManagerProxy::willExitFullScreen()
 {
+    m_fullscreenState = FullscreenState::ExitingFullscreen;
     m_page.fullscreenClient().willExitFullscreen(&m_page);
     m_page.send(Messages::WebFullScreenManager::WillExitFullScreen());
@@ -93 +96 @@
 void WebFullScreenManagerProxy::didExitFullScreen()
 {
+    m_fullscreenState = FullscreenState::NotInFullscreen;
     m_page.fullscreenClient().didExitFullscreen(&m_page);
     m_page.send(Messages::WebFullScreenManager::DidExitFullScreen());

trunk/Source/WebKit/UIProcess/WebFullScreenManagerProxy.h

@@ -68 +68 @@
     void close();
 
+    enum class FullscreenState : uint8_t {
+        NotInFullscreen,
+        EnteringFullscreen,
+        InFullscreen,
+        ExitingFullscreen,
+    };
+    FullscreenState fullscreenState() const { return m_fullscreenState; }
+
     void willEnterFullScreen();
     void didEnterFullScreen();
@@ -95 +103 @@
     WebPageProxy& m_page;
     WebFullScreenManagerProxyClient& m_client;
+    FullscreenState m_fullscreenState { FullscreenState::NotInFullscreen };
     bool m_blocksReturnToFullscreenFromPictureInPicture { false };
     Vector<CompletionHandler<void()>> m_closeCompletionHandlers;

trunk/Tools/ChangeLog

@@ +1 @@
+2021-11-12  Peng Liu  <peng.liu6@apple.com>
+
+        Promote WKPreferences._fullScreenEnabled to API
+        https://bugs.webkit.org/show_bug.cgi?id=230784
+        <rdar://83255308>
+
+        Reviewed by Jer Noble.
+
+        * MiniBrowser/mac/AppDelegate.m:
+        (-[BrowserAppDelegate defaultConfiguration]):
+
 2021-11-12  Chris Dumez  <cdumez@apple.com>
 

trunk/Tools/MiniBrowser/mac/AppDelegate.m

@@ -146 +146 @@
         }
 
-        configuration.preferences._fullScreenEnabled = YES;
+        configuration.preferences.elementFullscreenEnabled = YES;
         configuration.preferences._allowsPictureInPictureMediaPlayback = YES;
         configuration.preferences._developerExtrasEnabled = YES;