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"
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>
31 #include <window-render-surface.h>
32 #include <drag-and-drop-detector-impl.h>
33 #include <ecore-indicator-impl.h>
34 #include <window-visibility-observer.h>
35 #include <orientation.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 mClientMessagehandler( NULL ),
68 mWindowDeleteRequestHandler( NULL ),
71 // store ecore window handle
72 ECore::WindowRenderSurface* x11Window( dynamic_cast< ECore::WindowRenderSurface * >( mWindow->mSurface ) );
75 mEcoreWindow = x11Window->GetXWindow();
77 DALI_ASSERT_ALWAYS( mEcoreWindow != 0 && "There is no ecore x window");
79 #ifndef DALI_PROFILE_UBUNTU
80 // set property on window to get deiconify approve client message
82 ecore_x_window_prop_card32_set(mEcoreWindow,
83 ECORE_X_ATOM_E_DEICONIFY_APPROVE,
85 #endif // DALI_PROFILE_UBUNTU
87 if( mWindow->mEcoreEventHander )
89 ecore_x_input_multi_select( mEcoreWindow );
91 // This ensures that we catch the window close (or delete) request
92 ecore_x_icccm_protocol_set( mEcoreWindow, ECORE_X_WM_PROTOCOL_DELETE_REQUEST, EINA_TRUE );
94 mWindowPropertyHandler= ecore_event_handler_add( ECORE_X_EVENT_WINDOW_PROPERTY, EcoreEventWindowPropertyChanged, this );
95 mClientMessagehandler = ecore_event_handler_add( ECORE_X_EVENT_CLIENT_MESSAGE, EcoreEventClientMessage, this );
96 mWindowDeleteRequestHandler = ecore_event_handler_add( ECORE_X_EVENT_WINDOW_DELETE_REQUEST, EcoreEventWindowDeleteRequest, this );
105 if ( mWindowPropertyHandler )
107 ecore_event_handler_del( mWindowPropertyHandler );
109 if ( mClientMessagehandler )
111 ecore_event_handler_del( mClientMessagehandler );
113 if ( mWindowDeleteRequestHandler )
115 ecore_event_handler_del( mWindowDeleteRequestHandler );
121 /// Called when the window properties are changed.
122 static Eina_Bool EcoreEventWindowPropertyChanged( void* data, int type, void* event )
124 Ecore_X_Event_Window_Property* propertyChangedEvent( (Ecore_X_Event_Window_Property*)event );
125 EventHandler* handler( (EventHandler*)data );
126 Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
128 if ( handler && handler->mWindow )
130 WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
131 if ( observer && ( propertyChangedEvent->win == handler->mEcoreWindow ) )
133 Ecore_X_Window_State_Hint state( ecore_x_icccm_state_get( propertyChangedEvent->win ) );
137 case ECORE_X_WINDOW_STATE_HINT_WITHDRAWN:
139 // Window was hidden.
140 observer->OnWindowHidden();
141 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Withdrawn\n", handler->mEcoreWindow );
142 handled = ECORE_CALLBACK_DONE;
146 case ECORE_X_WINDOW_STATE_HINT_ICONIC:
148 // Window was iconified (minimised).
149 observer->OnWindowHidden();
150 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Iconfied\n", handler->mEcoreWindow );
151 handled = ECORE_CALLBACK_DONE;
155 case ECORE_X_WINDOW_STATE_HINT_NORMAL:
158 observer->OnWindowShown();
159 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Shown\n", handler->mEcoreWindow );
160 handled = ECORE_CALLBACK_DONE;
174 /// Called when the window properties are changed.
175 static Eina_Bool EcoreEventClientMessage( void* data, int type, void* event )
177 Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
178 #ifndef DALI_PROFILE_UBUNTU
179 Ecore_X_Event_Client_Message* clientMessageEvent( (Ecore_X_Event_Client_Message*)event );
180 EventHandler* handler( (EventHandler*)data );
182 if (clientMessageEvent->message_type == ECORE_X_ATOM_E_DEICONIFY_APPROVE)
184 ECore::WindowRenderSurface* x11Window( dynamic_cast< ECore::WindowRenderSurface * >( handler->mWindow->mSurface ) );
185 WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
187 if ( observer && ( (unsigned int)clientMessageEvent->data.l[0] == handler->mEcoreWindow ) )
189 if (clientMessageEvent->data.l[1] == 0) //wm sends request message using value 0
191 observer->OnWindowShown();
193 // request to approve the deiconify. render-surface should send proper event after real rendering
196 x11Window->RequestToApproveDeiconify();
199 handled = ECORE_CALLBACK_DONE;
203 #endif // DALI_PROFILE_UBUNTU
208 /// Called when the window receives a delete request
209 static Eina_Bool EcoreEventWindowDeleteRequest( void* data, int type, void* event )
211 EventHandler* handler( (EventHandler*)data );
212 handler->mWindow->mDeleteRequestSignal.Emit();
213 return ECORE_CALLBACK_DONE;
218 Ecore_Event_Handler* mWindowPropertyHandler;
219 Ecore_Event_Handler* mClientMessagehandler;
220 Ecore_Event_Handler* mWindowDeleteRequestHandler;
221 Ecore_X_Window mEcoreWindow;
225 Window* Window::New( const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent )
227 Window* window = new Window();
228 window->mIsTransparent = isTransparent;
229 window->Initialize( positionSize, name, className );
233 void Window::SetAdaptor(Dali::Adaptor& adaptor)
235 DALI_ASSERT_ALWAYS( !mStarted && "Adaptor already started" );
238 // Only create one overlay per window
239 Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
240 Integration::Core& core = adaptorImpl.GetCore();
241 mOverlay = &core.GetSystemOverlay();
243 Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
244 taskList.CreateTask();
246 mAdaptor = &adaptorImpl;
247 mAdaptor->AddObserver( *this );
249 // Can only create the detector when we know the Core has been instantiated.
250 mDragAndDropDetector = DragAndDropDetector::New();
251 mAdaptor->SetDragAndDropDetector( &GetImplementation( mDragAndDropDetector ) );
255 mOrientation->SetAdaptor(adaptor);
258 if( mIndicator != NULL )
260 mIndicator->SetAdaptor(mAdaptor);
264 RenderSurface* Window::GetSurface()
269 void Window::ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode )
271 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "visible : %d\n", visibleMode );
272 DALI_ASSERT_DEBUG(mOverlay);
274 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
275 DALI_ASSERT_DEBUG(x11Window);
276 Ecore_X_Window xWinId = x11Window->GetXWindow();
278 mIndicatorVisible = visibleMode;
280 if ( mIndicatorVisible == Dali::Window::VISIBLE )
282 // when the indicator is visible, set proper mode for indicator server according to bg mode
283 if ( mIndicatorOpacityMode == Dali::Window::OPAQUE )
285 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_OPAQUE);
287 else if ( mIndicatorOpacityMode == Dali::Window::TRANSLUCENT )
289 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_TRANSLUCENT);
291 #if defined(DALI_PROFILE_MOBILE)
292 else if ( mIndicatorOpacityMode == Dali::Window::TRANSPARENT )
294 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_OPAQUE);
300 // when the indicator is not visible, set TRANSPARENT mode for indicator server
301 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_TRANSPARENT); // it means hidden indicator
304 DoShowIndicator( mIndicatorOrientation );
307 void Window::RotateIndicator(Dali::Window::WindowOrientation orientation)
309 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "Orientation: %d\n", orientation );
311 DoRotateIndicator( orientation );
314 void Window::SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacityMode )
316 mIndicatorOpacityMode = opacityMode;
318 if( mIndicator != NULL )
320 mIndicator->SetOpacityMode( opacityMode );
324 void Window::SetClass(std::string name, std::string klass)
326 // Get render surface's x11 window
329 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
332 ecore_x_icccm_name_class_set( x11Window->GetXWindow(), name.c_str(), klass.c_str() );
339 mIndicatorVisible( Dali::Window::INVISIBLE ),
340 mIndicatorIsShown( false ),
341 mShowRotatedIndicatorOnClose( false ),
343 mIsTransparent( false ),
344 mWMRotationAppSet( false ),
345 mEcoreEventHander( true ),
346 mResizeEnabled( true ),
348 mIndicatorOrientation( Dali::Window::PORTRAIT ),
349 mNextIndicatorOrientation( Dali::Window::PORTRAIT ),
350 mIndicatorOpacityMode( Dali::Window::OPAQUE ),
353 mEventHandler( NULL ),
354 mPreferredOrientation( Dali::Window::PORTRAIT ),
355 mSupportedAuxiliaryHints(),
359 // Detect if we're not running in a ecore main loop (e.g. libuv).
360 // Typically ecore_x_init is called by app_efl_main->elm_init
361 // but if we're not using app_efl_main then we have to call it ourselves
362 // This is a hack until we create a pure X Window class
363 if( ecore_x_display_get() == NULL )
365 mEcoreEventHander = false;
366 ecore_x_init (NULL); // internally calls _ecore_x_input_init
373 delete mEventHandler;
377 mOverlay->Remove( mIndicator->GetActor() );
378 Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
379 Dali::RenderTask indicatorTask = taskList.GetTask(0);
380 mOverlay->GetOverlayRenderTasks().RemoveTask(indicatorTask);
387 mAdaptor->RemoveObserver( *this );
388 mAdaptor->SetDragAndDropDetector( NULL );
395 void Window::Initialize(const PositionSize& positionSize, const std::string& name, const std::string& className)
397 // create an X11 window by default
399 ECore::WindowRenderSurface* windowSurface = new ECore::WindowRenderSurface( positionSize, surface, name, className, mIsTransparent );
400 windowSurface->Map();
402 mSurface = windowSurface;
404 mOrientation = Orientation::New(this);
406 // create event handler for X11 window
407 mEventHandler = new EventHandler( this );
410 void Window::DoShowIndicator( Dali::Window::WindowOrientation lastOrientation )
412 if( mIndicator == NULL )
414 if( mIndicatorVisible != Dali::Window::INVISIBLE )
416 mIndicator = new Indicator( mAdaptor, mIndicatorOrientation, this );
417 mIndicator->SetOpacityMode( mIndicatorOpacityMode );
418 Dali::Actor actor = mIndicator->GetActor();
419 SetIndicatorActorRotation();
420 mOverlay->Add(actor);
422 // else don't create a hidden indicator
424 else // Already have indicator
426 if( mIndicatorVisible == Dali::Window::VISIBLE )
428 // If we are resuming, and rotation has changed,
429 if( mIndicatorIsShown == false && mIndicatorOrientation != mNextIndicatorOrientation )
431 // then close current indicator and open new one
432 mShowRotatedIndicatorOnClose = true;
433 mIndicator->Close(); // May synchronously call IndicatorClosed() callback & 1 level of recursion
434 // Don't show actor - will contain indicator for old orientation.
439 // set indicator visible mode
440 if( mIndicator != NULL )
442 mIndicator->SetVisible( mIndicatorVisible );
445 bool show = (mIndicatorVisible != Dali::Window::INVISIBLE );
446 SetIndicatorProperties( show, lastOrientation );
447 mIndicatorIsShown = show;
450 void Window::DoRotateIndicator( Dali::Window::WindowOrientation orientation )
452 if( mIndicatorIsShown )
454 mShowRotatedIndicatorOnClose = true;
455 mNextIndicatorOrientation = orientation;
456 mIndicator->Close(); // May synchronously call IndicatorClosed() callback
460 // Save orientation for when the indicator is next shown
461 mShowRotatedIndicatorOnClose = false;
462 mNextIndicatorOrientation = orientation;
466 void Window::SetIndicatorProperties( bool isShow, Dali::Window::WindowOrientation lastOrientation )
468 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
471 Ecore_X_Window win = x11Window->GetXWindow();
473 int show_state = static_cast<int>( isShow );
474 ecore_x_window_prop_property_set( win,
475 ECORE_X_ATOM_E_ILLUME_INDICATOR_STATE,
476 ECORE_X_ATOM_CARDINAL, 32, &show_state, 1);
480 ecore_x_e_illume_indicator_state_set(win, ECORE_X_ILLUME_INDICATOR_STATE_ON);
484 ecore_x_e_illume_indicator_state_set(win, ECORE_X_ILLUME_INDICATOR_STATE_OFF);
489 void Window::IndicatorTypeChanged(Indicator::Type type)
491 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
494 #ifndef DALI_PROFILE_UBUNTU
495 Ecore_X_Window win = x11Window->GetXWindow();
498 case Indicator::INDICATOR_TYPE_1:
499 ecore_x_e_illume_indicator_type_set( win, ECORE_X_ILLUME_INDICATOR_TYPE_1 );
502 case Indicator::INDICATOR_TYPE_2:
503 ecore_x_e_illume_indicator_type_set( win, ECORE_X_ILLUME_INDICATOR_TYPE_2 );
506 case Indicator::INDICATOR_TYPE_UNKNOWN:
510 #endif // DALI_PROFILE_UBUNTU
514 void Window::IndicatorClosed( IndicatorInterface* indicator )
516 DALI_LOG_TRACE_METHOD( gWindowLogFilter );
518 if( mShowRotatedIndicatorOnClose )
520 Dali::Window::WindowOrientation currentOrientation = mIndicatorOrientation;
521 mIndicator->Open(mNextIndicatorOrientation);
522 mIndicatorOrientation = mNextIndicatorOrientation;
523 SetIndicatorActorRotation();
524 DoShowIndicator(currentOrientation);
528 void Window::IndicatorVisibilityChanged(bool isVisible)
530 mIndicatorVisibilityChangedSignal.Emit(isVisible);
533 void Window::SetIndicatorActorRotation()
535 DALI_LOG_TRACE_METHOD( gWindowLogFilter );
536 DALI_ASSERT_DEBUG( mIndicator != NULL );
538 Dali::Actor actor = mIndicator->GetActor();
539 switch( mIndicatorOrientation )
541 case Dali::Window::PORTRAIT:
542 actor.SetParentOrigin( ParentOrigin::TOP_CENTER );
543 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
544 actor.SetOrientation( Degree(0), Vector3::ZAXIS );
546 case Dali::Window::PORTRAIT_INVERSE:
547 actor.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
548 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
549 actor.SetOrientation( Degree(180), Vector3::ZAXIS );
551 case Dali::Window::LANDSCAPE:
552 actor.SetParentOrigin( ParentOrigin::CENTER_LEFT );
553 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
554 actor.SetOrientation( Degree(270), Vector3::ZAXIS );
556 case Dali::Window::LANDSCAPE_INVERSE:
557 actor.SetParentOrigin( ParentOrigin::CENTER_RIGHT );
558 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
559 actor.SetOrientation( Degree(90), Vector3::ZAXIS );
566 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
569 Ecore_X_Window win = x11Window->GetXWindow();
570 ecore_x_window_raise(win);
576 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
579 Ecore_X_Window win = x11Window->GetXWindow();
580 ecore_x_window_lower(win);
584 void Window::Activate()
586 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
589 Ecore_X_Window win = x11Window->GetXWindow();
590 ecore_x_netwm_client_active_request(ecore_x_window_root_get(win), win, 1 /* request type, 1:application, 2:pager */, 0);
594 Dali::DragAndDropDetector Window::GetDragAndDropDetector() const
596 return mDragAndDropDetector;
599 Dali::Any Window::GetNativeHandle() const
603 return mEventHandler->mEcoreWindow;
611 void Window::OnStart()
613 ShowIndicator( mIndicatorVisible );
616 void Window::OnPause()
620 void Window::OnResume()
622 // resume indicator status
623 if( mIndicator != NULL )
625 // Restore own indicator opacity
626 // Send opacity mode to indicator service when app resumed
627 mIndicator->SetOpacityMode( mIndicatorOpacityMode );
631 void Window::OnStop()
642 void Window::OnDestroy()
647 void Window::AddAvailableOrientation(Dali::Window::WindowOrientation orientation)
651 for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
653 if(mAvailableOrientations[i] == orientation)
662 mAvailableOrientations.push_back(orientation);
663 SetAvailableOrientations( mAvailableOrientations );
667 void Window::RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation)
669 for( std::vector<Dali::Window::WindowOrientation>::iterator iter = mAvailableOrientations.begin();
670 iter != mAvailableOrientations.end(); ++iter )
672 if( *iter == orientation )
674 mAvailableOrientations.erase( iter );
678 SetAvailableOrientations( mAvailableOrientations );
681 void Window::SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations)
683 DALI_ASSERT_ALWAYS( mAvailableOrientations.size() <= 4 && "Incorrect number of available orientations" );
685 mAvailableOrientations = orientations;
686 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
689 #ifndef DALI_PROFILE_UBUNTU
690 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
691 if( ! mWMRotationAppSet )
693 mWMRotationAppSet = true;
694 ecore_x_e_window_rotation_app_set(ecoreWindow, EINA_TRUE);
698 for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
700 rotations[i] = static_cast<int>(mAvailableOrientations[i]);
702 ecore_x_e_window_rotation_available_rotations_set(ecoreWindow, rotations, mAvailableOrientations.size() );
703 #endif // DALI_PROFILE_UBUNTU
707 const std::vector<Dali::Window::WindowOrientation>& Window::GetAvailableOrientations()
709 return mAvailableOrientations;
712 void Window::SetPreferredOrientation(Dali::Window::WindowOrientation orientation)
714 mPreferredOrientation = orientation;
716 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
719 #ifndef DALI_PROFILE_UBUNTU
720 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
722 if( ! mWMRotationAppSet )
724 mWMRotationAppSet = true;
725 ecore_x_e_window_rotation_app_set(ecoreWindow, EINA_TRUE);
728 ecore_x_e_window_rotation_preferred_rotation_set(ecoreWindow, orientation);
729 #endif // DALI_PROFILE_UBUNTU
733 Dali::Window::WindowOrientation Window::GetPreferredOrientation()
735 return mPreferredOrientation;
738 void Window::RotationDone( int orientation, int width, int height )
740 // Tell window manager we're done
741 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
744 #ifndef DALI_PROFILE_UBUNTU
745 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
746 Ecore_X_Window root = ecore_x_window_root_get(ecoreWindow);
749 * send rotation done message to wm, even if window is already rotated.
750 * that's why wm must be wait for comming rotation done message
751 * after sending rotation request.
753 ecore_x_e_window_rotation_change_done_send(root, ecoreWindow, orientation, width, height);
756 * set rotate window property
758 int angles[2] = { orientation, orientation };
759 ecore_x_window_prop_property_set( ecoreWindow,
760 ECORE_X_ATOM_E_ILLUME_ROTATE_WINDOW_ANGLE,
761 ECORE_X_ATOM_CARDINAL, 32, &angles, 2 );
763 mAdaptor->SurfaceResizePrepare( Adaptor::SurfaceSize( width, height ) );
765 mAdaptor->SurfaceResizeComplete( Adaptor::SurfaceSize( width, height ) );
766 #endif // DALI_PROFILE_UBUNTU
770 unsigned int Window::AddAuxiliaryHint( const std::string& hint, const std::string& value )