dali/internal/web-engine/common/web-engine-impl.h

   1 #ifndef DALI_WEB_ENGINE_IMPL_H
   2 #define DALI_WEB_ENGINE_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-object.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/adaptor-framework/accessibility.h>
  26 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-plugin.h>
  27 #include <dali/devel-api/adaptor-framework/web-engine/web-engine.h>
  28
  29 namespace Dali
  30 {
  31 // forward declaration
  32 class WebEngineBackForwardList;
  33 class WebEngineContext;
  34 class WebEngineCookieManager;
  35 class WebEngineSettings;
  36
  37 namespace Internal
  38 {
  39 namespace Adaptor
  40 {
  41 class WebEngine;
  42
  43 typedef IntrusivePtr<WebEngine> WebEnginePtr;
  44
  45 /**
  46  * @brief WebEngine class is used for Web.
  47  */
  48 class WebEngine : public Dali::BaseObject
  49 {
  50 public:
  51   /**
  52    * @brief Create a new WebEngine handle
  53    *
  54    * @return WebEngine pointer
  55    */
  56   static WebEnginePtr New();
  57
  58   /**
  59    * @brief Get context of web engine
  60    *
  61    */
  62   static Dali::WebEngineContext* GetContext();
  63
  64   /**
  65    * @brief Get cookie manager of web engine
  66    *
  67    */
  68   static Dali::WebEngineCookieManager* GetCookieManager();
  69
  70   /**
  71    * @copydoc Dali::WebEngine::Create()
  72    */
  73   void Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId);
  74
  75   /**
  76    * @copydoc Dali::WebEngine::Create()
  77    */
  78   void Create(uint32_t width, uint32_t height, uint32_t argc, char** argv);
  79
  80   /**
  81    * @copydoc Dali::WebEngine::Destroy()
  82    */
  83   void Destroy();
  84
  85   /**
  86    * @copydoc Dali::WebEngine::GetNativeImageSource()
  87    */
  88   Dali::NativeImageSourcePtr GetNativeImageSource();
  89
  90   /**
  91    * @copydoc Dali::WebEngine::GetSettings()
  92    */
  93   Dali::WebEngineSettings& GetSettings() const;
  94
  95   /**
  96    * @copydoc Dali::WebEngine::GetBackForwardList()
  97    */
  98   Dali::WebEngineBackForwardList& GetBackForwardList() const;
  99
 100   /**
 101    * @copydoc Dali::WebEngine::LoadUrl()
 102    */
 103   void LoadUrl(const std::string& url);
 104
 105   /**
 106    * @copydoc Dali::WebEngine::GetTitle()
 107    */
 108   std::string GetTitle() const;
 109
 110   /**
 111    * @copydoc Dali::WebEngine::GetFavicon()
 112    */
 113   Dali::PixelData GetFavicon() const;
 114
 115   /**
 116    * @copydoc Dali::WebEngine::GetUrl()
 117    */
 118   std::string GetUrl() const;
 119
 120   /**
 121    * @copydoc Dali::WebEngine::GetUserAgent()
 122    */
 123   std::string GetUserAgent() const;
 124
 125   /**
 126    * @copydoc Dali::WebEngine::SetUserAgent()
 127    */
 128   void SetUserAgent(const std::string& userAgent);
 129
 130   /**
 131    * @copydoc Dali::WebEngine::LoadHtmlString()
 132    */
 133   void LoadHtmlString(const std::string& htmlString);
 134
 135   /**
 136    * @copydoc Dali::WebEngine::LoadHtmlStringOverrideCurrentEntry()
 137    */
 138   bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
 139
 140   /**
 141    * @copydoc Dali::WebEngine::LoadContents()
 142    */
 143   bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
 144
 145   /**
 146    * @copydoc Dali::WebEngine::Reload()
 147    */
 148   void Reload();
 149
 150   /**
 151    * @copydoc Dali::WebEngine::ReloadWithoutCache()
 152    */
 153   bool ReloadWithoutCache();
 154
 155   /**
 156    * @copydoc Dali::WebEngine::StopLoading()
 157    */
 158   void StopLoading();
 159
 160   /**
 161    * @copydoc Dali::WebEngine::Suspend()
 162    */
 163   void Suspend();
 164
 165   /**
 166    * @copydoc Dali::WebEngine::Resume()
 167    */
 168   void Resume();
 169
 170   /**
 171    * @copydoc Dali::WebEngine::SuspendNetworkLoading()
 172    */
 173   void SuspendNetworkLoading();
 174
 175   /**
 176    * @copydoc Dali::WebEngine::ResumeNetworkLoading()
 177    */
 178   void ResumeNetworkLoading();
 179
 180   /**
 181    * @copydoc Dali::WebEngine::AddCustomHeader()
 182    */
 183   bool AddCustomHeader(const std::string& name, const std::string& value);
 184
 185   /**
 186    * @copydoc Dali::WebEngine::RemoveCustomHeader()
 187    */
 188   bool RemoveCustomHeader(const std::string& name);
 189
 190   /**
 191    * @copydoc Dali::WebEngine::StartInspectorServer()
 192    */
 193   uint32_t StartInspectorServer(uint32_t port);
 194
 195   /**
 196    * @copydoc Dali::WebEngine::StopInspectorServer()
 197    */
 198   bool StopInspectorServer();
 199
 200   /**
 201    * @copydoc Dali::WebEngine::ScrollBy()
 202    */
 203   void ScrollBy(int32_t deltaX, int32_t deltaY);
 204
 205   /**
 206    * @copydoc Dali::WebEngine::ScrollEdgeBy()
 207    */
 208   bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY);
 209
 210   /**
 211    * @copydoc Dali::WebEngine::SetScrollPosition()
 212    */
 213   void SetScrollPosition(int32_t x, int32_t y);
 214
 215   /**
 216    * @copydoc Dali::WebEngine::GetScrollPosition()
 217    */
 218   Dali::Vector2 GetScrollPosition() const;
 219
 220   /**
 221    * @copydoc Dali::WebEngine::GetScrollSize()
 222    */
 223   Dali::Vector2 GetScrollSize() const;
 224
 225   /**
 226    * @copydoc Dali::WebEngine::GetContentSize()
 227    */
 228   Dali::Vector2 GetContentSize() const;
 229
 230   /**
 231    * @copydoc Dali::WebEngine::RegisterJavaScriptAlertCallback()
 232    */
 233   void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
 234
 235   /**
 236    * @copydoc Dali::WebEngine::JavaScriptAlertReply()
 237    */
 238   void JavaScriptAlertReply();
 239
 240   /**
 241    * @copydoc Dali::WebEngine::RegisterJavaScriptConfirmCallback()
 242    */
 243   void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
 244
 245   /**
 246    * @copydoc Dali::WebEngine::JavaScriptConfirmReply()
 247    */
 248   void JavaScriptConfirmReply(bool confirmed);
 249
 250   /**
 251    * @copydoc Dali::WebEngine::RegisterJavaScriptPromptCallback()
 252    */
 253   void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
 254
 255   /**
 256    * @copydoc Dali::WebEngine::JavaScriptPromptReply()
 257    */
 258   void JavaScriptPromptReply(const std::string& result);
 259
 260   /**
 261    * @copydoc Dali::WebEngine::CreateHitTest()
 262    */
 263   std::unique_ptr<Dali::WebEngineHitTest> CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode);
 264
 265   /**
 266    * @copydoc Dali::WebEngine::CreateHitTestAsynchronously()
 267    */
 268   bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback);
 269
 270   /**
 271    * @copydoc Dali::WebEngine::CanGoForward()
 272    */
 273   bool CanGoForward();
 274
 275   /**
 276    * @copydoc Dali::WebEngine::GoForward()
 277    */
 278   void GoForward();
 279
 280   /**
 281    * @copydoc Dali::WebEngine::CanGoBack()
 282    */
 283   bool CanGoBack();
 284
 285   /**
 286    * @copydoc Dali::WebEngine::GoBack()
 287    */
 288   void GoBack();
 289
 290   /**
 291    * @copydoc Dali::WebEngine::EvaluateJavaScript()
 292    */
 293   void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler);
 294
 295   /**
 296    * @copydoc Dali::WebEngine::AddJavaScriptMessageHandler()
 297    */
 298   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler);
 299
 300   /**
 301    * @copydoc Dali::WebEngine::ClearAllTilesResources()
 302    */
 303   void ClearAllTilesResources();
 304
 305   /**
 306    * @copydoc Dali::WebEngine::ClearHistory()
 307    */
 308   void ClearHistory();
 309
 310   /**
 311    * @copydoc Dali::WebEngine::SetSize()
 312    */
 313   void SetSize(uint32_t width, uint32_t height);
 314
 315   /**
 316    * @copydoc Dali::WebEngine::EnableMouseEvents()
 317    */
 318   void EnableMouseEvents(bool enabled);
 319
 320   /**
 321    * @copydoc Dali::WebEngine::EnableKeyEvents()
 322    */
 323   void EnableKeyEvents(bool enabled);
 324
 325   /**
 326    * @copydoc Dali::WebEngine::SetDocumentBackgroundColor()
 327    */
 328   void SetDocumentBackgroundColor(Dali::Vector4 color);
 329
 330   /**
 331    * @copydoc Dali::WebEngine::ClearTilesWhenHidden()
 332    */
 333   void ClearTilesWhenHidden(bool cleared);
 334
 335   /**
 336    * @copydoc Dali::WebEngine::SetTileCoverAreaMultiplier()
 337    */
 338   void SetTileCoverAreaMultiplier(float multiplier);
 339
 340   /**
 341    * @copydoc Dali::WebEngine::EnableCursorByClient()
 342    */
 343   void EnableCursorByClient(bool enabled);
 344
 345   /**
 346    * @copydoc Dali::WebEngine::GetSelectedText()
 347    */
 348   std::string GetSelectedText() const;
 349
 350   /**
 351    * @copydoc Dali::WebEngine::SendTouchEvent()
 352    */
 353   bool SendTouchEvent(const Dali::TouchEvent& touch);
 354
 355   /**
 356    * @copydoc Dali::WebEngine::SendKeyEvent()
 357    */
 358   bool SendKeyEvent(const Dali::KeyEvent& event);
 359
 360   /**
 361    * @copydoc Dali::WebEngine::SetFocus()
 362    */
 363   void SetFocus(bool focused);
 364
 365   /**
 366    * @copydoc Dali::WebEngine::SetPageZoomFactor()
 367    */
 368   void SetPageZoomFactor(float zoomFactor);
 369
 370   /**
 371    * @copydoc Dali::WebEngine::GetPageZoomFactor()
 372    */
 373   float GetPageZoomFactor() const;
 374
 375   /**
 376    * @copydoc Dali::WebEngine::SetTextZoomFactor()
 377    */
 378   void SetTextZoomFactor(float zoomFactor);
 379
 380   /**
 381    * @copydoc Dali::WebEngine::GetTextZoomFactor()
 382    */
 383   float GetTextZoomFactor() const;
 384
 385   /**
 386    * @copydoc Dali::WebEngine::GetLoadProgressPercentage()
 387    */
 388   float GetLoadProgressPercentage() const;
 389
 390   /**
 391    * @copydoc Dali::WebEngine::SetScaleFactor()
 392    */
 393   void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
 394
 395   /**
 396    * @copydoc Dali::WebEngine::GetScaleFactor()
 397    */
 398   float GetScaleFactor() const;
 399
 400   /**
 401    * @copydoc Dali::WebEngine::ActivateAccessibility()
 402    */
 403   void ActivateAccessibility(bool activated);
 404
 405   /**
 406    * @copydoc Dali::WebEngine::GetAccessibilityAddress()
 407    */
 408   Accessibility::Address GetAccessibilityAddress();
 409
 410   /**
 411    * @copydoc Dali::WebEngine::SetVisibility()
 412    */
 413   bool SetVisibility(bool visible);
 414
 415   /**
 416    * @copydoc Dali::WebEngine::HighlightText()
 417    */
 418   bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
 419
 420   /**
 421    * @copydoc Dali::WebEngine::AddDynamicCertificatePath()
 422    */
 423   void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
 424
 425   /**
 426    * @copydoc Dali::WebEngine::GetScreenshot()
 427    */
 428   Dali::PixelData GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor);
 429
 430   /**
 431    * @copydoc Dali::WebEngine::GetScreenshotAsync()
 432    */
 433   bool GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback);
 434
 435   /**
 436    * @copydoc Dali::WebEngine::IsVideoPlaying()
 437    */
 438   bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
 439
 440   /**
 441    * @copydoc Dali::WebEngine::RegisterGeolocationPermissionCallback()
 442    */
 443   void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
 444
 445   /**
 446    * @copydoc Dali::WebEngine::UpdateDisplayArea()
 447    */
 448   void UpdateDisplayArea(Dali::Rect<int32_t> displayArea);
 449
 450   /**
 451    * @copydoc Dali::WebEngine::EnableVideoHole()
 452    */
 453   void EnableVideoHole(bool enabled);
 454
 455   /**
 456    * @copydoc Dali::WebEngine::SendHoverEvent()
 457    */
 458   bool SendHoverEvent(const Dali::HoverEvent& event);
 459
 460   /**
 461    * @copydoc Dali::WebEngine::SendWheelEvent()
 462    */
 463   bool SendWheelEvent(const Dali::WheelEvent& event);
 464
 465   /**
 466    * @copydoc Dali::WebEngine::FrameRenderedSignal()
 467    */
 468   Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& FrameRenderedSignal();
 469
 470   /**
 471    * @copydoc Dali::WebEngine::RegisterPageLoadStartedCallback()
 472    */
 473   void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 474
 475   /**
 476    * @copydoc Dali::WebEngine::RegisterPageLoadInProgressCallback()
 477    */
 478   void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 479
 480   /**
 481    * @copydoc Dali::WebEngine::RegisterPageLoadFinishedCallback()
 482    */
 483   void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 484
 485   /**
 486    * @copydoc Dali::WebEngine::RegisterPageLoadErrorCallback()
 487    */
 488   void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
 489
 490   /**
 491    * @copydoc Dali::WebEngine::RegisterScrollEdgeReachedCallback()
 492    */
 493   void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
 494
 495   /**
 496    * @copydoc Dali::WebEngine::RegisterUrlChangedCallback()
 497    */
 498   void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback);
 499
 500   /**
 501    * @copydoc Dali::WebEngine::RegisterFormRepostDecidedCallback()
 502    */
 503   void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback);
 504
 505   /**
 506    @copydoc Dali::WebEngine::RegisterConsoleMessageReceivedCallback()
 507    */
 508   void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback);
 509
 510   /**
 511    @copydoc Dali::WebEngine::RegisterResponsePolicyDecidedCallback()
 512    */
 513   void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback);
 514
 515   /**
 516    @copydoc Dali::WebEngine::RegisterNavigationPolicyDecidedCallback()
 517    */
 518   void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback);
 519
 520   /**
 521    * @copydoc Dali::WebEngine::RegisterCertificateConfirmedCallback()
 522    */
 523   void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
 524
 525   /**
 526    * @copydoc Dali::WebEngine::RegisterSslCertificateChangedCallback()
 527    */
 528   void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
 529
 530   /**
 531    * @copydoc Dali::WebEngine::RegisterHttpAuthHandlerCallback()
 532    */
 533   void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback);
 534
 535   /**
 536    * @copydoc Dali::WebEngine::RegisterContextMenuShownCallback()
 537    */
 538   void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback);
 539
 540   /**
 541    * @copydoc Dali::WebEngine::RegisterContextMenuHiddenCallback()
 542    */
 543   void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback);
 544
 545   /**
 546    * @copydoc Dali::WebEngine::GetPlainTextAsynchronously()
 547    */
 548   void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
 549
 550 private:
 551   /**
 552    * @brief Constructor.
 553    */
 554   WebEngine();
 555
 556   /**
 557    * @brief Destructor.
 558    */
 559   virtual ~WebEngine();
 560
 561   // Undefined copy constructor
 562   WebEngine(const WebEngine& WebEngine);
 563
 564   // Undefined assignment operator
 565   WebEngine& operator=(const WebEngine& WebEngine);
 566
 567   /**
 568    * @brief Initialize member data.
 569    *
 570    * @return Whether the initialization succeed or not.
 571    */
 572   bool Initialize();
 573
 574   /**
 575    * @brief Initialize library handle by loading web engine plugin.
 576    *
 577    * @return Whether the initialization succeed or not.
 578    */
 579   static bool InitializePluginHandle();
 580
 581   /**
 582    * @brief Close library handle.
 583    */
 584   static void ClosePluginHandle();
 585
 586 private:
 587   using CreateWebEngineFunction  = Dali::WebEnginePlugin* (*)();
 588   using DestroyWebEngineFunction = void (*)(Dali::WebEnginePlugin* plugin);
 589
 590   Dali::WebEnginePlugin* mPlugin; ///< WebEnginePlugin instance
 591
 592   static void*                    mHandle;              ///< Handle for the loaded library
 593   static CreateWebEngineFunction  mCreateWebEnginePtr;  ///< Function to create plugin instance
 594   static DestroyWebEngineFunction mDestroyWebEnginePtr; ///< Function to destroy plugin instance
 595 };
 596
 597 } // namespace Adaptor
 598 } // namespace Internal
 599
 600 inline static Internal::Adaptor::WebEngine& GetImplementation(Dali::WebEngine& webEngine)
 601 {
 602   DALI_ASSERT_ALWAYS(webEngine && "WebEngine handle is empty.");
 603
 604   BaseObject& handle = webEngine.GetBaseObject();
 605
 606   return static_cast<Internal::Adaptor::WebEngine&>(handle);
 607 }
 608
 609 inline static const Internal::Adaptor::WebEngine& GetImplementation(const Dali::WebEngine& webEngine)
 610 {
 611   DALI_ASSERT_ALWAYS(webEngine && "WebEngine handle is empty.");
 612
 613   const BaseObject& handle = webEngine.GetBaseObject();
 614
 615   return static_cast<const Internal::Adaptor::WebEngine&>(handle);
 616 }
 617
 618 } // namespace Dali
 619
 620 #endif