2 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "web-view-impl.h"
23 #include <dali/devel-api/scripting/enum-helper.h>
24 #include <dali/devel-api/scripting/scripting.h>
25 #include <dali/devel-api/common/stage.h>
26 #include <dali/public-api/adaptor-framework/native-image-source.h>
27 #include <dali/public-api/object/type-registry.h>
28 #include <dali/public-api/object/type-registry-helper.h>
31 #include <dali-toolkit/devel-api/controls/control-devel.h>
32 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
33 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
34 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
50 return Toolkit::WebView::New();
53 DALI_ENUM_TO_STRING_TABLE_BEGIN( CacheModel )
54 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_VIEWER )
55 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_BROWSER )
56 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, PRIMARY_WEB_BROWSER )
57 DALI_ENUM_TO_STRING_TABLE_END( CacheModel )
59 DALI_ENUM_TO_STRING_TABLE_BEGIN( CookieAcceptPolicy )
60 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, ALWAYS )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NEVER )
62 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NO_THIRD_PARTY )
63 DALI_ENUM_TO_STRING_TABLE_END( CookieAcceptPolicy )
65 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::WebView, Toolkit::Control, Create )
67 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "url", STRING, URL )
68 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cacheModel", STRING, CACHE_MODEL )
69 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cookieAcceptPolicy", STRING, COOKIE_ACCEPT_POLICY )
70 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "userAgent", STRING, USER_AGENT )
71 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "enableJavaScript", BOOLEAN, ENABLE_JAVASCRIPT )
72 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "loadImagesAutomatically", BOOLEAN, LOAD_IMAGES_AUTOMATICALLY )
73 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultTextEncodingName", STRING, DEFAULT_TEXT_ENCODING_NAME )
74 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultFontSize", INTEGER, DEFAULT_FONT_SIZE )
75 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "scrollPosition", VECTOR2, SCROLL_POSITION )
76 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "scrollSize", VECTOR2, SCROLL_SIZE )
77 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "contentSize", VECTOR2, CONTENT_SIZE )
79 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadStarted", PAGE_LOAD_STARTED_SIGNAL )
80 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadFinished", PAGE_LOAD_FINISHED_SIGNAL )
81 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadError", PAGE_LOAD_ERROR_SIGNAL )
82 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "scrollEdgeReached", SCROLL_EDGE_REACHED_SIGNAL )
84 DALI_TYPE_REGISTRATION_END()
86 const std::string kEmptyString;
88 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
90 const char* FRAGMENT_SHADER_TEXTURE = DALI_COMPOSE_SHADER(
91 varying mediump vec2 vTexCoord;\n
92 uniform sampler2D sTexture;\n
93 uniform lowp vec4 uColor;\n
94 uniform lowp vec3 mixColor;\n
95 uniform lowp float preMultipliedAlpha;\n
99 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * vec4( mixColor, 1.0 );\n
103 Dali::Toolkit::Visual::Base CreateNativeImageVisual( NativeImageInterfacePtr nativeImageInterface )
105 std::string fragmentShader;
107 const char* fragmentPrefix = nativeImageInterface->GetCustomFragmentPrefix();
110 fragmentShader = fragmentPrefix;
111 fragmentShader += FRAGMENT_SHADER_TEXTURE;
115 fragmentShader = FRAGMENT_SHADER_TEXTURE;
118 const char* customSamplerTypename = nativeImageInterface->GetCustomSamplerTypename();
119 if( customSamplerTypename )
121 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
124 Texture texture = Dali::Texture::New( *nativeImageInterface );
125 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
127 return Toolkit::VisualFactory::Get().CreateVisual(
128 { { Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE } ,
129 { Toolkit::Visual::Property::SHADER, { { Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, fragmentShader } } },
130 { Toolkit::ImageVisual::Property::URL, nativeImageUrl } } );
133 } // anonymous namepsace
135 #define GET_ENUM_STRING( structName, inputExp ) \
136 Scripting::GetLinearEnumerationName< Toolkit::WebView::structName::Type >( static_cast< Toolkit::WebView::structName::Type >( inputExp ), structName##_TABLE, structName##_TABLE_COUNT )
138 #define GET_ENUM_VALUE( structName, inputExp, outputExp ) \
139 Scripting::GetEnumerationProperty< Toolkit::WebView::structName::Type >( inputExp, structName##_TABLE, structName##_TABLE_COUNT, outputExp )
141 WebView::WebView( const std::string& locale, const std::string& timezoneId )
142 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS ) ),
145 mWebViewSize( Stage::GetCurrent().GetSize() ),
147 mPageLoadStartedSignal(),
148 mPageLoadFinishedSignal(),
149 mPageLoadErrorSignal()
151 mWebEngine = Dali::WebEngine::New();
153 // WebEngine is empty when it is not properly initialized.
156 mWebEngine.Create( mWebViewSize.width, mWebViewSize.height, locale, timezoneId );
169 Toolkit::WebView WebView::New()
171 WebView* impl = new WebView();
172 Toolkit::WebView handle = Toolkit::WebView( *impl );
178 Toolkit::WebView WebView::New( const std::string& locale, const std::string& timezoneId )
180 WebView* impl = new WebView( locale, timezoneId );
181 Toolkit::WebView handle = Toolkit::WebView( *impl );
187 void WebView::OnInitialize()
189 Self().SetProperty( Actor::Property::KEYBOARD_FOCUSABLE, true );
190 Self().TouchedSignal().Connect( this, &WebView::OnTouchEvent );
194 mWebEngine.PageLoadStartedSignal().Connect( this, &WebView::OnPageLoadStarted );
195 mWebEngine.PageLoadFinishedSignal().Connect( this, &WebView::OnPageLoadFinished );
196 mWebEngine.PageLoadErrorSignal().Connect( this, &WebView::OnPageLoadError );
197 mWebEngine.ScrollEdgeReachedSignal().Connect( this, &WebView::OnScrollEdgeReached );
201 void WebView::LoadUrl( const std::string& url )
206 mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
210 // Clean up previously registered visual and add new one.
211 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
212 mWebEngine.LoadUrl( url );
217 void WebView::LoadHTMLString( const std::string& htmlString )
221 mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
225 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
226 mWebEngine.LoadHTMLString( htmlString );
231 void WebView::Reload()
239 void WebView::StopLoading()
243 mWebEngine.StopLoading();
247 void WebView::Suspend()
251 mWebEngine.Suspend();
255 void WebView::Resume()
263 void WebView::ScrollBy( int deltaX, int deltaY )
267 mWebEngine.ScrollBy( deltaX, deltaY );
271 bool WebView::CanGoForward()
273 return mWebEngine ? mWebEngine.CanGoForward() : false;
276 void WebView::GoForward()
280 mWebEngine.GoForward();
284 bool WebView::CanGoBack()
286 return mWebEngine ? mWebEngine.CanGoBack() : false;
289 void WebView::GoBack()
297 void WebView::EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler )
301 mWebEngine.EvaluateJavaScript( script, resultHandler );
305 void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
309 mWebEngine.AddJavaScriptMessageHandler( exposedObjectName, handler );
313 void WebView::ClearHistory()
317 mWebEngine.ClearHistory();
321 void WebView::ClearCache()
325 mWebEngine.ClearCache();
329 void WebView::ClearCookies()
333 mWebEngine.ClearCookies();
337 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadStartedSignal()
339 return mPageLoadStartedSignal;
342 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadFinishedSignal()
344 return mPageLoadFinishedSignal;
347 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& WebView::PageLoadErrorSignal()
349 return mPageLoadErrorSignal;
352 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& WebView::ScrollEdgeReachedSignal()
354 return mScrollEdgeReachedSignal;
357 void WebView::OnPageLoadStarted( const std::string& url )
359 if( !mPageLoadStartedSignal.Empty() )
361 Dali::Toolkit::WebView handle( GetOwner() );
362 mPageLoadStartedSignal.Emit( handle, url );
366 void WebView::OnPageLoadFinished( const std::string& url )
368 if( !mPageLoadFinishedSignal.Empty() )
370 Dali::Toolkit::WebView handle( GetOwner() );
371 mPageLoadFinishedSignal.Emit( handle, url );
375 void WebView::OnPageLoadError( const std::string& url, int errorCode )
377 if( !mPageLoadErrorSignal.Empty() )
379 Dali::Toolkit::WebView handle( GetOwner() );
380 mPageLoadErrorSignal.Emit( handle, url, static_cast< Toolkit::WebView::LoadErrorCode >( errorCode ) );
384 void WebView::OnScrollEdgeReached( Dali::WebEnginePlugin::ScrollEdge edge )
386 if( !mScrollEdgeReachedSignal.Empty() )
388 Dali::Toolkit::WebView handle( GetOwner() );
389 mScrollEdgeReachedSignal.Emit( handle, edge );
393 bool WebView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
395 Dali::BaseHandle handle( object );
397 bool connected = false;
398 Toolkit::WebView webView = Toolkit::WebView::DownCast( handle );
400 if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL ) )
402 webView.PageLoadStartedSignal().Connect( tracker, functor );
405 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL ) )
407 webView.PageLoadFinishedSignal().Connect( tracker, functor );
410 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_ERROR_SIGNAL ) )
412 webView.PageLoadErrorSignal().Connect( tracker, functor );
415 else if( 0 == strcmp( signalName.c_str(), SCROLL_EDGE_REACHED_SIGNAL ) )
417 webView.ScrollEdgeReachedSignal().Connect( tracker, functor );
424 Vector3 WebView::GetNaturalSize()
428 Vector2 rendererNaturalSize;
429 mVisual.GetNaturalSize( rendererNaturalSize );
430 return Vector3( rendererNaturalSize );
433 return Vector3( mWebViewSize );
436 void WebView::OnRelayout( const Vector2& size, RelayoutContainer& container )
438 Control::OnRelayout( size, container );
440 if( size.width > 0 && size.height > 0 && mWebViewSize != size )
446 mWebEngine.SetSize( size.width, size.height );
451 void WebView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
453 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
457 WebView& impl = GetImpl( webView );
460 case Toolkit::WebView::Property::URL:
463 if( value.Get( url ) )
469 case Toolkit::WebView::Property::CACHE_MODEL:
471 Toolkit::WebView::CacheModel::Type output = impl.GetCacheModel();
472 GET_ENUM_VALUE( CacheModel, value, output );
473 impl.SetCacheModel( output );
476 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
478 Toolkit::WebView::CookieAcceptPolicy::Type output = impl.GetCookieAcceptPolicy();
479 GET_ENUM_VALUE( CookieAcceptPolicy, value, output );
480 impl.SetCookieAcceptPolicy( output );
483 case Toolkit::WebView::Property::USER_AGENT:
486 if( value.Get( input ) )
488 impl.SetUserAgent( input );
492 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
495 if( value.Get( input ) )
497 impl.EnableJavaScript( input );
501 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
504 if( value.Get( input ) )
506 impl.LoadImagesAutomatically( input );
510 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
513 if( value.Get( input ) )
515 impl.SetDefaultTextEncodingName( input );
519 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
522 if( value.Get( input ) )
524 impl.SetDefaultFontSize( input );
528 case Toolkit::WebView::Property::SCROLL_POSITION:
531 if ( value.Get( input ) )
533 impl.SetScrollPosition( input.x, input.y );
541 Property::Value WebView::GetProperty( BaseObject* object, Property::Index propertyIndex )
543 Property::Value value;
545 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
549 WebView& impl = GetImpl( webView );
550 switch( propertyIndex )
552 case Toolkit::WebView::Property::URL:
557 case Toolkit::WebView::Property::CACHE_MODEL:
559 value = GET_ENUM_STRING( CacheModel, impl.GetCacheModel() );
562 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
564 value = GET_ENUM_STRING( CookieAcceptPolicy, impl.GetCookieAcceptPolicy() );
567 case Toolkit::WebView::Property::USER_AGENT:
569 value = impl.GetUserAgent();
572 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
574 value = impl.IsJavaScriptEnabled();
577 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
579 value = impl.AreImagesAutomaticallyLoaded();
582 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
584 value = impl.GetDefaultTextEncodingName();
587 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
589 value = impl.GetDefaultFontSize();
592 case Toolkit::WebView::Property::SCROLL_POSITION:
595 impl.GetScrollPosition( x, y );
596 value = Vector2( x, y );
599 case Toolkit::WebView::Property::SCROLL_SIZE:
602 impl.GetScrollSize( width, height );
603 value = Vector2( width, height );
606 case Toolkit::WebView::Property::CONTENT_SIZE:
609 impl.GetContentSize( width, height );
610 value = Vector2( width, height );
621 bool WebView::OnTouchEvent( Actor actor, const Dali::TouchEvent& touch )
627 result = mWebEngine.SendTouchEvent( touch );
632 bool WebView::OnKeyEvent( const Dali::KeyEvent& event )
638 result = mWebEngine.SendKeyEvent( event );
643 void WebView::OnKeyInputFocusGained()
647 mWebEngine.SetFocus( true );
650 EmitKeyInputFocusSignal( true ); // Calls back into the Control hence done last.
653 void WebView::OnKeyInputFocusLost()
657 mWebEngine.SetFocus( false );
660 EmitKeyInputFocusSignal( false ); // Calls back into the Control hence done last.
663 void WebView::SetScrollPosition( int x, int y )
667 mWebEngine.SetScrollPosition( x, y );
671 void WebView::GetScrollPosition( int& x, int& y ) const
675 mWebEngine.GetScrollPosition( x, y );
679 void WebView::GetScrollSize( int& width, int& height ) const
683 mWebEngine.GetScrollSize( width, height );
687 void WebView::GetContentSize( int& width, int& height ) const
691 mWebEngine.GetContentSize( width, height );
695 Toolkit::WebView::CacheModel::Type WebView::GetCacheModel() const
697 return mWebEngine ? static_cast< Toolkit::WebView::CacheModel::Type >( mWebEngine.GetCacheModel() ) : Toolkit::WebView::CacheModel::DOCUMENT_VIEWER;
700 void WebView::SetCacheModel( Toolkit::WebView::CacheModel::Type cacheModel )
704 mWebEngine.SetCacheModel( static_cast< WebEnginePlugin::CacheModel >( cacheModel ) );
708 Toolkit::WebView::CookieAcceptPolicy::Type WebView::GetCookieAcceptPolicy() const
710 return mWebEngine ? static_cast< Toolkit::WebView::CookieAcceptPolicy::Type >( mWebEngine.GetCookieAcceptPolicy() ) : Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY;
713 void WebView::SetCookieAcceptPolicy( Toolkit::WebView::CookieAcceptPolicy::Type policy )
717 mWebEngine.SetCookieAcceptPolicy( static_cast< WebEnginePlugin::CookieAcceptPolicy >( policy ) );
721 const std::string& WebView::GetUserAgent() const
723 return mWebEngine ? mWebEngine.GetUserAgent() : kEmptyString;
726 void WebView::SetUserAgent( const std::string& userAgent )
730 mWebEngine.SetUserAgent( userAgent );
734 bool WebView::IsJavaScriptEnabled() const
736 return mWebEngine ? mWebEngine.IsJavaScriptEnabled() : true;
739 void WebView::EnableJavaScript( bool enabled )
743 mWebEngine.EnableJavaScript( enabled );
747 bool WebView::AreImagesAutomaticallyLoaded() const
749 return mWebEngine ? mWebEngine.AreImagesAutomaticallyLoaded() : true;
752 void WebView::LoadImagesAutomatically( bool automatic )
756 mWebEngine.LoadImagesAutomatically( automatic );
760 const std::string& WebView::GetDefaultTextEncodingName() const
762 return mWebEngine ? mWebEngine.GetDefaultTextEncodingName() : kEmptyString;
765 void WebView::SetDefaultTextEncodingName( const std::string& defaultTextEncodingName )
769 mWebEngine.SetDefaultTextEncodingName( defaultTextEncodingName );
773 int WebView::GetDefaultFontSize() const
775 return mWebEngine ? mWebEngine.GetDefaultFontSize() : 0;
778 void WebView::SetDefaultFontSize( int defaultFontSize )
782 mWebEngine.SetDefaultFontSize( defaultFontSize );
786 #undef GET_ENUM_STRING
787 #undef GET_ENUM_VALUE
789 } // namespace Internal
791 } // namespace Toolkit