2 * Copyright (c) 2017 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 <window-impl.h>
23 #include <Ecore_Wayland.h>
25 #include <dali/integration-api/core.h>
26 #include <dali/integration-api/system-overlay.h>
27 #include <dali/public-api/render-tasks/render-task.h>
28 #include <dali/public-api/render-tasks/render-task-list.h>
29 #include <orientation.h>
32 #include <window-render-surface.h>
33 #include <drag-and-drop-detector-impl.h>
34 #include <ecore-indicator-impl.h>
35 #include <window-visibility-observer.h>
36 #include <orientation-impl.h>
40 const float INDICATOR_ANIMATION_DURATION( 0.18f ); // 180 milli seconds
41 const float INDICATOR_SHOW_Y_POSITION( 0.0f );
42 const float INDICATOR_HIDE_Y_POSITION( -52.0f );
51 #if defined(DEBUG_ENABLED)
52 Debug::Filter* gWindowLogFilter = Debug::Filter::New(Debug::Concise, false, "LOG_WINDOW");
56 * TODO: Abstract Window class out and move this into a window implementation for Ecore
58 struct Window::EventHandler
62 * @param[in] window A pointer to the window class.
64 EventHandler( Window* window )
66 mWindowPropertyHandler( NULL ),
67 mWindowIconifyStateHandler( NULL ),
68 mWindowFocusInHandler( NULL ),
69 mWindowFocusOutHandler( NULL ),
72 // store ecore window handle
73 ECore::WindowRenderSurface* wlWindow( dynamic_cast< ECore::WindowRenderSurface * >( mWindow->mSurface ) );
76 mEcoreWindow = wlWindow->GetWlWindow();
78 DALI_ASSERT_ALWAYS( mEcoreWindow != 0 && "There is no ecore Wl window");
80 if( mWindow->mEcoreEventHander )
82 mWindowIconifyStateHandler = ecore_event_handler_add( ECORE_WL_EVENT_WINDOW_ICONIFY_STATE_CHANGE, EcoreEventWindowIconifyStateChanged, this );
83 mWindowFocusInHandler = ecore_event_handler_add( ECORE_WL_EVENT_FOCUS_IN, EcoreEventWindowFocusIn, this );
84 mWindowFocusOutHandler = ecore_event_handler_add( ECORE_WL_EVENT_FOCUS_OUT, EcoreEventWindowFocusOut, this );
93 if ( mWindowPropertyHandler )
95 ecore_event_handler_del( mWindowPropertyHandler );
97 if ( mWindowIconifyStateHandler )
99 ecore_event_handler_del( mWindowIconifyStateHandler );
101 if( mWindowFocusInHandler )
103 ecore_event_handler_del( mWindowFocusInHandler );
105 if( mWindowFocusOutHandler )
107 ecore_event_handler_del( mWindowFocusOutHandler );
113 /// Called when the window properties are changed.
114 static Eina_Bool EcoreEventWindowPropertyChanged( void* data, int type, void* event )
119 /// Called when the window iconify state is changed.
120 static Eina_Bool EcoreEventWindowIconifyStateChanged( void* data, int type, void* event )
122 Ecore_Wl_Event_Window_Iconify_State_Change* iconifyChangedEvent( static_cast< Ecore_Wl_Event_Window_Iconify_State_Change* >( event ) );
123 EventHandler* handler( static_cast< EventHandler* >( data ) );
124 Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
126 if ( handler && handler->mWindow )
128 WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
129 if ( observer && ( iconifyChangedEvent->win == static_cast< unsigned int> ( ecore_wl_window_id_get( handler->mEcoreWindow ) ) ) )
131 if( iconifyChangedEvent->iconified == EINA_TRUE )
133 observer->OnWindowHidden();
134 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Iconfied\n", handler->mEcoreWindow );
138 observer->OnWindowShown();
139 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Shown\n", handler->mEcoreWindow );
141 handled = ECORE_CALLBACK_DONE;
148 /// Called when the window gains focus
149 static Eina_Bool EcoreEventWindowFocusIn( void* data, int type, void* event )
151 Ecore_Wl_Event_Focus_In* focusInEvent( static_cast< Ecore_Wl_Event_Focus_In* >( event ) );
152 EventHandler* handler( static_cast< EventHandler* >( data ) );
154 if ( handler && handler->mWindow && focusInEvent->win == static_cast< unsigned int >( ecore_wl_window_id_get( handler->mEcoreWindow ) ) )
156 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window EcoreEventWindowFocusIn\n" );
158 handler->mWindow->mFocusChangedSignal.Emit( true );
161 return ECORE_CALLBACK_PASS_ON;
164 /// Called when the window loses focus
165 static Eina_Bool EcoreEventWindowFocusOut( void* data, int type, void* event )
167 Ecore_Wl_Event_Focus_Out* focusOutEvent( static_cast< Ecore_Wl_Event_Focus_Out* >( event ) );
168 EventHandler* handler( static_cast< EventHandler* >( data ) );
170 if ( handler && handler->mWindow && focusOutEvent->win == static_cast< unsigned int >(ecore_wl_window_id_get( handler->mEcoreWindow ) ) )
172 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window EcoreEventWindowFocusOut\n" );
174 handler->mWindow->mFocusChangedSignal.Emit( false );
177 return ECORE_CALLBACK_PASS_ON;
182 Ecore_Event_Handler* mWindowPropertyHandler;
183 Ecore_Event_Handler* mWindowIconifyStateHandler;
184 Ecore_Event_Handler* mWindowFocusInHandler;
185 Ecore_Event_Handler* mWindowFocusOutHandler;
186 Ecore_Wl_Window* mEcoreWindow;
189 Window* Window::New(const PositionSize& posSize, const std::string& name, const std::string& className, bool isTransparent)
191 Window* window = new Window();
192 window->mIsTransparent = isTransparent;
193 window->Initialize(posSize, name, className);
197 void Window::SetAdaptor(Dali::Adaptor& adaptor)
199 DALI_ASSERT_ALWAYS( !mStarted && "Adaptor already started" );
202 // Only create one overlay per window
203 Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
204 Integration::Core& core = adaptorImpl.GetCore();
205 mOverlay = &core.GetSystemOverlay();
207 Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
208 taskList.CreateTask();
210 mAdaptor = &adaptorImpl;
211 mAdaptor->AddObserver( *this );
213 // Can only create the detector when we know the Core has been instantiated.
214 mDragAndDropDetector = DragAndDropDetector::New();
215 mAdaptor->SetDragAndDropDetector( &GetImplementation( mDragAndDropDetector ) );
219 mOrientation->SetAdaptor(adaptor);
222 if( mIndicator != NULL )
224 mIndicator->SetAdaptor(mAdaptor);
228 RenderSurface* Window::GetSurface()
233 void Window::ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode )
235 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "visible : %d\n", visibleMode );
236 DALI_ASSERT_DEBUG(mOverlay);
238 ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
239 DALI_ASSERT_DEBUG(wlSurface);
240 Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
242 mIndicatorVisible = visibleMode;
244 if ( mIndicatorVisible == Dali::Window::VISIBLE )
246 // when the indicator is visible, set proper mode for indicator server according to bg mode
247 if ( mIndicatorOpacityMode == Dali::Window::OPAQUE )
249 ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_OPAQUE);
251 else if ( mIndicatorOpacityMode == Dali::Window::TRANSLUCENT )
253 ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_TRANSLUCENT);
255 else if ( mIndicatorOpacityMode == Dali::Window::TRANSPARENT )
257 ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_OPAQUE);
262 // when the indicator is not visible, set TRANSPARENT mode for indicator server
263 ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_TRANSPARENT); // it means hidden indicator
266 DoShowIndicator( mIndicatorOrientation );
269 void Window::RotateIndicator( Dali::Window::WindowOrientation orientation )
271 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "Orientation: %d\n", orientation );
273 DoRotateIndicator( orientation );
276 void Window::SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacityMode )
278 mIndicatorOpacityMode = opacityMode;
280 if( mIndicator != NULL )
282 mIndicator->SetOpacityMode( opacityMode );
286 void Window::SetClass(std::string name, std::string klass)
288 ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
292 Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
293 ecore_wl_window_title_set( wlWindow, name.c_str() );
294 ecore_wl_window_class_name_set( wlWindow, klass.c_str() );
298 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window has no surface\n" );
304 mIndicatorVisible( Dali::Window::VISIBLE ),
305 mIndicatorIsShown( false ),
306 mShowRotatedIndicatorOnClose( false ),
308 mIsTransparent( false ),
309 mWMRotationAppSet( false ),
310 mEcoreEventHander( true ),
311 mIsFocusAcceptable( true ),
314 mIndicatorOrientation( Dali::Window::PORTRAIT ),
315 mNextIndicatorOrientation( Dali::Window::PORTRAIT ),
316 mIndicatorOpacityMode( Dali::Window::OPAQUE ),
319 mEventHandler( NULL ),
320 mPreferredOrientation( Dali::Window::PORTRAIT )
326 delete mEventHandler;
336 mAdaptor->RemoveObserver( *this );
337 mAdaptor->SetDragAndDropDetector( NULL );
344 void Window::Initialize(const PositionSize& windowPosition, const std::string& name, const std::string& className)
346 // create an Wayland window by default
348 ECore::WindowRenderSurface* windowSurface = new ECore::WindowRenderSurface( windowPosition, surface, name, mIsTransparent );
350 mSurface = windowSurface;
351 SetClass( name, className );
352 windowSurface->Map();
354 mOrientation = Orientation::New(this);
356 // create event handler for Wayland window
357 mEventHandler = new EventHandler( this );
360 void Window::DoShowIndicator( Dali::Window::WindowOrientation lastOrientation )
362 if( mIndicator == NULL )
364 if( mIndicatorVisible != Dali::Window::INVISIBLE )
366 mIndicator = new Indicator( mAdaptor, mIndicatorOrientation, this );
367 mIndicator->SetOpacityMode( mIndicatorOpacityMode );
368 Dali::Actor actor = mIndicator->GetActor();
369 SetIndicatorActorRotation();
370 mOverlay->Add(actor);
372 // else don't create a hidden indicator
374 else // Already have indicator
376 if( mIndicatorVisible == Dali::Window::VISIBLE )
378 // If we are resuming, and rotation has changed,
379 if( mIndicatorIsShown == false && mIndicatorOrientation != mNextIndicatorOrientation )
381 // then close current indicator and open new one
382 mShowRotatedIndicatorOnClose = true;
383 mIndicator->Close(); // May synchronously call IndicatorClosed() callback & 1 level of recursion
384 // Don't show actor - will contain indicator for old orientation.
389 // set indicator visible mode
390 if( mIndicator != NULL )
392 mIndicator->SetVisible( mIndicatorVisible );
395 bool show = (mIndicatorVisible != Dali::Window::INVISIBLE );
396 SetIndicatorProperties( show, lastOrientation );
397 mIndicatorIsShown = show;
400 void Window::DoRotateIndicator( Dali::Window::WindowOrientation orientation )
402 if( mIndicatorIsShown )
404 mShowRotatedIndicatorOnClose = true;
405 mNextIndicatorOrientation = orientation;
406 mIndicator->Close(); // May synchronously call IndicatorClosed() callback
410 // Save orientation for when the indicator is next shown
411 mShowRotatedIndicatorOnClose = false;
412 mNextIndicatorOrientation = orientation;
416 void Window::SetIndicatorProperties( bool isShow, Dali::Window::WindowOrientation lastOrientation )
418 ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
422 Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
425 ecore_wl_window_indicator_state_set(wlWindow, ECORE_WL_INDICATOR_STATE_ON);
429 ecore_wl_window_indicator_state_set(wlWindow, ECORE_WL_INDICATOR_STATE_OFF);
434 void Window::IndicatorTypeChanged(Indicator::Type type)
436 #if defined(DALI_PROFILE_MOBILE)
437 ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
441 Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
444 case Indicator::INDICATOR_TYPE_1:
445 ecore_wl_indicator_visible_type_set(wlWindow, ECORE_WL_INDICATOR_VISIBLE_TYPE_SHOWN);
448 case Indicator::INDICATOR_TYPE_2:
449 ecore_wl_indicator_visible_type_set(wlWindow, ECORE_WL_INDICATOR_VISIBLE_TYPE_HIDDEN);
452 case Indicator::INDICATOR_TYPE_UNKNOWN:
460 void Window::IndicatorClosed( IndicatorInterface* indicator )
462 DALI_LOG_TRACE_METHOD( gWindowLogFilter );
464 if( mShowRotatedIndicatorOnClose )
466 Dali::Window::WindowOrientation currentOrientation = mIndicatorOrientation;
467 mIndicator->Open(mNextIndicatorOrientation);
468 mIndicatorOrientation = mNextIndicatorOrientation;
469 SetIndicatorActorRotation();
470 DoShowIndicator(currentOrientation);
474 void Window::IndicatorVisibilityChanged(bool isVisible)
476 mIndicatorVisibilityChangedSignal.Emit(isVisible);
479 void Window::SetIndicatorActorRotation()
481 DALI_LOG_TRACE_METHOD( gWindowLogFilter );
482 DALI_ASSERT_DEBUG( mIndicator != NULL );
484 Dali::Actor actor = mIndicator->GetActor();
485 switch( mIndicatorOrientation )
487 case Dali::Window::PORTRAIT:
488 actor.SetParentOrigin( ParentOrigin::TOP_CENTER );
489 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
490 actor.SetOrientation( Degree(0), Vector3::ZAXIS );
492 case Dali::Window::PORTRAIT_INVERSE:
493 actor.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
494 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
495 actor.SetOrientation( Degree(180), Vector3::ZAXIS );
497 case Dali::Window::LANDSCAPE:
498 actor.SetParentOrigin( ParentOrigin::CENTER_LEFT );
499 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
500 actor.SetOrientation( Degree(270), Vector3::ZAXIS );
502 case Dali::Window::LANDSCAPE_INVERSE:
503 actor.SetParentOrigin( ParentOrigin::CENTER_RIGHT );
504 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
505 actor.SetOrientation( Degree(90), Vector3::ZAXIS );
512 ecore_wl_window_raise( mEventHandler->mEcoreWindow );
517 ecore_wl_window_lower( mEventHandler->mEcoreWindow );
520 void Window::Activate()
522 ecore_wl_window_activate( mEventHandler->mEcoreWindow );
525 Dali::DragAndDropDetector Window::GetDragAndDropDetector() const
527 return mDragAndDropDetector;
530 Dali::Any Window::GetNativeHandle() const
534 return mEventHandler->mEcoreWindow;
542 void Window::OnStart()
544 DoShowIndicator( mIndicatorOrientation );
547 void Window::OnPause()
551 void Window::OnResume()
553 // resume indicator status
554 if( mIndicator != NULL )
556 // Restore own indicator opacity
557 // Send opacity mode to indicator service when app resumed
558 mIndicator->SetOpacityMode( mIndicatorOpacityMode );
562 void Window::OnStop()
573 void Window::OnDestroy()
578 void Window::AddAvailableOrientation(Dali::Window::WindowOrientation orientation)
582 for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
584 if(mAvailableOrientations[i] == orientation)
593 mAvailableOrientations.push_back(orientation);
594 SetAvailableOrientations( mAvailableOrientations );
598 void Window::RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation)
600 for( std::vector<Dali::Window::WindowOrientation>::iterator iter = mAvailableOrientations.begin();
601 iter != mAvailableOrientations.end(); ++iter )
603 if( *iter == orientation )
605 mAvailableOrientations.erase( iter );
609 SetAvailableOrientations( mAvailableOrientations );
612 void Window::SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations)
615 for( std::size_t i = 0; i < mAvailableOrientations.size(); ++i )
617 rotations[i] = static_cast< int >( mAvailableOrientations[i] );
619 ecore_wl_window_rotation_available_rotations_set( mEventHandler->mEcoreWindow, rotations, mAvailableOrientations.size() );
622 const std::vector<Dali::Window::WindowOrientation>& Window::GetAvailableOrientations()
624 return mAvailableOrientations;
627 void Window::SetPreferredOrientation(Dali::Window::WindowOrientation orientation)
629 mPreferredOrientation = orientation;
631 ecore_wl_window_rotation_preferred_rotation_set( mEventHandler->mEcoreWindow, orientation );
634 Dali::Window::WindowOrientation Window::GetPreferredOrientation()
636 return mPreferredOrientation;
639 void Window::SetAcceptFocus( bool accept )
641 mIsFocusAcceptable = accept;
643 ecore_wl_window_focus_skip_set( mEventHandler->mEcoreWindow, !accept );
646 bool Window::IsFocusAcceptable()
648 return mIsFocusAcceptable;
654 ecore_wl_window_show( mEventHandler->mEcoreWindow );
656 // Need an update request
659 mAdaptor->RequestUpdateOnce();
666 ecore_wl_window_hide( mEventHandler->mEcoreWindow );
669 bool Window::IsVisible() const
674 void Window::RotationDone( int orientation, int width, int height )
676 ecore_wl_window_rotation_change_done_send( mEventHandler->mEcoreWindow );