ApplePlatformWebBrowser.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
#if !WITH_CEF3 && (PLATFORM_IOS || PLATFORM_MAC)
 
#include "IWebBrowserWindow.h"
#include "Widgets/SWindow.h"
 
#include "Engine/Texture2D.h"
#include "Materials/MaterialInstanceDynamic.h"
#include "WebBrowserTexture.h"
#include "Misc/ConfigCacheIni.h"
 
#include "MobileJS/MobileJSScripting.h"
 
#if PLATFORM_IOS
#import <UIKit/UIKit.h>
#else
#import <AppKit/AppKit.h>
#endif
 
#if !PLATFORM_TVOS
#import "WebKit/WebKit.h"
#endif
 
 
DECLARE_LOG_CATEGORY_EXTERN(LogAppleWebBrowser, Log, All);
 
class SAppleWebBrowserWidget;
class SWebBrowserView;
 
#if !PLATFORM_TVOS
@class WebViewCloseButton;
 
@interface AppleWebViewWrapper : NSObject <WKUIDelegate, WKNavigationDelegate, WKScriptMessageHandler>
#else
@interface AppleWebViewWrapper : NSObject
#endif
{
    SAppleWebBrowserWidget* WebBrowserWidget;
    FTextureRHIRef VideoTexture;
    TWeakPtr<SWindow> Current3DWindow;
    bool bNeedsAddToView;
    bool Is3DBrowser;
    bool bVideoTextureValid;
}
#if !PLATFORM_TVOS
@property(strong) WKWebView* WebView;
#if PLATFORM_MAC
@property(strong) NSView* WebViewContainer;
@property(strong) NSView* GameWindowView;
#else
@property(strong) WebViewCloseButton* CloseButton;
@property(strong) UIView* WebViewContainer;
#endif
@property(strong) WKUserContentController* UserContentController;
#endif
@property(copy) NSURL* NextURL;
@property(copy) NSString* NextContent;
@property CGRect DesiredFrame;
 
-(void)create:(SAppleWebBrowserWidget*)InWebBrowserWidget userAgentApplication: (NSString*)UserAgentApplication useTransparency : (bool)InUseTransparency
enableFloatingCloseButton : (bool)bEnableFloatingCloseButton;
-(void)didRotate;
-(void)close;
-(void)showFloatingCloseButton:(BOOL)bShow setDraggable:(BOOL)bDraggable;
-(void)dealloc;
-(void)updateframe:(CGRect)InFrame window:(FGenericWindow*)EnclosedWindow;
-(void)loadstring:(NSString*)InString dummyurl:(NSURL*)InURL;
-(void)loadurl:(NSURL*)InURL;
-(void)executejavascript:(NSString*)InJavaScript;
-(void)set3D:(bool)InIs3DBrowser;
-(void)setDefaultVisibility;
-(void)setVisibility:(bool)InIsVisible;
-(void)stopLoading;
-(void)reload;
-(void)goBack;
-(void)goForward;
-(bool)canGoBack;
-(bool)canGoForward;
-(FTextureRHIRef)GetVideoTexture;
-(void)SetVideoTexture:(FTextureRHIRef)Texture;
-(void)SetVideoTextureValid:(bool)Condition;
-(bool)IsVideoTextureValid;
-(bool)UpdateVideoFrame:(void*)ptr;
-(void)updateWebViewMetalTexture : (id<MTLTexture>)texture;
-(void)leaveDeadWindow;
-(bool)inKeyWindow;
#if !PLATFORM_MAC
-(CGFloat)getScreenScale;
#endif
#if !PLATFORM_TVOS
-(void)webView:(WKWebView*)InWebView decidePolicyForNavigationAction : (WKNavigationAction*)InNavigationAction decisionHandler : (void(^)(WKNavigationActionPolicy))InDecisionHandler;
-(void)webView:(WKWebView*)InWebView didCommitNavigation : (WKNavigation*)InNavigation;
#endif
@end
 
