Use c-style string when webview loads contents.
[platform/core/uifw/dali-adaptor.git] / dali / internal / web-engine / common / web-engine-impl.h
old mode 100644 (file)
new mode 100755 (executable)
index 069339f..1a35dc9
@@ -2,7 +2,7 @@
 #define DALI_WEB_ENGINE_IMPL_H
 
 /*
- * Copyright (c) 2021 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,8 +22,9 @@
 #include <dali/public-api/object/base-object.h>
 
 // INTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
-#include <dali/devel-api/adaptor-framework/web-engine.h>
+#include <dali/devel-api/adaptor-framework/accessibility.h>
+#include <dali/devel-api/adaptor-framework/web-engine/web-engine-plugin.h>
+#include <dali/devel-api/adaptor-framework/web-engine/web-engine.h>
 
 namespace Dali
 {
@@ -48,21 +49,33 @@ class WebEngine : public Dali::BaseObject
 {
 public:
   /**
-   * @brief Creates a new WebEngine handle
+   * @brief Create a new WebEngine handle
    *
    * @return WebEngine pointer
    */
   static WebEnginePtr New();
 
   /**
+   * @brief Get context of web engine
+   *
+   */
+  static Dali::WebEngineContext* GetContext();
+
+  /**
+   * @brief Get cookie manager of web engine
+   *
+   */
+  static Dali::WebEngineCookieManager* GetCookieManager();
+
+  /**
    * @copydoc Dali::WebEngine::Create()
    */
-  void Create(int width, int height, const std::string& locale, const std::string& timezoneId);
+  void Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId);
 
   /**
    * @copydoc Dali::WebEngine::Create()
    */
-  void Create(int width, int height, int argc, char** argv);
+  void Create(uint32_t width, uint32_t height, uint32_t argc, char** argv);
 
   /**
    * @copydoc Dali::WebEngine::Destroy()
@@ -70,24 +83,19 @@ public:
   void Destroy();
 
   /**
-   * @copydoc Dali::WebEngine::GetNativeImageSource()
+   * @copydoc Dali::WebEngine::GetPlugin()
    */
-  Dali::NativeImageInterfacePtr GetNativeImageSource();
+  Dali::WebEnginePlugin* GetPlugin() const;
 
   /**
-   * @copydoc Dali::WebEngine::GetSettings()
-   */
-  Dali::WebEngineSettings& GetSettings() const;
-
-  /**
-   * @copydoc Dali::WebEngine::GetContext()
+   * @copydoc Dali::WebEngine::GetNativeImageSource()
    */
-  Dali::WebEngineContext& GetContext() const;
+  Dali::NativeImageSourcePtr GetNativeImageSource();
 
   /**
-   * @copydoc Dali::WebEngine::GetCookieManager()
+   * @copydoc Dali::WebEngine::GetSettings()
    */
-  Dali::WebEngineCookieManager& GetCookieManager() const;
+  Dali::WebEngineSettings& GetSettings() const;
 
   /**
    * @copydoc Dali::WebEngine::GetBackForwardList()
@@ -112,12 +120,12 @@ public:
   /**
    * @copydoc Dali::WebEngine::GetUrl()
    */
-  const std::string& GetUrl();
+  std::string GetUrl() const;
 
   /**
    * @copydoc Dali::WebEngine::GetUserAgent()
    */
-  const std::string& GetUserAgent() const;
+  std::string GetUserAgent() const;
 
   /**
    * @copydoc Dali::WebEngine::SetUserAgent()
@@ -130,11 +138,26 @@ public:
   void LoadHtmlString(const std::string& htmlString);
 
   /**
+   * @copydoc Dali::WebEngine::LoadHtmlStringOverrideCurrentEntry()
+   */
+  bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
+
+  /**
+   * @copydoc Dali::WebEngine::LoadContents()
+   */
+  bool LoadContents(const int8_t* contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
+
+  /**
    * @copydoc Dali::WebEngine::Reload()
    */
   void Reload();
 
   /**
+   * @copydoc Dali::WebEngine::ReloadWithoutCache()
+   */
+  bool ReloadWithoutCache();
+
+  /**
    * @copydoc Dali::WebEngine::StopLoading()
    */
   void StopLoading();
@@ -150,14 +173,49 @@ public:
   void Resume();
 
   /**
+   * @copydoc Dali::WebEngine::SuspendNetworkLoading()
+   */
+  void SuspendNetworkLoading();
+
+  /**
+   * @copydoc Dali::WebEngine::ResumeNetworkLoading()
+   */
+  void ResumeNetworkLoading();
+
+  /**
+   * @copydoc Dali::WebEngine::AddCustomHeader()
+   */
+  bool AddCustomHeader(const std::string& name, const std::string& value);
+
+  /**
+   * @copydoc Dali::WebEngine::RemoveCustomHeader()
+   */
+  bool RemoveCustomHeader(const std::string& name);
+
+  /**
+   * @copydoc Dali::WebEngine::StartInspectorServer()
+   */
+  uint32_t StartInspectorServer(uint32_t port);
+
+  /**
+   * @copydoc Dali::WebEngine::StopInspectorServer()
+   */
+  bool StopInspectorServer();
+
+  /**
    * @copydoc Dali::WebEngine::ScrollBy()
    */
-  void ScrollBy(int deltaX, int deltaY);
+  void ScrollBy(int32_t deltaX, int32_t deltaY);
+
+  /**
+   * @copydoc Dali::WebEngine::ScrollEdgeBy()
+   */
+  bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY);
 
   /**
    * @copydoc Dali::WebEngine::SetScrollPosition()
    */
