/*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2024 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.
*/
// CLASS HEADER
-#include "web-view-impl.h"
+#include <dali-toolkit/internal/controls/web-view/web-view-impl.h>
// EXTERNAL INCLUDES
-#include <cstring>
#include <dali/devel-api/adaptor-framework/web-engine/web-engine-back-forward-list.h>
#include <dali/devel-api/adaptor-framework/web-engine/web-engine-certificate.h>
#include <dali/devel-api/adaptor-framework/web-engine/web-engine-console-message.h>
#include <dali/devel-api/adaptor-framework/web-engine/web-engine-load-error.h>
#include <dali/devel-api/adaptor-framework/web-engine/web-engine-policy-decision.h>
#include <dali/devel-api/adaptor-framework/web-engine/web-engine-settings.h>
+#include <dali/devel-api/adaptor-framework/window-devel.h>
#include <dali/devel-api/common/stage.h>
#include <dali/devel-api/scripting/enum-helper.h>
#include <dali/devel-api/scripting/scripting.h>
#include <dali-toolkit/devel-api/controls/control-devel.h>
#include <dali-toolkit/devel-api/controls/web-view/web-back-forward-list.h>
#include <dali-toolkit/devel-api/controls/web-view/web-settings.h>
+#include <dali-toolkit/devel-api/visuals/visual-actions-devel.h>
+#include <dali-toolkit/internal/visuals/visual-base-impl.h>
#include <dali-toolkit/internal/visuals/visual-factory-impl.h>
-#include <dali-toolkit/public-api/image-loader/image.h>
#include <dali-toolkit/public-api/image-loader/image-url.h>
+#include <dali-toolkit/public-api/image-loader/image.h>
#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
#include <functional>
static std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>> pluginWebViewMap;
return pluginWebViewMap;
}
+
+enum class DisplayAreaCalculateOption
+{
+ PROPERTY = 0, ///< Calculate display update area by property
+ CURRENT_PROPERTY = 1, ///< Calculate display update area by current property
+};
+
+/**
+ * @brief Helper function to calculate exact display area, offset and size.
+ * It will be useful when view size is not integer value, or view size is not matched with texture size.
+ *
+ * @param[in] self The view itself.
+ * @param[in] option Option of this calculation. Let we decide what kind of property will be used.
+ * @return DisplayArea for this view.
+ */
+Rect<int32_t> CalculateDisplayArea(Dali::Actor self, DisplayAreaCalculateOption option)
+{
+ bool positionUsesAnchorPoint = self.GetProperty<bool>(Actor::Property::POSITION_USES_ANCHOR_POINT);
+ Vector3 actorSize = (option == DisplayAreaCalculateOption::CURRENT_PROPERTY) ? self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::SCALE)
+ : self.GetProperty<Vector3>(Actor::Property::SIZE) * self.GetProperty<Vector3>(Actor::Property::SCALE);
+ Vector3 anchorPointOffSet = actorSize * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
+ Vector2 screenPosition = (option == DisplayAreaCalculateOption::CURRENT_PROPERTY) ? self.GetProperty<Vector2>(Actor::Property::SCREEN_POSITION)
+ : Dali::DevelActor::CalculateScreenPosition(self);
+
+ Dali::Rect<int32_t> displayArea;
+ displayArea.x = screenPosition.x - anchorPointOffSet.x;
+ displayArea.y = screenPosition.y - anchorPointOffSet.y;
+ displayArea.width = actorSize.x;
+ displayArea.height = actorSize.y;
+
+ return displayArea;
+}
+
+constexpr Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
+
+/**
+ * @brief Helper function to calculate exact pixel area value by view and texture size.
+ * It will be useful when view size is not integer value, or view size is not matched with texture size.
+ *
+ * @param[in] viewSize The size of view.
+ * @param[in] textureWidth The width of texture, that must be integer type.
+ * @param[in] textureHeight The height of texture, that must be integer type.
+ * @return PixelArea value that image visual can use.
+ */
+Vector4 CalculatePixelArea(const Size& viewSize, const uint32_t textureWidth, const uint32_t textureHeight)
+{
+ float widthRatio = textureWidth == 0u ? 1.0f : viewSize.width / static_cast<float>(textureWidth);
+ float heightRatio = textureHeight == 0u ? 1.0f : viewSize.height / static_cast<float>(textureHeight);
+ return Vector4(0.0f, 0.0f, widthRatio, heightRatio);
+}
+
} // namespace
WebView::WebView(const std::string& locale, const std::string& timezoneId)
mVisual(),
mWebViewSize(Stage::GetCurrent().GetSize()),
mWebEngine(),
+ mLastRenderedNativeImageWidth(0u),
+ mLastRenderedNativeImageHeight(0u),
mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
mVideoHoleEnabled(false),
mMouseEventsEnabled(true),
mKeyEventsEnabled(true),
+ mVisualChangeRequired(false),
mScreenshotCapturedCallback{nullptr},
mFrameRenderedCallback{nullptr}
{
mVisual(),
mWebViewSize(Stage::GetCurrent().GetSize()),
mWebEngine(),
+ mLastRenderedNativeImageWidth(0u),
+ mLastRenderedNativeImageHeight(0u),
mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
mVideoHoleEnabled(false),
mMouseEventsEnabled(true),
mKeyEventsEnabled(true),
+ mVisualChangeRequired(false),
mScreenshotCapturedCallback{nullptr},
mFrameRenderedCallback{nullptr}
{
if(mWebEngine)
{
auto iter = GetPluginWebViewTable().find(mWebEngine.GetPlugin());
- if (iter != GetPluginWebViewTable().end())
+ if(iter != GetPluginWebViewTable().end())
{
GetPluginWebViewTable().erase(iter);
}
{
WebView* impl = new WebView();
Toolkit::WebView handle = Toolkit::WebView(*impl);
- if (impl->GetPlugin())
+ if(impl->GetPlugin())
{
GetPluginWebViewTable()[impl->GetPlugin()] = handle;
}
{
WebView* impl = new WebView(locale, timezoneId);
Toolkit::WebView handle = Toolkit::WebView(*impl);
- if (impl->GetPlugin())
+ if(impl->GetPlugin())
{
GetPluginWebViewTable()[impl->GetPlugin()] = handle;
}
{
WebView* impl = new WebView(argc, argv);
Toolkit::WebView handle = Toolkit::WebView(*impl);
- if (impl->GetPlugin())
+ if(impl->GetPlugin())
{
GetPluginWebViewTable()[impl->GetPlugin()] = handle;
}
Toolkit::WebView WebView::FindWebView(Dali::WebEnginePlugin* plugin)
{
auto iter = GetPluginWebViewTable().find(plugin);
- if (iter != GetPluginWebViewTable().end())
+ if(iter != GetPluginWebViewTable().end())
{
return iter->second.GetHandle();
}
self.WheelEventSignal().Connect(this, &WebView::OnWheelEvent);
Dali::DevelActor::VisibilityChangedSignal(self).Connect(this, &WebView::OnVisibilityChanged);
+ mWebViewVisibleState |= WebViewVisibleStateFlag::SELF_SHOW;
+
mPositionUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_POSITION, StepCondition(1.0f, 1.0f));
mSizeUpdateNotification = self.AddPropertyNotification(Actor::Property::SIZE, StepCondition(1.0f, 1.0f));
mScaleUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_SCALE, StepCondition(0.1f, 1.0f));
return new WebViewAccessible(Self(), mWebEngine);
}
+void WebView::OnRelayout(const Vector2& size, RelayoutContainer& container)
+{
+ if(!mWebEngine)
+ {
+ return;
+ }
+
+ auto displayArea = CalculateDisplayArea(Self(), DisplayAreaCalculateOption::PROPERTY);
+
+ SetDisplayArea(displayArea);
+}
+
Dali::Toolkit::WebSettings* WebView::GetSettings() const
{
return mWebSettings.get();
return mWebEngine.LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
}
-bool WebView::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
+bool WebView::LoadContents(const int8_t* contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
{
if(!mWebEngine)
return false;
{
if(mWebEngine)
{
- mWebEngine.EvaluateJavaScript(script, resultHandler);
+ mWebEngine.EvaluateJavaScript(script, std::move(resultHandler));
}
}
{
if(mWebEngine)
{
- mWebEngine.AddJavaScriptMessageHandler(exposedObjectName, handler);
+ mWebEngine.AddJavaScriptMessageHandler(exposedObjectName, std::move(handler));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterJavaScriptAlertCallback(callback);
+ mWebEngine.RegisterJavaScriptAlertCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterJavaScriptConfirmCallback(callback);
+ mWebEngine.RegisterJavaScriptConfirmCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterJavaScriptPromptCallback(callback);
+ mWebEngine.RegisterJavaScriptPromptCallback(std::move(callback));
}
}
bool result = false;
if(mWebEngine)
{
- result = mWebEngine.CreateHitTestAsynchronously(x, y, mode, callback);
+ result = mWebEngine.CreateHitTestAsynchronously(x, y, mode, std::move(callback));
}
return result;
}
bool WebView::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback)
{
- mScreenshotCapturedCallback = callback;
+ mScreenshotCapturedCallback = std::move(callback);
return mWebEngine ? mWebEngine.GetScreenshotAsynchronously(viewArea, scaleFactor, std::bind(&WebView::OnScreenshotCaptured, this, std::placeholders::_1)) : false;
}
bool WebView::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
{
- return mWebEngine ? mWebEngine.CheckVideoPlayingAsynchronously(callback) : false;
+ return mWebEngine ? mWebEngine.CheckVideoPlayingAsynchronously(std::move(callback)) : false;
}
void WebView::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
{
if(mWebEngine)
{
- mWebEngine.RegisterGeolocationPermissionCallback(callback);
+ mWebEngine.RegisterGeolocationPermissionCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterPageLoadStartedCallback(callback);
+ mWebEngine.RegisterPageLoadStartedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterPageLoadInProgressCallback(callback);
+ mWebEngine.RegisterPageLoadInProgressCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterPageLoadFinishedCallback(callback);
+ mWebEngine.RegisterPageLoadFinishedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterPageLoadErrorCallback(callback);
+ mWebEngine.RegisterPageLoadErrorCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterScrollEdgeReachedCallback(callback);
+ mWebEngine.RegisterScrollEdgeReachedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterUrlChangedCallback(callback);
+ mWebEngine.RegisterUrlChangedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterFormRepostDecidedCallback(callback);
+ mWebEngine.RegisterFormRepostDecidedCallback(std::move(callback));
}
}
void WebView::RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback)
{
- mFrameRenderedCallback = callback;
+ mFrameRenderedCallback = std::move(callback);
}
void WebView::RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback)
{
if(mWebEngine)
{
- mWebEngine.RegisterConsoleMessageReceivedCallback(callback);
+ mWebEngine.RegisterConsoleMessageReceivedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterResponsePolicyDecidedCallback(callback);
+ mWebEngine.RegisterResponsePolicyDecidedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterNavigationPolicyDecidedCallback(callback);
+ mWebEngine.RegisterNavigationPolicyDecidedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterNewWindowCreatedCallback(callback);
+ mWebEngine.RegisterNewWindowCreatedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterCertificateConfirmedCallback(callback);
+ mWebEngine.RegisterCertificateConfirmedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterSslCertificateChangedCallback(callback);
+ mWebEngine.RegisterSslCertificateChangedCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterHttpAuthHandlerCallback(callback);
+ mWebEngine.RegisterHttpAuthHandlerCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterContextMenuShownCallback(callback);
+ mWebEngine.RegisterContextMenuShownCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.RegisterContextMenuHiddenCallback(callback);
+ mWebEngine.RegisterContextMenuHiddenCallback(std::move(callback));
}
}
{
if(mWebEngine)
{
- mWebEngine.GetPlainTextAsynchronously(callback);
+ mWebEngine.GetPlainTextAsynchronously(std::move(callback));
}
}
mFrameRenderedCallback();
}
- // Make sure that mVisual is created only once.
- if (mVisual)
- return;
-
- Dali::Toolkit::ImageUrl nativeImageUrl = Dali::Toolkit::Image::GenerateUrl(mWebEngine.GetNativeImageSource());
- mVisual = Toolkit::VisualFactory::Get().CreateVisual({{Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE}, {Toolkit::ImageVisual::Property::URL, nativeImageUrl.GetUrl()}});
- if(mVisual)
+ // Make sure that mVisual is created only if required.
+ if(mVisualChangeRequired || !mVisual)
{
- DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual);
- EnableBlendMode(!mVideoHoleEnabled);
+ // Reset flag
+ mVisualChangeRequired = false;
+
+ auto nativeImageSourcePtr = mWebEngine.GetNativeImageSource();
+
+ mLastRenderedNativeImageWidth = nativeImageSourcePtr->GetWidth();
+ mLastRenderedNativeImageHeight = nativeImageSourcePtr->GetHeight();
+
+ Dali::Toolkit::ImageUrl nativeImageUrl = Dali::Toolkit::Image::GenerateUrl(nativeImageSourcePtr);
+
+ mVisual = Toolkit::VisualFactory::Get().CreateVisual(
+ {{Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE},
+ {Toolkit::ImageVisual::Property::URL, nativeImageUrl.GetUrl()},
+ {Toolkit::ImageVisual::Property::PIXEL_AREA, FULL_TEXTURE_RECT},
+ {Toolkit::ImageVisual::Property::WRAP_MODE_U, Dali::WrapMode::CLAMP_TO_EDGE},
+ {Toolkit::ImageVisual::Property::WRAP_MODE_V, Dali::WrapMode::CLAMP_TO_EDGE}});
+
+ if(mVisual)
+ {
+ DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual);
+ EnableBlendMode(!mVideoHoleEnabled);
+ }
}
}
void WebView::OnDisplayAreaUpdated(Dali::PropertyNotification& /*source*/)
{
if(!mWebEngine)
+ {
return;
+ }
- Actor self(Self());
-
- bool positionUsesAnchorPoint = self.GetProperty<bool>(Actor::Property::POSITION_USES_ANCHOR_POINT);
- Vector3 actorSize = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::SCALE);
- Vector3 anchorPointOffSet = actorSize * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
- Vector2 screenPosition = self.GetProperty<Vector2>(Actor::Property::SCREEN_POSITION);
+ auto displayArea = CalculateDisplayArea(Self(), DisplayAreaCalculateOption::CURRENT_PROPERTY);
- Dali::Rect<int32_t> displayArea;
- displayArea.x = screenPosition.x - anchorPointOffSet.x;
- displayArea.y = screenPosition.y - anchorPointOffSet.y;
- displayArea.width = actorSize.x;
- displayArea.height = actorSize.y;
+ SetDisplayArea(displayArea);
+}
- Size displaySize = Size(displayArea.width, displayArea.height);
- if(mWebViewSize != displaySize)
+void WebView::OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type)
+{
+ if(type == Dali::DevelActor::VisibilityChange::Type::SELF)
{
- mWebViewSize = displaySize;
+ if(isVisible)
+ {
+ mWebViewVisibleState |= WebViewVisibleStateFlag::SELF_SHOW;
+ }
+ else
+ {
+ mWebViewVisibleState &= ~WebViewVisibleStateFlag::SELF_SHOW;
+ }
}
-
- if(mWebViewArea != displayArea)
+ else if(type == Dali::DevelActor::VisibilityChange::Type::PARENT)
{
- mWebViewArea = displayArea;
- mWebEngine.UpdateDisplayArea(mWebViewArea);
+ if(isVisible)
+ {
+ mWebViewVisibleState |= WebViewVisibleStateFlag::PARENT_SHOW;
+ // TODO : We should consider double-hide called from parent
+ }
+ else
+ {
+ mWebViewVisibleState &= ~WebViewVisibleStateFlag::PARENT_SHOW;
+ }
}
+ ApplyVisibilityCheck();
}
-void WebView::OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type)
+void WebView::OnWindowVisibilityChanged(Window window, bool visible)
{
- if(type == Dali::DevelActor::VisibilityChange::Type::SELF)
+ if(visible)
+ {
+ mWebViewVisibleState |= WebViewVisibleStateFlag::WINDOW_SHOW;
+ }
+ else
{
- SetVisibility(isVisible);
+ mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
}
+ ApplyVisibilityCheck();
}
void WebView::OnScreenshotCaptured(Dali::PixelData pixel)
}
}
+void WebView::SetDisplayArea(const Dali::Rect<int32_t>& displayArea)
+{
+ Size displaySize = Size(displayArea.width, displayArea.height);
+ if(mWebViewSize != displaySize)
+ {
+ mWebViewSize = displaySize;
+ }
+
+ if(mWebViewArea != displayArea)
+ {
+ // WebEngine visual size changed. we have to re-create visual.
+ mVisualChangeRequired = true;
+
+ // Change old visual's pixel area matched as changed web view size
+ if(mVisual)
+ {
+ auto pixelArea = CalculatePixelArea(mWebViewSize, mLastRenderedNativeImageWidth, mLastRenderedNativeImageHeight);
+ Toolkit::GetImplementation(mVisual).DoAction(Toolkit::DevelVisual::Action::UPDATE_PROPERTY, {{Toolkit::ImageVisual::Property::PIXEL_AREA, pixelArea}});
+ }
+
+ mWebViewArea = displayArea;
+ mWebEngine.UpdateDisplayArea(mWebViewArea);
+ }
+}
+
void WebView::OnSceneConnection(int depth)
{
+ mWebViewVisibleState |= WebViewVisibleStateFlag::SCENE_ON;
+ mWebViewVisibleState |= WebViewVisibleStateFlag::PARENT_SHOW;
+ // TODO : We should consider already hided parent
+ Window window = DevelWindow::Get(Self());
+ if(window)
+ {
+ // Hold the weak handle of the placement window.
+ mPlacementWindow = window;
+ if(window.IsVisible())
+ {
+ mWebViewVisibleState |= WebViewVisibleStateFlag::WINDOW_SHOW;
+ }
+ else
+ {
+ mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
+ }
+ DevelWindow::VisibilityChangedSignal(window).Connect(this, &WebView::OnWindowVisibilityChanged);
+ }
+ ApplyVisibilityCheck();
Control::OnSceneConnection(depth);
EnableBlendMode(!mVideoHoleEnabled);
}
+void WebView::OnSceneDisconnection()
+{
+ mWebViewVisibleState &= ~WebViewVisibleStateFlag::SCENE_ON;
+ mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
+ mWebViewVisibleState &= ~WebViewVisibleStateFlag::PARENT_SHOW;
+ Window window = mPlacementWindow.GetHandle();
+ if(window)
+ {
+ DevelWindow::VisibilityChangedSignal(window).Disconnect(this, &WebView::OnWindowVisibilityChanged);
+ mPlacementWindow.Reset();
+ }
+ ApplyVisibilityCheck();
+ Control::OnSceneDisconnection();
+}
+
bool WebView::OnTouchEvent(Actor actor, const Dali::TouchEvent& touch)
{
bool result = false;
return mWebEngine ? mWebEngine.SetVisibility(visible) : false;
}
+void WebView::ApplyVisibilityCheck()
+{
+ SetVisibility(mWebViewVisibleState == WebViewVisibleStateFlag::VISIBLE);
+}
+
WebView::WebViewAccessible::WebViewAccessible(Dali::Actor self, Dali::WebEngine& webEngine)
-: ControlAccessible(self), mRemoteChild{}, mWebEngine{webEngine}
+: ControlAccessible(self),
+ mRemoteChild{},
+ mWebEngine{webEngine}
{
mRemoteChild.SetParent(this);
projects / platform / core / uifw / dali-toolkit.git / blobdiff