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 WebEngineConsoleMessage;
36 class WebEngineContext;
37 class WebEngineCookieManager;
38 class WebEngineFormRepostDecision;
39 class WebEngineLoadError;
40 class WebEnginePolicyDecision;
41 class WebEngineRequestInterceptor;
42 class WebEngineSettings;
47 * @brief WebEnginePlugin is an abstract interface, used by dali-adaptor to access WebEngine plugin.
48 * A concrete implementation must be created for each platform and provided as dynamic library.
54 * @brief WebEngine signal type related with page loading.
56 using WebEnginePageLoadSignalType = Signal<void(const std::string&)>;
59 * @brief WebView signal type related with page loading error.
61 using WebEnginePageLoadErrorSignalType = Signal<void(std::shared_ptr<Dali::WebEngineLoadError>)>;
63 // forward declaration.
64 enum class ScrollEdge;
67 * @brief WebView signal type related with scroll edge reached.
69 using WebEngineScrollEdgeReachedSignalType = Signal<void(const ScrollEdge)>;
72 * @brief WebView signal type related with page url changed.
74 using WebEngineUrlChangedSignalType = Signal<void(const std::string&)>;
77 * @brief WebView signal type related with screen captured.
79 using ScreenshotCapturedCallback = std::function<void(Dali::PixelData)>;
82 * @brief WebView signal type related with geolocation permission.
83 * Host and protocol of security origin will be provided when requesting
84 * geolocation permission.
85 * It returns true if a pop-up is created successfully, false otherwise.
87 using GeolocationPermissionCallback = std::function<bool(const std::string&, const std::string&)>;
90 * @brief WebView signal type related with video playing.
92 using VideoPlayingCallback = std::function<void(bool)>;
95 * @brief WebView signal type related with http request interceptor.
97 using WebEngineRequestInterceptorSignalType = Signal<void(std::shared_ptr<Dali::WebEngineRequestInterceptor>)>;
100 * @brief WebView signal type related with console message will be logged.
102 using WebEngineConsoleMessageSignalType = Signal<void(std::shared_ptr<Dali::WebEngineConsoleMessage>)>;
105 * @brief Alert callback when JavaScript alert is called with a message.
106 * It returns true if a pop-up is created successfully, false otherwise.
108 using JavaScriptAlertCallback = std::function<bool(const std::string&)>;
111 * @brief Confirm callback when JavaScript confirm is called with a message.
112 * It returns true if a pop-up is created successfully, false otherwise.
114 using JavaScriptConfirmCallback = std::function<bool(const std::string&)>;
117 * @brief Prompt callback when JavaScript prompt is called with a message
118 * and an optional value that is the default value for the input field.
119 * It returns true if a pop-up is created successfully, false otherwise.
121 using JavaScriptPromptCallback = std::function<bool(const std::string&, const std::string&)>;
124 * @brief WebView signal type related with form repost decision.
126 using WebEngineFormRepostDecisionSignalType = Signal<void(std::shared_ptr<Dali::WebEngineFormRepostDecision>)>;
129 * @brief WebView signal type related with frame rendered.
131 using WebEngineFrameRenderedSignalType = Signal<void(void)>;
134 * @brief WebView signal type related with policy would be decided.
136 using WebEnginePolicyDecisionSignalType = Signal<void(std::shared_ptr<Dali::WebEnginePolicyDecision>)>;
139 * @brief Enumeration for the scroll edge.
141 enum class ScrollEdge
143 LEFT, ///< Left edge reached.
144 RIGHT, ///< Right edge reached.
145 TOP, ///< Top edge reached.
146 BOTTOM, ///< Bottom edge reached.
150 * @brief Enumeration that provides the option to find text.
152 enum class FindOption
154 NONE = 0, ///< No search flags, this means a case sensitive, no wrap, forward only search
155 CASE_INSENSITIVE = 1 << 0, ///< Case insensitive search
156 AT_WORD_STARTS = 1 << 1, ///< Search text only at the beginning of the words
157 TREAT_MEDIAL_CAPITAL_AS_WORD_START = 1 << 2, ///< Treat capital letters in the middle of words as word start
158 BACKWARDS = 1 << 3, ///< Search backwards
159 WRAP_AROUND = 1 << 4, ///< If not present the search stops at the end of the document
160 SHOW_OVERLAY = 1 << 5, ///< Show overlay
161 SHOW_FIND_INDICATOR = 1 << 6, ///< Show indicator
162 SHOW_HIGHLIGHT = 1 << 7, ///< Show highlight
166 * @brief Constructor.
168 WebEnginePlugin() = default;
173 virtual ~WebEnginePlugin() = default;
176 * @brief Create WebEngine instance.
178 * @param [in] width The width of Web
179 * @param [in] height The height of Web
180 * @param [in] locale The locale of Web
181 * @param [in] timezoneId The timezoneID of Web
183 virtual void Create(int width, int height, const std::string& locale, const std::string& timezoneId) = 0;
186 * @brief Create WebEngine instance.
188 * @param [in] width The width of Web
189 * @param [in] height The height of Web
190 * @param [in] argc The count of application arguments
191 * @param [in] argv The string array of application arguments
193 virtual void Create(int width, int height, int argc, char** argv) = 0;
196 * @brief Destroy WebEngine instance.
198 virtual void Destroy() = 0;
201 * @brief Get settings of WebEngine.
203 virtual WebEngineSettings& GetSettings() const = 0;
206 * @brief Get context of WebEngine.
208 virtual WebEngineContext& GetContext() const = 0;
211 * @brief Get cookie manager of WebEngine.
213 virtual WebEngineCookieManager& GetCookieManager() const = 0;
216 * @brief Get back-forward list of WebEngine.
218 virtual WebEngineBackForwardList& GetBackForwardList() const = 0;
221 * @brief Load a web page based on a given URL.
223 * @param [in] url The URL of the resource to load
225 virtual void LoadUrl(const std::string& url) = 0;
228 * @brief Return the title of the Web.
230 * @return The title of web page
232 virtual std::string GetTitle() const = 0;
235 * @brief Return the Favicon of the Web.
237 * @return Favicon of Dali::PixelData& type
239 virtual Dali::PixelData GetFavicon() const = 0;
242 * @brief Get image to render.
244 virtual NativeImageInterfacePtr GetNativeImageSource() = 0;
247 * @brief Returns the URL of the Web.
249 * @return Url of string type
251 virtual const std::string& GetUrl() = 0;
254 * @brief Load a given string as web contents.
256 * @param [in] htmlString The string to use as the contents of the web page
258 virtual void LoadHtmlString(const std::string& htmlString) = 0;
261 * @brief Load the specified html string as the content of the view overriding current history entry
263 * @param[in] html HTML data to load
264 * @param[in] basicUri Base URL used for relative paths to external objects
265 * @param[in] unreachableUrl URL that could not be reached
267 * @return true if successfully loaded, false otherwise
269 virtual bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl) = 0;
272 * @brief Request loading the given contents by MIME type into the view object
274 * @param[in] contents The content to load
275 * @param[in] contentSize The size of contents (in bytes)
276 * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
277 * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
278 * @param[in] baseUri The base URI to use for relative resources
280 * @return true if successfully request, false otherwise
282 virtual bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri) = 0;
285 * @brief Reload the Web.
287 virtual void Reload() = 0;
290 * @brief Reload the current page's document without cache
292 virtual bool ReloadWithoutCache() = 0;
295 * @brief Stop loading web contents on the current page.
297 virtual void StopLoading() = 0;
300 * @brief Suspend the operation associated with the view.
302 virtual void Suspend() = 0;
305 * @brief Resume the operation associated with the view object after calling Suspend().
307 virtual void Resume() = 0;
310 * @brief To suspend all url loading
312 virtual void SuspendNetworkLoading() = 0;
315 * @brief To resume new url network loading
317 virtual void ResumeNetworkLoading() = 0;
320 * @brief Add custom header
322 * @param[in] name custom header name to add the custom header
323 * @param[in] value custom header value to add the custom header
325 * @return true if succeeded, false otherwise
327 virtual bool AddCustomHeader(const std::string& name, const std::string& value) = 0;
330 * @brief Remove custom header
332 * @param[in] name custom header name to remove the custom header
334 * @return true if succeeded, false otherwise
336 virtual bool RemoveCustomHeader(const std::string& name) = 0;
339 * @brief Start the inspector server
341 * @param[in] port port number
343 * @return the port number
345 virtual uint32_t StartInspectorServer(uint32_t port) = 0;
348 * @brief Stop the inspector server
350 * @return true if succeeded, false otherwise
352 virtual bool StopInspectorServer() = 0;
355 * @brief Scroll web page of view by deltaX and deltaY.
357 * @param[in] deltaX horizontal offset to scroll
358 * @param[in] deltaY vertical offset to scroll
360 virtual void ScrollBy(int deltaX, int deltaY) = 0;
363 * @brief Scroll edge of view by deltaX and deltaY.
365 * @param[in] deltaX horizontal offset to scroll
366 * @param[in] deltaY vertical offset to scroll
368 * @return true if succeeded, false otherwise
370 virtual bool ScrollEdgeBy(int deltaX, int deltaY) = 0;
373 * @brief Scroll to the specified position of the given view.
375 virtual void SetScrollPosition(int x, int y) = 0;
378 * @brief Get the current scroll position of the given view.
380 virtual Dali::Vector2 GetScrollPosition() const = 0;
383 * @brief Get the possible scroll size of the given view.
385 virtual Dali::Vector2 GetScrollSize() const = 0;
388 * @brief Get the last known content's size.
390 virtual Dali::Vector2 GetContentSize() const = 0;
393 * @brief Return whether forward is possible.
395 * @return True if forward is possible, false otherwise
397 virtual bool CanGoForward() = 0;
400 * @brief Go to forward.
402 virtual void GoForward() = 0;
405 * @brief Return whether backward is possible.
407 * @return True if backward is possible, false otherwise
409 virtual bool CanGoBack() = 0;
414 virtual void GoBack() = 0;
417 * @brief Evaluates JavaScript code represented as a string.
419 * @param[in] script The JavaScript code
420 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
422 virtual void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler) = 0;
425 * @brief Add a message handler into JavaScript.
427 * @param[in] exposedObjectName The name of exposed object
428 * @param[in] handler The callback function
430 virtual void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler) = 0;
433 * @brief Register a callback for JavaScript alert.
435 * @param[in] callback The callback function
437 virtual void RegisterJavaScriptAlertCallback(JavaScriptAlertCallback callback) = 0;
440 * @brief Reply for JavaScript alert.
442 virtual void JavaScriptAlertReply() = 0;
445 * @brief Register a callback for JavaScript confirm.
447 * @param[in] callback The callback function
449 virtual void RegisterJavaScriptConfirmCallback(JavaScriptConfirmCallback callback) = 0;
452 * @brief Reply for JavaScript confirm.
454 virtual void JavaScriptConfirmReply(bool confirmed) = 0;
457 * @brief Register a callback for JavaScript prompt.
459 * @param[in] callback The callback function
461 virtual void RegisterJavaScriptPromptCallback(JavaScriptPromptCallback callback) = 0;
464 * @brief Reply for JavaScript prompt.
466 virtual void JavaScriptPromptReply(const std::string& result) = 0;
469 * @brief Clear the history of Web.
471 virtual void ClearHistory() = 0;
474 * @brief Clear all tiles resources of Web.
476 virtual void ClearAllTilesResources() = 0;
479 * @brief Get user agent string.
481 * @return The string value of user agent
483 virtual const std::string& GetUserAgent() const = 0;
486 * @brief Set user agent string.
488 * @param[in] userAgent The string value of user agent
490 virtual void SetUserAgent(const std::string& userAgent) = 0;
493 * @brief Sets size of Web Page.
495 virtual void SetSize(int width, int height) = 0;
498 * @brief Set background color of web page.
500 * @param[in] color Background color
502 virtual void SetDocumentBackgroundColor(Dali::Vector4 color) = 0;
505 * @brief Clear tiles when hidden.
507 * @param[in] cleared Whether tiles are cleared or not
509 virtual void ClearTilesWhenHidden(bool cleared) = 0;
512 * @brief Set multiplier of cover area of tile.
514 * @param[in] multiplier The multiplier of cover area
516 virtual void SetTileCoverAreaMultiplier(float multiplier) = 0;
519 * @brief Enable cursor by client.
521 * @param[in] enabled Whether cursor is enabled or not
523 virtual void EnableCursorByClient(bool enabled) = 0;
526 * @brief Get the selected text.
528 * @return the selected text
530 virtual std::string GetSelectedText() const = 0;
533 * @brief Send Touch Events.
535 virtual bool SendTouchEvent(const TouchEvent& touch) = 0;
538 * @brief Send Key Events.
540 virtual bool SendKeyEvent(const KeyEvent& event) = 0;
543 * @brief Support mouse events or not.
544 * @param[in] enabled True if enabled, false othewise.
546 virtual void EnableMouseEvents(bool enabled) = 0;
549 * @brief Support key events or not.
550 * @param[in] enabled True if enabled, false othewise.
552 virtual void EnableKeyEvents(bool enabled) = 0;
556 * @param[in] focused True if focus is gained, false lost.
558 virtual void SetFocus(bool focused) = 0;
561 * @brief Set zoom factor of the current page.
562 * @param[in] zoomFactor a new factor to be set.
564 virtual void SetPageZoomFactor(float zoomFactor) = 0;
567 * @brief Query the current zoom factor of the page。
568 * @return The current page zoom factor.
570 virtual float GetPageZoomFactor() const = 0;
573 * @brief Set the current text zoom level。.
574 * @param[in] zoomFactor a new factor to be set.
576 virtual void SetTextZoomFactor(float zoomFactor) = 0;
579 * @brief Get the current text zoom level.
580 * @return The current text zoom factor.
582 virtual float GetTextZoomFactor() const = 0;
585 * @brief Get the current load progress of the page.
586 * @return The load progress of the page.
588 virtual float GetLoadProgressPercentage() const = 0;
591 * @brief Scale the current page, centered at the given point.
592 * @param[in] scaleFactor a new factor to be scaled.
593 * @param[in] point a center coordinate.
595 virtual void SetScaleFactor(float scaleFactor, Dali::Vector2 point) = 0;
598 * @brief Get the current scale factor of the page.
599 * @return The current scale factor.
601 virtual float GetScaleFactor() const = 0;
604 * @brief Request to activate/deactivate the accessibility usage set by web app.
605 * @param[in] activated Activate accessibility or not.
607 virtual void ActivateAccessibility(bool activated) = 0;
610 * @brief Request to set the current page's visibility.
611 * @param[in] visible Visible or not.
613 * @return true if succeeded, false otherwise
615 virtual bool SetVisibility(bool visible) = 0;
618 * @brief Search and highlight the given string in the document.
619 * @param[in] text The text to find
620 * @param[in] options The options to find
621 * @param[in] maxMatchCount The maximum match count to find
623 * @return true if found & highlighted, false otherwise
625 virtual bool HighlightText(const std::string& text, FindOption options, uint32_t maxMatchCount) = 0;
628 * @brief Add dynamic certificate path.
629 * @param[in] host host that required client authentication
630 * @param[in] certPath the file path stored certificate
632 virtual void AddDynamicCertificatePath(const std::string& host, const std::string& certPath) = 0;
635 * @brief Get snapshot of the specified viewArea of page.
637 * @param[in] viewArea The rectangle of screen shot
638 * @param[in] scaleFactor The scale factor
640 * @return pixel data of screen shot
642 virtual Dali::PixelData GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor) = 0;
645 * @brief Request to get snapshot of the specified viewArea of page asynchronously.
647 * @param[in] viewArea The rectangle of screen shot
648 * @param[in] scaleFactor The scale factor
649 * @param[in] callback The callback for screen shot
651 * @return true if requested successfully, false otherwise
653 virtual bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, ScreenshotCapturedCallback callback) = 0;
656 * @brief Asynchronously request to check if there is a video playing in the given view.
658 * @param[in] callback The callback called after checking if video is playing or not
660 * @return true if requested successfully, false otherwise
662 virtual bool CheckVideoPlayingAsynchronously(VideoPlayingCallback callback) = 0;
665 * @brief Set callback which will be called upon geolocation permission request.
667 * @param[in] callback The callback for requesting geolocation permission
669 virtual void RegisterGeolocationPermissionCallback(GeolocationPermissionCallback callback) = 0;
672 * @brief Update display area.
673 * @param[in] displayArea The display area need be updated.
675 virtual void UpdateDisplayArea(Dali::Rect<int> displayArea) = 0;
678 * @brief Enable video hole.
679 * @param[in] enabled True if enabled, false othewise.
681 virtual void EnableVideoHole(bool enabled) = 0;
684 * @brief Send Hover Events.
685 * @param[in] event The hover event would be sent.
687 virtual bool SendHoverEvent(const HoverEvent& event) = 0;
690 * @brief Send Wheel Events.
691 * @param[in] event The wheel event would be sent.
693 virtual bool SendWheelEvent(const WheelEvent& event) = 0;
696 * @brief Connect to this signal to be notified when page loading is started.
698 * @return A signal object to connect with.
700 virtual WebEnginePageLoadSignalType& PageLoadStartedSignal() = 0;
703 * @brief Connect to this signal to be notified when page loading is in progress.
705 * @return A signal object to connect with.
707 virtual WebEnginePageLoadSignalType& PageLoadInProgressSignal() = 0;
710 * @brief Connect to this signal to be notified when page loading is finished.
712 * @return A signal object to connect with.
714 virtual WebEnginePageLoadSignalType& PageLoadFinishedSignal() = 0;
717 * @brief Connect to this signal to be notified when an error occurs in page loading.
719 * @return A signal object to connect with.
721 virtual WebEnginePageLoadErrorSignalType& PageLoadErrorSignal() = 0;
724 * @brief Connect to this signal to be notified when scroll edge is reached.
726 * @return A signal object to connect with.
728 virtual WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal() = 0;
731 * @brief Connect to this signal to be notified when url is changed.
733 * @return A signal object to connect with.
735 virtual WebEngineUrlChangedSignalType& UrlChangedSignal() = 0;
738 * @brief Connect to this signal to be notified when form repost decision is requested.
740 * @return A signal object to connect with.
742 virtual WebEngineFormRepostDecisionSignalType& FormRepostDecisionSignal() = 0;
745 * @brief Connect to this signal to be notified when frame is rendered.
747 * @return A signal object to connect with.
749 virtual WebEngineFrameRenderedSignalType& FrameRenderedSignal() = 0;
752 * @brief Connects to this signal to be notified when http request need be intercepted.
754 * @return A signal object to connect with.
756 virtual WebEngineRequestInterceptorSignalType& RequestInterceptorSignal() = 0;
759 * @brief Connect to this signal to be notified when console message will be logged.
761 * @return A signal object to connect with.
763 virtual WebEngineConsoleMessageSignalType& ConsoleMessageSignal() = 0;
766 * @brief Connects to this signal to be notified when new policy would be decided.
768 * @return A signal object to connect with.
770 virtual WebEnginePolicyDecisionSignalType& PolicyDecisionSignal() = 0;
773 // specialization has to be done in the same namespace
775 struct EnableBitMaskOperators<WebEnginePlugin::FindOption>
777 static const bool ENABLE = true;