-  void SetScrollPosition(int x, int y);
+  void SetScrollPosition(int32_t x, int32_t y);
 
   /**
    * @copydoc Dali::WebEngine::GetScrollPosition()
@@ -175,6 +233,46 @@ public:
   Dali::Vector2 GetContentSize() const;
 
   /**
+   * @copydoc Dali::WebEngine::RegisterJavaScriptAlertCallback()
+   */
+  void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::JavaScriptAlertReply()
+   */
+  void JavaScriptAlertReply();
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterJavaScriptConfirmCallback()
+   */
+  void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::JavaScriptConfirmReply()
+   */
+  void JavaScriptConfirmReply(bool confirmed);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterJavaScriptPromptCallback()
+   */
+  void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::JavaScriptPromptReply()
+   */
+  void JavaScriptPromptReply(const std::string& result);
+
+  /**
+   * @copydoc Dali::WebEngine::CreateHitTest()
+   */
+  std::unique_ptr<Dali::WebEngineHitTest> CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode);
+
+  /**
+   * @copydoc Dali::WebEngine::CreateHitTestAsynchronously()
+   */
+  bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback);
+
+  /**
    * @copydoc Dali::WebEngine::CanGoForward()
    */
   bool CanGoForward();
@@ -197,12 +295,12 @@ public:
   /**
    * @copydoc Dali::WebEngine::EvaluateJavaScript()
    */
-  void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
+  void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler);
 
   /**
    * @copydoc Dali::WebEngine::AddJavaScriptMessageHandler()
    */
-  void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
+  void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler);
 
   /**
    * @copydoc Dali::WebEngine::ClearAllTilesResources()
@@ -217,7 +315,42 @@ public:
   /**
    * @copydoc Dali::WebEngine::SetSize()
    */
-  void SetSize(int width, int height);
+  void SetSize(uint32_t width, uint32_t height);
+
+  /**
+   * @copydoc Dali::WebEngine::EnableMouseEvents()
+   */
+  void EnableMouseEvents(bool enabled);
+
+  /**
+   * @copydoc Dali::WebEngine::EnableKeyEvents()
+   */
+  void EnableKeyEvents(bool enabled);
+
+  /**
+   * @copydoc Dali::WebEngine::SetDocumentBackgroundColor()
+   */
+  void SetDocumentBackgroundColor(Dali::Vector4 color);
+
+  /**
+   * @copydoc Dali::WebEngine::ClearTilesWhenHidden()
+   */
+  void ClearTilesWhenHidden(bool cleared);
+
+  /**
+   * @copydoc Dali::WebEngine::SetTileCoverAreaMultiplier()
+   */
+  void SetTileCoverAreaMultiplier(float multiplier);
+
+  /**
+   * @copydoc Dali::WebEngine::EnableCursorByClient()
+   */
+  void EnableCursorByClient(bool enabled);
+
+  /**
+   * @copydoc Dali::WebEngine::GetSelectedText()
+   */
+  std::string GetSelectedText() const;
 
   /**
    * @copydoc Dali::WebEngine::SendTouchEvent()
@@ -235,9 +368,89 @@ public:
   void SetFocus(bool focused);
 
   /**
+   * @copydoc Dali::WebEngine::SetPageZoomFactor()
+   */
+  void SetPageZoomFactor(float zoomFactor);
+
+  /**
+   * @copydoc Dali::WebEngine::GetPageZoomFactor()
+   */
+  float GetPageZoomFactor() const;
+
+  /**
+   * @copydoc Dali::WebEngine::SetTextZoomFactor()
+   */
+  void SetTextZoomFactor(float zoomFactor);
+
+  /**
+   * @copydoc Dali::WebEngine::GetTextZoomFactor()
+   */
+  float GetTextZoomFactor() const;
+
+  /**
+   * @copydoc Dali::WebEngine::GetLoadProgressPercentage()
+   */
+  float GetLoadProgressPercentage() const;
+
+  /**
+   * @copydoc Dali::WebEngine::SetScaleFactor()
+   */
+  void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
+
+  /**
+   * @copydoc Dali::WebEngine::GetScaleFactor()
+   */
+  float GetScaleFactor() const;
+
+  /**
+   * @copydoc Dali::WebEngine::ActivateAccessibility()
+   */
+  void ActivateAccessibility(bool activated);
+
+  /**
+   * @copydoc Dali::WebEngine::GetAccessibilityAddress()
+   */
+  Accessibility::Address GetAccessibilityAddress();
+
+  /**
+   * @copydoc Dali::WebEngine::SetVisibility()
+   */
+  bool SetVisibility(bool visible);
+
+  /**
+   * @copydoc Dali::WebEngine::HighlightText()
+   */
+  bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
+
+  /**
+   * @copydoc Dali::WebEngine::AddDynamicCertificatePath()
+   */
+  void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
+
+  /**
+   * @copydoc Dali::WebEngine::GetScreenshot()
+   */
+  Dali::PixelData GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor);
+
+  /**
+   * @copydoc Dali::WebEngine::GetScreenshotAsync()
+   */
+  bool GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::IsVideoPlaying()
+   */
+  bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterGeolocationPermissionCallback()
+   */
+  void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
+
+  /**
    * @copydoc Dali::WebEngine::UpdateDisplayArea()
    */