class FWebView3DInputHandler;
 
class FWebBrowserWindow
    : public IWebBrowserWindow
    , public TSharedFromThis<FWebBrowserWindow>
{
    // The WebBrowserSingleton should be the only one creating instances of this class
    friend class FWebBrowserSingleton;
    // CreateWidget should only be called by the WebBrowserView
    friend class SWebBrowserView;
 
private:
    FWebBrowserWindow(FString InUrl, TOptional<FString> InContentsToLoad, bool ShowErrorMessage, bool bThumbMouseButtonNavigation, bool bUseTransparency, bool bInJSBindingToLoweringEnabled, FString InUserAgentApplication, bool bMobileJSReturnInDict);
 
    TSharedRef<SViewport> CreateWidget();
 
public:
    virtual ~FWebBrowserWindow();
 
public:
 
    // IWebBrowserWindow Interface
 
    virtual void LoadURL(FString NewURL) override;
    virtual void LoadString(FString Contents, FString DummyURL) override;
    virtual void SetViewportSize(FIntPoint ViewportWindowSize, FIntPoint WindowPos) override;
    virtual FIntPoint GetViewportSize() const override;
    virtual FSlateShaderResource* GetTexture(bool bIsPopup = false) override;
    virtual bool IsValid() const override;
    virtual bool IsInitialized() const override;
    virtual bool IsClosing() const override;
    virtual EWebBrowserDocumentState GetDocumentLoadingState() const override;
    virtual FString GetTitle() const override;
    virtual FString GetUrl() const override;
    virtual bool OnKeyDown(const FKeyEvent& InKeyEvent) override;
    virtual bool OnKeyUp(const FKeyEvent& InKeyEvent) override;
    virtual bool OnKeyChar(const FCharacterEvent& InCharacterEvent) override;
    virtual FReply OnMouseButtonDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
    virtual FReply OnMouseButtonUp(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
    virtual FReply OnMouseButtonDoubleClick(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
    virtual FReply OnMouseMove(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
    virtual void OnMouseLeave(const FPointerEvent& MouseEvent) override;
    virtual void SetSupportsMouseWheel(bool bValue) override;
    virtual bool GetSupportsMouseWheel() const override;
    virtual FReply OnMouseWheel(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
    virtual FReply OnTouchGesture(const FGeometry& MyGeometry, const FPointerEvent& GestureEvent, bool bIsPopup) override;
    virtual void OnFocus(bool SetFocus, bool bIsPopup) override;
    virtual void OnCaptureLost() override;
    virtual bool CanGoBack() const override;
    virtual void GoBack() override;
    virtual bool CanGoForward() const override;
    virtual void GoForward() override;
    virtual bool IsLoading() const override;
    virtual void Reload() override;
    virtual void StopLoad() override;
    virtual void ExecuteJavascript(const FString& Script) override;
    virtual void CloseBrowser(bool bForce, bool bBlockTillClosed) override;
    virtual void BindUObject(const FString& Name, UObject* Object, bool bIsPermanent = true) override;
    virtual void UnbindUObject(const FString& Name, UObject* Object = nullptr, bool bIsPermanent = true) override;
    virtual void GetSource(TFunction<void (const FString&)> Callback) const;
    virtual int GetLoadError() override;
    virtual void SetIsDisabled(bool bValue) override;
    virtual TSharedPtr<SWindow> GetParentWindow() const override;
    virtual void SetParentWindow(TSharedPtr<SWindow> Window) override;
    virtual void SetParentDockTab(TSharedPtr<SDockTab> DockTab) override;
    virtual void ShowFloatingCloseButton(bool bShow, bool bDraggable) override;
 
    // TODO: None of these events are actually called
 
    DECLARE_DERIVED_EVENT(FWebBrowserWindow, IWebBrowserWindow::FOnDocumentStateChanged, FOnDocumentStateChanged);
    virtual FOnDocumentStateChanged& OnDocumentStateChanged() override
    {
        return DocumentStateChangedEvent;
    }
 
    DECLARE_DERIVED_EVENT(FWebBrowserWindow, IWebBrowserWindow::FOnTitleChanged, FOnTitleChanged);
    virtual FOnTitleChanged& OnTitleChanged() override
    {
        return TitleChangedEvent;
    }
 
    DECLARE_DERIVED_EVENT(FWebBrowserWindow, IWebBrowserWindow::FOnUrlChanged, FOnUrlChanged);
    virtual FOnUrlChanged& OnUrlChanged() override
    {
        return UrlChangedEvent;
    }
 
    DECLARE_DERIVED_EVENT(FWebBrowserWindow, IWebBrowserWindow::FOnToolTip, FOnToolTip);
    virtual FOnToolTip& OnToolTip() override
    {
        return ToolTipEvent;
    }
 
    DECLARE_DERIVED_EVENT(FWebBrowserWindow, IWebBrowserWindow::FOnNeedsRedraw, FOnNeedsRedraw);
    virtual FOnNeedsRedraw& OnNeedsRedraw() override
    {
        return NeedsRedrawEvent;
    }
 
    virtual FOnBeforeBrowse& OnBeforeBrowse() override
    {
        return BeforeBrowseDelegate;
    }
 
    virtual FOnLoadUrl& OnLoadUrl() override
    {
        return LoadUrlDelegate;
    }
 
    virtual FOnCreateWindow& OnCreateWindow() override
    {
        return CreateWindowDelegate;
    }
 
    virtual FOnCloseWindow& OnCloseWindow() override
    {
        return CloseWindowDelegate;
    }
 
    virtual FOnFloatingCloseButtonPressed& OnFloatingCloseButtonPressed() override
    {
        return FloatingCloseButtonPressedDelegate;
    }
 
    virtual FCursorReply OnCursorQuery(const FGeometry& MyGeometry, const FPointerEvent& CursorEvent) override
    {
        //return Cursor == EMouseCursor::Default ? FCursorReply::Unhandled() : FCursorReply::Cursor(Cursor);
        return FCursorReply::Unhandled();
    }
 
    virtual FOnBeforeResourceLoadDelegate& OnBeforeResourceLoad() override
    {
        return BeforeResourceLoadDelegate;
    }
 
    virtual FOnResourceLoadCompleteDelegate& OnResourceLoadComplete() override
    {
        return ResourceLoadCompleteDelegate;
    }
 
    virtual FOnConsoleMessageDelegate& OnConsoleMessage() override
    {
        return ConsoleMessageDelegate;
    }
 
    virtual FOnBeforePopupDelegate& OnBeforePopup() override
    {
        return BeforePopupDelegate;
    }
 
    DECLARE_DERIVED_EVENT(FWebBrowserWindow, IWebBrowserWindow::FOnShowPopup, FOnShowPopup);
    virtual FOnShowPopup& OnShowPopup() override
    {
        return ShowPopupEvent;
    }
 
    DECLARE_DERIVED_EVENT(FWebBrowserWindow, IWebBrowserWindow::FOnDismissPopup, FOnDismissPopup);
    virtual FOnDismissPopup& OnDismissPopup() override
    {
        return DismissPopupEvent;
    }
 
    virtual FOnShowDialog& OnShowDialog() override
    {
        return ShowDialogDelegate;
    }
 
    virtual FOnDismissAllDialogs& OnDismissAllDialogs() override
    {
        return DismissAllDialogsDelegate;
    }
 
    virtual FOnSuppressContextMenu& OnSuppressContextMenu() override
    {
        return SuppressContextMenuDelgate;
    }
 
    virtual FOnDragWindow& OnDragWindow() override
    {
        return DragWindowDelegate;
    }
    
    void NotifyDocumentLoadingStateChange(const FString& InCurrentUrl, bool IsLoading);
 
    void NotifyDocumentError(const FString& InCurrentUrl, int InErrorCode);
 
    bool OnJsMessageReceived(const FString& Command, const TArray<FString>& Params, const FString& Origin);
 
    virtual FOnUnhandledKeyDown& OnUnhandledKeyDown() override
    {
        return UnhandledKeyDownDelegate;
    }
 
    virtual FOnUnhandledKeyUp& OnUnhandledKeyUp() override
    {
        return UnhandledKeyUpDelegate;
    }
 
    virtual FOnUnhandledKeyChar& OnUnhandledKeyChar() override
    {
        return UnhandledKeyCharDelegate;
    }
 
    void NotifyUrlChanged(const FString& InCurrentUrl);
public:
    void CheckTickActivity() override;
 
    void SetTickLastFrame();
 
    bool IsVisible();
    
    bool Is3D();
 
    void FloatingCloseButtonPressed();
 
 
    void SetTitle(const FString& InTitle)
    {
        Title = InTitle;
        OnTitleChanged().Broadcast(Title);
    }
    
    void OnActiveTabChanged(TSharedPtr<SDockTab> ActiveTab, TSharedPtr<SDockTab> PreviouslyActiveTab);
    
    TWeakPtr<SDockTab> GetParentDockTab();
 
private:
 
    TOptional<FSlateRenderTransform> GetWebBrowserRenderTransform() const;
    void RedirectNSEvent();
    
    TSharedPtr<SAppleWebBrowserWidget> BrowserWidget;
 
    FString Title;
 
    FString CurrentUrl;
 
    FString UserAgentApplication;
 
    TOptional<FString> ContentsToLoad;
    
    bool bUseTransparency;
 
    // TODO: None of these events are actually called
 
    FOnDocumentStateChanged DocumentStateChangedEvent;
 
    FOnTitleChanged TitleChangedEvent;
 
    FOnUrlChanged UrlChangedEvent;
 
    FOnToolTip ToolTipEvent;
 
    FOnNeedsRedraw NeedsRedrawEvent;
 
    FOnBeforeBrowse BeforeBrowseDelegate;
 
    FOnLoadUrl LoadUrlDelegate;
 
    FOnBeforePopupDelegate BeforePopupDelegate;
 
    FOnBeforeResourceLoadDelegate BeforeResourceLoadDelegate;
 
    FOnResourceLoadCompleteDelegate ResourceLoadCompleteDelegate;
 
    FOnConsoleMessageDelegate ConsoleMessageDelegate;
 
    FOnCreateWindow CreateWindowDelegate;
 
    FOnCloseWindow CloseWindowDelegate;
 
    FOnFloatingCloseButtonPressed FloatingCloseButtonPressedDelegate;
 
    FOnShowPopup ShowPopupEvent;
 
    FOnDismissPopup DismissPopupEvent;
 
    FOnShowDialog ShowDialogDelegate;
 
    FOnDismissAllDialogs DismissAllDialogsDelegate;
 
    FOnSuppressContextMenu SuppressContextMenuDelgate;
 
    FOnDragWindow DragWindowDelegate;
 
    EWebBrowserDocumentState DocumentState;
    int ErrorCode;
 
    FMobileJSScriptingPtr Scripting;
    TSharedPtr<FWebView3DInputHandler> WebView3DInput;
 
    mutable TOptional<TFunction<void(const FString&)>> GetPageSourceCallback;
    FOnUnhandledKeyDown UnhandledKeyDownDelegate;
    
    FOnUnhandledKeyUp UnhandledKeyUpDelegate;
    
    FOnUnhandledKeyChar UnhandledKeyCharDelegate;
 
    TWeakPtr<SWindow> ParentWindow;
    TWeakPtr<SDockTab> ParentDockTab;
    FDelegateHandle ParentDockTabDelegate;
 
    FIntPoint WindowSize;
 
    bool bIsDisabled;
 
    bool bIsVisible;
 
    bool bTickedLastFrame;
};
 
#endif