1 #ifndef DALI_WEB_ENGINE_PLUGIN_H
2 #define DALI_WEB_ENGINE_PLUGIN_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
26 #include <dali/devel-api/adaptor-framework/web-engine-hit-test.h>
27 #include <dali/devel-api/common/bitwise-enum.h>
28 #include <dali/public-api/images/native-image-interface.h>
29 #include <dali/public-api/math/rect.h>
30 #include <dali/public-api/signals/dali-signal.h>
37 class WebEngineBackForwardList;
38 class WebEngineCertificate;
39 class WebEngineConsoleMessage;
40 class WebEngineContext;
41 class WebEngineContextMenu;
42 class WebEngineCookieManager;
43 class WebEngineFormRepostDecision;
44 class WebEngineHitTest;
45 class WebEngineHttpAuthHandler;
46 class WebEngineLoadError;
47 class WebEnginePolicyDecision;
48 class WebEngineRequestInterceptor;
49 class WebEngineSettings;
54 * @brief WebEnginePlugin is an abstract interface, used by dali-adaptor to access WebEngine plugin.
55 * A concrete implementation must be created for each platform and provided as dynamic library.
61 * @brief WebEngine signal type related with page loading.
63 using WebEnginePageLoadSignalType = Signal<void(const std::string&)>;
66 * @brief WebView signal type related with page loading error.
68 using WebEnginePageLoadErrorSignalType = Signal<void(std::shared_ptr<Dali::WebEngineLoadError>)>;
70 // forward declaration.
71 enum class ScrollEdge;
74 * @brief WebView signal type related with scroll edge reached.
76 using WebEngineScrollEdgeReachedSignalType = Signal<void(const ScrollEdge)>;
79 * @brief WebView signal type related with page url changed.
81 using WebEngineUrlChangedSignalType = Signal<void(const std::string&)>;
84 * @brief WebView signal type related with screen captured.
86 using ScreenshotCapturedCallback = std::function<void(Dali::PixelData)>;
89 * @brief WebView signal type related with geolocation permission.
90 * Host and protocol of security origin will be provided when requesting
91 * geolocation permission.
92 * It returns true if a pop-up is created successfully, false otherwise.
94 using GeolocationPermissionCallback = std::function<bool(const std::string&, const std::string&)>;
97 * @brief WebView signal type related with video playing.
99 using VideoPlayingCallback = std::function<void(bool)>;
102 * @brief WebView signal type related with http request interceptor.
104 using WebEngineRequestInterceptorSignalType = Signal<void(std::shared_ptr<Dali::WebEngineRequestInterceptor>)>;
107 * @brief WebView signal type related with console message logged.
109 using WebEngineConsoleMessageSignalType = Signal<void(std::shared_ptr<Dali::WebEngineConsoleMessage>)>;
112 * @brief WebView signal type related with certificate changed.
114 using WebEngineCertificateSignalType = Signal<void(std::shared_ptr<Dali::WebEngineCertificate>)>;
117 * @brief WebView signal type related with http authentication.
119 using WebEngineHttpAuthHandlerSignalType = Signal<void(std::shared_ptr<Dali::WebEngineHttpAuthHandler>)>;
122 * @brief WebView signal type related with context menu shown.
124 using WebEngineContextMenuShownSignalType = Signal<void(std::shared_ptr<Dali::WebEngineContextMenu>)>;
127 * @brief WebView signal type related with context menu hidden.
129 using WebEngineContextMenuHiddenSignalType = Signal<void(std::shared_ptr<Dali::WebEngineContextMenu>)>;
132 * @brief Alert callback when JavaScript alert is called with a message.
133 * It returns true if a pop-up is created successfully, false otherwise.
135 using JavaScriptAlertCallback = std::function<bool(const std::string&)>;
138 * @brief Confirm callback when JavaScript confirm is called with a message.
139 * It returns true if a pop-up is created successfully, false otherwise.
141 using JavaScriptConfirmCallback = std::function<bool(const std::string&)>;
144 * @brief Prompt callback when JavaScript prompt is called with a message
145 * and an optional value that is the default value for the input field.
146 * It returns true if a pop-up is created successfully, false otherwise.
148 using JavaScriptPromptCallback = std::function<bool(const std::string&, const std::string&)>;
151 * @brief WebView signal type related with form repost decision.
153 using WebEngineFormRepostDecisionSignalType = Signal<void(std::shared_ptr<Dali::WebEngineFormRepostDecision>)>;
156 * @brief WebView signal type related with frame rendered.
158 using WebEngineFrameRenderedSignalType = Signal<void(void)>;
161 * @brief WebView signal type related with response policy would be decided.
163 using WebEngineResponsePolicyDecisionSignalType = Signal<void(std::shared_ptr<Dali::WebEnginePolicyDecision>)>;
166 * @brief Hit test callback called after hit test is created asynchronously.
168 using WebEngineHitTestCreatedCallback = std::function<bool(std::unique_ptr<Dali::WebEngineHitTest>)>;
171 * @brief Enumeration for the scroll edge.
173 enum class ScrollEdge
175 LEFT, ///< Left edge reached.
176 RIGHT, ///< Right edge reached.
177 TOP, ///< Top edge reached.
178 BOTTOM, ///< Bottom edge reached.
182 * @brief Enumeration that provides the option to find text.
184 enum class FindOption
186 NONE = 0, ///< No search flags, this means a case sensitive, no wrap, forward only search
187 CASE_INSENSITIVE = 1 << 0, ///< Case insensitive search
188 AT_WORD_STARTS = 1 << 1, ///< Search text only at the beginning of the words
189 TREAT_MEDIAL_CAPITAL_AS_WORD_START = 1 << 2, ///< Treat capital letters in the middle of words as word start
190 BACKWARDS = 1 << 3, ///< Search backwards
191 WRAP_AROUND = 1 << 4, ///< If not present the search stops at the end of the document
192 SHOW_OVERLAY = 1 << 5, ///< Show overlay
193 SHOW_FIND_INDICATOR = 1 << 6, ///< Show indicator
194 SHOW_HIGHLIGHT = 1 << 7, ///< Show highlight
198 * @brief Constructor.
200 WebEnginePlugin() = default;
205 virtual ~WebEnginePlugin() = default;
208 * @brief Create WebEngine instance.
210 * @param [in] width The width of Web
211 * @param [in] height The height of Web
212 * @param [in] locale The locale of Web
213 * @param [in] timezoneId The timezoneID of Web
215 virtual void Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId) = 0;
218 * @brief Create WebEngine instance.
220 * @param [in] width The width of Web
221 * @param [in] height The height of Web
222 * @param [in] argc The count of application arguments
223 * @param [in] argv The string array of application arguments
225 virtual void Create(uint32_t width, uint32_t height, uint32_t argc, char** argv) = 0;
228 * @brief Destroy WebEngine instance.
230 virtual void Destroy() = 0;
233 * @brief Get settings of WebEngine.
235 virtual WebEngineSettings& GetSettings() const = 0;
238 * @brief Get context of WebEngine.
240 virtual WebEngineContext& GetContext() const = 0;
243 * @brief Get cookie manager of WebEngine.
245 virtual WebEngineCookieManager& GetCookieManager() const = 0;
248 * @brief Get back-forward list of WebEngine.
250 virtual WebEngineBackForwardList& GetBackForwardList() const = 0;
253 * @brief Load a web page based on a given URL.
255 * @param [in] url The URL of the resource to load
257 virtual void LoadUrl(const std::string& url) = 0;
260 * @brief Return the title of the Web.
262 * @return The title of web page
264 virtual std::string GetTitle() const = 0;
267 * @brief Return the Favicon of the Web.
269 * @return Favicon of Dali::PixelData& type
271 virtual Dali::PixelData GetFavicon() const = 0;
274 * @brief Get image to render.
276 virtual NativeImageInterfacePtr GetNativeImageSource() = 0;
279 * @brief Return the URL of the Web.
281 * @return Url of string type
283 virtual std::string GetUrl() const = 0;
286 * @brief Load a given string as web contents.
288 * @param [in] htmlString The string to use as the contents of the web page
290 virtual void LoadHtmlString(const std::string& htmlString) = 0;
293 * @brief Load the specified html string as the content of the view overriding current history entry
295 * @param[in] html HTML data to load
296 * @param[in] basicUri Base URL used for relative paths to external objects
297 * @param[in] unreachableUrl URL that could not be reached
299 * @return true if successfully loaded, false otherwise
301 virtual bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl) = 0;
304 * @brief Request loading the given contents by MIME type into the view object
306 * @param[in] contents The content to load
307 * @param[in] contentSize The size of contents (in bytes)
308 * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
309 * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
310 * @param[in] baseUri The base URI to use for relative resources
312 * @return true if successfully request, false otherwise
314 virtual bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri) = 0;
317 * @brief Reload the Web.
319 virtual void Reload() = 0;
322 * @brief Reload the current page's document without cache
324 virtual bool ReloadWithoutCache() = 0;
327 * @brief Stop loading web contents on the current page.
329 virtual void StopLoading() = 0;
332 * @brief Suspend the operation associated with the view.
334 virtual void Suspend() = 0;
337 * @brief Resume the operation associated with the view object after calling Suspend().
339 virtual void Resume() = 0;
342 * @brief To suspend all url loading
344 virtual void SuspendNetworkLoading() = 0;
347 * @brief To resume new url network loading
349 virtual void ResumeNetworkLoading() = 0;
352 * @brief Add custom header
354 * @param[in] name custom header name to add the custom header
355 * @param[in] value custom header value to add the custom header
357 * @return true if succeeded, false otherwise
359 virtual bool AddCustomHeader(const std::string& name, const std::string& value) = 0;
362 * @brief Remove custom header
364 * @param[in] name custom header name to remove the custom header
366 * @return true if succeeded, false otherwise
368 virtual bool RemoveCustomHeader(const std::string& name) = 0;
371 * @brief Start the inspector server
373 * @param[in] port port number
375 * @return the port number
377 virtual uint32_t StartInspectorServer(uint32_t port) = 0;
380 * @brief Stop the inspector server
382 * @return true if succeeded, false otherwise
384 virtual bool StopInspectorServer() = 0;
387 * @brief Scroll web page of view by deltaX and deltaY.
389 * @param[in] deltaX horizontal offset to scroll
390 * @param[in] deltaY vertical offset to scroll
392 virtual void ScrollBy(int32_t deltaX, int32_t deltaY) = 0;
395 * @brief Scroll edge of view by deltaX and deltaY.
397 * @param[in] deltaX horizontal offset to scroll
398 * @param[in] deltaY vertical offset to scroll
400 * @return true if succeeded, false otherwise
402 virtual bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY) = 0;
405 * @brief Scroll to the specified position of the given view.
407 virtual void SetScrollPosition(int32_t x, int32_t y) = 0;
410 * @brief Get the current scroll position of the given view.
412 virtual Dali::Vector2 GetScrollPosition() const = 0;
415 * @brief Get the possible scroll size of the given view.
417 virtual Dali::Vector2 GetScrollSize() const = 0;
420 * @brief Get the last known content's size.
422 virtual Dali::Vector2 GetContentSize() const = 0;
425 * @brief Return whether forward is possible.
427 * @return True if forward is possible, false otherwise
429 virtual bool CanGoForward() = 0;
432 * @brief Go to forward.
434 virtual void GoForward() = 0;
437 * @brief Return whether backward is possible.
439 * @return True if backward is possible, false otherwise
441 virtual bool CanGoBack() = 0;
446 virtual void GoBack() = 0;
449 * @brief Evaluate JavaScript code represented as a string.
451 * @param[in] script The JavaScript code
452 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
454 virtual void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler) = 0;
457 * @brief Add a message handler into JavaScript.
459 * @param[in] exposedObjectName The name of exposed object
460 * @param[in] handler The callback function
462 virtual void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler) = 0;
465 * @brief Register a callback for JavaScript alert.
467 * @param[in] callback The callback function
469 virtual void RegisterJavaScriptAlertCallback(JavaScriptAlertCallback callback) = 0;
472 * @brief Reply for JavaScript alert.
474 virtual void JavaScriptAlertReply() = 0;
477 * @brief Register a callback for JavaScript confirm.
479 * @param[in] callback The callback function
481 virtual void RegisterJavaScriptConfirmCallback(JavaScriptConfirmCallback callback) = 0;
484 * @brief Reply for JavaScript confirm.
486 virtual void JavaScriptConfirmReply(bool confirmed) = 0;
489 * @brief Register a callback for JavaScript prompt.
491 * @param[in] callback The callback function
493 virtual void RegisterJavaScriptPromptCallback(JavaScriptPromptCallback callback) = 0;
496 * @brief Reply for JavaScript prompt.
498 virtual void JavaScriptPromptReply(const std::string& result) = 0;
501 * @brief Create a new hit test.
503 * @param[in] x the horizontal position to query
504 * @param[in] y the vertical position to query
505 * @param[in] mode the mode of hit test
507 * @return a new hit test object.
509 virtual std::unique_ptr<Dali::WebEngineHitTest> CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode) = 0;
512 * @brief create a hit test asynchronously.
514 * @param[in] x the horizontal position to query
515 * @param[in] y the vertical position to query
516 * @param[in] mode the mode of hit test
517 * @param[in] callback The callback function
519 * @return true if succeeded, false otherwise
521 virtual bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, WebEngineHitTestCreatedCallback callback) = 0;
524 * @brief Clear the history of Web.
526 virtual void ClearHistory() = 0;
529 * @brief Clear all tiles resources of Web.
531 virtual void ClearAllTilesResources() = 0;
534 * @brief Get user agent string.
536 * @return The string value of user agent
538 virtual std::string GetUserAgent() const = 0;
541 * @brief Set user agent string.
543 * @param[in] userAgent The string value of user agent
545 virtual void SetUserAgent(const std::string& userAgent) = 0;
548 * @brief Set size of Web Page.
550 virtual void SetSize(uint32_t width, uint32_t height) = 0;
553 * @brief Set background color of web page.
555 * @param[in] color Background color
557 virtual void SetDocumentBackgroundColor(Dali::Vector4 color) = 0;
560 * @brief Clear tiles when hidden.
562 * @param[in] cleared Whether tiles are cleared or not
564 virtual void ClearTilesWhenHidden(bool cleared) = 0;
567 * @brief Set multiplier of cover area of tile.
569 * @param[in] multiplier The multiplier of cover area
571 virtual void SetTileCoverAreaMultiplier(float multiplier) = 0;
574 * @brief Enable cursor by client.
576 * @param[in] enabled Whether cursor is enabled or not
578 virtual void EnableCursorByClient(bool enabled) = 0;
581 * @brief Get the selected text.
583 * @return the selected text
585 virtual std::string GetSelectedText() const = 0;
588 * @brief Send Touch Events.
590 virtual bool SendTouchEvent(const TouchEvent& touch) = 0;
593 * @brief Send Key Events.
595 virtual bool SendKeyEvent(const KeyEvent& event) = 0;
598 * @brief Support mouse events or not.
599 * @param[in] enabled True if enabled, false othewise.
601 virtual void EnableMouseEvents(bool enabled) = 0;
604 * @brief Support key events or not.
605 * @param[in] enabled True if enabled, false othewise.
607 virtual void EnableKeyEvents(bool enabled) = 0;
611 * @param[in] focused True if focus is gained, false lost.
613 virtual void SetFocus(bool focused) = 0;
616 * @brief Set zoom factor of the current page.
617 * @param[in] zoomFactor a new factor to be set.
619 virtual void SetPageZoomFactor(float zoomFactor) = 0;
622 * @brief Query the current zoom factor of the page。
623 * @return The current page zoom factor.
625 virtual float GetPageZoomFactor() const = 0;
628 * @brief Set the current text zoom level。.
629 * @param[in] zoomFactor a new factor to be set.
631 virtual void SetTextZoomFactor(float zoomFactor) = 0;
634 * @brief Get the current text zoom level.
635 * @return The current text zoom factor.
637 virtual float GetTextZoomFactor() const = 0;
640 * @brief Get the current load progress of the page.
641 * @return The load progress of the page.
643 virtual float GetLoadProgressPercentage() const = 0;
646 * @brief Scale the current page, centered at the given point.
647 * @param[in] scaleFactor a new factor to be scaled.
648 * @param[in] point a center coordinate.
650 virtual void SetScaleFactor(float scaleFactor, Dali::Vector2 point) = 0;
653 * @brief Get the current scale factor of the page.
654 * @return The current scale factor.
656 virtual float GetScaleFactor() const = 0;
659 * @brief Request to activate/deactivate the accessibility usage set by web app.
660 * @param[in] activated Activate accessibility or not.
662 virtual void ActivateAccessibility(bool activated) = 0;
665 * @brief Request to set the current page's visibility.
666 * @param[in] visible Visible or not.
668 * @return true if succeeded, false otherwise
670 virtual bool SetVisibility(bool visible) = 0;
673 * @brief Search and highlight the given string in the document.
674 * @param[in] text The text to find
675 * @param[in] options The options to find
676 * @param[in] maxMatchCount The maximum match count to find
678 * @return true if found & highlighted, false otherwise
680 virtual bool HighlightText(const std::string& text, FindOption options, uint32_t maxMatchCount) = 0;
683 * @brief Add dynamic certificate path.
684 * @param[in] host host that required client authentication
685 * @param[in] certPath the file path stored certificate
687 virtual void AddDynamicCertificatePath(const std::string& host, const std::string& certPath) = 0;
690 * @brief Get snapshot of the specified viewArea of page.
692 * @param[in] viewArea The rectangle of screen shot
693 * @param[in] scaleFactor The scale factor
695 * @return pixel data of screen shot
697 virtual Dali::PixelData GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor) = 0;
700 * @brief Request to get snapshot of the specified viewArea of page asynchronously.
702 * @param[in] viewArea The rectangle of screen shot
703 * @param[in] scaleFactor The scale factor
704 * @param[in] callback The callback for screen shot
706 * @return true if requested successfully, false otherwise
708 virtual bool GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, ScreenshotCapturedCallback callback) = 0;
711 * @brief Asynchronously request to check if there is a video playing in the given view.
713 * @param[in] callback The callback called after checking if video is playing or not
715 * @return true if requested successfully, false otherwise
717 virtual bool CheckVideoPlayingAsynchronously(VideoPlayingCallback callback) = 0;
720 * @brief Set callback which will be called upon geolocation permission request.
722 * @param[in] callback The callback for requesting geolocation permission
724 virtual void RegisterGeolocationPermissionCallback(GeolocationPermissionCallback callback) = 0;
727 * @brief Update display area.
728 * @param[in] displayArea The display area need be updated.
730 virtual void UpdateDisplayArea(Dali::Rect<int32_t> displayArea) = 0;
733 * @brief Enable video hole.
734 * @param[in] enabled True if enabled, false othewise.
736 virtual void EnableVideoHole(bool enabled) = 0;
739 * @brief Send Hover Events.
740 * @param[in] event The hover event would be sent.
742 virtual bool SendHoverEvent(const HoverEvent& event) = 0;
745 * @brief Send Wheel Events.
746 * @param[in] event The wheel event would be sent.
748 virtual bool SendWheelEvent(const WheelEvent& event) = 0;
751 * @brief Connect to this signal to be notified when page loading is started.
753 * @return A signal object to connect with.
755 virtual WebEnginePageLoadSignalType& PageLoadStartedSignal() = 0;
758 * @brief Connect to this signal to be notified when page loading is in progress.
760 * @return A signal object to connect with.
762 virtual WebEnginePageLoadSignalType& PageLoadInProgressSignal() = 0;
765 * @brief Connect to this signal to be notified when page loading is finished.
767 * @return A signal object to connect with.
769 virtual WebEnginePageLoadSignalType& PageLoadFinishedSignal() = 0;
772 * @brief Connect to this signal to be notified when an error occurs in page loading.
774 * @return A signal object to connect with.
776 virtual WebEnginePageLoadErrorSignalType& PageLoadErrorSignal() = 0;
779 * @brief Connect to this signal to be notified when scroll edge is reached.
781 * @return A signal object to connect with.
783 virtual WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal() = 0;
786 * @brief Connect to this signal to be notified when url is changed.
788 * @return A signal object to connect with.
790 virtual WebEngineUrlChangedSignalType& UrlChangedSignal() = 0;
793 * @brief Connect to this signal to be notified when form repost decision is requested.
795 * @return A signal object to connect with.
797 virtual WebEngineFormRepostDecisionSignalType& FormRepostDecisionSignal() = 0;
800 * @brief Connect to this signal to be notified when frame is rendered.
802 * @return A signal object to connect with.
804 virtual WebEngineFrameRenderedSignalType& FrameRenderedSignal() = 0;
807 * @brief Connect to this signal to be notified when http request need be intercepted.
809 * @return A signal object to connect with.
811 virtual WebEngineRequestInterceptorSignalType& RequestInterceptorSignal() = 0;
814 * @brief Connect to this signal to be notified when console message will be logged.
816 * @return A signal object to connect with.
818 virtual WebEngineConsoleMessageSignalType& ConsoleMessageSignal() = 0;
821 * @brief Connect to this signal to be notified when response policy would be decided.
823 * @return A signal object to connect with.
825 virtual WebEngineResponsePolicyDecisionSignalType& ResponsePolicyDecisionSignal() = 0;
828 * @brief Connect to this signal to be notified when certificate need be confirmed.
830 * @return A signal object to connect with.
832 virtual WebEngineCertificateSignalType& CertificateConfirmSignal() = 0;
835 * @brief Connect to this signal to be notified when ssl certificate is changed.
837 * @return A signal object to connect with.
839 virtual WebEngineCertificateSignalType& SslCertificateChangedSignal() = 0;
842 * @brief Connect to this signal to be notified when http authentication need be confirmed.
844 * @return A signal object to connect with.
846 virtual WebEngineHttpAuthHandlerSignalType& HttpAuthHandlerSignal() = 0;
849 * @brief Connect to this signal to be notified when context menu would be shown.
851 * @return A signal object to connect with.
853 virtual WebEngineContextMenuShownSignalType& ContextMenuShownSignal() = 0;
856 * @brief Connect to this signal to be notified when context menu would be hidden.
858 * @return A signal object to connect with.
860 virtual WebEngineContextMenuHiddenSignalType& ContextMenuHiddenSignal() = 0;
863 // specialization has to be done in the same namespace
865 struct EnableBitMaskOperators<WebEnginePlugin::FindOption>
867 static const bool ENABLE = true;