-  void UpdateDisplayArea(Dali::Rect<int> displayArea);
+  void UpdateDisplayArea(Dali::Rect<int32_t> displayArea);
 
   /**
    * @copydoc Dali::WebEngine::EnableVideoHole()
@@ -245,24 +458,104 @@ public:
   void EnableVideoHole(bool enabled);
 
   /**
-   * @copydoc Dali::WebEngine::PageLoadStartedSignal()
+   * @copydoc Dali::WebEngine::SendHoverEvent()
+   */
+  bool SendHoverEvent(const Dali::HoverEvent& event);
+
+  /**
+   * @copydoc Dali::WebEngine::SendWheelEvent()
+   */
+  bool SendWheelEvent(const Dali::WheelEvent& event);
+
+  /**
+   @copydoc Dali::WebEngine::RegisterFrameRenderedCallback()
    */
-  Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
+  void RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback);
 
   /**
-   * @copydoc Dali::WebEngine::PageLoadFinishedSignal()
+   * @copydoc Dali::WebEngine::RegisterPageLoadStartedCallback()
    */
-  Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
+  void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 
   /**
-   * @copydoc Dali::WebEngine::PageLoadErrorSignal()
+   * @copydoc Dali::WebEngine::RegisterPageLoadInProgressCallback()
    */
-  Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
+  void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 
   /**
-   * @copydoc Dali::WebEngine::ScrollEdgeReachedSignal()
+   * @copydoc Dali::WebEngine::RegisterPageLoadFinishedCallback()
    */
-  Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
+  void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterPageLoadErrorCallback()
+   */
+  void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterScrollEdgeReachedCallback()
+   */
+  void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterUrlChangedCallback()
+   */
+  void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterFormRepostDecidedCallback()
+   */
+  void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback);
+
+  /**
+   @copydoc Dali::WebEngine::RegisterConsoleMessageReceivedCallback()
+   */
+  void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback);
+
+  /**
+   @copydoc Dali::WebEngine::RegisterResponsePolicyDecidedCallback()
+   */
+  void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback);
+
+  /**
+   @copydoc Dali::WebEngine::RegisterNavigationPolicyDecidedCallback()
+   */
+  void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback);
+
+  /**
+   @copydoc Dali::WebEngine::RegisterNewWindowCreatedCallback()
+   */
+  void RegisterNewWindowCreatedCallback(Dali::WebEnginePlugin::WebEngineNewWindowCreatedCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterCertificateConfirmedCallback()
+   */
+  void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterSslCertificateChangedCallback()
+   */
+  void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterHttpAuthHandlerCallback()
+   */
+  void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterContextMenuShownCallback()
+   */
+  void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::RegisterContextMenuHiddenCallback()
+   */
+  void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback);
+
+  /**
+   * @copydoc Dali::WebEngine::GetPlainTextAsynchronously()
+   */
+  void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
 
 private:
   /**
@@ -282,27 +575,14 @@ private:
   WebEngine& operator=(const WebEngine& WebEngine);
 
   /**
-   * @brief Initializes member data.
+   * @brief Initialize member data.
    *
    * @return Whether the initialization succeed or not.
    */
   bool Initialize();
 
-  /**
-   * @brief Initializes library handle by loading web engine plugin.
-   *
-   * @return Whether the initialization succeed or not.
-   */
-  bool InitializePluginHandle();
-
 private:
-  typedef Dali::WebEnginePlugin* (*CreateWebEngineFunction)();
-  typedef void (*DestroyWebEngineFunction)(Dali::WebEnginePlugin* plugin);
-
-  Dali::WebEnginePlugin*   mPlugin;              ///< WebEnginePlugin instance
-  void*                    mHandle;              ///< Handle for the loaded library
-  CreateWebEngineFunction  mCreateWebEnginePtr;  ///< Function to create plugin instance
-  DestroyWebEngineFunction mDestroyWebEnginePtr; ///< Function to destroy plugin instance
+  Dali::WebEnginePlugin* mPlugin; ///< WebEnginePlugin instance
 };
 
 } // namespace Adaptor