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.
22 #include <dali/devel-api/common/bitwise-enum.h>
23 #include <dali/public-api/images/native-image-interface.h>
24 #include <dali/public-api/math/rect.h>
25 #include <dali/public-api/signals/dali-signal.h>
34 class WebEngineBackForwardList;
35 class WebEngineCertificate;
36 class WebEngineConsoleMessage;
37 class WebEngineContext;
38 class WebEngineCookieManager;
39 class WebEngineFormRepostDecision;
40 class WebEngineHttpAuthHandler;
41 class WebEngineLoadError;
42 class WebEnginePolicyDecision;
43 class WebEngineRequestInterceptor;
44 class WebEngineSettings;
49 * @brief WebEnginePlugin is an abstract interface, used by dali-adaptor to access WebEngine plugin.
50 * A concrete implementation must be created for each platform and provided as dynamic library.
56 * @brief WebEngine signal type related with page loading.
58 using WebEnginePageLoadSignalType = Signal<void(const std::string&)>;
61 * @brief WebView signal type related with page loading error.
63 using WebEnginePageLoadErrorSignalType = Signal<void(std::shared_ptr<Dali::WebEngineLoadError>)>;
65 // forward declaration.
66 enum class ScrollEdge;
69 * @brief WebView signal type related with scroll edge reached.
71 using WebEngineScrollEdgeReachedSignalType = Signal<void(const ScrollEdge)>;
74 * @brief WebView signal type related with page url changed.
76 using WebEngineUrlChangedSignalType = Signal<void(const std::string&)>;
79 * @brief WebView signal type related with screen captured.
81 using ScreenshotCapturedCallback = std::function<void(Dali::PixelData)>;
84 * @brief WebView signal type related with geolocation permission.
85 * Host and protocol of security origin will be provided when requesting
86 * geolocation permission.
87 * It returns true if a pop-up is created successfully, false otherwise.
89 using GeolocationPermissionCallback = std::function<bool(const std::string&, const std::string&)>;
92 * @brief WebView signal type related with video playing.
94 using VideoPlayingCallback = std::function<void(bool)>;
97 * @brief WebView signal type related with http request interceptor.
99 using WebEngineRequestInterceptorSignalType = Signal<void(std::shared_ptr<Dali::WebEngineRequestInterceptor>)>;
102 * @brief WebView signal type related with console message will be logged.
104 using WebEngineConsoleMessageSignalType = Signal<void(std::shared_ptr<Dali::WebEngineConsoleMessage>)>;
107 * @brief WebView signal type related with certificate changed.
109 using WebEngineCertificateSignalType = Signal<void(std::shared_ptr<Dali::WebEngineCertificate>)>;
112 * @brief WebView signal type related with http authentication.
114 using WebEngineHttpAuthHandlerSignalType = Signal<void(std::shared_ptr<Dali::WebEngineHttpAuthHandler>)>;
117 * @brief Alert callback when JavaScript alert is called with a message.
118 * It returns true if a pop-up is created successfully, false otherwise.
120 using JavaScriptAlertCallback = std::function<bool(const std::string&)>;
123 * @brief Confirm callback when JavaScript confirm is called with a message.
124 * It returns true if a pop-up is created successfully, false otherwise.
126 using JavaScriptConfirmCallback = std::function<bool(const std::string&)>;
129 * @brief Prompt callback when JavaScript prompt is called with a message
130 * and an optional value that is the default value for the input field.
131 * It returns true if a pop-up is created successfully, false otherwise.
133 using JavaScriptPromptCallback = std::function<bool(const std::string&, const std::string&)>;
136 * @brief WebView signal type related with form repost decision.
138 using WebEngineFormRepostDecisionSignalType = Signal<void(std::shared_ptr<Dali::WebEngineFormRepostDecision>)>;
141 * @brief WebView signal type related with frame rendered.
143 using WebEngineFrameRenderedSignalType = Signal<void(void)>;
146 * @brief WebView signal type related with policy would be decided.
148 using WebEnginePolicyDecisionSignalType = Signal<void(std::shared_ptr<Dali::WebEnginePolicyDecision>)>;
151 * @brief Enumeration for the scroll edge.
153 enum class ScrollEdge
155 LEFT, ///< Left edge reached.
156 RIGHT, ///< Right edge reached.
157 TOP, ///< Top edge reached.
158 BOTTOM, ///< Bottom edge reached.
162 * @brief Enumeration that provides the option to find text.
164 enum class FindOption
166 NONE = 0, ///< No search flags, this means a case sensitive, no wrap, forward only search
167 CASE_INSENSITIVE = 1 << 0, ///< Case insensitive search
168 AT_WORD_STARTS = 1 << 1, ///< Search text only at the beginning of the words
169 TREAT_MEDIAL_CAPITAL_AS_WORD_START = 1 << 2, ///< Treat capital letters in the middle of words as word start
170 BACKWARDS = 1 << 3, ///< Search backwards
171 WRAP_AROUND = 1 << 4, ///< If not present the search stops at the end of the document
172 SHOW_OVERLAY = 1 << 5, ///< Show overlay
173 SHOW_FIND_INDICATOR = 1 << 6, ///< Show indicator
174 SHOW_HIGHLIGHT = 1 << 7, ///< Show highlight
178 * @brief Constructor.
180 WebEnginePlugin() = default;
185 virtual ~WebEnginePlugin() = default;
188 * @brief Create WebEngine instance.
190 * @param [in] width The width of Web
191 * @param [in] height The height of Web
192 * @param [in] locale The locale of Web
193 * @param [in] timezoneId The timezoneID of Web
195 virtual void Create(int width, int height, const std::string& locale, const std::string& timezoneId) = 0;
198 * @brief Create WebEngine instance.
200 * @param [in] width The width of Web
201 * @param [in] height The height of Web
202 * @param [in] argc The count of application arguments
203 * @param [in] argv The string array of application arguments
205 virtual void Create(int width, int height, int argc, char** argv) = 0;
208 * @brief Destroy WebEngine instance.
210 virtual void Destroy() = 0;
213 * @brief Get settings of WebEngine.
215 virtual WebEngineSettings& GetSettings() const = 0;
218 * @brief Get context of WebEngine.
220 virtual WebEngineContext& GetContext() const = 0;
223 * @brief Get cookie manager of WebEngine.
225 virtual WebEngineCookieManager& GetCookieManager() const = 0;
228 * @brief Get back-forward list of WebEngine.
230 virtual WebEngineBackForwardList& GetBackForwardList() const = 0;
233 * @brief Load a web page based on a given URL.
235 * @param [in] url The URL of the resource to load
237 virtual void LoadUrl(const std::string& url) = 0;
240 * @brief Return the title of the Web.
242 * @return The title of web page
244 virtual std::string GetTitle() const = 0;
247 * @brief Return the Favicon of the Web.
249 * @return Favicon of Dali::PixelData& type
251 virtual Dali::PixelData GetFavicon() const = 0;
254 * @brief Get image to render.
256 virtual NativeImageInterfacePtr GetNativeImageSource() = 0;
259 * @brief Returns the URL of the Web.
261 * @return Url of string type
263 virtual const std::string& GetUrl() = 0;
266 * @brief Load a given string as web contents.
268 * @param [in] htmlString The string to use as the contents of the web page
270 virtual void LoadHtmlString(const std::string& htmlString) = 0;
273 * @brief Load the specified html string as the content of the view overriding current history entry
275 * @param[in] html HTML data to load
276 * @param[in] basicUri Base URL used for relative paths to external objects
277 * @param[in] unreachableUrl URL that could not be reached
279 * @return true if successfully loaded, false otherwise
281 virtual bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl) = 0;
284 * @brief Request loading the given contents by MIME type into the view object
286 * @param[in] contents The content to load
287 * @param[in] contentSize The size of contents (in bytes)
288 * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
289 * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
290 * @param[in] baseUri The base URI to use for relative resources
292 * @return true if successfully request, false otherwise
294 virtual bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri) = 0;
297 * @brief Reload the Web.
299 virtual void Reload() = 0;
302 * @brief Reload the current page's document without cache
304 virtual bool ReloadWithoutCache() = 0;
307 * @brief Stop loading web contents on the current page.
309 virtual void StopLoading() = 0;
312 * @brief Suspend the operation associated with the view.
314 virtual void Suspend() = 0;
317 * @brief Resume the operation associated with the view object after calling Suspend().
319 virtual void Resume() = 0;
322 * @brief To suspend all url loading
324 virtual void SuspendNetworkLoading() = 0;
327 * @brief To resume new url network loading
329 virtual void ResumeNetworkLoading() = 0;
332 * @brief Add custom header
334 * @param[in] name custom header name to add the custom header
335 * @param[in] value custom header value to add the custom header
337 * @return true if succeeded, false otherwise
339 virtual bool AddCustomHeader(const std::string& name, const std::string& value) = 0;
342 * @brief Remove custom header
344 * @param[in] name custom header name to remove the custom header
346 * @return true if succeeded, false otherwise
348 virtual bool RemoveCustomHeader(const std::string& name) = 0;
351 * @brief Start the inspector server
353 * @param[in] port port number
355 * @return the port number
357 virtual uint32_t StartInspectorServer(uint32_t port) = 0;
360 * @brief Stop the inspector server
362 * @return true if succeeded, false otherwise
364 virtual bool StopInspectorServer() = 0;
367 * @brief Scroll web page of view by deltaX and deltaY.
369 * @param[in] deltaX horizontal offset to scroll
370 * @param[in] deltaY vertical offset to scroll
372 virtual void ScrollBy(int deltaX, int deltaY) = 0;
375 * @brief Scroll edge of view by deltaX and deltaY.
377 * @param[in] deltaX horizontal offset to scroll
378 * @param[in] deltaY vertical offset to scroll
380 * @return true if succeeded, false otherwise
382 virtual bool ScrollEdgeBy(int deltaX, int deltaY) = 0;
385 * @brief Scroll to the specified position of the given view.
387 virtual void SetScrollPosition(int x, int y) = 0;
390 * @brief Get the current scroll position of the given view.
392 virtual Dali::Vector2 GetScrollPosition() const = 0;
395 * @brief Get the possible scroll size of the given view.
397 virtual Dali::Vector2 GetScrollSize() const = 0;
400 * @brief Get the last known content's size.
402 virtual Dali::Vector2 GetContentSize() const = 0;
405 * @brief Return whether forward is possible.
407 * @return True if forward is possible, false otherwise
409 virtual bool CanGoForward() = 0;
412 * @brief Go to forward.
414 virtual void GoForward() = 0;
417 * @brief Return whether backward is possible.
419 * @return True if backward is possible, false otherwise
421 virtual bool CanGoBack() = 0;
426 virtual void GoBack() = 0;
429 * @brief Evaluates JavaScript code represented as a string.
431 * @param[in] script The JavaScript code
432 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
434 virtual void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler) = 0;
437 * @brief Add a message handler into JavaScript.
439 * @param[in] exposedObjectName The name of exposed object
440 * @param[in] handler The callback function
442 virtual void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler) = 0;
445 * @brief Register a callback for JavaScript alert.
447 * @param[in] callback The callback function
449 virtual void RegisterJavaScriptAlertCallback(JavaScriptAlertCallback callback) = 0;
452 * @brief Reply for JavaScript alert.
454 virtual void JavaScriptAlertReply() = 0;
457 * @brief Register a callback for JavaScript confirm.
459 * @param[in] callback The callback function
461 virtual void RegisterJavaScriptConfirmCallback(JavaScriptConfirmCallback callback) = 0;
464 * @brief Reply for JavaScript confirm.
466 virtual void JavaScriptConfirmReply(bool confirmed) = 0;
469 * @brief Register a callback for JavaScript prompt.
471 * @param[in] callback The callback function
473 virtual void RegisterJavaScriptPromptCallback(JavaScriptPromptCallback callback) = 0;
476 * @brief Reply for JavaScript prompt.
478 virtual void JavaScriptPromptReply(const std::string& result) = 0;
481 * @brief Clear the history of Web.
483 virtual void ClearHistory() = 0;
486 * @brief Clear all tiles resources of Web.
488 virtual void ClearAllTilesResources() = 0;
491 * @brief Get user agent string.
493 * @return The string value of user agent
495 virtual const std::string& GetUserAgent() const = 0;
498 * @brief Set user agent string.
500 * @param[in] userAgent The string value of user agent
502 virtual void SetUserAgent(const std::string& userAgent) = 0;
505 * @brief Sets size of Web Page.
507 virtual void SetSize(int width, int height) = 0;
510 * @brief Set background color of web page.
512 * @param[in] color Background color
514 virtual void SetDocumentBackgroundColor(Dali::Vector4 color) = 0;
517 * @brief Clear tiles when hidden.
519 * @param[in] cleared Whether tiles are cleared or not
521 virtual void ClearTilesWhenHidden(bool cleared) = 0;
524 * @brief Set multiplier of cover area of tile.
526 * @param[in] multiplier The multiplier of cover area
528 virtual void SetTileCoverAreaMultiplier(float multiplier) = 0;
531 * @brief Enable cursor by client.
533 * @param[in] enabled Whether cursor is enabled or not
535 virtual void EnableCursorByClient(bool enabled) = 0;
538 * @brief Get the selected text.
540 * @return the selected text
542 virtual std::string GetSelectedText() const = 0;
545 * @brief Send Touch Events.
547 virtual bool SendTouchEvent(const TouchEvent& touch) = 0;
550 * @brief Send Key Events.
552 virtual bool SendKeyEvent(const KeyEvent& event) = 0;
555 * @brief Support mouse events or not.
556 * @param[in] enabled True if enabled, false othewise.
558 virtual void EnableMouseEvents(bool enabled) = 0;
561 * @brief Support key events or not.
562 * @param[in] enabled True if enabled, false othewise.
564 virtual void EnableKeyEvents(bool enabled) = 0;
568 * @param[in] focused True if focus is gained, false lost.
570 virtual void SetFocus(bool focused) = 0;
573 * @brief Set zoom factor of the current page.
574 * @param[in] zoomFactor a new factor to be set.
576 virtual void SetPageZoomFactor(float zoomFactor) = 0;
579 * @brief Query the current zoom factor of the page。
580 * @return The current page zoom factor.
582 virtual float GetPageZoomFactor() const = 0;
585 * @brief Set the current text zoom level。.
586 * @param[in] zoomFactor a new factor to be set.
588 virtual void SetTextZoomFactor(float zoomFactor) = 0;
591 * @brief Get the current text zoom level.
592 * @return The current text zoom factor.
594 virtual float GetTextZoomFactor() const = 0;
597 * @brief Get the current load progress of the page.
598 * @return The load progress of the page.
600 virtual float GetLoadProgressPercentage() const = 0;
603 * @brief Scale the current page, centered at the given point.
604 * @param[in] scaleFactor a new factor to be scaled.
605 * @param[in] point a center coordinate.
607 virtual void SetScaleFactor(float scaleFactor, Dali::Vector2 point) = 0;
610 * @brief Get the current scale factor of the page.
611 * @return The current scale factor.
613 virtual float GetScaleFactor() const = 0;
616 * @brief Request to activate/deactivate the accessibility usage set by web app.
617 * @param[in] activated Activate accessibility or not.
619 virtual void ActivateAccessibility(bool activated) = 0;
622 * @brief Request to set the current page's visibility.
623 * @param[in] visible Visible or not.
625 * @return true if succeeded, false otherwise
627 virtual bool SetVisibility(bool visible) = 0;
630 * @brief Search and highlight the given string in the document.
631 * @param[in] text The text to find
632 * @param[in] options The options to find
633 * @param[in] maxMatchCount The maximum match count to find
635 * @return true if found & highlighted, false otherwise
637 virtual bool HighlightText(const std::string& text, FindOption options, uint32_t maxMatchCount) = 0;
640 * @brief Add dynamic certificate path.
641 * @param[in] host host that required client authentication
642 * @param[in] certPath the file path stored certificate
644 virtual void AddDynamicCertificatePath(const std::string& host, const std::string& certPath) = 0;
647 * @brief Get snapshot of the specified viewArea of page.
649 * @param[in] viewArea The rectangle of screen shot
650 * @param[in] scaleFactor The scale factor
652 * @return pixel data of screen shot
654 virtual Dali::PixelData GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor) = 0;
657 * @brief Request to get snapshot of the specified viewArea of page asynchronously.
659 * @param[in] viewArea The rectangle of screen shot
660 * @param[in] scaleFactor The scale factor
661 * @param[in] callback The callback for screen shot
663 * @return true if requested successfully, false otherwise
665 virtual bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, ScreenshotCapturedCallback callback) = 0;
668 * @brief Asynchronously request to check if there is a video playing in the given view.
670 * @param[in] callback The callback called after checking if video is playing or not
672 * @return true if requested successfully, false otherwise
674 virtual bool CheckVideoPlayingAsynchronously(VideoPlayingCallback callback) = 0;
677 * @brief Set callback which will be called upon geolocation permission request.
679 * @param[in] callback The callback for requesting geolocation permission
681 virtual void RegisterGeolocationPermissionCallback(GeolocationPermissionCallback callback) = 0;
684 * @brief Update display area.
685 * @param[in] displayArea The display area need be updated.
687 virtual void UpdateDisplayArea(Dali::Rect<int> displayArea) = 0;
690 * @brief Enable video hole.
691 * @param[in] enabled True if enabled, false othewise.
693 virtual void EnableVideoHole(bool enabled) = 0;
696 * @brief Send Hover Events.
697 * @param[in] event The hover event would be sent.
699 virtual bool SendHoverEvent(const HoverEvent& event) = 0;
702 * @brief Send Wheel Events.
703 * @param[in] event The wheel event would be sent.
705 virtual bool SendWheelEvent(const WheelEvent& event) = 0;
708 * @brief Connect to this signal to be notified when page loading is started.
710 * @return A signal object to connect with.
712 virtual WebEnginePageLoadSignalType& PageLoadStartedSignal() = 0;
715 * @brief Connect to this signal to be notified when page loading is in progress.
717 * @return A signal object to connect with.
719 virtual WebEnginePageLoadSignalType& PageLoadInProgressSignal() = 0;
722 * @brief Connect to this signal to be notified when page loading is finished.
724 * @return A signal object to connect with.
726 virtual WebEnginePageLoadSignalType& PageLoadFinishedSignal() = 0;
729 * @brief Connect to this signal to be notified when an error occurs in page loading.
731 * @return A signal object to connect with.
733 virtual WebEnginePageLoadErrorSignalType& PageLoadErrorSignal() = 0;
736 * @brief Connect to this signal to be notified when scroll edge is reached.
738 * @return A signal object to connect with.
740 virtual WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal() = 0;
743 * @brief Connect to this signal to be notified when url is changed.
745 * @return A signal object to connect with.
747 virtual WebEngineUrlChangedSignalType& UrlChangedSignal() = 0;
750 * @brief Connect to this signal to be notified when form repost decision is requested.
752 * @return A signal object to connect with.
754 virtual WebEngineFormRepostDecisionSignalType& FormRepostDecisionSignal() = 0;
757 * @brief Connect to this signal to be notified when frame is rendered.
759 * @return A signal object to connect with.
761 virtual WebEngineFrameRenderedSignalType& FrameRenderedSignal() = 0;
764 * @brief Connects to this signal to be notified when http request need be intercepted.
766 * @return A signal object to connect with.
768 virtual WebEngineRequestInterceptorSignalType& RequestInterceptorSignal() = 0;
771 * @brief Connect to this signal to be notified when console message will be logged.
773 * @return A signal object to connect with.
775 virtual WebEngineConsoleMessageSignalType& ConsoleMessageSignal() = 0;
778 * @brief Connects to this signal to be notified when new policy would be decided.
780 * @return A signal object to connect with.
782 virtual WebEnginePolicyDecisionSignalType& PolicyDecisionSignal() = 0;
785 * @brief Connects to this signal to be notified when certificate need be confirmed.
787 * @return A signal object to connect with.
789 virtual WebEngineCertificateSignalType& CertificateConfirmSignal() = 0;
792 * @brief Connects to this signal to be notified when ssl certificate is changed.
794 * @return A signal object to connect with.
796 virtual WebEngineCertificateSignalType& SslCertificateChangedSignal() = 0;
799 * @brief Connects to this signal to be notified when http authentication need be confirmed.
801 * @return A signal object to connect with.
803 virtual WebEngineHttpAuthHandlerSignalType& HttpAuthHandlerSignal() = 0;
806 // specialization has to be done in the same namespace
808 struct EnableBitMaskOperators<WebEnginePlugin::FindOption>
810 static const bool ENABLE = true;